cogger 1.6.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 925679ac5f76d9dcd1d9dedde73857a6ca6f66b214321926d63b47a56b4eb857
-  data.tar.gz: db34b9122766c6f2b2f914435bd42c41a6b5b77a0b6be2b0352c0630f669c41f
+  metadata.gz: 1a8655e0aee27b95221e80234335e5c4850bf2b39729ab2f70c6ce817fe758bd
+  data.tar.gz: dcd69cd1c13ac6528851ac92a18facb31f4bf6b2056fb7ba8c7244669bf03744
 SHA512:
-  metadata.gz: f404fed5aa1db3c8c118586976895c55a231883cbac4a8f386795729a58574103585637440597ea21939ecf6fd32530b616205884aea9bbd50f9f45e6139eeff
-  data.tar.gz: 623939be083087672ed80f20bc8a7641793ec19ded0191bb54f8eb3b72f0a535eeebdc1ae17c5072800198a19b49aef626bfd901264dfff4824a07466be777f0
+  metadata.gz: 51f1a9346fcb583164b34ce3d1e071ff75d4a134e3dfd491272c7368e4c145b53a0b3455aca50ee9a40c63b7ffa2163075ee856ddab519789fb78fdae24b8ca2
+  data.tar.gz: 319268287863d76706c2854fec96e4e8fd03ada640fc580ec4f99830133a1901b5cec7174b7b4dc1087f5e680a597822fef5a475c28be1f0dcd17b3de9c84bb2

data/README.adoc

@@ -112,10 +112,10 @@ When creating a new logger, you can configure behavior via the following attribu
 * `id`: The program/process ID which shows up in the logs as your `id`. Default: `$PROGRAM_NAME`. For example, if run within a `demo.rb` script, the `id` would be `"demo"`,
 * `io`: The input/output stream. This can be `STDOUT/$stdout`, a file/path, or `nil`. Default: `$stdout`.
 * `level`: The log level you want to log at. Can be `:debug`, `:info`, `:warn`, `:error`, `:fatal`, or `:unknown`. Default: `:info`.
-* `formatter`: The formatter to use for formatting your log output. Default: `Cogger::Formatter::Color`. See the _Formatters_ section for more info.
+* `formatter`: The formatter to use for formatting your log output. Default: `Cogger::Formatter::Emoji`. 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.
+* `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%:z` ({rfc_3339_link}).
+* `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: `false`. 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).
@@ -158,8 +158,7 @@ The default date/time format used for _all_ log values can be viewed via the fol
 
 [source,ruby]
 ----
-Cogger::DATETIME_FORMAT
-# "%Y-%m-%dT%H:%M:%S.%L%:z
+Cogger::DATETIME_FORMAT  # "%Y-%m-%dT%H:%M:%S%:z"
 ----
 
 The above adheres to {rfc_3339_link} and can be customized -- as mentioned earlier -- when creating a new logger instance. Example:
@@ -822,7 +821,7 @@ require "logger"
 logger = Cogger.new formatter: Logger::Formatter.new
 logger.info "Demo"
 
-# I, [2024-08-28T15:57:31.930722 #69391]  INFO -- console: #<data Cogger::Entry id="console", level=:INFO, at=2024-08-28 15:57:31.930696 -0600, message="Demo", tags=[], datetime_format="%Y-%m-%dT%H:%M:%S.%L%:z", payload={}>
+# I, [2025-12-27T14:31:23.865252 #29621]  INFO -- console: #<data Cogger::Entry id="console", level=:INFO, at=2025-12-27 14:31:23.865216 -0700, message="Demo", tags=[], datetime_format="%Y-%m-%dT%H:%M:%S%:z", payload={}>
 ----
 
 While the above doesn't cause an error, you only get a dump of the `Cogger::Entry` which is not what you want. To replicate native {logger_link} functionality, you can use the `Simple` formatter as follows:
@@ -1009,7 +1008,7 @@ logger.info "Demo"
 
 === Abort
 
-Aborting a program is mostly syntax sugar for Command Line Interfaces (CLIs) which aids in situations where you need to log an error message _and_ exit the program at the same time with an exit code of `1` (similar to how `Kernel#abort` behaves). This allows your CLI to log an error and ensure the exit status is correct when displaying status, piping commands together, etc. All of the arguments, when messaging `#error` directly, are the same. Here's how it works:
+Aborting a program is syntactic sugar for Command Line Interfaces (CLIs) where you need to log an error message _and_ exit the program at the same time with an exit code of `1` (similar to how `Kernel#abort` behaves). This allows your CLI to log an error and ensure the exit status is correct when displaying status, piping commands together, etc. All of the arguments, when messaging `#error` directly, are the same. Here's how it works:
 
 [source,ruby]
 ----
@@ -1028,7 +1027,7 @@ logger.abort message: "Danger!"
 # Exits with status code: 1.
 ----
 
-You can use `#abort` without a message which will not log anything and immediately exit:
+Please _avoid_ using `#abort` without a message. Example:
 
 [source,ruby]
 ----
@@ -1036,7 +1035,38 @@ logger.abort
 # Logs no message and exits with status code: 1.
 ----
 
-This is _not recommended_ since using `Kernel#exit` directly is more performant.
+Use `Kernel#exit` instead since it's more performant.
+
+=== Panic
+
+This is syntactic sugar for Command Line Interfaces (CLIs) where you need to log a fatal message _and_ exit the program at the same time with an exit code of `1`. This allows your CLI to log a message and ensure the exit status is correct when displaying status, piping commands together, etc. All of the arguments, when messaging `#fatal` directly, are the same. Example:
+
+[source,ruby]
+----
+logger = Cogger.new
+
+logger.panic "Danger!"
+# 🔥 [console] Danger!
+# Exits with status code: 1.
+
+logger.panic { "Danger!" }
+# 🔥 [console] Danger!
+# Exits with status code: 1.
+
+logger.panic message: "Danger!"
+# 🔥 [console] Danger!
+# Exits with status code: 1.
+----
+
+Please _avoid_ using `#panic` without a message. Example:
+
+[source,ruby]
+----
+logger.panic
+# Logs no message and exits with status code: 1.
+----
+
+Use `Kernel#exit` instead since it's more performant.
 
 === Rack
 
@@ -1183,9 +1213,9 @@ logger.inspect
 #                @io=IO,
 #                @level=1,
 #                @formatter=Cogger::Formatters::Emoji,
-#                @datetime_format=\"%Y-%m-%dT%H:%M:%S.%L%:z\",
+#                @datetime_format=\"%Y-%m-%dT%H:%M:%S%:z\",
 #                @tags=[],
-#                @header=true,
+#                @header=false,
 #                @mode=false,
 #                @age=,
 #                @size=1048576,

data/cogger.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "cogger"
-  spec.version = "1.6.0"
+  spec.version = "2.0.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/cogger"
@@ -22,11 +22,11 @@ Gem::Specification.new do |spec|
   spec.signing_key = Gem.default_key_path
   spec.cert_chain = [Gem.default_cert_path]
 
-  spec.required_ruby_version = "~> 3.4"
-  spec.add_dependency "core", "~> 2.0"
+  spec.required_ruby_version = ">= 4.0"
+  spec.add_dependency "core", "~> 3.0"
   spec.add_dependency "logger", "~> 1.7"
-  spec.add_dependency "refinements", "~> 13.5"
-  spec.add_dependency "tone", "~> 2.0"
+  spec.add_dependency "refinements", "~> 14.0"
+  spec.add_dependency "tone", "~> 3.0"
   spec.add_dependency "zeitwerk", "~> 2.7"
 
   spec.extra_rdoc_files = Dir["README*", "LICENSE*"]

data/lib/cogger/configuration.rb

@@ -30,7 +30,7 @@ module Cogger
                    formatter: Formatters::Emoji.new,
                    datetime_format: DATETIME_FORMAT,
                    tags: Core::EMPTY_ARRAY,
-                   header: true,
+                   header: false,
                    mode: false,
                    age: nil,
                    size: 1_048_576,

data/lib/cogger/hub.rb

@@ -64,6 +64,11 @@ module Cogger
       exit false
     end
 
+    def panic(message = nil, **payload, &block)
+      fatal(message, **payload, &block) if message || !payload.empty? || block
+      exit false
+    end
+
     def add(level, message = nil, **, &)
       log(Logger::SEV_LABEL.fetch(level, "ANY").downcase, message, **, &)
     end

data/lib/cogger/program.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "pathname"
-
 # Computes default program name based on current file name.
 module Cogger
   Program = lambda do |name = $PROGRAM_NAME|

data/lib/cogger/registry.rb

@@ -46,14 +46,6 @@ 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
@@ -65,14 +57,6 @@ 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

data/lib/cogger.rb

@@ -13,7 +13,7 @@ end
 module Cogger
   extend Registry
 
-  DATETIME_FORMAT = "%Y-%m-%dT%H:%M:%S.%L%:z"
+  DATETIME_FORMAT = "%Y-%m-%dT%H:%M:%S%:z"
   LEVELS = %w[debug info warn error fatal unknown].freeze
 
   def self.loader registry = Zeitwerk::Registry

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cogger
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -41,14 +41,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
@@ -69,28 +69,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.5'
+        version: '14.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.5'
+        version: '14.0'
 - !ruby/object:Gem::Dependency
   name: tone
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -166,16 +166,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '3.4'
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.3
 specification_version: 4
 summary: A customizable and feature rich logger.
 test_files: []