jekyll_plugin_support 1.1.0 → 3.1.0

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
@@ -35,7 +33,7 @@ module JekyllSupport
       @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
@@ -47,8 +45,8 @@ module JekyllSupport
     # Method prescribed by the Jekyll plugin lifecycle.
     # Defines @config, @envs, @mode, @page and @site
     # @return [String]
-    def render(liquid_context)
-      @helper.liquid_context = JekyllSupport.inject_config_vars liquid_context # modifies liquid_context
+    def render(liquid_context) # rubocop: disable Metrics/AbcSize
+      @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
@@ -84,10 +82,11 @@ module JekyllSupport
       render_impl(text)
     rescue StandardError => e
       e.shorten_backtrace
+      @logger.error e.full_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}" }
+      @logger.error { "While processing line #{@line_number} #{of_page} for #{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
@@ -14,7 +12,7 @@ module JekyllSupport
     rescue StandardError => e
       e.shorten_backtrace
       @logger.error { e.full_message }
-      JekyllSupport.error_short_trace(@logger, e)
+      ::JekyllSupport.error_short_trace(@logger, e)
     end
 
     # Liquid::Block subclasses do not render if there is no content within the tag

data/lib/error/jekyll_custom_error.rb

@@ -42,11 +42,12 @@ module JekyllSupport
       END_MSG
     end
 
-    def shorten_backtrace(backtrace_element_count = 3)
-      b = backtrace[0..backtrace_element_count - 1].map do |x|
-        x.gsub(Dir.pwd + '/', './')
-      end
-      set_backtrace b
+    def shorten_backtrace(backtrace_element_count = 6)
+      set_backtrace backtrace[0..backtrace_element_count]
+      # b = backtrace[0..backtrace_element_count - 1].map do |x|
+      #   x.gsub(Dir.pwd + '/', './')
+      # end
+      # set_backtrace b
     end
   end
 end

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 }

data/lib/helper/jekyll_plugin_helper_class.rb

@@ -66,8 +66,8 @@ 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

data/lib/hooks/a_page.rb

@@ -0,0 +1,203 @@
+require 'date'
+require 'jekyll_draft'
+require 'time'
+
+module JekyllSupport
+  # Contructor for testing and jekyll_outline
+  def self.apage_from( # rubocop:disable Metrics/ParameterLists
+    collection_name: nil,
+    date: nil,
+    description: nil,
+    draft: false,
+    last_modified: nil,
+    logger: nil,
+    order: nil,
+    title: nil,
+    url: nil
+  )
+    # Jekyll documents have inconsistent date and last_modified property types.
+    date = Time.parse(date) if date.instance_of?(String)
+    unless date.instance_of? Time
+      logger.error { "date is not an instance of Time, it is an instance of #{date.class}" }
+      exit 2
+    end
+
+    last_modified = Date.parse(last_modified) if last_modified.instance_of?(String)
+    last_modified = Date.parse(date.strftime('%Y-%m-%d')) if last_modified.nil?
+    unless last_modified.instance_of? Date
+      logger.error { "last_modified is not an instance of Date, it is an instance of #{last_modified.class}" }
+      exit 3
+    end
+    last_modified = Date.parse(date._to_s) if last_modified.nil?
+    data = {
+      collection:    { label: collection_name },
+      draft:         draft,
+      last_modified: last_modified,
+      order:         order,
+      title:         title,
+    }
+    obj = {}
+    JekyllSupport.new_attribute obj, :data, data
+    JekyllSupport.new_attribute obj, :date, date
+    JekyllSupport.new_attribute obj, :description, description
+    JekyllSupport.new_attribute obj, :draft, draft
+    JekyllSupport.new_attribute obj, :extname, '.html'
+    JekyllSupport.new_attribute obj, :last_modified, last_modified
+    JekyllSupport.new_attribute obj, :logger, PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+    JekyllSupport.new_attribute obj, :title, title
+    JekyllSupport.new_attribute obj, :url, url
+
+    JekyllSupport::APage.new obj, nil
+  rescue StandardError => e
+    puts e.full_message
+  end
+
+  # Create Array of JekyllSupport::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|
+      unless object.respond_to?(:logger)
+        JekyllSupport.new_attribute(object,
+                                    :logger,
+                                    PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config))
+      end
+      page = APage.new(object, origin)
+      pages << page unless page.data['exclude_from_all'] || page.path == 'redirect.html'
+    end
+    pages
+  end
+
+  # Defines a new attribute called `prop_name` in object `obj` and sets it to `prop_value`
+  def self.new_attribute(obj, prop_name, prop_value)
+    obj.class.module_eval { attr_accessor prop_name }
+    obj.instance_variable_set :"@#{prop_name}", prop_value
+  end
+
+  FIXNUM_MAX = (2**((0.size * 8) - 2)) - 1 unless defined? FIXNUM_MAX
+  END_OF_DAYS = 1_000_000_000_000 unless defined? END_OF_DAYS # One trillion years in the future
+  # Time.new is -4712-01-01
+
+  class APage
+    attr_reader :categories, :collection_name, :content, :data, :date, :description, :destination, :draft,
+                :excerpt, :ext, :extname, :href, :label, :last_modified, :last_modified_field,
+                :layout, :logger, :name, :origin, :path, :relative_path, :tags, :title, :type, :url
+
+    # @param obj can be a `Jekyll::Document` or a Hash with properties
+    # @param origin values: 'collection', 'individual_page', and 'static_file'
+    #               (See method JekyllSupport.apages_from_objects)
+    def initialize(obj, origin)
+      @logger = obj.logger
+      @origin = origin
+      build obj
+    rescue StandardError => e
+      ::JekyllSupport.error_short_trace(@logger, e)
+    end
+
+    # @param name can be either a String or a Symbol
+    def field(name, use_default: true)
+      default_value = case name
+                      when :date, :last_modified, :last_modified_at
+                        END_OF_DAYS
+                      else
+                        ''
+                      end
+
+      result = data[name.to_sym] || data[name.to_s] if data.key?(name.to_sym) || data.key?(name.to_s)
+      return result if result
+
+      default_value if use_default
+    end
+
+    # Look within @data (if the property exists), then self for the given key as a symbol or a string
+    # @param key must be a symbol
+    # @return value of data[key] if key exists as a string or a symbol, else nil
+    def obj_field(obj, key)
+      if obj.respond_to? :data
+        return obj.data[key] if obj.data.key? key
+
+        return obj.data[key.to_s] if obj.data.key? key.to_s
+      end
+      return obj.send(key) if obj.respond_to?(key)
+
+      return unless obj.respond_to?(:key?)
+      return obj[key] if obj.key?(key)
+
+      obj[key.to_s] if obj.key?(key.to_s)
+    end
+
+    def order
+      if data.key?('order') || data.key?(:order)
+        data['order'] || data[:order]
+      else
+        FIXNUM_MAX
+      end
+    end
+
+    def to_s
+      @label || @date.to_s
+    end
+
+    private
+
+    # Sets the following uninitialized instance attributes in APage from selected key/value pairs in `obj.data`:
+    # `categories`, `date`, `description`, `excerpt`, `ext`, `last_modified` or `last_modified_at`,
+    # `layout`, and `tags`.
+    # Sets the following instance attributes in APage from selected attributes in `obj` (when present):
+    # `content`, `destination`, `ext` and `extname`, `label` from `collection.label`,
+    # `path`, `relative_path`, `type`, and `url`.
+    def build(obj) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      @categories          ||= obj_field(obj, :categories)
+
+      collection_value     = obj_field(obj, :collection)
+      @collection_name     = if collection_value
+                               if collection_value.respond_to?(:label)
+                                 collection_value.label
+                               elsif collection_value.key? :label
+                                 collection_value[:label]
+                               end
+                             end
+
+      @content             ||= obj.content if obj.respond_to? :content
+      @data                ||= obj.respond_to?(:data) ? obj.data : {}
+      @date                ||= obj_field(obj, :date) || Time.now # Jekyll doc.date property is a Time
+      @description         ||= obj_field(obj, :description)
+      # TODO: What _config.yml setting should be passed to destination()?
+      @destination         ||= obj.destination('') if obj.respond_to? :destination
+      @draft               ||= Jekyll::Draft.draft? obj
+      @excerpt             ||= obj_field(obj, :excerpt)
+      @ext                 ||= obj_field(obj, :ext) || obj_field(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)
+
+      @last_modified       ||= obj_field(obj, :last_modified) ||
+                               obj_field(obj, :last_modified_at) ||
+                               Date.parse(@date.to_s) # Jekyll doc.last_modified property is a Date
+
+      @last_modified_field ||= if obj_field(obj, :last_modified)
+                                 :last_modified
+                               elsif obj_field(obj, :last_modified_at)
+                                 :last_modified_at
+                               end
+
+      @layout              ||= obj_field(obj, :layout)
+      @path                ||= obj_field(obj, :path)
+      @relative_path       ||= obj_field(obj, :relative_path)
+      @tags                ||= obj_field(obj, :tags)
+      @type                ||= obj_field(obj, :type)
+
+      @url                 ||= obj.url
+      if @url
+        @url = "#{@url}index.html" if @url&.end_with? '/'
+      else
+        @url = '/index.html'
+      end
+
+      # @href  = "/#{@href}" if @origin == 'individual_page'
+      @href  ||= @url
+      @name  ||= File.basename(@href)
+      @title ||= obj_field(obj, :title) || "<code>#{@href}</code>"
+    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,38 @@
+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
+
+  # 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 = JekyllSupport.apages_from_objects(documents, 'collection')
+    @all_documents   = @all_collections +
+                       JekyllSupport.apages_from_objects(site.pages, 'individual_page')
+    @everything      = @all_documents +
+                       JekyllSupport.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,174 @@
+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
+      generate_output sort_lambda
+    rescue StandardError => e
+      ::JekyllSupport.error_short_trace @logger, e
+      # ::JekyllSupport.warn_short_trace @logger, e
+    end
+
+    # Descending sort keys are preceded by a minus sign, and reverse the order of comparison
+    # @param criteria String Examples: 'date', '-date', 'last_modified', '-last_modified',
+    #        ['date', 'last_modified], ['-date', '-last_modified'], ['date', '-last_modified']
+    # @return values:
+    #   "->(a, b) { [a.last_modified] <=> [b.last_modified] }" (ascending)
+    #   "->(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 date_value(apage, field_name)
+      if %i[last_modified last_modified_at].include? field_name
+        apage.field(:last_modified_at, use_default: false) ||
+          apage.field(:last_modified, use_default: false) ||
+          Date.today
+      else
+        apage.date || Time.now
+      end
+    end
+
+    def generate_output(sort_lambda)
+      id = @id.to_s.strip.empty? ? '' : " id=\"#{@id}\""
+      heading = @heading.strip.to_s.empty? ? '' : "<h2#{id}>#{@heading}</h2>"
+      apages = 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
+      filtered_apages = @collection_name.nil? ? apages : apages.select { |apage| apage.collection_name == @collection_name }
+      sorted_apages = filtered_apages.sort(&sort_lambda)
+      posts = sorted_apages.map do |apage|
+        date_column = @date_column.to_s == 'last_modified' ? :last_modified : :date
+        d = date_value(apage, date_column)
+        if d.respond_to?(:strftime)
+          date = d.strftime '%Y-%m-%d'
+        else
+          @logger.error do
+            "date_value returned a #{d.class} instead of a class with a strftime method like Date and Time; date_column=#{date_column}"
+          end
+        end
+        draft         = apage.draft ? DRAFT_HTML : ''
+        title         = apage.title || apage.href
+        href          = "<a href='#{apage.href}'>#{title}</a>"
+        @logger.debug { "  date='#{date}' #{title}\n" }
+        "  <span>#{date}</span><span>#{href}#{draft}</span>"
+      end
+      <<~END_TEXT
+        #{heading}
+        <div class="posts">
+          #{posts.join "\n"}
+        </div>
+      END_TEXT
+    rescue NoMethodError || ArgumentError => e
+      ::JekyllSupport.error_short_trace @logger, e
+    end
+
+    # See https://stackoverflow.com/a/75377832/553865
+    def init_sort_by(sort_by)
+      sort_lambda_string = AllCollectionsTag.create_lambda_string sort_by
+
+      @logger.debug do
+        "#{@page['path']} sort_lambda_string = #{sort_lambda_string}\n"
+      end
+
+      evaluate sort_lambda_string
+    end
+
+    # @return String defining the parsed sort_by expression
+    def parse_arguments
+      @collection_name = @helper.parameter_specified?('collection_name')
+      @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
+      if (@data_selector != 'all_collections') && @collection_name
+        @logger.warn do
+          "collection_name was specified as '#{@collection_name}', but data_selector is #{@data_selector},
+          which is less effcient than specifying all_collections."
+        end
+      end
+
+      sort_by_param = @helper.parameter_specified? 'sort_by' # Might specify multiple sort fields
+
+      # Default to displaying last modified field unless a sort field is specified
+      @date_column = @helper.parameter_specified?('date_column') || 'last_modified'
+      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 instead."
+      end
+      @date_column ||= (sort_by_param.include?('last_modified') ? 'last_modified' : 'date') # display the sort date by default
+
+      @id = @helper.parameter_specified?('id') || SecureRandom.hex(10)
+
+      @sort_by = (sort_by_param&.delete(' ')&.split(',') if sort_by_param != false) || ['-date']
+
+      @heading = @helper.parameter_specified?('heading') || default_head(@sort_by)
+
+      @sort_by
+    end
+
+    ::JekyllSupport::JekyllPluginHelper.register(self, PLUGIN_NAME)
+  end
+end