jekyll_pre 1.2.4 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a78213a8f26a3d6743a9b706501a5c0f87279eeb243e492956fdd557b0a1e6d
-  data.tar.gz: 64c8640dee1fe914ac54f9813df8bb3f365518d41d13aecd62bda8c752d0488e
+  metadata.gz: 16aa76dad7fdc41eac063227ee8463e9bcb77dd1c9893840e05f22a67c08aef0
+  data.tar.gz: 9e550133932e9b422a30bdccb813dd0c603870bac9bbb08489256a92be9d27ce
 SHA512:
-  metadata.gz: e89f23e343045045c93f7fe7843a43611608f8702e934f4ce0f3c50b52bed7d71b856c79af679d4af9fbdd25921bbcf6977acbd709033a171bbfffc136ff358d
-  data.tar.gz: bba7c4caf281ab09415560e63a525c632bd98019bb475d53e526fade9c43ed4f77a9de7ef8395085c82308cf4fe31c4e4bbc52c58870f942cd7f6db1181e23ae
+  metadata.gz: 8f87a17e7dff740d917a248323822a491559ac3bc3223ca4af7a62c261ca213be8f82f61577b7278112534b0ed5af597f01242fba0ba9adb9158a27425893ffa
+  data.tar.gz: 1227a44360aae2c913a005223c28e0ef1f3a788e43e7acb0973f960fbc618846d587754e9944f15884f184f73b9ed2bd913eeedc1273ee186e694deef31e5fc5

data/.rubocop.yml

@@ -20,13 +20,14 @@ Gemspec/RequireMFA:
   Enabled: false
 
 Layout/HashAlignment:
-  Enabled: false
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
 
 Layout/LineLength:
   Max: 150
 
 Metrics/AbcSize:
-  Max: 25
+  Max: 35
 
 Metrics/BlockLength:
   Exclude:

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 1.3.1
+  * Generates outer `div` with `jekyll_pre` class, like this:
+    ```html
+    <div class="jekyll_pre">
+      ... HTML generated by previous versions of `pre` tag here
+    </div>
+    ```
+  * Added `wrapper_class` and `wrapper_style` name/value options.
+
+## 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.
 

data/README.md

@@ -47,14 +47,16 @@ This Jekyll plugin provides 3 new Liquid tags that work together:
 
      - `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.
+     - `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.
+     - `wrapper_class` class applied to outer `div`.
+     - `wrapper_style` style applied to outer `div`.
 
 
 ## CSS

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', '>= 0.5.3'
+  spec.add_dependency 'jekyll_plugin_support', '~> 0.6.0'
 end

data/lib/exec_tag.rb

@@ -12,7 +12,9 @@ module ExecTag
     def render_impl
       parse_args
       @original_command = @helper.remaining_markup_original
-      command = JekyllPluginHelper.expand_env(@original_command)
+      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)
@@ -27,7 +29,8 @@ module ExecTag
     rescue PreError => e
       raise PreError, e.message, []
     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']}"
+      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
 
@@ -85,7 +88,8 @@ module ExecTag
       @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']}"
+      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

data/lib/jekyll_pre/version.rb

@@ -1,3 +1,3 @@
 module JekyllPreVersion
-  VERSION = '1.2.4'.freeze
+  VERSION = '1.3.1'.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,21 +33,65 @@ 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'
+      @clear = @helper.parameter_specified? 'clear'
+      @dark = ' dark' if @helper.parameter_specified? 'dark'
       @highlight = @helper.parameter_specified? 'highlight'
+      @label = @helper.parameter_specified? 'label'
       @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'
+      @wrapper_class = @helper.parameter_specified? 'wrapper_class'
+      @wrapper_style = @helper.parameter_specified? 'wrapper_style'
+
+      @class = @class ? " #{@class}" : ''
+      @style = @style ? " style='#{@style}'" : ''
+      @wrapper_class = @wrapper_class ? " #{@wrapper_class}" : ''
+      @wrapper_style = @wrapper_style ? " style='#{@wrapper_style}'" : ''
 
       # 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)
+      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
+      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
+        <div class="jekyll_pre#{@wrapper_class}" #{@wrapper_style}>
+        #{@label}
+        <pre data-lt-active='false' class='#{classes}'#{@style} id='#{pre_id}'>#{pre_content}</pre>
+        #{attribution}
+        </div>
+      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.4
+  version: 1.3.1
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-19 00:00:00.000000000 Z
+date: 2023-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -30,20 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.3
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.3
+        version: 0.6.0
 description: 'Jekyll tags pre and noselect, for HTML <pre/> tag, prompts and unselectable
   text. Can number lines.
 
@@ -68,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+