jekyll_plugin_logger 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f82bc258b242f26c4358799b244b20d7b0763a86f5618af7f01b20fd1002d59
-  data.tar.gz: 3ffb12d7e491701a2eaefde02f29cda28bf9ddf5c039a5146a175aa9163f0381
+  metadata.gz: 26418179467ef67c9e606c45bd565fff0fe4f8c450da9efa243d29d99b581821
+  data.tar.gz: 6f7b529c26a6df0b236acb15c2a6c9314b2679cba64d152c41b3f581ab188a8e
 SHA512:
-  metadata.gz: 32fa2599a8864cb7418b6b4b85d9e4d7d1a42c5ad93b7763b19c2f62bb470df37d6d439c6a396ba616a9e4e8d5c33696f23adfb5926d508d981be3e09a474f80
-  data.tar.gz: 295194a15f1937caec9d78185891091e5c47a3f271343f84fb35bbef4be62768c089a80e724c6310c130fc342d16bfd5095fd37b994609b41a957f5c15524b77
+  metadata.gz: 61308925aaf08121c323b650a7918c549a33c5eb4a2b0c50985210be2edd11bcadf5d31d4773c9a09c96194822efb95b83767ea10f98864752ec7a36cb5ee118
+  data.tar.gz: e4f70c43f66bffe16ccb045ed645d6ac0167de28e9146661325d69c155a444f9b717bfd9d9972e43e17217445c11247a58de13325cd1e04ef9f32a07d78bd650

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 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`

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.1"
+module JekyllPluginLoggerVersion
+  VERSION = "2.1.0"
 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
 
+  # 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.class.name.demodulize
+      klass.to_s.split("::").last # class_name.name.split("::").last
     when "Module", "Symbol", "String"
-      klass.to_s
+      klass.to_s.split("::").last
     else
       class_name
     end
   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
 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,15 +144,15 @@ 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
+  def initialize()
     super
     @config = nil
     @logger = new_logger(self)
@@ -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_reset, :priority => :high) do |site|
   instance = PluginMetaLogger.instance
-  logger = instance.setup(site.config)
-  logger.info { "Loaded #{JekyllPluginLoggerName::PLUGIN_NAME} v#{JekyllPluginLogger::VERSION} plugin." }
+  logger = instance.new_logger(PluginMetaLogger, site.config)
+  logger.info { "Loaded #{JekyllPluginLoggerName::PLUGIN_NAME} v#{JekyllPluginLoggerVersion::VERSION} plugin." }
   logger.debug { "Logger for #{instance.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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_plugin_logger
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Mike Slinn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-05 00:00:00.000000000 Z
+date: 2022-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -69,7 +69,7 @@ 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
 homepage: https://www.mslinn.com/blog/2020/12/28/custom-logging-in-jekyll-plugins.html
 licenses:
@@ -103,5 +103,5 @@ 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