jekyll_pre 1.1.4 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be2fcd1765446ab64973e355acb073057dea3c98ed1be553362b5b755e5453fb
-  data.tar.gz: 33b14de234b5764673af3c9380d6ae32fa5a429294f7ee5f53d094aa63bf1f87
+  metadata.gz: a3eced8ae5430c67a303f08c90a38caf16c46efbad4e11232aa95ed9580c2f98
+  data.tar.gz: 9370b4fab76dc5ba5487c0d0876907ed9366d0f1e777e63ca8250121a9a32533
 SHA512:
-  metadata.gz: 46fcc4e0dcab10f27bfc9f8fa408e84e5d5c3c19f926d1de51167b39754740a2a4a3af2a17ca4c4f8dc2bf25011283205137c7afa9d144abb67ee6c2479276a5
-  data.tar.gz: c39c5e30e3386d1eeb3029d7cf31ab159fcb8b32fb3b72fa5f03d5af8269daa30b7cf308e0bdbf1905180a468f88b2e7b00ab1e440daf75ba5ee96987bc1a727
+  metadata.gz: 7fc327f37d0c5dc7f54ba78837984a05603ae24bbdee5e888eebdb01bc8d377ecd08bbc4b18a68c97a9bd3f1272f359cb8da53ee7a2143938793d5dca298fb31
+  data.tar.gz: 656acb136598d957e9b129a2ebd71cfb905f63191c6c0c09eb0565c9070c71d5790b1319289b6ac70d71f15b8710a1af5e693240102f10f5c4ecce0068784252

data/.rubocop.yml

@@ -1,6 +1,6 @@
-require: rubocop-jekyll
-inherit_gem:
-  rubocop-jekyll: .rubocop.yml
+# require: rubocop-jekyll
+# inherit_gem:
+#   rubocop-jekyll: .rubocop.yml
 
 AllCops:
   Exclude:

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.1.5
+  * Added `class` and `style` options to allow for specifying additional CSS classes and inline CSS
+  * Added `clear` option to ensure no images overlap the pre output
+
 ## 1.1.4
   * Added `highlight` regex option
   * Now using `lib/jekyll_tag_helper.rb` to parse markup

data/jekyll_pre.gemspec

@@ -39,10 +39,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "key-value-parser"
   spec.add_dependency "shellwords"
 
-  spec.add_development_dependency "debase"
+  # spec.add_development_dependency "debase"
   # spec.add_development_dependency "rubocop-jekyll"
   # spec.add_development_dependency "rubocop-rake"
   # spec.add_development_dependency "rubocop-rspec"
-  spec.add_development_dependency "ruby-debug-ide"
+  # spec.add_development_dependency "ruby-debug-ide"
 end
 # rubocop:enable Metrics/BlockLength

data/lib/jekyll_pre/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllPreVersion
-  VERSION = "1.1.4"
+  VERSION = "1.1.5"
 end

data/lib/jekyll_pre.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require "liquid"
-require "jekyll_plugin_logger"
+require 'liquid'
+require 'jekyll_plugin_logger'
 require 'key_value_parser'
-require "shellwords"
-require_relative "jekyll_pre/version"
-require_relative "jekyll_tag_helper"
+require 'shellwords'
+require_relative 'jekyll_pre/version'
+require_relative 'jekyll_tag_helper'
 
 module JekyllPluginPreName
-  PLUGIN_NAME = "jekyll_pre"
+  PLUGIN_NAME = 'jekyll_pre'
 end
 
 # """
@@ -37,36 +37,46 @@ class PreTagBlock < Liquid::Block
              "alt='Copy to clipboard' style='width: 13px'></button>"
 
   def self.highlight(content, pattern)
-    content.gsub(Regexp::new(pattern), "<span class='bg_yellow'>\\0</span>")
+    content.gsub(Regexp.new(pattern), "<span class='bg_yellow'>\\0</span>")
   end
 
   def self.make_copy_button(pre_id)
     "#{@@prefix}'##{pre_id}'#{@@suffix}"
   end
 
-  def self.make_pre(make_copy_button, number_lines, label, dark, highlight_pattern, content) # rubocop:disable Metrics/ParameterLists
-    dark_label = " darkLabel" if dark
+  def self.make_pre(make_copy_button, number_lines, label, dark, highlight_pattern, css_class, style, clear, content) # rubocop:disable Metrics/ParameterLists, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
+    pre_clear = label_clear = ''
+    if clear
+      if label.to_s.empty?
+        pre_clear = ' clear'
+      else
+        label_clear = ' clear'
+      end
+    end
+    css_class = css_class ? " #{css_class}" : ''
+    style = style ? " style='#{style}'" : ''
+    dark_label = ' darkLabel' if dark
     label = if label.to_s.empty?
-              ""
-            elsif label.to_s.downcase.strip == "shell"
-              "<div class='codeLabel unselectable#{dark_label}' data-lt-active='false'>Shell</div>"
+              ''
+            elsif label.to_s.downcase.strip == 'shell'
+              "<div class='codeLabel unselectable#{dark_label}#{label_clear}' data-lt-active='false'>Shell</div>"
             else
-              "<div class='codeLabel unselectable#{dark_label}' data-lt-active='false'>#{label}</div>"
+              "<div class='codeLabel unselectable#{dark_label}#{label_clear}' data-lt-active='false'>#{label}</div>"
             end
     pre_id = "id#{SecureRandom.hex(6)}"
-    copy_button = make_copy_button ? PreTagBlock.make_copy_button(pre_id) : ""
+    copy_button = make_copy_button ? PreTagBlock.make_copy_button(pre_id) : ''
     content = PreTagBlock.highlight(content, highlight_pattern) if highlight_pattern
     content = PreTagBlock.number_content(content) if number_lines
-    "#{label}<pre data-lt-active='false' class='maxOneScreenHigh copyContainer#{dark}' id='#{pre_id}'>#{copy_button}#{content.strip}</pre>"
+    "#{label}<pre data-lt-active='false' class='maxOneScreenHigh copyContainer#{dark}#{pre_clear}#{css_class}'#{style} id='#{pre_id}'>#{copy_button}#{content.strip}</pre>"
   end
 
-  def self.number_content(content)
+  def self.number_content(content) # rubocop:disable Metrics/MethodLength
     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, " ")
+      number = i.to_s.rjust(digits, ' ')
       "<span class='unselectable numbered_line'> #{number}: </span>#{line}"
     end
     result = numbered_content.join("\n")
@@ -84,7 +94,7 @@ class PreTagBlock < Liquid::Block
   # @return [void]
   def initialize(_tag_name, markup, _tokens)
     super
-    markup = "" if markup.nil?
+    markup = '' if markup.nil?
     markup.strip!
 
     @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
@@ -94,21 +104,24 @@ class PreTagBlock < Liquid::Block
   # Method prescribed by the Jekyll plugin lifecycle.
   # @param liquid_context [Liquid::Context]
   # @return [String]
-  def render(liquid_context)
+  def render(liquid_context) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     content = super
     @helper.liquid_context = liquid_context
 
-    @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"
-    @label = @helper.parameter_specified? "label"
+    @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'
+    @label = @helper.parameter_specified? 'label'
+    @style = @helper.parameter_specified?('style')
 
     # If a label was specified, use it, otherwise concatenate any dangling parameters and use that as the label
-    @label ||= @helper.params.join(" ")
+    @label ||= @helper.params.join(' ')
 
     @logger.debug { "@make_copy_button = '#{@make_copy_button}'; @label = '#{@label}'" }
-    PreTagBlock.make_pre(@make_copy_button, @number_lines, @label, @dark, @highlight, content)
+    PreTagBlock.make_pre(@make_copy_button, @number_lines, @label, @dark, @highlight, @class, @style, @clear, content)
   end
 end
 
@@ -124,7 +137,7 @@ class UnselectableTag < Liquid::Tag
     @logger = PluginMetaLogger.instance.new_logger(self)
 
     @markup = markup
-    @markup = "$ " if @markup.nil? || @markup.empty?
+    @markup = '$ ' if @markup.nil? || @markup.empty?
     @logger.debug { "UnselectableTag: markup= '#{@markup}'" }
   end
 
@@ -134,5 +147,5 @@ class UnselectableTag < Liquid::Tag
 end
 
 PluginMetaLogger.instance.info { "Loaded #{JekyllPluginPreName::PLUGIN_NAME} v#{JekyllPreVersion::VERSION} plugin." }
-Liquid::Template.register_tag("pre", PreTagBlock)
-Liquid::Template.register_tag("noselect", UnselectableTag)
+Liquid::Template.register_tag('pre', PreTagBlock)
+Liquid::Template.register_tag('noselect', UnselectableTag)

data/lib/jekyll_tag_helper.rb

@@ -1,23 +1,25 @@
 # frozen_string_literal: true
 
-require "shellwords"
+require 'shellwords'
 require 'key_value_parser'
 
+# Parses arguments and options
 class JekyllTagHelper
   attr_reader :argv, :liquid_context, :logger, :params, :tag_name
 
   def self.escape_html(string)
-    string.gsub("&", "&")
-          .gsub("{", "{")
-          .gsub("}", "}")
-          .gsub("<", "&lt;")
+    string.gsub('&', '&amp;')
+          .gsub('{', '&#123;')
+          .gsub('}', '&#125;')
+          .gsub('<', '&lt;')
   end
 
   # Expand a environment variable reference
-  def self.expand_env(str, die_if_undefined=false)
+  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
@@ -67,7 +69,7 @@ class JekyllTagHelper
     value = @liquid_context[name] # Finds variables named like 'include.my_variable', found in @liquid_context.scopes.first
     value ||= @page[name] if @page # Finds variables named like 'page.my_variable'
     value ||= dereference_include_variable(name)
-    value ||= ""
+    value ||= ''
     value
   end
 
@@ -79,9 +81,9 @@ class JekyllTagHelper
 
   def lookup_variable(symbol)
     string = symbol.to_s
-    return string unless string.start_with?("{{") && string.end_with?("}}")
+    return string unless string.start_with?('{{') && string.end_with?('}}')
 
-    dereference_variable(string.delete_prefix("{{").delete_suffix("}}"))
+    dereference_variable(string.delete_prefix('{{').delete_suffix('}}'))
   end
 
   def page

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_pre
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.5
 platform: ruby
 authors:
 - Mike Slinn
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-24 00:00:00.000000000 Z
+date: 2022-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -66,38 +66,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: debase
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: ruby-debug-ide
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  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.
 
-'
+  '
 email:
 - mslinn@mslinn.com
 executables: []
@@ -143,8 +115,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Jekyll tags pre and noselect, for HTML <pre/> tag, prompts and unselectable
   text. Can number lines.
@@ -152,3 +124,4 @@ test_files:
 - spec/pre_spec.rb
 - spec/spec_helper.rb
 - spec/status_persistence.txt
+...