jekyll_plugin_logger 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a7a503b502ebd28c7bfe8ed9237ae721560135f1620054da34ece8275cfb5118
+  data.tar.gz: 5285da27eebe3005f00562260e38117a8d685a8f10b8ab5bf444ee804d17cf46
+SHA512:
+  metadata.gz: ebc0a877d7bf80fe01e1609123ea93900ce9a23e96c877e3d304128543946c1fe31613c3af9b50324fa5fdf030170a06f5f2b79ba02d3fd079f7797931639088
+  data.tar.gz: 516fb3f7250fce0bacf7f5a2e782111e358ab0e979cd98950a7105faa0516d657423e88499dfd9534c05c9c70dec00431475a8c1f72be1b166b2164cc0018c56

data/.rubocop.yml

@@ -0,0 +1,21 @@
+require: rubocop-jekyll
+inherit_gem:
+ rubocop-jekyll: .rubocop.yml
+
+AllCops:
+  Exclude:
+      - vendor/**/*
+      - Gemfile*
+      - '*.gemspec' # This does nothing. Why?
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Jekyll/NoPutsAllowed:
+  Exclude:
+    - spec/**/*
+
+Layout/LineLength:
+  Max: 150
+
+# Gemspec/RequireMFA:
+#   enable: false

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+## 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`.
+  * Automatically obtains plugin class name and uses that as `progname`.
+  * `:into` level output is colored cyan.
+
+## 1.0.0 / 2022-03-16
+  * Published as a gem.
+  * New instances are now created with `new` instead of `create_logger`.
+  * Now subclasses Jekyll's Stevenson logger.
+  * Documentation improved, clarifies that the only supported levels are those provided by the Stevenson logger: `:debug`, `:info`, and `:error`.
+  * No longer supports control over where log output goes; STDERR and STDOUT are automatically selected according to log level.
+
+## 2020-12-28
+  * Initial version published at https://www.mslinn.com/blog/2020/12/28/custom-logging-in-jekyll-plugins.html

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Mike Slinn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,120 @@
+`jekyll_plugin_logger`
+[![Gem Version](https://badge.fury.io/rb/jekyll_plugin_logger.svg)](https://badge.fury.io/rb/jekyll_plugin_logger)
+===========
+
+`jekyll_plugin_logger` is a Jekyll plugin, packaged as a Ruby gem, that provides colored console logs for Jekyll plugins.
+
+
+## Usage
+
+It looks within `_config.yml` for a key corresponding to the plugin progname.
+For example, if the plugin's class is called `"MyPlugin"` then an entry called `plugin_loggers.MyPlugin`
+will be read from the config file, if present.
+If the entry exists, its value overrides the value specified when created.
+If no such entry is found then the `log_level` value passed to `new` is used.
+
+Here are examples of how to use this plugin:
+```ruby
+# These log messages are always computed, needed or not:
+Jekyll.logger.info("Info message 1")
+Jekyll.logger.info('MyPlugin', "Info message 2")
+
+# The following blocks are not evaluated unless log_level requires them to be
+
+Jekyll.logger.info('MyPlugin') { "Info message 3" }
+Jekyll.info { "Info message 4" }
+
+Jekyll.logger.warn('MyPlugin') { "Warn message 1" }
+Jekyll.warn { "Warn message 2" }
+
+Jekyll.logger.error('MyPlugin') { "Error message 1" }
+Jekyll.error { "Error message 2" }
+```
+
+For more information about the logging feature in the Ruby standard library,
+see https://ruby-doc.org/stdlib-2.7.2/libdoc/logger/rdoc/Logger.html
+
+
+
+## Installation
+
+Add this line to your Jekyll website's `_config.yml`:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll_plugin_logger'
+end
+```
+
+Install all of the dependent gems of your Jekyll website by typing:
+
+    $ bundle install
+
+Or install just this one gem by typing:
+
+    $ gem install jekyll_plugin_logger
+
+
+## Additional Information
+More information is available on Mike Slinn's web site about
+[Jekyll plugins](https://www.mslinn.com/blog/index.html#Jekyll).
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies, including development dependencies.
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+### Build and Install Locally
+To build and install this gem onto your local machine, run:
+```shell
+$ rake install:local
+```
+
+The following also does the same thing:
+```shell
+$ bundle exec rake install
+jekyll_plugin_logger 1.0.0 built to pkg/jekyll_plugin_logger-0.1.0.gem.
+jekyll_plugin_logger (1.0.0) installed.
+```
+
+Examine the newly built gem:
+```shell
+$ gem info jekyll_plugin_logger
+
+*** LOCAL GEMS ***
+
+jekyll_plugin_logger (1.0.0)
+    Author: Mike Slinn
+    Homepage:
+    https://github.com/mslinn/jekyll_plugin_logger
+    License: MIT
+    Installed at: /home/mslinn/.gems
+
+    Generates Jekyll logger with colored output.
+```
+
+### Build and Push to RubyGems
+To release a new version,
+  1. Update the version number in `version.rb`.
+  2. Commit all changes to git; if you don't the next step might fail with an unexplainable error message.
+  3. Run the following:
+     ```shell
+     $ bundle exec rake release
+     ```
+     The above creates a git tag for the version, commits the created tag,
+     and pushes the new `.gem` file to [RubyGems.org](https://rubygems.org).
+
+
+## Contributing
+
+1. Fork the project
+2. Create a descriptively named feature branch
+3. Add your feature
+4. Submit a pull request
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/jekyll_plugin_logger.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "lib/jekyll_plugin_logger/version"
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  github = "https://github.com/mslinn/jekyll_plugin_logger"
+
+  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.homepage = "https://www.mslinn.com/blog/2020/12/28/custom-logging-in-jekyll-plugins.html"
+  spec.license = "MIT"
+  spec.metadata = {
+    "allowed_push_host" => "https://rubygems.org",
+    "bug_tracker_uri"   => "#{github}/issues",
+    "changelog_uri"     => "#{github}/CHANGELOG.md",
+    "homepage_uri"      => spec.homepage,
+    "source_code_uri"   => github,
+  }
+  spec.name = "jekyll_plugin_logger"
+  spec.post_install_message = <<~END_MESSAGE
+
+    Thanks for installing #{spec.name}!
+
+  END_MESSAGE
+  spec.require_paths = ["lib"]
+  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.add_dependency "jekyll", ">= 3.5.0"
+
+  spec.add_development_dependency "debase"
+  # spec.add_development_dependency "rubocop-jekyll"
+  # spec.add_development_dependency "rubocop-rake"
+  # spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "ruby-debug-ide"
+end
+# rubocop:enable Metrics/BlockLength

data/lib/jekyll_plugin_logger/version.rb

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

data/lib/jekyll_plugin_logger.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+require "colorator"
+require "logger"
+require "singleton"
+require "yaml"
+require_relative "jekyll_plugin_logger/version"
+
+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.
+# @example Create new `PluginLogger`s like this:
+#   @logger = PluginMetaLogger.instance.new_logger(self)
+#
+# self can be 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.
+# 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" }
+#
+# 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),
+  #   or as a case-insensitive string
+  #   (`debug`, `info`, `warn`, `error`, or `DEBUG`, `INFO`, `WARN`, `ERROR`),
+  #   or as a symbol (`:debug`, `:info`, `:warn`, `:error` ).
+  #
+  # @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({})`.
+  #
+  # @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)
+    @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
+    # puts "PluginLogger.initialize: @logger.progname=#{@logger.progname} set to #{@logger.level}".red
+    @logger.formatter = proc { |severity, _, prog_name, msg|
+      "#{severity} #{prog_name}: #{msg}\n"
+    }
+  end
+
+  def debug(progname = nil, &block)
+    if block
+      @logger.debug(@logger.progname) { (yield block).to_s.magenta }
+    else
+      @logger.debug(@logger.progname) { progname.to_s.magenta }
+    end
+  end
+
+  def info(progname = nil, &block)
+    if block
+      @logger.info(@logger.progname) { (yield block).to_s.cyan }
+    else
+      @logger.info(@logger.progname) { progname.to_s.cyan }
+    end
+  end
+
+  def level=(value)
+    @logger.level = value
+  end
+
+  def level
+    @logger.level
+  end
+
+  def progname=(value)
+    @logger.progname = value
+  end
+
+  def progname
+    @logger.progname
+  end
+
+  def warn(progname = nil, &block)
+    if block
+      @logger.warn(@logger.progname) { (yield block).to_s.yellow }
+    else
+      @logger.warn(@logger.progname) { progname.to_s.yellow }
+    end
+  end
+
+  def error(progname = nil, &block)
+    if block
+      @logger.error(@logger.progname) { (yield block).to_s.red }
+    else
+      @logger.error(@logger.progname) { progname.to_s.red }
+    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
+end
+
+# Makes a meta-logger instance (a singleton) with level set by `site.config`.
+# Saves `site.config` for later use when creating plugin loggers; these loggers each have their own log levels.
+#
+# For example, if the plugin's progname has value `MyPlugin` then an entry called `plugin_loggers.MyPlugin`
+# will be read from `config`, if present.
+# If no such entry is found then the meta-logger log_level is set to `:info`.
+# If you want to see messages that indicate the loggers and log levels as they are created,
+# set the log level for `PluginMetaLogger` to `debug` in `_config.yml`
+#
+# @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" }
+#
+#   # In `config.yml`:
+#   plugin_loggers:
+#     PluginMetaLogger: info
+#     MyPlugin: warn
+#     MakeArchive: error
+#     ArchiveDisplayTag: debug
+#
+#   # In a Jekyll plugin:
+#   @logger = PluginMetaLogger.instance.new_logger(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
+
+  def initialize
+    super
+    @config = nil
+    @logger = new_logger(self)
+  end
+
+  def info
+    @logger.info(self) { yield }
+  end
+
+  def debug
+    @logger.debug(self) { yield }
+  end
+
+  def warn
+    @logger.warn(self) { yield }
+  end
+
+  def error
+    @logger.error(self) { yield }
+  end
+
+  def new_logger(klass, stream_name = $stdout)
+    if @config.nil?
+      puts { "Error: PluginMetaLogger has not been initialized by calling setup yet.".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|
+  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}" }
+end

data/spec/jekyll_plugin_logger.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "colorator"
+require "jekyll"
+require_relative "../lib/jekyll_plugin_logger"
+
+# Output should be:
+
+# Info message 1 (cyan)
+#      MyPlugin Info message 2 (cyan)
+#     MyPlugin: Info message 3 (cyan)
+# MyTestPlugin: Info message 4 (cyan)
+# .
+#     MyPlugin: Warn message 1 (yellow)
+# MyTestPlugin: Warn message 2 (yellow)
+#     MyPlugin: Error message 1 (red)
+# MyTestPlugin: Error message 2 (red)
+
+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.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)}"
+    logger.debug("Debug message 1")
+    # logger.debug("MyPlugin", "Debug message 2")
+    # logger.debug("MyPlugin") { "Debug message 3" }
+    logger.debug { "Debug message 4" }
+
+    logger.info("Info message 1")
+    # logger.info("MyPlugin", "Info message 2")
+    # logger.info("MyPlugin") { "Info message 3" }
+    logger.info { "Info message 4" }
+
+    logger.warn("Warn message 1")
+    # logger.warn("MyPlugin", "Warn message 2")
+    # logger.warn("MyPlugin") { "Warn message 3" }
+    logger.warn { "Warn message 4" }
+
+    logger.error("Error message 1")
+    # logger.error("MyPlugin", "Error message 2")
+    # logger.error("MyPlugin") { "Error message 3" }
+    logger.error { "Error message 4" }
+  end
+
+  RSpec.describe JekyllPluginLogger do
+    it "outputs at debug level" do
+      MyTestPlugin.exercise(PluginMetaLogger.instance.new_logger(self, $stdout))
+    end
+
+    it "uses config warn" do
+      logger = PluginMetaLogger.instance.new_logger("SiteInspector", $stdout)
+      MyTestPlugin.exercise(logger)
+    end
+
+    it "uses config error" do
+      logger = PluginMetaLogger.instance.new_logger(:MakeArchive)
+      MyTestPlugin.exercise(logger)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require_relative "../lib/jekyll_plugin_logger"
+
+Jekyll.logger.log_level = :info
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = "random"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_plugin_logger
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Mike Slinn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: debase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-debug-ide
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Generates Jekyll logger with colored output.
+
+'
+email:
+- mslinn@mslinn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll_plugin_logger.gemspec
+- lib/jekyll_plugin_logger.rb
+- lib/jekyll_plugin_logger/version.rb
+- spec/jekyll_plugin_logger.rb
+- spec/spec_helper.rb
+homepage: https://www.mslinn.com/blog/2020/12/28/custom-logging-in-jekyll-plugins.html
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/mslinn/jekyll_plugin_logger/issues
+  changelog_uri: https://github.com/mslinn/jekyll_plugin_logger/CHANGELOG.md
+  homepage_uri: https://www.mslinn.com/blog/2020/12/28/custom-logging-in-jekyll-plugins.html
+  source_code_uri: https://github.com/mslinn/jekyll_plugin_logger
+post_install_message: |2+
+
+  Thanks for installing jekyll_plugin_logger!
+
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Generates Jekyll logger with colored output.
+test_files:
+- spec/jekyll_plugin_logger.rb
+- spec/spec_helper.rb