jekyll_plugin_support 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb10128c2e05e5b4cd74a5878d137d6ffea98ceaf0dcd792666f00fbe8e7555f
-  data.tar.gz: 59363370fe4c0a64db20ea2a8a2adbe456e66eecc53a0b50f4393dea64a71f04
+  metadata.gz: 4d4b97854b427b9113f6db8e175608ac5e2b3fc5866c0062449c9b7e5c530798
+  data.tar.gz: 39c0b2b1ee1b457df3e339edb166d295fdf14b83faeb44a6261be39993fc82f4
 SHA512:
-  metadata.gz: 2e6ce3ce7322e023604e57f23bcd55f5a14eeb098800ab19b477e0a5af1220266fc5f0a64f3e376c3882356bd1514ef1fa7a88040e83fe43355c2b8471ad1c6b
-  data.tar.gz: 4305d408b8ac6ff904c6c2090ff6c873c2f9631c60c8122a18b4a9f66fad377e314c0cc20f2b113488a5e4a8a141ab958da9a9181e162885003fcdf0a8598e9f
+  metadata.gz: db5aa2fe02695556bb5bc7c95e53c5eb98990688fd1920bcab97503262979ef4266ac95210da7fc5d60a67f635b2fe11e7b18ebd3d35ab6e4bdbeedc1d116442
+  data.tar.gz: accae0af9a79e92f812980db24e23e33b7555362f24e28f9dd099f6faa57e7484a7043ddeccb16aa10f1d6a7d187cf6ee9f023bbd030d8cb49bf9984dc8049eb

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.7.0 / 2023-05-22
+  * Added `error_short_trace` and `warn_short_trace` methods for displaying non-fatal errors on the console.
+
 ## 0.6.2 / 2023-05-15
   * Removed annoying blank line output when attribute was invoked.
 

data/jekyll_plugin_support.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.authors = ['Mike Slinn']
   spec.email = ['mslinn@mslinn.com']
   spec.files = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec}/**/*', '*.gemspec', '*.md']
-  spec.homepage = 'https://www.mslinn.com/jekyll/10200-jekyll-plugin-support.html'
+  spec.homepage = 'https://www.mslinn.com/jekyll_plugins/jekyll_plugin_support.html'
   spec.license = 'MIT'
   spec.metadata = {
     'allowed_push_host' => 'https://rubygems.org',

data/lib/jekyll_plugin_support/version.rb

@@ -1,3 +1,3 @@
 module JekyllPluginSupportVersion
-  VERSION = '0.6.2'.freeze
+  VERSION = '0.7.0'.freeze
 end

data/lib/jekyll_plugin_support.rb

@@ -12,6 +12,26 @@ module NoArgParsing
 end
 
 module JekyllSupport
+  DISPLAYED_CALLS = 8
+
+  def self.error_short_trace(logger, error)
+    remaining = e.backtrace.length - DISPLAYED_CALLS
+    logger.error do
+      error.message + "\n" + # rubocop:disable Style/StringConcatenation
+        error.backtrace.take(DISPLAYED_CALLS).join("\n") +
+        "\n...Remaining #{remaining} call sites elided.\n"
+    end
+  end
+
+  def self.warn_short_trace(logger, error)
+    remaining = e.backtrace.length - DISPLAYED_CALLS
+    logger.warn do
+      error.message + "\n" + # rubocop:disable Style/StringConcatenation
+        error.backtrace.take(DISPLAYED_CALLS).join("\n") +
+        "\n...Remaining #{remaining} call sites elided.\n"
+    end
+  end
+
   # Base class for Jekyll block tags
   class JekyllBlock < Liquid::Block
     attr_reader :argument_string, :helper, :line_number, :logger, :page, :site, :text
@@ -34,16 +54,27 @@ module JekyllSupport
       @helper = JekyllPluginHelper.new tag_name, argument_string, @logger, respond_to?(:no_arg_parsing)
     end
 
+    # @return line number where tag or block was found, relative to the start of the page
+    def jekyll_line_number
+      @page['front_matter'].count("\n") + @line_number
+    end
+
     # Method prescribed by the Jekyll plugin lifecycle.
+    # Defines @config, @envs, @mode, @page and @site
     # @return [String]
     def render(liquid_context)
       text = super
       @helper.liquid_context = liquid_context
 
-      @page = liquid_context.registers[:page] # Type Jekyll::Drops::DocumentDrop
+      @page = liquid_context.registers[:page] # hash
       @site = liquid_context.registers[:site]
       @config = @site.config
       @envs = liquid_context.environments.first
+
+      @layout    = @envs[:layout]
+      @paginator = @envs[:paginator]
+      @theme     = @envs[:theme]
+
       @mode = @config['env']['JEKYLL_ENV'] || 'development'
 
       render_impl text
@@ -54,12 +85,18 @@ module JekyllSupport
       raise e
     end
 
-    # Jekyll plugins should override this method, not render, so their plugin can be tested more easily
-    # @page and @site are available
-    # @return [String]
+    # Jekyll plugins should override this method, not render,
+    # so they can be tested more easily.
+    # The following variables are predefined:
+    #   @argument_string, @config, @envs, @helper, @layout, @logger, @mode, @page, @paginator, @site, @tag_name and @theme
+    # @return [String] The result to be rendered to the invoking page
     def render_impl(text)
       text
     end
+
+    def warn_short_trace(error)
+      JekyllSupport.warn_short_trace(@logger, error)
+    end
   end
 
   class JekyllBlockNoArgParsing < JekyllBlock
@@ -74,6 +111,10 @@ module JekyllSupport
       @logger.error { "#{self.class} died with a #{e.full_message}" }
       exit 2
     end
+
+    def warn_short_trace(error)
+      JekyllSupport.warn_short_trace(@logger, error)
+    end
   end
 
   # Base class for Jekyll tags
@@ -98,6 +139,11 @@ module JekyllSupport
       @helper = JekyllPluginHelper.new(tag_name, argument_string, @logger, respond_to?(:no_arg_parsing))
     end
 
+    # @return line number where tag or block was found, relative to the start of the page
+    def jekyll_line_number
+      @page['front_matter'].count("\n") + @line_number
+    end
+
     # Method prescribed by the Jekyll plugin lifecycle.
     def render(liquid_context)
       return if @helper.excerpt_caller
@@ -123,10 +169,15 @@ module JekyllSupport
     end
 
     # Jekyll plugins must override this method, not render, so their plugin can be tested more easily
-    # @page and @site are available
+    # The following variables are predefined:
+    #   @argument_string, @config, @envs, @helper, @layout, @logger, @mode, @page, @paginator, @site, @tag_name and @theme
     def render_impl
       abort "#{self.class}.render_impl for tag #{@tag_name} must be overridden, but it was not."
     end
+
+    def warn_short_trace(error)
+      JekyllSupport.warn_short_trace(@logger, error)
+    end
   end
 
   class JekyllTagNoArgParsing < JekyllTag

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_plugin_support
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-15 00:00:00.000000000 Z
+date: 2023-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: facets
@@ -86,18 +86,16 @@ files:
 - lib/jekyll_plugin_support.rb
 - lib/jekyll_plugin_support/version.rb
 - lib/jekyll_plugin_support_spec_support.rb
-- spec/jekyll_plugin_helper_call_spec.rb
 - spec/jekyll_plugin_helper_options_spec.rb
 - spec/spec_helper.rb
-- spec/status_persistence.txt
-homepage: https://www.mslinn.com/jekyll/10200-jekyll-plugin-support.html
+homepage: https://www.mslinn.com/jekyll_plugins/jekyll_plugin_support.html
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
   bug_tracker_uri: https://github.com/mslinn/jekyll_plugin_support/issues
   changelog_uri: https://github.com/mslinn/jekyll_plugin_support/CHANGELOG.md
-  homepage_uri: https://www.mslinn.com/jekyll/10200-jekyll-plugin-support.html
+  homepage_uri: https://www.mslinn.com/jekyll_plugins/jekyll_plugin_support.html
   source_code_uri: https://github.com/mslinn/jekyll_plugin_support
 post_install_message: |2+
 
@@ -122,8 +120,6 @@ signing_key:
 specification_version: 4
 summary: Provides support for writing Jekyll plugins.
 test_files:
-- spec/jekyll_plugin_helper_call_spec.rb
 - spec/jekyll_plugin_helper_options_spec.rb
 - spec/spec_helper.rb
-- spec/status_persistence.txt
 ...

data/spec/jekyll_plugin_helper_call_spec.rb

@@ -1,21 +0,0 @@
-require 'jekyll_plugin_logger'
-require 'rspec/match_ignoring_whitespace'
-require_relative '../lib/jekyll_plugin_support'
-require_relative '../lib/jekyll_plugin_support_spec_support'
-
-class JekyllPluginHelperCallTest
-  RSpec.describe JekyllPluginHelper do
-    it 'might not return jpsh_subclass_caller value' do
-      jpsh_subclass_caller = CallChain.jpsh_subclass_caller
-      expect(jpsh_subclass_caller).to be_nil
-    end
-
-    it 'asf' do
-      logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
-      jph = described_class.new('my_tag', 'attribution', logger, false)
-      actual = jph.jpsh_subclass_caller
-      expected = [__FILE__, 15, 'new'] # The 2nd element value depends on the line # of two lines up
-      expect(actual).to match_array(expected)
-    end
-  end
-end

data/spec/status_persistence.txt

@@ -1,4 +0,0 @@
-example_id                                                                                      | status | run_time        |
------------------------------------------------------------------------------------------------ | ------ | --------------- |
-/mnt/_/work/jekyll/my_plugins/jekyll_plugin_support/spec/jekyll_plugin_helper_call_spec.rb[1:1] | passed | 0.00436 seconds |
-/mnt/_/work/jekyll/my_plugins/jekyll_plugin_support/spec/jekyll_plugin_helper_call_spec.rb[1:2] | passed | 0.00476 seconds |