jekyll_pre 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc048288e5f189d4519766b6db9a8807d6f41b4193be5fcd7ea7d39ed1af4a7b
-  data.tar.gz: 356f768bba6d1bbdb4abe52394a75e6aa387257b4fd1c58d7f9775324382ac6f
+  metadata.gz: 4cc10df37a945ecc8abddce501dd71a176084b9fafdde6e3aa6a48e18c7e4551
+  data.tar.gz: 73fe925e47914475d889e814cae15f8c8331ed7abf2498aaf0a207fd2e0bf7d9
 SHA512:
-  metadata.gz: 5e0833a721b44a3f9078d9ae76a70152d516469bb6062424366c3a7dc1171fe78a9407d6195e5ba5ae728224f78a278cff2f8fb145d94c5bc9346bf75bc44435
-  data.tar.gz: ff46960e6cfd7fd339e9d835e2bcaf0934d29dc7bb14bcf860208ced8bfab349f6bd680ac9b5cab7b426d4af5f0ae1dc10758181e24327e645cbeb0a323f8d63
+  metadata.gz: 76a1487e85b498708d27a2258fce364703fe2613253eff69e80475b22303f81f519a8bcedb14671fd62179d53521c80ca9c47d859e838d2bb43060ef58adc236
+  data.tar.gz: 59edd4611b9d6553096d76ce57d518a4e6dd670d2e7f236cfa6ae000c34b269584ecf318705db9bd68d32d9da42590ff71628a7a122107dca8d8e2057e048900

data/.rubocop.yml

@@ -20,7 +20,8 @@ Gemspec/RequireMFA:
   Enabled: false
 
 Layout/HashAlignment:
-  Enabled: false
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
 
 Layout/LineLength:
   Max: 150

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 1.4.0
+  * Added `dedent` option and config setting.
+  * No longer dies when exec is passed an empty string, or a string with just whitespace.
+
+## 1.3.2
+  * No longer strips leading spaces from exec result lines.
+
+## 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.
 

data/README.md

@@ -15,6 +15,7 @@ This Jekyll plugin provides 3 new Liquid tags that work together:
      - `clear` – Line break after floating HTML elements
      - `copyButton` – Generate a copy button
      - `dark` – Dark mode
+     - `dedent` &ndash; Remove leading spaces common to all lines, like Ruby's <<~ squiggly heredoc (default is false)
      - `label='This is a label'` &ndash; Apply text above `pre` tag.
         The `label` parameter value can also be specified in free text.
         For example, the following produce the same results:
@@ -47,14 +48,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
@@ -62,8 +65,38 @@ See [`demo/assets/css/style.css`](demo/assets/css/style.css) for the CSS declara
 between `/* Start of pre tag css */` and `/* End of pre tag css */`.
 
 
+## Configuration
+Default options can be set for the `pre` tag by entries in `_config.yml`.
+The following demonstrates setting a default value for every possible option:
+
+```yml
+pre:
+  class: bg_yellow
+  clear: true
+  dark: true
+  dedent: true
+  highlight: 'Error:.*'
+  label: Shell
+  copyButton: true
+  number: true
+  style: 'font-face: courier'
+  wrapper_class: rounded shadow
+  wrapper_style: 'padding: 2em; border: thin green dashed;'
+```
+
+The default values used on [`mslinn.com`](https://www.mslinn.com) are:
+
+```yml
+pre:
+  dedent: true
+  label: Shell
+  copyButton: true
+```
+
+
 ## Additional Information
-More information is available on [my website](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#jekyll_pre).
+More information is available on
+[Mike Slinn&rsquo;s website](https://www.mslinn.com/jekyll_plugins/jekyll_pre.html).
 
 
 ## Installation
@@ -78,11 +111,24 @@ end
 
 And then execute:
 
-    $ bundle install
+    $ bundle
 
 
 ## Usage
-The following examples are rendered on [my website](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#jekyll_pre).
+The following examples are rendered on
+[Mike Slinn&rsquo;s website](https://www.mslinn.com/jekyll_plugins/jekyll_pre.html).
+
+### Example 0
+<pre data-lt-active="false" class="maxOneScreenHigh copyContainer" id="id110c50d624b4">{% pre dedent %}
+    This line was indented 4 spaces
+      This line was indented 6 spaces
+    This line was indented 4 spaces
+{% endpre %}</pre>
+Which renders as:
+
+<pre data-lt-active="false" class="maxOneScreenHigh copyContainer" id="id377433c30186">This line was indented 4 spaces
+  This line was indented 6 spaces
+This line was indented 4 spaces</pre>
 
 ### Example 1
 This example does not generate a copy button and does not demonstrate `noselect`.

data/jekyll_pre.gemspec

@@ -1,3 +1,4 @@
+require 'jekyll'
 require_relative 'lib/jekyll_pre/version'
 
 Gem::Specification.new do |spec|
@@ -33,4 +34,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'jekyll', '>= 3.5.0'
   spec.add_dependency 'jekyll_plugin_support', '~> 0.6.0'
+  spec.add_dependency 'rack'
 end

data/lib/exec_tag.rb

@@ -1,7 +1,16 @@
 require 'jekyll_plugin_support'
+require 'rack/utils'
 require_relative 'jekyll_pre/version'
 
-module ExecTag
+module JekyllPreModule
+  def self.compress(response, no_strip)
+    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
+
   class ExecTag < JekyllSupport::JekyllTag
     include JekyllPreVersion
 
@@ -13,11 +22,18 @@ module ExecTag
       parse_args
       @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?
+      if command.strip.empty?
+        msg = "Command is empty on on line #{@line_number} (after front matter) of #{@page['path']}"
+        unless @die_if_error
+          @logger.warn { msg }
+          return ''
+        end
+        raise PreError, msg, []
+      end
 
       response = run_command(command)
       response = if @child_status.success?
-                   compress(response)
+                   ExecTagModule.compress(response, @no_strip)
                  else
                    handle_error(command)
                  end
@@ -29,20 +45,13 @@ 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
 
     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 = self.class.remove_html_tags(msg)
       @logger.error("#{@page['path']} - #{msg_no_html}")
@@ -87,7 +96,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.3.0'.freeze
+  VERSION = '1.4.0'.freeze
 end

data/lib/jekyll_pre.rb

@@ -8,10 +8,14 @@ require_relative './pre_tag_block'
 
 PreError = Class.new(Liquid::Error)
 
-module JekyllPreModule
-  include NoSelectTag
-  include PreTagBlock
-  include ExecTag
+class String
+  # Works like <<~ from Ruby 2.3.0
+  def dedent
+    # Find the margin whitespace on the first line
+    margin = self[/\A\s*/]
+    # Remove margin-sized whitespace from each line
+    gsub(/^\s{#{margin.size}}/, '')
+  end
 end
 
 PluginMetaLogger.instance.info { "Loaded #{JekyllPluginPreName::PLUGIN_NAME} v#{JekyllPreVersion::VERSION} plugin." }

data/lib/noselect_tag.rb

@@ -1,7 +1,7 @@
 require 'jekyll_plugin_support'
 require_relative 'jekyll_pre/version'
 
-module NoSelectTag
+module JekyllPreModule
   # """\\{% noselect %} or \\{% noselect this all gets copied.
   # Also, space before the closing percent is signficant %}"""
   class NoSelectTag < JekyllSupport::JekyllTagNoArgParsing

data/lib/pre_tag_block.rb

@@ -1,7 +1,7 @@
 require 'jekyll_plugin_support'
 require_relative 'jekyll_pre/version'
 
-module PreTagBlock
+module JekyllPreModule
   class PreTagBlock < JekyllSupport::JekyllBlock
     include JekyllPreVersion
 
@@ -31,23 +31,48 @@ module PreTagBlock
       result
     end
 
+    # remove leading blank lines and trailing whitespace
+    def self.remove_surrounding(text)
+      text.gsub(/\A(\s?\n)*/, '').rstrip
+    end
+
+    def option(name)
+      value = @helper.parameter_specified? name
+      return value unless value.nil?
+
+      @pre_config[name] if @pre_config
+    end
+
     def render_impl(text)
-      text.strip!
+      text = PreTagBlock.remove_surrounding text
+
       @helper.gem_file __FILE__ # Enables plugin attribution
 
-      @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'
+      @pre_config = @config['pre']
+
+      @class            = option 'class'
+      @clear            = option 'clear'
+      @dark             = ' dark' if option 'dark'
+      @dedent           = option 'dedent'
+      @highlight        = option 'highlight'
+      @label            = option 'label'
+      @make_copy_button = option 'copyButton'
+      @number_lines     = option 'number'
+      @style            = option 'style'
+      @wrapper_class    = option 'wrapper_class'
+      @wrapper_style    = option '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}'" }
+
+      text = text.dedent if @dedent
       make_pre(text)
     end
 
@@ -62,8 +87,6 @@ module PreTagBlock
           label_clear = ' clear'
         end
       end
-      @class = @class ? " #{@class}" : ''
-      @style = @style ? " style='#{@style}'" : ''
       dark_label = ' darkLabel' if @dark
       @label = if @label.to_s.empty?
                  ''
@@ -81,9 +104,11 @@ module PreTagBlock
       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
 

data/spec/exec_spec.rb

@@ -0,0 +1,34 @@
+require_relative '../lib/jekyll_pre'
+
+module ExecTagSpec
+  RSpec.describe(JekyllPreModule) do
+    it 'strips properly' do
+      content = <<~END_CONTENT
+        Line 1
+          Line 2
+            Line 3
+            Line 4
+          Line 5
+        Line 6
+        Line 7
+          Line 8
+          Line 9
+        Line 10
+      END_CONTENT
+      actual = described_class.compress content, false
+      expected = <<~END_CONTENT
+        Line 1
+          Line 2
+            Line 3
+            Line 4
+          Line 5
+        Line 6
+        Line 7
+          Line 8
+          Line 9
+        Line 10
+      END_CONTENT
+      expect(expected.strip).to eq(actual)
+    end
+  end
+end

data/spec/pre_spec.rb

@@ -4,7 +4,71 @@ require 'key_value_parser'
 require 'shellwords'
 require_relative '../lib/jekyll_pre'
 
-RSpec.describe(PreTagBlock) do
+RSpec.describe(JekyllPreModule::PreTagBlock) do
+  it 'dedents content lines' do
+    content = <<-END_CONTENT
+      Line 1
+        Line 2
+          Line 3
+          Line 4
+        Line 5
+      Line 6
+      Line 7
+        Line 8
+        Line 9
+      Line 10
+    END_CONTENT
+    expected = <<~END_CONTENT
+      Line 1
+        Line 2
+          Line 3
+          Line 4
+        Line 5
+      Line 6
+      Line 7
+        Line 8
+        Line 9
+      Line 10
+    END_CONTENT
+    actual = content.dedent
+    expect(actual).to eq(expected)
+  end
+
+  it 'removes surrounding whitespace' do
+    text = <<-END_CONTENT
+
+
+      Line 1
+        Line 2
+          Line 3
+          Line 4
+        Line 5
+      Line 6
+      Line 7
+        Line 8
+        Line 9
+      Line 10
+
+
+    END_CONTENT
+    actual = described_class.remove_surrounding(text)
+
+    expected = <<-END_CONTENT
+      Line 1
+        Line 2
+          Line 3
+          Line 4
+        Line 5
+      Line 6
+      Line 7
+        Line 8
+        Line 9
+      Line 10
+    END_CONTENT
+
+    expect(actual).to eq(expected.rstrip)
+  end
+
   it 'parses arguments' do
     argv = Shellwords.split 'number copyButton shell'
     options = KeyValueParser.new.parse(argv)

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 require 'jekyll'
 require 'fileutils'
 require 'key_value_parser'
+require 'jekyll_plugin_support'
+require 'rack/utils'
 require 'shellwords'
 
 require_relative '../lib/jekyll_pre'

data/spec/status_persistence.txt

@@ -1,5 +1,13 @@
-example_id              | status | run_time        |
------------------------ | ------ | --------------- |
-./spec/pre_spec.rb[1:1] | passed | 0.00075 seconds |
-./spec/pre_spec.rb[1:2] | passed | 0.00044 seconds |
-./spec/pre_spec.rb[1:3] | passed | 0.00018 seconds |
+example_id                                                      | status | run_time        |
+--------------------------------------------------------------- | ------ | --------------- |
+./spec/exec_spec.rb[1:1]                                        | passed | 0.00377 seconds |
+./spec/pre_spec.rb[1:1]                                         | passed | 0.00014 seconds |
+./spec/pre_spec.rb[1:2]                                         | passed | 0.00351 seconds |
+./spec/pre_spec.rb[1:3]                                         | passed | 0.00016 seconds |
+./spec/pre_spec.rb[1:4]                                         | passed | 0.00011 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_pre/spec/exec_spec.rb[1:1] | passed | 0.00457 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_pre/spec/pre_spec.rb[1:1]  | passed | 0.00326 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_pre/spec/pre_spec.rb[1:2]  | passed | 0.00067 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_pre/spec/pre_spec.rb[1:3]  | passed | 0.00362 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_pre/spec/pre_spec.rb[1:4]  | passed | 0.00033 seconds |
+/mnt/_/work/jekyll/my_plugins/jekyll_pre/spec/pre_spec.rb[1:5]  | passed | 0.00083 seconds |

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_pre
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-06 00:00:00.000000000 Z
+date: 2023-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'Jekyll tags pre and noselect, for HTML <pre/> tag, prompts and unselectable
   text. Can number lines.
 
@@ -59,6 +73,7 @@ files:
 - lib/jekyll_pre/version.rb
 - lib/noselect_tag.rb
 - lib/pre_tag_block.rb
+- spec/exec_spec.rb
 - spec/pre_spec.rb
 - spec/spec_helper.rb
 - spec/status_persistence.txt
@@ -95,6 +110,7 @@ specification_version: 4
 summary: Jekyll tags pre and noselect, for HTML <pre/> tag, prompts and unselectable
   text. Can number lines.
 test_files:
+- spec/exec_spec.rb
 - spec/pre_spec.rb
 - spec/spec_helper.rb
 - spec/status_persistence.txt