l2meter 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dda89323ab92c0d321524755d2d657e4c9d3cec349e9e6f0efd4ed2877fb0633
-  data.tar.gz: 0d94a52a832e1bea9aad522a67be4df1dddb76aea50ea6b6c52013aa7f056c99
+  metadata.gz: 4e7d0b5b1d2ed03198fd3d9dcf6ceeae3b8ea7e9ea33bd41357d4d8cfcaf50e7
+  data.tar.gz: dad33aee25c34db52c0d2bbcf81735361da935697e94448d1a59d57345127c00
 SHA512:
-  metadata.gz: be3e77657abea69b5e11f322b587de92d5b5ce07d047125ab7d24155c8113e745aae79e8078e1218905fbebacb241f67ae32c7eb67a1133c38c45b881bd1e348
-  data.tar.gz: 0755fa82b1f7caaa2b33a485b59973f9d35ac9164a7a2603e353c8661e7cdcf975779ce614f6a74d61bdbbe730d2e5e2650eccbf03872c50d354d08ece21c4f7
+  metadata.gz: 85522f064c39045663580b4bfac46c99aa1ffe4b93bf5fd8bc1bef34c2c7afb938a5d62c527eb474fbfc351e3bfc2e51806c9a953225a396331ff35bdf5f3588
+  data.tar.gz: 98ac4f5586dd2cac47b34fc660ea408ba22370701d4b1202918cbfc4c8005d01151b1e977bd266daf99b445af7d9019bfc2a1731a58121b0d869a57f9b279269

data/.gitignore

@@ -2,6 +2,7 @@
 /log/
 /tmp/
 /tags
+.byebug_history
 
 # Package and dependency caches
 /.bundle

data/CHANGELOG.md

@@ -6,6 +6,11 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 
+## [0.15.0] 2020-05-15
+
+### Added
+- Allow outputting of true/false/nil values via a config option. ([#9](https://github.com/heroku/l2meter/pull/9))
+
 ## [0.14.0] 2020-04-16
 
 ### Added

data/README.md

@@ -235,6 +235,27 @@ logger.log my_url: "https://user:password@example.com"
 
 Note that returning nil value will make l2meter omit the field completely.
 
+### "Compacting" values
+
+By default l2meter will treat key-value pairs where the value is `true`, `false` or `nil` differently. `false` and `nil` values will cause the whole pair to be omitted, `true` will cause just the key to be output:
+
+```ruby
+logger.log foo: "hello", bar: true  # => foo=hello bar
+logger.log foo: "hello", bar: false # => foo=hello
+logger.log foo: "hello", bar: nil   # => foo=hello
+```
+
+When the option is disabled, the full pairs are emitted:
+
+```ruby
+config.compact_values = false
+logger.log foo: "hello", bar: true  # => foo=hello bar=true
+logger.log foo: "hello", bar: false # => foo=hello bar=false
+logger.log foo: "hello", bar: nil   # => foo=hello bar=null
+```
+
+Note that "null" is output in the `nil` case.
+
 ## Silence
 
 There's a way to temporary silence the log emitter. This might be useful for

data/lib/l2meter/configuration.rb

@@ -16,6 +16,7 @@ module L2meter
       @output = $stdout
       @float_precision = 4
       @context = nil
+      @compact_values = true
     end
 
     def format_keys(&block)
@@ -30,6 +31,14 @@ module L2meter
       @sort = !!value
     end
 
+    def compact_values?
+      @compact_values
+    end
+
+    def compact_values=(value)
+      @compact_values = !!value
+    end
+
     def context
       if block_given?
         @context = Proc.new

data/lib/l2meter/emitter.rb

@@ -4,6 +4,8 @@ module L2meter
   class Emitter
     attr_reader :configuration
 
+    BARE_VALUE_SENTINEL = Object.new.freeze
+
     def initialize(configuration: Configuration.new)
       @configuration = configuration
     end
@@ -160,7 +162,7 @@ module L2meter
     end
 
     def source_context
-      {source: configuration.source}
+      configuration.source ? {source: configuration.source} : {}
     end
 
     def resolved_contexts
@@ -197,11 +199,13 @@ module L2meter
     end
 
     def format_token(key, value)
-      case value
-      when TrueClass
+      case
+      when value == true && configuration.compact_values?
         key
-      when FalseClass, NilClass
+      when !value && configuration.compact_values?
         nil
+      when value == BARE_VALUE_SENTINEL
+        key
       else
         value = format_value(value)
         "#{key}=#{value}"
@@ -218,6 +222,8 @@ module L2meter
         format_time_value(value)
       when Array
         value.map(&method(:format_value)).join(",")
+      when nil
+        "null"
       else
         format_value(value.to_s)
       end
@@ -253,7 +259,7 @@ module L2meter
       {}.tap do |result|
         args.each do |arg|
           next if arg.nil?
-          arg = Hash[arg, true] unless Hash === arg
+          arg = Hash[arg, BARE_VALUE_SENTINEL] unless Hash === arg
           arg.each do |key, value|
             result[key] = value
           end

data/lib/l2meter/version.rb

@@ -1,3 +1,3 @@
 module L2meter
-  VERSION = "0.14.0".freeze
+  VERSION = "0.15.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: l2meter
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Pavel Pravosud
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-16 00:00:00.000000000 Z
+date: 2020-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: L2met friendly log formatter