jekyll_pre 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e01bd13d91a64bf9b1dc9802cd11ef6c759985a30532daf8b3ace4618bfe634
-  data.tar.gz: 6d33733cf1f1d0267ba226dafd459807254fa10f5199f2b1358648f9f94ccc01
+  metadata.gz: bc048288e5f189d4519766b6db9a8807d6f41b4193be5fcd7ea7d39ed1af4a7b
+  data.tar.gz: 356f768bba6d1bbdb4abe52394a75e6aa387257b4fd1c58d7f9775324382ac6f
 SHA512:
-  metadata.gz: 8e1f5e2a5cb3beb928cc2d8ad09fd1274aff0c5085ac1ee1f014456aaefaa78d5711c2bd9046e9418737b7bff7b53b2e4f54856e5dbbb8fcd1d4f193757db0fc
-  data.tar.gz: 22747b92ec65bb6568a648c98a2a24417fd970daa012632ec596deca2232b0e994dffa7017792083d797c1ee6b2bc86b01b4b496d84525786ddcfd06769ade64
+  metadata.gz: 5e0833a721b44a3f9078d9ae76a70152d516469bb6062424366c3a7dc1171fe78a9407d6195e5ba5ae728224f78a278cff2f8fb145d94c5bc9346bf75bc44435
+  data.tar.gz: ff46960e6cfd7fd339e9d835e2bcaf0934d29dc7bb14bcf860208ced8bfab349f6bd680ac9b5cab7b426d4af5f0ae1dc10758181e24327e645cbeb0a323f8d63

data/.rubocop.yml

@@ -26,7 +26,7 @@ Layout/LineLength:
   Max: 150
 
 Metrics/AbcSize:
-  Max: 25
+  Max: 35
 
 Metrics/BlockLength:
   Exclude:

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 1.3.0
+  * Updated to `jekyll_plugin_support` v0.6.0 for attribution support.
+
+## 1.2.5
+  * Empty exec commands are detected and reported.
+
+## 1.2.4
+  * The `exec` tag now evaluates environment variables in the command before execution.
+
 ## 1.2.3
   * Added `cd` option to `exec` tag.
 

data/README.md

@@ -38,7 +38,8 @@ This Jekyll plugin provides 3 new Liquid tags that work together:
     ```
 
   * 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`.
+    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] %}
     ```
@@ -219,6 +220,24 @@ The following executes `ls -alF /` and displays the output.
 {% 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 $USER' %}
+{% noselect %}{% exec die_if_nonzero=false echo $USER %}
+{% endpre %}
+```
+
 
 ### Comprehensive Example
 The code I wrote to generate the above CSS was a good example of how the plugins work together with

data/jekyll_pre.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   END_OF_DESC
   spec.email = ['mslinn@mslinn.com']
   spec.files = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec}/**/*', '*.gemspec', '*.md']
-  spec.homepage = 'https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#pre'
+  spec.homepage = 'https://www.mslinn.com/jekyll/3000-jekyll-plugins.html#jekyll_pre'
   spec.license = 'MIT'
   spec.metadata = {
     'allowed_push_host' => 'https://rubygems.org',
@@ -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.6.0'
 end

data/lib/exec_tag.rb

@@ -5,9 +5,16 @@ 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
+      @original_command = @helper.remaining_markup_original
+      command = JekyllPluginHelper.expand_env @original_command
+      raise PreError, "Command is empty on on line #{@line_number} (after front matter) of #{@page['path']}", [] if command.strip.empty?
+
       response = run_command(command)
       response = if @child_status.success?
                    compress(response)
@@ -16,14 +23,14 @@ module ExecTag
                  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
@@ -37,13 +44,14 @@ module ExecTag
     end
 
     def die(msg)
-      msg_no_html = remove_html_tags(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}
@@ -78,12 +86,14 @@ module ExecTag
                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
 
     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.3'.freeze
+  VERSION = '1.3.0'.freeze
 end

data/lib/pre_tag_block.rb

@@ -17,35 +17,6 @@ module PreTagBlock
       "#{@@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
@@ -62,6 +33,7 @@ module PreTagBlock
 
     def render_impl(text)
       text.strip!
+      @helper.gem_file __FILE__ # Enables plugin attribution
 
       @clear = @helper.parameter_specified? 'clear'
       @class = @helper.parameter_specified? 'class'
@@ -76,7 +48,43 @@ module PreTagBlock
       @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)
+      make_pre(text)
+    end
+
+    private
+
+    def make_pre(content)
+      pre_clear = label_clear = ''
+      if @clear
+        if @label.to_s.empty?
+          pre_clear = ' clear'
+        else
+          label_clear = ' clear'
+        end
+      end
+      @class = @class ? " #{@class}" : ''
+      @style = @style ? " style='#{@style}'" : ''
+      dark_label = ' darkLabel' if @dark
+      @label = if @label.to_s.empty?
+                 ''
+               elsif @label.to_s.casecmp('shell').zero?
+                 "<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) if @highlight
+      content = PreTagBlock.number_content(content) if @number_lines
+
+      classes = "maxOneScreenHigh copyContainer#{@dark}#{pre_clear}#{@class}"
+      pre_content = "#{copy_button}#{content}"
+      attribution = @helper.attribute if @helper.attribution
+      <<~END_OUTPUT
+        #{@label}
+        <pre data-lt-active='false' class='#{classes}'#{@style} id='#{pre_id}'>#{pre_content}</pre>
+        #{attribution}
+      END_OUTPUT
     end
 
     JekyllPluginHelper.register(self, 'pre')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_pre
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-19 00:00:00.000000000 Z
+date: 2023-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
 description: 'Jekyll tags pre and noselect, for HTML <pre/> tag, prompts and unselectable
   text. Can number lines.
 
@@ -62,14 +62,14 @@ files:
 - spec/pre_spec.rb
 - spec/spec_helper.rb
 - spec/status_persistence.txt
-homepage: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#pre
+homepage: https://www.mslinn.com/jekyll/3000-jekyll-plugins.html#jekyll_pre
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
   bug_tracker_uri: https://github.com/mslinn/jekyll_pre/issues
   changelog_uri: https://github.com/mslinn/jekyll_pre/CHANGELOG.md
-  homepage_uri: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#pre
+  homepage_uri: https://www.mslinn.com/jekyll/3000-jekyll-plugins.html#jekyll_pre
   source_code_uri: https://github.com/mslinn/jekyll_pre
 post_install_message: |2+