jekyll_from_to_until 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df28899e4d0c5ef83e25c224bf13ab963540f5329fdb901e57810fc8959f6c8e
-  data.tar.gz: 1e6159cef57b71549fb95a94052e46a535d5f9a9d05bc45aa8749102c7af9774
+  metadata.gz: 1a9e56c1266c423bdcca5f7fc1a5bfbd88038b3b7c92fbb84f0d05f73041f091
+  data.tar.gz: 6526b906d36f9937f63d0e81211dad42bec006eda5ec1cf62b286168925c489a
 SHA512:
-  metadata.gz: ff87af96660512fa9e48546598ff7a0130db3ff83e8ed4ab6945e5261ddbd88257904a343345ec999f076be98e444a51c6ce78cc0281454fe5eec69f2a40a184
-  data.tar.gz: 4f44c850b030ee09f151ffa98af5e2442f0285a396f004d38e637b7011c9572d894052e582c70e4bc5627295537665e7d1b6c4f336e61391cbda4642b683e332
+  metadata.gz: b8a0f1ec7d9032e98edc3bd6729a1037b9884fb7b1ef7614f8b9f53045f5d223cf4615588d3f62c9fa604daeef8e06dc03d371fe452b34df6152c2545d8e3cab
+  data.tar.gz: 7a3621381e1d6bc4258728b98520087d8954035cfceecc2932885f77f6f87879f2d8d163f7fd07552a68ec134ded6b0b6a7e206382e979bacf06e57315a889ca

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change Log
 
+## 1.0.5 / 2024-08-22
+
+* Fixed method forwarding
+* Regexes are now subjected to an HTML unescape, so special characters are now supported,
+  such as the right closing squiggly bracket:
+
+   ```html
+   {{ css | from: '.error' | to: '}' | strip }}
+   ```
+
+
 ## 1.0.4 / 2023-11-18
 
 * Now callable from any Ruby program

data/README.md

@@ -22,7 +22,7 @@ More information is available on the [`jekyll_from_to_until` gem web page](https
 ### As a Jekyll Filter Plugin
 
 If you want to use this Ruby gem in a Jekyll application,
-add the following line to your application's Gemfile:
+add the following line to your application's `Gemfile`:
 
 ```ruby
 group :jekyll_plugins do
@@ -100,7 +100,13 @@ All of these examples perform identically.
 {{ sourceOfLines | until: regex }}
 ```
 
-:warning: Important: the name of the filter must be followed by a colon (:). If you fail to do that an error will be generated and the Jekyll site building process will halt. The error message looks something like this: `Liquid Warning: Liquid syntax error (line 285): Expected end_of_string but found string in "{{ lines | from '2' | until: '4' | xml_escape }}" in /some_directory/some_files.html Liquid Exception: Liquid error (line 285): wrong number of arguments (given 1, expected 2) in /some_directory/some_file.html Error: Liquid error (line 285): wrong number of arguments (given 1, expected 2)`
+:warning: Important: the name of the filter must be followed by a colon (:).
+If you fail to do that an error will be generated and the Jekyll site building process will halt.
+The error message looks something like this:
+`Liquid Warning: Liquid syntax error (line 285): Expected end_of_string but found string in
+"{{ lines | from '2' | until: '4' | xml_escape }}" in /some_directory/some_files.html Liquid Exception:
+Liquid error (line 285): wrong number of arguments (given 1, expected 2) in /some_directory/some_file.
+html Error: Liquid error (line 285): wrong number of arguments (given 1, expected 2)`
 
 
 ## Jekyll Usage
@@ -167,7 +173,9 @@ mslinn_aws.tar
 
 ### From the third line of string
 
-These examples return the lines of the file from the beginning of the until a line with the string "3" is found, including the matched line. The only difference between the examples is the delimiter around the regular expression.
+These examples return the lines of the file from the beginning of the until a line with the string "3" is found,
+including the matched line.
+The only difference between the examples is the delimiter around the regular expression.
 
 ```html
 {{ lines | from: '3' }}
@@ -204,7 +212,9 @@ mslinn_aws.tar
 
 ### To the third line of string
 
-These examples return the lines of the file from the first line until a line with the string `"3"` is found, including the matched line. The only difference between the examples is the delimiter around the regular expression.
+These examples return the lines of the file from the first line until a line with the string `"3"` is found,
+including the matched line.
+The only difference between the examples is the delimiter around the regular expression.
 
 ```html
 {{ lines | to: '3' }}
@@ -245,7 +255,8 @@ target/
 
 ### Until the third line of string
 
-These examples return the lines of the file until a line with the string `"3"` is found, excluding the matched line. The only difference between the examples is the delimiter around the regular expression.
+These examples return the lines of the file until a line with the string `"3"` is found, excluding the matched line.
+The only difference between the examples is the delimiter around the regular expression.
 
 ```html
 {{ lines | until: '3' }}
@@ -284,7 +295,8 @@ target/
 
 ### From the string "2" until the string "4"
 
-These examples return the lines of the file until a line with the string `"3"` is found, excluding the matched line. The only difference between the examples is the delimiter around the regular expression.
+These examples return the lines of the file until a line with the string `"3"` is found, excluding the matched line.
+The only difference between the examples is the delimiter around the regular expression.
 
 ```html
 {{ lines | from: '2' | until: '4' }}
@@ -302,7 +314,8 @@ line 3
 
 ### From Line In a File Containing 'idea' Until no match
 
-The `.gitignore` file does not contain the string `xx`. If we attempt to match against that string the remainder of the file is returned for the to and until filter, and the empty string is returned for the from filter.
+The `.gitignore` file does not contain the string `xx`.
+If we attempt to match against that string the remainder of the file is returned for the to and until filter.
 
 ```html
 {{ gitignore | from: 'PID' | until: 'xx' }}
@@ -338,6 +351,18 @@ mslinn_aws.tar
 ```
 
 
+### Encoding Special Characters
+
+Special characters can be specified as HTML entities.
+For example, `}` is `Open parenthesis. Belle par. A parent. 5 Resulting. OK. }`.
+
+```html
+{{ css | from: '.error' | to: '}' | strip }}
+```
+
+`demo/special.html` demonstrates this.
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.
@@ -349,7 +374,7 @@ You can also run `bin/console` for an interactive prompt that will allow you to
 
 To build and install this gem onto your local machine, run:
 
-```shell
+```shellSoap. XboxXboxOur cub Our company outcome.XboxParent
 $ bundle exec rake install
 ```
 

data/jekyll_from_to_until.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.test_files = spec.files.grep(%r!^(test|spec|features)/!)
   spec.version = JekyllFromToUntilVersion::VERSION
 
+  spec.add_dependency 'htmlentities'
   spec.add_dependency 'jekyll', '>= 3.5.0'
   spec.add_dependency 'jekyll_plugin_logger'
 end

data/lib/jekyll_from_to_until/version.rb

@@ -1,3 +1,3 @@
 module JekyllFromToUntilVersion
-  VERSION = '1.0.4'.freeze
+  VERSION = '1.0.5'.freeze
 end

data/lib/jekyll_from_to_until.rb

@@ -1,5 +1,6 @@
 # Jekyll filters for working with multiline strings.
 
+require 'htmlentities'
 require_relative 'jekyll_from_to_until/version'
 
 module JekyllPluginFromToUntilName
@@ -8,95 +9,132 @@ end
 
 CALLED_FROM_JEKYLL = !$LOADED_FEATURES.grep(/.*liquid.rb/).empty?
 
-module FromToUntil
-  @logger = if CALLED_FROM_JEKYLL
-              require 'liquid'
-              require 'jekyll_plugin_logger'
-              PluginMetaLogger.instance.new_logger "FromToUntil", PluginMetaLogger.instance.config
-            else
-              require 'logger'
-              Logger.new $stdout
-            end
-
-  # Filters a multiline string, returning the portion beginning with the line that satisfies a regex.
-  # The regex could be enclosed in single quotes, double quotes, or nothing.
-  # @param input_strings [String] The multi-line string to scan
-  # @param regex [String] The regular expression to match against each line of `input_strings` until found
-  # @return [String] The remaining multi-line string
-  # @example Returns remaining lines starting with the line containing the word `module`.
-  #   {{ flexible_include '/blog/2020/10/03/jekyll-plugins.html' | from 'module' }}
-  def from(input_strings, regex)
-    return '' unless check_parameters(input_strings, regex)
-
-    regex = remove_quotations(regex.to_s.strip)
-    matched = false
-    result = ''
-    input_strings.each_line do |line|
-      matched = true if !matched && line =~ %r!#{regex}!
-      result += line if matched
+module Jekyll
+  module FromToUntil
+    @logger = if CALLED_FROM_JEKYLL
+                require 'liquid'
+                require 'jekyll_plugin_logger'
+                PluginMetaLogger.instance.new_logger "FromToUntil", PluginMetaLogger.instance.config
+              else
+                require 'logger'
+                Logger.new $stdout
+              end
+
+    # Filters a multiline string, returning the portion beginning with the line that satisfies a regex.
+    # The regex could be enclosed in single quotes, double quotes, or nothing.
+    # @param input_strings [String] The multi-line string to scan
+    # @param regex [String] The regular expression to match against each line of `input_strings` until found
+    # @return [String] The remaining multi-line string
+    # @example Returns remaining lines starting with the line containing the word `module`.
+    #   {{ flexible_include '/blog/2020/10/03/jekyll-plugins.html' | from 'module' }}
+    def from(input_strings, regex)
+      return '' unless check_parameters(input_strings, regex)
+
+      regex = remove_quotations(regex.to_s.strip)
+      matched = false
+      result = ''
+      input_strings.each_line do |line|
+        matched = true if !matched && line =~ %r!#{regex}!
+        result += line if matched
+      end
+      result
     end
-    result
-  end
 
-  # Filters a multiline string, returning the portion from the beginning until and including the line that satisfies a regex.
-  # The regex could be enclosed in single quotes, double quotes, or nothing.
-  # @example Returns lines up to and including the line containing the word `module`.
-  #   {{ flexible_include '/blog/2020/10/03/jekyll-plugins.html' | to 'module' }}
-  def to(input_strings, regex)
-    return '' unless check_parameters(input_strings, regex)
-
-    regex = remove_quotations(regex.to_s.strip)
-    result = ''
-    input_strings.each_line do |line|
-      result += line
-      return result if line.match?(%r!#{regex}!)
+    # Filters a multiline string, returning the portion from the beginning until and including the line that satisfies a regex.
+    # The regex could be enclosed in single quotes, double quotes, or nothing.
+    # @example Returns lines up to and including the line containing the word `module`.
+    #   {{ flexible_include '/blog/2020/10/03/jekyll-plugins.html' | to 'module' }}
+    def to(input_strings, regex)
+      return '' unless check_parameters(input_strings, regex)
+
+      regex = remove_quotations(regex.to_s.strip)
+      result = ''
+      input_strings.each_line do |line|
+        result += line
+        return result if line.match?(%r!#{regex}!)
+      end
+      result
+    end
+
+    # Filters a multiline string, returning the portion from the beginning until but not including the line that satisfies a regex.
+    # The regex could be enclosed in single quotes, double quotes, or nothing.
+    # @example Returns lines up to but not including the line containing the word `module`.
+    #   {{ flexible_include '/blog/2020/10/03/jekyll-plugins.html' | until 'module' }}
+    def until(input_strings, regex)
+      return '' unless check_parameters(input_strings, regex)
+
+      regex = remove_quotations(regex.to_s.strip)
+      result = ''
+      input_strings.each_line do |line|
+        return result if line.match?(%r!#{regex}!)
+
+        result += line
+      end
+      result
     end
-    result
-  end
 
-  # Filters a multiline string, returning the portion from the beginning until but not including the line that satisfies a regex.
-  # The regex could be enclosed in single quotes, double quotes, or nothing.
-  # @example Returns lines up to but not including the line containing the word `module`.
-  #   {{ flexible_include '/blog/2020/10/03/jekyll-plugins.html' | until 'module' }}
-  def until(input_strings, regex)
-    return '' unless check_parameters(input_strings, regex)
+    private if CALLED_FROM_JEKYLL
 
-    regex = remove_quotations(regex.to_s.strip)
-    result = ''
-    input_strings.each_line do |line|
-      return result if line.match?(%r!#{regex}!)
+    def check_parameters(input_strings, regex)
+      if input_strings.nil? || input_strings.empty?
+        @logger.warn { "Warning: Plugin 'from' received no input for regex #{regex}." }
+        return false
+      end
 
-      result += line
+      regex = regex.to_s
+      if regex.nil? || regex.empty?
+        @logger.warn { "Warning: Plugin 'from' received no regex for input #{input_strings}." }
+        return false
+      end
+      true
     end
-    result
+
+    def remove_quotations(str)
+      str = str.slice(1..-2) if (str.start_with?('"') && str.end_with?('"')) ||
+                                (str.start_with?("'") && str.end_with?("'"))
+      str
+    end
+
+    module_function :from, :to, :until, :check_parameters, :remove_quotations
   end
 
-  private if CALLED_FROM_JEKYLL
+  # See https://www.mslinn.com/jekyll/10400-jekyll-plugin-template-collection.html#module_function
+  module FromToUntilFilter
+    def from(input_strings, regex)
+      input_strings = extra_decode HTMLEntities.new.decode input_strings
+      regex         = extra_decode HTMLEntities.new.decode regex
+      FromToUntil.from(input_strings, regex) # method forwarding
+    end
 
-  def check_parameters(input_strings, regex)
-    if input_strings.nil? || input_strings.empty?
-      @logger.warn { "Warning: Plugin 'from' received no input for regex #{regex}." }
-      return false
+    def to(input_strings, regex)
+      input_strings = extra_decode HTMLEntities.new.decode input_strings
+      regex         = extra_decode HTMLEntities.new.decode regex
+      FromToUntil.to(input_strings, regex) # method forwarding
     end
 
-    regex = regex.to_s
-    if regex.nil? || regex.empty?
-      @logger.warn { "Warning: Plugin 'from' received no regex for input #{input_strings}." }
-      return false
+    def until(input_strings, regex)
+      input_strings = extra_decode HTMLEntities.new.decode input_strings
+      regex         = extra_decode HTMLEntities.new.decode regex
+      FromToUntil.until(input_strings, regex) # method forwarding
     end
-    true
-  end
 
-  def remove_quotations(str)
-    str = str.slice(1..-2) if (str.start_with?('"') && str.end_with?('"')) ||
-                              (str.start_with?("'") && str.end_with?("'"))
-    str
+    # HTMLEntities does not support enough HTML entities
+    def extra_decode(line)
+      line.gsub('{', '{')
+          .gsub('}', '}')
+          .gsub('(', '(')
+          .gsub(')', ')')
+          .gsub('&lparen;', '(')
+          .gsub('&rparen;', ')')
+          .gsub('[', '[')
+          .gsub(']', ']')
+          .gsub('[', '[')
+          .gsub(']', ']')
+    end
   end
 
-  module_function :from, :to, :until, :check_parameters, :remove_quotations
-end
-
-if CALLED_FROM_JEKYLL
-  PluginMetaLogger.instance.info { "Loaded #{JekyllPluginFromToUntilName::PLUGIN_NAME} v#{JekyllFromToUntilVersion::VERSION} plugin." }
-  Liquid::Template.register_filter(FromToUntil)
+  if CALLED_FROM_JEKYLL
+    PluginMetaLogger.instance.info { "Loaded #{JekyllPluginFromToUntilName::PLUGIN_NAME} v#{JekyllFromToUntilVersion::VERSION} plugin." }
+    Liquid::Template.register_filter(FromToUntilFilter)
+  end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_from_to_until
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-22 00:00:00.000000000 Z
+date: 2024-08-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: htmlentities
+  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: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -69,7 +83,7 @@ metadata:
   source_code_uri: https://github.com/mslinn/jekyll_from_to_until
 post_install_message: |2+
 
-  Thanks for installing jekyll_from_to_until v1.0.4!
+  Thanks for installing jekyll_from_to_until v1.0.5!
 
 rdoc_options: []
 require_paths:
@@ -85,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: 'This Jekyll plugin provides 3 filters that return portions of a multiline