l2meter 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d6bbc8048445c11b2601b92ad8ff351ef058d842127dd53588e5e78f3219a80
-  data.tar.gz: 186c086e8782a191f32c638f7687008cc7d0cc08dea636a12234092736e826af
+  metadata.gz: dda89323ab92c0d321524755d2d657e4c9d3cec349e9e6f0efd4ed2877fb0633
+  data.tar.gz: 0d94a52a832e1bea9aad522a67be4df1dddb76aea50ea6b6c52013aa7f056c99
 SHA512:
-  metadata.gz: 1ec890f4bde056dfe4f85303530e8c8e5a013720778a202bcc81cec6c736ab04d059267c16401bdf1ef0c00b1154163c53f03692d0a87f0811f491880ceedf13
-  data.tar.gz: 98896fb1fa2e8af273168160048d888eac1ebad6bc5725826b873cf1aba0f0cc1b0222986e70ccd8430cd7ec8dca11ff3e1d9408173c5ce7708fa38ce9e09fe3
+  metadata.gz: be3e77657abea69b5e11f322b587de92d5b5ce07d047125ab7d24155c8113e745aae79e8078e1218905fbebacb241f67ae32c7eb67a1133c38c45b881bd1e348
+  data.tar.gz: 0755fa82b1f7caaa2b33a485b59973f9d35ac9164a7a2603e353c8661e7cdcf975779ce614f6a74d61bdbbe730d2e5e2650eccbf03872c50d354d08ece21c4f7

data/.gitignore

@@ -0,0 +1,19 @@
+# Ignore all logfiles and tempfiles
+/log/
+/tmp/
+/tags
+
+# Package and dependency caches
+/.bundle
+/Gemfile.lock
+/pkg/
+
+# Generated documentation
+/doc/
+/.yardoc
+/_yardoc/
+
+# Spec reports and failure tracking
+/coverage/
+/spec/rspec-status.txt
+/spec/reports/

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.7
+  - 2.6
+  - 2.5
+  - 2.4

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.14.0] 2020-04-16
+
+### Added
+- CHANGELOG.md
+
+### Changed
+- Officially only support Ruby 2.5+; all older Rubies are EoL'd.
+
+### Fixed
+- Fix Ruby 2.7 proc warning
+- Fix Ruby 2.7 last argument as keyword params warning
+
+## [0.13.0] 2019-05-11
+
+### Changed
+- Total re-write to fix memory leaks in `L2meter::ThreadSafe` proxy object. See: https://github.com/heroku/l2meter/issues/6

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -36,8 +36,8 @@ logger.log :doing_work do            # => doing-work at=start
 end                                  # => doing-work at=finish elapsed=1.2345
 ```
 
-In case of the exception inside the block, all relevant information is logged
-and then exception is re-raised.
+In case of an exception inside the block, all relevant information is logged
+and then the exception is re-raised.
 
 ```ruby
 logger.log :doing_work do   # => doing-work at=start
@@ -86,7 +86,7 @@ def do_work_with_retries
 end
 ```
 
-It's possbile to create a dedicated copy of the logger with some specific
+It's possible to create a dedicated copy of the logger with some specific
 context attached to it.
 
 ```ruby
@@ -154,7 +154,7 @@ Here's the full list of available settings.
 
 ### Global context
 
-Global context works similary to context method, but globally:
+Global context works similarly to context method, but globally:
 
 ```ruby
 config.context = { app_name: "my-app-name" }
@@ -237,7 +237,7 @@ Note that returning nil value will make l2meter omit the field completely.
 
 ## Silence
 
-There's a way to temporary silence the log emitter. This might be userful for
+There's a way to temporary silence the log emitter. This might be useful for
 tests for example.
 
 ```ruby

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/l2meter.gemspec

@@ -0,0 +1,35 @@
+require File.expand_path("../lib/l2meter/version", __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name = "l2meter"
+  spec.version = L2meter::VERSION
+  spec.authors = ["Pavel Pravosud"]
+  spec.email = ["pavel@pravosud.com"]
+
+  spec.summary = "L2met friendly log formatter"
+  spec.description = "L2meter is a tool for building logfmt-compatiable loggers."
+  spec.homepage = "https://github.com/heroku/l2meter"
+  spec.license = "MIT"
+
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+    "bug_tracker_uri" => "#{spec.homepage}/issues",
+    "changelog_uri" => "#{spec.homepage}/blob/master/CHANGELOG.md"
+  }
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = []
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.8.0"
+  spec.add_development_dependency "timecop"
+end

data/lib/l2meter.rb

@@ -4,11 +4,11 @@ module L2meter
   extend self
 
   autoload :Configuration, "l2meter/configuration"
-  autoload :Emitter,       "l2meter/emitter"
-  autoload :NullOutput,    "l2meter/null_output"
+  autoload :Emitter, "l2meter/emitter"
+  autoload :NullOutput, "l2meter/null_output"
 
   def build(configuration: Configuration.new)
-    yield configuration if block_given?
+    yield(configuration) if block_given?
     Emitter.new(configuration: configuration.freeze)
   end
 end

data/lib/l2meter/configuration.rb

@@ -1,11 +1,11 @@
 module L2meter
   class Configuration
-    attr_writer :output
+    attr_writer :context, :output
     attr_accessor :source, :prefix, :float_precision, :scrubber
-    attr_reader :context, :key_formatter, :output
+    attr_reader :key_formatter, :output
 
     DEFAULT_KEY_FORMATTER = ->(key) do
-      key.to_s.strip.downcase.gsub(/[^-a-z\d.#]+/, ?-)
+      key.to_s.strip.downcase.gsub(/[^-a-z\d.#]+/, "-")
     end
 
     private_constant :DEFAULT_KEY_FORMATTER
@@ -15,6 +15,7 @@ module L2meter
       @key_formatter = DEFAULT_KEY_FORMATTER
       @output = $stdout
       @float_precision = 4
+      @context = nil
     end
 
     def format_keys(&block)
@@ -36,7 +37,5 @@ module L2meter
         @context
       end
     end
-
-    attr_writer :context
   end
 end

data/lib/l2meter/emitter.rb

@@ -1,5 +1,4 @@
 require "time"
-require "thread"
 
 module L2meter
   class Emitter
@@ -9,19 +8,19 @@ module L2meter
       @configuration = configuration
     end
 
-    def log(*args)
-      merge! current_context, *args
+    def log(*args, &block)
+      merge!(current_context, *args)
 
-      if block_given?
-        wrap &proc
+      if block
+        wrap(&block)
       else
         write
       end
     end
 
-    def context(*context_data)
-      if block_given?
-        wrap_context(context_data, &proc)
+    def context(*context_data, &block)
+      if block
+        wrap_context(context_data, &block)
       else
         contexted(context_data)
       end
@@ -33,24 +32,24 @@ module L2meter
       end
     end
 
-    def silence
-      with_output(NullOutput.new, &proc)
+    def silence(&block)
+      with_output(NullOutput.new, &block)
     end
 
     def silence!
-      set_output NullOutput.new
+      set_output(NullOutput.new)
     end
 
     def unsilence!
-      set_output nil
+      set_output(nil)
     end
 
     def with_output(new_output)
       old_output = output
-      set_output new_output
+      set_output(new_output)
       yield
     ensure
-      set_output old_output
+      set_output(old_output)
     end
 
     def batch
@@ -58,24 +57,24 @@ module L2meter
       in_batch!
       yield
     ensure
-      reset_in_batch old_state
+      reset_in_batch(old_state)
       write
     end
 
-    def measure(*args)
-      log_with_prefix :measure, *args
+    def measure(metric, value, **args)
+      log_with_prefix(:measure, metric, value, **args)
     end
 
-    def sample(*args)
-      log_with_prefix :sample, *args
+    def sample(metric, value, **args)
+      log_with_prefix(:sample, metric, value, **args)
     end
 
     def count(metric, value = 1)
-      log_with_prefix :count, metric, value
+      log_with_prefix(:count, metric, value)
     end
 
     def unique(metric, value)
-      log_with_prefix :unique, metric, value
+      log_with_prefix(:unique, metric, value)
     end
 
     def clone
@@ -83,7 +82,7 @@ module L2meter
       original_output = output
       self.class.new(configuration: configuration).tap do |clone|
         clone.instance_eval do
-          dynamic_contexts.concat original_contexts
+          dynamic_contexts.concat(original_contexts)
           set_output original_output
         end
       end
@@ -92,8 +91,8 @@ module L2meter
     private
 
     def log_with_prefix(method, key, value, unit: nil)
-      key = [configuration.prefix, key, unit].compact.join(?.)
-      log Hash["#{method}##{key}", value]
+      key = [configuration.prefix, key, unit].compact.join(".")
+      log(Hash["#{method}##{key}", value])
     end
 
     def elapse(since = Time.now)
@@ -101,21 +100,21 @@ module L2meter
     end
 
     def write(*args)
-      merge! *args
+      merge!(*args)
       fire! unless in_batch?
     end
 
-    def wrap
+    def wrap(&block)
       elapsed = elapse
       cloned_buffer = buffer.clone
-      write at: :start
-      result, exception = capture(&proc)
-      merge! cloned_buffer
+      write(at: :start)
+      result, exception = capture(&block)
+      merge!(cloned_buffer)
       if exception
-        write unwrap_exception(exception), elapsed: elapsed
-        raise exception
+        write(unwrap_exception(exception), elapsed: elapsed)
+        raise(exception)
       else
-        write at: :finish, elapsed: elapsed
+        write(at: :finish, elapsed: elapsed)
         result
       end
     end
@@ -127,7 +126,7 @@ module L2meter
     end
 
     def wrap_context(context_data)
-      dynamic_contexts.concat context_data
+      dynamic_contexts.concat(context_data)
       yield
     ensure
       context_data.each { dynamic_contexts.pop }
@@ -135,7 +134,7 @@ module L2meter
 
     def contexted(context_data)
       clone.instance_eval do
-        dynamic_contexts.concat context_data
+        dynamic_contexts.concat(context_data)
         self
       end
     end
@@ -161,7 +160,7 @@ module L2meter
     end
 
     def source_context
-      { source: configuration.source }
+      {source: configuration.source}
     end
 
     def resolved_contexts
@@ -172,13 +171,13 @@ module L2meter
       tokens = buffer.map { |k, v| build_token(k, v) }.compact
       tokens.sort! if configuration.sort?
       return if tokens.empty?
-      output.print tokens.join(SPACE) << NL
+      output.print(tokens.join(SPACE) << NL)
     ensure
       buffer.clear
     end
 
     SPACE = " ".freeze
-    NL    = "\n".freeze
+    NL = "\n".freeze
 
     private_constant :SPACE, :NL
 
@@ -218,7 +217,7 @@ module L2meter
       when Time
         format_time_value(value)
       when Array
-        value.map(&method(:format_value)).join(?,)
+        value.map(&method(:format_value)).join(",")
       else
         format_value(value.to_s)
       end
@@ -234,7 +233,7 @@ module L2meter
     end
 
     def format_string_value(value)
-      value =~ /[^\w,.:@\-\]\[]/ ?
+      /[^\w,.:@\-\]\[]/.match?(value) ?
         value.strip.gsub(/\s+/, " ").inspect :
         value.to_s
     end
@@ -251,7 +250,7 @@ module L2meter
     end
 
     def unwrap(args)
-      Hash.new.tap do |result|
+      {}.tap do |result|
         args.each do |arg|
           next if arg.nil?
           arg = Hash[arg, true] unless Hash === arg
@@ -295,7 +294,7 @@ module L2meter
     end
 
     def in_batch!
-      reset_in_batch true
+      reset_in_batch(true)
     end
 
     def reset_in_batch(new_value)

data/lib/l2meter/null_output.rb

@@ -1,5 +1,6 @@
 module L2meter
   class NullOutput
-    def print(*); end
+    def print(*)
+    end
   end
 end

data/lib/l2meter/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: l2meter
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Pavel Pravosud
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2019-05-12 00:00:00.000000000 Z
+date: 2020-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,15 +80,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description: L2meter is a tool for building logfmt-compatiable loggers.
 email:
 - pavel@pravosud.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
 - LICENSE.txt
 - README.md
+- Rakefile
+- l2meter.gemspec
 - lib/l2meter.rb
 - lib/l2meter/configuration.rb
 - lib/l2meter/emitter.rb
@@ -97,7 +104,11 @@ files:
 homepage: https://github.com/heroku/l2meter
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/heroku/l2meter
+  source_code_uri: https://github.com/heroku/l2meter
+  bug_tracker_uri: https://github.com/heroku/l2meter/issues
+  changelog_uri: https://github.com/heroku/l2meter/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -113,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: L2met friendly log formatter