jekyll_plugin_support 3.1.5 → 3.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d4f6b9106ad6c0ac015ac96af510e4f284d01de3296b29f815cfe74a14dd249
-  data.tar.gz: aa2ff95dfa6366d6c1b06e6fe7689d34131bf699e17a8ce05090fe1df836ceb8
+  metadata.gz: 0e9e668968a611289735fbb49845ac930d027015d4c385295e78722f85cf40cf
+  data.tar.gz: b2cc67846dd969875cf3fa62cba74adfbe10ed86b9607077054e63c07ac890e8
 SHA512:
-  metadata.gz: 629abbd99fb59ca3c741d623bc34248377c65744209a2f2b06b27b030aaaa8fba616e92db61494474ac2810674deb49aafd5ef006761e2fcc05380ecf733de80
-  data.tar.gz: bc8b36722bf0a033231a7b60f1cc70de4c354b898c4ab45ea99aaabe6a8cb70886550fb4bde13524ac741a789824178c76bfdfcd3dcd33cb79d854cfe87a6025
+  metadata.gz: 831f38b469c65ef2e2332f18b1624ce06626322643939e3bc497f513c24092070b7ac96664f0a6a63f323f8058141f7c6159966ed23fb76741f807d53d5ffef5
+  data.tar.gz: fe06519f62fb7a42cdbba80752cd12a85ad2f1458fa18a2318bb758d75d6c02a65739f62096f6bda3077947588da88398aa6b7cb644346438b35c905b963ee43

data/.rubocop.yml

@@ -107,6 +107,9 @@ Style/GlobalVars:
   Exclude:
     - spec/mslinn_binary_search_spec.rb
 
+Style/OneClassPerFile:
+  Enabled: false
+
 Style/RedundantParentheses:
   Exclude:
     - README.md

data/CHANGELOG.md

@@ -1,9 +1,15 @@
 # Change Log
 
+## 3.1.6
+
+Several little fixes and tweaks.
+
+
 ## 3.1.5
 
 * Added install subcommand to bundle invocations
-* Replaced wslvar which is no longer maintained
+* Replaced `wslvar` which is no longer maintained
+
 
 ## 3.1.4
 

data/FIXME.md

@@ -0,0 +1,49 @@
+# Code Smells in `jekyll_plugin_support`
+
+A review of the codebase turned up the issues below. They are ordered by
+severity. Line numbers refer to the state of the repo at the time of review and
+may drift.
+
+## Medium severity
+
+### 6. Duplication between `JekyllTag` and `JekyllBlock`
+
+`render`, `initialize`, and `set_error_context` are ~90% identical across
+`lib/tag/jekyll_plugin_support_tag.rb` and
+`lib/block/jekyll_plugin_support_block.rb`. The block version even logs
+`e.full_message` **twice** (lines 89 and 93). Extract a shared
+`JekyllPluginBase` module.
+
+
+### 12. `parse` has a leftover TODO and dead branch
+
+```ruby
+@params_original = @keys_values_original unless respond_to?(:no_arg_parsing) && no_arg_parsing
+...
+@params = @keys_values # TODO: @keys_values should be deleted
+```
+
+The conditional on `@params_original` is moot because `reinitialize` only calls
+`parse` when `!@no_arg_parsing`. And the TODO has lingered.
+(`lib/helper/jekyll_plugin_helper.rb:91-106`)
+
+## Lower severity
+
+### 17. Comment typos / placeholder text in docs
+
+`@ptions` appears in the parse_context doc block of *both* tag and block files
+(should be `@options`). Comments like `# Are error and logger.error defined?`
+(`lib/jekyll_plugin_support/jekyll_plugin_support_class.rb:18`) read like
+unanswered questions left in production.
+
+### 20. `_` prefixed unused param but still required
+
+`dump_vars(_logger, liquid_context)` — the `_` prefix says "unused," but callers
+must still pass it. Either drop the parameter or use it.
+(`lib/jekyll_plugin_support/jekyll_plugin_support_class.rb:30`)
+
+
+## Suggested order to tackle
+
+1. **Extract shared base for `JekyllTag`/`JekyllBlock` (#6)** — biggest maintainability win.
+3. Remove dead/commented code (#4).

data/jekyll_plugin_support.gemspec

@@ -34,6 +34,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'jekyll', '>= 4.4.1'
   spec.add_dependency 'jekyll_plugin_logger'
   spec.add_dependency 'key-value-parser'
-  spec.add_dependency 'pry'
   spec.add_dependency 'sorted_set'
 end

data/lib/block/jekyll_plugin_support_block.rb

@@ -1,7 +1,8 @@
 module JekyllSupport
   # Base class for Jekyll block tags
   class JekyllBlock < Liquid::Block
-    attr_reader :argument_string, :helper, :highlighter_prefix, :highlighter_suffix, :jekyll_version, :line_number, :logger, :page, :raw_content, :site, :text
+    attr_reader :argument_string, :helper, :highlighter_prefix, :highlighter_suffix, :jekyll_version, :line_number, :logger, :page, :raw_content,
+                :site, :text
 
     # See https://github.com/Shopify/liquid/wiki/Liquid-for-Programmers#create-your-own-tags
     # @param tag_name [String] the name of the tag, which we usually know.
@@ -79,10 +80,6 @@ module JekyllSupport
       @attribution = @helper.parameter_specified?('attribution') || false unless @no_arg_parsing
       @logger.debug { "@keys_values='#{@keys_values}'" }
 
-      # @argument_string = JekyllSupport.lookup_liquid_variables @logger, liquid_context, @argument_string # Is this redundant?
-      # @argument_string.strip! # Is this redundant?
-      # @helper.reinitialize @argument_string # Is this redundant?
-
       render_impl(text)
     rescue StandardError => e
       e.shorten_backtrace
@@ -91,7 +88,7 @@ module JekyllSupport
       in_file_name = "in '#{file_name}' " if file_name
       of_page = "of '#{@page['path']}'" if @page
       @logger.error { "While processing line #{@line_number} #{of_page} for #{tag_name} #{in_file_name}- #{e.message}" }
-      binding.pry if @pry_on_standard_error # rubocop:disable Lint/Debugger
+      binding.pry if @pry_on_standard_error && defined?(Pry) # rubocop:disable Lint/Debugger
       raise e if @die_on_standard_error
 
       <<~END_MSG

data/lib/block/jekyll_plugin_support_block_noarg.rb

@@ -1,7 +1,5 @@
 module JekyllSupport
   class JekyllBlockNoArgParsing < JekyllBlock
-    attr_reader :argument_string, :helper, :line_number, :logger, :page, :site
-
     def initialize(tag_name, argument_string, parse_context)
       class << self
         include NoArgParsing

data/lib/error/jekyll_custom_error.rb

@@ -42,12 +42,8 @@ module JekyllSupport
       END_MSG
     end
 
-    def shorten_backtrace(backtrace_element_count = 6)
-      set_backtrace backtrace[0..backtrace_element_count]
-      # b = backtrace[0..backtrace_element_count - 1].map do |x|
-      #   x.gsub(Dir.pwd + '/', './')
-      # end
-      # set_backtrace b
+    def shorten_backtrace(backtrace_element_count = 5)
+      set_backtrace backtrace.first(backtrace_element_count)
     end
   end
 end

data/lib/helper/jekyll_plugin_helper.rb

@@ -27,7 +27,7 @@ module JekyllSupport
 
     # @return undefined if parameter was specified, removes it from the available tokens and returns value
     def parameter_specified?(name, delete_param: true)
-      return false if @keys_values.to_s.empty?
+      return false if @keys_values.empty?
 
       key = name
       key = name.to_sym if @keys_values&.first&.first.instance_of?(Symbol)

data/lib/jekyll_plugin_support/jekyll_plugin_support_class.rb

@@ -1,12 +1,7 @@
-# Monkey patch StandardError so a new method called shorten_backtrace is added.
 class StandardError
   def shorten_backtrace(backtrace_element_count = 5)
-    set_backtrace backtrace[0..backtrace_element_count]
-    # self.backtrace = backtrace[0..backtrace_element_count].map do |x|
-    #   raise JekyllPluginSupportError, "backtrace contains a #{x.class} with value '#{x}'." unless x.instance_of? String
-
-    #   x.gsub(Dir.pwd + '/', './')
-    # end
+    limit = [backtrace.size - 1, backtrace_element_count].min
+    set_backtrace(backtrace[0..limit])
   end
 end
 
@@ -131,7 +126,7 @@ module JekyllSupport
     layout&.each do |name, value|
       if value.nil?
         value = ''
-        logger.warn { "layout.#{value} is undefined." }
+        logger.warn { 'layout.value is undefined.' }
       end
       markup.gsub!("{{layout.#{name}}}", value.to_s)
     end

data/lib/jekyll_plugin_support/version.rb

@@ -1,3 +1,3 @@
 module JekyllPluginSupportVersion
-  VERSION = '3.1.5'.freeze unless defined?(VERSION)
+  VERSION = '3.1.6'.freeze unless defined?(VERSION)
 end

data/lib/jekyll_plugin_support.rb

@@ -1,5 +1,5 @@
 def require_directory(dir)
-  Dir[File.join(dir, '*.rb')]&.sort&.each do |file|
+  Dir[File.join(dir, '*.rb')].each do |file|
     require file unless file == __FILE__
   end
 end
@@ -7,7 +7,6 @@ end
 require 'colorator'
 require 'jekyll'
 require 'jekyll_plugin_logger'
-require 'pry'
 require 'sorted_set'
 
 # require_directory __dir__
@@ -21,16 +20,9 @@ require_directory "#{__dir__}/tag"
 require_directory "#{__dir__}/jekyll_all_collections"
 require_directory "#{__dir__}/hooks"
 
-module JekyllSupport
-  def self.redef_without_warning(const, value)
-    send(:remove_const, const) if const_defined?(const)
-    const_set const, value
-  end
-end
-
 module ToString
   def to_s
-    "#{self}.class.name"
+    self.class.name
   end
 end
 
@@ -41,6 +33,11 @@ module NoArgParsing
 end
 
 module JekyllSupport
+  def self.redef_without_warning(const, value)
+    send(:remove_const, const) if const_defined?(const)
+    const_set const, value
+  end
+
   class JekyllTag
     include JekyllSupportError
     include ToString

data/lib/tag/jekyll_plugin_support_tag.rb

@@ -1,7 +1,8 @@
 module JekyllSupport
   # Base class for Jekyll tags
   class JekyllTag < Liquid::Tag
-    attr_reader :argument_string, :helper, :highlighter_prefix, :highlighter_suffix, :jekyll_version, :line_number, :logger, :page, :raw_content, :site
+    attr_reader :argument_string, :helper, :highlighter_prefix, :highlighter_suffix, :jekyll_version, :line_number,
+                :logger, :page, :raw_content, :site
 
     # See https://github.com/Shopify/liquid/wiki/Liquid-for-Programmers#create-your-own-tags
     # @param tag_name [String] the name of the tag, which we usually know.
@@ -69,10 +70,6 @@ module JekyllSupport
       @argument_string = JekyllSupport.lookup_liquid_variables @logger, @helper.liquid_context, @argument_string.to_s.strip
       @helper.reinitialize @argument_string.to_s.strip
 
-      # @argument_string = JekyllSupport.lookup_liquid_variables @logger, liquid_context, @argument_string # Is this redundant?
-      # @argument_string.strip! # Is this redundant?
-      # @helper.reinitialize @argument_string # Is this redundant?
-
       render_impl
     rescue StandardError => e
       e.shorten_backtrace
@@ -80,7 +77,7 @@ module JekyllSupport
       in_file_name = "in '#{file_name}' " if file_name
       of_page = "of '#{@page['path']}'" if @page
       @logger.error { "#{e.class} on line #{@line_number} #{of_page} while processing #{tag_name} #{in_file_name}- #{e.message}" }
-      binding.pry if @pry_on_standard_error # rubocop:disable Lint/Debugger
+      binding.pry if @pry_on_standard_error && defined?(Pry) # rubocop:disable Lint/Debugger
       raise e if @die_on_standard_error
 
       <<~END_MSG

data/lib/tag/jekyll_plugin_support_tag_noarg.rb

@@ -1,7 +1,5 @@
 module JekyllSupport
   class JekyllTagNoArgParsing < JekyllTag
-    attr_reader :argument_string, :helper, :line_number, :logger, :page, :site
-
     def initialize(tag_name, argument_string, parse_context)
       class << self
         include NoArgParsing

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_plugin_support
 version: !ruby/object:Gem::Version
-  version: 3.1.5
+  version: 3.1.6
 platform: ruby
 authors:
 - Mike Slinn
@@ -79,20 +79,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  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'
 - !ruby/object:Gem::Dependency
   name: sorted_set
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +102,7 @@ files:
 - ".rubocop.yml"
 - ATTIBUTION_NOTES.md
 - CHANGELOG.md
+- FIXME.md
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -182,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.11
+rubygems_version: 4.0.19
 specification_version: 4
 summary: Provides a framework for writing and testing Jekyll plugins
 test_files: