jekyll_plugin_support 3.1.2 → 3.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a63b7533f8a3f533d8dc786921c5792b7517ac60c5fbb21f93b19e7a6a579f93
-  data.tar.gz: ad1d4c07e39743b8fd057f0235ab6ae6c1f89fa130026d7f7012d8a855cf5fc3
+  metadata.gz: 0e9e668968a611289735fbb49845ac930d027015d4c385295e78722f85cf40cf
+  data.tar.gz: b2cc67846dd969875cf3fa62cba74adfbe10ed86b9607077054e63c07ac890e8
 SHA512:
-  metadata.gz: db14aae8119f378a9032c6aefa6d9a0065e735c2dbf5965b136a1bf393782f573ed178645db5c50c420eb4b8767c046f7802be690628d3cc0efb57849e85ac00
-  data.tar.gz: 54ab6a67d6fecc4b587d00eda923868a0780555fa52af2ebe092fb080aa5537b01da7f99140cb0ab13c0ab9f3fc891b7f127f93d873c6b8c9eb478f90ba8c3fd
+  metadata.gz: 831f38b469c65ef2e2332f18b1624ce06626322643939e3bc497f513c24092070b7ac96664f0a6a63f323f8058141f7c6159966ed23fb76741f807d53d5ffef5
+  data.tar.gz: fe06519f62fb7a42cdbba80752cd12a85ad2f1458fa18a2318bb758d75d6c02a65739f62096f6bda3077947588da88398aa6b7cb644346438b35c905b963ee43

data/.rubocop.yml

@@ -107,6 +107,9 @@ Style/GlobalVars:
   Exclude:
     - spec/mslinn_binary_search_spec.rb
 
+Style/OneClassPerFile:
+  Enabled: false
+
 Style/RedundantParentheses:
   Exclude:
     - README.md

data/CHANGELOG.md

@@ -1,19 +1,30 @@
 # Change Log
 
+## 3.1.6
+
+Several little fixes and tweaks.
+
+
+## 3.1.5
+
+* Added install subcommand to bundle invocations
+* Replaced `wslvar` which is no longer maintained
+
+
+## 3.1.4
+
+* Added `@jekyll_version` instance variable exposing raw HTML content of the page being processed
+* Added `@raw_content` instance variable exposing raw HTML content of the page being processed
+
+
 ## 3.1.3 / 2025-01-02
 
-* **BREAKING CHANGE**: Modified `JekyllPluginHelper.expand_env` to only expand Bash environment
-  variables (`$VAR` or `${VAR}`), not Windows environment variables (`%VAR%`). This prevents false
-  expansions in web content where text strings contain pairs of percent signs that are not
-  environment variables.
-* Removed the `use_wslvar` parameter from `JekyllPluginHelper.expand_env` method signature.
-* `JekyllPluginHelper.env_var_expand_windows` is still available for plugins that specifically
-  need Windows environment variable expansion.
-* `jekyll_flexible_include_plugin` now explicitly calls both `env_var_expand_bash` and
-  `env_var_expand_windows` for file paths to maintain its ability to handle both Bash and
-  Windows environment variables.
-* Updated `JekyllPluginHelper.find_windows_envar` to properly fall back to environment variable
-  search when `wslvar` is not available or doesn't find the variable.
+* Modified `JekyllPluginHelper.expand_env` to only expand Bash environment
+  variables (`$VAR` or `${VAR}`), not Windows environment variables (`%VAR%`)
+* Removed the `use_wslvar` parameter from `JekyllPluginHelper.expand_env` method
+  signature
+* `env_var_expand_windows` remains available for plugins that specifically need
+  Windows environment variable expansion
 
 
 ## 3.1.2 / 2025-11-17
@@ -69,12 +80,7 @@
 * Added the `bin/release_port` script that kills hung processes being debugged
 * Added the `cleanDemo` task for the **Debug Demo production** and **Debug Demo development** tasks
 * Many minor improvements to the demo.
-* `JekyllSupport::JekyllPluginHelper::register` now accepts a `quiet` option, to suppress the signon message.
-  Use it like this:
-
-  ```ruby
-  JekyllPluginHelper.register(self, 'tag_name', quiet: true)
-  ```
+* `JekyllPluginHelper.register` now accepts a `quiet` option to suppress the signon message
 
 
 ## 1.0.3 / 2024-08-19
@@ -86,19 +92,7 @@
 
 * Computes line_number and path properly
 * Refactored demo CSS
-* Improved custom plugin error handling and sample code.
-  The following seems to be optimal for custom plugins; it suppresses the ridiculously long stack trace that used to be generated:
-
-   ```ruby
-   begin
-     # ...
-   rescue DemoInlineTagError => e # jekyll_plugin_support handles StandardError
-     @logger.error { e.logger_message }
-     exit! 1 if @die_on_demo_tag_error
-
-     e.html_message
-   end
-   ```
+* Improved custom plugin error handling and sample code
 
 
 ## 1.0.1 / 2024-07-27
@@ -161,10 +155,8 @@
 * Demo site now shows how to define and handle custom errors.
 * Added `@tag_config` variable, which can be inspected to determine whether to die on various types of exceptions.
 * Added `format_error_message`, `maybe_reraise_error`, and `raise_error` to `JekyllBlock` and `JekyllTag`
-* Adds a method called `shorten_backtrace` to `StandardError` and all custom error
-  classes defined by `JekyllSupport.define_error`.
-  See the `demo/` directory for examples of how to use this optional feature.
-* The `plugin-vars` section in `_config.yml` was renamed to `liquid_vars`.
+* Added `shorten_backtrace` to StandardError and all custom error classes defined by `JekyllSupport.define_error`
+* The `plugin-vars` section in `_config.yml` was renamed to `liquid_vars`
 
 
 ## 0.7.2 / 2023-08-14
@@ -176,10 +168,8 @@
 
 * Suppressed stack trace from issue [#4](../../issues/4).
 * Now using Shopify `ruby-lsp` instead of `rebornix.Ruby` by Peng Lv
-* Debug configurations changed to `rdbg` instead of `ruby`, so the `debase` development dependency was changed to
-  [`debug`](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg),
-  which provides the `rdgb` command.
-  The `ruby-debug-ide` development dependency is also no longer required.
+* Debug configurations changed to `rdbg` instead of `ruby`, so the `debase` development dependency was changed to [`debug`](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg)
+* The `ruby-debug-ide` development dependency is no longer required
 
 
 ## 0.7.0 / 2023-05-22

data/FIXME.md

@@ -0,0 +1,49 @@
+# Code Smells in `jekyll_plugin_support`
+
+A review of the codebase turned up the issues below. They are ordered by
+severity. Line numbers refer to the state of the repo at the time of review and
+may drift.
+
+## Medium severity
+
+### 6. Duplication between `JekyllTag` and `JekyllBlock`
+
+`render`, `initialize`, and `set_error_context` are ~90% identical across
+`lib/tag/jekyll_plugin_support_tag.rb` and
+`lib/block/jekyll_plugin_support_block.rb`. The block version even logs
+`e.full_message` **twice** (lines 89 and 93). Extract a shared
+`JekyllPluginBase` module.
+
+
+### 12. `parse` has a leftover TODO and dead branch
+
+```ruby
+@params_original = @keys_values_original unless respond_to?(:no_arg_parsing) && no_arg_parsing
+...
+@params = @keys_values # TODO: @keys_values should be deleted
+```
+
+The conditional on `@params_original` is moot because `reinitialize` only calls
+`parse` when `!@no_arg_parsing`. And the TODO has lingered.
+(`lib/helper/jekyll_plugin_helper.rb:91-106`)
+
+## Lower severity
+
+### 17. Comment typos / placeholder text in docs
+
+`@ptions` appears in the parse_context doc block of *both* tag and block files
+(should be `@options`). Comments like `# Are error and logger.error defined?`
+(`lib/jekyll_plugin_support/jekyll_plugin_support_class.rb:18`) read like
+unanswered questions left in production.
+
+### 20. `_` prefixed unused param but still required
+
+`dump_vars(_logger, liquid_context)` — the `_` prefix says "unused," but callers
+must still pass it. Either drop the parameter or use it.
+(`lib/jekyll_plugin_support/jekyll_plugin_support_class.rb:30`)
+
+
+## Suggested order to tackle
+
+1. **Extract shared base for `JekyllTag`/`JekyllBlock` (#6)** — biggest maintainability win.
+3. Remove dead/commented code (#4).

data/README.md

@@ -35,6 +35,9 @@ Public plugins that use `jekyll_plugin_support` include:
   <li>
     <a href='https://www.mslinn.com/jekyll_plugins/jekyll_img.html'><code>jekyll_img</code></a>
   </li>
+  <li>
+    <a href='https://www.mslinn.com/jekyll_plugins/jekyll_kramdown.html'><code>jekyll_kramdown</code></a>
+  </li>
   <li>
     <a href='https://www.mslinn.com/jekyll_plugins/jekyll_outline.html'><code>jekyll_outline</code></a>
   </li>
@@ -54,7 +57,8 @@ Public plugins that use `jekyll_plugin_support` include:
 
 Jekyll plugin tags created from `jekyll_plugin_support` framework automatically have the following features:
 
-0. Claude LLM support is provided
+0. Generic LLM support is provided; tested and works with Claude and mini-agent from MiniMax.
+   Gemini is not recommended since it can only handle one project at a time, and this component is a project.
 1. Boilerplate is removed, so you can focus on the required logic and output.
 2. Arguments are parsed for keywords and name/value parameters.
 3. Single or double quotes can be used for arguments and parameters.
@@ -154,7 +158,7 @@ end
 Install the `jekyll_plugin_support` gem into your plugin project in the usual manner:
 
 ```shell
-$ bundle
+$ bundle install
 ```
 
 Copy the CSS classes from
@@ -456,9 +460,21 @@ Included spaces are ignored:
 * [`@config`](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll#configuring-jekyll-in-your-github-pages-site)
   The [YAML](https://yaml.org/) Jekyll site configuration file
 
+- `@jekyll_version` version of Jekyll, the returned string might have a value like "4.4.1".
+
 * [`@helper`](https://github.com/mslinn/jekyll_plugin_support/blob/master/lib/jekyll_plugin_helper.rb)
   `JekyllPluginHelper` instance for your plugin.
 
+* `@highlighter_prefix` Syntax highlighter prefix, as it exists
+  during the [layout rendering stage](https://jekyllrb.com/docs/plugins/hooks/)
+  occurring between `:documents, :post_convert` and `:documents, :post_render`.
+  All pages, posts and documents go through this phase.
+
+* `@highlighter_suffix` Syntax highlighter suffix, as it exists
+  during the [layout rendering stage](https://jekyllrb.com/docs/plugins/hooks/)
+  occurring between `:documents, :post_convert` and `:documents, :post_render`.
+  All pages, posts and documents go through this phase.
+
 * [`@layout`](https://jekyllrb.com/docs/variables/#global-variables) Layout information
 
 * `@logger` [`jekyll_plugin_logger`](https://github.com/mslinn/jekyll_plugin_logger) instance for your Jekyll plugin.
@@ -470,6 +486,11 @@ Included spaces are ignored:
 
 * [`@paginator`](https://jekyllrb.com/docs/variables/#page-variables) Pagination variables
 
+- `@raw_content` The raw HTML/Markdown content of the current page, as it exists
+  during the [layout rendering stage](https://jekyllrb.com/docs/plugins/hooks/)
+  occurring between `:documents, :post_convert` and `:documents, :post_render`.
+  All pages, posts and documents go through this phase.
+
 * [`@scopes`](https://jekyllrb.com/docs/variables/)
   See the [`jekyll_plugin_support` demo project](demo/variables.html)
 
@@ -643,16 +664,20 @@ They are can be used like any other Liquid variable.
 ## Variable Expansion
 
 Jekyll expands Liquid variable references during the page rendering process.
-Jekyll does not expand Liquid variable references passes as parameters to tag and block plugins, however.
+Jekyll does not expand Liquid variable references passed as parameters to tag and block plugins, however.
 However, plugins made from `jekyll_plugin_support` automatically
 expand all types of variable references passed as parameters and in block tag bodies.
 
-`Jekyll_plugin_support` tag and block plugins expand the following types of variables:
+`jekyll_plugin_support` tag and block plugins expand the following types of variables:
 
-* Jekyll_plugin_support configuration variables, discussed above.
+* jekyll_plugin_support configuration variables, discussed above.
 * Jekyll [page](https://jekyllrb.com/docs/variables/#page-variables) and
   [layout](https://jekyllrb.com/docs/layouts/#variables) variables.
+* Jekyll global variables such as `jekyll.version` and `jekyll.environment`.
 * Inline Liquid variables (defined in [assign](https://shopify.dev/docs/api/liquid/tags/assign) and [capture](https://shopify.dev/docs/api/liquid/tags/capture) statements).
+* Include variables (when plugins are invoked from within Jekyll include files with parameters).
+* Theme variables (provided by the active theme).
+* Paginator variables (for sites with pagination).
 
 In the following example web page, Jekyll expands the `var1` reference within the `<p></p>` tag,
 but not the `var1` or `var2` references passed to `my_plugin`.
@@ -674,8 +699,14 @@ Thus, the above is interpreted as follows when `my_plugin` is evaluated during t
 {% my_plugin param1="value1" param2="value 2" %}
 ```
 
+**Note on Variable Resolution Order**: Variables are processed in Jekyll's actual priority order to ensure expected behavior:
+1. Page variables (e.g., `{{page.title}}`)
+2. Layout variables (e.g., `{{layout.name}}`)
+3. Jekyll global variables (e.g., `{{jekyll.version}}`)
+4. Include variables (e.g., `{{include.my_var}}`)
+5. Liquid variables (e.g., `{{my_var}}` from `assign`/`capture`)
 
-`Jekyll_plugin_support` expands most of the [plugin variables described above](#predefined-variables),
+`jekyll_plugin_support` expands most of the [plugin variables described above](#predefined-variables),
 replacing Liquid variable references with their values.
 The exception is `@argument_string`, which is not expanded.
 

data/jekyll_plugin_support.gemspec

@@ -34,6 +34,5 @@ Gem::Specification.new do |spec|
   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,7 +1,8 @@
 module JekyllSupport
   # Base class for Jekyll block tags
   class JekyllBlock < Liquid::Block
-    attr_reader :argument_string, :helper, :line_number, :logger, :page, :site, :text
+    attr_reader :argument_string, :helper, :highlighter_prefix, :highlighter_suffix, :jekyll_version, :line_number, :logger, :page, :raw_content,
+                :site, :text
 
     # 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.
@@ -62,9 +63,13 @@ 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]
+      @highlighter_prefix = @envs[:highlighter_prefix]
+      @highlighter_suffix = @envs[:highlighter_suffix]
+      @jekyll_version = @envs[:jekyll]['version']
+      @layout      = @envs[:layout]
+      @paginator   = @envs[:paginator]
+      @raw_content = @envs[:content]
+      @theme       = @envs[:theme]
 
       env = @config['env']
       @mode = env&.key?('JEKYLL_ENV') ? env['JEKYLL_ENV'] : 'development'
@@ -75,10 +80,6 @@ module JekyllSupport
       @attribution = @helper.parameter_specified?('attribution') || false unless @no_arg_parsing
       @logger.debug { "@keys_values='#{@keys_values}'" }
 
-      # @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
@@ -87,7 +88,7 @@ module JekyllSupport
       in_file_name = "in '#{file_name}' " if file_name
       of_page = "of '#{@page['path']}'" if @page
       @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
+      binding.pry if @pry_on_standard_error && defined?(Pry) # rubocop:disable Lint/Debugger
       raise e if @die_on_standard_error
 
       <<~END_MSG
@@ -100,7 +101,7 @@ module JekyllSupport
     # Jekyll plugins should override this method, not render,
     # so they 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
+    #   @argument_string, @config, @envs, @helper, @highlighter_prefix, @highlighter_suffix, @layout, @logger, @mode, @page, @paginator, @raw_content, @site, @tag_name and @theme
     # @return [String] The result to be rendered to the invoking page
     def render_impl(text)
       text

data/lib/block/jekyll_plugin_support_block_noarg.rb

@@ -1,7 +1,5 @@
 module JekyllSupport
   class JekyllBlockNoArgParsing < JekyllBlock
-    attr_reader :argument_string, :helper, :line_number, :logger, :page, :site
-
     def initialize(tag_name, argument_string, parse_context)
       class << self
         include NoArgParsing

data/lib/error/jekyll_custom_error.rb

@@ -42,12 +42,8 @@ module JekyllSupport
       END_MSG
     end
 
-    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
+    def shorten_backtrace(backtrace_element_count = 5)
+      set_backtrace backtrace.first(backtrace_element_count)
     end
   end
 end

data/lib/helper/jekyll_plugin_helper.rb

@@ -27,7 +27,7 @@ module JekyllSupport
 
     # @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?
+      return false if @keys_values.empty?
 
       key = name
       key = name.to_sym if @keys_values&.first&.first.instance_of?(Symbol)

data/lib/helper/jekyll_plugin_helper_class.rb

@@ -68,15 +68,9 @@ module JekyllSupport
     #
     def self.find_windows_envar(envar, use_wslvar: true)
       if use_wslvar
-        wslvar_path = `which wslvar 2> /dev/null`.chomp
-        if wslvar_path.empty?
-          warn "jekyll_plugin_support warning: wslvar not found in PATH; will attempt to find $#{envar} in the bash environment variables."
-          return env_var_case_insensitive(envar)
-        end
-
-        result = `wslvar #{envar} &2> /dev/null`.chomp
+        result = self.wslvar envar
         if result.empty?
-          warn "jekyll_plugin_support warning: wslvar did not find $#{envar}; will attempt to find it in the bash environment variables."
+          error "jekyll_plugin_support warning: wslvar did not find $#{envar}; will attempt to find it in the bash environment variables."
           return env_var_case_insensitive(envar)
         end
 
@@ -85,6 +79,10 @@ module JekyllSupport
       env_var_case_insensitive(envar)
     end
 
+    def self.wslvar(envar)
+      result = `powershell.exe -NoProfile -Command "Write-Output \\$env:#{envar}" 2> /dev/null`.chomp("\r\n")
+    end
+
     # Detect if Jekyll is running under WSL
     def self.wsl_detected? = File.read('/proc/version').include?('-WSL')
 

data/lib/jekyll_plugin_support/jekyll_plugin_support_class.rb

@@ -1,12 +1,7 @@
-# Monkey patch StandardError so a new method called shorten_backtrace is added.
 class StandardError
   def shorten_backtrace(backtrace_element_count = 5)
-    set_backtrace backtrace[0..backtrace_element_count]
-    # self.backtrace = backtrace[0..backtrace_element_count].map do |x|
-    #   raise JekyllPluginSupportError, "backtrace contains a #{x.class} with value '#{x}'." unless x.instance_of? String
-
-    #   x.gsub(Dir.pwd + '/', './')
-    # end
+    limit = [backtrace.size - 1, backtrace_element_count].min
+    set_backtrace(backtrace[0..limit])
   end
 end
 
@@ -51,17 +46,22 @@ module JekyllSupport
 
     scope = liquid_context.scopes.last
 
+    # Support multiple environment variable keys and fall back to Jekyll's environment
     env = site.config['env']
-    @mode = env&.key?('JEKYLL_ENV') ? env['JEKYLL_ENV'] : 'development'
+    @mode = env&.[]('JEKYLL_ENV') ||
+            env&.[]('JEKYLL_ENVIRONMENT') ||
+            site.config['JEKYLL_ENV'] ||
+            site.config['JEKYLL_ENVIRONMENT'] ||
+            'development'
 
-    # Set default values
+    # Set default values (support multiple data types)
     plugin_variables&.each do |name, value|
-      scope[name] = value if value.instance_of? String
+      scope[name] = value
     end
 
     # Override with environment-specific values
     plugin_variables&.[](@mode)&.each do |name, value|
-      scope[name] = value if value.instance_of? String
+      scope[name] = value
     end
 
     liquid_context
@@ -87,9 +87,17 @@ module JekyllSupport
     page   = liquid_context.registers[:page]
     envs   = liquid_context.environments.first
     layout = envs[:layout]
-
-    markup = process_layout_variables logger, layout, markup
+    jekyll = envs[:jekyll]
+
+    # Process variables in Jekyll's actual priority order:
+    # 1. Page variables (registers[:page])
+    # 2. Layout variables (environments.first[:layout])
+    # 3. Jekyll global variables (environments.first[:jekyll])
+    # 4. Include variables (scopes)
+    # 5. Liquid variables (scopes)
     markup = process_page_variables logger, page, markup
+    markup = process_layout_variables logger, layout, markup
+    markup = process_jekyll_variables logger, jekyll, markup
     liquid_context.scopes&.each do |scope|
       markup = process_included_variables logger, scope, markup
       markup = process_liquid_variables logger, scope, markup
@@ -105,19 +113,20 @@ module JekyllSupport
       raise JekyllPluginSupportError, "include.#{name} is a #{name.class}, not a String." unless name.instance_of?(String)
       raise JekyllPluginSupportError, "include.#{name} has an undefined value." if value.nil?
 
-      markup.gsub!("{{include.#{name}}}", value.to_s)
+      # Sanitize variable name to prevent regex injection
+      sanitized_name = sanitize_variable_name(name)
+      markup.gsub!("{{include.#{sanitized_name}}}", value.to_s)
     end
     markup
   rescue StandardError => e
     logger.error { e.full_message }
-    exit! 1
   end
 
   def self.process_layout_variables(logger, layout, markup)
     layout&.each do |name, value|
       if value.nil?
         value = ''
-        logger.warn { "layout.#{value} is undefined." }
+        logger.warn { 'layout.value is undefined.' }
       end
       markup.gsub!("{{layout.#{name}}}", value.to_s)
     end
@@ -154,6 +163,28 @@ module JekyllSupport
     logger.error { e.full_message }
   end
 
+  def self.process_jekyll_variables(logger, jekyll, markup)
+    return markup unless jekyll
+
+    # JekyllDrop provides access to version and environment
+    # Handle known JekyllDrop attributes
+    markup.gsub!('{{jekyll.version}}', jekyll.version.to_s) if jekyll.respond_to?(:version)
+
+    markup.gsub!('{{jekyll.environment}}', jekyll.environment.to_s) if jekyll.respond_to?(:environment)
+
+    markup
+  rescue StandardError => e
+    logger.error { e.full_message }
+  end
+
+  # Sanitizes variable names to prevent regex injection attacks
+  # @param name [String] the variable name to sanitize
+  # @return [String] sanitized variable name
+  def self.sanitize_variable_name(name)
+    # Allow only alphanumeric characters, underscores, and hyphens
+    name.to_s.gsub(/[^a-zA-Z0-9_-]/, '')
+  end
+
   def self.warn_short_trace(logger, error)
     remaining = error.backtrace.length - DISPLAYED_CALLS
     logger.warn do

data/lib/jekyll_plugin_support/version.rb

@@ -1,3 +1,3 @@
 module JekyllPluginSupportVersion
-  VERSION = '3.1.2'.freeze unless defined?(VERSION)
+  VERSION = '3.1.6'.freeze unless defined?(VERSION)
 end

data/lib/jekyll_plugin_support.rb

@@ -1,5 +1,5 @@
 def require_directory(dir)
-  Dir[File.join(dir, '*.rb')]&.sort&.each do |file|
+  Dir[File.join(dir, '*.rb')].each do |file|
     require file unless file == __FILE__
   end
 end
@@ -7,7 +7,6 @@ end
 require 'colorator'
 require 'jekyll'
 require 'jekyll_plugin_logger'
-require 'pry'
 require 'sorted_set'
 
 # require_directory __dir__
@@ -21,16 +20,9 @@ require_directory "#{__dir__}/tag"
 require_directory "#{__dir__}/jekyll_all_collections"
 require_directory "#{__dir__}/hooks"
 
-module JekyllSupport
-  def self.redef_without_warning(const, value)
-    send(:remove_const, const) if const_defined?(const)
-    const_set const, value
-  end
-end
-
 module ToString
   def to_s
-    "#{self}.class.name"
+    self.class.name
   end
 end
 
@@ -41,6 +33,11 @@ module NoArgParsing
 end
 
 module JekyllSupport
+  def self.redef_without_warning(const, value)
+    send(:remove_const, const) if const_defined?(const)
+    const_set const, value
+  end
+
   class JekyllTag
     include JekyllSupportError
     include ToString

data/lib/tag/jekyll_plugin_support_tag.rb

@@ -1,7 +1,8 @@
 module JekyllSupport
   # Base class for Jekyll tags
   class JekyllTag < Liquid::Tag
-    attr_reader :argument_string, :helper, :line_number, :logger, :page, :site
+    attr_reader :argument_string, :helper, :highlighter_prefix, :highlighter_suffix, :jekyll_version, :line_number,
+                :logger, :page, :raw_content, :site
 
     # 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.
@@ -55,9 +56,13 @@ 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]
+      @highlighter_prefix = @envs[:highlighter_prefix]
+      @highlighter_suffix = @envs[:highlighter_suffix]
+      @jekyll_version = @envs[:jekyll]['version']
+      @layout      = @envs[:layout]
+      @paginator   = @envs[:paginator]
+      @raw_content = @envs[:content]
+      @theme       = @envs[:theme]
 
       env = @config['env']
       @mode = env&.key?('JEKYLL_ENV') ? env['JEKYLL_ENV'] : 'development'
@@ -65,10 +70,6 @@ module JekyllSupport
       @argument_string = JekyllSupport.lookup_liquid_variables @logger, @helper.liquid_context, @argument_string.to_s.strip
       @helper.reinitialize @argument_string.to_s.strip
 
-      # @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
     rescue StandardError => e
       e.shorten_backtrace
@@ -76,7 +77,7 @@ module JekyllSupport
       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
+      binding.pry if @pry_on_standard_error && defined?(Pry) # rubocop:disable Lint/Debugger
       raise e if @die_on_standard_error
 
       <<~END_MSG
@@ -88,7 +89,7 @@ module JekyllSupport
 
     # 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
+    #   @argument_string, @config, @envs, @helper, @highlighter_prefix, @highlighter_suffix, @layout, @logger, @mode, @page, @paginator, @raw_content, @site, @tag_name and @theme
     def render_impl
       abort "#{self.class}.render_impl for tag #{@tag_name} must be overridden, but it was not."
     end

data/lib/tag/jekyll_plugin_support_tag_noarg.rb

@@ -1,7 +1,5 @@
 module JekyllSupport
   class JekyllTagNoArgParsing < JekyllTag
-    attr_reader :argument_string, :helper, :line_number, :logger, :page, :site
-
     def initialize(tag_name, argument_string, parse_context)
       class << self
         include NoArgParsing

data/spec/status_persistence.txt

@@ -1,52 +1,53 @@
 example_id                                                        | status  | run_time        |
 ----------------------------------------------------------------- | ------- | --------------- |
-./spec/all_collections_tag/all_collections_tag_sort_spec.rb[1:1]  | passed  | 0.00367 seconds |
-./spec/all_collections_tag/all_collections_tag_sort_spec.rb[1:2]  | passed  | 0.00321 seconds |
-./spec/all_collections_tag/all_collections_tag_sort_spec.rb[1:3]  | passed  | 0.004 seconds   |
-./spec/all_collections_tag/all_collections_tag_sort_spec.rb[1:4]  | passed  | 0.00724 seconds |
-./spec/all_collections_tag/all_collections_tag_sort_spec.rb[1:5]  | passed  | 0.00321 seconds |
-./spec/all_collections_tag/all_collections_tag_sort_spec.rb[1:6]  | passed  | 0.00501 seconds |
-./spec/all_collections_tag/all_collections_tag_sort_spec.rb[1:7]  | passed  | 0.00573 seconds |
-./spec/all_collections_tag/all_collections_tag_sort_spec.rb[1:8]  | passed  | 0.00661 seconds |
-./spec/all_collections_tag/all_collections_tag_sort_spec.rb[1:9]  | passed  | 0.00674 seconds |
-./spec/all_collections_tag/all_collections_tag_sort_spec.rb[1:10] | passed  | 0.00399 seconds |
-./spec/bsearch_spec.rb[1:1]                                       | pending | 0.00029 seconds |
-./spec/bsearch_spec.rb[1:2]                                       | pending | 0.00009 seconds |
-./spec/custom_error_spec.rb[1:1]                                  | passed  | 0.0022 seconds  |
-./spec/custom_error_spec.rb[2:1]                                  | passed  | 0.0016 seconds  |
-./spec/date_sort_spec.rb[1:1]                                     | passed  | 0.00043 seconds |
-./spec/date_sort_spec.rb[1:2]                                     | passed  | 0.00125 seconds |
-./spec/date_sort_spec.rb[1:3]                                     | passed  | 0.00004 seconds |
-./spec/date_sort_spec.rb[1:4]                                     | passed  | 0.00004 seconds |
-./spec/date_sort_spec.rb[1:5]                                     | passed  | 0.00022 seconds |
-./spec/date_sort_spec.rb[1:6]                                     | passed  | 0.00004 seconds |
-./spec/date_sort_spec.rb[1:7]                                     | passed  | 0.00016 seconds |
-./spec/date_sort_spec.rb[1:8]                                     | passed  | 0.00019 seconds |
-./spec/date_sort_spec.rb[1:9]                                     | passed  | 0.00004 seconds |
-./spec/date_sort_spec.rb[1:10]                                    | passed  | 0.00004 seconds |
-./spec/expand_env_spec.rb[1:1]                                    | passed  | 0.0004 seconds  |
-./spec/expand_env_spec.rb[1:2]                                    | passed  | 2.09 seconds    |
-./spec/expand_env_spec.rb[1:3]                                    | passed  | 0.00015 seconds |
-./spec/jekyll_plugin_helper_options_spec.rb[1:1]                  | passed  | 0.00032 seconds |
-./spec/jekyll_plugin_helper_options_spec.rb[1:2]                  | passed  | 0.00013 seconds |
-./spec/jekyll_plugin_helper_options_spec.rb[1:3]                  | passed  | 0.00414 seconds |
-./spec/jekyll_plugin_helper_options_spec.rb[1:4]                  | passed  | 0.00074 seconds |
-./spec/liquid_variable_parsing_spec.rb[1:1]                       | passed  | 0.00186 seconds |
-./spec/mslinn_binary_search_spec.rb[1:1]                          | passed  | 0.00343 seconds |
-./spec/mslinn_binary_search_spec.rb[1:2]                          | passed  | 0.00018 seconds |
-./spec/mslinn_binary_search_spec.rb[1:3]                          | passed  | 0.00013 seconds |
-./spec/send_chain_spec.rb[1:1]                                    | passed  | 0.00011 seconds |
-./spec/send_chain_spec.rb[1:2]                                    | passed  | 0.00003 seconds |
-./spec/send_chain_spec.rb[1:3]                                    | passed  | 0.00002 seconds |
-./spec/send_chain_spec.rb[1:4]                                    | passed  | 0.00002 seconds |
-./spec/send_chain_spec.rb[1:5]                                    | passed  | 0.00002 seconds |
-./spec/send_chain_spec.rb[1:6]                                    | passed  | 0.00002 seconds |
-./spec/send_chain_spec.rb[1:7]                                    | passed  | 0.00034 seconds |
-./spec/send_spec.rb[1:1]                                          | passed  | 0.00011 seconds |
-./spec/send_spec.rb[1:2]                                          | passed  | 0.00003 seconds |
-./spec/sorted_lru_files_spec.rb[1:1]                              | passed  | 0.00078 seconds |
-./spec/sorted_lru_files_spec.rb[1:2]                              | passed  | 0.00031 seconds |
+./spec/all_collections_tag/all_collections_tag_sort_spec.rb[1:1]  | passed  | 0.00227 seconds |
+./spec/all_collections_tag/all_collections_tag_sort_spec.rb[1:2]  | passed  | 0.00075 seconds |
+./spec/all_collections_tag/all_collections_tag_sort_spec.rb[1:3]  | passed  | 0.00059 seconds |
+./spec/all_collections_tag/all_collections_tag_sort_spec.rb[1:4]  | passed  | 0.00367 seconds |
+./spec/all_collections_tag/all_collections_tag_sort_spec.rb[1:5]  | passed  | 0.0008 seconds  |
+./spec/all_collections_tag/all_collections_tag_sort_spec.rb[1:6]  | passed  | 0.00104 seconds |
+./spec/all_collections_tag/all_collections_tag_sort_spec.rb[1:7]  | passed  | 0.00067 seconds |
+./spec/all_collections_tag/all_collections_tag_sort_spec.rb[1:8]  | passed  | 0.00079 seconds |
+./spec/all_collections_tag/all_collections_tag_sort_spec.rb[1:9]  | passed  | 0.00065 seconds |
+./spec/all_collections_tag/all_collections_tag_sort_spec.rb[1:10] | passed  | 0.00245 seconds |
+./spec/bsearch_spec.rb[1:1]                                       | pending | 0.00005 seconds |
+./spec/bsearch_spec.rb[1:2]                                       | pending | 0.00038 seconds |
+./spec/custom_error_spec.rb[1:1]                                  | passed  | 0.00211 seconds |
+./spec/custom_error_spec.rb[2:1]                                  | passed  | 0.00182 seconds |
+./spec/date_sort_spec.rb[1:1]                                     | passed  | 0.00019 seconds |
+./spec/date_sort_spec.rb[1:2]                                     | passed  | 0.00069 seconds |
+./spec/date_sort_spec.rb[1:3]                                     | passed  | 0.00051 seconds |
+./spec/date_sort_spec.rb[1:4]                                     | passed  | 0.00006 seconds |
+./spec/date_sort_spec.rb[1:5]                                     | passed  | 0.00067 seconds |
+./spec/date_sort_spec.rb[1:6]                                     | passed  | 0.00007 seconds |
+./spec/date_sort_spec.rb[1:7]                                     | passed  | 0.00062 seconds |
+./spec/date_sort_spec.rb[1:8]                                     | passed  | 0.00007 seconds |
+./spec/date_sort_spec.rb[1:9]                                     | passed  | 0.0005 seconds  |
+./spec/date_sort_spec.rb[1:10]                                    | passed  | 0.00008 seconds |
+./spec/expand_env_spec.rb[1:1]                                    | passed  | 0.00007 seconds |
+./spec/expand_env_spec.rb[1:2]                                    | passed  | 0.00003 seconds |
+./spec/expand_env_spec.rb[1:3]                                    | passed  | 1.66 seconds    |
+./spec/expand_env_spec.rb[1:4]                                    | passed  | 0.00131 seconds |
+./spec/jekyll_plugin_helper_options_spec.rb[1:1]                  | passed  | 0.00014 seconds |
+./spec/jekyll_plugin_helper_options_spec.rb[1:2]                  | passed  | 0.00058 seconds |
+./spec/jekyll_plugin_helper_options_spec.rb[1:3]                  | passed  | 0.00169 seconds |
+./spec/jekyll_plugin_helper_options_spec.rb[1:4]                  | passed  | 0.00091 seconds |
+./spec/liquid_variable_parsing_spec.rb[1:1]                       | passed  | 0.00126 seconds |
+./spec/mslinn_binary_search_spec.rb[1:1]                          | passed  | 0.0027 seconds  |
+./spec/mslinn_binary_search_spec.rb[1:2]                          | passed  | 0.00006 seconds |
+./spec/mslinn_binary_search_spec.rb[1:3]                          | passed  | 0.00004 seconds |
+./spec/send_chain_spec.rb[1:1]                                    | passed  | 0.00003 seconds |
+./spec/send_chain_spec.rb[1:2]                                    | passed  | 0.00004 seconds |
+./spec/send_chain_spec.rb[1:3]                                    | passed  | 0.00003 seconds |
+./spec/send_chain_spec.rb[1:4]                                    | passed  | 0.00003 seconds |
+./spec/send_chain_spec.rb[1:5]                                    | passed  | 0.00003 seconds |
+./spec/send_chain_spec.rb[1:6]                                    | passed  | 0.00003 seconds |
+./spec/send_chain_spec.rb[1:7]                                    | passed  | 0.00003 seconds |
+./spec/send_spec.rb[1:1]                                          | passed  | 0.00022 seconds |
+./spec/send_spec.rb[1:2]                                          | passed  | 0.00004 seconds |
+./spec/sorted_lru_files_spec.rb[1:1]                              | passed  | 0.00009 seconds |
+./spec/sorted_lru_files_spec.rb[1:2]                              | passed  | 0.00007 seconds |
 ./spec/sorted_lru_files_spec.rb[1:3]                              | passed  | 0.00003 seconds |
-./spec/sorted_lru_files_spec.rb[1:4]                              | passed  | 0.00068 seconds |
+./spec/sorted_lru_files_spec.rb[1:4]                              | passed  | 0.00005 seconds |
 ./spec/testable_spec.rb[1:1]                                      | passed  | 0.00003 seconds |
 ./spec/testable_spec.rb[2:1]                                      | passed  | 0.00003 seconds |

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_plugin_support
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.1.6
 platform: ruby
 authors:
 - Mike Slinn
@@ -79,20 +79,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: sorted_set
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +102,7 @@ files:
 - ".rubocop.yml"
 - ATTIBUTION_NOTES.md
 - CHANGELOG.md
+- FIXME.md
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -182,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.19
 specification_version: 4
 summary: Provides a framework for writing and testing Jekyll plugins
 test_files: