jekyll_plugin_support 0.8.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20c575e857da7ffa50f37a587494b25232e1eb1309040946dd13d8f896250f07
-  data.tar.gz: 4aa5e163875f4e99adca9a6bc4ca97927c95c4cc4d017f52ca0b108d9ea24670
+  metadata.gz: cb346f630f3f3d54d602c2c130ead054765b3f1fcd5d2a13550a82d850ce6c7f
+  data.tar.gz: 50a247655dbdb650eaeabb6163843b2d9f2c1ec47c69609f43b0e22df10d96c7
 SHA512:
-  metadata.gz: f2a2123c073c9e344e097e3eecd364606037bdd0213045d7060a09d48acaac1810eb609e201126e3f4fc8e5edc0e4e6e81db43800aa4eea954490d4e21e91cdc
-  data.tar.gz: 2d4e8daa6ea71e412065356a7029f3ff0b432fb7a06cdc98f403ba02709106f75c62e8236bae12668e6b181f4c52ccba328811fdb9619cd075597fea622052e7
+  metadata.gz: c3277bc67de6688e3c4af585940a26bd641d157a54be0757a34aae364454fc5bfe952cb5e7834d8dc57eda4e6957ce1c1adcf603915d3bff442e7a88e52552ca
+  data.tar.gz: f9e68b39c8de0fa100d720601b59e2a052a8fb3de9746ccb7a37fa28752bb43171827dd325f7b1e6bda920561716feed78a69e477d1fc022832ff43ce5d9234a

data/.rubocop.yml

@@ -34,14 +34,14 @@ Metrics/AbcSize:
 
 Metrics/BlockLength:
   Exclude:
-    - jekyll_all_collections.gemspec
+    - jekyll_plugin_support.gemspec
   Max: 30
 
 Metrics/CyclomaticComplexity:
   Max: 25
 
 Metrics/MethodLength:
-  Max: 30
+  Max: 50
 
 Metrics/PerceivedComplexity:
   Max: 25
@@ -49,14 +49,17 @@ Metrics/PerceivedComplexity:
 Naming/FileName:
   Exclude:
     - Rakefile
+    - "*.md"
 
 RSpec/ExampleLength:
   Max: 30
 
-RSpec/FilePath:
+RSpec/SpecFilePathFormat:
   Enabled: false
   IgnoreMethods: true
-  SpecSuffixOnly: true
+
+RSpec/SpecFilePathSuffix:
+  Enabled: false
 
 RSpec/IndexedLet:
   Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change Log
 
+## 1.0.0 / 2024-07-23
+
+* Added the `redef_without_warning` method so tag and block plugins can be subclassed.
+* Put most of the functionality into the `JekyllSupport` module.
+* Made tag and block code more consistent
+
+
+## 0.8.6 / 2024-06-11
+
+* Fixup version, containing what was supposed to be in v0.8.5
+
 
 ## 0.8.5 / 2024-03-25
 

data/README.md

@@ -55,9 +55,9 @@ add the following line to your Jekyll plugin’s `Gemfile`.
 
 ```ruby
 group :jekyll_plugins do
-  ...
+  # ...
   gem 'jekyll_plugin_support', '>= 0.8.0'
-  ...
+  # ...
 end
 ```
 
@@ -65,9 +65,9 @@ Otherwise, if your custom plugin will be packaged into a gem, add the following
 
 ```ruby
 Gem::Specification.new do |spec|
-  ...
+  # ...
   spec.add_dependency 'jekyll_plugin_support', '>= 0.8.0'
-  ...
+  # ...
 end
 ```
 
@@ -516,7 +516,7 @@ without tokenization, and you expect that the plugin might be invoked with large
 derive your plugin from `JekyllBlockNoArgParsing` or `JekyllTagNoArgParsing`.
 
 
-## Subclass Attribution
+## Attribution
 
 `JekyllTag` and `JekyllBlock` subclasses of `jekyll_plugin_support` can utilize the `attribution`
 option if they are published as a gem.
@@ -584,6 +584,21 @@ An alternative attribution string can be specified properties can be output usin
 {% my_tag attribution="Generated by the #{name} #{version} Jekyll plugin, written by #{author} #{date}" %}
 ```
 
+## Subclassing
+
+Jekyll plugins created using `jekyll_plugin_support` are implemented as Ruby classes.
+If you would like to create a version of an existing Jekyll plugin, you will need to subclass the plugin.
+In order to do that, you will need to override the plugin name and version, which are defined as constants.
+
+`Jekyll_plugin_support` provides a method that allows
+a constant to be redefined, called `redef_without_warning`.
+Use it in a subclass like this:
+
+```ruby
+redef_without_warning :PLUGIN_NAME, 'my_plugin'.freeze
+redef_without_warning :VERSION, '0.1.0'.freeze
+```
+
 
 ## Development
 

data/lib/{jekyll_plugin_support_block.rb → block/jekyll_plugin_support_block.rb}

@@ -1,13 +1,10 @@
-require_relative 'jekyll_plugin_error_handling'
+require_relative '../error/jekyll_plugin_error_handling'
 
 module JekyllSupport
   # Base class for Jekyll block tags
   class JekyllBlock < Liquid::Block
     attr_reader :argument_string, :helper, :line_number, :logger, :page, :site, :text
 
-    include JekyllSupportErrorHandling
-    extend JekyllSupportErrorHandling
-
     # 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.
@@ -26,7 +23,7 @@ module JekyllSupport
       @helper = JekyllPluginHelper.new tag_name, markup, @logger, respond_to?(:no_arg_parsing)
 
       @error_name = "#{tag_name.camelcase(:upper)}Error"
-      Jekyll::CustomError.factory @error_name
+      JekyllSupport::CustomError.factory @error_name
     end
 
     # Liquid::Block subclasses do not render if there is no content within the tag
@@ -49,6 +46,8 @@ module JekyllSupport
 
       @config = @site.config
       @tag_config = @config[@tag_name]
+      @jps = @config['jekyll_plugin_support']
+      @pry_on_standard_error = @jps['pry_on_standard_error'] || false if @jps
 
       set_error_context
 
@@ -56,7 +55,8 @@ module JekyllSupport
       @paginator = @envs[:paginator]
       @theme     = @envs[:theme]
 
-      @mode = @config['env']&.key?('JEKYLL_ENV') ? @config['env']['JEKYLL_ENV'] : 'development'
+      env = @config['env']
+      @mode = env&.key?('JEKYLL_ENV') ? env['JEKYLL_ENV'] : 'development'
 
       @helper.reinitialize @markup.strip
 
@@ -69,13 +69,13 @@ module JekyllSupport
       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}" }
+      @logger.error { "#{e.class} on line #{@line_number} of #{e.backtrace[0].split(':').first} by #{@tag_name} - #{e.message}" }
       binding.pry if @pry_on_standard_error # rubocop:disable Lint/Debugger
       raise e if @die_on_standard_error
 
       <<~END_MSG
         <div class='standard_error'>
-          #{e.class} on line #{@line_number} of #{e.backtrace[0].split(':').first} by #{tag_name}: #{e.message}
+          #{e.class} on line #{@line_number} of #{e.backtrace[0].split(':').first} by #{@tag_name}: #{e.message}
         </div>
       END_MSG
     end

data/lib/{jekyll_plugin_support_block_noarg.rb → block/jekyll_plugin_support_block_noarg.rb}

@@ -1,12 +1,9 @@
-require_relative 'jekyll_plugin_error_handling'
+require_relative '../error/jekyll_plugin_error_handling'
 
 module JekyllSupport
   class JekyllBlockNoArgParsing < JekyllBlock
     attr_reader :argument_string, :helper, :line_number, :logger, :page, :site
 
-    include JekyllSupportErrorHandling
-    extend JekyllSupportErrorHandling
-
     def initialize(tag_name, argument_string, parse_context)
       class << self
         include NoArgParsing
@@ -20,6 +17,12 @@ module JekyllSupport
       JekyllSupport.error_short_trace(@logger, e)
     end
 
+    # Liquid::Block subclasses do not render if there is no content within the tag
+    # This override fixes that
+    def blank?
+      false
+    end
+
     # Jekyll plugins must override this method, not render, so their plugin can be tested more easily
     # The following variables are predefined:
     #   @argument_string, @config, @envs, @helper, @layout, @logger, @mode, @page, @paginator, @site, @tag_name and @theme

data/lib/{jekyll_custom_error.rb → error/jekyll_custom_error.rb}

@@ -1,7 +1,7 @@
 require 'facets/string/camelcase'
 require 'facets/string/snakecase'
 
-module Jekyll
+module JekyllSupport
   # Use like this:
   # CustomError.new(:MyError, 'blah', 'asdf')
   class CustomError < StandardError

data/lib/{jekyll_plugin_error_handling.rb → error/jekyll_plugin_error_handling.rb}

@@ -1,4 +1,4 @@
-module JekyllSupportErrorHandling
+module JekyllSupport
   attr_reader :logger, :page
 
   # If a Jekyll plugin needs to crash exit, and stop Jekyll, call this method.

data/lib/generator/jekyll_plugin_support_generator.rb

@@ -0,0 +1,75 @@
+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.
+  class JekyllGenerator < Jekyll::Generator
+    attr_reader :helper, :line_number, :logger, :site
+
+    # Method prescribed by the Jekyll plugin lifecycle.
+    # Defines @config, @envs, @mode and @site
+    # @return [void]
+    def generate(site)
+      @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
+      @envs   = site.config['env']
+      @theme  = @site.theme
+
+      @mode = ENV['JEKYLL_ENV'] || 'development'
+
+      # set_error_context(self.class)
+
+      generate_impl
+    rescue StandardError => e
+      e.shorten_backtrace
+      @logger.error { "#{e.class} on line #{@line_number} of #{e.backtrace[0].split(':').first} by #{self.class.name} - #{e.message}" }
+      binding.pry if @pry_on_standard_error # rubocop:disable Lint/Debugger
+      raise e if @die_on_standard_error
+
+      <<~END_MSG
+        <div class='standard_error'>
+          #{e.class} on line #{@line_number} of #{e.backtrace[0].split(':').first} by #{self.class.name}: #{e.message}
+        </div>
+      END_MSG
+    end
+
+    # Jekyll plugins should override this method, not `generate`, so they can be tested more easily.
+    # The following variables are predefined:
+    #   @config, @envs, @helper, @logger, @mode, @paginator, @site and @theme
+    # @return [void]
+    def generate_impl; end
+
+    def self.register(klass)
+      abort("Error: The #{klass.name} plugin does not define VERSION") \
+        unless klass.const_defined?(:VERSION)
+
+      version = klass.const_get(:VERSION)
+      error_name_stub = klass.name.include?('::') ? klass.name.split('::')[1] : klass.name
+      error_ruby_class_name = "#{error_name_stub.camelcase(:upper)}Error"
+      error_css_class_name = error_ruby_class_name.split('::').last.snakecase
+      msg = <<~END_MSG
+        Loaded generator plugin #{klass.name} v#{version}. It has:
+          Error class: #{@error_name}
+          CSS class for error messages: #{error_css_class_name}
+      END_MSG
+
+      PluginMetaLogger.instance.info { msg }
+    end
+
+    def set_error_context(klass)
+      return unless Object.const_defined? @error_name
+
+      error_class = Object.const_get @error_name
+      error_class.class_variable_set(:@@argument_string, @argument_string)
+      error_class.class_variable_set(:@@line_number, @line_number)
+      error_class.class_variable_set(:@@path, @page['path'])
+      error_class.class_variable_set(:@@tag_name, klass.name)
+    end
+  end
+end

data/lib/helper/jekyll_plugin_helper.rb

@@ -0,0 +1,112 @@
+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
+
+    # 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.
+    # @param argument_string [String] the arguments from 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
+    # @return [void]
+    def initialize(tag_name, markup, logger, no_arg_parsing)
+      @tag_name = tag_name
+      @logger = logger
+      @no_arg_parsing = no_arg_parsing
+      @markup = markup
+    rescue StandardError => e
+      e.shorten_backtrace
+      @logger.error { e.message }
+    end
+
+    # @return undefined if parameter was specified, removes it from the available tokens and returns value
+    def parameter_specified?(name, delete_param: true)
+      return false if @keys_values.to_s.empty?
+
+      key = name
+      key = name.to_sym if @keys_values&.first&.first.instance_of?(Symbol)
+      value = @keys_values[key]
+      delete_parameter(name) if delete_param
+      value
+    end
+
+    def reinitialize(markup)
+      # @keys_values was a Hash[Symbol, String|Boolean] but now it is Hash[String, String|Boolean]
+      @markup = markup
+      if @no_arg_parsing
+        define_singleton_method(:argv) { warn_fetch :argv }
+        define_singleton_method(:keys_values) { warn_fetch :keys_values }
+        define_singleton_method(:params) { warn_fetch :params }
+        define_singleton_method(:parameter_specified?) { |_name| warn_parse(:parameter_specified?) }
+        define_singleton_method(:delete_parameter) { |_name| warn_parse(:delete_parameter) }
+        @attribution = false
+      else
+        parse markup
+        @attribution = parameter_specified?('attribution') || false
+        @logger.debug { "@keys_values='#{@keys_values}'" }
+      end
+    end
+
+    # Call this method to return the remaining markup after `parameter_specified?` has been invoked.
+    def remaining_markup
+      @argv&.join(' ')
+    end
+
+    def remaining_markup_original
+      @argv_original&.join(' ')
+    end
+
+    def warn_fetch(variable)
+      abort "Error: Argument parsing was suppressed, but an attempt to obtain the value of #{variable} was made"
+    end
+
+    def warn_parse(meth)
+      abort "Error: Argument parsing was suppressed, but an attempt to invoke #{meth} was made"
+    end
+
+    def delete_parameter(key)
+      return if @keys_values.empty? || @params.nil?
+
+      @params.delete(key)
+      @argv.delete_if { |x| x == key or x.start_with?("#{key}=") }
+      @keys_values.delete(key)
+
+      @params_original.delete(key)
+      @argv_original.delete_if { |x| x == key or x.start_with?("#{key}=") }
+      @keys_values_original.delete(key)
+    end
+
+    private
+
+    def page
+      @liquid_context.registers[:page]
+    end
+
+    def parse(markup)
+      @argv_original = Shellwords.split(markup)
+      @keys_values_original = KeyValueParser
+                              .new({}, { array_values: false, normalize_keys: false, separator: /=/ })
+                              .parse(@argv_original)
+      @params_original = @keys_values_original unless respond_to?(:no_arg_parsing) && no_arg_parsing
+
+      @argv = Shellwords.split(self.class.expand_env(markup, logger))
+      @keys_values = KeyValueParser
+                     .new({}, { array_values: false, normalize_keys: false, separator: /=/ })
+                     .parse(@argv)
+
+      return if respond_to?(:no_arg_parsing) && no_arg_parsing
+
+      @params = @keys_values # TODO: @keys_values should be deleted
+    end
+  end
+end

data/lib/helper/jekyll_plugin_helper_attribution.rb

@@ -0,0 +1,74 @@
+module JekyllSupport
+  # Attribution aspect of JekyllPluginHelper
+  class JekyllPluginHelper
+    # @param file must be a fully qualified file name that points to a file within a gem.
+    # @return Gem::Specification of gem that file points into, or nil if not called from a gem
+    # See https://stackoverflow.com/a/75890279/553865
+    def self.current_spec(file)
+      abort 'JekyllPluginHelper::current_spec: file is nil' if file.nil?
+      return nil unless File.exist?(file)
+
+      searcher = if Gem::Specification.respond_to?(:find)
+                   Gem::Specification
+                 elsif Gem.respond_to?(:searcher)
+                   Gem.searcher.init_gemspecs
+                 end
+
+      searcher&.find do |spec|
+        file.start_with? spec.full_gem_path
+      end
+    end
+
+    def attribute
+      return unless @current_gem
+
+      <<~END_OUTPUT
+        <div id="jps_attribute_#{rand(999_999)}" class="jps_attribute">
+          <div>
+            <a href="#{@homepage}" target="_blank" rel="nofollow">
+              #{attribution_string}
+            </a>
+          </div>
+        </div>
+      END_OUTPUT
+    end
+
+    def default_attribution
+      authors = @authors&.join(', ')
+      result = "Generated by the \#{@name} v\#{@version} Jekyll plugin"
+      result << ", written by #{authors}" if authors
+      result << " \#{@published_date}" if @published_date
+      result << '.'
+      result
+    end
+
+    # Sets @current_gem if file points at a uniquely named file within a gem.
+    # @param file must be a fully qualified file name in a gem, for example: __FILE__
+    def gem_file(file)
+      @current_gem = JekyllPluginHelper.current_spec file
+      @logger.debug "No gem found for '#{file} was found." unless @current_gem
+      annotate_globals if @attribution && @current_gem
+    end
+
+    private
+
+    def annotate_globals
+      return unless @current_gem
+
+      @name           = @current_gem.name
+      @authors        = @current_gem.authors
+      @homepage       = @current_gem.homepage
+      @published_date = @current_gem.date.to_date.to_s
+      @version        = @current_gem.version
+    end
+
+    def attribution_string
+      string = if @attribution == true
+                 default_attribution
+               else
+                 @attribution
+               end
+      String.interpolate { string }
+    end
+  end
+end

data/lib/helper/jekyll_plugin_helper_class.rb

@@ -0,0 +1,83 @@
+require 'facets/string/camelcase'
+require 'facets/string/snakecase'
+require 'yaml'
+
+module JekyllSupport
+  # Class methods for JekyllPluginHelper
+  class JekyllPluginHelper
+    # Expand an environment variable reference
+    def self.expand_env(str, logger = nil, die_if_undefined: false)
+      str&.gsub(/\$([a-zA-Z_][a-zA-Z0-9_]*)|\${\g<1>}/) do
+        envar = Regexp.last_match(1)
+        unless ENV.key? envar
+          msg = "jekyll_plugin_support error: environment variable #{envar} is undefined"
+          raise JekyllPluginSupportError, msg.red, [] if die_if_undefined
+
+          if logger
+            logger.warn msg
+          else
+            puts msg.red
+          end
+        end
+        ENV.fetch(envar, nil)
+      end
+    end
+
+    def self.generate_message(klass, tag_name, version)
+      error_name_stub = klass.name.include?('::') ? klass.name.split('::')[1] : klass.name
+      error_ruby_class_name = "#{error_name_stub.camelcase(:upper)}Error"
+      config_die_key = "die_on_#{error_ruby_class_name.snakecase}"
+      error_css_class_name = error_ruby_class_name.split('::').last.snakecase
+      config = YAML.load_file('_config.yml')
+      tag_config = config[tag_name]
+      tag_config_msg = if tag_config.nil?
+                         <<~END_MSG
+                           _config.yml does not contain configuration information for this plugin.
+                             You could add a section containing default values by specifying a section for the tag name,
+                             and an entry whose name starts with `die_on_`, followed by a snake_case version of the error name.
+
+                               #{tag_name}:
+                                 #{config_die_key}: false
+                         END_MSG
+                       else
+                         <<~END_MSG
+                           _config.yml contains the following configuration for this plugin:
+                             #{tag_config}
+                         END_MSG
+                       end
+
+      <<~END_MSG
+        Loaded plugin #{tag_name} v#{version}. It has:
+          Error class: #{error_ruby_class_name}
+          CSS class for error messages: #{error_css_class_name}
+
+          #{tag_config_msg}
+      END_MSG
+    end
+
+    def self.register(klass, tag_name)
+      abort("Error: The #{tag_name} plugin does not define VERSION") \
+        unless klass.const_defined?(:VERSION)
+
+      version = klass.const_get(:VERSION)
+
+      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))
+
+      Liquid::Template.register_tag(tag_name, klass)
+      msg = generate_message(klass, tag_name, version)
+      PluginMetaLogger.instance.info { msg }
+    end
+
+    def self.remove_html_tags(string)
+      string.gsub(/<[^>]*>/, '').strip
+    end
+
+    # strip leading and trailing quotes if present
+    def self.remove_quotes(string)
+      string.strip.gsub(/\A'|\A"|'\Z|"\Z/, '').strip if string
+    end
+  end
+end

data/lib/{jekyll_plugin_support_class.rb → jekyll_plugin_support/jekyll_plugin_support_class.rb}

@@ -1,4 +1,4 @@
-require_relative 'jekyll_custom_error'
+require_relative '../error/jekyll_custom_error'
 
 # Monkey patch StandardError so a new method called shorten_backtrace is added.
 class StandardError
@@ -22,7 +22,7 @@ module JekyllSupport
 
   # @return a new StandardError subclass containing the shorten_backtrace method
   def define_error
-    Class.new Jekyll::CustomError
+    Class.new JekyllSupport::CustomError
   end
   module_function :define_error
 

data/lib/jekyll_plugin_support/version.rb

@@ -1,3 +1,3 @@
 module JekyllPluginSupportVersion
-  VERSION = '0.8.5'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/lib/jekyll_plugin_support.rb

@@ -1,8 +1,19 @@
 require 'colorator'
 require 'jekyll'
 require 'jekyll_plugin_logger'
-require_relative 'jekyll_plugin_helper'
-require_relative 'jekyll_plugin_support/version'
+
+def require_directory(dir)
+  Dir[File.join(dir, '*.rb')].sort.each do |file|
+    require file unless file == __FILE__
+  end
+end
+
+module JekyllSupport
+  def self.redef_without_warning(const, value)
+    send(:remove_const, const) if const_defined?(const)
+    const_set const, value
+  end
+end
 
 module NoArgParsing
   attr_accessor :no_arg_parsing
@@ -10,9 +21,10 @@ module NoArgParsing
   @no_arg_parsing = true
 end
 
-require_relative 'jekyll_plugin_support_class'
-require_relative 'jekyll_plugin_support_block'
-require_relative 'jekyll_plugin_support_block_noarg'
-require_relative 'jekyll_plugin_support_tag'
-require_relative 'jekyll_plugin_support_tag_noarg'
-require_relative 'jekyll_custom_error'
+require_directory __dir__
+require_directory "#{__dir__}/block"
+require_directory "#{__dir__}/error"
+require_directory "#{__dir__}/generator"
+require_directory "#{__dir__}/helper"
+require_directory "#{__dir__}/jekyll_plugin_support"
+require_directory "#{__dir__}/tag"

data/lib/{jekyll_plugin_support_tag.rb → tag/jekyll_plugin_support_tag.rb}

@@ -1,14 +1,11 @@
 require 'pry'
-require_relative 'jekyll_plugin_error_handling'
+require_relative '../error/jekyll_plugin_error_handling'
 
 module JekyllSupport
   # Base class for Jekyll tags
   class JekyllTag < Liquid::Tag
     attr_reader :argument_string, :helper, :line_number, :logger, :page, :site
 
-    include JekyllSupportErrorHandling
-    extend JekyllSupportErrorHandling
-
     # 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.
@@ -29,7 +26,7 @@ module JekyllSupport
       @helper = JekyllPluginHelper.new(tag_name, @argument_string, @logger, respond_to?(:no_arg_parsing))
 
       @error_name = "#{tag_name.camelcase(:upper)}Error"
-      Jekyll::CustomError.factory @error_name
+      JekyllSupport::CustomError.factory @error_name
     end
 
     # Method prescribed by the Jekyll plugin lifecycle.
@@ -55,10 +52,11 @@ module JekyllSupport
       @paginator = @envs[:paginator]
       @theme     = @envs[:theme]
 
-      @mode = @config['env']&.key?('JEKYLL_ENV') ? @config['env']['JEKYLL_ENV'] : 'development'
+      env = @config['env']
+      @mode = env&.key?('JEKYLL_ENV') ? env['JEKYLL_ENV'] : 'development'
 
       markup = JekyllSupport.lookup_liquid_variables liquid_context, @argument_string
-      @helper.reinitialize markup
+      @helper.reinitialize markup.strip
 
       render_impl
     rescue StandardError => e

data/lib/{jekyll_plugin_support_tag_noarg.rb → tag/jekyll_plugin_support_tag_noarg.rb}

@@ -1,12 +1,9 @@
-require_relative 'jekyll_plugin_error_handling'
+require_relative '../error/jekyll_plugin_error_handling'
 
 module JekyllSupport
   class JekyllTagNoArgParsing < JekyllTag
     attr_reader :argument_string, :helper, :line_number, :logger, :page, :site
 
-    include JekyllSupportErrorHandling
-    extend JekyllSupportErrorHandling
-
     def initialize(tag_name, argument_string, parse_context)
       class << self
         include NoArgParsing

data/spec/custom_error_spec.rb

@@ -17,7 +17,7 @@ class CustomErrorSpec
     raise AnError, 'Oops'
   rescue AnError => e
     puts "Caught AnError: #{e.message}"
-  rescue Jekyll::CustomError => e
+  rescue JekyllSupport::CustomError => e
     puts "Caught CustomError: #{e.message}"
   end
 
@@ -31,7 +31,7 @@ class CustomErrorSpec
     end
   end
 
-  RSpec.describe Jekyll::CustomError do
+  RSpec.describe JekyllSupport::CustomError do
     it 'can create custom errors' do
       expect { raise AnError, 'Oops' }.to raise_error(AnError)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_plugin_support
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-25 00:00:00.000000000 Z
+date: 2024-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: facets
@@ -94,19 +94,20 @@ files:
 - README.md
 - Rakefile
 - jekyll_plugin_support.gemspec
-- lib/jekyll_custom_error.rb
-- lib/jekyll_plugin_error_handling.rb
-- lib/jekyll_plugin_helper.rb
-- lib/jekyll_plugin_helper_attribution.rb
-- lib/jekyll_plugin_helper_class.rb
+- lib/block/jekyll_plugin_support_block.rb
+- lib/block/jekyll_plugin_support_block_noarg.rb
+- lib/error/jekyll_custom_error.rb
+- lib/error/jekyll_plugin_error_handling.rb
+- lib/generator/jekyll_plugin_support_generator.rb
+- lib/helper/jekyll_plugin_helper.rb
+- lib/helper/jekyll_plugin_helper_attribution.rb
+- lib/helper/jekyll_plugin_helper_class.rb
 - lib/jekyll_plugin_support.rb
+- lib/jekyll_plugin_support/jekyll_plugin_support_class.rb
+- lib/jekyll_plugin_support/jekyll_plugin_support_spec_support.rb
 - lib/jekyll_plugin_support/version.rb
-- lib/jekyll_plugin_support_block.rb
-- lib/jekyll_plugin_support_block_noarg.rb
-- lib/jekyll_plugin_support_class.rb
-- lib/jekyll_plugin_support_spec_support.rb
-- lib/jekyll_plugin_support_tag.rb
-- lib/jekyll_plugin_support_tag_noarg.rb
+- lib/tag/jekyll_plugin_support_tag.rb
+- lib/tag/jekyll_plugin_support_tag_noarg.rb
 - spec/custom_error_spec.rb
 - spec/jekyll_plugin_helper_options_spec.rb
 - spec/liquid_variable_parsing_spec.rb
@@ -139,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Provides a framework for writing and testing Jekyll plugins

data/lib/jekyll_plugin_helper.rb

@@ -1,110 +0,0 @@
-require 'facets/string/interpolate'
-require 'key_value_parser'
-require 'shellwords'
-require_relative 'jekyll_plugin_helper_class'
-require_relative 'jekyll_plugin_helper_attribution'
-
-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
-
-  # 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.
-  # @param argument_string [String] the arguments from 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
-  # @return [void]
-  def initialize(tag_name, markup, logger, no_arg_parsing)
-    @tag_name = tag_name
-    @logger = logger
-    @no_arg_parsing = no_arg_parsing
-    @markup = markup
-  rescue StandardError => e
-    e.shorten_backtrace
-    @logger.error { e.message }
-  end
-
-  # @return undefined if parameter was specified, removes it from the available tokens and returns value
-  def parameter_specified?(name, delete_param: true)
-    return false if @keys_values.to_s.empty?
-
-    key = name
-    key = name.to_sym if @keys_values&.first&.first.instance_of?(Symbol)
-    value = @keys_values[key]
-    delete_parameter(name) if delete_param
-    value
-  end
-
-  def reinitialize(markup)
-    # @keys_values was a Hash[Symbol, String|Boolean] but now it is Hash[String, String|Boolean]
-    @markup = markup
-    if @no_arg_parsing
-      define_singleton_method(:argv) { warn_fetch :argv }
-      define_singleton_method(:keys_values) { warn_fetch :keys_values }
-      define_singleton_method(:params) { warn_fetch :params }
-      define_singleton_method(:parameter_specified?) { |_name| warn_parse(:parameter_specified?) }
-      define_singleton_method(:delete_parameter) { |_name| warn_parse(:delete_parameter) }
-      @attribution = false
-    else
-      parse markup
-      @attribution = parameter_specified?('attribution') || false
-      @logger.debug { "@keys_values='#{@keys_values}'" }
-    end
-  end
-
-  # Call this method to return the remaining markup after `parameter_specified?` has been invoked.
-  def remaining_markup
-    @argv&.join(' ')
-  end
-
-  def remaining_markup_original
-    @argv_original&.join(' ')
-  end
-
-  def warn_fetch(variable)
-    abort "Error: Argument parsing was suppressed, but an attempt to obtain the value of #{variable} was made"
-  end
-
-  def warn_parse(meth)
-    abort "Error: Argument parsing was suppressed, but an attempt to invoke #{meth} was made"
-  end
-
-  def delete_parameter(key)
-    return if @keys_values.empty? || @params.nil?
-
-    @params.delete(key)
-    @argv.delete_if { |x| x == key or x.start_with?("#{key}=") }
-    @keys_values.delete(key)
-
-    @params_original.delete(key)
-    @argv_original.delete_if { |x| x == key or x.start_with?("#{key}=") }
-    @keys_values_original.delete(key)
-  end
-
-  private
-
-  def page
-    @liquid_context.registers[:page]
-  end
-
-  def parse(markup)
-    @argv_original = Shellwords.split(markup)
-    @keys_values_original = KeyValueParser
-                            .new({}, { array_values: false, normalize_keys: false, separator: /=/ })
-                            .parse(@argv_original)
-    @params_original = @keys_values_original unless respond_to?(:no_arg_parsing) && no_arg_parsing
-
-    @argv = Shellwords.split(self.class.expand_env(markup, logger))
-    @keys_values = KeyValueParser
-                   .new({}, { array_values: false, normalize_keys: false, separator: /=/ })
-                   .parse(@argv)
-
-    return if respond_to?(:no_arg_parsing) && no_arg_parsing
-
-    @params = @keys_values # TODO: @keys_values should be deleted
-  end
-end

data/lib/jekyll_plugin_helper_attribution.rb

@@ -1,72 +0,0 @@
-# Attribution aspect of JekyllPluginHelper
-class JekyllPluginHelper
-  # @param file must be a fully qualified file name that points to a file within a gem.
-  # @return Gem::Specification of gem that file points into, or nil if not called from a gem
-  # See https://stackoverflow.com/a/75890279/553865
-  def self.current_spec(file)
-    abort 'JekyllPluginHelper::current_spec: file is nil' if file.nil?
-    return nil unless File.exist?(file)
-
-    searcher = if Gem::Specification.respond_to?(:find)
-                 Gem::Specification
-               elsif Gem.respond_to?(:searcher)
-                 Gem.searcher.init_gemspecs
-               end
-
-    searcher&.find do |spec|
-      file.start_with? spec.full_gem_path
-    end
-  end
-
-  def attribute
-    return unless @current_gem
-
-    <<~END_OUTPUT
-      <div id="jps_attribute_#{rand(999_999)}" class="jps_attribute">
-        <div>
-          <a href="#{@homepage}" target="_blank" rel="nofollow">
-            #{attribution_string}
-          </a>
-        </div>
-      </div>
-    END_OUTPUT
-  end
-
-  def default_attribution
-    authors = @authors&.join(', ')
-    result = "Generated by the \#{@name} v\#{@version} Jekyll plugin"
-    result << ", written by #{authors}" if authors
-    result << " \#{@published_date}" if @published_date
-    result << '.'
-    result
-  end
-
-  # Sets @current_gem if file points at a uniquely named file within a gem.
-  # @param file must be a fully qualified file name in a gem, for example: __FILE__
-  def gem_file(file)
-    @current_gem = JekyllPluginHelper.current_spec file
-    @logger.debug "No gem found for '#{file} was found." unless @current_gem
-    annotate_globals if @attribution && @current_gem
-  end
-
-  private
-
-  def annotate_globals
-    return unless @current_gem
-
-    @name           = @current_gem.name
-    @authors        = @current_gem.authors
-    @homepage       = @current_gem.homepage
-    @published_date = @current_gem.date.to_date.to_s
-    @version        = @current_gem.version
-  end
-
-  def attribution_string
-    string = if @attribution == true
-               default_attribution
-             else
-               @attribution
-             end
-    String.interpolate { string }
-  end
-end

data/lib/jekyll_plugin_helper_class.rb

@@ -1,81 +0,0 @@
-require 'facets/string/camelcase'
-require 'facets/string/snakecase'
-require 'yaml'
-
-# Class methods for JekyllPluginHelper
-class JekyllPluginHelper
-  # Expand an environment variable reference
-  def self.expand_env(str, logger = nil, die_if_undefined: false)
-    str&.gsub(/\$([a-zA-Z_][a-zA-Z0-9_]*)|\${\g<1>}/) do
-      envar = Regexp.last_match(1)
-      unless ENV.key? envar
-        msg = "jekyll_plugin_support error: environment variable #{envar} is undefined"
-        raise JekyllPluginSupportError, msg.red, [] if die_if_undefined
-
-        if logger
-          logger.warn msg
-        else
-          puts msg.red
-        end
-      end
-      ENV.fetch(envar, nil)
-    end
-  end
-
-  def self.generate_message(klass, tag_name, version)
-    error_name_stub = klass.name.include?('::') ? klass.name.split('::')[1] : klass.name
-    error_ruby_class_name = "#{error_name_stub.camelcase(:upper)}Error"
-    config_die_key = "die_on_#{error_ruby_class_name.snakecase}"
-    error_css_class_name = error_ruby_class_name.split('::').last.snakecase
-    config = YAML.load_file('_config.yml')
-    tag_config = config[tag_name]
-    tag_config_msg = if tag_config.nil?
-                       <<~END_MSG
-                         _config.yml does not contain configuration information for this plugin.
-                           You could add a section containing default values by specifying a section for the tag name,
-                           and an entry whose name starts with `die_on_`, followed by a snake_case version of the error name.
-
-                             #{tag_name}:
-                               #{config_die_key}: false
-                       END_MSG
-                     else
-                       <<~END_MSG
-                         _config.yml contains the following configuration for this plugin:
-                           #{tag_config}
-                       END_MSG
-                     end
-
-    <<~END_MSG
-      Loaded plugin #{tag_name} v#{version}. It has:
-        Error class: #{error_ruby_class_name}
-        CSS class for error messages: #{error_css_class_name}
-
-        #{tag_config_msg}
-    END_MSG
-  end
-
-  def self.register(klass, tag_name)
-    abort("Error: The #{tag_name} plugin does not define VERSION") \
-      unless klass.const_defined?(:VERSION)
-
-    version = klass.const_get(:VERSION)
-
-    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))
-
-    Liquid::Template.register_tag(tag_name, klass)
-    msg = generate_message(klass, tag_name, version)
-    PluginMetaLogger.instance.info { msg }
-  end
-
-  def self.remove_html_tags(string)
-    string.gsub(/<[^>]*>/, '').strip
-  end
-
-  # strip leading and trailing quotes if present
-  def self.remove_quotes(string)
-    string.strip.gsub(/\A'|\A"|'\Z|"\Z/, '').strip if string
-  end
-end