cogger 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c31256d5e4f8446c023227a43adb18992c566a027c61f7b3356cea081662b2ed
-  data.tar.gz: 0ef798366fa9b799dbf24967e656ae5840d14e62953aad6c551aac462e0ff1a4
+  metadata.gz: 925679ac5f76d9dcd1d9dedde73857a6ca6f66b214321926d63b47a56b4eb857
+  data.tar.gz: db34b9122766c6f2b2f914435bd42c41a6b5b77a0b6be2b0352c0630f669c41f
 SHA512:
-  metadata.gz: 242434b94151c9072d5dd0bbd5c8985a2020001ed6bd30eb406684755595bac2747c298c694a7c945f3da06a358fceb94b60a8a095c79c169ef2ab55db19411b
-  data.tar.gz: b3e3e7d9ee7d95b987d6c51c019f8811e0ac1aa9ddbe700997be59c51bf64b13a4903c27c985ffc83d50b7ab90a799bcb842db9aa15875cdb1f40aa8a24e88c7
+  metadata.gz: f404fed5aa1db3c8c118586976895c55a231883cbac4a8f386795729a58574103585637440597ea21939ecf6fd32530b616205884aea9bbd50f9f45e6139eeff
+  data.tar.gz: 623939be083087672ed80f20bc8a7641793ec19ded0191bb54f8eb3b72f0a535eeebdc1ae17c5072800198a19b49aef626bfd901264dfff4824a07466be777f0

data/README.adoc

@@ -115,6 +115,7 @@ When creating a new logger, you can configure behavior via the following attribu
 * `formatter`: The formatter to use for formatting your log output. Default: `Cogger::Formatter::Color`. See the _Formatters_ section for more info.
 * `tags`: The global tags used for all log entries. _Must_ be an array of objects you wish to use for tagging purposes. Default: `[]`.
 * `datetime_format`: The global date/time format used for all `Time`, `Date`, and/or `DateTime` values in your log entries. Default: `%Y-%m-%dT%H:%M:%S.%L%:z`.
+* `header`: Determines if your log files should start with a date/time header comment. Can be `true` or `false` and is identical to the `skip_header` functionality found in the {logger_link} class. Default: `true`. This is automatically disabled -- and can't be overwritten -- when using the JSON formatter since the JSON format doesn't support code comments.
 * `mode`: The binary mode which determines if your logs should be written in binary mode or not. Can be `true` or `false` and is identical to the `binmode` functionality found in the {logger_link} class. Default: `false`.
 * `age`: The rotation age of your log. This only applies when logging to a file. This is equivalent to the `shift_age` as found with the {logger_link} class. Default: `0`.
 * `size`: The rotation size of your log. This only applies when logging to a file. This is equivalent to the `shift_size` as found with the {logger_link} class. Default: `1,048,576` (i.e. 1 MB).
@@ -134,6 +135,7 @@ logger = Cogger.new id: :demo,
                     formatter: :json,
                     tags: %w[DEMO DB],
                     datetime_format: "%Y-%m-%d",
+                    header: false,
                     mode: false,
                     age: 5,
                     size: 1_000,
@@ -236,8 +238,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:
@@ -616,7 +617,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:
@@ -943,9 +944,7 @@ To add filters, use:
 
 [source,ruby]
 ----
-Cogger.add_filter(:login)
-      .add_filter "email"
-
+Cogger.add_filters :login, "email"
 Cogger.filters  # #<Set: {:login, :email}>
 ----
 
@@ -953,7 +952,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"
 
@@ -1186,8 +1185,9 @@ logger.inspect
 #                @formatter=Cogger::Formatters::Emoji,
 #                @datetime_format=\"%Y-%m-%dT%H:%M:%S.%L%:z\",
 #                @tags=[],
+#                @header=true,
 #                @mode=false,
-#                @age=0,
+#                @age=,
 #                @size=1048576,
 #                @suffix=\"%Y-%m-%d\",
 #                @entry=Cogger::Entry,

data/cogger.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "cogger"
-  spec.version = "1.4.0"
+  spec.version = "1.6.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

@@ -13,6 +13,7 @@ module Cogger
     :formatter,
     :datetime_format,
     :tags,
+    :header,
     :mode,
     :age,
     :size,
@@ -29,6 +30,7 @@ module Cogger
                    formatter: Formatters::Emoji.new,
                    datetime_format: DATETIME_FORMAT,
                    tags: Core::EMPTY_ARRAY,
+                   header: true,
                    mode: false,
                    age: nil,
                    size: 1_048_576,
@@ -49,6 +51,7 @@ module Cogger
                  level:,
                  formatter:,
                  datetime_format:,
+                 skip_header: skip_header?,
                  binmode: mode,
                  shift_period_suffix: suffix
     end
@@ -56,8 +59,12 @@ module Cogger
     def inspect
       "#<#{self.class} @id=#{id}, @io=#{io.class}, @level=#{level}, " \
       "@formatter=#{formatter.class}, @datetime_format=#{datetime_format.inspect}, " \
-      "@tags=#{tags.inspect}, @mode=#{mode}, @age=#{age}, @size=#{size}, " \
+      "@tags=#{tags.inspect}, @header=#{header}, @mode=#{mode}, @age=#{age}, @size=#{size}, " \
       "@suffix=#{suffix.inspect}, @entry=#{entry}, @logger=#{logger}>"
     end
+
+    private
+
+    def skip_header? = formatter == :json || formatter.is_a?(Formatters::JSON) || !header
   end
 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

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.4.0
+  version: 1.6.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.7.1
+rubygems_version: 3.7.2
 specification_version: 4
 summary: A customizable and feature rich logger.
 test_files: []