jekyll_flexible_include 2.0.9 → 2.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b71142b75599a60998290ed57afbe3231330bf42dba89c7f892e3e08e3eb07e2
-  data.tar.gz: e1cf42634742f63c2f6f44e4e800093003fbe9a01e47f12414c8876c9663f0d1
+  metadata.gz: c55ae38bb0ea6af18a3bff7de442e9c75229e3fca45991a15b5b0d829606e417
+  data.tar.gz: 6cba87719d81e829c0b3e68f9483d99b1daed9454c740b815d6c098c629ac003
 SHA512:
-  metadata.gz: 1456652118883acd55de272df6c00c8ce29c42031609282ffe95ff043c15f5c57f9f293d23490edf78267dc672408045018e69cb2edcd6be144cd214b180b9a4
-  data.tar.gz: 88a9c4d75a15fdd84980816a266fbfd12d6e1e81cfac041881393b33d015ddbcfad30c0a2d1e4ae7b5ea09048838a0fddfc7352db508a6520543b4cca67ab06a
+  metadata.gz: 9c470001c4f5e933c0ec122792f9bc6cccb34b0a7e20e6886875e5a5a41c8de64c6722347ff9cf5a6e586aef9859106d73ed90863cdb91fe89254beffd510294
+  data.tar.gz: a6e79fcb6d7eb7834b7de448d385940818870be9021454e3a8ef476fae4c2a90f0c944ba2f6d8d4d2ab5514a122adbe2629cfbc5af387e6681af2b8eff9f1fba

data/CHANGELOG.md

@@ -1,5 +1,18 @@
+## 2.0.13 / 2022-04-24
+  * Added `highlight` regex option, for highlighting
+  * Added `number` option, for numbered lines
+
+## 2.0.12 / 2022-04-22
+  * Exits with an error message if an environment variable included in the value of `FLEXIBLE_INCLUDE_PATHS` is undefined.
+
+## 2.0.11 / 2022-04-15
+  * Added & => & to the escaped characters
+
+## 2.0.10 / 2022-04-15
+  * Fixed nil pointer
+
 ## 2.0.9 / 2022-04-15
-  * Displays elapsed time to scan files; only scans when the gem is first used.
+  * Changed how path matching was implemented.
 
 ## 2.0.8 / 2022-04-14
   * Added the ability to restrict arbitrary command execution, and specify the allowable directories to read from.

data/README.md

@@ -37,6 +37,7 @@ Note that the [square brackets] merely indicate optional parameters and are not
 
 ### Options
   * `do_not_escape` includes the content without HTML escaping it.
+  * `highlight='regex pattern here'` wraps content matching the regex pattern within a `<span class='bg_yellow'></span>` tag.
   * `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`:

data/lib/flexible_include/version.rb

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

data/lib/flexible_include.rb

@@ -11,13 +11,16 @@ module JekyllFlexibleIncludeName
   PLUGIN_NAME = "flexible_include"
 end
 
+class FlexibleError < StandardError
+end
+
 class FlexibleInclude < Liquid::Tag
   FlexibleIncludeError = Class.new(Liquid::Error)
 
   @read_regexes = nil
 
   def self.normalize_path(path)
-    JekyllTagHelper.expand_env(path)
+    JekyllTagHelper.expand_env(path, die_if_undefined: true)
                    .gsub("~", Dir.home)
   end
 
@@ -27,7 +30,8 @@ class FlexibleInclude < Liquid::Tag
     @execution_denied = ENV['DISABLE_FLEXIBLE_INCLUDE']
 
     unless @read_regexes
-      read_paths = normalize_path(ENV['FLEXIBLE_INCLUDE_PATHS'])
+      flexible_include_paths = ENV['FLEXIBLE_INCLUDE_PATHS']
+      read_paths = normalize_path(flexible_include_paths) if flexible_include_paths
       if read_paths
         @read_regexes = read_paths.split(":").map do |path|
           abs_path = path.start_with?('/') ? path : (Pathname.new(Dir.pwd) + path).to_s
@@ -43,6 +47,20 @@ class FlexibleInclude < Liquid::Tag
     @read_regexes.find { |regex| regex.match(normalize_path(path)) }
   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
+
   # @param tag_name [String] the name of the tag, which we already know.
   # @param markup [String] the arguments from the tag, as a single string.
   # @param parse_context [Liquid::ParseContext] hash that stores Liquid options.
@@ -64,10 +82,12 @@ class FlexibleInclude < Liquid::Tag
     @do_not_escape = @helper.parameter_specified? "do_not_escape"
     @download = @helper.parameter_specified? "download"
     @dark = " dark" if @helper.parameter_specified?("dark")
+    @highlight_pattern = @helper.parameter_specified? "highlight"
     @label = @helper.parameter_specified? "label"
+    @number_lines = @helper.parameter_specified? "number"
     @label_specified = @label
     @copy_button = @helper.parameter_specified? "copyButton"
-    @pre = @copy_button || @dark || @download || @label_specified || @helper.parameter_specified?("pre") # Download or label implies pre
+    @pre = @copy_button || @dark || @download || @label_specified || @number_lines || @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
@@ -116,6 +136,10 @@ class FlexibleInclude < Liquid::Tag
     "<p style='color: white; background-color: red; padding: 2pt 1em 2pt 1em;'>#{msg}</p>"
   end
 
+  def highlight(content, pattern)
+    content.gsub(Regexp::new(pattern), "<span class='bg_yellow'>\\0</span>")
+  end
+
   def read_file(file)
     File.read(file)
   end
@@ -129,6 +153,8 @@ class FlexibleInclude < Liquid::Tag
   def render_completion(path, contents)
     contents ||= read_file(path)
     contents2 = @do_not_escape ? contents : JekyllTagHelper.escape_html(contents)
+    contents2 = highlight(contents2, @highlight_pattern) if @highlight_pattern
+    contents2 = FlexibleInclude.number_content(contents2) if @number_lines
     @pre ? wrap_in_pre(path, contents2) : contents2
   end
 

data/lib/jekyll_tag_helper.rb

@@ -7,12 +7,19 @@ class JekyllTagHelper
   attr_reader :argv, :liquid_context, :logger, :params, :tag_name
 
   def self.escape_html(string)
-    string.gsub("{", "&#123;").gsub("}", "&#125;").gsub("<", "&lt;")
+    string.gsub("&", "&amp;")
+          .gsub("{", "&#123;")
+          .gsub("}", "&#125;")
+          .gsub("<", "&lt;")
   end
 
   # Expand a environment variable reference
-  def self.expand_env(str)
-    str.gsub(/\$([a-zA-Z_][a-zA-Z0-9_]*)|\${\g<1>}|%\g<1>%/) { ENV[Regexp.last_match(1)] }
+  def self.expand_env(str, die_if_undefined=false)
+    str.gsub(/\$([a-zA-Z_][a-zA-Z0-9_]*)|\${\g<1>}|%\g<1>%/) do
+      envar = Regexp.last_match(1)
+      raise FlexibleError, "flexible_include error: #{envar} is undefined".red, [] if !ENV.key?(envar) && die_if_undefined # Suppress stack trace
+      ENV[envar]
+    end
   end
 
   # strip leading and trailing quotes if present

metadata

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