scrolls 0.9.0 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0beda1c02c56ef85e12ea9a241e4a2077d47455d
-  data.tar.gz: 60228ade9fab4786baafc08e186b9fb3de509a3e
+SHA256:
+  metadata.gz: c9e31caada359ce18dceed5246a8da245c3a8587f02ebe079e3317baf2f50551
+  data.tar.gz: 28cfb3b4ed27598042d5499d9b3e5105bab48562b3d18dd6c678398cbcee6d0b
 SHA512:
-  metadata.gz: 913819999b29cb0c5d039440340260b38ea92ff9c1877260946dc2129fc3f9d6df66643935403bc4fc3ea743f2512e7025e0231ffe7e950d51f83002d8cd377d
-  data.tar.gz: 7163d0841cd810a1741e2e333cf62b8cabd1c512da443cd16d10fb4f4f4b02c73f8e10248f58c5c98ac0324f573056521766b0770276f501159ebc212c22f695
+  metadata.gz: c9fadc0c6475e40c4d427295f1d9b9db218e1038bcca634ebd00da18a80aced226510e6ea69a1c66c817cae947cff7cff621a7532cbeb6428c7e3bbaf9049913
+  data.tar.gz: 99293d2de9ac23a5d07e3551a88964f3f76ca5537002915480ba898acc8ba0171355da7930e27d3d085a5eb34e75e865237bc192c6bf4396884366c7230b344b

data/LICENSE

@@ -1,7 +1,7 @@
 The MIT License (MIT)
 
-Copyright © Curt Micol <asenchi@asenchi.com> 2012,2013,2014
-Copyright © Heroku 2012
+Copyright (c) 2013-2021 Curt Micol <asenchi@asenchi.com>
+Copyright (c) 2012, Heroku
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -67,6 +67,7 @@ exceptions: "single"
 global_context: {}
 syslog_options: Syslog::LOG_PID|Syslog::LOG_CONS
 escape_keys: false
+strict_logfmt: false
 ```
 
 ## Older Versions

data/lib/scrolls/logger.rb

@@ -37,14 +37,15 @@ module Scrolls
     attr_accessor :exceptions, :timestamp
 
     def initialize(options={})
-      @stream       = options.fetch(:stream, STDOUT)
-      @log_facility = options.fetch(:facility, LOG_FACILITY)
-      @time_unit    = options.fetch(:time_unit, "seconds")
-      @timestamp    = options.fetch(:timestamp, false)
-      @exceptions   = options.fetch(:exceptions, "single")
-      @global_ctx   = options.fetch(:global_context, {})
-      @syslog_opts  = options.fetch(:syslog_options, SYSLOG_OPTIONS)
-      @escape_keys  = options.fetch(:escape_keys, false)
+      @stream        = options.fetch(:stream, STDOUT)
+      @log_facility  = options.fetch(:facility, LOG_FACILITY)
+      @time_unit     = options.fetch(:time_unit, "seconds")
+      @timestamp     = options.fetch(:timestamp, false)
+      @exceptions    = options.fetch(:exceptions, "single")
+      @global_ctx    = options.fetch(:global_context, {})
+      @syslog_opts   = options.fetch(:syslog_options, SYSLOG_OPTIONS)
+      @escape_keys   = options.fetch(:escape_keys, false)
+      @strict_logfmt = options.fetch(:strict_logfmt, false)
 
       # Our main entry point to ensure our options are setup properly
       setup!
@@ -69,7 +70,7 @@ module Scrolls
     def stream=(s)
       # Return early to avoid setup
       return if s == @stream
-      
+
       @stream = s
       setup_stream
     end
@@ -78,6 +79,10 @@ module Scrolls
       @escape_keys
     end
 
+    def strict_logfmt?
+      @strict_logfmt
+    end
+
     def syslog_options
       @syslog_opts
     end
@@ -140,7 +145,7 @@ module Scrolls
         begin
           res = yield
         rescue StandardError => e
-          logdata.merge({
+          logdata.merge!({
             at:           "exception",
             reraise:      true,
             class:        e.class,
@@ -309,7 +314,7 @@ module Scrolls
 
     def write(data)
       if log_level_ok?(data[:level])
-        msg = Scrolls::Parser.unparse(data, escape_keys=escape_keys?)
+        msg = Scrolls::Parser.unparse(data, escape_keys=escape_keys?, strict_logfmt=strict_logfmt?)
         @logger.log(msg)
       end
     end

data/lib/scrolls/parser.rb

@@ -4,7 +4,7 @@ module Scrolls
   module Parser
     extend self
 
-    def unparse(data, escape_keys=false)
+    def unparse(data, escape_keys=false, strict_logfmt=false)
       data.map do |(k,v)|
         k = Scrolls::Utils.escape_chars(k) if escape_keys
 
@@ -23,7 +23,7 @@ module Scrolls
           has_single_quote = v.index("'")
           has_double_quote = v.index('"')
           if v =~ /[ =:,]/
-            if has_single_quote && has_double_quote
+            if (has_single_quote || strict_logfmt) && has_double_quote
               v = '"' + v.gsub(/\\|"/) { |c| "\\#{c}" } + '"'
             elsif has_double_quote
               v = "'" + v.gsub('\\', '\\\\\\') + "'"

data/lib/scrolls/version.rb

@@ -1,3 +1,3 @@
 module Scrolls
-  VERSION = "0.9.0"
+  VERSION = "0.9.5"
 end

data/lib/scrolls.rb

@@ -7,18 +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
+  #   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
 
@@ -71,24 +74,24 @@ module Scrolls
 
   # Public: Log an exception
   #
-  # data - A hash of key/values to log
   # e    - An exception to pass to the logger
+  # data - A hash of key/values to log
   #
   # Examples:
   #
   #   begin
   #     raise Exception
   #   rescue Exception => e
-  #     Scrolls.log_exception({test: "test"}, e)
+  #     Scrolls.log_exception(e, {test: "test"})
   #   end
   #   test=test at=exception class=Exception message=Exception exception_id=70321999017240
   #   ...
   #
-  def log_exception(data, e)
+  def log_exception(e, data)
     # Allows us to call #log directly and initialize defaults
     @log = Logger.new({}) unless @initialized
 
-    @log.log_exception(data, e)
+    @log.log_exception(e, data)
   end
 
   # Public: Setup a logging facility (default: Syslog::LOG_USER)
@@ -221,6 +224,7 @@ module Scrolls
   #   => nil
   #
   def debug(data, &blk)
+    data = coalesce_strings_to_hash(data)
     data = data.merge(:level => "debug") if data.is_a?(Hash)
     @log.log(data, &blk)
   end
@@ -239,7 +243,8 @@ module Scrolls
   #   => nil
   #
   def error(data, &blk)
-    data = data.merge(:level => "warning") if data.is_a?(Hash)
+    data = coalesce_strings_to_hash(data)
+    data = data.merge(:level => @adapt_severity_for_syslog ? "warning" : "error") if data.is_a?(Hash)
     @log.log(data, &blk)
   end
 
@@ -257,7 +262,8 @@ module Scrolls
   #   => nil
   #
   def fatal(data, &blk)
-    data = data.merge(:level => "error") if data.is_a?(Hash)
+    data = coalesce_strings_to_hash(data)
+    data = data.merge(:level => @adapt_severity_for_syslog ? "error" : "critical") if data.is_a?(Hash)
     @log.log(data, &blk)
   end
 
@@ -275,6 +281,7 @@ module Scrolls
   #   => nil
   #
   def info(data, &blk)
+    data = coalesce_strings_to_hash(data)
     data = data.merge(:level => "info") if data.is_a?(Hash)
     @log.log(data, &blk)
   end
@@ -293,7 +300,8 @@ module Scrolls
   #   => nil
   #
   def warn(data, &blk)
-    data = data.merge(:level => "notice") if data.is_a?(Hash)
+    data = coalesce_strings_to_hash(data)
+    data = data.merge(:level => @adapt_severity_for_syslog ? "notice" : "warn") if data.is_a?(Hash)
     @log.log(data, &blk)
   end
 
@@ -311,6 +319,7 @@ module Scrolls
   #   => nil
   #
   def unknown(data, &blk)
+    data = coalesce_strings_to_hash(data)
     data = data.merge(:level => "alert") if data.is_a?(Hash)
     @log.log(data, &blk)
   end
@@ -321,4 +330,8 @@ module Scrolls
     @log
   end
 
+  def coalesce_strings_to_hash(string_or_something_else)
+    return string_or_something_else unless string_or_something_else.is_a?(String)
+    { "log_message" => string_or_something_else }
+  end
 end

data/test/test_parser.rb

@@ -88,6 +88,12 @@ class TestScrollsParser < Minitest::Test
       unparse(data, escape_keys=true)
   end
 
+  def test_unparse_strict_logfmt
+    data = { s: 'echo "hello"' }
+    assert_equal 's="echo \"hello\""', unparse(data, escape_keys=false, strict_logfmt=true)
+    assert_equal data.inspect, parse(unparse(data, escape_keys=false, strict_logfmt=true)).inspect
+  end
+
   def test_parse_time
     time = Time.new(2012, 06, 19, 16, 02, 35, "+01:00")
     string = "t=2012-06-19T16:02:35+01:00"

data/test/test_scrolls.rb

@@ -90,6 +90,21 @@ class TestScrolls < Minitest::Test
     end
   end
 
+  def test_deeply_nested_context_after_exception
+    Scrolls.log(:o => "o") do
+      begin
+        Scrolls.log(:io => 'io') do
+          raise "Error from inside of nested logging"
+        end
+      rescue
+        Scrolls.log(:o => 'o')
+      end
+    end
+    @out.truncate(124)
+    output = "o=o at=start\nio=io at=start\nio=io at=exception reraise=true class=RuntimeError message=\"Error from inside of nested logging\""
+    assert_equal output, @out.string
+  end
+
   def test_default_time_unit
     assert_equal "seconds", Scrolls.time_unit
   end
@@ -208,22 +223,40 @@ class TestScrolls < Minitest::Test
 
   def test_sending_string_error
     Scrolls.error("error")
-    assert_equal "log_message=error\n", @out.string
+    assert_equal "log_message=error level=warning\n", @out.string
   end
 
   def test_sending_string_fatal
     Scrolls.fatal("fatal")
-    assert_equal "log_message=fatal\n", @out.string
+    assert_equal "log_message=fatal level=error\n", @out.string
   end
 
   def test_sending_string_warn
     Scrolls.warn("warn")
-    assert_equal "log_message=warn\n", @out.string
+    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\n", @out.string
+    assert_equal "log_message=unknown level=alert\n", @out.string
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scrolls
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.5
 platform: ruby
 authors:
 - Curt Micol
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-04 00:00:00.000000000 Z
+date: 2021-10-29 00:00:00.000000000 Z
 dependencies: []
 description: Logging, easier, more consistent.
 email:
@@ -54,8 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.2.29
 signing_key: 
 specification_version: 4
 summary: When do we log? All the time.