lib/jekyll-archives-v2/archive.rb
# frozen_string_literal: true module Jekyll module ArchivesV2 class Archive < Jekyll::Page attr_accessor :collection_name, :documents, :type, :slug # Attributes for Liquid templates ATTRIBUTES_FOR_LIQUID = %w( collection_name documents type title date name path url permalink ).freeze # Initialize a new Archive page # # site - The Site object. # title - The name of the tag/category or a Hash of the year/month/day in case of date. # e.g. { :year => 2014, :month => 08 } or "my-category" or "my-tag". # type - The type of archive. Can be one of "year", "month", "day", "category", or "tag" # collection_name - The name of the collection. # documents - The array of documents that belong in this archive. def initialize(site, title, type, collection_name, documents) @site = site @documents = documents @type = type @title = title @collection_name = collection_name @config = site.config["jekyll-archives"][collection_name] @slug = slugify_string_title # Use ".html" for file extension and url for path @ext = File.extname(relative_path) @path = relative_path @name = File.basename(relative_path, @ext) @data = { "layout" => layout, } @content = "" end # The template of the permalink. # # Returns the template String. def template @config.dig("permalinks", type) end # The layout to use for rendering # # Returns the layout as a String def layout @config.dig("layouts", type) || @config["layout"] end # Returns a hash of URL placeholder names (as symbols) mapping to the # desired placeholder replacements. For details see "url.rb". def url_placeholders if @title.is_a? Hash @title.merge(:collection => @collection_name, :type => @type) else { :collection => @collection_name, :name => @slug, :type => @type } end end # The generated relative url of this page. e.g. /about.html. # # Returns the String url. def url @url ||= URL.new( :template => template, :placeholders => url_placeholders, :permalink => nil ).to_s rescue ArgumentError raise ArgumentError, "Template \"#{template}\" provided is invalid." end def permalink data&.is_a?(Hash) && data["permalink"] end # Produce a title object suitable for Liquid based on type of archive. # # Returns a String (for tag and category archives) and nil for # date-based archives. def title @title if @title.is_a? String end # Produce a date object if a date-based archive # # Returns a Date. def date return unless @title.is_a?(Hash) @date ||= begin args = @title.values.map(&:to_i) Date.new(*args) end end # Obtain the write path relative to the destination directory # # Returns the destination relative path String. def relative_path @relative_path ||= begin path = URL.unescape_path(url).gsub(%r!^/!, "") path = File.join(path, "index.html") if url.end_with?("/") path end end # Returns the object as a debug String. def inspect "#<Jekyll:Archive @type=#{@type} @title=#{@title} @data=#{@data.inspect}>" end # The Liquid representation of this page. def to_liquid @to_liquid ||= Jekyll::ArchivesV2::PageDrop.new(self) end private # Generate slug if @title attribute is a string. # # Note: mode other than those expected by Jekyll returns the given string after # downcasing it. def slugify_string_title return unless title.is_a?(String) Utils.slugify(title, :mode => @config["slug_mode"]) end end end end