cogger 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06b02f31842765991c8645f435efe1ac2c8d2ad54ec52e04cbfe6fc64096dd6d
-  data.tar.gz: 819a9aa91290741d08ea935c8ae9046676a6255c940759d6b4dd0eca5820f0f5
+  metadata.gz: 6cc72e287de4da7142df1dc928db707a3f80f2d9f149319b6c56fef0ba18abe4
+  data.tar.gz: 7740a2b7996fe62802224f027bcd046ec2a678631f8c4c50a614d3544e00fa75
 SHA512:
-  metadata.gz: 2a6973639d6f83b05959cfc596d0940ed80e733c24df781a973b479a9bc406d8ab5fee499cc24dd6c9eaf9aabef59a6b2f7474eeab7012ceeb96390b518c1ad7
-  data.tar.gz: 9209e5c53220d33beb9f72c56c22b8bbbe5b731dc0ea25b6fdbca1955f7317619bfa35bf8a00a5e8eca178e9c95b770ce948d83392df43e7f5d60f23f1b4413a
+  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.15.0"
+  spec.version = "0.16.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/cogger"

data/lib/cogger/hub.rb

@@ -8,6 +8,7 @@ require "refinements/logger"
 module Cogger
   # Loads configuration and simultaneously sends messages to multiple streams.
   # :reek:TooManyInstanceVariables
+  # :reek:TooManyMethods
   class Hub
     extend Forwardable
 
@@ -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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cogger
 version: !ruby/object:Gem::Version
-  version: 0.15.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: 2024-01-01 00:00:00.000000000 Z
+date: 2024-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: core
@@ -155,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
 summary: A customizable and feature rich logger.