jekyll_plugin_support 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 522c54334332d7fda1dc57bfa90647d419f458ff6153a7afe8bc8a60b0be7bca
-  data.tar.gz: 6ce396d28eefd925fa8a7a367fbca3991b2ca3625b85c0720bc9eb295a107b03
+  metadata.gz: 4efc790e49d3b2d98eb4e96bee8c75a18df25fcf7c08d66a44ef96d7c6db19c6
+  data.tar.gz: 6629e04d2170911427e4914c0d356e3f9c95149b7a673b2638242ba43cbe11fa
 SHA512:
-  metadata.gz: 65ca01eb7f2a017675220b352ee4f041a87df21cf435ca280acb19e512c547f68004be72e9f8dcd51aaad099a1beaefc3544261a63eae0f44fc9b8a5e636f58a
-  data.tar.gz: 1049865b366c17bdc3b4d6b2e88e9826e3dfa849ff6b35f03b65b5c6d9b4367ccfe0477a4497ffab2cfea3e3210512ae2d8bf163f71450a05e5c5963d5960883
+  metadata.gz: 5afd0123f178c5fe89ddbfbf55e48a63630a3ebdffe07b28b60e6ba5d0df0ee1c7f6c5b4dc25ca0c77c5e0fe4329a46cf9902585cadbcc9ea90fed032dc4b459
+  data.tar.gz: fd6cb95f84f50655b12e81a069a6cdf85ec265f244159b200909ec9d7c8559871c4a781ddf162b10dd9a53eefb07614ed7cec172877130a52e2859a306df0512

data/.rubocop.yml

@@ -30,7 +30,7 @@ Layout/LineLength:
   Max: 150
 
 Metrics/AbcSize:
-  Max: 45
+  Max: 55
 
 Metrics/BlockLength:
   Exclude:
@@ -64,6 +64,9 @@ RSpec/IndexedLet:
 RSpec/MultipleExpectations:
   Max: 15
 
+Style/ClassVars:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 0.8.1 / 2023-12-10
+
+* Added the `JekyllPluginHelper.remove_html_tags` method.
+
+
 ## 0.8.0 / 2023-11-14
 
 * Restructured for better support of Liquid variables.

data/lib/jekyll_custom_error.rb

@@ -0,0 +1,55 @@
+require 'facets/string/camelcase'
+require 'facets/string/snakecase'
+
+module Jekyll
+  # Use like this:
+  # CustomError.new(:MyError, 'blah', 'asdf')
+  class CustomError < StandardError
+    def self.factory(name)
+      return if Object.const_defined? name
+
+      puts "Defining #{name}".yellow
+      eval "#{name} = Class.new Jekyll::CustomError" # rubocop:disable Style/EvalWithLocation, Security/Eval
+    end
+
+    def error_name
+      self.class.name.split('::').last
+    end
+
+    def calling_file
+      file_fq, _line_number, _extra = backtrace[0].split(':')
+      file_fq
+    end
+
+    # @return HTML <div> tag with class set to the snake_case version of the error class name.
+    def html_message
+      shorten_backtrace
+      line_number = self.class.class_variable_get :@@line_number
+      path = self.class.class_variable_get :@@path
+      <<~END_MSG
+        <div class='#{error_name.snakecase}'>
+          #{self.class} raised in #{calling_file} while processing line #{line_number} (after front matter) of #{path}
+          #{message}
+        </div>
+      END_MSG
+    end
+
+    def logger_message
+      shorten_backtrace
+      kaller = caller(1..1).first
+      line_number = self.class.class_variable_get :@@line_number
+      path = self.class.class_variable_get :@@path
+      <<~END_MSG
+        #{error_name} raised in #{kaller} while processing line #{line_number} (after front matter) of #{path}
+          #{message}
+      END_MSG
+    end
+
+    def shorten_backtrace(backtrace_element_count = 3)
+      b = backtrace[0..backtrace_element_count - 1].map do |x|
+        x.gsub(Dir.pwd + '/', './')
+      end
+      set_backtrace b
+    end
+  end
+end

data/lib/jekyll_plugin_error_handling.rb

@@ -19,20 +19,23 @@ module JekyllSupportErrorHandling
   rescue StandardError => e
     file, line_number, caller = e.backtrace[caller_index].split(':')
     caller = caller.tr('`', "'")
-    warn "#{error.msg} #{caller} on line #{line_number} (after front matter) of #{file}".red
+    warn "#{error.message} #{caller} on line #{line_number} (after front matter) of #{file}".red
     # Process.kill('HUP', Process.pid) # generates huge stack trace
     exec "echo ''"
   end
 
+  # TODO: Delete this
   def format_error_message(message)
     page = " of #{@page['path']}" if @page
     remove_ansi_color "on line #{line_number} (after front matter)#{page}.\n#{message}"
   end
 
+  # TODO: Delete this
   def remove_ansi_color(string)
     string.gsub(/\e\[([;\d]+)?m/, '')
   end
 
+  # TODO: Delete this
   def maybe_reraise_error(error, throw_error: true)
     fmsg = format_error_message "#{error.class}: #{error.message.strip}"
     @logger.error { fmsg }

data/lib/jekyll_plugin_helper.rb

@@ -25,7 +25,7 @@ class JekyllPluginHelper
     @markup = markup
   rescue StandardError => e
     e.shorten_backtrace
-    @logger.error { e.msg }
+    @logger.error { e.message }
   end
 
   # @return undefined if parameter was specified, removes it from the available tokens and returns value

data/lib/jekyll_plugin_helper_class.rb

@@ -1,3 +1,7 @@
+require 'facets/string/camelcase'
+require 'facets/string/snakecase'
+require 'yaml'
+
 # Class methods for JekyllPluginHelper
 class JekyllPluginHelper
   # Expand an environment variable reference
@@ -11,19 +15,55 @@ class JekyllPluginHelper
     end
   end
 
-  def self.register(klass, name)
-    abort("Error: The #{name} plugin does not define VERSION") \
+  def self.generate_message(klass, tag_name, version)
+    error_ruby_class_name = "#{klass.name.camelcase(:upper)}Error"
+    config_die_key = "die_on_#{error_ruby_class_name.snakecase}"
+    error_css_class_name = error_ruby_class_name.split('::').last.snakecase
+    # config_file_fq = File.realpath 'demo/_config.yml'
+    config = YAML.load_file('demo/_config.yml')
+    tag_config = config[tag_name]
+    tag_config_msg = if tag_config.nil?
+                       <<~END_MSG
+                         _config.yml does not contain configuration information for this plugin.
+                           You could add a section containing default values like this:
+
+                               #{tag_name}:
+                                 #{config_die_key}: false
+                       END_MSG
+                     else
+                       <<~END_MSG
+                         _config.yml contains the following configuration for this plugin is:
+                           #{tag_config}
+                       END_MSG
+                     end
+
+    <<~END_MSG
+      Loaded plugin #{tag_name} v#{version}. It has:
+        Error class: #{error_ruby_class_name}
+        CSS class for error messages: #{error_css_class_name}
+
+        #{tag_config_msg}
+    END_MSG
+  end
+
+  def self.register(klass, tag_name)
+    abort("Error: The #{tag_name} plugin does not define VERSION") \
       unless klass.const_defined?(:VERSION)
 
     version = klass.const_get(:VERSION)
 
-    abort("Error: The #{name} plugin is not an instance of JekyllSupport::JekyllBlock or JekyllSupport::JekyllTag") \
+    abort("Error: The #{tag_name} plugin is not an instance of JekyllSupport::JekyllBlock or JekyllSupport::JekyllTag") \
       unless klass.instance_of?(Class) &&
              (klass.ancestors.include?(JekyllSupport::JekyllBlock) ||
               klass.ancestors.include?(JekyllSupport::JekyllTag))
 
-    Liquid::Template.register_tag(name, klass)
-    PluginMetaLogger.instance.info { "Loaded #{name} v#{version} plugin." }
+    Liquid::Template.register_tag(tag_name, klass)
+    msg = generate_message(klass, tag_name, version)
+    PluginMetaLogger.instance.info msg
+  end
+
+  def self.remove_html_tags(string)
+    string.gsub(/<[^>]*>/, '').strip
   end
 
   # strip leading and trailing quotes if present

data/lib/jekyll_plugin_support/version.rb

@@ -1,3 +1,3 @@
 module JekyllPluginSupportVersion
-  VERSION = '0.8.0'.freeze
+  VERSION = '0.8.1'.freeze
 end

data/lib/jekyll_plugin_support.rb

@@ -15,3 +15,4 @@ require_relative 'jekyll_plugin_support_block'
 require_relative 'jekyll_plugin_support_block_noarg'
 require_relative 'jekyll_plugin_support_tag'
 require_relative 'jekyll_plugin_support_tag_noarg'
+require_relative 'jekyll_custom_error'

data/lib/jekyll_plugin_support_block.rb

@@ -8,6 +8,14 @@ module JekyllSupport
     include JekyllSupportErrorHandling
     extend JekyllSupportErrorHandling
 
+    def set_error_context
+      error_class = Object.const_get error_class_name
+      error_class.class_variable_set(:@@argument_string, @argument_string)
+      error_class.class_variable_set(:@@line_number, @line_number)
+      error_class.class_variable_set(:@@path, @page['path'])
+      error_class.class_variable_set(:@@tag_name, @tag_name)
+    end
+
     # 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.
     # @param argument_string [String] the arguments passed to the tag, as a single string.
@@ -24,6 +32,9 @@ module JekyllSupport
       @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
       @logger.debug { "#{self.class}: respond_to?(:no_arg_parsing) #{respond_to?(:no_arg_parsing) ? 'yes' : 'no'}." }
       @helper = JekyllPluginHelper.new tag_name, markup, @logger, respond_to?(:no_arg_parsing)
+
+      @error_name = "#{tag_name.camelcase(:upper)}Error"
+      Jekyll::CustomError.factory @error_name
     end
 
     # Method prescribed by the Jekyll plugin lifecycle.
@@ -41,6 +52,8 @@ module JekyllSupport
       @config = @site.config
       @tag_config = @config[@tag_name]
 
+      set_error_context @error_name
+
       @layout    = @envs[:layout]
       @paginator = @envs[:paginator]
       @theme     = @envs[:theme]
@@ -58,11 +71,15 @@ module JekyllSupport
       render_impl text
     rescue StandardError => e
       e.shorten_backtrace
-      msg = format_error_message e.full_message
-      @logger.error msg
+      @logger.error { "#{e.class} on line #{@line_number} of #{e.backtrace[0].split(':').first} by #{tag_name} - #{e.message}" }
+      binding.pry if @pry_on_standard_error # rubocop:disable Lint/Debugger
       raise e if @die_on_standard_error
 
-      "<div class='standard_error'>#{e.class}: #{msg}</div>"
+      <<~END_MSG
+        <div class='standard_error'>
+          #{e.class} on line #{@line_number} of #{e.backtrace[0].split(':').first} by #{tag_name}: #{e.message}
+        </div>
+      END_MSG
     end
 
     # Jekyll plugins should override this method, not render,

data/lib/jekyll_plugin_support_class.rb

@@ -1,3 +1,5 @@
+require_relative 'jekyll_custom_error'
+
 # Monkey patch StandardError so a new method called shorten_backtrace is added.
 class StandardError
   def shorten_backtrace(backtrace_element_count = 3)
@@ -20,7 +22,7 @@ module JekyllSupport
 
   # @return a new StandardError subclass containing the shorten_backtrace method
   def define_error
-    Class.new StandardError
+    Class.new Jekyll::CustomError
   end
   module_function :define_error
 
@@ -78,7 +80,7 @@ module JekyllSupport
   def self.warn_short_trace(logger, error)
     remaining = error.backtrace.length - DISPLAYED_CALLS
     logger.warn do
-      error.msg + "\n" +
+      error.message + "\n" +
         error.backtrace.take(DISPLAYED_CALLS).join("\n") +
         "\n...Remaining #{remaining} call sites elided.\n"
     end

data/lib/jekyll_plugin_support_tag.rb

@@ -27,6 +27,17 @@ module JekyllSupport
       @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
       @logger.debug { "#{self.class}: respond_to?(:no_arg_parsing) #{respond_to?(:no_arg_parsing) ? 'yes' : 'no'}." }
       @helper = JekyllPluginHelper.new(tag_name, @argument_string, @logger, respond_to?(:no_arg_parsing))
+
+      @error_name = "#{tag_name.camelcase(:upper)}Error"
+      Jekyll::CustomError.factory @error_name
+    end
+
+    def set_error_context
+      error_class = Object.const_get @error_name
+      error_class.class_variable_set(:@@argument_string, @argument_string)
+      error_class.class_variable_set(:@@line_number, @line_number)
+      error_class.class_variable_set(:@@path, @page['path'])
+      error_class.class_variable_set(:@@tag_name, @tag_name)
     end
 
     # Method prescribed by the Jekyll plugin lifecycle.
@@ -45,6 +56,8 @@ module JekyllSupport
       @jps = @config['jekyll_plugin_support']
       @pry_on_standard_error = @jps['pry_on_standard_error'] || false if @jps
 
+      set_error_context @error_name
+
       # @envs.keys are :content, :highlighter_prefix, :highlighter_suffix, :jekyll, :layout, :page, :paginator, :site, :theme
       @layout    = @envs[:layout]
       @paginator = @envs[:paginator]
@@ -57,12 +70,15 @@ module JekyllSupport
       render_impl
     rescue StandardError => e
       e.shorten_backtrace
-      msg = format_error_message e.full_message
-      @logger.error msg
+      @logger.error { "#{e.class} on line #{@line_number} of #{e.backtrace[0].split(':').first} while processing #{tag_name} - #{e.message}" }
       binding.pry if @pry_on_standard_error # rubocop:disable Lint/Debugger
       raise e if @die_on_standard_error
 
-      "<div class='standard_error'>#{e.class}: #{msg}</div>"
+      <<~END_MSG
+        <div class='standard_error'>
+          #{e.class} on line #{@line_number} of #{e.backtrace[0].split(':').first} while processing #{tag_name}: #{e.message}
+        </div>
+      END_MSG
     end
 
     # Jekyll plugins must override this method, not render, so their plugin can be tested more easily

data/spec/custom_error_spec.rb

@@ -0,0 +1,39 @@
+require_relative '../lib/jekyll_custom_error'
+require_relative '../lib/jekyll_plugin_support_class'
+
+class Dummy
+  def just_for_testing; end
+end
+
+class CustomErrorSpec
+  tag_name = 'test_tag'
+  argument_string = 'This is the argument string'
+  AnError = JekyllSupport.define_error
+  AnError.class_variable_set(:@@tag_name, tag_name)
+  AnError.class_variable_set(:@@argument_string, argument_string)
+
+  puts "AnError is a #{AnError.class}; StandardError is a #{StandardError.class}"
+  begin
+    raise AnError, 'Oops'
+  rescue AnError => e
+    puts "Caught AnError: #{e.message}"
+  rescue Jekyll::CustomError => e
+    puts "Caught CustomError: #{e.message}"
+  end
+
+  RSpec.describe JekyllPluginHelper do
+    it 'generates messages' do
+      msg = described_class.generate_message(Dummy, tag_name, '0.1.0')
+      puts msg
+      expect(msg).to include(match(/Error class. DummyError/))
+      expect(msg).to include(match(/CSS class for error messages. dummy_error/))
+      expect(msg).to include(match(/die_on_dummy_error. false/))
+    end
+  end
+
+  RSpec.describe Jekyll::CustomError do
+    it 'can create custom errors' do
+      expect { raise AnError, 'Oops' }.to raise_error(AnError)
+    end
+  end
+end

data/spec/status_persistence.txt

@@ -1,7 +1,6 @@
 example_id                                       | status | run_time        |
 ------------------------------------------------ | ------ | --------------- |
-./spec/jekyll_plugin_helper_options_spec.rb[1:1] | failed | 0.00009 seconds |
-./spec/jekyll_plugin_helper_options_spec.rb[1:2] | failed | 0.00004 seconds |
-./spec/jekyll_plugin_helper_options_spec.rb[1:3] | failed | 0.00002 seconds |
-./spec/jekyll_plugin_helper_options_spec.rb[1:4] | failed | 0.00002 seconds |
-./spec/liquid_variable_parsing_spec.rb[1:1]      | failed | 0.00003 seconds |
+./spec/jekyll_plugin_helper_options_spec.rb[1:1] | passed | 0.00559 seconds |
+./spec/jekyll_plugin_helper_options_spec.rb[1:2] | passed | 0.00583 seconds |
+./spec/jekyll_plugin_helper_options_spec.rb[1:3] | passed | 0.00543 seconds |
+./spec/jekyll_plugin_helper_options_spec.rb[1:4] | passed | 0.00157 seconds |

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_plugin_support
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-22 00:00:00.000000000 Z
+date: 2024-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: facets
@@ -94,6 +94,7 @@ files:
 - README.md
 - Rakefile
 - jekyll_plugin_support.gemspec
+- lib/jekyll_custom_error.rb
 - lib/jekyll_plugin_error_handling.rb
 - lib/jekyll_plugin_helper.rb
 - lib/jekyll_plugin_helper_attribution.rb
@@ -106,6 +107,7 @@ files:
 - lib/jekyll_plugin_support_spec_support.rb
 - lib/jekyll_plugin_support_tag.rb
 - lib/jekyll_plugin_support_tag_noarg.rb
+- spec/custom_error_spec.rb
 - spec/jekyll_plugin_helper_options_spec.rb
 - spec/liquid_variable_parsing_spec.rb
 - spec/spec_helper.rb
@@ -137,11 +139,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Provides a framework for writing and testing Jekyll plugins
 test_files:
+- spec/custom_error_spec.rb
 - spec/jekyll_plugin_helper_options_spec.rb
 - spec/liquid_variable_parsing_spec.rb
 - spec/spec_helper.rb