jekyll_plugin_support 0.8.4 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d96d3f40ca733d7fa1322a8fbec0a70131029baa063a32c55fdc003efcf0d24
-  data.tar.gz: 2ebb3e46419147a2f1b60e2024fd7118617be61c6cd8f359e448aad2279bf92f
+  metadata.gz: 6bf93dd0ea77ecf7c70380afdddc398824f3e1e27226ed3b8e996e8170a15443
+  data.tar.gz: 32e434ab647fcfc81e674a54fb676b1b17450ceef5c38f0f51c1a5f59588f666
 SHA512:
-  metadata.gz: f4022b99e9b6b1eef55be72e3cbe6a8d99af12e6ec0004a1e2c610325c726ffdf5cef042ce8687eb9be4e352fc7372e3a51f7053e39303cb06ff2dd5f180d530
-  data.tar.gz: 6d6b5d1221e8985a02bc8bfe32d6411cb516aa4376a0a3f27d9dc6d7b66bee43ce41c02b026e102f9b5035f0b6b116cf8983e1b8b6cea3847a5c2d70733cff69
+  metadata.gz: 2c254100e325c89dfd874e7403d83c5e3b10a808de8d987748fca7ef955d92dba2a90157868d7dd525953661968eb142a208bafc0015dbf99f357b1bf255dcf0
+  data.tar.gz: ae9cf29baf54d74c957bea4ff126edfe49ddcebb3ba327b2ae7729ef2e783fbe6f1df73a0a635f865a8f8fcbd00b33ebbc3e94ba949c892480a33543a31d21d4

data/CHANGELOG.md

@@ -1,9 +1,20 @@
 # 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
+
+
 ## 0.8.4 / 2024-02-27
 
 * Problem in error handler fixed.
+* A warning is logged if an environment variable is undefined and `die_if_undefined` is not set.
 
 
 ## 0.8.3 / 2024-01-05

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
@@ -29,6 +29,12 @@ module JekyllSupport
       Jekyll::CustomError.factory @error_name
     end
 
+    # Liquid::Block subclasses do not render if there is no content within the tag
+    # This override fixes that
+    def blank?
+      false
+    end
+
     # Method prescribed by the Jekyll plugin lifecycle.
     # Defines @config, @envs, @mode, @page and @site
     # @return [String]
@@ -50,9 +56,10 @@ 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)
+      @helper.reinitialize @markup.strip
 
       @attribution = @helper.parameter_specified?('attribution') || false unless @no_arg_parsing
       @logger.debug { "@keys_values='#{@keys_values}'" }
@@ -60,16 +67,16 @@ module JekyllSupport
       markup = JekyllSupport.lookup_liquid_variables liquid_context, @argument_string
       @helper.reinitialize markup
 
-      render_impl text
+      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/{jekyll_plugin_error_handling.rb → error/jekyll_plugin_error_handling.rb}

@@ -35,7 +35,6 @@ module JekyllSupportErrorHandling
     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/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_helper.rb → helper/jekyll_plugin_helper.rb}

@@ -98,7 +98,7 @@ class JekyllPluginHelper
                             .parse(@argv_original)
     @params_original = @keys_values_original unless respond_to?(:no_arg_parsing) && no_arg_parsing
 
-    @argv = Shellwords.split(self.class.expand_env(markup))
+    @argv = Shellwords.split(self.class.expand_env(markup, logger))
     @keys_values = KeyValueParser
                    .new({}, { array_values: false, normalize_keys: false, separator: /=/ })
                    .parse(@argv)

data/lib/{jekyll_plugin_helper_class.rb → helper/jekyll_plugin_helper_class.rb}

@@ -5,12 +5,19 @@ require 'yaml'
 # Class methods for JekyllPluginHelper
 class JekyllPluginHelper
   # Expand an environment variable reference
-  def self.expand_env(str, die_if_undefined: false)
-    str&.gsub(/\$([a-zA-Z_][a-zA-Z0-9_]*)|\${\g<1>}|%\g<1>%/) do
+  def self.expand_env(str, logger = nil, die_if_undefined: false)
+    str&.gsub(/\$([a-zA-Z_][a-zA-Z0-9_]*)|\${\g<1>}/) do
       envar = Regexp.last_match(1)
-      raise JekyllPluginSupportError, "jekyll_plugin_support error: #{envar} is undefined".red, [] \
-        if !ENV.key?(envar) && die_if_undefined # Suppress stack trace
+      unless ENV.key? envar
+        msg = "jekyll_plugin_support error: environment variable #{envar} is undefined"
+        raise JekyllPluginSupportError, msg.red, [] if die_if_undefined
 
+        if logger
+          logger.warn msg
+        else
+          puts msg.red
+        end
+      end
       ENV.fetch(envar, nil)
     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.4'.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
@@ -64,8 +64,9 @@ module JekyllSupport
     rescue StandardError => e
       e.shorten_backtrace
       file_name = e.backtrace[0]&.split(':')&.first
-      of_file_name = "of #{file_name} " if file_name
-      @logger.error { "#{e.class} on line #{@line_number} #{of_file_name}while processing #{tag_name} - #{e.message}" }
+      in_file_name = "in '#{file_name}' " if file_name
+      of_page = "of '#{@page['path']}'" if @page
+      @logger.error { "#{e.class} on line #{@line_number} #{of_page}while processing #{tag_name} #{in_file_name}- #{e.message}" }
       binding.pry if @pry_on_standard_error # rubocop:disable Lint/Debugger
       raise e if @die_on_standard_error
 

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.4
+  version: 0.8.6
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-27 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