cogger 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c81fa9c3fdd3ce5ef1db012304946e95dd84c5c9087f5a82b6029f507f278c51
-  data.tar.gz: fb40393d822afe21906b559bca98bdf602875b2d78ca38a843a58ad34154d4f6
+  metadata.gz: 051cbeb63381e6680f86fd1b73a1e6648d6ecc1befc37824d0425cbb12d0fb63
+  data.tar.gz: 8772b28a29157d2f023096eaf40ba28c252888e3430e5ddc673ade49888b7da2
 SHA512:
-  metadata.gz: 1975f4568ca48b1d0f6851a66d255b43cc57c79849ab6edafc621f2705ffbe6ae116aad3cc76d024ab67cd5b17d431795fddda0de9083062876192176fe71d3a
-  data.tar.gz: 7f0c08112e4510dd7120e5e2c4ecd8cb98a3a35fa13087ebd6252e9367d81574a46e44365697637a3b4bc2e9de9c6823b897ff8ecc1d13d06aef002ec947dd55
+  metadata.gz: 4b290ebea636e3744c68dd07c1cd37bd310fa3c99600a8b7a32ed93dcdcc651559ff718fcfe43446c7bad91772ba25eb4bb60bfe0ff9f2c6f85d8158dc58c9c1
+  data.tar.gz: 163afc50ba9118ab76f2ff75f351b4d2b60992b29f317bbfab218e310ada42890fec1e5cfed6993bde0421d67126b65038adbe7b81791f062c07ae82e32c3143

data/README.adoc

@@ -182,7 +182,7 @@ export LOG_LEVEL=fatal
 export LOG_LEVEL=unknown
 ----
 
-While downcase is preferred for each log level value, you can use upcased values as well. If the `LOG_LEVEL` environment variable is not set, `Cogger` will fall back to `"info"` unless overwritten during initialization. Example: `Cogger.new level: :debug`. Otherwise, an invalid log level will result in an `ArgumentError`.
+While lower case is preferred for each log level value, you can use upper case values as well. If the `LOG_LEVEL` environment variable is not set, `Cogger` will fall back to `"info"` unless overwritten during initialization. Example: `Cogger.new level: :debug`. Otherwise, an invalid log level will result in an `ArgumentError`.
 
 === Mutations
 
@@ -457,7 +457,7 @@ Additional keys as provided by your message hash and/or tags can be customized a
 Template keys, emojis, and elements do have a few restrictions:
 
 * Use the special `emoji` key to provide dynamic or specific emoji logging.
-* Use the special `tags` key to provide tagged logging. More information on tags can be found later in this document.
+* Use the special `tags` key to provide tagged logging. For more information, the _Tags_ section below.
 * Avoid supplying the same keys as the default keys. Example: `logger.info id: :bad, at: Time.now, level: :bogus`. This is because these keys will be ignored. In other words, you can't _override_ the default keys.
 * Avoid wrapping keys and/or emojis in elements because nesting isn't supported and can lead to strange output. Example: `<green>%<emoji:error>s %<id:dynamic>s</green>`.
 * Avoid wrapping elements within elements because nesting isn't supported and can lead to strange output. Example: `<dynamic><cyan>%<message>s</cyan></dynamic>`.
@@ -757,8 +757,7 @@ logger.info "Demo", tags: ["WEB", "PRIMARY", {service: :api, demo: true}]
 #   "level":"INFO",
 #   "at":"2023-12-10T18:44:32.723+00:00",
 #   "message":"Demo",
-#   "tags":["WEB",
-#   "PRIMARY"],
+#   "tags":["WEB", "PRIMARY"],
 #   "service":"api",
 #   "demo":true
 # }
@@ -929,6 +928,7 @@ As you can see, tags are highly versatile. That said, the following guidelines a
 * Prefer consistent tag names by using tags that are not synonymous or ambiguous.
 * Prefer using tags by feature rather than things like environments. Examples: API, DB, MAILER.
 * Prefer the JSON formatter for structured metadata instead of tags. Logging JSON formatted messages with tags will work but sticking with a traditional hash, instead of tags, will probably serve you better.
+* Avoid using `id`, `level`, `at`, and/or `message` as hash keys since those are reserved keys and will be rejected if supplied.
 
 === Filters
 
@@ -970,14 +970,25 @@ You can add multiple log streams (outputs) by using:
 
 [source,ruby]
 ----
+require "stringio"
+
+buffer = StringIO.new
 logger = Cogger.new
+               .add_stream(io: buffer)
                .add_stream(io: "tmp/demo.log")
                .add_stream(io: nil)
 
 logger.info "Demo."
 ----
 
-The above would log the `"Demo."` message to `$stdout` -- the default stream -- to the `tmp/demo.log` file, and to `/dev/null`. All attributes used to construct your default logger apply to all additional streams unless customized further. This means any custom template/formatter can be applied to your streams. Example:
+The above would log `"Demo."` to:
+
+* To `$stdout` (the default stream which is your console).
+* To the StringIO `buffer` where you can use `buffer.string` to view content.
+* To the `tmp/demo.log` file where you can use `cat tmp/demo.log` to view content.
+* To `/dev/null` which immediately ignores all writes.
+
+All attributes used to construct your default logger apply to all additional streams unless customized further. This means any custom template/formatter can be applied to your streams. Example:
 
 [source,ruby]
 ----

data/cogger.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "cogger"
-  spec.version = "2.2.0"
+  spec.version = "2.3.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/cogger"
@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "logger", "~> 1.7"
   spec.add_dependency "refinements", "~> 14.0"
   spec.add_dependency "tone", "~> 3.0"
-  spec.add_dependency "zeitwerk", "~> 2.7"
+  spec.add_dependency "zeitwerk", "~> 2.8"
 
   spec.extra_rdoc_files = Dir["README*", "LICENSE*"]
   spec.files = Dir["*.gemspec", "lib/**/*"]

data/lib/cogger/tag.rb

@@ -5,18 +5,24 @@ require "refinements/hash"
 
 module Cogger
   # Models a tag which may consist of an array and/or hash.
-  Tag = Data.define :singles, :pairs do
+  Tag = Data.define :singles, :pairs, :exclusions do
     using Refinements::Hash
 
-    def self.for(*bag)
-      bag.each.with_object new do |item, tag|
+    def self.for(*bag) = new(**reduce(bag))
+
+    def self.reduce bag
+      bag.each.with_object({singles: [], pairs: {}}) do |item, all|
         value = item.is_a?(Proc) ? item.call : item
-        value.is_a?(Hash) ? tag.pairs.merge!(value) : tag.singles.append(value)
+        value.is_a?(Hash) ? all[:pairs].merge!(value) : all[:singles].append(value)
       end
     end
 
-    def initialize singles: [], pairs: {}
-      super
+    private_class_method :reduce
+
+    def initialize singles: [], pairs: {}, exclusions: %w[id level at message]
+      filtered_pairs = pairs.reject { |key, _| exclusions.include? key.to_s }
+
+      super singles:, pairs: filtered_pairs, exclusions:
     end
 
     def empty? = singles.empty? && pairs.empty?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cogger
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -97,14 +97,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.8'
 email:
 - brooke@alchemists.io
 executables: []
@@ -175,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.12
 specification_version: 4
 summary: A customizable and feature rich logger.
 test_files: []