cogger 0.14.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e943adc7eaeab019242b860b3c66da64e24c52cfe756c242d3b92de480586503
-  data.tar.gz: ad0f47de612ca8fde2eff91593e32e5ed7cfaad13f77b62b6c3aebcbe18a9bc6
+  metadata.gz: 6cc72e287de4da7142df1dc928db707a3f80f2d9f149319b6c56fef0ba18abe4
+  data.tar.gz: 7740a2b7996fe62802224f027bcd046ec2a678631f8c4c50a614d3544e00fa75
 SHA512:
-  metadata.gz: 52c552fcb5ae45c4893bb84e427691504d49b987904734e81ce68b3dac889544f30c040e547d7a99d17c18429c732651a63b7628d11c00de6ba506985ea7c493
-  data.tar.gz: 4d7d3c410af6800bbcc6c2d35d969d06e5752c9a326010e55c8049ba91e5657aa808a04cb82cbaf294f077630a61c01ff4dcbed156abf54696a017cd59955a00
+  metadata.gz: deb27d680a13bea905d22973a05349ff4e96d79d8e9c705d5e6af5d9604ed392ce2a08587cb1a401b6e9714f257e45ba1ff1c64d432e61cd893ce143eb3ddc3f
+  data.tar.gz: c0d52748459efb13ac0a0ec7d9b1fb52acf1d4eb63bc8f35ffafe8c542e7eace0e64f852c324dfcf8f9b83a8eba8a228504ac9c7672426b9f0f5377e5023d14a

data/README.adoc

@@ -755,6 +755,31 @@ logger.info "Demo"
 # 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:
+
+[source,ruby]
+----
+logger = Cogger.new
+
+# Not recommended since `Kernel#exit false` is faster.
+logger.abort
+# Logs no message and exits with status code: 1.
+
+logger.abort "Danger!"
+# 🛑 Danger!
+# Exits with status code: 1.
+
+logger.abort { "Danger!" }
+# 🛑 Danger!
+# Exits with status code: 1.
+
+logger.abort message: "Danger!"
+# 🛑 Danger!
+# Exits with status code: 1.
+----
+
 === Rack
 
 {rack_link} is _implicitly_ supported which means your middleware _must be_ Rack-based and _must require_ the Rack gem since `Cogger::Rack::Logger` doesn't _explicitly_ require Rack by default. If these requirements are met then, to add HTTP request logging, you only need to use it. Example:

data/cogger.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "cogger"
-  spec.version = "0.14.0"
+  spec.version = "0.16.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/cogger"
@@ -22,10 +22,10 @@ Gem::Specification.new do |spec|
   spec.signing_key = Gem.default_key_path
   spec.cert_chain = [Gem.default_cert_path]
 
-  spec.required_ruby_version = [">= 3.2", "<= 3.3"]
-  spec.add_dependency "core", "~> 0.1"
-  spec.add_dependency "refinements", "~> 11.0"
-  spec.add_dependency "tone", "~> 0.3"
+  spec.required_ruby_version = "~> 3.3"
+  spec.add_dependency "core", "~> 1.0"
+  spec.add_dependency "refinements", "~> 12.0"
+  spec.add_dependency "tone", "~> 1.0"
   spec.add_dependency "zeitwerk", "~> 2.6"
 
   spec.extra_rdoc_files = Dir["README*", "LICENSE*"]

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

@@ -46,13 +46,13 @@ module Cogger
         # :reek:TooManyStatements
         def sanitize_and_extract template, attributes
           template.gsub pattern do
-            captures = Regexp.last_match.named_captures
-            attributes[captures["key"].to_sym] = captures["directive"]
+            captures = Regexp.last_match.named_captures symbolize_names: true
+            attributes[captures[:key].to_sym] = captures[:directive]
 
             captures.reduce(+"%") do |body, (key, value)|
-              next body if key == "directive"
+              next body if key == :directive
 
-              body.concat key == "key" ? "<#{value}>" : value.to_s
+              body.concat key == :key ? "<#{value}>" : value.to_s
             end
           end
         end

data/lib/cogger/hub.rb

@@ -2,17 +2,18 @@
 
 require "forwardable"
 require "logger"
-require "refinements/hashes"
-require "refinements/loggers"
+require "refinements/hash"
+require "refinements/logger"
 
 module Cogger
   # Loads configuration and simultaneously sends messages to multiple streams.
   # :reek:TooManyInstanceVariables
+  # :reek:TooManyMethods
   class Hub
     extend Forwardable
 
-    using Refinements::Loggers
-    using Refinements::Hashes
+    using Refinements::Logger
+    using Refinements::Hash
 
     delegate %i[
       close
@@ -49,20 +50,25 @@ module Cogger
       self
     end
 
-    def debug(message = nil, **payload, &) = log(__method__, message, **payload, &)
+    def debug(message = nil, **, &) = log(__method__, message, **, &)
 
-    def info(message = nil, **payload, &) = log(__method__, message, **payload, &)
+    def info(message = nil, **, &) = log(__method__, message, **, &)
 
-    def warn(message = nil, **payload, &) = log(__method__, message, **payload, &)
+    def warn(message = nil, **, &) = log(__method__, message, **, &)
 
-    def error(message = nil, **payload, &) = log(__method__, message, **payload, &)
+    def error(message = nil, **, &) = log(__method__, message, **, &)
 
-    def fatal(message = nil, **payload, &) = log(__method__, message, **payload, &)
+    def fatal(message = nil, **, &) = log(__method__, message, **, &)
 
-    def any(message = nil, **payload, &) = log(__method__, message, **payload, &)
+    def any(message = nil, **, &) = log(__method__, message, **, &)
 
-    def add(severity, message = nil, **payload, &)
-      log(Logger::SEV_LABEL.fetch(severity, "ANY").downcase, message, **payload, &)
+    def abort(message = nil, **payload, &block)
+      error(message, **payload, &block) if message || !payload.empty? || block
+      exit false
+    end
+
+    def add(severity, message = nil, **, &)
+      log(Logger::SEV_LABEL.fetch(severity, "ANY").downcase, message, **, &)
     end
 
     alias unknown any
@@ -88,8 +94,8 @@ module Cogger
       )
     end
 
-    def log(severity, message = nil, **payload, &)
-      dispatch(severity, message, **payload, &)
+    def log(severity, message = nil, **, &)
+      dispatch(severity, message, **, &)
     rescue StandardError => error
       crash message, error
     end

data/lib/cogger/level.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 require "logger"
-require "refinements/arrays"
+require "refinements/array"
 
 # Loads log level from environment.
 module Cogger
-  using Refinements::Arrays
+  using Refinements::Array
 
   Level = lambda do |logger = Logger, environment: ENV, allowed: LEVELS|
     value = String environment.fetch("LOG_LEVEL", "INFO")

data/lib/cogger/tag.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 require "core"
-require "refinements/hashes"
+require "refinements/hash"
 
 module Cogger
   # Models a tag which may consist of an array and/or hash.
   Tag = Data.define :singles, :pairs do
-    using Refinements::Hashes
+    using Refinements::Hash
 
     def self.for(*bag)
       bag.each.with_object new do |item, tag|

data/lib/cogger/time/unit.rb

@@ -3,7 +3,6 @@
 module Cogger
   module Time
     # Provides unit of measure for duration.
-    # rubocop:disable Style/MethodCallWithArgsParentheses
     Unit = lambda do |duration, range: RANGE|
       case duration
         when range.fetch(:nanoseconds) then "ns"
@@ -13,6 +12,5 @@ module Cogger
         else "m"
       end
     end
-    # rubocop:enable Style/MethodCallWithArgsParentheses
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cogger
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2023-12-10 00:00:00.000000000 Z
+date: 2024-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: core
@@ -43,42 +43,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: refinements
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '12.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: tone
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -146,10 +146,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
-    - !ruby/object:Gem::Version
-      version: '3.2'
-  - - "<="
+  - - "~>"
     - !ruby/object:Gem::Version
       version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -158,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
 summary: A customizable and feature rich logger.