jekyll_plugin_logger 2.1.2 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90e90f26bac683d004a6ba9c963d8b6532678dac4cc0e03eee15732742c2f936
-  data.tar.gz: c1711187ac79bfd16ae6e357e647488f67c32e4b4526222d932e4c02c76615c4
+  metadata.gz: 3c3467fff319002876010e4599258218a4d007fc76f6b78de3dbe4ca6f6e52be
+  data.tar.gz: 59811c6f5339fc5eafd5d1f6274739b56a8596cac113c6d1cb4c8a9a588ff808
 SHA512:
-  metadata.gz: 1ae7813c1bdac1068b72633198d3e09518590d55982cdc2ee0a178d6b655e4022419d7f49baa16d5dace49f6a1a4c72bb9ff9118e192aef48db9970c48de8bec
-  data.tar.gz: fe1bbdc922dd1a0a3cbf5af36dbdf7e5fd67ca12dc8c14b55361d9b9cbef61aa1983abb616dfda460ef3b626a721353cc61c6e4b5b6286c9804a8b6b83a7aec3
+  metadata.gz: 3ec77851f74498677d41088a0b121991cd4534bcc7d80f7a982c15b72abb50757fe4ab78acd11c8eceb09c79ee5675cf6bdc39126570b5cc978bb84aa9591f94
+  data.tar.gz: b24dd3fa24b79e16506ae4ea7dbe1340f5898f27d6f3c59f0c57d182365234d2638abf2635ad0d42544e792377591e3d9c4f5b54e9e80f63b15918cdc75f53de

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 2.1.3 / 2025-11-21
+
+* Improved comments.
+* Improved PluginMetaLogger.new_logger debug output.
+* Fixed initial log level always being INFO
+
+
 ## 2.1.2 / 2023-11-21
 
 * Added `demo`.

data/jekyll_plugin_logger.gemspec

@@ -3,15 +3,15 @@ require_relative 'lib/jekyll_plugin_logger/version'
 Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   github = 'https://github.com/mslinn/jekyll_plugin_logger'
 
-  spec.authors = ['Mike Slinn']
-  spec.bindir = 'exe'
+  spec.authors     = ['Mike Slinn']
+  spec.bindir      = 'exe'
   spec.description = <<~END_OF_DESC
     Generates Jekyll logger with colored output.
   END_OF_DESC
-  spec.email = ['mslinn@mslinn.com']
-  spec.files = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec}/**/*', '*.gemspec', '*.md']
+  spec.email    = ['mslinn@mslinn.com']
+  spec.files    = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec}/**/*', '*.gemspec', '*.md']
   spec.homepage = 'https://www.mslinn.com/jekyll_plugins/jekyll_plugin_logger.html'
-  spec.license = 'MIT'
+  spec.license  = 'MIT'
   spec.metadata = {
     'allowed_push_host' => 'https://rubygems.org',
     'bug_tracker_uri'   => "#{github}/issues",
@@ -19,17 +19,18 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
     'homepage_uri'      => spec.homepage,
     'source_code_uri'   => github,
   }
-  spec.name = 'jekyll_plugin_logger'
+  spec.name                 = 'jekyll_plugin_logger'
+  spec.platform             = Gem::Platform::RUBY
   spec.post_install_message = <<~END_MESSAGE
 
     Thanks for installing #{spec.name}!
 
   END_MESSAGE
-  spec.require_paths = ['lib']
+  spec.require_paths         = ['lib']
   spec.required_ruby_version = '>= 2.6.0'
-  spec.summary = 'Generates a Jekyll logger with colored output.'
-  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
-  spec.version = JekyllPluginLoggerVersion::VERSION
+  spec.summary               = 'Generates a Jekyll logger with colored output.'
+  spec.test_files            = spec.files.grep(%r{^(test|spec|features)/})
+  spec.version               = JekyllPluginLoggerVersion::VERSION
 
   spec.add_dependency 'bump'
   spec.add_dependency 'jekyll', '>= 3.5.0'

data/lib/jekyll_plugin_logger/version.rb

@@ -1,3 +1,3 @@
 module JekyllPluginLoggerVersion
-  VERSION = '2.1.2'.freeze
+  VERSION = '2.1.3'.freeze
 end

data/lib/jekyll_plugin_logger.rb

@@ -10,13 +10,16 @@ end
 
 # Once the meta-logger is made (see `PluginMetaLogger`, below) new instances of `PluginLogger` can be created with log levels set
 # by `config` entries.
+#
 # @example Create new `PluginLogger`s like this:
-#   @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+#   @logger = PluginMetaLogger.instance.new_logger(ref, PluginMetaLogger.instance.config)
 #
-# self can be a module, a class, a string, or a symbol.
+# ref can be a module name, a class name, a string, or a symbol.
 #
+# Logger usage:
 # Best practice is to invoke `info`, `warn, `debug` and `error` methods by passing blocks that contain the message.
 # The blocks will only be evaluated if output for that level is enabled.
+#
 # @example Use `PluginLogger`s like this:
 #   @logger.info { "This is only evaluated if info level debugging is enabled" }
 #
@@ -24,24 +27,12 @@ end
 # @see https://ruby-doc.org/stdlib-2.7.1/libdoc/logger/rdoc/Logger.html
 class PluginLogger
   # This method should only be called by PluginMetaLogger
-  # @param log_level [String, Symbol, Integer] can be specified as $stderr or $stdout,
-  #   or an integer from 0..3 (inclusive),
-  #   or as a case-insensitive string
-  #   (`debug`, `info`, `warn`, `error`, or `DEBUG`, `INFO`, `WARN`, `ERROR`),
-  #   or as a symbol (`:debug`, `:info`, `:warn`, `:error` ).
-  #
-  # 0: debug
-  # 1: info
-  # 2: warn
-  # 3: error
-  # 4: fatal
-  # 5: unknown (displays as ANY)
+  # @param stream_name [String, Symbol, Integer] can be specified as $stderr or $stdout
   #
-  # @param config [YAML] is normally created by reading a YAML file such as Jekyll's `_config.yml`.
-  #   When invoking from a Jekyll plugin, provide `site.config`,
-  #   which is available from all types of Jekyll plugins as `Jekyll.configuration({})`.
+  # @param config [YAML] can accept configuration data, usually a reference to `site.config`,
+  # stored in `PluginMetaLogger.instance.config`.
   #
-  # @example  If `progname` has value `abc`, then the YAML to override the programmatically set log_level to `debug` is:
+  # @example  If `klass` has value `abc`, then the YAML to override the programmatically set log_level to `debug` is:
   #   logger_factory:
   #     abc: debug
   def initialize(klass, config = nil, stream_name = $stdout)
@@ -50,7 +41,8 @@ class PluginLogger
 
     @logger = Logger.new stream_name
     @logger.progname = derive_progname klass
-    @logger.level = :info
+    # Default to :warn when no config, so INFO messages are suppressed until config is loaded
+    @logger.level = (config.nil? || config.empty?) ? :warn : :info
     @logger.level = plugin_loggers[@logger.progname] if plugin_loggers&.[] @logger.progname
     # puts "PluginLogger.initialize: @logger.progname=#{@logger.progname} set to #{@logger.level}".red
     @logger.formatter = proc { |severity, _datetime, progname, msg|
@@ -74,6 +66,17 @@ class PluginLogger
     end
   end
 
+  # @param value [String, Symbol, Integer] can be an integer from 0..3 (inclusive),
+  #   or a case-insensitive string
+  #   (`debug`, `info`, `warn`, `error`, or `DEBUG`, `INFO`, `WARN`, `ERROR`),
+  #   or a symbol (`:debug`, `:info`, `:warn`, `:error` ).
+  #
+  # 0: debug
+  # 1: info
+  # 2: warn
+  # 3: error
+  # 4: fatal
+  # 5: unknown (displays as ANY)
   def level=(value)
     @logger.level = value
   end
@@ -144,9 +147,13 @@ class PluginLogger
   end
 end
 
-Jekyll::Hooks.register(:site, :after_reset, priority: :high) do |site|
+# When Jekyll first starts, this code reads the contents of `_config.yml` that was stored in `site.config`,
+# and stores a reference to the configuration information in `PluginMetaLogger.instance.config` for when loggers are
+# created in the future.
+# The `site.config` information is used by `PluginLogger.initialize` to automatically configure new loggers.
+Jekyll::Hooks.register(:site, :after_init, priority: :high) do |site|
   instance = PluginMetaLogger.instance
-  logger = instance.new_logger(PluginMetaLogger, site.config)
-  logger.info { "Loaded #{JekyllPluginLoggerName::PLUGIN_NAME} v#{JekyllPluginLoggerVersion::VERSION} plugin." }
-  logger.debug { "Logger for #{instance.logger.progname} created at level #{instance.level_as_sym}" }
+  instance.logger = instance.new_logger(PluginMetaLogger, site.config)
+  instance.logger.info { "Loaded #{JekyllPluginLoggerName::PLUGIN_NAME} v#{JekyllPluginLoggerVersion::VERSION} plugin." }
+  instance.logger.debug { "Logger for #{instance.logger.progname} created at level #{instance.level_as_sym}" }
 end

data/lib/jekyll_plugin_meta_logger.rb

@@ -31,6 +31,7 @@ require 'singleton'
 class PluginMetaLogger
   include Singleton
   attr_reader :config, :logger
+  attr_writer :logger
 
   def initialize
     super
@@ -39,10 +40,12 @@ class PluginMetaLogger
   end
 
   def info(&block)
+    # Delegate to @logger which respects the configured level
     @logger.info(self) { yield block }
   end
 
   def debug(&block)
+    # Delegate to @logger which respects the configured level
     @logger.debug(self) { yield block }
   end
 
@@ -58,13 +61,16 @@ class PluginMetaLogger
     @logger.error(self) { yield block }
   end
 
+  # By the time this method is called, `PluginMetaLogger.instance.config` contains the entire contents of `_config.yml`
   def new_logger(klass, config = nil, stream_name = $stdout)
     @config ||= config
     if @config.nil?
-      puts { 'Error: PluginMetaLogger has not been initialized with site.config.'.red }
-      PluginLogger.new(klass, {}, stream_name)
+      logger = PluginLogger.new(klass, {}, stream_name)
+      logger.debug { 'PluginMetaLogger was not initialized from site.config.' }
     else
-      PluginLogger.new(klass, @config, stream_name)
+      logger = PluginLogger.new(klass, @config, stream_name)
+      logger.debug { 'PluginMetaLogger was initialized from site.config.' }
     end
+    logger
   end
 end

data/spec/jekyll_plugin_logger_spec.rb

@@ -53,9 +53,10 @@ class MyTestPlugin
   end
 
   RSpec.describe PluginLogger do
-    it 'outputs at info level' do
+    it 'defaults to warn level when no config' do
       MyTestPlugin.exercise(PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config, $stdout))
-      expect(PluginMetaLogger.instance.level_as_sym).to eq(:info)
+      # Default level is :warn when no config is provided (suppresses INFO during gem loading)
+      expect(PluginMetaLogger.instance.level_as_sym).to eq(:warn)
     end
 
     it 'uses config debug' do

data/spec/status_persistence.txt

@@ -1,7 +1,7 @@
 example_id                               | status | run_time        |
 ---------------------------------------- | ------ | --------------- |
-./spec/jekyll_plugin_logger_spec.rb[1:1] | passed | 0.00004 seconds |
-./spec/jekyll_plugin_logger_spec.rb[1:2] | passed | 0.00005 seconds |
-./spec/jekyll_plugin_logger_spec.rb[1:3] | passed | 0.00009 seconds |
-./spec/jekyll_plugin_logger_spec.rb[1:4] | passed | 0.00005 seconds |
-./spec/jekyll_plugin_logger_spec.rb[1:5] | passed | 0.00117 seconds |
+./spec/jekyll_plugin_logger_spec.rb[1:1] | passed | 0.00032 seconds |
+./spec/jekyll_plugin_logger_spec.rb[1:2] | passed | 0.0002 seconds  |
+./spec/jekyll_plugin_logger_spec.rb[1:3] | passed | 0.0002 seconds  |
+./spec/jekyll_plugin_logger_spec.rb[1:4] | passed | 0.00078 seconds |
+./spec/jekyll_plugin_logger_spec.rb[1:5] | passed | 0.00025 seconds |

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_plugin_logger
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.3
 platform: ruby
 authors:
 - Mike Slinn
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -86,8 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Generates a Jekyll logger with colored output.
 test_files: