jekyll_pre 1.2.2 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6097d5cc2c288233bb1bdb16683fa3116ec244edead6a25d971d0f002932d939
-  data.tar.gz: ab7f388db1f0e9dbfc0f677ea1e830b8486f02acc6da3aa95f08654c2f7de3a4
+  metadata.gz: 2a78213a8f26a3d6743a9b706501a5c0f87279eeb243e492956fdd557b0a1e6d
+  data.tar.gz: 64c8640dee1fe914ac54f9813df8bb3f365518d41d13aecd62bda8c752d0488e
 SHA512:
-  metadata.gz: e3069935c7ad9b664004cb4235002ab12fb6e91911876a9cb5113e880c3f6b3a565d84c51bd5706470866fd82d1a6c168c0b26b88cbf59cf9d3adfc49ce9e392
-  data.tar.gz: 5e14ff1c554fda49eb095538fef25297f13bf8cdf48d508747227db69e0fa32a698193f391dbb9981f19914f4a6a15656d9db4ad50240b1bf6162c01af68c77b
+  metadata.gz: e89f23e343045045c93f7fe7843a43611608f8702e934f4ce0f3c50b52bed7d71b856c79af679d4af9fbdd25921bbcf6977acbd709033a171bbfffc136ff358d
+  data.tar.gz: bba7c4caf281ab09415560e63a525c632bd98019bb475d53e526fade9c43ed4f77a9de7ef8395085c82308cf4fe31c4e4bbc52c58870f942cd7f6db1181e23ae

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.2.4
+  * The `exec` tag now evaluates environment variables in the command before execution.
+
+## 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`

data/README.md

@@ -4,9 +4,9 @@ Jekyll_pre
 
 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,7 +24,7 @@ This Jekyll plugin provides 3 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.
 
@@ -32,32 +32,34 @@ This Jekyll plugin provides 3 new Liquid tags that work together:
     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 %}
     ```
 
   * 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`.
-## 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;
-}
+    Environment variables are evaluated,
+    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
@@ -80,6 +82,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`.
@@ -151,20 +154,88 @@ 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 %}
+```
+
+### Example 9
+The following changes to the home directory (`$HOME`), then executes `pwd` and displays the output.
+
+```
+{% pre clear copyButton label='Exec without error' %}
+{% noselect %}{% exec cd="$HOME" die_if_nonzero=false pwd %}
+{% endpre %}
+```
+
+### Example 10
+The following executes `echo $USER` and displays the output.
+
+```
+{% pre clear copyButton label='Exec display &dollar;USER' %}
+{% noselect %}{% exec die_if_nonzero=false echo $USER %}
+{% endpre %}
 ```
 
 
@@ -208,11 +279,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/jekyll_pre.gemspec

@@ -32,5 +32,5 @@ Gem::Specification.new do |spec|
   spec.version = JekyllPreVersion::VERSION
 
   spec.add_dependency 'jekyll', '>= 3.5.0'
-  spec.add_dependency 'jekyll_plugin_support', '~> 0.5.0'
+  spec.add_dependency 'jekyll_plugin_support', '~> 0.5.0', '>= 0.5.3'
 end

data/lib/exec_tag.rb

@@ -5,30 +5,30 @@ module ExecTag
   class ExecTag < JekyllSupport::JekyllTag
     include JekyllPreVersion
 
+    def self.remove_html_tags(string)
+      string.gsub(/<[^>]*>/, '')
+    end
+
     def render_impl
       parse_args
-
-      command = @helper.remaining_markup
-      response = `#{command}`
-      if $CHILD_STATUS.success?
-        response = compress response
-      else
-        msg = "Error: executing '#{command}' on line #{@line_number} (after front matter) of #{@page['path']} returned error code #{$CHILD_STATUS.exitstatus}"
-        raise PreError, msg.red, [] if @die_if_nonzero
-
-        @logger.error { msg }
-        response = "<span class='error'>Error: error code #{$CHILD_STATUS.exitstatus}</span>"
-      end
+      @original_command = @helper.remaining_markup_original
+      command = JekyllPluginHelper.expand_env(@original_command)
+      response = run_command(command)
+      response = if @child_status.success?
+                   compress(response)
+                 else
+                   handle_error(command)
+                 end
 
       <<~END_OUTPUT
-        #{Rack::Utils.escape_html(command)}
+        #{Rack::Utils.escape_html(@original_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
+      msg = self.class.remove_html_tags(e.message) + " from executing '#{@original_command}' on line #{@line_number} (after front matter) of #{@page['path']}"
+      raise PreError, msg.red, [] if @die_if_error
     end
 
     private
@@ -41,25 +41,57 @@ module ExecTag
       result
     end
 
+    def die(msg)
+      msg_no_html = self.class.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 += " (expanded from #{@original_command})" if command != @original_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
 
-    JekyllPluginHelper.register(self, 'exec')
-  end
-
-  private
-
-  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
+    # 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
+    rescue StandardError => e
+      msg = self.class.remove_html_tags(e.message) + " from executing '#{@original_command}' on line #{@line_number} (after front matter) of #{@page['path']}"
+      raise PreError, msg.red, [] if @die_if_error
+    ensure
+      @child_status = $CHILD_STATUS
+      result
+    end
 
-  def remove_html_tags(string)
-    string.gsub(/<[^>]*>/, '')
+    JekyllPluginHelper.register(self, 'exec')
   end
 end

data/lib/jekyll_pre/version.rb

@@ -1,3 +1,3 @@
 module JekyllPreVersion
-  VERSION = '1.2.2'.freeze
+  VERSION = '1.2.4'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_pre
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.4
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-18 00:00:00.000000000 Z
+date: 2023-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -31,6 +31,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,6 +41,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.3
 description: 'Jekyll tags pre and noselect, for HTML <pre/> tag, prompts and unselectable
   text. Can number lines.