jekyll_plugin_support 1.0.3 → 3.0.0

data/jekyll_plugin_support.gemspec

@@ -3,12 +3,12 @@ require_relative 'lib/jekyll_plugin_support/version'
 Gem::Specification.new do |spec|
   github = 'https://github.com/mslinn/jekyll_plugin_support'
 
-  spec.bindir = 'exe'
-  spec.authors = ['Mike Slinn']
-  spec.email = ['mslinn@mslinn.com']
-  spec.files = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec}/**/*', '*.gemspec', '*.md']
+  spec.bindir   = 'exe'
+  spec.authors  = ['Mike Slinn']
+  spec.email    = ['mslinn@mslinn.com']
+  spec.files    = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec}/**/*', '*.gemspec', '*.md']
   spec.homepage = 'https://www.mslinn.com/jekyll_plugins/jekyll_plugin_support.html'
-  spec.license = 'MIT'
+  spec.license  = 'MIT'
   spec.metadata = {
     'allowed_push_host' => 'https://rubygems.org',
     'bug_tracker_uri'   => "#{github}/issues",
@@ -16,21 +16,23 @@ Gem::Specification.new do |spec|
     'homepage_uri'      => spec.homepage,
     'source_code_uri'   => github,
   }
-  spec.name = 'jekyll_plugin_support'
+  spec.name                 = 'jekyll_plugin_support'
+  spec.platform             = Gem::Platform::RUBY
   spec.post_install_message = <<~END_MESSAGE
 
     Thanks for installing #{spec.name}!
 
   END_MESSAGE
-  spec.require_paths = ['lib']
+  spec.require_paths         = ['lib']
   spec.required_ruby_version = '>= 2.6.0'
-  spec.summary = 'Provides a framework for writing and testing Jekyll plugins'
-  spec.test_files = spec.files.grep %r{^(test|spec|features)/}
-  spec.version = JekyllPluginSupportVersion::VERSION
+  spec.summary               = 'Provides a framework for writing and testing Jekyll plugins'
+  spec.test_files            = spec.files.grep %r{^(test|spec|features)/}
+  spec.version               = JekyllPluginSupportVersion::VERSION
 
   spec.add_dependency 'facets'
-  spec.add_dependency 'jekyll', '>= 3.5.0'
+  spec.add_dependency 'jekyll', '>= 4.4.1'
   spec.add_dependency 'jekyll_plugin_logger'
   spec.add_dependency 'key-value-parser'
   spec.add_dependency 'pry'
+  spec.add_dependency 'sorted_set'
 end

data/lib/block/jekyll_plugin_support_block.rb

@@ -1,5 +1,3 @@
-require_relative '../error/jekyll_plugin_error_handling'
-
 module JekyllSupport
   # Base class for Jekyll block tags
   class JekyllBlock < Liquid::Block
@@ -8,22 +6,34 @@ module JekyllSupport
     # See https://github.com/Shopify/liquid/wiki/Liquid-for-Programmers#create-your-own-tags
     # @param tag_name [String] the name of the tag, which we usually know.
     # @param argument_string [String] the arguments passed to the tag, as a single string.
-    # @param parse_context [Liquid::ParseContext] hash that stores Liquid options.
-    #        By default it has two keys: :locale and :line_numbers, the first is a Liquid::I18n object, and the second,
-    #        a boolean parameter that determines if error messages should display the line number the error occurred.
-    #        This argument is used mostly to display localized error messages on Liquid built-in Tags and Filters.
-    #        See https://github.com/Shopify/liquid/wiki/Liquid-for-Programmers#create-your-own-tags
+    # @param parse_context [Liquid::ParseContext] contains the following attributes:
+    #        @depth might have the value 0
+    #        @error_mode might have the value `:strict`
+    #        @line_number duplicates @ptions[:line_number]
+    #        @locale duplicates @ptions[:locale]
+    #        @options is a hash with the following two keys that holds Liquid options:
+    #          :locale is a Liquid::I18n object, used to display localized error messages on Liquid built-in tags and filters.
+    #          :line_number is the line number containing the plugin invocation.
+    #          See https://github.com/Shopify/liquid/wiki/Liquid-for-Programmers#create-your-own-tags
+    #        @partial Boolean, unclear what this indicates
+    #        @template_options Replicates @options
+    #        @trim_whitespace might have the value `false`
+    #        @warnings array
     # @return [void]
     def initialize(tag_name, markup, parse_context)
       super
       @tag_name = tag_name
-      @argument_string = markup.to_s # Vars in plugin parameters cannot be replaced yet
+      raise JekyllPluginSupportError, "markup is a #{markup.class} with value '#{markup}'." unless markup.instance_of? String
+
+      # Lookup variable names with values in markup in render because site and config are not available here
+      @argument_string = markup # Replace variable names with values in markup in render because site and config are not available here
+
       @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
       @logger.debug { "#{self.class}: respond_to?(:no_arg_parsing) #{respond_to?(:no_arg_parsing) ? 'yes' : 'no'}." }
       @helper = JekyllPluginHelper.new tag_name, markup, @logger, respond_to?(:no_arg_parsing)
 
       @error_name = "#{tag_name.camelcase(:upper)}Error"
-      JekyllSupport::CustomError.factory @error_name
+      ::JekyllSupport::CustomError.factory @error_name
     end
 
     # Liquid::Block subclasses do not render if there is no content within the tag
@@ -36,11 +46,11 @@ module JekyllSupport
     # Defines @config, @envs, @mode, @page and @site
     # @return [String]
     def render(liquid_context)
-      @helper.liquid_context = JekyllSupport.inject_vars @logger, liquid_context
+      @helper.liquid_context = ::JekyllSupport.inject_config_vars liquid_context # modifies liquid_context
       text = super # Liquid variable values in content are looked up and substituted
 
       @envs      = liquid_context.environments.first
-      @page      = liquid_context.registers[:page] # hash
+      @page      = liquid_context.registers[:page]
       @scopes    = liquid_context.scopes
       @site      = liquid_context.registers[:site]
 
@@ -51,6 +61,7 @@ module JekyllSupport
 
       set_error_context
 
+      # @envs.keys are :content, :highlighter_prefix, :highlighter_suffix, :jekyll, :layout, :page, :paginator, :site, :theme
       @layout    = @envs[:layout]
       @paginator = @envs[:paginator]
       @theme     = @envs[:theme]
@@ -58,18 +69,23 @@ module JekyllSupport
       env = @config['env']
       @mode = env&.key?('JEKYLL_ENV') ? env['JEKYLL_ENV'] : 'development'
 
-      @helper.reinitialize @markup.strip
+      @argument_string = JekyllSupport.lookup_liquid_variables @logger, @helper.liquid_context, @argument_string.to_s.strip
+      @helper.reinitialize @argument_string.to_s.strip
 
       @attribution = @helper.parameter_specified?('attribution') || false unless @no_arg_parsing
       @logger.debug { "@keys_values='#{@keys_values}'" }
 
-      markup = JekyllSupport.lookup_liquid_variables liquid_context, @argument_string
-      @helper.reinitialize markup
+      # @argument_string = JekyllSupport.lookup_liquid_variables @logger, liquid_context, @argument_string # Is this redundant?
+      # @argument_string.strip! # Is this redundant?
+      # @helper.reinitialize @argument_string # Is this redundant?
 
       render_impl(text)
     rescue StandardError => e
       e.shorten_backtrace
-      @logger.error { "#{e.class} on line #{@line_number} of #{e.backtrace[0].split(':').first} by #{@tag_name} - #{e.message}" }
+      file_name = e.backtrace[0]&.split(':')&.first
+      in_file_name = "in '#{file_name}' " if file_name
+      of_page = "of '#{@page['path']}'" if @page
+      @logger.error { "#{e.class} on line #{@line_number} #{of_page} while processing #{tag_name} #{in_file_name}- #{e.message}" }
       binding.pry if @pry_on_standard_error # rubocop:disable Lint/Debugger
       raise e if @die_on_standard_error
 

data/lib/block/jekyll_plugin_support_block_noarg.rb

@@ -1,5 +1,3 @@
-require_relative '../error/jekyll_plugin_error_handling'
-
 module JekyllSupport
   class JekyllBlockNoArgParsing < JekyllBlock
     attr_reader :argument_string, :helper, :line_number, :logger, :page, :site

data/lib/generator/jekyll_plugin_support_generator.rb

@@ -1,6 +1,3 @@
-require 'jekyll'
-require_relative '../error/jekyll_plugin_error_handling'
-
 module JekyllSupport
   # Base class for Jekyll generators.
   # PluginMetaLogger.instance.config is populated with the contents of `_config.yml` before Jekyll::Generator instances run.
@@ -14,7 +11,6 @@ module JekyllSupport
       @logger ||= PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
 
       @error_name = "#{self.class.name}Error"
-      # JekyllSupport::CustomError.factory @error_name
 
       @site   = site
       @config = @site.config
@@ -23,8 +19,6 @@ module JekyllSupport
 
       @mode = ENV['JEKYLL_ENV'] || 'development'
 
-      # set_error_context(self.class)
-
       generate_impl
     rescue StandardError => e
       e.shorten_backtrace
@@ -62,7 +56,7 @@ module JekyllSupport
       PluginMetaLogger.instance.info { msg }
     end
 
-    def set_error_context(klass)
+    def set_error_context(klass) # rubocop:disable Naming/AccessorMethodName
       return unless Object.const_defined? @error_name
 
       error_class = Object.const_get @error_name

data/lib/helper/jekyll_plugin_helper.rb

@@ -1,14 +1,13 @@
 require 'facets/string/interpolate'
 require 'key_value_parser'
 require 'shellwords'
-require_relative 'jekyll_plugin_helper_class'
-require_relative 'jekyll_plugin_helper_attribution'
 
 module JekyllSupport
   class JekyllPluginHelper
     attr_accessor :liquid_context
-    attr_reader :argv, :attribution, :keys_values, :logger, :markup, :no_arg_parsing, :params, :tag_name,
-                :argv_original, :excerpt_caller, :keys_values_original, :params_original, :jpsh_subclass_caller
+    attr_reader :argument_string, :argv, :argv_original, :attribution, :excerpt_caller, :keys_values_original,
+                :keys_values, :jpsh_subclass_caller, :logger, :markup, :no_arg_parsing, :params, :params_original,
+                :tag_name
 
     # See https://github.com/Shopify/liquid/wiki/Liquid-for-Programmers#create-your-own-tags
     # @param tag_name [String] the name of the tag, which we already know.
@@ -22,8 +21,9 @@ module JekyllSupport
     def initialize(tag_name, markup, logger, no_arg_parsing)
       @tag_name = tag_name
       @logger = logger
-      @no_arg_parsing = no_arg_parsing
       @markup = markup
+      @argument_string = markup
+      @no_arg_parsing = no_arg_parsing
     rescue StandardError => e
       e.shorten_backtrace
       @logger.error { e.message }
@@ -42,7 +42,7 @@ module JekyllSupport
 
     def reinitialize(markup)
       # @keys_values was a Hash[Symbol, String|Boolean] but now it is Hash[String, String|Boolean]
-      @markup = markup
+      @argument_string = markup
       if @no_arg_parsing
         define_singleton_method(:argv) { warn_fetch :argv }
         define_singleton_method(:keys_values) { warn_fetch :keys_values }

data/lib/helper/jekyll_plugin_helper_class.rb

@@ -55,7 +55,10 @@ module JekyllSupport
       END_MSG
     end
 
-    def self.register(klass, tag_name)
+    # @param klass [Class] class instance to register
+    # @param tag_name [String] name of plugin defined by klass to register as
+    # @param quiet [Boolean] suppress registration message if truthy
+    def self.register(klass, tag_name, quiet: false)
       abort("Error: The #{tag_name} plugin does not define VERSION") \
         unless klass.const_defined?(:VERSION)
 
@@ -63,10 +66,12 @@ module JekyllSupport
 
       abort("Error: The #{tag_name} plugin is not an instance of JekyllSupport::JekyllBlock or JekyllSupport::JekyllTag") \
         unless klass.instance_of?(Class) &&
-               (klass.ancestors.include?(JekyllSupport::JekyllBlock) ||
-                klass.ancestors.include?(JekyllSupport::JekyllTag))
+               (klass.ancestors.include?(::JekyllSupport::JekyllBlock) ||
+                klass.ancestors.include?(::JekyllSupport::JekyllTag))
 
       Liquid::Template.register_tag(tag_name, klass)
+      return if quiet
+
       msg = generate_message(klass, tag_name, version)
       PluginMetaLogger.instance.info { msg }
     end

data/lib/hooks/a_page.rb

@@ -0,0 +1,69 @@
+module AllCollectionsHooks
+  class APage
+    attr_reader :content, :data, :date, :description, :destination, :draft, :excerpt, :ext, :extname, :href,
+                :label, :last_modified, :layout, :origin, :path, :relative_path, :tags, :title, :type, :url
+
+    def initialize(obj, origin)
+      @origin = origin
+      data_field_init obj
+      obj_field_init obj
+      @draft = Jekyll::Draft.draft? obj
+      @href = @url if @href.nil?
+      # @href = "/#{@href}" if @origin == 'individual_page'
+      @href = "#{@href}index.html" if @href.end_with? '/'
+      @name = File.basename(@href)
+      @title = if @data&.key?('title')
+                 @data['title']
+               elsif obj.respond_to?(:title)
+                 obj.title
+               else
+                 "<code>#{@href}</code>"
+               end
+    rescue StandardError => e
+      JekyllSupport.error_short_trace(@logger, e)
+      # JekyllSupport.warn_short_trace(@logger, e)
+    end
+
+    def to_s
+      @label || @date.to_s
+    end
+
+    private
+
+    def data_field_init(obj)
+      return unless obj.respond_to? :data
+
+      @data = obj.data
+
+      @categories = @data['categories'] if @data.key? 'categories'
+      @date = (@data['date'].to_date if @data&.key?('date')) || Date.today
+      @description = @data['description'] if @data.key? 'description'
+      @excerpt = @data['excerpt'] if @data.key? 'excerpt'
+      @ext ||= @data['ext'] if @data.key? 'ext'
+      @last_modified = @data['last_modified'] || @data['last_modified_at'] || @date
+      @last_modified_field = case @data
+                             when @data.key?('last_modified')
+                               'last_modified'
+                             when @data.key?('last_modified_at')
+                               'last_modified_at'
+                             end
+      @layout = @data['layout'] if @data.key? 'layout'
+      @tags = @data['tags'] if @data.key? 'tags'
+    end
+
+    def obj_field_init(obj)
+      @content = obj.content if obj.respond_to? :content
+
+      # TODO: What _config.yml setting should be passed to destination()?
+      @destination = obj.destination('') if obj.respond_to? :destination
+      @ext = obj.extname
+      @extname = @ext # For compatibility with previous versions of all_collections
+      @label = obj.collection.label if obj.respond_to?(:collection) && obj.collection.respond_to?(:label)
+      @path = obj.path if obj.respond_to? :path
+      @relative_path = obj.relative_path if obj.respond_to? :relative_path
+      @type = obj.type if obj.respond_to? :type
+      @url = obj.url
+      @url = "#{@url}index.html" if @url.end_with? '/'
+    end
+  end
+end

data/lib/hooks/all_collections_hooks.rb

@@ -0,0 +1,61 @@
+module JekyllAllCollections
+  module AllCollectionsHooks
+    class << self
+      attr_accessor :logger
+    end
+    @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+
+    # No, all_collections is not defined for this hook
+    # Jekyll::Hooks.register(:site, :after_init, priority: :normal) do |site|
+    #   defined_msg = ::AllCollectionsHooks.all_collections_defined?(site)
+    #   @logger.debug { "Jekyll::Hooks.register(:site, :after_init: #{defined_msg}" }
+    # end
+
+    # Creates a `Array[APage]` property called site.all_collections if it does not already exist.
+    # The array is available from :site, :pre_render onwards
+    # Each `APage` entry is one document or page.
+    Jekyll::Hooks.register(:site, :post_read, priority: :normal) do |site|
+      @site = site
+      unless site.class.method_defined? :all_collections
+        defined_msg = ::AllCollectionsHooks.all_collections_defined? site
+        @logger.debug { "Jekyll::Hooks.register(:site, :post_read, :normal: #{defined_msg}" }
+        ::AllCollectionsHooks.compute(site) if !@site.class.method_defined?(:all_documents) || @site.all_documents.nil?
+      end
+    rescue StandardError => e
+      JekyllSupport.error_short_trace(@logger, e)
+      # JekyllSupport.warn_short_trace(@logger, e)
+    end
+
+    # Yes, all_collections is defined for this hook
+    # Jekyll::Hooks.register(:site, :post_read, priority: :low) do |site|
+    #   defined_msg = ::AllCollectionsHooks.all_collections_defined?(site)
+    #   @logger.debug { "Jekyll::Hooks.register(:site, :post_read, :low: #{defined_msg}" }
+    # rescue StandardError => e
+    #   JekyllSupport.error_short_trace(@logger, e)
+    #   # JekyllSupport.warn_short_trace(@logger, e)
+    # end
+
+    # Yes, all_collections is defined for this hook
+    # Jekyll::Hooks.register(:site, :post_read, priority: :normal) do |site|
+    #   defined_msg = ::AllCollectionsHooks.all_collections_defined?(site)
+    #   @logger.debug { "Jekyll::Hooks.register(:site, :post_read, :normal: #{defined_msg}" }
+    # rescue StandardError => e
+    #   JekyllSupport.error_short_trace(@logger, e)
+    #   # JekyllSupport.warn_short_trace(@logger, e)
+    # end
+
+    # Yes, all_collections is defined for this hook
+    # Jekyll::Hooks.register(:site, :pre_render, priority: :normal) do |site, _payload|
+    #   defined_msg = ::AllCollectionsHooks.all_collections_defined?(site)
+    #   @logger.debug { "Jekyll::Hooks.register(:site, :pre_render: #{defined_msg}" }
+    # rescue StandardError => e
+    #   JekyllSupport.error_short_trace(@logger, e)
+    #   # JekyllSupport.warn_short_trace(@logger, e)
+    # end
+  end
+end
+
+PluginMetaLogger.instance.logger.info do
+  "Loaded AllCollectionsHooks v#{JekyllPluginSupportVersion::VERSION} :site, :pre_render, :normal hook plugin."
+end
+Liquid::Template.register_filter(JekyllAllCollections::AllCollectionsHooks)

data/lib/hooks/all_files.rb

@@ -0,0 +1,48 @@
+# Insert the url of a Jekyll::Page into each LruFile instance,
+# along with the Page reference
+# todo: replace references to url and :url with reverse_url and :reverse_url
+LruFile = Struct.new(:url, :page) do
+  include SendChain
+
+  def <=>(other)
+    url <=> other.url
+  end
+
+  def href
+    url.reverse
+  end
+end
+
+# Matches suffixes of an array of urls
+# Converts suffixes to prefixes
+class SortedLruFiles
+  attr_reader :msbs
+
+  def initialize
+    @msbs = MSlinnBinarySearch.new %i[url start_with?]
+  end
+
+  # @param apages [Array[APage]]
+  def add_pages(apages)
+    apages.each { |apage| insert apage.href, apage }
+    @msbs.enable_search
+  end
+
+  def enable_search
+    @msbs.enable_search
+  end
+
+  def find(suffix)
+    @msbs.find suffix
+  end
+
+  def insert(url, file)
+    lru_file = LruFile.new(url.reverse, file)
+    lru_file.new_chain [:url, %i[start_with? placeholder]]
+    @msbs.insert(lru_file)
+  end
+
+  def select(suffix)
+    @msbs.select_pages suffix
+  end
+end

data/lib/hooks/class_methods.rb

@@ -0,0 +1,50 @@
+module AllCollectionsHooks
+  class << self
+    attr_accessor :all_collections, :all_documents, :everything, :sorted_lru_files
+  end
+
+  # @sort_by = ->(apages, criteria) { [apages.sort(criteria)] } # todo delete this
+
+  # @return [String] indicating if :all_collections is defined or not
+  def self.all_collections_defined?(site)
+    "site.all_collections #{site.class.method_defined?(:all_collections) ? 'IS' : 'IS NOT'} defined"
+  end
+
+  # Create Array of AllCollectionsHooks::APage from objects
+  # @param objects [Array] An array of Jekyll::Document, Jekyll::Page or file names
+  # @param origin [String] Indicates type of objects being passed
+  def self.apages_from_objects(objects, origin)
+    pages = []
+    objects.each do |object|
+      page = APage.new(object, origin)
+      pages << page unless page.data['exclude_from_all'] || page.path == 'redirect.html'
+    end
+    pages
+  end
+
+  # Called by early, high-priority hook.
+  # Computes site.all_collections, site.all_documents, site.everything, and site.sorted_lru_files
+  def self.compute(site)
+    site.class.module_eval { attr_accessor :all_collections, :all_documents, :everything, :sorted_lru_files }
+
+    documents = site.collections
+                    .values
+                    .map { |x| x.class.method_defined?(:docs) ? x.docs : x }
+                    .flatten
+                    .compact
+    @all_collections = AllCollectionsHooks.apages_from_objects(documents, 'collection')
+    @all_documents   = @all_collections +
+                       AllCollectionsHooks.apages_from_objects(site.pages, 'individual_page')
+    @everything      = @all_documents +
+                       AllCollectionsHooks.apages_from_objects(site.static_files, 'static_file')
+    @sorted_lru_files = SortedLruFiles.new.add_pages @everything
+
+    site.all_collections  = @all_collections
+    site.all_documents    = @all_documents
+    site.everything       = @everything
+    site.sorted_lru_files = @sorted_lru_files
+  rescue StandardError => e
+    JekyllSupport.error_short_trace(::JekyllAllCollections::AllCollectionsHooks.logger, e)
+    # JekyllSupport.warn_short_trace(::JekyllAllCollections::AllCollectionsHooks.logger, e)
+  end
+end

data/lib/jekyll_all_collections/all_collections_tag.rb

@@ -0,0 +1,157 @@
+# require 'jekyll_draft'
+require 'securerandom'
+
+# @author Copyright 2020 Michael Slinn
+# @license SPDX-License-Identifier: Apache-2.0
+module JekyllAllCollections
+  PLUGIN_NAME = 'all_collections'.freeze unless defined?(PLUGIN_NAME)
+  CRITERIA = %w[date destination draft label last_modified last_modified_at path relative_path title type url].freeze unless defined?(CRITERIA)
+  DRAFT_HTML = '<i class="jekyll_draft">Draft</i>'.freeze unless defined?(DRAFT_HTML)
+
+  class AllCollectionsTag < ::JekyllSupport::JekyllTag
+    include ::JekyllPluginSupportVersion
+
+    # Method prescribed by JekyllTag.
+    # @return [String]
+    def render_impl
+      parse_arguments # Defines instance variables like @sort_by
+      sort_lambda = init_sort_by @sort_by, @sort_by_param
+      @heading = @helper.parameter_specified?('heading') || default_head(@sort_by)
+      generate_output sort_lambda
+    rescue StandardError => e
+      JekyllSupport.error_short_trace @logger, e
+      # JekyllSupport.warn_short_trace @logger, e
+    end
+
+    # Descending sort keys reverse the order of comparison
+    # Example return values:
+    #   "->(a, b) { [a.last_modified] <=> [b.last_modified] }"
+    #   "->(a, b) { [b.last_modified] <=> [a.last_modified] }" (descending)
+    #   "->(a, b) { [a.last_modified, a.date] <=> [b.last_modified, b.date] }" (descending last_modified, ascending date)
+    #   "->(a, b) { [a.last_modified, b.date] <=> [b.last_modified, a.date] }" (ascending last_modified, descending date)
+    def self.create_lambda_string(criteria)
+      criteria_lhs_array = []
+      criteria_rhs_array = []
+      verify_sort_by_type(criteria).each do |c|
+        descending_sort = c.start_with? '-'
+        c.delete_prefix! '-'
+        abort("Error: '#{c}' is not a valid sort field. Valid field names are: #{CRITERIA.join ', '}") \
+          unless CRITERIA.include?(c)
+        criteria_lhs_array << (descending_sort ? "b.#{c}" : "a.#{c}")
+        criteria_rhs_array << (descending_sort ? "a.#{c}" : "b.#{c}")
+      end
+      "->(a, b) { [#{criteria_lhs_array.join(', ')}] <=> [#{criteria_rhs_array.join(', ')}] }"
+    end
+
+    def self.verify_sort_by_type(sort_by)
+      case sort_by
+      when Array
+        sort_by
+      when Enumerable
+        sort_by.to_a
+      when Date
+        [sort_by.to_i]
+      when String
+        [sort_by]
+      else
+        abort "Error: @sort_by was specified as '#{sort_by}'; it must either be a string or an array of strings"
+      end
+    end
+
+    private
+
+    def default_head(sort_by)
+      criteria = (sort_by.map do |x|
+        reverse = x.start_with? '-'
+        criterion = x.delete_prefix('-').capitalize
+        criterion += reverse ? ' (Newest to Oldest)' : ' (Oldest to Newest)'
+        criterion
+      end).join(', ')
+      "All Posts in All Categories Sorted By #{criteria}"
+    end
+
+    def evaluate(string)
+      self.eval string, binding, __FILE__, __LINE__
+    rescue StandardError => e
+      warn_short_trace e.red
+    end
+
+    def last_modified_value(apage)
+      @logger.debug do
+        "  apage.last_modified='#{apage.last_modified}'; " \
+          "apage.last_modified_at='#{apage.last_modified_at}'; " \
+          "@date_column='#{@date_column}'"
+      end
+      last_modified = if @date_column == 'last_modified' && apage.respond_to?(:last_modified)
+                        apage.last_modified
+                      elsif apage.respond_to? :last_modified_at
+                        apage.last_modified_at
+                      else
+                        apage.date
+                      end
+      last_modified ||= apage.date || Date.today
+      last_modified
+    end
+
+    def generate_output(sort_lambda)
+      id = @id.to_s.strip.empty? ? '' : " id='#{@id}'"
+      heading = @heading.strip.to_s.empty? ? '' : "<h2#{id}>#{@heading}</h2>"
+      data = case @data_selector
+             when 'all_collections'
+               @site.all_collections
+             when 'all_documents'
+               @site.all_documents
+             when 'everything'
+               @site.everything
+             else
+               raise AllCollectionsError, "Invalid value for @data_selector (#{data_selector})"
+             end
+      collection = data.sort(&sort_lambda)
+      posts = collection.map do |x|
+        last_modified = last_modified_value x
+        date = last_modified.strftime '%Y-%m-%d'
+        draft = x.draft ? DRAFT_HTML : ''
+        href = "<a href='#{x.href}'>#{x.title}</a>"
+        @logger.debug { "  date='#{date}' #{x.title}\n" }
+        "  <span>#{date}</span><span>#{href}#{draft}</span>"
+      end
+      <<~END_TEXT
+        #{heading}
+        <div class="posts">
+          #{posts.join "\n"}
+        </div>
+      END_TEXT
+    rescue ArgumentError => e
+      warn_short_trace e
+    end
+
+    # See https://stackoverflow.com/a/75377832/553865
+    def init_sort_by(sort_by, sort_by_param)
+      sort_lambda_string = AllCollectionsTag.create_lambda_string sort_by
+
+      @logger.debug do
+        "#{@page['path']} sort_by_param=#{sort_by_param}  " \
+          "sort_lambda_string = #{sort_lambda_string}\n"
+      end
+
+      evaluate sort_lambda_string
+    end
+
+    def parse_arguments
+      @data_selector = @helper.parameter_specified?('data_selector') || 'all_collections'
+      abort "Invalid data_selector #{@data_selector}" unless %w[all_collections all_documents everything].include? @data_selector
+
+      @date_column = @helper.parameter_specified?('date_column') || 'date'
+      unless %w[date last_modified].include?(@date_column)
+        raise AllCollectionsError "The date_column attribute must either have value 'date' or 'last_modified', " \
+                                  "but '#{@date_column}' was specified"
+      end
+
+      @id = @helper.parameter_specified?('id') || SecureRandom.hex(10)
+      @sort_by_param = @helper.parameter_specified? 'sort_by'
+      @sort_by = (@sort_by_param&.delete(' ')&.split(',') if @sort_by_param != false) || ['-date']
+    end
+
+    ::JekyllSupport::JekyllPluginHelper.register(self, PLUGIN_NAME)
+  end
+end