jekyll-archives 2.1.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2f27192f95a4ce144e1d72588b4bf80d765357f2
-  data.tar.gz: 2e51316514e8d6020cfc281c302b9854e66e7c4b
+SHA256:
+  metadata.gz: 50b7b8aebac240d8301566358280400e017127a035a5d31ab4e7eea412b17199
+  data.tar.gz: e2443238bbb35443bf37bfce255492ba035ab3d46d54a6be7dcf5cab28548a2f
 SHA512:
-  metadata.gz: 6a07cb99f2004e548f0b386485f1f6a5ec9139b24f99db985a8a3e1b55ae42459fe07826aa5eaadc92f8454bbf5a82d3ff5c0b9891e1a0aa557190b6da5dd6a6
-  data.tar.gz: f46620e903c6a09d2bd7ac414162d45eaeacf7a3f95ce407b6cb4e2dabe63358bd8e9946698bff2b32b436fbaa17da34fe24ad74df8b6ce51d48b40db18749d5
+  metadata.gz: f001b57c44f9ccc6f4664695b7159c0961e2bc4c202343c9ab25e11b1484d529547277937d38023254be55f4dc231b595d4e0ad274c61d189e5607ab2b9d40d5
+  data.tar.gz: 2e49eb77fa4803b0407f23940de2139c0e2929f5fef86d6785a501f5dbbf44837c6bc62a6eddcea22ed6250fa3e501d4a87c55f9d2af0ab8c4dc2a553aff7585

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-present Alfred Xing and the jekyll-archives 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/archive.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Archives
     class Archive < Jekyll::Page
-
       attr_accessor :posts, :type, :slug
 
       # Attributes for Liquid templates
@@ -13,6 +14,7 @@ module Jekyll
         name
         path
         url
+        permalink
       ).freeze
 
       # Initialize a new Archive page
@@ -27,12 +29,8 @@ module Jekyll
         @posts  = posts
         @type   = type
         @title  = title
-        @config = site.config['jekyll-archives']
-
-        # Generate slug if tag or category (taken from jekyll/jekyll/features/support/env.rb)
-        if title.to_s.length
-          @slug = Utils.slugify(title.to_s)
-        end
+        @config = site.config["jekyll-archives"]
+        @slug   = slugify_string_title
 
         # Use ".html" for file extension and url for path
         @ext  = File.extname(relative_path)
@@ -40,7 +38,7 @@ module Jekyll
         @name = File.basename(relative_path, @ext)
 
         @data = {
-          "layout" => layout
+          "layout" => layout,
         }
         @content = ""
       end
@@ -49,25 +47,21 @@ module Jekyll
       #
       # Returns the template String.
       def template
-        @config['permalinks'][type]
+        @config.dig("permalinks", type)
       end
 
       # The layout to use for rendering
       #
       # Returns the layout as a String
       def layout
-        if @config['layouts'] && @config['layouts'][type]
-          @config['layouts'][type]
-        else
-          @config['layout']
-        end
+        @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({ :type => @type })
+          @title.merge(:type => @type)
         else
           { :name => @slug, :type => @type }
         end
@@ -77,13 +71,17 @@ module Jekyll
       #
       # Returns the String url.
       def url
-        @url ||= URL.new({
-          :template => template,
+        @url ||= URL.new(
+          :template     => template,
           :placeholders => url_placeholders,
-          :permalink => nil
-        }).to_s
+          :permalink    => nil
+        ).to_s
       rescue ArgumentError
-        raise ArgumentError.new "Template \"#{template}\" provided is invalid."
+        raise ArgumentError, "Template #{template.inspect} 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.
@@ -91,17 +89,17 @@ module Jekyll
       # Returns a String (for tag and category archives) and nil for
       # date-based archives.
       def title
-        if @title.is_a? String
-          @title
-        end
+        @title if @title.is_a?(String)
       end
 
       # Produce a date object if a date-based archive
       #
       # Returns a Date.
       def date
-        if @title.is_a? Hash
-          args = @title.values.map { |s| s.to_i }
+        return unless @title.is_a?(Hash)
+
+        @date ||= begin
+          args = @title.values.map(&:to_i)
           Date.new(*args)
         end
       end
@@ -110,14 +108,33 @@ module Jekyll
       #
       # Returns the destination relative path String.
       def relative_path
-        path = URL.unescape_path(url).gsub(/^\//, '')
-        path = File.join(path, "index.html") if url =~ /\/$/
-        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.to_s} @title=#{@title} @data=#{@data.inspect}>"
+        "#<Jekyll:Archive @type=#{@type} @title=#{@title} @data=#{@data.inspect}>"
+      end
+
+      # The Liquid representation of this page.
+      def to_liquid
+        @to_liquid ||= Jekyll::Archives::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

data/lib/jekyll-archives/page_drop.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Archives
+    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/version.rb

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

data/lib/jekyll-archives.rb

@@ -1,48 +1,49 @@
-require 'jekyll'
+# frozen_string_literal: true
+
+require "jekyll"
 
 module Jekyll
   module Archives
     # Internal requires
-    autoload :Archive, 'jekyll-archives/archive'
-    autoload :VERSION, 'jekyll-archives/version'
-
-    if (Jekyll.const_defined? :Hooks)
-      Jekyll::Hooks.register :site, :after_reset do |site|
-        # We need to disable incremental regen for Archives to generate with the
-        # correct content
-        site.regenerator.instance_variable_set(:@disabled, true)
-      end
-    end
+    autoload :Archive,  "jekyll-archives/archive"
+    autoload :PageDrop, "jekyll-archives/page_drop"
+    autoload :VERSION,  "jekyll-archives/version"
 
     class Archives < Jekyll::Generator
       safe true
 
       DEFAULTS = {
-        'layout' => 'archive',
-        'enabled' => [],
-        'permalinks' => {
-          'year' => '/:year/',
-          'month' => '/:year/:month/',
-          'day' => '/:year/:month/:day/',
-          'tag' => '/tag/:name/',
-          'category' => '/category/:name/'
-        }
-      }
-
-      def initialize(config = nil)
-        if config['jekyll-archives'].nil?
-          @config = DEFAULTS
+        "layout"     => "archive",
+        "enabled"    => [],
+        "permalinks" => {
+          "year"     => "/:year/",
+          "month"    => "/:year/:month/",
+          "day"      => "/:year/:month/:day/",
+          "tag"      => "/tag/:name/",
+          "category" => "/category/:name/",
+        },
+      }.freeze
+
+      def initialize(config = {})
+        archives_config = config.fetch("jekyll-archives", {})
+        if archives_config.is_a?(Hash)
+          @config = Utils.deep_merge_hashes(DEFAULTS, archives_config)
         else
-          @config = Utils.deep_merge_hashes(DEFAULTS, config['jekyll-archives'])
+          @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
+        @enabled = @config && @config["enabled"]
       end
 
       def generate(site)
+        return if @config.nil?
+
         @site = site
         @posts = site.posts
         @archives = []
 
-        @site.config['jekyll-archives'] = @config
+        @site.config["jekyll-archives"] = @config
 
         read
         @site.pages.concat(@archives)
@@ -74,12 +75,12 @@ module Jekyll
       end
 
       def read_dates
-        years.each do |year, posts|
-          @archives << Archive.new(@site, { :year => year }, "year", posts) if enabled? "year"
-          months(posts).each do |month, posts|
-            @archives << Archive.new(@site, { :year => year, :month => month }, "month", posts) if enabled? "month"
-            days(posts).each do |day, posts|
-              @archives << Archive.new(@site, { :year => year, :month => month, :day => day }, "day", posts) if enabled? "day"
+        years.each do |year, y_posts|
+          append_enabled_date_type({ :year => year }, "year", y_posts)
+          months(y_posts).each do |month, m_posts|
+            append_enabled_date_type({ :year => year, :month => month }, "month", m_posts)
+            days(m_posts).each do |day, d_posts|
+              append_enabled_date_type({ :year => year, :month => month, :day => day }, "day", d_posts)
             end
           end
         end
@@ -87,44 +88,52 @@ module Jekyll
 
       # Checks if archive type is enabled in config
       def enabled?(archive)
-        @config["enabled"] == true || @config["enabled"] == "all" || if @config["enabled"].is_a? Array
-          @config["enabled"].include? archive
-        end
+        @enabled == true || @enabled == "all" || (@enabled.is_a?(Array) && @enabled.include?(archive))
       end
 
       def tags
-        @site.post_attr_hash('tags')
+        @site.tags
       end
 
       def categories
-        @site.post_attr_hash('categories')
+        @site.categories
       end
 
       # Custom `post_attr_hash` method for years
       def years
-        hash = Hash.new { |h, key| h[key] = [] }
-
-        # In Jekyll 3, Collection#each should be called on the #docs array directly.
-        if Jekyll::VERSION >= '3.0.0' 
-          @posts.docs.each { |p| hash[p.date.strftime("%Y")] << p }
-        else
-          @posts.each { |p| hash[p.date.strftime("%Y")] << p }
-        end
-        hash.values.each { |posts| posts.sort!.reverse! }
-        hash
+        date_attr_hash(@posts.docs, "%Y")
       end
 
+      # Custom `post_attr_hash` method for months
       def months(year_posts)
-        hash = Hash.new { |h, key| h[key] = [] }
-        year_posts.each { |p| hash[p.date.strftime("%m")] << p }
-        hash.values.each { |posts| posts.sort!.reverse! }
-        hash
+        date_attr_hash(year_posts, "%m")
       end
 
+      # Custom `post_attr_hash` method for days
       def days(month_posts)
-        hash = Hash.new { |h, key| h[key] = [] }
-        month_posts.each { |p| hash[p.date.strftime("%d")] << p }
-        hash.values.each { |posts| posts.sort!.reverse! }
+        date_attr_hash(month_posts, "%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.
+      # posts - The array of posts that belong in the date archive.
+      def append_enabled_date_type(meta, type, posts)
+        @archives << Archive.new(@site, meta, type, posts) if enabled?(type)
+      end
+
+      # Custom `post_attr_hash` for date type archives.
+      #
+      # posts - Array of posts to be considered for archiving.
+      # id    - String used to format post date via `Time.strptime` e.g. %Y, %m, etc.
+      def date_attr_hash(posts, id)
+        hash = Hash.new { |hsh, key| hsh[key] = [] }
+        posts.each { |post| hash[post.date.strftime(id)] << post }
+        hash.each_value { |posts_in_hsh| posts_in_hsh.sort!.reverse! }
         hash
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-archives
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Alfred Xing
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-18 00:00:00.000000000 Z
+date: 2024-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -16,78 +16,31 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+        version: '3.6'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.4'
-- !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: shoulda
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '5.0'
+  type: :runtime
   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:
-    - - ">="
+        version: '3.6'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 description: Automatically generate post archives by dates, tags, and categories.
 email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - lib/jekyll-archives.rb
 - lib/jekyll-archives/archive.rb
+- lib/jekyll-archives/page_drop.rb
+- lib/jekyll-archives/version.rb
 homepage: https://github.com/jekyll/jekyll-archives
 licenses:
 - MIT
@@ -100,15 +53,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Post archives for Jekyll.