jekyll_flexible_include 2.0.6 → 2.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fed2067800a2324df252ff3e8cfd48b21c9cb3754e5e5b474d135ebb307cd8bf
-  data.tar.gz: abbf8f05f739832f259d9cb16d16d552ae18ee3da17a5bf8a77cae933cdb9b76
+  metadata.gz: 38eeb054b62e4c999437208ce95cb7291174167839d344db3df48670954b32ef
+  data.tar.gz: '0962b93b74c28d6521c655cea29f0646c11051d8f3ddaf690618b9ed91e7276b'
 SHA512:
-  metadata.gz: b33745dc685acc809658f6ad42efaea735747c5b6816653e10ae56e5f001f957e0f13959d3e1cffe954d2ba8270309277a322568d8536864d9fc055938e00c48
-  data.tar.gz: c6926ffab7a700d4ef884237c0f606ed053d32e66ac97472458cc09102875df883d1cc656c55dfb6a769bc094ae7447abe6e2057bebfb9a74f6e183c57d2e625
+  metadata.gz: 2e3ec9a8c269bda135c245a54b995abd6f2229658190a5f89e1bad97372e85f4a37af7c7227cbaa8b518f1ae90a6b70ecc3f0f9c881859329fdf241123047ca6
+  data.tar.gz: b8f6497ee5505ac0f43f28a6c9d0bb639be7b7c2bc712375f8ae6774522ccaae6ecd0108be1bdcb0d72cb1656e0b1a268ffa52d3feb675722295aca6c698961d

data/CHANGELOG.md

@@ -1,12 +1,17 @@
+## 2.0.7 / 2022-04-14
+  * Added `file=` option, so the included file or process is better defined. This option is not required; the file/process can be specified without it as before.
+  * Documented `data-lt-active="false"`.
+  * Added `dark` option, and [provided CSS](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#pre_css).
+
 ## 2.0.6 / 2022-04-11
   * Niggling little bug thing. Gone.
 
 ## 2.0.5 / 2022-04-11
-  * Now using <code>Shellwords</code> and <code>KeyValueParser</code> instead of a homegrown parser.
+  * Now using `Shellwords` and `KeyValueParser` instead of a homegrown parser.
   * Refactored helper methods to jekyll_tag_helper.rb
   * Looks up values for liquid variable references from several scopes.
   * Suppresses stack dump when an error occurs.
-  * Deleted a lot of old cruft.
+  * Deleted a lot of old cruft. Virtually none of the original code remains.
   * Added pre, label and copy_button optional parameters
 
 ## 2.0.4 / 2022-04-05

data/README.md

@@ -22,6 +22,7 @@ This plugin supports 4 types of includes:
 In addition, filenames that require environment expansion because they contain a <code>$</code> character are
 expanded according to the environment variables defined when <code>jekyll build</code> executes.
 
+
 ### Syntax
 The following are equivalent:
 ```
@@ -36,18 +37,18 @@ Note that the [square brackets] merely indicate optional parameters and are not
 
 ### Options
   * `do_not_escape` includes the content without HTML escaping it.
-  * `pre` causes the included file to be wrapped inside a &lt;pre>&lt;/pre> tag, no label is generated.
+  * `pre` causes the included file to be wrapped inside a &lt;pre>&lt;/pre> tag, no label is generated. The &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.
 
 The following options imply `pre`:
+  * `dark` applies the `dark` class to the generated &lt;pre>&lt;/pre> tag.
+    You can define the `dark` and `darkLabel` classes as desired.
+    [This CSS is a good starting point.](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#pre_css)
   * `download` uses the name of the file as a label, and displays it above the &lt;pre>&lt;/pre> tag. Clicking the label causes the file to be downloaded.
   * `copy_button` draws an icon at the top right of the &lt;pre>&lt;/pre> tag that causes the included contents to be copied to the clipboard.
   * `label` specifies that an automatically generated label be placed above the contents. There is no need to specify this option if `download` or `copy_button` options are provided.
   * `label="blah blah"` specifies a label for the contents; this value overrides the default label. The value can be enclosed in single or double quotes.
 
 
-### Additional Information
-More information is available on my web site about [my Jekyll plugins](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).
-
 
 ## Installation
 

data/lib/flexible_include/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllFlexibleIncludePluginVersion
-  VERSION = "2.0.6"
+  VERSION = "2.0.7"
 end

data/lib/flexible_include.rb

@@ -27,15 +27,17 @@ class FlexibleInclude < Liquid::Tag
   end
 
   # @param liquid_context [Liquid::Context]
-  def render(liquid_context) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity
+  def render(liquid_context) # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/MethodLength, Metrics/CyclomaticComplexity
     @helper.liquid_context = liquid_context
     @do_not_escape = @helper.parameter_specified? "do_not_escape"
     @download = @helper.parameter_specified? "download"
+    @dark = " dark" if @helper.parameter_specified?("dark")
     @label = @helper.parameter_specified? "label"
     @label_specified = @label
     @copy_button = @helper.parameter_specified? "copyButton"
-    @pre = @copy_button || @download || @label_specified || @helper.parameter_specified?("pre") # Download or label implies pre
-    filename = @helper.params.first # Do this after all options have been checked for
+    @pre = @copy_button || @dark || @download || @label_specified || @helper.parameter_specified?("pre") # Download or label implies pre
+    filename = @helper.parameter_specified? "file"
+    filename ||= @helper.params.first # Do this after all options have been checked for
     @label ||= filename
 
     # If a label was specified, use it, otherwise concatenate any dangling parameters and use that as the label
@@ -53,7 +55,7 @@ class FlexibleInclude < Liquid::Tag
       path = File.join(ENV['HOME'], filename)
       @logger.debug { "User home end filename=#{filename}, path=#{path}" }
     when /\A!/ # Run command and return response
-      filename = JekyllTagHelper.remove_quotes(@helper.argv.first)
+      filename = JekyllTagHelper.remove_quotes(@helper.argv.first) if @helper.argv.first
       filename.slice! "!"
       contents = run(filename)
     else # Relative path
@@ -107,9 +109,10 @@ class FlexibleInclude < Liquid::Tag
                     end
     pre_id = "id#{SecureRandom.hex 6}"
     copy_button = @copy_button ? "#{PREFIX}'##{pre_id}'#{SUFFIX}" : ""
+    dark_label = " darkLabel" if @dark
     <<~END_PRE
-      <div class="codeLabel">#{label_or_href}</div>
-      <pre data-lt-active="false" class="maxOneScreenHigh copyContainer" id="#{pre_id}">#{copy_button}#{content}</pre>
+      <div class="codeLabel#{dark_label}">#{label_or_href}</div>
+      <pre data-lt-active="false" class="maxOneScreenHigh copyContainer#{@dark}" id="#{pre_id}">#{copy_button}#{content}</pre>
     END_PRE
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_flexible_include
 version: !ruby/object:Gem::Version
-  version: 2.0.6
+  version: 2.0.7
 platform: ruby
 authors:
 - Mike Slinn
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-13 00:00:00.000000000 Z
+date: 2022-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll