jekyll_plugin_support 0.8.5 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20c575e857da7ffa50f37a587494b25232e1eb1309040946dd13d8f896250f07
-  data.tar.gz: 4aa5e163875f4e99adca9a6bc4ca97927c95c4cc4d017f52ca0b108d9ea24670
+  metadata.gz: 6bf93dd0ea77ecf7c70380afdddc398824f3e1e27226ed3b8e996e8170a15443
+  data.tar.gz: 32e434ab647fcfc81e674a54fb676b1b17450ceef5c38f0f51c1a5f59588f666
 SHA512:
-  metadata.gz: f2a2123c073c9e344e097e3eecd364606037bdd0213045d7060a09d48acaac1810eb609e201126e3f4fc8e5edc0e4e6e81db43800aa4eea954490d4e21e91cdc
-  data.tar.gz: 2d4e8daa6ea71e412065356a7029f3ff0b432fb7a06cdc98f403ba02709106f75c62e8236bae12668e6b181f4c52ccba328811fdb9619cd075597fea622052e7
+  metadata.gz: 2c254100e325c89dfd874e7403d83c5e3b10a808de8d987748fca7ef955d92dba2a90157868d7dd525953661968eb142a208bafc0015dbf99f357b1bf255dcf0
+  data.tar.gz: ae9cf29baf54d74c957bea4ff126edfe49ddcebb3ba327b2ae7729ef2e783fbe6f1df73a0a635f865a8f8fcbd00b33ebbc3e94ba949c892480a33543a31d21d4

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Change Log
 
 
+## 0.8.6 / 2024-06-11
+
+* Fixup version, containing what was supposed to be in v0.8.5
+
+
 ## 0.8.5 / 2024-03-25
 
 * Empty block tags now return a value. See https://talk.jekyllrb.com/t/empty-liquid-block-not-rendering

data/lib/{jekyll_plugin_support_block.rb → block/jekyll_plugin_support_block.rb}

@@ -1,4 +1,4 @@
-require_relative 'jekyll_plugin_error_handling'
+require_relative '../error/jekyll_plugin_error_handling'
 
 module JekyllSupport
   # Base class for Jekyll block tags
@@ -56,7 +56,8 @@ module JekyllSupport
       @paginator = @envs[:paginator]
       @theme     = @envs[:theme]
 
-      @mode = @config['env']&.key?('JEKYLL_ENV') ? @config['env']['JEKYLL_ENV'] : 'development'
+      env = @config['env']
+      @mode = env&.key?('JEKYLL_ENV') ? env['JEKYLL_ENV'] : 'development'
 
       @helper.reinitialize @markup.strip
 
@@ -69,13 +70,13 @@ module JekyllSupport
       render_impl(text)
     rescue StandardError => e
       e.shorten_backtrace
-      @logger.error { "#{e.class} on line #{@line_number} of #{e.backtrace[0].split(':').first} by #{tag_name} - #{e.message}" }
+      @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
 
       <<~END_MSG
         <div class='standard_error'>
-          #{e.class} on line #{@line_number} of #{e.backtrace[0].split(':').first} by #{tag_name}: #{e.message}
+          #{e.class} on line #{@line_number} of #{e.backtrace[0].split(':').first} by #{@tag_name}: #{e.message}
         </div>
       END_MSG
     end

data/lib/{jekyll_plugin_support_block_noarg.rb → block/jekyll_plugin_support_block_noarg.rb}

@@ -1,4 +1,4 @@
-require_relative 'jekyll_plugin_error_handling'
+require_relative '../error/jekyll_plugin_error_handling'
 
 module JekyllSupport
   class JekyllBlockNoArgParsing < JekyllBlock
@@ -20,6 +20,12 @@ module JekyllSupport
       JekyllSupport.error_short_trace(@logger, e)
     end
 
+    # Liquid::Block subclasses do not render if there is no content within the tag
+    # This override fixes that
+    def blank?
+      false
+    end
+
     # Jekyll plugins must override this method, not render, so their plugin 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

data/lib/generator/jekyll_plugin_support_generator.rb

@@ -0,0 +1,78 @@
+require 'jekyll'
+require_relative '../error/jekyll_plugin_error_handling'
+
+module JekyllSupport
+  # Base class for Jekyll generators.
+  # PluginMetaLogger.instance.config is populated with the contents of `_config.yml` before Jekyll::Generator instances run.
+  class JekyllGenerator < Jekyll::Generator
+    attr_reader :helper, :line_number, :logger, :site
+
+    include JekyllSupportErrorHandling
+    extend JekyllSupportErrorHandling
+
+    # Method prescribed by the Jekyll plugin lifecycle.
+    # Defines @config, @envs, @mode and @site
+    # @return [void]
+    def generate(site)
+      @logger ||= PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+
+      @error_name = "#{self.class.name}Error"
+      # Jekyll::CustomError.factory @error_name
+
+      @site   = site
+      @config = @site.config
+      @envs   = site.config['env']
+      @theme  = @site.theme
+
+      @mode = ENV['JEKYLL_ENV'] || 'development'
+
+      # set_error_context(self.class)
+
+      generate_impl
+    rescue StandardError => e
+      e.shorten_backtrace
+      @logger.error { "#{e.class} on line #{@line_number} of #{e.backtrace[0].split(':').first} by #{self.class.name} - #{e.message}" }
+      binding.pry if @pry_on_standard_error # rubocop:disable Lint/Debugger
+      raise e if @die_on_standard_error
+
+      <<~END_MSG
+        <div class='standard_error'>
+          #{e.class} on line #{@line_number} of #{e.backtrace[0].split(':').first} by #{self.class.name}: #{e.message}
+        </div>
+      END_MSG
+    end
+
+    # Jekyll plugins should override this method, not `generate`, so they can be tested more easily.
+    # The following variables are predefined:
+    #   @config, @envs, @helper, @logger, @mode, @paginator, @site and @theme
+    # @return [void]
+    def generate_impl; end
+
+    def self.register(klass)
+      abort("Error: The #{klass.name} plugin does not define VERSION") \
+        unless klass.const_defined?(:VERSION)
+
+      version = klass.const_get(:VERSION)
+      error_name_stub = klass.name.include?('::') ? klass.name.split('::')[1] : klass.name
+      error_ruby_class_name = "#{error_name_stub.camelcase(:upper)}Error"
+      error_css_class_name = error_ruby_class_name.split('::').last.snakecase
+      msg = <<~END_MSG
+        Loaded generator plugin #{klass.name} v#{version}. It has:
+          Error class: #{@error_name}
+          CSS class for error messages: #{error_css_class_name}
+      END_MSG
+
+      PluginMetaLogger.instance.info { msg }
+    end
+
+    def set_error_context(klass)
+      return unless Object.const_defined? @error_name
+
+      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, klass.name)
+    end
+  end
+end

data/lib/{jekyll_plugin_support_class.rb → jekyll_plugin_support/jekyll_plugin_support_class.rb}

@@ -1,4 +1,4 @@
-require_relative 'jekyll_custom_error'
+require_relative '../error/jekyll_custom_error'
 
 # Monkey patch StandardError so a new method called shorten_backtrace is added.
 class StandardError

data/lib/jekyll_plugin_support/version.rb

@@ -1,3 +1,3 @@
 module JekyllPluginSupportVersion
-  VERSION = '0.8.5'.freeze
+  VERSION = '0.8.6'.freeze
 end

data/lib/jekyll_plugin_support.rb

@@ -1,8 +1,12 @@
 require 'colorator'
 require 'jekyll'
 require 'jekyll_plugin_logger'
-require_relative 'jekyll_plugin_helper'
-require_relative 'jekyll_plugin_support/version'
+
+def require_directory(dir)
+  Dir[File.join(dir, '*.rb')].sort.each do |file|
+    require file unless file == __FILE__
+  end
+end
 
 module NoArgParsing
   attr_accessor :no_arg_parsing
@@ -10,9 +14,10 @@ module NoArgParsing
   @no_arg_parsing = true
 end
 
-require_relative 'jekyll_plugin_support_class'
-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'
+require_directory __dir__
+require_directory "#{__dir__}/block"
+require_directory "#{__dir__}/error"
+require_directory "#{__dir__}/generator"
+require_directory "#{__dir__}/helper"
+require_directory "#{__dir__}/jekyll_plugin_support"
+require_directory "#{__dir__}/tag"

data/lib/{jekyll_plugin_support_tag.rb → tag/jekyll_plugin_support_tag.rb}

@@ -1,5 +1,5 @@
 require 'pry'
-require_relative 'jekyll_plugin_error_handling'
+require_relative '../error/jekyll_plugin_error_handling'
 
 module JekyllSupport
   # Base class for Jekyll tags

data/lib/{jekyll_plugin_support_tag_noarg.rb → tag/jekyll_plugin_support_tag_noarg.rb}

@@ -1,4 +1,4 @@
-require_relative 'jekyll_plugin_error_handling'
+require_relative '../error/jekyll_plugin_error_handling'
 
 module JekyllSupport
   class JekyllTagNoArgParsing < JekyllTag

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_plugin_support
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.8.6
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-25 00:00:00.000000000 Z
+date: 2024-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: facets
@@ -94,19 +94,20 @@ 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
-- lib/jekyll_plugin_helper_class.rb
+- lib/block/jekyll_plugin_support_block.rb
+- lib/block/jekyll_plugin_support_block_noarg.rb
+- lib/error/jekyll_custom_error.rb
+- lib/error/jekyll_plugin_error_handling.rb
+- lib/generator/jekyll_plugin_support_generator.rb
+- lib/helper/jekyll_plugin_helper.rb
+- lib/helper/jekyll_plugin_helper_attribution.rb
+- lib/helper/jekyll_plugin_helper_class.rb
 - lib/jekyll_plugin_support.rb
+- lib/jekyll_plugin_support/jekyll_plugin_support_class.rb
+- lib/jekyll_plugin_support/jekyll_plugin_support_spec_support.rb
 - lib/jekyll_plugin_support/version.rb
-- lib/jekyll_plugin_support_block.rb
-- lib/jekyll_plugin_support_block_noarg.rb
-- lib/jekyll_plugin_support_class.rb
-- lib/jekyll_plugin_support_spec_support.rb
-- lib/jekyll_plugin_support_tag.rb
-- lib/jekyll_plugin_support_tag_noarg.rb
+- lib/tag/jekyll_plugin_support_tag.rb
+- lib/tag/jekyll_plugin_support_tag_noarg.rb
 - spec/custom_error_spec.rb
 - spec/jekyll_plugin_helper_options_spec.rb
 - spec/liquid_variable_parsing_spec.rb
@@ -139,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.10
 signing_key:
 specification_version: 4
 summary: Provides a framework for writing and testing Jekyll plugins