jekyll_pre 1.2.1 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c319e1e24db16309a2df595cd44df695cd239eba0c477af076a12fc25033e292
-  data.tar.gz: edddecc3b1265d3741d4c7a5eac9cf6980f305541fa003f14f67d7a0165c3766
+  metadata.gz: 2e01bd13d91a64bf9b1dc9802cd11ef6c759985a30532daf8b3ace4618bfe634
+  data.tar.gz: 6d33733cf1f1d0267ba226dafd459807254fa10f5199f2b1358648f9f94ccc01
 SHA512:
-  metadata.gz: 6cef3e92951e7d2f53107a8ade5dd04d52b8bc505fd4112bb0689a8bf7a245b6088c3e56238a211a73362c1ff6cf978ff3646ed289b667533e2495838f7127e4
-  data.tar.gz: c5b8067ee37fe465aa697acc30bdb8e6d54b85c020da4fa80d788f978a72d729745c9b3556caa563edbb358d770b95e0e07e6bf0addf23aad0818c0cf2e4b00d
+  metadata.gz: 8e1f5e2a5cb3beb928cc2d8ad09fd1274aff0c5085ac1ee1f014456aaefaa78d5711c2bd9046e9418737b7bff7b53b2e4f54856e5dbbb8fcd1d4f193757db0fc
+  data.tar.gz: 22747b92ec65bb6568a648c98a2a24417fd970daa012632ec596deca2232b0e994dffa7017792083d797c1ee6b2bc86b01b4b496d84525786ddcfd06769ade64

data/.rubocop.yml

@@ -1,6 +1,9 @@
 require:
- - rubocop-rspec
- - rubocop-rake
+  # - rubocop-jekyll
+  - rubocop-md
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
 
 AllCops:
   Exclude:

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.2.3
+  * Added `cd` option to `exec` tag.
+
+## 1.2.2
+  * Added `exec` tag.
+  * Demarked CSS for the `exec`, `noselect`, and `pre` tags in `demo/assets/css/style.css`
+    within `/* Start of pre tag css */` and `/* End of pre tag css */`.
+
 ## 1.2.1
   * Updated to `jekyll_plugin_support` v0.5.1 so the `noselect` tag is more efficient.
 

data/README.md

@@ -2,11 +2,11 @@ Jekyll_pre
 [![Gem Version](https://badge.fury.io/rb/jekyll_pre.svg)](https://badge.fury.io/rb/jekyll_pre)
 ===========
 
-This Jekyll plugin provides 2 new Liquid tags that work together:
+This Jekyll plugin provides 3 new Liquid tags that work together:
 
-  * A `pre` block tag that can optionally display a copy button.
+  * A `pre` block tag that can be displayed various ways.
     ```
-    {% pre [Options] [headline words] %}
+    {% pre [Options] [free text label] %}
     Contents of pre tag
     {% endpre %}
     ```
@@ -24,37 +24,41 @@ This Jekyll plugin provides 2 new Liquid tags that work together:
         - {% pre This is a label %}<br>Contents of pre tag<br>{% endpre %}
      - `number` &ndash; Number the lines
      - `shell` &ndash; Equivalent to `label='Shell'`
-     - `style` &ndash; Apply CSS styles
+     - `style` &ndash; Apply inline CSS styles
 
     The generated &lt;pre>&lt;/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,
     and generates a <code>$</code> prompt if no content is provided.
     ```
     {% pre %}
-    {% noselect [optional text string, defaults to $]%}Contents of pre tag
+    {% noselect [optional text string, defaults to $]%}Command
+    {% noselect unselectable output goes here %}
     {% endpre %}
     ```
 
-## CSS
-Below are the CSS declarations that I defined pertaining to the pre and noselect tags that produced the above images:
-```css
-.maxOneScreenHigh {
-  max-height: 500px;
-}
+  * An `exec` tag that executes shell commands and incorporates the command and its output into the content of the `pre` tag.
+    Output data is escaped, whitespace is condensed, and wrapped in the same `unselectable` class as does `unselectable`.
+    ```
+    {% exec [Options] [shell command] %}
+    ```
+    `Options` are:
 
-.numbered_line,
-.unselectable.numbered_line,
-.numbered_line.unselectable {
-  color: #5fb25f;
-}
+     - `cd="relative/or/absolute/directory"` - Change to specified directory before executing shell command.
+       Environment variables in the directory path will be expanded.
+     - `no_escape` – Do not HTML escape the result of running the shell command.
+     - `no_strip` – Do not remove leading and trailing whitespace from the result.
+     - `die_if_nonzero` – Set `false` to treat non-zero return codes as non-fatal.
+       Instead of terminating Jekyll with an error message,
+       the message will be displayed as an error by the Jekyll logger,
+       and a red message will appear in place of the result on the web page.
+     - `die_if_error` – Set `false` to treat exceptions generated by this plugin as non-fatal.
+       Instead of terminating Jekyll with an error message, the message will be displayed as an error by the Jekyll logger.
 
-.unselectable {
-  color: #7922f9;
-  -moz-user-select: none;
-  -khtml-user-select: none;
-  user-select: none;
-}
-```
+
+## CSS
+See [`demo/assets/css/style.css`](demo/assets/css/style.css) for the CSS declarations,
+between `/* Start of pre tag css */` and `/* End of pre tag css */`.
 
 
 ## Additional Information
@@ -77,6 +81,7 @@ And then execute:
 
 
 ## Usage
+The following examples are rendered on [my website](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#jekyll_pre).
 
 ### Example 1
 This example does not generate a copy button and does not demonstrate `noselect`.
@@ -148,20 +153,70 @@ Which renders as:
 ![example 4](images/usage4example.png)
 
 
-### CSS
-Here are the CSS declarations that I defined pertaining to the `pre` and `noselect` tags that produced the above images:
+### Example 5
+A regular expression can be passed to the `highlight` option.
+This causes text that matches the regex pattern to be wrapped within a &lt;span class="bg_yellow">&lt;/span> tag.
+
+The CSS stylesheet used for this page contains the following:
 
 ```css
-.maxOneScreenHigh {
-  max-height: 500px;
+.bg_yellow {
+  background-color: yellow;
+  padding: 2px;
 }
+```
 
-.unselectable {
-  color: #7922f9;
-  -moz-user-select: none;
-  -khtml-user-select: none;
-  user-select: none;
-}
+This example demonstrates highlighting text that matches a regular expression. Regular expressions match against lines, which are delimited via newlines (\n).
+
+```
+{% pre copyButton highlight="Line 2" %}
+Line 1
+  Line 2
+    Line 3
+      Line 4
+    Line 5
+  Line 6
+Line 7
+{% endpre %}
+```
+
+
+### Example 6
+Regular expressions match against lines, which are delimited via newlines (`\n`).
+Thus to match an entire line that contains a phrase, specify the regex as `.*phrase.*`.
+The following matches 3 possible phrases (`2`, `4` or `6`), then selects the entire line if matched.
+
+```
+{% pre copyButton highlight=".*(2|4|6).*" %}
+Line 1
+  Line 2
+    Line 3
+      Line 4
+    Line 5
+  Line 6
+Line 7
+{% endpre %}
+```
+
+
+### Example 7
+This example floats an image to the right.
+The `jekyll_pre plugin`’s `clear` option moves the generated HTML below the image.
+
+```
+&lt;img src="jekyll.webp" style="float: right; width: 100px; height: auto;">
+{% pre clear copyButton label='Clear example' %}
+Using clear, copyButton and label parameters
+{% endpre %}
+```
+
+### Example 8
+The following executes `ls -alF /` and displays the output.
+
+```
+{% pre clear copyButton label='Exec without error' %}
+{% noselect %}{% exec die_if_nonzero=false ls -alF / %}
+{% endpre %}
 ```
 
 
@@ -205,11 +260,7 @@ A test website is provided in the `demo` directory.
 
 ### Build and Install Locally
 To build and install this gem onto your local machine, run:
-```shell
-$ rake install:local
-```
 
-The following also does the same thing:
 ```shell
 $ bundle exec rake install
 ```

data/lib/exec_tag.rb

@@ -0,0 +1,89 @@
+require 'jekyll_plugin_support'
+require_relative 'jekyll_pre/version'
+
+module ExecTag
+  class ExecTag < JekyllSupport::JekyllTag
+    include JekyllPreVersion
+
+    def render_impl
+      parse_args
+      command = @helper.remaining_markup
+      response = run_command(command)
+      response = if @child_status.success?
+                   compress(response)
+                 else
+                   handle_error(command)
+                 end
+
+      <<~END_OUTPUT
+        #{Rack::Utils.escape_html(command)}
+        <span class='unselectable'>#{response}</span>
+      END_OUTPUT
+    rescue PreError => e
+      raise PreError, e.message, []
+    rescue StandardError => e
+      msg = remove_html_tags(e.message) + " from executing '#{command}' on line #{@line_number} (after front matter) of #{@page['path']}"
+      raise PreError, msg.red, [] if die_if_error
+    end
+
+    private
+
+    def compress(response)
+      result = response.chomp
+      result = result.strip unless @no_strip
+      result = result.gsub('\n\n', '<br>\n')
+      result = Rack::Utils.escape_html(result) unless @no_escape
+      result
+    end
+
+    def die(msg)
+      msg_no_html = remove_html_tags(msg)
+      @logger.error("#{@page['path']} - #{msg_no_html}")
+      raise PreError, "#{@page['path']} - #{msg_no_html.red}", []
+    end
+
+    def handle_error(command)
+      msg0 = "Error: executing '#{command}'"
+      msg0 += " in directory '#{@cd}'" if @cd
+      msg = <<~END_MSG
+        #{msg0} on line #{@line_number} (after front matter) of #{@page['path']} returned error code #{@child_status.exitstatus}
+      END_MSG
+      raise PreError, msg.red, [] if @die_if_nonzero
+
+      @logger.error { msg }
+      "<span class='error'>Error code #{@child_status.exitstatus}</span>"
+    end
+
+    def parse_args
+      @cd = @helper.parameter_specified? 'cd'
+      @cd = JekyllPluginHelper.expand_env(@cd) if @cd
+
+      @no_escape      = @helper.parameter_specified? 'no_escape'
+      @no_strip       = @helper.parameter_specified? 'no_strip'
+      @die_if_nonzero = @helper.parameter_specified?('die_if_nonzero') # Implies die_if_error
+      @die_if_error   = @helper.parameter_specified?('die_if_error') | @die_if_nonzero
+    end
+
+    # References @cd
+    # Defines @child_status
+    # @return result of running command
+    # @param command [String] Shell command to execute
+    def run_command(command)
+      result = if @cd
+                 Dir.chdir(@cd) do
+                   `#{command}`
+                 end
+               else
+                 `#{command}`
+               end
+      @child_status = $CHILD_STATUS
+      result
+    end
+
+    JekyllPluginHelper.register(self, 'exec')
+  end
+
+  def remove_html_tags(string)
+    string.gsub(/<[^>]*>/, '')
+  end
+end

data/lib/jekyll_pre/version.rb

@@ -1,3 +1,3 @@
 module JekyllPreVersion
-  VERSION = '1.2.1'.freeze
+  VERSION = '1.2.3'.freeze
 end

data/lib/jekyll_pre.rb

@@ -1,98 +1,17 @@
-require 'liquid'
-require 'jekyll_plugin_logger'
-require 'jekyll_plugin_support'
-require_relative 'jekyll_pre/version'
-
 module JekyllPluginPreName
   PLUGIN_NAME = 'jekyll_pre'.freeze
 end
 
-class PreTagBlock < JekyllSupport::JekyllBlock
-  @@prefix = "<button class='copyBtn' data-clipboard-target="
-  @@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, dark, highlight_pattern, css_class, style, clear, content) # rubocop:disable Metrics/ParameterLists
-    pre_clear = label_clear = ''
-    if clear
-      if label.to_s.empty?
-        pre_clear = ' clear'
-      else
-        label_clear = ' clear'
-      end
-    end
-    css_class = css_class ? " #{css_class}" : ''
-    style = style ? " style='#{style}'" : ''
-    dark_label = ' darkLabel' if dark
-    label = if label.to_s.empty?
-              ''
-            elsif label.to_s.downcase.strip == 'shell'
-              "<div class='codeLabel unselectable#{dark_label}#{label_clear}' data-lt-active='false'>Shell</div>"
-            else
-              "<div class='codeLabel unselectable#{dark_label}#{label_clear}' 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
-
-    classes = "maxOneScreenHigh copyContainer#{dark}#{pre_clear}#{css_class}"
-    pre_content = "#{copy_button}#{content.strip}"
-    "#{label}<pre data-lt-active='false' class='#{classes}'#{style} id='#{pre_id}'>#{pre_content}</pre>"
-  end
+require_relative './exec_tag'
+require_relative './noselect_tag'
+require_relative './pre_tag_block'
 
-  def self.number_content(content)
-    lines = content.split("\n")
-    digits = lines.length.to_s.length
-    i = 0
-    numbered_content = lines.map do |line|
-      i += 1
-      number = i.to_s.rjust(digits, ' ')
-      "<span class='unselectable numbered_line'> #{number}: </span>#{line}"
-    end
-    result = numbered_content.join("\n")
-    result += "\n" unless result.end_with?("\n")
-    result
-  end
-
-  def render_impl(text)
-    text.strip!
-
-    @clear = @helper.parameter_specified? 'clear'
-    @class = @helper.parameter_specified? 'class'
-    @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'
-    @style = @helper.parameter_specified? 'style'
-    @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.argv.join(' ')
-
-    @logger.debug { "@make_copy_button = '#{@make_copy_button}'; @label = '#{@label}'" }
-    self.class.make_pre(@make_copy_button, @number_lines, @label, @dark, @highlight, @class, @style, @clear, text)
-  end
-end
+PreError = Class.new(Liquid::Error)
 
-# """\\{% noselect %} or \\{% noselect this all gets copied.
-# Also, space before the closing percent is signficant %}"""
-class UnselectableTag < JekyllSupport::JekyllTagNoArgParsing
-  def render_impl
-    text = @argument_string
-    text = '$ ' if text.nil? || text.empty?
-    "<span class='unselectable'>#{text}</span>"
-  end
+module JekyllPreModule
+  include NoSelectTag
+  include PreTagBlock
+  include ExecTag
 end
 
 PluginMetaLogger.instance.info { "Loaded #{JekyllPluginPreName::PLUGIN_NAME} v#{JekyllPreVersion::VERSION} plugin." }
-Liquid::Template.register_tag('pre', PreTagBlock)
-Liquid::Template.register_tag('noselect', UnselectableTag)

data/lib/noselect_tag.rb

@@ -0,0 +1,18 @@
+require 'jekyll_plugin_support'
+require_relative 'jekyll_pre/version'
+
+module NoSelectTag
+  # """\\{% noselect %} or \\{% noselect this all gets copied.
+  # Also, space before the closing percent is signficant %}"""
+  class NoSelectTag < JekyllSupport::JekyllTagNoArgParsing
+    include JekyllPreVersion
+
+    def render_impl
+      text = @argument_string
+      text = '$ ' if text.nil? || text.empty?
+      "<span class='unselectable'>#{text}</span>"
+    end
+
+    JekyllPluginHelper.register(self, 'noselect')
+  end
+end

data/lib/pre_tag_block.rb

@@ -0,0 +1,84 @@
+require 'jekyll_plugin_support'
+require_relative 'jekyll_pre/version'
+
+module PreTagBlock
+  class PreTagBlock < JekyllSupport::JekyllBlock
+    include JekyllPreVersion
+
+    @@prefix = "<button class='copyBtn' data-clipboard-target="
+    @@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, dark, highlight_pattern, css_class, style, clear, content) # rubocop:disable Metrics/ParameterLists
+      pre_clear = label_clear = ''
+      if clear
+        if label.to_s.empty?
+          pre_clear = ' clear'
+        else
+          label_clear = ' clear'
+        end
+      end
+      css_class = css_class ? " #{css_class}" : ''
+      style = style ? " style='#{style}'" : ''
+      dark_label = ' darkLabel' if dark
+      label = if label.to_s.empty?
+                ''
+              elsif label.to_s.downcase.strip == 'shell'
+                "<div class='codeLabel unselectable#{dark_label}#{label_clear}' data-lt-active='false'>Shell</div>"
+              else
+                "<div class='codeLabel unselectable#{dark_label}#{label_clear}' 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
+
+      classes = "maxOneScreenHigh copyContainer#{dark}#{pre_clear}#{css_class}"
+      pre_content = "#{copy_button}#{content.strip}"
+      "#{label}<pre data-lt-active='false' class='#{classes}'#{style} id='#{pre_id}'>#{pre_content}</pre>"
+    end
+
+    def self.number_content(content)
+      lines = content.split("\n")
+      digits = lines.length.to_s.length
+      i = 0
+      numbered_content = lines.map do |line|
+        i += 1
+        number = i.to_s.rjust(digits, ' ')
+        "<span class='unselectable numbered_line'> #{number}: </span>#{line}"
+      end
+      result = numbered_content.join("\n")
+      result += "\n" unless result.end_with?("\n")
+      result
+    end
+
+    def render_impl(text)
+      text.strip!
+
+      @clear = @helper.parameter_specified? 'clear'
+      @class = @helper.parameter_specified? 'class'
+      @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'
+      @style = @helper.parameter_specified? 'style'
+      @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.argv.join(' ')
+
+      @logger.debug { "@make_copy_button = '#{@make_copy_button}'; @label = '#{@label}'" }
+      self.class.make_pre(@make_copy_button, @number_lines, @label, @dark, @highlight, @class, @style, @clear, text)
+    end
+
+    JekyllPluginHelper.register(self, 'pre')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_pre
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.3
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-17 00:00:00.000000000 Z
+date: 2023-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -54,8 +54,11 @@ files:
 - README.md
 - Rakefile
 - jekyll_pre.gemspec
+- lib/exec_tag.rb
 - lib/jekyll_pre.rb
 - lib/jekyll_pre/version.rb
+- lib/noselect_tag.rb
+- lib/pre_tag_block.rb
 - spec/pre_spec.rb
 - spec/spec_helper.rb
 - spec/status_persistence.txt