jekyll_plugin_support 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb346f630f3f3d54d602c2c130ead054765b3f1fcd5d2a13550a82d850ce6c7f
-  data.tar.gz: 50a247655dbdb650eaeabb6163843b2d9f2c1ec47c69609f43b0e22df10d96c7
+  metadata.gz: fc8c02963da77be335a8e4713e9bcffc12395912733d31781e16198f9f9392f0
+  data.tar.gz: 8851a2ede60d7a70f0cb7eab711c7a3cb06da87d9764740d5dd50a385ee8066d
 SHA512:
-  metadata.gz: c3277bc67de6688e3c4af585940a26bd641d157a54be0757a34aae364454fc5bfe952cb5e7834d8dc57eda4e6957ce1c1adcf603915d3bff442e7a88e52552ca
-  data.tar.gz: f9e68b39c8de0fa100d720601b59e2a052a8fb3de9746ccb7a37fa28752bb43171827dd325f7b1e6bda920561716feed78a69e477d1fc022832ff43ce5d9234a
+  metadata.gz: 06b06073d76ba15d23d69d585d3148edd0e2adcd86ffc0b6d7982d2659989aad9da79b6adab83220c9c4299354e423a4bc3490ace1f2c1348d5e9a01e1b848c8
+  data.tar.gz: 9e9bd5db4569abe954ba547e38538c62ecf99037f772a893ef73a1fe68c9a9766df4c15069f6e1ff3aea578913d92e91922ab076c2be632540eb1e31a73e33a4

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Change Log
 
+
+## 1.0.2 / 2024-08-19
+
+* Computes line_number and path properly
+* Refactored demo CSS
+* Improved custom plugin error handling and sample code.
+  The following seems to be optimal for custom plugins; it suppresses the ridiculously long stack trace that used to be generated:
+
+   ```ruby
+    rescue DemoInlineTagError => e # jekyll_plugin_support handles StandardError
+      @logger.error e.logger_message
+      exit! 1 if @die_on_demo_tag_error
+
+      e.html_message
+    ```
+
+
+## 1.0.1 / 2024-07-27
+
+* Moved `warn_short_trace`, `maybe_reraise_error`, `remove_ansi_color`,
+`format_error_message` and `exit_without_stack_trace` into `JekyllSupportError`.
+* Added missing `shared_include.css` and `clippy.svg` to `demo/`.
+* Fixed missing module name when invoking `format_error_message`.
+
+
 ## 1.0.0 / 2024-07-23
 
 * Added the `redef_without_warning` method so tag and block plugins can be subclassed.

data/README.md

@@ -466,9 +466,8 @@ class DemoBlock < JekyllSupport::JekyllBlock
   def render_impl(text)
     raise DemoBlockTagError, 'Fall down, go boom.'
   rescue DemoBlockTagError => e
-    e.shorten_backtrace
     @logger.error e.logger_message
-    raise e if @die_on_demo_block_error
+    exit! 1 if @die_on_demo_block_error
 
     e.html_message
   end

data/lib/error/jekyll_custom_error.rb

@@ -23,8 +23,7 @@ module JekyllSupport
     # @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
+      path, line_number, _caller = backtrace[1].split(':')
       <<~END_MSG
         <div class='#{error_name.snakecase}'>
           #{self.class} raised in #{calling_file} while processing line #{line_number} (after front matter) of #{path}
@@ -36,8 +35,7 @@ module JekyllSupport
     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
+      path, line_number, _caller = backtrace[1].split(':')
       <<~END_MSG
         #{error_name} raised in #{kaller} while processing line #{line_number} (after front matter) of #{path}
           #{message}

data/lib/error/jekyll_plugin_error_handling.rb

@@ -1,4 +1,4 @@
-module JekyllSupport
+module JekyllSupportError
   attr_reader :logger, :page
 
   # If a Jekyll plugin needs to crash exit, and stop Jekyll, call this method.
@@ -24,19 +24,17 @@ module JekyllSupport
     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
 
   def maybe_reraise_error(error, throw_error: true)
-    fmsg = format_error_message "#{error.class}: #{error.message.strip}"
+    fmsg = JekyllSupport.format_error_message "#{error.class}: #{error.message.strip}"
     @logger.error { fmsg }
     return "<span class='jekyll_plugin_support_error'>#{fmsg}</span>" unless throw_error
 

data/lib/jekyll_plugin_support/version.rb

@@ -1,3 +1,3 @@
 module JekyllPluginSupportVersion
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.0.2'.freeze
 end

data/lib/jekyll_plugin_support.rb

@@ -28,3 +28,21 @@ require_directory "#{__dir__}/generator"
 require_directory "#{__dir__}/helper"
 require_directory "#{__dir__}/jekyll_plugin_support"
 require_directory "#{__dir__}/tag"
+
+module JekyllSupport
+  class JekyllTag
+    include JekyllSupportError
+  end
+
+  class JekyllTagNoArgParsing
+    include JekyllSupportError
+  end
+
+  class JekyllBlock
+    include JekyllSupportError
+  end
+
+  class JekyllBlockNoArgParsing
+    include JekyllSupportError
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_plugin_support
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-26 00:00:00.000000000 Z
+date: 2024-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: facets
@@ -140,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: Provides a framework for writing and testing Jekyll plugins