jekyll_all_collections 0.3.6 → 0.4.0

data/lib/all_collections_tag.rb

@@ -1,139 +0,0 @@
-require 'jekyll_draft'
-require 'jekyll_plugin_logger'
-require 'jekyll_plugin_support'
-require 'securerandom'
-
-# See https://stackoverflow.com/a/75389679/553865
-class NullBinding < BasicObject
-  def min_binding
-    ::Kernel
-      .instance_method(:binding)
-      .bind_call(self)
-  end
-end
-
-# @author Copyright 2020 Michael Slinn
-# @license SPDX-License-Identifier: Apache-2.0
-module AllCollectionsTag
-  PLUGIN_NAME = 'all_collections'.freeze
-  CRITERIA = %w[date destination draft label last_modified last_modified_at path relative_path title type url].freeze
-  DRAFT_HTML = '<i class="jekyll_draft">Draft</i>'.freeze
-
-  class AllCollectionsTag < JekyllSupport::JekyllTag
-    include JekyllAllCollectionsVersion
-
-    # Method prescribed by JekyllTag.
-    # @return [String]
-    def render_impl
-      AllCollectionsHooks.compute(@site) unless @site.class.method_defined? :all_collections
-
-      @date_column = @helper.parameter_specified?('date_column') || 'date'
-      unless %w[date last_modified].include?(@date_column)
-        # TODO: should this just issue a warning and return instead of dieing?
-        abort "Error: 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']
-      @heading = @helper.parameter_specified?('heading') || self.class.default_head(sort_by)
-      sort_lambda_string = self.class.create_lambda_string(sort_by)
-      @logger.debug do
-        "#{@page['path']} sort_by_param=#{sort_by_param}  " \
-          "sort_lambda_string = #{sort_lambda_string}\n"
-      end
-      sort_lambda = self.class.evaluate sort_lambda_string
-      generate_output sort_lambda
-    end
-
-    def self.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
-
-    # Descending sort keys reverse the order of comparison
-    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
-      # Examples:
-      #   "->(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)
-      "->(a, b) { [#{criteria_lhs_array.join(', ')}] <=> [#{criteria_rhs_array.join(', ')}] }"
-    end
-
-    def self.evaluate(string)
-      eval string, NullBinding.new.min_binding, __FILE__, __LINE__ # rubocop:disable Security/Eval
-    end
-
-    def self.verify_sort_by_type(sort_by)
-      if @sort_by.is_a? Array
-        sort_by
-      elsif sort_by.is_a? Enumerable
-        sort_by.to_a
-      elsif sort_by.is_a? Date
-        [sort_by.to_i]
-      elsif sort_by.is_a? 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 last_modified_value(post)
-      @logger.debug do
-        "  post.last_modified='#{post.last_modified}'; " \
-          "post.last_modified_at='#{post.last_modified_at}'; " \
-          "@date_column='#{@date_column}'"
-      end
-      last_modified = if @date_column == 'last_modified' && post.respond_to?(:last_modified)
-                        post.last_modified
-                      elsif post.respond_to? :last_modified_at
-                        post.last_modified_at
-                      else
-                        post.date
-                      end
-      last_modified ||= post.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>"
-      collection = @site.all_collections.sort(&sort_lambda)
-      <<~END_TEXT
-        #{heading}
-        <div class="posts">
-          #{(collection.map do |post|
-               last_modified = last_modified_value post
-               date = last_modified.strftime '%Y-%m-%d'
-               draft = post.draft ? DRAFT_HTML : ''
-               href = "<a href='#{post.url}'>#{post.title}</a>"
-               @logger.debug { "  date='#{date}' #{post.title}\n" }
-               "  <span>#{date}</span><span>#{href}#{draft}</span>"
-             end).join "\n"}
-        </div>
-      END_TEXT
-    rescue ArgumentError => e
-      warn_short_trace e
-    end
-
-    JekyllSupport::JekyllPluginHelper.register(self, PLUGIN_NAME)
-  end
-end