jekyll_pre 1.3.1 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16aa76dad7fdc41eac063227ee8463e9bcb77dd1c9893840e05f22a67c08aef0
-  data.tar.gz: 9e550133932e9b422a30bdccb813dd0c603870bac9bbb08489256a92be9d27ce
+  metadata.gz: f765cdcaf2d5447e9e05c49f02aa47b59feba53ba9dab4133a05eaa35f415555
+  data.tar.gz: 2b742223bfd91ce5dc8349a8dd5a09e8c678890dbb338a347ac2c463d3db9f1d
 SHA512:
-  metadata.gz: 8f87a17e7dff740d917a248323822a491559ac3bc3223ca4af7a62c261ca213be8f82f61577b7278112534b0ed5af597f01242fba0ba9adb9158a27425893ffa
-  data.tar.gz: 1227a44360aae2c913a005223c28e0ef1f3a788e43e7acb0973f960fbc618846d587754e9944f15884f184f73b9ed2bd913eeedc1273ee186e694deef31e5fc5
+  metadata.gz: f4c15e15ee8390c7c429ce94f5913063d16804a2a61be225d66d1186406995eeed6a326e16fe438efac8dcf266f2e649888aec4c3d581fc10217098d1cbea3b9
+  data.tar.gz: 7ae60210e08f23519765d3c1064761838f448e4e04f4dd03f8965361b5243d0cbfa543665370b918bbc4e188c97a3ec96b400d884b7c543d39b1b722afffead5

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 1.4.1
+  * Fixed problem that caused exec tag to no produce output.
+
+## 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

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:
@@ -58,14 +59,105 @@ This Jekyll plugin provides 3 new Liquid tags that work together:
      - `wrapper_class` class applied to outer `div`.
      - `wrapper_style` style applied to outer `div`.
 
+## Keyword Options
+For all keyword options, including keyword options for the `pre` and `exec` tags:
+
+ - Option values specified in the document *may* be provided.
+   If a value is not provided, the value `true` is assumed.
+   Otherwise, if a value is provided, it *must* be wrapped in single or double quotes.
+
+ - Option values specified in `_config.yml` *must* be provided, and the value `true` cannot be implied.
+   Values that do not contain special characters *may* be wrapped in single or double quotes.
+
+### Examples
+#### Specifying Tag Option Values
+The following sets `die_if_error` `true`:
+```
+{% pre die_if_error %} ... {% endpre %}
+```
+
+The above is the same as writing:
+```
+{% pre die_if_error='true' %} ... {% endpre %}
+```
+
+Or writing:
+```
+{% pre die_if_error="true" %} ... {% endpre %}
+```
+
+Neglecting to provide surrounding quotes around the provided value causes the parser to not recognize the option.
+Instead, what you had intended to be the keyword/value pair will be parsed as part of the command.
+For the `pre` tag, this means the erroneous string becomes part of the `label` value, unless `label` is explicitly specified.
+For the `exec` tag, this means the erroneous string becomes part of the command to execute.
+The following demonstrates the error.
+
+```
+{% pre die_if_error=false %} ... {% endpre %}
+```
+The above causes the label to be `die_if_error=false`.
+
+```
+{% exec die_if_error=false ls %} ... {% endpre %}
+```
+The above causes the command to be executed to be `die_if_error=false ls` instead of `ls`.
+
 
 ## 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 */`.
 
 
+## 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
+```
+
+
+#### Specifying Default Option Values
+Specifying a default value for `die_if_error` in `_config.yml` could be done as follows:
+```yaml
+pre:
+  die_if_error: true
+```
+
+```yaml
+pre:
+  die_if_error: "true"
+```
+
+```yaml
+pre:
+  die_if_error: '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
@@ -80,11 +172,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`.
@@ -218,7 +323,7 @@ The following executes `ls -alF /` and displays the output.
 
 ```
 {% pre clear copyButton label='Exec without error' %}
-{% noselect %}{% exec die_if_nonzero=false ls -alF / %}
+{% noselect %}{% exec die_if_nonzero='false' ls -alF / %}
 {% endpre %}
 ```
 
@@ -227,7 +332,7 @@ The following changes to the home directory (`$HOME`), then executes `pwd` and d
 
 ```
 {% pre clear copyButton label='Exec without error' %}
-{% noselect %}{% exec cd="$HOME" die_if_nonzero=false pwd %}
+{% noselect %}{% exec cd="$HOME" die_if_nonzero='false' pwd %}
 {% endpre %}
 ```
 
@@ -236,7 +341,7 @@ 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 %}
+{% noselect %}{% exec die_if_nonzero='false' echo $USER %}
 {% endpre %}
 ```
 

data/jekyll_pre.gemspec

@@ -1,3 +1,4 @@
+require 'jekyll'
 require_relative 'lib/jekyll_pre/version'
 
 Gem::Specification.new do |spec|
@@ -10,7 +11,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/jekyll/3000-jekyll-plugins.html#jekyll_pre'
+  spec.homepage = 'https://www.mslinn.com/jekyll_plugins/jekyll_pre.html'
   spec.license = 'MIT'
   spec.metadata = {
     'allowed_push_host' => 'https://rubygems.org',
@@ -32,5 +33,6 @@ Gem::Specification.new do |spec|
   spec.version = JekyllPreVersion::VERSION
 
   spec.add_dependency 'jekyll', '>= 3.5.0'
-  spec.add_dependency 'jekyll_plugin_support', '~> 0.6.0'
+  spec.add_dependency 'jekyll_plugin_support', '>= 0.7.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)
+                   JekyllPreModule.compress(response, @no_strip)
                  else
                    handle_error(command)
                  end
@@ -36,14 +52,6 @@ module ExecTag
 
     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}")

data/lib/jekyll_pre/version.rb

@@ -1,3 +1,3 @@
 module JekyllPreVersion
-  VERSION = '1.3.1'.freeze
+  VERSION = '1.4.1'.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,20 +31,36 @@ 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
 
-      @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'
-      @style = @helper.parameter_specified? 'style'
-      @wrapper_class = @helper.parameter_specified? 'wrapper_class'
-      @wrapper_style = @helper.parameter_specified? 'wrapper_style'
+      @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}'" : ''
@@ -55,6 +71,8 @@ module PreTagBlock
       @label ||= @helper.argv.join(' ')
 
       @logger.debug { "@make_copy_button = '#{@make_copy_button}'; @label = '#{@label}'" }
+
+      text = text.dedent if @dedent
       make_pre(text)
     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.1
+  version: 1.4.1
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-13 00:00:00.000000000 Z
+date: 2023-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -28,16 +28,30 @@ dependencies:
   name: jekyll_plugin_support
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.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.6.0
+        version: '0'
 description: 'Jekyll tags pre and noselect, for HTML <pre/> tag, prompts and unselectable
   text. Can number lines.
 
@@ -59,17 +73,18 @@ 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
-homepage: https://www.mslinn.com/jekyll/3000-jekyll-plugins.html#jekyll_pre
+homepage: https://www.mslinn.com/jekyll_plugins/jekyll_pre.html
 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/jekyll/3000-jekyll-plugins.html#jekyll_pre
+  homepage_uri: https://www.mslinn.com/jekyll_plugins/jekyll_pre.html
   source_code_uri: https://github.com/mslinn/jekyll_pre
 post_install_message: |2+
 
@@ -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