jekyll_plugin_support 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75b8116adff0e7869b3d9d05def0b7cb702b67860e596e3b9901dce1f43182e7
-  data.tar.gz: 86da2a9936cbeffb9f381d3d2031f58acee7f79d8efd7a37b2f4864c3201b20e
+  metadata.gz: 16fe00b243305d30e8dff85f604336e9c9802afe837a762dd295bd7283d8e1d4
+  data.tar.gz: c4ae30a570d27d77d17d7710be941731aefeaf11e4c2e19ec9f8fb773a9ad01d
 SHA512:
-  metadata.gz: f944740ed80b93a8d5fa6e0e4d3a4b0fe04761aa546d2dfea10b3929d7650daf87afdcd295b3698d80ded0f50209fe04a9c918914f216cfcabc335314da7454a
-  data.tar.gz: c5d1f11b7fb11900a94ba1430faca977794d84fd4073e793cc50128e922c401adaee2ea5ecdc2eef16b3ed1450e0ac98e5eeff1b8dc96fcc9fda1610b04dc2f8
+  metadata.gz: f0abe907f3c564efdf0192279e1d7b2553f3fe97ecb9cbac989defe6a9051979c295db7b0e5917a9c954bc1faab1b42b3fb88b1ac6ef4d20cf3b49217b859fae
+  data.tar.gz: fe6027eaccdc0e46de5d98bc954e17600d088e988fbe3798cb2ad842cdcf8b5d417cd2fdd6bdb0d27f517831d81dd8956444235c23767db222634c579d2d60e6

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.5.3 / 2023-03-19
+  * Added properties `argv_original`, `keys_values_original`, `remaining_markup_original`,
+    and `params_original`, which are the original values of `argv`, `keys_values`,
+    `remaining_markup`, and `params`, before environment variable expansion.
+
 ## 0.5.2 / 2023-03-17
   * Added `@helper.remaining_markup` public method, which returns remaining markup passed to your tag, after keyword and name/value parsing is complete.
   * Finally wrote proper `rspec` tests.

data/lib/jekyll_plugin_support/version.rb

@@ -1,3 +1,3 @@
 module JekyllPluginSupportVersion
-  VERSION = '0.5.2'.freeze
+  VERSION = '0.5.3'.freeze
 end

data/lib/jekyll_plugin_support_helper.rb

@@ -2,8 +2,10 @@ require 'shellwords'
 require 'key_value_parser'
 
 # Base class for all types of Jekyll plugin helpers
-class JekyllPluginHelper
-  attr_reader :argv, :keys_values, :liquid_context, :logger, :markup, :no_arg_parsing, :params, :tag_name
+class JekyllPluginHelper # rubocop:disable Metrics/ClassLength
+  attr_accessor :liquid_context
+  attr_reader :argv, :keys_values, :logger, :markup, :no_arg_parsing, :params, :tag_name,
+              :argv_original, :keys_values_original, :params_original
 
   # Expand an environment variable reference
   def self.expand_env(str, die_if_undefined: false)
@@ -53,12 +55,15 @@ class JekyllPluginHelper
     @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
+  # @return if parameter was specified, removes it from the available tokens and returns value
+  def parameter_specified?(name)
+    return false if @keys_values.empty?
 
-  def warn_parse(meth)
-    abort "Error: Argument parsing was suppressed, but an attempt to invoke #{meth} was made"
+    key = name
+    key = name.to_sym if @keys_values.first.first.instance_of?(Symbol)
+    value = @keys_values[key]
+    delete_parameter(name)
+    value
   end
 
   def reinitialize(markup)
@@ -71,11 +76,7 @@ class JekyllPluginHelper
       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)
-      @params = @keys_values.map { |k, _v| lookup_variable(k) } unless respond_to?(:no_arg_parsing) && no_arg_parsing
+      parse markup
     end
   end
 
@@ -84,23 +85,30 @@ class JekyllPluginHelper
     @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
+
+  private
+
   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)
-  end
-
-  # @return if parameter was specified, removes it from the available tokens and returns value
-  def parameter_specified?(name)
-    return false if @keys_values.empty?
 
-    key = name
-    key = name.to_sym if @keys_values.first.first.instance_of?(Symbol)
-    value = @keys_values[key]
-    delete_parameter(name)
-    value
+    @params_original.delete(key)
+    @argv_original.delete_if { |x| x == key or x.start_with?("#{key}=") }
+    @keys_values_original.delete(key)
   end
 
   PREDEFINED_SCOPE_KEYS = %i[include page].freeze
@@ -126,11 +134,6 @@ class JekyllPluginHelper
     value
   end
 
-  # Sets @params by replacing any Liquid variable names with their values
-  def liquid_context=(context)
-    @liquid_context = context
-  end
-
   def lookup_variable(symbol)
     string = symbol.to_s
     return string unless string.start_with?('{{') && string.end_with?('}}')
@@ -141,4 +144,18 @@ class JekyllPluginHelper
   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.map { |k, _v| lookup_variable(k) } unless respond_to?(:no_arg_parsing) && no_arg_parsing
+
+    @argv = Shellwords.split(self.class.expand_env(markup))
+    @keys_values = KeyValueParser \
+      .new({}, { array_values: false, normalize_keys: false, separator: /=/ }) \
+      .parse(@argv)
+    @params = @keys_values.map { |k, _v| lookup_variable(k) } unless respond_to?(:no_arg_parsing) && no_arg_parsing
+  end
 end

metadata

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