jekyll-archives-v2 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bd3853c2320099f7c356af52603b8cbcbe353a220a5b3f59ae5a4a54c087d9ec
+  data.tar.gz: 77a4dbb8bb3342964b79b224767c8d43805ad6640c2af2114ac826bc5645f9ec
+SHA512:
+  metadata.gz: a25f649119ae3f1d982dfb41898af49c2898793b9057a8c45c64aaee20450d68e6002dcea3964bb46bb42372f381dd5497f205015884174d74ce33ca2cd7d6fb
+  data.tar.gz: 7c9fae3f1f46bd596d301337d2680210de53d797f07f22200ac5cb0737de183908686d2c2b897378406bde1499f9298ffacd2b51919f75300f0b412daf89fcd4

data/lib/jekyll-archives-v2/archive.rb

@@ -0,0 +1,144 @@
+# 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

data/lib/jekyll-archives-v2/page_drop.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module ArchivesV2
+    class PageDrop < Jekyll::Drops::Drop
+      extend Forwardable
+
+      mutable false
+
+      def_delegators :@obj, :posts, :type, :title, :date, :name, :path, :url, :permalink
+      private def_delegator :@obj, :data, :fallback_data
+    end
+  end
+end

data/lib/jekyll-archives-v2/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module ArchivesV2
+    VERSION = "0.0.1"
+  end
+end

data/lib/jekyll-archives.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+require "jekyll"
+
+module Jekyll
+  module ArchivesV2
+    # Internal requires
+    autoload :Archive,  "jekyll-archives-v2/archive"
+    autoload :PageDrop, "jekyll-archives-v2/page_drop"
+    autoload :VERSION,  "jekyll-archives-v2/version"
+
+    class Archives < Jekyll::Generator
+      safe true
+
+      def initialize(config = {})
+        defaults = {}
+        config.fetch("collections", {}).each do |name, collection|
+          defaults[name] = {
+            "layout"     => "archive",
+            "enabled"    => [],
+            "permalinks" => {
+              "year"     => "/#{name}/:year/",
+              "month"    => "/#{name}/:year/:month/",
+              "day"      => "/#{name}/:year/:month/:day/",
+              "tag"      => "/#{name}/tag/:name/",
+              "category" => "/#{name}/category/:name/",
+            },
+          }
+        end
+        defaults.freeze
+        archives_config = config.fetch("jekyll-archives", {})
+        if archives_config.is_a?(Hash)
+          @config = Utils.deep_merge_hashes(defaults, archives_config)
+        else
+          @config = nil
+          Jekyll.logger.warn "Archives:", "Expected a hash but got #{archives_config.inspect}"
+          Jekyll.logger.warn "", "Archives will not be generated for this site."
+        end
+      end
+
+      def generate(site)
+        return if @config.nil?
+
+        @site = site
+        @collections = site.collections
+        @archives = []
+
+        @site.config["jekyll-archives"] = @config
+
+        # loop through collections keys and read them
+        @config.each do |collection_name, collection_config|
+          read(collection_name)
+        end
+
+        @site.pages.concat(@archives)
+        @site.config["archives"] = @archives
+      end
+
+      # Read archive data from collection
+      def read(collection_name)
+        if enabled?(collection_name, "tags")
+          read_tags(collection_name)
+        end
+
+        if enabled?(collection_name, "categories")
+          read_categories(collection_name)
+        end
+
+        if enabled?(collection_name, "year") || enabled?(collection_name, "month") || enabled?(collection_name, "day")
+          read_dates(collection_name)
+        end
+      end
+
+      def read_tags(collection_name)
+        tags(@collections[collection_name]).each do |title, documents|
+          @archives << Archive.new(@site, title, "tag", collection_name, documents)
+        end
+      end
+
+      def read_categories(collection_name)
+        categories(@collections[collection_name]).each do |title, documents|
+          @archives << Archive.new(@site, title, "category", collection_name, documents)
+        end
+      end
+
+      def read_dates(collection_name)
+        years(@collections[collection_name]).each do |year, y_documents|
+          append_enabled_date_type({ :year => year }, "year", collection_name, y_posts)
+          months(y_documents).each do |month, m_documents|
+            append_enabled_date_type({ :year => year, :month => month }, "month", collection_name, m_posts)
+            days(m_documents).each do |day, d_documents|
+              append_enabled_date_type({ :year => year, :month => month, :day => day }, "day", collection_name, d_posts)
+            end
+          end
+        end
+      end
+
+      # Checks if archive type is enabled in config
+      def enabled?(collection_name, archive)
+        @enabled == true || @enabled == "all" || (@enabled.is_a?(Array) && @enabled.include?(archive))
+      end
+
+      def tags(documents)
+        doc_attr_hash(documents, "tags")
+      end
+
+      def categories(documents)
+        doc_attr_hash(documents, "categories")
+      end
+
+      # Custom `post_attr_hash` method for years
+      def years(documents)
+        date_attr_hash(documents, "%Y")
+      end
+
+      # Custom `post_attr_hash` method for months
+      def months(year_documents)
+        date_attr_hash(year_documents, "%m")
+      end
+
+      # Custom `post_attr_hash` method for days
+      def days(month_documents)
+        date_attr_hash(month_documents, "%d")
+      end
+
+      private
+
+      # Initialize a new Archive page and append to base array if the associated date `type`
+      # has been enabled by configuration.
+      #
+      # meta            - A Hash of the year / month / day as applicable for date.
+      # type            - The type of date archive.
+      # collection_name - the name of the collection
+      # documents       - The array of documents that belong in the date archive.
+      def append_enabled_date_type(meta, type, collection_name, documents)
+        @archives << Archive.new(@site, meta, type, collection_name, documents) if enabled?(collection_name, type)
+      end
+
+      # Custom `post_attr_hash` for date type archives.
+      #
+      # documents - Array of documents to be considered for archiving.
+      # id        - String used to format post date via `Time.strptime` e.g. %Y, %m, etc.
+      def date_attr_hash(documents, id)
+        hash = Hash.new { |hsh, key| hsh[key] = [] }
+        documents.each { |document| hash[document.date.strftime(id)] << document }
+        hash.each_value { |documents| documents.sort!.reverse! }
+        hash
+      end
+
+      # Custom `post_attr_hash` for any collection.
+      #
+      # documents - Array of documents to be considered for archiving.
+      # doc_attr  - The String name of the Document attribute.
+      def doc_attr_hash(documents, doc_attr)
+        # Build a hash map based on the specified document attribute ( doc_attr =>
+        # array of elements from collection ) then sort each array in reverse order.
+        hash = Hash.new { |h, key| h[key] = [] }
+        documents.docs.each { |document| document.data[doc_attr]&.each { |t| hash[t] << document } }
+        hash.each_value { |documents| documents.sort!.reverse! }
+        hash
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-archives-v2
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- George Corrêa de Araújo
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Automatically generate collections archives by dates, tags, and categories.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll-archives-v2/archive.rb
+- lib/jekyll-archives-v2/page_drop.rb
+- lib/jekyll-archives-v2/version.rb
+- lib/jekyll-archives.rb
+homepage: https://github.com/george-gca/jekyll-archives-v2
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: Collections archives for Jekyll.
+test_files: []