jekyll_pre 1.1.7 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97df025cc0565235360a3c42053ed994e5f33968145eef4008ae5b27a8df61fa
-  data.tar.gz: d8c1eba16949515b28e7696865307da8ba8e150d807f466f45e32322f1786576
+  metadata.gz: 6097d5cc2c288233bb1bdb16683fa3116ec244edead6a25d971d0f002932d939
+  data.tar.gz: ab7f388db1f0e9dbfc0f677ea1e830b8486f02acc6da3aa95f08654c2f7de3a4
 SHA512:
-  metadata.gz: 03bb017f63fe8cf7b780065f10e248727f4047c031c0c5d74f4a96721b95c3a4e30ba9288dc9ac176b5eeff4efb2a454e412da28a58a7489c246529fb2335ea4
-  data.tar.gz: 4fb5fd78dde215a9639438095fddae46c053f396edcd77cbd42662d9f3250c32928349effecc17688d377f2f09bab140f56c6af16cf061801d15667849ed2ebc
+  metadata.gz: e3069935c7ad9b664004cb4235002ab12fb6e91911876a9cb5113e880c3f6b3a565d84c51bd5706470866fd82d1a6c168c0b26b88cbf59cf9d3adfc49ce9e392
+  data.tar.gz: 5e14ff1c554fda49eb095538fef25297f13bf8cdf48d508747227db69e0fa32a698193f391dbb9981f19914f4a6a15656d9db4ad50240b1bf6162c01af68c77b

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,14 @@
+## 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.
+
+## 1.2.0
+  * Updated to `jekyll_plugin_support` v0.5.0.
+
 ## 1.1.7
   * Fixed `noselect` tag content handling.
 

data/README.md

@@ -2,7 +2,7 @@ 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.
     ```
@@ -11,23 +11,33 @@ This Jekyll plugin provides 2 new Liquid tags that work together:
     {% endpre %}
     ```
     `Options` are:
+     - `class="class1 class2"` – Apply CSS classes
      - `clear` – Line break after floating HTML elements
-     - `class="class names"` – Apply CSS styles
      - `copyButton` – Generate a copy button
      - `dark` – Dark mode
-     - `label='This is a label'` – Apply text above pre tag
+     - `label='This is a label'` – Apply text above `pre` tag.
+        The `label` parameter value can also be specified in free text.
+        For example, the following produce the same results:
+
+        - {% pre label="This is a label" %}<br>Contents of pre tag<br>{% endpre %}
+
+        - {% 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
 
     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.
+
+  * A `noselect` tag that can renders HTML content passed to it unselectable,
+    and generates a <code>$</code> prompt if no content is provided.
     ```
-    {% pre [copyButton] %}
-    {% noselect [text string, defaults to $]%}Contents of pre tag
+    {% pre %}
+    {% noselect [optional text string, defaults to $]%}Contents of pre tag
     {% 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

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.4.0'
+  spec.add_dependency 'jekyll_plugin_support', '~> 0.5.0'
 end

data/lib/exec_tag.rb

@@ -0,0 +1,65 @@
+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 = `#{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
+
+      <<~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 parse_args
+      @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
+
+  def remove_html_tags(string)
+    string.gsub(/<[^>]*>/, '')
+  end
+end

data/lib/jekyll_pre/version.rb

@@ -1,3 +1,3 @@
 module JekyllPreVersion
-  VERSION = '1.1.7'.freeze
+  VERSION = '1.2.2'.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::JekyllTag
-  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.1.7
+  version: 1.2.2
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-15 00:00:00.000000000 Z
+date: 2023-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
 description: 'Jekyll tags pre and noselect, for HTML <pre/> tag, prompts and unselectable
   text. Can number lines.
 
@@ -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