jekyll-archives-v2 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a627d116dccfd0c16c031b21c4e61817912e414a300f586e103dc9fb84499412
-  data.tar.gz: b73d608cc75bc0b00e7af2cb525575f7a400d6514c2dc9d9c9ee7dec29e0da31
+  metadata.gz: d9e2dfffe66ba0ceefe1eb7197a1f1520e55a683e7d741a9445152535aa22c2c
+  data.tar.gz: ab2b84ac05c6ae09d2020059024de384b6289b0b64267f1bbb6060320ccf6fdf
 SHA512:
-  metadata.gz: 706f4b9f3e3bfaf8d381535020b702d044ec34fd449b4b5710cfb2c7f18524ad8c810bcbb1abcfc2f8aa1c75cc49620b09416a31b0b0a64658984cab8f57bad6
-  data.tar.gz: 33536cb6a931eacbac78123a4d905ec05a8171d884703cf59692fc7cd5196d66f60948fb10f97acc7ec218add4f4918d1f158289e47aacc6d2978e1191e4aaa3
+  metadata.gz: 52e63725865bdde06001b9b0c7c44814aa8a4486a59151800181df4ace4bfc8050a8b3175e254a781db4eb3ed3c50b0e55e3177b3f5e463bd7b0d2b47edb913a
+  data.tar.gz: 215a4818de5e28326aab33d6034e3ecb6a21e67600268c15633810d22cd5ef5cb1f24f2a4c012be5fe508b7640b10a475e9f454056ee2be32c207bff420c5b01

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'active_support/inflector'
 
 module Jekyll
   module ArchivesV2
@@ -20,12 +21,12 @@ module Jekyll
 
       # 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"
+      # 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.
+      # documents       - The array of documents that belong in this archive.
       def initialize(site, title, type, collection_name, documents)
         @site   = site
         @documents  = documents
@@ -48,9 +49,9 @@ module Jekyll
 
       # The template of the permalink.
       #
-      # Returns the template String.
+      # Returns the template String as defined in config, else returns default template.
       def template
-        @config.dig("permalinks", type)
+        @config.dig("permalinks", type) || "/:collection/:type/:name/"
       end
 
       # The layout to use for rendering
@@ -64,9 +65,9 @@ module Jekyll
       # desired placeholder replacements. For details see "url.rb".
       def url_placeholders
         if @title.is_a? Hash
-          @title.merge(:collection => @collection_name, :type => @type)
+          @title.merge(:collection => @collection_name, :type => @type.singularize)
         else
-          { :collection => @collection_name, :name => @slug, :type => @type }
+          { :collection => @collection_name, :name => @slug, :type => @type.singularize }
         end
       end
 

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

@@ -2,6 +2,6 @@
 
 module Jekyll
   module ArchivesV2
-    VERSION = "0.0.4"
+    VERSION = "0.0.6"
   end
 end

data/lib/jekyll-archives-v2.rb

@@ -19,11 +19,10 @@ module Jekyll
             "layout"     => "archive",
             "enabled"    => [],
             "permalinks" => {
-              "year"     => "/#{name}/:year/",
-              "month"    => "/#{name}/:year/:month/",
-              "day"      => "/#{name}/:year/:month/:day/",
-              "tag"      => "/#{name}/tag/:name/",
-              "category" => "/#{name}/category/:name/",
+              "year"     => "/:collection/:year/",
+              "month"    => "/:collection/:year/:month/",
+              "day"      => "/:collection/:year/:month/:day/",
+              "tags"      => "/:collection/:type/:name/",
             },
           }
         end
@@ -57,55 +56,54 @@ module Jekyll
       end
 
       # Read archive data from collection
-      def read(collection_name)
-        if enabled?(collection_name, "tags")
-          read_tags(collection_name)
-        end
+      def read(collection)
+        if @config[collection]["enabled"].is_a?(Array)
+          if enabled?(collection, "year") || enabled?(collection, "month") || enabled?(collection, "day")
+            read_dates(collection)
+          end
 
-        if enabled?(collection_name, "categories")
-          read_categories(collection_name)
-        end
+          # read all attributes that are not year, month, or day
+          attributes = @config[collection]["enabled"].select { |attr| !["year", "month", "day"].include?(attr) }
 
-        if enabled?(collection_name, "year") || enabled?(collection_name, "month") || enabled?(collection_name, "day")
-          read_dates(collection_name)
-        end
-      end
+          attributes.each do |attr|
+            read_attrs(collection, attr)
+          end
+
+        elsif @config[collection]["enabled"] == true || @config[collection]["enabled"] == "all"
+          read_dates(collection)
 
-      def read_tags(collection_name)
-        tags(@collections[collection_name]).each do |title, documents|
-          @archives << Archive.new(@site, title, "tag", collection_name, documents)
+          # create a list of all attributes
+          attributes = @collections[collection].docs.flat_map { |doc| doc.data.keys }.uniq
+          # discard any attribute that is not an array
+          attributes.reject! { |attr| @collections[collection].docs.all? { |doc| !doc.data[attr].is_a?(Array) } }
+
+          attributes.each do |attr|
+            read_attrs(collection, attr)
+          end
         end
       end
 
-      def read_categories(collection_name)
-        categories(@collections[collection_name]).each do |title, documents|
-          @archives << Archive.new(@site, title, "category", collection_name, documents)
+      def read_attrs(collection, attr)
+        doc_attr_hash(@collections[collection], attr).each do |title, documents|
+          @archives << Archive.new(@site, title, attr, collection, 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_documents)
+      def read_dates(collection)
+        years(@collections[collection]).each do |year, y_documents|
+          append_enabled_date_type({ :year => year }, "year", collection, y_documents)
           months(y_documents).each do |month, m_documents|
-            append_enabled_date_type({ :year => year, :month => month }, "month", collection_name, m_documents)
+            append_enabled_date_type({ :year => year, :month => month }, "month", collection, m_documents)
             days(m_documents).each do |day, d_documents|
-              append_enabled_date_type({ :year => year, :month => month, :day => day }, "day", collection_name, d_documents)
+              append_enabled_date_type({ :year => year, :month => month, :day => day }, "day", collection, d_documents)
             end
           end
         end
       end
 
       # Checks if archive type is enabled in config
-      def enabled?(collection_name, archive)
-        @config[collection_name]["enabled"] == true || @config[collection_name]["enabled"] == "all" || (@config[collection_name]["enabled"].is_a?(Array) && @config[collection_name]["enabled"].include?(archive))
-      end
-
-      def tags(documents)
-        doc_attr_hash(documents, "tags")
-      end
-
-      def categories(documents)
-        doc_attr_hash(documents, "categories")
+      def enabled?(collection, archive)
+        @config[collection]["enabled"] == true || @config[collection]["enabled"] == "all" || (@config[collection]["enabled"].is_a?(Array) && @config[collection]["enabled"].include?(archive))
       end
 
       # Custom `post_attr_hash` method for years
@@ -128,12 +126,12 @@ module Jekyll
       # 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)
+      # meta       - A Hash of the year / month / day as applicable for date.
+      # type       - The type of date archive.
+      # collection - the name of the collection
+      # documents  - The array of documents that belong in the date archive.
+      def append_enabled_date_type(meta, type, collection, documents)
+        @archives << Archive.new(@site, meta, type, collection, documents) if enabled?(collection, type)
       end
 
       # Custom `post_attr_hash` for date type archives.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-archives-v2
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - George Corrêa de Araújo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-30 00:00:00.000000000 Z
+date: 2024-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -30,6 +30,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -124,10 +138,14 @@ files:
 - lib/jekyll-archives-v2/archive.rb
 - lib/jekyll-archives-v2/page_drop.rb
 - lib/jekyll-archives-v2/version.rb
-homepage: https://github.com/george-gca/jekyll-archives-v2
+homepage: https://george-gca.github.io/jekyll-archives-v2/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/george-gca/jekyll-archives-v2
+  bug_tracker_uri: https://github.com/george-gca/jekyll-archives-v2/issues
+  changelog_uri: https://github.com/george-gca/jekyll-archives-v2/releases
+  homepage_uri: https://george-gca.github.io/jekyll-archives-v2/
 post_install_message:
 rdoc_options: []
 require_paths: