scrolls 0.9.4 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c46a03de696acee9e14e71d9e2a373415e9fa60532a7ac51896f71b5e0286ca
-  data.tar.gz: 9d9af16e271f1ff468fb778c8d5e05d9f215909adf77cdbf144204d2b3d8836e
+  metadata.gz: 0a22fdde95ee4d9fba497168f1e87870c4a2a9acb4dd9e3b3fbb2a0f57f403a2
+  data.tar.gz: 9bb1d566a68271d57fcfdbca02a0100fdb106a759ce5b4d9bd59cff35ed7431c
 SHA512:
-  metadata.gz: 9aa2a50b5c00379872e54384b8f0b6050f82ab5f86e66bb2eca544a7ea5845ac4672dcc758e948d9b3af84b6d61af7972ca937be21854010002325c89b176865
-  data.tar.gz: 992fc115e62d9a2ea39305a72db4bfd0868c0f64d2e1a47082136ecf01e2d7a16461bbfb69e5bb38da628a4e1331685c4f6da275277e9793dfe5c5a8a808c496
+  metadata.gz: e2d64db3b3d90206861fc46e5d9cf5d8744a3c94a48b304f0389fa17390a2e485eb3b6a1c9f655f5082491f3bc021fbd04a896c5d0b9ee18d970d0e1d8501972
+  data.tar.gz: 0ae6039a25a4525f30717e0a1f3b8b295912c18fff09b41294a558e8a3b035ee8b5feb7ac74d8d5f8c78d920105ad42af818f4f07c1b714032f771b7aed92cc6

data/lib/scrolls/utils.rb

@@ -53,9 +53,9 @@ module Scrolls
 
     def self.escape_chars(d)
       if d.is_a?(String) and d =~ ESCAPE_CHAR_PATTERN
-        esc = d.to_s.gsub(ESCAPE_CHAR_PATTERN) {|c| ESCAPE_CHAR[c] }
+        d.to_s.gsub(ESCAPE_CHAR_PATTERN) {|c| ESCAPE_CHAR[c] }
       else
-        esc = d
+        d
       end
     end
 

data/lib/scrolls/version.rb

@@ -1,3 +1,3 @@
 module Scrolls
-  VERSION = "0.9.4"
+  VERSION = "0.9.6"
 end

data/lib/scrolls.rb

@@ -7,19 +7,21 @@ module Scrolls
   # Public: Initialize a Scrolls logger
   #
   # options - A hash of key/values for configuring Scrolls
-  #   stream         - Stream to output data (default: STDOUT)
-  #   log_facility   - Syslog facility (default: Syslog::LOG_USER)
-  #   time_unit      - Unit of time (default: seconds)
-  #   timestamp      - Prepend logs with a timestamp (default: false)
-  #   exceptions     - Method for outputting exceptions (default: single line)
-  #   global_context - Immutable context to prepend all messages with
-  #   syslog_options - Syslog options (default: Syslog::LOG_PID|Syslog::LOG_CONS)
-  #   escape_keys    - Escape chars in keys
-  #   strict_logfmt  - Always use double quotes to quote values
+  #   stream                    - Stream to output data (default: STDOUT)
+  #   log_facility              - Syslog facility (default: Syslog::LOG_USER)
+  #   time_unit                 - Unit of time (default: seconds)
+  #   timestamp                 - Prepend logs with a timestamp (default: false)
+  #   exceptions                - Method for outputting exceptions (default: single line)
+  #   global_context            - Immutable context to prepend all messages with
+  #   syslog_options            - Syslog options (default: Syslog::LOG_PID|Syslog::LOG_CONS)
+  #   escape_keys               - Escape chars in keys
+  #   strict_logfmt             - Always use double quotes to quote values
+  #   adapt_severity_for_syslog - Downgrade severity one level to match syslog (default: true) per https://docs.ruby-lang.org/en/2.1.0/Syslog/Logger.html
   #
   def init(options={})
     # Set a hint whether #init was called.
     @initialized = true
+    @adapt_severity_for_syslog = options.fetch(:adapt_severity_for_syslog, true)
     @log = Logger.new(options)
   end
 
@@ -242,7 +244,7 @@ module Scrolls
   #
   def error(data, &blk)
     data = coalesce_strings_to_hash(data)
-    data = data.merge(:level => "warning") if data.is_a?(Hash)
+    data = data.merge(:level => @adapt_severity_for_syslog ? "warning" : "error") if data.is_a?(Hash)
     @log.log(data, &blk)
   end
 
@@ -261,7 +263,7 @@ module Scrolls
   #
   def fatal(data, &blk)
     data = coalesce_strings_to_hash(data)
-    data = data.merge(:level => "error") if data.is_a?(Hash)
+    data = data.merge(:level => @adapt_severity_for_syslog ? "error" : "critical") if data.is_a?(Hash)
     @log.log(data, &blk)
   end
 
@@ -299,7 +301,7 @@ module Scrolls
   #
   def warn(data, &blk)
     data = coalesce_strings_to_hash(data)
-    data = data.merge(:level => "notice") if data.is_a?(Hash)
+    data = data.merge(:level => @adapt_severity_for_syslog ? "notice" : "warn") if data.is_a?(Hash)
     @log.log(data, &blk)
   end
 

data/scrolls.gemspec

@@ -14,4 +14,6 @@ Gem::Specification.new do |gem|
   gem.name          = "scrolls"
   gem.require_paths = ["lib"]
   gem.version       = Scrolls::VERSION
+
+  gem.add_dependency "syslog"
 end

data/test/test_scrolls.rb

@@ -236,6 +236,24 @@ class TestScrolls < Minitest::Test
     assert_equal "log_message=warn level=notice\n", @out.string
   end
 
+  def test_adapted_log_error
+    Scrolls.init({:stream => @out, :adapt_severity_for_syslog => false })
+    Scrolls.error("error")
+    assert_equal "log_message=error level=error\n", @out.string
+  end
+
+  def test_adapted_log_fatal
+    Scrolls.init({:stream => @out, :adapt_severity_for_syslog => false })
+    Scrolls.fatal("fatal")
+    assert_equal "log_message=fatal level=critical\n", @out.string
+  end
+
+  def test_adapted_log_warn
+    Scrolls.init({:stream => @out, :adapt_severity_for_syslog => false })
+    Scrolls.warn("warn")
+    assert_equal "log_message=warn level=warn\n", @out.string
+  end
+
   def test_sending_string_unknown
     Scrolls.unknown("unknown")
     assert_equal "log_message=unknown level=alert\n", @out.string

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: scrolls
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.6
 platform: ruby
 authors:
 - Curt Micol
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-22 00:00:00.000000000 Z
-dependencies: []
+date: 2024-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: syslog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Logging, easier, more consistent.
 email:
 - asenchi@asenchi.com
@@ -39,7 +53,7 @@ homepage: https://github.com/asenchi/scrolls
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -54,8 +68,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.29
-signing_key: 
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: When do we log? All the time.
 test_files: