cogger 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af05bac1bb9c038a63ab4b3a2cab4c88d9da636773fe625215e9b5ec07dbfef9
-  data.tar.gz: be3aa6d32adcd4848a385027db21548f9233960024db003d3a855bb1ac654e4c
+  metadata.gz: 492646c716b64bbf80f9aa93bf0092220068b00ef8abe89bc8baaaef9f3464f7
+  data.tar.gz: 834d46200c376ffc6c538e229ae5f5ca4b44ba0beed3c2724e5585ebc8aca642
 SHA512:
-  metadata.gz: f38ac069cb48f265aac5f2a33289a2b0b4a2733dcc295a9fab24e56a165aa1d26d00bf065b237c831a2eb75052e987afe87d6a7aa3aa46469faa8deb7c2c268b
-  data.tar.gz: 12c247340142fa2ae5964971aec4c15f788f3106bdda1a10bd000fe1ceacab566a74a9793346f3f2a3f2b72f8a3fa3a37e8ffd476f860266dd63a4b3c7a156e3
+  metadata.gz: cc80eb9f305539d61932c5c5a95e01dfeb18ee76dee502049aabac4073ab37ee33ef45dbd73e7df6637b23f5b4e623df0e144e01a64755c646513bfe3dd45e0c
+  data.tar.gz: 7c52fdfd07d8e2595f2f02e28b9546c4b7d389a9b7ae3f32feb686d8719a07533581f5b5ea28c0a0ab2684e457d7a3a8cc6e8b49ebfa0831deb6dbb1ffda5d95

data/README.adoc

@@ -236,8 +236,7 @@ To add multiple custom emojis, you can chain messages together when registering
 
 [source,ruby]
 ----
-Cogger.add_emoji(:tada, "🎉")
-      .add_emoji :favorite, "❇️"
+Cogger.add_emojis tada: "🎉", favorite: "❇️"
 ----
 
 If you always want to use the _same_ emoji, you could use the emoji formatter with a specific template:
@@ -282,6 +281,26 @@ Aliases are a powerful way to customize colors via concise syntax in your templa
 
 💡 Aliases are used by the color and emoji formatters so check out the {tone_link} documentation and/or _Templates_ and _Formatters_ sections below to learn more.
 
+=== Encodings
+
+All messages use UTF-8 encoding. Any unknown character will show up as a question mark. Example:
+
+[source,ruby]
+----
+logger = Cogger.new
+bad = "b\xE9d".dup.force_encoding "ASCII-8BIT"
+
+logger.info bad      # "b?d"
+logger.info { bad }  # "b?d"
+----
+
+The underlying implementation uses the following to produce the logs shown above:
+
+[source,ruby]
+----
+message.encode "UTF-8", invalid: :replace, undef: :replace, replace: "?"
+----
+
 === Templates
 
 Templates are used by all formatters and adhere to an _enhanced_ version of the {format_link} as used by `Kernel#format`. Here’s what is provided by default:
@@ -596,7 +615,7 @@ This allows an emoji to be dynamically applied based on log level. You can add o
 
 [source,ruby]
 ----
-Cogger.add_emoji :warn, "🟡"
+Cogger.add_emojis warn: "🟡"
 ----
 
 Once an alias is added/updated, it can be immediately applied via the template of your formatter. Example:
@@ -746,6 +765,41 @@ logger.info "Demo", tags: ["WEB", "PRIMARY", {service: :api, demo: true}]
 
 Notice, with the above, that the single tags of `WEB` and `PRIMARY` show up in the `tags` array while the `:service` and `:demo` keys show up at the top level of the hash. Since the `:tags`, `:service`, `:demo` keys are normal keys, like any key in your JSON output, this means you can use a custom template to arrange the order of these keys if you don't like the default.
 
+A block can be used with a string or hash for content. Example:
+
+[source,ruby]
+----
+logger = Cogger.new formatter: :json
+
+logger.info { "Demo" }
+# {
+#   "id":"console",
+#   "level":"INFO",
+#   "at":"2025-08-03T13:37:58.227-06:00",
+#   "message":"Demo"
+# }
+
+logger.info { {message: :demo, weight: 0.2} }
+# {
+#   "id":"console",
+#   "level":"INFO",
+#   "at":"2025-08-03T13:39:32.438-06:00",
+#   "message":"demo",
+#   "weight":0.2
+# }
+
+logger.info(tags: %w[WEB PRIMARY]) { {message: :demo, weight: 0.2} }
+# {
+#   "id":"console",
+#   "level":"INFO",
+#   "at":"2025-08-03T13:42:22.869-06:00",
+#   "message":"demo",
+#   "tags":["WEB",
+#   "PRIMARY"],
+#   "weight":0.2
+# }
+----
+
 ==== Rack
 
 This formatter is the _Simple_ formatter with a different template and can be configured as follows:
@@ -888,9 +942,7 @@ To add filters, use:
 
 [source,ruby]
 ----
-Cogger.add_filter(:login)
-      .add_filter "email"
-
+Cogger.add_filters :login, "email"
 Cogger.filters  # #<Set: {:login, :email}>
 ----
 
@@ -898,7 +950,7 @@ Symbols and strings can be used interchangeably but are stored as symbols since
 
 [source,ruby]
 ----
-Cogger.add_filter :password
+Cogger.add_filters :password
 logger = Cogger.new formatter: :json
 logger.info login: "jayne", password: "secret"
 

data/cogger.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "cogger"
-  spec.version = "1.3.0"
+  spec.version = "1.5.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/cogger"
@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = "~> 3.4"
   spec.add_dependency "core", "~> 2.0"
   spec.add_dependency "logger", "~> 1.7"
-  spec.add_dependency "refinements", "~> 13.3"
+  spec.add_dependency "refinements", "~> 13.5"
   spec.add_dependency "tone", "~> 2.0"
   spec.add_dependency "zeitwerk", "~> 2.7"
 

data/lib/cogger/configuration.rb

@@ -18,7 +18,8 @@ module Cogger
     :size,
     :suffix,
     :entry,
-    :logger
+    :logger,
+    :mutex
   ) do
     using Refinements::Array
 
@@ -33,7 +34,8 @@ module Cogger
                    size: 1_048_576,
                    suffix: "%Y-%m-%d",
                    entry: Entry,
-                   logger: Logger
+                   logger: Logger,
+                   mutex: Mutex.new
       super.tap { tags.freeze }
     end
 

data/lib/cogger/entry.rb

@@ -5,11 +5,13 @@ require "core"
 module Cogger
   # Defines a log entry which can be formatted for output.
   Entry = Data.define :id, :level, :at, :message, :tags, :datetime_format, :payload do
-    def self.for(message = nil, **payload)
+    def self.for(message = nil, **payload, &)
+      content = block_given? ? yield : message
+
       new id: payload.delete(:id) || Program.call,
           level: (payload.delete(:level) || "INFO").upcase,
           at: payload.delete(:at) || ::Time.now,
-          message: (block_given? ? yield : message),
+          message: sanitize!(content, payload),
           tags: Array(payload.delete(:tags)),
           datetime_format: payload.delete(:datetime_format) || DATETIME_FORMAT,
           payload:
@@ -26,6 +28,22 @@ module Cogger
           }
     end
 
+    def self.sanitize! content, payload
+      body = if content.is_a? Hash
+               content.delete(:message).tap { payload.merge! content }
+             else
+               content
+             end
+
+      if body.is_a? String
+        body.encode "UTF-8", invalid: :replace, undef: :replace, replace: "?"
+      else
+        body
+      end
+    end
+
+    private_class_method :sanitize!
+
     def initialize id: Program.call,
                    level: "INFO",
                    at: ::Time.now,

data/lib/cogger/formatters/abstract.rb

@@ -23,8 +23,8 @@ module Cogger
 
       protected
 
-      def sanitize entry, message
-        entry.public_send(message).tap do |attributes|
+      def sanitize entry, method
+        entry.public_send(method).tap do |attributes|
           filter attributes
           attributes.transform_values! { |value| format_time value, format: entry.datetime_format }
         end

data/lib/cogger/formatters/parsers/position.rb

@@ -10,7 +10,7 @@ module Cogger
           ?             # Flag, width, or precision.
           <             # Reference start.
           (?<name>\w+)  # Name.
-          (?::[\w]+)?   # Optional delimiter and directive.
+          (?::\w+)?     # Optional delimiter and directive.
           >             # Reference end.
           ?             # Specifier.
         /x
@@ -19,10 +19,8 @@ module Cogger
           @pattern = pattern
         end
 
-        # :reek:FeatureEnvy
         def call template, attributes
-          return attributes if !template || template.empty?
-          return attributes unless template.match? pattern
+          return attributes unless String(template).match? pattern
 
           keys = scan template
           attributes.slice(*keys).merge!(attributes.except(*keys))

data/lib/cogger/hub.rb

@@ -6,7 +6,6 @@ require "refinements/hash"
 
 module Cogger
   # Loads configuration and simultaneously sends messages to multiple streams.
-  # :reek:TooManyInstanceVariables
   # :reek:TooManyMethods
   class Hub
     extend Forwardable
@@ -40,7 +39,6 @@ module Cogger
       @configuration = model[**find_formatter(attributes)]
       @primary = configuration.to_logger
       @streams = [@primary]
-      @mutex = Mutex.new
     end
 
     def add_stream **attributes
@@ -80,7 +78,7 @@ module Cogger
 
     private
 
-    attr_reader :registry, :configuration, :primary, :streams, :mutex
+    attr_reader :registry, :configuration, :primary, :streams
 
     # :reek:FeatureEnvy
     def find_formatter attributes
@@ -110,7 +108,7 @@ module Cogger
         &
       )
 
-      mutex.synchronize { streams.each { |logger| logger.public_send level, entry } }
+      configuration.mutex.synchronize { streams.each { |logger| logger.public_send level, entry } }
       true
     end
     # rubocop:enable Metrics/MethodLength

data/lib/cogger/registry.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
+require "refinements/hash"
 require "tone"
 
 module Cogger
   # Provides a global regsitry for global configuration.
   module Registry
+    using Refinements::Hash
+
     def self.extended descendant
       descendant.add_alias(:debug, :white)
                 .add_alias(:info, :green)
@@ -12,12 +15,14 @@ module Cogger
                 .add_alias(:error, :red)
                 .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_emojis(
+                  debug: "🔎",
+                  info: "🟢",
+                  warn: "⚠️",
+                  error: "🛑",
+                  fatal: "🔥",
+                  any: "⚫️"
+                )
                 .add_formatter(:color, Cogger::Formatters::Color)
                 .add_formatter(
                   :detail,
@@ -42,10 +47,18 @@ module Cogger
     def aliases = color.aliases
 
     def add_emoji key, value
+      warn "`#{self.class}##{__method__}` is deprecated, use `#add_emojis` instead.",
+           category: :deprecated
+
       emojis[key.to_sym] = value
       self
     end
 
+    def add_emojis(**attributes)
+      emojis.merge! attributes.symbolize_keys!
+      self
+    end
+
     def get_emoji key
       emojis.fetch(key.to_sym) { fail KeyError, "Unregistered emoji: #{key}." }
     end
@@ -53,10 +66,18 @@ module Cogger
     def emojis = @emojis ||= {}
 
     def add_filter key
+      warn "`#{self.class}##{__method__}` is deprecated, use `#add_filters` instead.",
+           category: :deprecated
+
       filters.add key.to_sym
       self
     end
 
+    def add_filters(*keys)
+      filters.merge(keys.map(&:to_sym))
+      self
+    end
+
     def filters = @filters ||= Set.new
 
     def add_formatter key, formatter, template = nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cogger
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -69,14 +69,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.3'
+        version: '13.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.3'
+        version: '13.5'
 - !ruby/object:Gem::Dependency
   name: tone
   requirement: !ruby/object:Gem::Requirement
@@ -175,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.1
 specification_version: 4
 summary: A customizable and feature rich logger.
 test_files: []