jekyll_plugin_logger 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7a503b502ebd28c7bfe8ed9237ae721560135f1620054da34ece8275cfb5118
-  data.tar.gz: 5285da27eebe3005f00562260e38117a8d685a8f10b8ab5bf444ee804d17cf46
+  metadata.gz: 6d9885c654b34790e6f52a8e3a92a008cc51a40fc2a6ea404037f0e3e929291d
+  data.tar.gz: 72130fb28aea51696ae2ddf2be772e330dfd7d59ba2f0cc14d2545093c572c25
 SHA512:
-  metadata.gz: ebc0a877d7bf80fe01e1609123ea93900ce9a23e96c877e3d304128543946c1fe31613c3af9b50324fa5fdf030170a06f5f2b79ba02d3fd079f7797931639088
-  data.tar.gz: 516fb3f7250fce0bacf7f5a2e782111e358ab0e979cd98950a7105faa0516d657423e88499dfd9534c05c9c70dec00431475a8c1f72be1b166b2164cc0018c56
+  metadata.gz: 509269138c34ff09d9a226657f07443155b89349681929218390b8041dc49b9497c2278c6f5ab6074fdfd7b1541a5caf7b5076eaa45524a734c64d0b6639c98e
+  data.tar.gz: 798aeac0b80dd88b3cbbe6e174511afd1b5c4df87325adf54af7683051a87776f83310097424e0dd7dc0c6030fdc7648311df982bd68d05c9d95b72f9c423054

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 2.1.1 / 2022-04-15
+  * Fixed progname reference for metalogger debug startup statement
+
+## 2.1.0 / 2022-04-05
+  * Changed how config info is made available
+
+## 2.0.1 / 2022-04-05
+  * Changed to registration hook to `:site`, `:after_reset` because that is the first hook that gets called.
+  * Improved the detection of various types of `progname`
+
 ## 2.0.0 / 2022-03-16
   * Completely rewrote this plugin, now not a class, but a module that monkey patches the existing Jekyll logger for compatibility.
   * Renamed the gem from `jekyll_logger_factory` to `jekyll_plugin_logger`.

data/Rakefile

@@ -1,7 +1,23 @@
 # frozen_string_literal: true
 
+require "bump/tasks"
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
+# do not always tag the version
+# Bump.tag_by_default = false
+
+# bump the version in additional files
+# Bump.replace_in_default = ["Readme.md"]
+
+# Maintain changelog:
+Bump.changelog = true
+
+# Open the changelog in an editor when bumping
+Bump.changelog = :editor
+
+# Configure bump to not use a prefix:
+ENV["TAG_PREFIX"] = ""
+
 RSpec::Core::RakeTask.new(:spec)
 task :default => :spec

data/jekyll_plugin_logger.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.6.0"
   spec.summary = "Generates Jekyll logger with colored output."
   spec.test_files = spec.files.grep(%r!^(test|spec|features)/!)
-  spec.version = JekyllPluginLogger::VERSION
+  spec.version = JekyllPluginLoggerVersion::VERSION
 
   spec.add_dependency "jekyll", ">= 3.5.0"
 

data/lib/jekyll_plugin_logger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module JekyllPluginLogger
-  VERSION = "2.0.0"
+module JekyllPluginLoggerVersion
+  VERSION = "2.1.1"
 end

data/lib/jekyll_plugin_logger.rb

@@ -10,13 +10,14 @@ module JekyllPluginLoggerName
   PLUGIN_NAME = "jekyll_plugin_logger"
 end
 
-# Once the meta-logger is made (see `PluginMetaLogger``, below) new instances of `PluginLogger` can be created with log levels set by `config` entries.
+# 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)
+#   @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
 #
-# self can be a class, a string, or a symbol.
+# self can be a module, a class, a string, or a symbol.
 #
-# Best practice is to invoke `info``, `warn, `debug`` and `error`` methods by passing blocks that contain the message.
+# 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,8 +25,6 @@ end
 # For more information about the logging feature in the Ruby standard library,
 # @see https://ruby-doc.org/stdlib-2.7.1/libdoc/logger/rdoc/Logger.html
 class PluginLogger
-  include JekyllPluginLogger
-
   # 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),
@@ -40,12 +39,13 @@ class PluginLogger
   # @example  If `progname` has value `abc`, then the YAML to override the programmatically set log_level to `debug` is:
   #   logger_factory:
   #     abc: debug
-  def initialize(klass, config, stream_name = $stdout)
+  def initialize(klass, config = nil, stream_name = $stdout)
+    @config = config
     @logger = Logger.new(stream_name)
     @logger.progname = derive_progname(klass)
     @logger.level = :info
-    plugin_loggers = config["plugin_loggers"]
-    @logger.level ||= plugin_loggers["PluginMetaLogger"] if plugin_loggers
+    plugin_loggers = config ? config["plugin_loggers"] : nil
+    @logger.level = plugin_loggers[@logger.progname] if plugin_loggers && plugin_loggers[@logger.progname]
     # puts "PluginLogger.initialize: @logger.progname=#{@logger.progname} set to #{@logger.level}".red
     @logger.formatter = proc { |severity, _, prog_name, msg|
       "#{severity} #{prog_name}: #{msg}\n"
@@ -100,26 +100,26 @@ class PluginLogger
     end
   end
 
-  private
-
-  def derive_progname(klass)
-    full_name = case klass.class
-                when String
-                  klass
-                when Symbol
-                  klass.to_s
-                else
-                  klass.class.name
-                end
-    full_name.split("::").last
-  end
-
   # Available colors are: :black, :red, :green, :yellow, :blue, :magenta, :cyan, :white, and the modifier :bold
   def level_as_sym
     return :unknown if @logger.level.negative? || level > 4
 
     [:debug, :info, :warn, :error, :fatal, :unknown][@logger.level]
   end
+
+  private
+
+  def derive_progname(klass)
+    class_name = klass.class.to_s
+    case class_name
+    when "Class"
+      klass.to_s.split("::").last # class_name.name.split("::").last
+    when "Module", "Symbol", "String"
+      klass.to_s.split("::").last
+    else
+      class_name
+    end
+  end
 end
 
 # Makes a meta-logger instance (a singleton) with level set by `site.config`.
@@ -133,7 +133,8 @@ end
 #
 # @example
 #   # Create and initialize the meta-logger singleton in a high priority Jekyll `site` `:after_init` hook:
-#   PluginMetaLogger.instance.setup(site.config).info { "Meta-logger has been created" }
+#   @meta_logger = PluginMetaLogger.instance.new_logger(site.config, self)
+#   @meta_logger.info { "Meta-logger has been created" }
 #
 #   # In `config.yml`:
 #   plugin_loggers:
@@ -143,13 +144,13 @@ end
 #     ArchiveDisplayTag: debug
 #
 #   # In a Jekyll plugin:
-#   @logger = PluginMetaLogger.instance.new_logger(self)
+#   @logger = PluginMetaLogger.instance.setup(self)
 #   @logger.info { "This is a log message from a Jekyll plugin" }
 #   #
 #   PluginMetaLogger.instance.info { "MyPlugin vX.Y.Z has been loaded" }
 class PluginMetaLogger
   include Singleton
-  attr_reader :logger
+  attr_reader :config, :logger
 
   def initialize
     super
@@ -165,6 +166,10 @@ class PluginMetaLogger
     @logger.debug(self) { yield }
   end
 
+  def level_as_sym
+    @logger.level_as_sym
+  end
+
   def warn
     @logger.warn(self) { yield }
   end
@@ -173,25 +178,20 @@ class PluginMetaLogger
     @logger.error(self) { yield }
   end
 
-  def new_logger(klass, stream_name = $stdout)
+  def new_logger(klass, config = nil, stream_name = $stdout)
+    @config ||= config
     if @config.nil?
-      puts { "Error: PluginMetaLogger has not been initialized by calling setup yet.".red }
+      puts { "Error: PluginMetaLogger has not been initialized with site.config.".red }
       PluginLogger.new(klass, {}, stream_name)
     else
       PluginLogger.new(klass, @config, stream_name)
     end
   end
-
-  def setup(config, stream_name = $stdout)
-    @config = config
-    @logger = new_logger(self, stream_name)
-    @logger
-  end
 end
 
-Jekyll::Hooks.register(:site, :after_init, :priority => :high) do |site|
+Jekyll::Hooks.register(:site, :after_reset, :priority => :high) do |site|
   instance = PluginMetaLogger.instance
-  logger = instance.setup(site.config)
-  logger.info { "Loaded #{JekyllPluginLoggerName::PLUGIN_NAME} v#{JekyllPluginLogger::VERSION} plugin." }
-  logger.debug { "Logger for #{instance.progname} created at level #{instance.level_as_sym}" }
+  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}" }
 end

data/spec/{jekyll_plugin_logger.rb → jekyll_plugin_logger_spec.rb}

@@ -19,26 +19,17 @@ require_relative "../lib/jekyll_plugin_logger"
 class MyTestPlugin
   instance = PluginMetaLogger.instance
   logger = instance.new_logger(self) # Should generate a warning
-  instance.setup({})
   PluginMetaLogger.instance.info { "How now, brown cow" }
   PluginMetaLogger.instance.debug { "How now, brown cow" }
   PluginMetaLogger.instance.warn { "How now, brown cow" }
   PluginMetaLogger.instance.error { "How now, brown cow" }
 
-  logger = PluginMetaLogger.instance.new_logger(self)
+  logger = PluginMetaLogger.instance.new_logger(self, RSpec.configuration.site_config)
   logger.debug { "3 fleas fleeing freedom" }
   logger.info { "3 fleas fleeing freedom" }
   logger.warn { "3 fleas fleeing freedom" }
   logger.error { "3 fleas fleeing freedom" }
 
-  _yaml = <<~END_YAML
-    plugin_loggers:
-      PluginMetaLogger: debug
-      SiteInspector: warn
-      MakeArchive: error
-      ArchiveDisplayTag: debug
-  END_YAML
-
   def self.exercise(logger)
     puts
     # puts "\ncalling_class_name=#{logger.send(:calling_class_name)}"
@@ -63,18 +54,33 @@ class MyTestPlugin
     logger.error { "Error message 4" }
   end
 
-  RSpec.describe JekyllPluginLogger do
-    it "outputs at debug level" do
-      MyTestPlugin.exercise(PluginMetaLogger.instance.new_logger(self, $stdout))
+  RSpec.describe PluginLogger do
+    it "outputs at info level" do
+      MyTestPlugin.exercise(PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config, $stdout))
+      expect(PluginMetaLogger.instance.level_as_sym).to eq(:info)
+    end
+
+    it "uses config debug" do
+      logger = PluginMetaLogger.instance.new_logger(:MyBlock, PluginMetaLogger.instance.config)
+      expect(logger.level_as_sym).to eq(:debug)
+      MyTestPlugin.exercise(logger)
+    end
+
+    it "uses config info" do
+      logger = PluginMetaLogger.instance.new_logger(:ArchiveDisplayTag, PluginMetaLogger.instance.config)
+      expect(logger.level_as_sym).to eq(:info)
+      MyTestPlugin.exercise(logger)
     end
 
     it "uses config warn" do
-      logger = PluginMetaLogger.instance.new_logger("SiteInspector", $stdout)
+      logger = PluginMetaLogger.instance.new_logger("SiteInspector", PluginMetaLogger.instance.config, $stdout)
+      expect(logger.level_as_sym).to eq(:warn)
       MyTestPlugin.exercise(logger)
     end
 
     it "uses config error" do
-      logger = PluginMetaLogger.instance.new_logger(:MakeArchive)
+      logger = PluginMetaLogger.instance.new_logger(:PreTagBlock, PluginMetaLogger.instance.config)
+      expect(logger.level_as_sym).to eq(:error)
       MyTestPlugin.exercise(logger)
     end
   end

data/spec/spec_helper.rb

@@ -6,7 +6,25 @@ require_relative "../lib/jekyll_plugin_logger"
 Jekyll.logger.log_level = :info
 
 RSpec.configure do |config|
-  config.run_all_when_everything_filtered = true
+  plugin_config = <<~END_CONFIG
+    plugin_loggers:
+      ArchiveDisplayTag: info
+      FlexibleInclude: info
+      MakeArchive: info
+      MyBlock: debug
+      PluginMetaLogger: info
+      PreTagBlock: error
+      SiteInspector: warn
+      UnselectableTag: info
+  END_CONFIG
+
+  config.add_setting :site_config
+  config.site_config = YAML.safe_load(plugin_config)
+
   config.filter_run :focus
   config.order = "random"
+  config.run_all_when_everything_filtered = true
+
+  # See https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures
+  config.example_status_persistence_file_path = "spec/status_persistence.txt"
 end

data/spec/status_persistence.txt

@@ -0,0 +1,7 @@
+example_id                               | status | run_time        |
+---------------------------------------- | ------ | --------------- |
+./spec/jekyll_plugin_logger_spec.rb[1:1] | failed | 0.02037 seconds |
+./spec/jekyll_plugin_logger_spec.rb[1:2] | passed | 0.03764 seconds |
+./spec/jekyll_plugin_logger_spec.rb[1:3] | passed | 0.00041 seconds |
+./spec/jekyll_plugin_logger_spec.rb[1:4] | passed | 0.00026 seconds |
+./spec/jekyll_plugin_logger_spec.rb[1:5] | passed | 0.0002 seconds  |

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_plugin_logger
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Mike Slinn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-25 00:00:00.000000000 Z
+date: 2022-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -69,8 +69,9 @@ files:
 - jekyll_plugin_logger.gemspec
 - lib/jekyll_plugin_logger.rb
 - lib/jekyll_plugin_logger/version.rb
-- spec/jekyll_plugin_logger.rb
+- spec/jekyll_plugin_logger_spec.rb
 - spec/spec_helper.rb
+- spec/status_persistence.txt
 homepage: https://www.mslinn.com/blog/2020/12/28/custom-logging-in-jekyll-plugins.html
 licenses:
 - MIT
@@ -103,5 +104,6 @@ signing_key:
 specification_version: 4
 summary: Generates Jekyll logger with colored output.
 test_files:
-- spec/jekyll_plugin_logger.rb
+- spec/jekyll_plugin_logger_spec.rb
 - spec/spec_helper.rb
+- spec/status_persistence.txt