jekyll_pre 1.1.1 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b79b7abf9ee4c8a48c3886fbc286e7f15c3525cd6e4df1aa48afaa57b2912d70
-  data.tar.gz: 20e448f4ecc75578c46728c821bc09529e587758cfcc0b40783ee6fd487ee095
+  metadata.gz: be2fcd1765446ab64973e355acb073057dea3c98ed1be553362b5b755e5453fb
+  data.tar.gz: 33b14de234b5764673af3c9380d6ae32fa5a429294f7ee5f53d094aa63bf1f87
 SHA512:
-  metadata.gz: 29643f46fdfed357b6ec9fcecc7344a5da043ddebc7fcd1f9f4d09d6d249b5f43c81f8d83e6b627879c2bbb1f67f40e7fe246f6451b8b7df672c4f3d30551df0
-  data.tar.gz: 2baae24a428b940bff90b8871a84b6c0c13af534af066755ff0308e22534c74d75435f056e873d9fd135e7902b645ba5df49c4b4b8e3f82b0afcbc8e9031b036
+  metadata.gz: 46fcc4e0dcab10f27bfc9f8fa408e84e5d5c3c19f926d1de51167b39754740a2a4a3af2a17ca4c4f8dc2bf25011283205137c7afa9d144abb67ee6c2479276a5
+  data.tar.gz: c39c5e30e3386d1eeb3029d7cf31ab159fcb8b32fb3b72fa5f03d5af8269daa30b7cf308e0bdbf1905180a468f88b2e7b00ab1e440daf75ba5ee96987bc1a727

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 1.1.4
+  * Added `highlight` regex option
+  * Now using `lib/jekyll_tag_helper.rb` to parse markup
+
+## 1.1.3
+  * Documented the `data-lt-active="false"` attribute.
+  * Added the `dark` option, and [provided CSS](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#pre_css).
+
+## 1.1.2 / 2022-04-05
+  * Updated to `jekyll_plugin_logger` v2.1.0
+
 ## 1.1.1 / 2022-03-31
   * Added `numbered_line` CSS class for unselectable line numbers
 

data/README.md

@@ -10,6 +10,7 @@ This Jekyll plugin provides 2 new Liquid tags that work together:
     Contents of pre tag
     {% endpre %}
     ```
+    The generated <pre></pre> tag has an `data-lt-active="false"` attribute, so [LanguageTool](https://forum.languagetool.org/t/avoid-spell-check-on-certain-html-inputs-manually/3944) does not check the spelling or grammar of the contents.
   * A `noselect` tag that can renders HTML content passed to it unselectable.
     ```
     {% pre [copyButton] %}
@@ -39,7 +40,7 @@ Below are the CSS declarations that I defined pertaining to the pre and noselect
 ```
 
 ## Additional Information
-More information is available on my web site about [my Jekyll plugins](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).
+More information is available on [my web site](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#jekyll_pre).
 
 
 ## Installation

data/lib/jekyll_pre/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllPreVersion
-  VERSION = "1.1.1"
+  VERSION = "1.1.4"
 end

data/lib/jekyll_pre.rb

@@ -2,7 +2,10 @@
 
 require "liquid"
 require "jekyll_plugin_logger"
+require 'key_value_parser'
+require "shellwords"
 require_relative "jekyll_pre/version"
+require_relative "jekyll_tag_helper"
 
 module JekyllPluginPreName
   PLUGIN_NAME = "jekyll_pre"
@@ -33,22 +36,28 @@ class PreTagBlock < Liquid::Block
   @@suffix = " title='Copy to clipboard'><img src='/assets/images/clippy.svg' " \
              "alt='Copy to clipboard' style='width: 13px'></button>"
 
+  def self.highlight(content, pattern)
+    content.gsub(Regexp::new(pattern), "<span class='bg_yellow'>\\0</span>")
+  end
+
   def self.make_copy_button(pre_id)
     "#{@@prefix}'##{pre_id}'#{@@suffix}"
   end
 
-  def self.make_pre(make_copy_button, number_lines, label, content)
+  def self.make_pre(make_copy_button, number_lines, label, dark, highlight_pattern, content) # rubocop:disable Metrics/ParameterLists
+    dark_label = " darkLabel" if dark
     label = if label.to_s.empty?
               ""
             elsif label.to_s.downcase.strip == "shell"
-              "<div class='codeLabel unselectable' data-lt-active='false'>Shell</div>"
+              "<div class='codeLabel unselectable#{dark_label}' data-lt-active='false'>Shell</div>"
             else
-              "<div class='codeLabel unselectable' data-lt-active='false'>#{label}</div>"
+              "<div class='codeLabel unselectable#{dark_label}' data-lt-active='false'>#{label}</div>"
             end
     pre_id = "id#{SecureRandom.hex(6)}"
     copy_button = make_copy_button ? PreTagBlock.make_copy_button(pre_id) : ""
+    content = PreTagBlock.highlight(content, highlight_pattern) if highlight_pattern
     content = PreTagBlock.number_content(content) if number_lines
-    "#{label}<pre data-lt-active='false' class='maxOneScreenHigh copyContainer' id='#{pre_id}'>#{copy_button}#{content.strip}</pre>"
+    "#{label}<pre data-lt-active='false' class='maxOneScreenHigh copyContainer#{dark}' id='#{pre_id}'>#{copy_button}#{content.strip}</pre>"
   end
 
   def self.number_content(content)
@@ -66,33 +75,40 @@ class PreTagBlock < Liquid::Block
   end
 
   # @param _tag_name [String] is the name of the tag, which we already know.
-  # @param argument_string [String] the arguments from the web page.
+  # @param markup [String] the arguments from the web page.
   # @param _tokens [Liquid::ParseContext] tokenized command line
+  #        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, argument_string, _tokens)
+  def initialize(_tag_name, markup, _tokens)
     super
-    argument_string = "" if argument_string.nil?
-    argument_string.strip!
-
-    @logger = PluginMetaLogger.instance.new_logger(self)
-
-    @make_copy_button = argument_string.include? "copyButton"
-    remaining_text = argument_string.sub("copyButton", "").strip
+    markup = "" if markup.nil?
+    markup.strip!
 
-    @number_lines = remaining_text.include? "number"
-    remaining_text = remaining_text.sub("number", "").strip
-
-    @label = remaining_text
-
-    @logger.debug { "@make_copy_button = '#{@make_copy_button}'; argument_string = '#{argument_string}'; remaining_text = '#{remaining_text}'" }
+    @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+    @helper = JekyllTagHelper.new(tag_name, markup, @logger)
   end
 
   # Method prescribed by the Jekyll plugin lifecycle.
+  # @param liquid_context [Liquid::Context]
   # @return [String]
-  def render(context)
+  def render(liquid_context)
     content = super
+    @helper.liquid_context = liquid_context
+
+    @highlight =  @helper.parameter_specified? "highlight"
+    @make_copy_button = @helper.parameter_specified? "copyButton"
+    @number_lines = @helper.parameter_specified? "number"
+    @dark = " dark" if @helper.parameter_specified? "dark"
+    @label = @helper.parameter_specified? "label"
+
+    # If a label was specified, use it, otherwise concatenate any dangling parameters and use that as the label
+    @label ||= @helper.params.join(" ")
+
     @logger.debug { "@make_copy_button = '#{@make_copy_button}'; @label = '#{@label}'" }
-    PreTagBlock.make_pre(@make_copy_button, @number_lines, @label, content)
+    PreTagBlock.make_pre(@make_copy_button, @number_lines, @label, @dark, @highlight, content)
   end
 end
 
@@ -100,20 +116,20 @@ end
 # Also, space before the closing percent is signficant %}"""
 class UnselectableTag < Liquid::Tag
   # @param _tag_name [String] is the name of the tag, which we already know.
-  # @param argument_string [String] the arguments from the web page.
+  # @param markup [String] the arguments from the web page.
   # @param _tokens [Liquid::ParseContext] tokenized command line
   # @return [void]
-  def initialize(_tag_name, argument_string, _tokens)
+  def initialize(_tag_name, markup, _tokens)
     super
     @logger = PluginMetaLogger.instance.new_logger(self)
 
-    @argument_string = argument_string
-    @argument_string = "$ " if @argument_string.nil? || @argument_string.empty?
-    @logger.debug { "UnselectableTag: argument_string= '#{@argument_string}'" }
+    @markup = markup
+    @markup = "$ " if @markup.nil? || @markup.empty?
+    @logger.debug { "UnselectableTag: markup= '#{@markup}'" }
   end
 
   def render(_)
-    "<span class='unselectable'>#{@argument_string}</span>"
+    "<span class='unselectable'>#{@markup}</span>"
   end
 end
 

data/lib/jekyll_tag_helper.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "shellwords"
+require 'key_value_parser'
+
+class JekyllTagHelper
+  attr_reader :argv, :liquid_context, :logger, :params, :tag_name
+
+  def self.escape_html(string)
+    string.gsub("&", "&")
+          .gsub("{", "{")
+          .gsub("}", "}")
+          .gsub("<", "&lt;")
+  end
+
+  # Expand a environment variable reference
+  def self.expand_env(str, die_if_undefined=false)
+    str.gsub(/\$([a-zA-Z_][a-zA-Z0-9_]*)|\${\g<1>}|%\g<1>%/) do
+      envar = Regexp.last_match(1)
+      raise FlexibleError, "flexible_include error: #{envar} is undefined".red, [] if !ENV.key?(envar) && die_if_undefined # Suppress stack trace
+      ENV[envar]
+    end
+  end
+
+  # strip leading and trailing quotes if present
+  def self.remove_quotes(string)
+    string.strip.gsub(/\A'|\A"|'\Z|"\Z/, '').strip if string
+  end
+
+  def initialize(tag_name, markup, logger)
+    @tag_name = tag_name
+    @argv = Shellwords.split(markup)
+    @keys_values = KeyValueParser.new.parse(@argv) # Hash[Symbol, String|Boolean]
+    @logger = logger
+    @logger.debug { "@keys_values='#{@keys_values}'" }
+  end
+
+  def delete_parameter(name)
+    @params.delete(name)
+    @argv.delete_if { |x| x.start_with? name }
+    @keys_values.delete(name.to_sym)
+  end
+
+  # @return if parameter was specified, returns value and removes it from the available tokens
+  def parameter_specified?(name)
+    value = @keys_values[name.to_sym]
+    delete_parameter(name)
+    value
+  end
+
+  PREDEFINED_SCOPE_KEYS = [:include, :page].freeze
+
+  # Finds variables defined in an invoking include, or maybe somewhere else
+  # @return variable value or nil
+  def dereference_include_variable(name)
+    @liquid_context.scopes.each do |scope|
+      next if PREDEFINED_SCOPE_KEYS.include? scope.keys.first
+
+      value = scope[name]
+      return value if value
+    end
+    nil
+  end
+
+  # @return value of variable, or the empty string
+  def dereference_variable(name)
+    value = @liquid_context[name] # Finds variables named like 'include.my_variable', found in @liquid_context.scopes.first
+    value ||= @page[name] if @page # Finds variables named like 'page.my_variable'
+    value ||= dereference_include_variable(name)
+    value ||= ""
+    value
+  end
+
+  # 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) }
+  end
+
+  def lookup_variable(symbol)
+    string = symbol.to_s
+    return string unless string.start_with?("{{") && string.end_with?("}}")
+
+    dereference_variable(string.delete_prefix("{{").delete_suffix("}}"))
+  end
+
+  def page
+    @liquid_context.registers[:page]
+  end
+end

data/spec/pre_spec.rb

@@ -45,4 +45,21 @@ RSpec.describe(PreTagBlock) do
     END_CONTENT
     expect(numbered_content).to eq(expected_content)
   end
+
+  it "highlights regex patterns" do
+    content = <<~END_CONTENT
+      Line 1
+        Line 2
+          Line 3
+          Line 4
+        Line 5
+      Line 6
+      Line 7
+        Line 8
+        Line 9
+      Line 10
+    END_CONTENT
+    highlighted = PreTagBlock.highlight(content, ".*2").split("\n")[1]
+    expect(highlighted).to eq("<span class='bg_yellow'>  Line 2</span>")
+  end
 end

data/spec/status_persistence.txt

@@ -1,4 +1,5 @@
 example_id              | status | run_time        |
 ----------------------- | ------ | --------------- |
-./spec/pre_spec.rb[1:1] | passed | 0.00366 seconds |
-./spec/pre_spec.rb[1:2] | passed | 0.00288 seconds |
+./spec/pre_spec.rb[1:1] | passed | 0.00187 seconds |
+./spec/pre_spec.rb[1:2] | passed | 0.00285 seconds |
+./spec/pre_spec.rb[1:3] | passed | 0.00056 seconds |

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_pre
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.4
 platform: ruby
 authors:
 - Mike Slinn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-31 00:00:00.000000000 Z
+date: 2022-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -112,6 +112,7 @@ files:
 - jekyll_pre.gemspec
 - lib/jekyll_pre.rb
 - lib/jekyll_pre/version.rb
+- lib/jekyll_tag_helper.rb
 - spec/pre_spec.rb
 - spec/spec_helper.rb
 - spec/status_persistence.txt