jekyll_plugin_support 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad3dd2c6f00993d77f9db69e844a1f70e52c21ac1ef66c47294cc7683dee5743
-  data.tar.gz: 121436f415bbcb0cddffa4f9b9c26f735e899aa733df38749e5be2856d56d238
+  metadata.gz: d0856ddeea29e8a1e24f0a4997aecb7f6b6b22eae587ca8466142686b65557b7
+  data.tar.gz: ac8a8a047666f89b055b6ab90d6535b59e7f34441405852f5905ed6a517cbc27
 SHA512:
-  metadata.gz: b6d186e5d5347b7857cef3318a152a4a9db75e57ebe7dc244dd0574542b47b2c97c4ba55af03065099cca94c3ca3fb3e666268fb4e2427683b94a0c058388a7b
-  data.tar.gz: 1529488c906cc7c687356f22b65223f347d75eb35f1747742466166921b266c4f172233eaf638bb06af7fdf6fcd93e67d0f6ca25cbde0f98139edb05fb07d64a
+  metadata.gz: 8122412d70d1c99a6195834a51faa25f0d7beb59a23c18db0beba2883c83f5625920a63495b7ff21abf891faf97ae2ffe085c764c2be9d178bfeb37a7ae4e2f5
+  data.tar.gz: abd34bf8420c7040e7015ce131a8ae3ea01158a552637a4e8d63c51095c138bdf87fd11bff1c3fb3f35fbd3e8b728a09934c4aefe0bbe29817703bdb032a8114

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.5.1 / 2023-02-17
+  * `no_arg_parsing` optimization added.
+
 ## 0.5.0 / 2023-02-15
   * Plugins now register themselves
   * Plugins now report their name and version

data/README.md

@@ -19,7 +19,7 @@ And then execute:
 
     $ bundle install
 
-## Usage
+## General Usage
 `JekyllSupport::JekyllBlock` and `JekyllSupport::JekyllTag`
 provide support for Jekyll tag blocks and Jekyll tags, respectively.
 They are very similar in construction and usage.
@@ -47,8 +47,10 @@ For block tags, a single parameter is required, which contains any text enclosed
 Your implementation of `render_impl` can access `@page` and `@site`,
 and can parse parameters passed to the tag / block tag, [as described here](https://mslinn.com/jekyll/10100-jekyll-plugin-background.html#params):
 
+### For a tag:
 ```ruby
-# For a tag:
+require 'jekyll_plugin_support'
+
 module Jekyll
   class MyTag < JekyllSupport::JekyllTag
     VERSION = '0.1.0'.freeze
@@ -56,12 +58,16 @@ module Jekyll
     def render_impl
       # Your code here
     end
+
+    JekyllPluginHelper.register(self, 'demo_tag')
   end
 end
 ```
 
+### For a tag block:
 ```ruby
-# For a tag block:
+require 'jekyll_plugin_support'
+
 module Jekyll
   class MyBlock < JekyllSupport::JekyllBlock
     VERSION = '0.1.0'.freeze
@@ -69,6 +75,8 @@ module Jekyll
     def render_impl(text)
       # Your code here
     end
+
+    JekyllPluginHelper.register(self, 'demo_block')
   end
 end
 ```
@@ -79,12 +87,15 @@ For example, if `lib/my_plugin/version.rb` looks like this:
 
 ```ruby
 module MyPluginVersion
-  VERSION = '0.5.0'.freeze
+  VERSION = '0.5.1'.freeze
 end
 ```
 
 Then your plugin can incorporate the `VERSION` constant into your plugin like this:
 ```ruby
+require 'jekyll_plugin_support'
+require_relative 'my_block/version'
+
 module Jekyll
   class MyBlock < JekyllSupport::JekyllBlock
     include MyPluginVersion
@@ -92,10 +103,18 @@ module Jekyll
     def render_impl(text)
       # Your code here
     end
+
+    JekyllPluginHelper.register(self, 'demo_tag')
   end
 end
 ```
 
+### `no_arg_parsing` Optimization
+If your tag or block plugin only needs access to the raw arguments passed from the web page,
+without tokenization, and you expect that the plugin might be invoked with large amounts of text,
+derive your plugin from `JekyllBlockNoArgParsing` or `JekyllTagNoArgParsing`.
+
+
 ## Additional Information
 More information is available on
 [Mike Slinn&rsquo;s website](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).

data/lib/jekyll_plugin_support/version.rb

@@ -1,3 +1,3 @@
 module JekyllPluginSupportVersion
-  VERSION = '0.5.0'.freeze
+  VERSION = '0.5.1'.freeze
 end

data/lib/jekyll_plugin_support.rb

@@ -5,6 +5,12 @@ require_relative 'jekyll_plugin_support/version'
 
 # @author Copyright 2022 Michael Slinn
 # @license SPDX-License-Identifier: Apache-2.0``
+module NoArgParsing
+  attr_accessor :no_arg_parsing
+
+  @no_arg_parsing = true
+end
+
 module JekyllSupport
   # Base class for Jekyll block tags
   class JekyllBlock < Liquid::Block
@@ -22,9 +28,10 @@ module JekyllSupport
     def initialize(tag_name, argument_string, parse_context)
       super
       @tag_name = tag_name
-      @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
-      @helper = JekyllPluginHelper.new(tag_name, argument_string, @logger)
       @argument_string = argument_string
+      @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+      @logger.debug { "#{self.class}: respond_to?(:no_arg_parsing) #{respond_to?(:no_arg_parsing) ? 'yes' : 'no'}." }
+      @helper = JekyllPluginHelper.new(tag_name, argument_string, @logger, respond_to?(:no_arg_parsing))
     end
 
     # Method prescribed by the Jekyll plugin lifecycle.
@@ -33,8 +40,7 @@ module JekyllSupport
       text = super
       @helper.liquid_context = liquid_context
 
-      # The names of front matter variables are hash keys for @page
-      @page = liquid_context.registers[:page] # Jekyll::Drops::DocumentDrop
+      @page = liquid_context.registers[:page] # Type Jekyll::Drops::DocumentDrop
       @site = liquid_context.registers[:site]
       @config = @site.config
       @envs = liquid_context.environments.first
@@ -51,6 +57,17 @@ module JekyllSupport
     end
   end
 
+  class JekyllBlockNoArgParsing < JekyllBlock
+    def initialize(tag_name, argument_string, parse_context)
+      class << self
+        include NoArgParsing
+      end
+
+      super
+      @logger.debug { "#{self.class}: respond_to?(:o_arg_parsing) #{respond_to?(:no_arg_parsing) ? 'yes' : 'no'}." }
+    end
+  end
+
   # Base class for Jekyll tags
   class JekyllTag < Liquid::Tag
     attr_reader :argument_string, :helper, :line_number, :logger, :page, :site
@@ -67,9 +84,10 @@ module JekyllSupport
     def initialize(tag_name, argument_string, parse_context)
       super
       @tag_name = tag_name
-      @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
-      @helper = JekyllPluginHelper.new(tag_name, argument_string, @logger)
       @argument_string = argument_string
+      @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+      @logger.debug { "#{self.class}: respond_to?(:no_arg_parsing) #{respond_to?(:no_arg_parsing) ? 'yes' : 'no'}." }
+      @helper = JekyllPluginHelper.new(tag_name, argument_string, @logger, respond_to?(:no_arg_parsing))
     end
 
     # Method prescribed by the Jekyll plugin lifecycle.
@@ -94,7 +112,18 @@ module JekyllSupport
     # Jekyll plugins must override this method, not render, so their plugin can be tested more easily
     # @page and @site are available
     def render_impl
-      abort "JekyllTag render_impl for tag #{@tag_name} must be overridden, but it was not."
+      abort "#{self.class}.render_impl for tag #{@tag_name} must be overridden, but it was not."
+    end
+  end
+
+  class JekyllTagNoArgParsing < JekyllTag
+    def initialize(tag_name, argument_string, parse_context)
+      class << self
+        include NoArgParsing
+      end
+
+      super
+      @logger.debug { "#{self.class}: respond_to?(:no_arg_parsing) #{respond_to?(:no_arg_parsing) ? 'yes' : 'no'}." }
     end
   end
 end

data/lib/jekyll_plugin_support_helper.rb

@@ -3,7 +3,7 @@ require 'key_value_parser'
 
 # Base class for all types of Jekyll plugin helpers
 class JekyllPluginHelper
-  attr_reader :argv, :keys_values, :liquid_context, :logger, :markup, :params, :tag_name
+  attr_reader :argv, :keys_values, :liquid_context, :logger, :markup, :no_arg_parsing, :params, :tag_name
 
   # Expand an environment variable reference
   def self.expand_env(str, die_if_undefined: false)
@@ -45,20 +45,37 @@ class JekyllPluginHelper
   #        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)
+  def initialize(tag_name, markup, logger, no_arg_parsing)
     @tag_name = tag_name
     @logger = logger
+    @no_arg_parsing = no_arg_parsing
     reinitialize(markup.strip)
     @logger.debug { "@keys_values='#{@keys_values}'" }
   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 reinitialize(markup)
     # @keys_values was a Hash[Symbol, String|Boolean] but now it is Hash[String, String|Boolean]
     @markup = markup
-    @argv = Shellwords.split(self.class.expand_env(markup))
-    @keys_values = KeyValueParser \
-      .new({}, { array_values: false, normalize_keys: false, separator: /=/ }) \
-      .parse(@argv)
+    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) }
+    else
+      @argv = Shellwords.split(self.class.expand_env(markup))
+      @keys_values = KeyValueParser \
+        .new({}, { array_values: false, normalize_keys: false, separator: /=/ }) \
+        .parse(@argv)
+    end
   end
 
   def delete_parameter(key)
@@ -106,7 +123,7 @@ class JekyllPluginHelper
   # Sets @params by replacing any Liquid variable names with their values
   def liquid_context=(context)
     @liquid_context = context
-    @params = @keys_values.map { |k, _v| lookup_variable(k) }
+    @params = @keys_values.map { |k, _v| lookup_variable(k) } unless respond_to?(:no_arg_parsing) && no_arg_parsing
   end
 
   def lookup_variable(symbol)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_plugin_support
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-16 00:00:00.000000000 Z
+date: 2023-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll