scrolls 0.9.1 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef35d7cda907156c55fc36b1486539ac755beb03fc91fd686e396f06609dc9f3
-  data.tar.gz: aa19774eeb977616f7e5e64b713bd612c870357ed640134c9dc9ad50d33e7c46
+  metadata.gz: d70168aa379a644e25091bce26f7ce86e3ffb9d6564a97246d3e6251fbe353ad
+  data.tar.gz: 813b7fc23789ea3436e4f18f1be99f601ec034fbf737e70bfbf8705948676aed
 SHA512:
-  metadata.gz: fab8615f38a24e2767bb2f4b1d291f744130af82ee3326109e2c74b8d769d525cfeb761c021f4dc5c95e7fbf859a9bb5db21b29a90c11b948107e11bfc935245
-  data.tar.gz: 37b338406b11a641ec6afb8ae28384d0460d3bf3970dd9c083cdc8eaa999d4bd4cf7b5c0dd2929719bda7751ea03cb2f7771dc06fe8911a306a0c74bedc355f0
+  metadata.gz: a419f6a9473eeaa2f7957db5d30ee5d1977149861542a7e28feb7e126f7413ee6a9876ff76e30414620fcf8a43eaa0abafe79408b23db0c4415a06f048ad5653
+  data.tar.gz: 3be6e7a630e21b35be17bf59ac480a40f2b98eec106c27dacfc245765574e317c680b5587a55064e5883b420c272ca1cdab687ac2052316fdbf53efdde7f9e45

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!
@@ -78,6 +79,10 @@ module Scrolls
       @escape_keys
     end
 
+    def strict_logfmt?
+      @strict_logfmt
+    end
+
     def syslog_options
       @syslog_opts
     end
@@ -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.1"
+  VERSION = "0.9.3"
 end

data/lib/scrolls.rb

@@ -15,6 +15,7 @@ module Scrolls
   #   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
   #
   def init(options={})
     # Set a hint whether #init was called.

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"

metadata

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