jekyll_pre 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cc10df37a945ecc8abddce501dd71a176084b9fafdde6e3aa6a48e18c7e4551
-  data.tar.gz: 73fe925e47914475d889e814cae15f8c8331ed7abf2498aaf0a207fd2e0bf7d9
+  metadata.gz: f765cdcaf2d5447e9e05c49f02aa47b59feba53ba9dab4133a05eaa35f415555
+  data.tar.gz: 2b742223bfd91ce5dc8349a8dd5a09e8c678890dbb338a347ac2c463d3db9f1d
 SHA512:
-  metadata.gz: 76a1487e85b498708d27a2258fce364703fe2613253eff69e80475b22303f81f519a8bcedb14671fd62179d53521c80ca9c47d859e838d2bb43060ef58adc236
-  data.tar.gz: 59edd4611b9d6553096d76ce57d518a4e6dd670d2e7f236cfa6ae000c34b269584ecf318705db9bd68d32d9da42590ff71628a7a122107dca8d8e2057e048900
+  metadata.gz: f4c15e15ee8390c7c429ce94f5913063d16804a2a61be225d66d1186406995eeed6a326e16fe438efac8dcf266f2e649888aec4c3d581fc10217098d1cbea3b9
+  data.tar.gz: 7ae60210e08f23519765d3c1064761838f448e4e04f4dd03f8965361b5243d0cbfa543665370b918bbc4e188c97a3ec96b400d884b7c543d39b1b722afffead5

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 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.

data/README.md

@@ -59,6 +59,49 @@ 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,
@@ -94,6 +137,24 @@ pre:
 ```
 
 
+#### 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
 [Mike Slinn’s website](https://www.mslinn.com/jekyll_plugins/jekyll_pre.html).
@@ -262,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 %}
 ```
 
@@ -271,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 %}
 ```
 
@@ -280,7 +341,7 @@ The following executes `echo $USER` and displays the output.
 
 ```
 {% pre clear copyButton label='Exec display $USER' %}
-{% noselect %}{% exec die_if_nonzero=false echo $USER %}
+{% noselect %}{% exec die_if_nonzero='false' echo $USER %}
 {% endpre %}
 ```
 

data/jekyll_pre.gemspec

@@ -11,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',
@@ -33,6 +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

@@ -33,7 +33,7 @@ module JekyllPreModule
 
       response = run_command(command)
       response = if @child_status.success?
-                   ExecTagModule.compress(response, @no_strip)
+                   JekyllPreModule.compress(response, @no_strip)
                  else
                    handle_error(command)
                  end

data/lib/jekyll_pre/version.rb

@@ -1,3 +1,3 @@
 module JekyllPreVersion
-  VERSION = '1.4.0'.freeze
+  VERSION = '1.4.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_pre
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-21 00:00:00.000000000 Z
+date: 2023-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -28,16 +28,16 @@ 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.6.0
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -77,14 +77,14 @@ files:
 - 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+