jekyll_plugin_support 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4093bb78659c8a6b9e75df1ed8e288e7ba8a0216b7d870f04856933c992e631
-  data.tar.gz: 69c2191230866feb2552a9a170140008b5d16290703f525d1a6487b28df78706
+  metadata.gz: 89499adafe6c65e0579f3a9bb6a1e724001dda3465777f189ba67407ae105f73
+  data.tar.gz: 284b6a91b644e2989e4f28decb8a29c597b0b1baaf30549b611ea21939d00990
 SHA512:
-  metadata.gz: e63ab6ea4dc5a241d4fdafd00fd088943dee27591a36297a2a5a4984e0096775365c902bd43ece243cea45ac26e64e5a374c1afcc72f51653825e680e33f40ae
-  data.tar.gz: 25db74e77f3f24dd4d40fb2aba3b3717ff630c6afb6e3e9743ac91dc1331a29139fe79c9c7e596e8e9a7c7149c83c2cedd6503401ff9f83cf1b3eb7ada94197c
+  metadata.gz: 1bb5b49b8bcf8d7ac2f6a8b0650c4ddf2e405db76295190cf5257154495db1f4f2491c676842a01c1c8607f4abd666655336fd4675828df716eff85bf0f66483
+  data.tar.gz: 54bc0d824c5e635be5143b70088a0229cd79b6a80992284e53119c2578b3e7a6fb3e57a31ec0b23f2dec5a8ed6afffd800213d0b5e1617d1d2d087241651d3b9

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 0.7.2 / 2023-08-14
+
+* Hopefully takes care of issue [#4](../../issues/4).
+
+
 ## 0.7.1 / 2023-08-11
 
 * Suppressed stack trace from issue [#4](../../issues/4).

data/lib/jekyll_plugin_support/version.rb

@@ -1,3 +1,3 @@
 module JekyllPluginSupportVersion
-  VERSION = '0.7.1'.freeze
+  VERSION = '0.7.2'.freeze
 end

data/lib/jekyll_plugin_support.rb

@@ -16,7 +16,7 @@ module JekyllSupport
   DISPLAYED_CALLS = 8
 
   def self.error_short_trace(logger, error)
-    remaining = e.backtrace.length - DISPLAYED_CALLS
+    remaining = error.backtrace.length - DISPLAYED_CALLS
     logger.error do
       error.message + "\n" + # rubocop:disable Style/StringConcatenation
         error.backtrace.take(DISPLAYED_CALLS).join("\n") +
@@ -25,7 +25,7 @@ module JekyllSupport
   end
 
   def self.warn_short_trace(logger, error)
-    remaining = e.backtrace.length - DISPLAYED_CALLS
+    remaining = error.backtrace.length - DISPLAYED_CALLS
     logger.warn do
       error.message + "\n" + # rubocop:disable Style/StringConcatenation
         error.backtrace.take(DISPLAYED_CALLS).join("\n") +
@@ -76,14 +76,12 @@ module JekyllSupport
       @paginator = @envs[:paginator]
       @theme     = @envs[:theme]
 
-      @mode = @config['env']['JEKYLL_ENV'] || 'development'
+      @mode = @config['env']&.key?('JEKYLL_ENV') ? @config['env']['JEKYLL_ENV'] : 'development'
 
       render_impl text
     rescue StandardError => e
       @logger.error { "#{self.class} died with a #{e.full_message}" }
-      # raise SystemExit, 3, []
-      e.set_backtrace []
-      raise e
+      JekyllSupport.error_short_trace(@logger, e)
     end
 
     # Jekyll plugins should override this method, not render,
@@ -110,7 +108,7 @@ module JekyllSupport
       @logger.debug { "#{self.class}: respond_to?(:o_arg_parsing) #{respond_to?(:no_arg_parsing) ? 'yes' : 'no'}." }
     rescue StandardError => e
       @logger.error { "#{self.class} died with a #{e.full_message}" }
-      exit 2
+      JekyllSupport.error_short_trace(@logger, e)
     end
 
     def warn_short_trace(error)
@@ -140,12 +138,26 @@ module JekyllSupport
       @helper = JekyllPluginHelper.new(tag_name, argument_string, @logger, respond_to?(:no_arg_parsing))
     end
 
-    def exit_without_stack_trace(error)
+    # If a Jekyll plugin needs to crash exit, and stop Jekyll, call this method.
+    # It does not generate a stack trace.
+    # This method does not return because the process is abruptly terminated.
+    #
+    # @param error StandardError or a subclass of StandardError is required
+    #
+    # Do not raise the error before calling this method, just create it via 'new', like this:
+    # exit_without_stack_trace StandardError.new('This is my error message')
+    #
+    # If you want to call this method from a handler method, the default index for the backtrace array must be specified.
+    # The default backtrace index is 1, which means the calling method.
+    # To specify the calling method's caller, pass in 2, like this:
+    # exit_without_stack_trace StandardError.new('This is my error message'), 2
+    def exit_without_stack_trace(error, caller_index = 1)
       raise error
     rescue StandardError => e
-      file, line_number, caller = e.backtrace[1].split(':')
+      file, line_number, caller = e.backtrace[caller_index].split(':')
       caller = caller.tr('`', "'")
       warn "#{self.class} died with a '#{error.message}' #{caller} on line #{line_number} of #{file}".red
+      # Process.kill('HUP', Process.pid) # generates huge stack trace
       exec "echo ''"
     end
 
@@ -170,11 +182,11 @@ module JekyllSupport
       @site      = liquid_context.registers[:site]
 
       @config = @site.config
-      @mode = @config['env'].key?('JEKYLL_ENV') ? @config['env']['JEKYLL_ENV'] : 'development'
+      @mode = @config['env']&.key?('JEKYLL_ENV') ? @config['env']['JEKYLL_ENV'] : 'development'
 
       render_impl
     rescue StandardError => e
-      exit_without_stack_trace(e)
+      JekyllSupport.error_short_trace(@logger, e)
     end
 
     # Jekyll plugins must override this method, not render, so their plugin can be tested more easily

data/spec/status_persistence.txt

@@ -1,6 +0,0 @@
-example_id                                       | status | run_time        |
------------------------------------------------- | ------ | --------------- |
-./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.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-11 00:00:00.000000000 Z
+date: 2023-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: facets