jekyll-archives-v2 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9e2dfffe66ba0ceefe1eb7197a1f1520e55a683e7d741a9445152535aa22c2c
-  data.tar.gz: ab2b84ac05c6ae09d2020059024de384b6289b0b64267f1bbb6060320ccf6fdf
+  metadata.gz: 754709d370320a7e9e7a2036aca0dcec025f89674be854b89f6e588d6e1b2d4a
+  data.tar.gz: 5fdfed2761628f0fc89c1136072b3d6c4df9c529f90f4d96fcd5c8fb20809fe6
 SHA512:
-  metadata.gz: 52e63725865bdde06001b9b0c7c44814aa8a4486a59151800181df4ace4bfc8050a8b3175e254a781db4eb3ed3c50b0e55e3177b3f5e463bd7b0d2b47edb913a
-  data.tar.gz: 215a4818de5e28326aab33d6034e3ecb6a21e67600268c15633810d22cd5ef5cb1f24f2a4c012be5fe508b7640b10a475e9f454056ee2be32c207bff420c5b01
+  metadata.gz: f2b8a5bc2179dcab6729b07646405c233b51169a70211dd6ac74b440b246860677ffe097c30a40b6f4381314ba7494cbb0f0b8941c83184ecfa6b7e5e99ee536
+  data.tar.gz: a02fd9b0b5d1fe9cd177db5961bc8206a6614b05f2312df067a8554f210af6248eec64edf77de5b6b4b39ddb0d6069886bb6bcae66726b49df2320776612d050

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024-present George Corrêa de Araújo and the jekyll-archives-v2 contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require 'active_support/inflector'
+
+require "active_support/inflector"
 
 module Jekyll
   module ArchivesV2
@@ -28,8 +29,8 @@ module Jekyll
       # 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
+        @site = site
+        @documents = documents
         @type   = type
         @title  = title
         @collection_name = collection_name
@@ -81,11 +82,11 @@ module Jekyll
           :permalink    => nil
         ).to_s
       rescue ArgumentError
-        raise ArgumentError, "Template \"#{template}\" provided is invalid."
+        raise ArgumentError, "Template #{template.inspect} provided is invalid."
       end
 
       def permalink
-        data&.is_a?(Hash) && data["permalink"]
+        data.is_a?(Hash) && data["permalink"]
       end
 
       # Produce a title object suitable for Liquid based on type of archive.
@@ -93,7 +94,7 @@ module Jekyll
       # Returns a String (for tag and category archives) and nil for
       # date-based archives.
       def title
-        @title if @title.is_a? String
+        @title if @title.is_a?(String)
       end
 
       # Produce a date object if a date-based archive

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

@@ -7,7 +7,8 @@ module Jekyll
 
       mutable false
 
-      def_delegators :@obj, :collection_name, :documents, :type, :title, :date, :name, :path, :url, :permalink
+      def_delegators :@obj, :collection_name, :documents, :type, :title, :date, :name, :path, :url,
+                     :permalink
       private def_delegator :@obj, :data, :fallback_data
     end
   end

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

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

data/lib/jekyll-archives-v2.rb

@@ -11,18 +11,19 @@ module Jekyll
 
     class Archives < Jekyll::Generator
       safe true
+      DATE_ENABLES = %w(year month day).freeze
 
       def initialize(config = {})
         defaults = {}
-        config.fetch("collections", {}).each do |name, collection|
+        config.fetch("collections", {}).each do |name, _collection|
           defaults[name] = {
             "layout"     => "archive",
             "enabled"    => [],
             "permalinks" => {
-              "year"     => "/:collection/:year/",
-              "month"    => "/:collection/:year/:month/",
-              "day"      => "/:collection/:year/:month/:day/",
-              "tags"      => "/:collection/:type/:name/",
+              "year"  => "/:collection/:year/",
+              "month" => "/:collection/:year/:month/",
+              "day"   => "/:collection/:year/:month/:day/",
+              "tags"  => "/:collection/:type/:name/",
             },
           }
         end
@@ -47,7 +48,7 @@ module Jekyll
         @site.config["jekyll-archives"] = @config
 
         # loop through collections keys and read them
-        @config.each do |collection_name, collection_config|
+        @config.each do |collection_name, _collection_config|
           read(collection_name)
         end
 
@@ -58,19 +59,23 @@ module Jekyll
       # Read archive data from collection
       def read(collection)
         if @config[collection]["enabled"].is_a?(Array)
-          if enabled?(collection, "year") || enabled?(collection, "month") || enabled?(collection, "day")
-            read_dates(collection)
+          use_year = @config[collection]["enabled"].include?("year")
+          use_month = @config[collection]["enabled"].include?("month")
+          use_day = @config[collection]["enabled"].include?("day")
+
+          if use_year || use_month || use_day
+            read_dates(collection, :use_year => use_year, :use_month => use_month, :use_day => use_day)
           end
 
           # read all attributes that are not year, month, or day
-          attributes = @config[collection]["enabled"].select { |attr| !["year", "month", "day"].include?(attr) }
+          attributes = @config[collection]["enabled"].reject { |attr| DATE_ENABLES.include?(attr) }
 
           attributes.each do |attr|
             read_attrs(collection, attr)
           end
 
         elsif @config[collection]["enabled"] == true || @config[collection]["enabled"] == "all"
-          read_dates(collection)
+          read_dates(collection, :use_year => true, :use_month => true, :use_day => true)
 
           # create a list of all attributes
           attributes = @collections[collection].docs.flat_map { |doc| doc.data.keys }.uniq
@@ -89,23 +94,28 @@ module Jekyll
         end
       end
 
-      def read_dates(collection)
+      def read_dates(collection, use_year: false, use_month: false, use_day: false)
         years(@collections[collection]).each do |year, y_documents|
-          append_enabled_date_type({ :year => year }, "year", collection, y_documents)
+          if use_year
+            @archives << Archive.new(@site, { :year => year }, "year", collection, y_documents)
+          end
+
+          next unless use_month || use_day
+
           months(y_documents).each do |month, m_documents|
-            append_enabled_date_type({ :year => year, :month => month }, "month", collection, m_documents)
+            if use_month
+              @archives << Archive.new(@site, { :year => year, :month => month }, "month", collection, m_documents)
+            end
+
+            next unless use_day
+
             days(m_documents).each do |day, d_documents|
-              append_enabled_date_type({ :year => year, :month => month, :day => day }, "day", collection, d_documents)
+              @archives << Archive.new(@site, { :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, 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
       def years(documents)
         date_attr_hash(documents.docs, "%Y")
@@ -123,17 +133,6 @@ module Jekyll
 
       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 - 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.
       #
       # documents - Array of documents to be considered for archiving.
@@ -141,7 +140,7 @@ module Jekyll
       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.each_value { |documents_in_hsh| documents_in_hsh.sort!.reverse! }
         hash
       end
 
@@ -153,7 +152,12 @@ module Jekyll
         # 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 } }
+        documents.docs.each do |document|
+          attr_value = document.data[doc_attr]
+          next if attr_value.nil?
+          attr_value = [attr_value] if attr_value.is_a?(String)
+          attr_value.each { |t| hash[t] << document }
+        end
         hash.each_value { |documents| documents.sort!.reverse! }
         hash
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-archives-v2
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - George Corrêa de Araújo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-05 00:00:00.000000000 Z
+date: 2026-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -44,96 +44,13 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '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:
+- LICENSE
 - lib/jekyll-archives-v2.rb
 - lib/jekyll-archives-v2/archive.rb
 - lib/jekyll-archives-v2/page_drop.rb
@@ -154,14 +71,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Collections archives for Jekyll.