cogger 0.7.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3226b0b30d4c6a4eba83e9aec637de1938ac852f8a7e1bbd3b4a07d501d67920
-  data.tar.gz: 4e00980079107adbb150c4b03f7d80f63ede92fe6fbbb628642d532dc9d82e9b
+  metadata.gz: 532289692d890ee67b30d2e4b5f725a43c1360ed37e4f58f3cd7885cbac1ac2e
+  data.tar.gz: e3e7edbc8ae802edab77418c9770b65edb6d3a152a6db8914902779a1df1b943
 SHA512:
-  metadata.gz: cf70a4540105ad59bc4237c9d654e2db5191eeb00b504391a465957b28d7d2fbb7c418969d30762fc8fe0f57ea97893be8980432ab7c2bd0b5643f9fea81ec02
-  data.tar.gz: d731085187625db4b92c45cc30eaff79c763d47c9e169d3e24a672627f9e2d144b40e4cd49074ce5afb47d05aa1e43c9cd29c0f2c97494d6f91d35e860a8e799
+  metadata.gz: 8ccb37f5593cc139a445926860861a3bb03ebb9bab11a077100dba47ec262b1b595ee5a30c501aed280063c42a6fac12ea8c3038b5f773dfb298b20aae3607ef
+  data.tar.gz: 66ec62a82933c8063431daf5eb132e68df7c08aeffeaa55754660e2386abb868c627126cd009da08dde5976c853e83adc5567c453ed9454d4f78f3506e6ee382

data/README.adoc

@@ -6,11 +6,10 @@
 :logger_link: link:https://rubyapi.org/o/s?q=Logger[Logger]
 :format_link: link:https://ruby-doc.org/3.2.1/format_specifications_rdoc.html[Format Specification]
 :pattern_matching_link: link:https://alchemists.io/articles/ruby_pattern_matching[pattern matching]
-:refinements_link: link:https://alchemists.io/projects/refinements[Refinements]
 
 = Cogger
 
-Cogger is a portmanteau for custom logging (i.e. `[c]ustom + l[ogger] = cogger`) which enhances Ruby's native {logger_link} functionality with additional features such as dynamic emojis, colorized text, structured JSON, multiple outputs, and much more. 🚀
+Cogger is a portmanteau for custom logger (i.e. `[c]ustom + l[ogger] = cogger`) which enhances Ruby's native {logger_link} functionality with additional features such as dynamic emojis, colorized text, structured JSON, multiple outputs, and much more. 🚀
 
 toc::[]
 
@@ -24,9 +23,31 @@ toc::[]
 * Provides multiple streams so you can log the same information to several outputs at once.
 * Provides filtering of sensitive information.
 
-== Screenshot
+== Screenshots
 
-image::https://alchemists.io/images/projects/cogger/screenshots/console.png[Console,width=1139,height=211,role=focal_point]
+*Emoji*
+
+image::https://alchemists.io/images/projects/cogger/screenshots/emoji.png[Emoji,width=150,height=130]
+
+*Color*
+
+image::https://alchemists.io/images/projects/cogger/screenshots/color.png[Color,width=150,height=125]
+
+*Simple*
+
+image::https://alchemists.io/images/projects/cogger/screenshots/simple.png[Simple,width=150,height=125]
+
+*Detail*
+
+image::https://alchemists.io/images/projects/cogger/screenshots/detail.png[Detail,width=350,height=130]
+
+*JSON*
+
+image::https://alchemists.io/images/projects/cogger/screenshots/json.png[JSON,width=803,height=130]
+
+*Rack*
+
+image::https://alchemists.io/images/projects/cogger/screenshots/rack.png[Rack,width=534,height=130]
 
 == Requirements
 
@@ -99,13 +120,6 @@ logger.unknown { "demo" }  # "demo"
 logger.any { "demo" }      # "demo"
 ----
 
-...or, if you'd like to display all severities at once, use:
-
-[source,ruby]
-----
-%i[debug info warn error fatal unknown any].each { |severity| logger.public_send severity, "demo" }
-----
-
 === Initialization
 
 When creating a new logger, you can configure behavior via the following attributes:
@@ -228,7 +242,8 @@ Cogger.emojis
 #    :info => "🟢",
 #    :warn => "⚠️ ",
 #   :error => "🛑",
-#   :fatal => "🔥"
+#   :fatal => "🔥",
+#     :any => "⚫️"
 # }
 ----
 
@@ -356,6 +371,8 @@ logger = Cogger.new formatter: :simple
 logger = Cogger.new formatter: :rack
 ----
 
+ℹ️ Any leading or trailing whitespace is automatically removed after the template has been formatted in order to account for template attributes that might be `nil` or empty strings so you don't have visual indentation in your output.
+
 ==== Color
 
 The color formatter is enabled by default and is the equivalent of initializing with either of the following:
@@ -381,8 +398,7 @@ Cogger.aliases
 #   warn: :yellow,
 #   error: :red,
 #   fatal: %i[bold white on_red],
-#   unknown: %i[bold white],
-#   any: %i[bold white]
+#   any: %i[dim bright_white]
 # }
 ----
 
@@ -401,6 +417,8 @@ Once an alias is added, it can be immediately applied via the template of your f
 logger = Cogger.new formatter: Cogger::Formatters::Color.new("<mystery>%<message>s</mystery>")
 ----
 
+ℹ️ Much like the simple formatter, any leading or trailing whitespace is automatically after the template has been formatted.
+
 ==== JSON
 
 This formatter is similar in behavior to the _simple_ formatter except the template allows you to order the layout of your keys only. All other information is ignored. To use:
@@ -422,6 +440,20 @@ logger.info verb: "GET", path: "/"
 
 Your template can be a full or partial match of keys. If no keys match what is defined in the template, then the original order of the keys will be used instead.
 
+==== Original
+
+Should you wish to use the original formatter as provided by original/native {logger_link}, you can get that behavior by specifying it as your preferred formatter. Example:
+
+[source,ruby]
+----
+require "logger"
+
+logger = Cogger.new formatter: Logger::Formatter.new
+logger.info "demo"
+
+# I, [2023-04-11T19:35:51.175733 #84790]  INFO -- console: demo
+----
+
 ==== Custom
 
 Should none of the built-in formatters be to your liking, you can implement, use, and/or register a custom formatter as well. The most minimum, bare bones, skeleton would be:
@@ -523,9 +555,7 @@ This is primarily meant for display/inspection purposes, though.
 
 === Testing
 
-When testing the Cogger client, you might find it convenient to use `StringIO`, or a file, for
-logging purposes in order to not pollute your test output but also have a convenient way to see what
-was logged. Example:
+When testing, you might find it convenient to rewind and read from the stream you are writing too (i.e. `IO`, `StringIO`, `File`). For instance, here is an example where I inject the default logger into my `Demo` class and then, for testing purposes, create a new logger to be injected which only logs to `StringIO` so I can buffer and read for test verification:
 
 [source,ruby]
 ----
@@ -542,24 +572,20 @@ class Demo
 end
 
 RSpec.describe Demo do
-  using Refinements::StringIOs
-
   subject(:demo) { described_class.new logger: }
 
-  let(:logger) { Cogger.new io: }
-  let(:io) { StringIO.new }
+  let(:logger) { Cogger.new io: StringIO.new }
 
   describe "#say" do
     it "logs text" do
       demo.say "test"
-      expect(io.reread).to include("test")
+      expect(logger.reread).to include("test")
     end
   end
 end
 ----
 
-Notice that when testing the instance of `Demo` and injecting a logger which logs to a string I/O
-object, you can conveniently _reread_ the string -- provided by the {refinements_link} gem -- to see what was logged. This makes your specs easier to write while avoiding additional noise in your test suite's output.
+The ability to `#reread` is only available for the default (first) stream and doesn't work with any additional streams that you add to your logger. That said, this does make it easy to test the `Demo` implementation while also keeping your test suite output clean at the same time. 🎉
 
 == Development
 
@@ -579,6 +605,8 @@ You can also use the IRB console for direct access to all objects:
 bin/console
 ----
 
+Lastly, there is a `bin/show` script which displays multiple log formats for quick visual reference. This is the same script used to generate the screenshots shown at the top of this document.
+
 == Tests
 
 To test, run:

data/cogger.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "cogger"
-  spec.version = "0.7.1"
+  spec.version = "0.9.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/cogger"
@@ -23,7 +23,8 @@ Gem::Specification.new do |spec|
   spec.cert_chain = [Gem.default_cert_path]
 
   spec.required_ruby_version = "~> 3.2"
-  spec.add_dependency "tone", "~> 0.1"
+  spec.add_dependency "refinements", "~> 10.0"
+  spec.add_dependency "tone", "~> 0.2"
   spec.add_dependency "zeitwerk", "~> 2.6"
 
   spec.extra_rdoc_files = Dir["README*", "LICENSE*"]

data/lib/cogger/client.rb

@@ -14,7 +14,11 @@ module Cogger
 
     delegate %i[formatter level progname debug info warn error fatal unknown] => :logger
 
+    # :reek:TooManyStatements
     def initialize logger = Logger.new($stdout), color: Cogger.color, **attributes
+      warn "#{self.class}##{__method__} is deprecated, use `Cogger.new` instead.",
+           category: :deprecated
+
       @logger = logger
       @color = color
       @attributes = attributes

data/lib/cogger/formatters/color.rb

@@ -13,7 +13,7 @@ module Cogger
 
       def call(*entry)
         updated_template, attributes = processor.call(template, *entry)
-        "#{format(updated_template, **attributes)}\n"
+        "#{format(updated_template, **attributes).tap(&:strip!)}\n"
       end
 
       private

data/lib/cogger/formatters/simple.rb

@@ -11,7 +11,7 @@ module Cogger
         @sanitizer = sanitizer
       end
 
-      def call(*entry) = "#{format template, sanitizer.call(*entry)}\n"
+      def call(*entry) = "#{format(template, sanitizer.call(*entry)).tap(&:strip!)}\n"
 
       private
 

data/lib/cogger/hub.rb

@@ -1,20 +1,27 @@
 # frozen_string_literal: true
 
 require "logger"
+require "refinements/hashes"
+require "refinements/loggers"
 
 module Cogger
   # Loads configuration and simultaneously sends messages to multiple streams.
+  # :reek:TooManyInstanceVariables
   class Hub
+    using Refinements::Loggers
+    using Refinements::Hashes
+
     def initialize(registry: Cogger, model: Configuration.new, **attributes)
       @registry = registry
-      @configuration = model.with(**transform(attributes))
+      @configuration = model.with(**find_formatter(attributes))
+      @primary = configuration.to_logger
+      @streams = [@primary]
       @mutex = Mutex.new
-      @streams = [configuration.to_logger]
     end
 
     def add_stream **attributes
       attributes[:id] = configuration.id
-      streams.append configuration.with(**transform(attributes)).to_logger
+      streams.append configuration.with(**find_formatter(attributes)).to_logger
       self
     end
 
@@ -32,24 +39,25 @@ module Cogger
 
     alias any unknown
 
+    def reread = primary.reread
+
     def inspect
       %(#<#{self.class} #{configuration.inspect.delete_prefix! "#<Cogger::Configuration "})
     end
 
     private
 
-    attr_reader :registry, :configuration, :mutex, :streams
-
-    # :reek:FeatureEnvy
-    # :reek:TooManyStatements
-    def transform attributes
-      value = attributes[:formatter]
+    attr_reader :registry, :configuration, :primary, :streams, :mutex
 
-      return attributes unless value.is_a?(Symbol) || value.is_a?(String)
+    def find_formatter attributes
+      attributes.transform_with!(
+        formatter: lambda do |value|
+          return value unless value.is_a?(Symbol) || value.is_a?(String)
 
-      formatter, template = registry.get_formatter value
-      attributes[:formatter] = template ? formatter.new(template) : formatter.new
-      attributes
+          formatter, template = registry.get_formatter value
+          template ? formatter.new(template) : formatter.new
+        end
+      )
     end
 
     # :reek:TooManyStatements

data/lib/cogger/registry.rb

@@ -10,14 +10,14 @@ module Cogger
             .add_alias(:info, :green)
             .add_alias(:warn, :yellow)
             .add_alias(:error, :red)
-            .add_alias(:fatal, *%i[bold white on_red])
-            .add_alias(:unknown, *%i[bold white])
-            .add_alias(:any, *%i[bold white])
+            .add_alias(:fatal, :bold, :white, :on_red)
+            .add_alias(:any, :dim, :bright_white)
             .add_emoji(:debug, "🔎")
             .add_emoji(:info, "🟢")
             .add_emoji(:warn, "⚠️ ")
             .add_emoji(:error, "🛑")
             .add_emoji(:fatal, "🔥")
+            .add_emoji(:any, "⚫️")
             .add_filter(:_csrf)
             .add_filter(:password)
             .add_filter(:password_confirmation)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cogger
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,22 +35,36 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2023-04-11 00:00:00.000000000 Z
+date: 2023-04-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: refinements
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: tone
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -119,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
 summary: A customizable logger.