sonnet 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fde1c29033040450a05efda38fc80a4ab39647af542de057bf1a51a12ae9c98
-  data.tar.gz: e02bacca362f4992aa567576d88720c961e3b733e7c9abdba5bdba9487aad0ac
+  metadata.gz: 2c6e3aeaaca85e174a1509ef9ac2876b6685f8bae30dbd940ad650ebf9377563
+  data.tar.gz: 834f727a97a66ee22bb9abf36594e149f473283ffa8d580435bea402fd600b62
 SHA512:
-  metadata.gz: 1bb24a4c08a4429764bd50319d088e342147fbf794ccb908213bd0dc74f010d01acafe9aa2c39f87b3b09396f9d29f072ae3f37a76fd6b2ef2730cd437ba8f0e
-  data.tar.gz: 65509aff4d33b784ec8576e3e78f2ef6bfe2fb9ffea11f9cf03f2877955eba628b12a7051667c68f679ecaf8381d7ac2142bf6f8b4448bcb5a86acfd6f8fc281
+  metadata.gz: b8a66ce8ae9c42fbd211764dea21398fcbdac0bd4fd1142577e02284122bd2a90dcf6632000e8c69743ec4c8082a4f99260beaae1eef64e13b536e53c096274b
+  data.tar.gz: 51eb3c154cccab8bc2ac7f1be0d0ae692f9d7c2c764df1eb08208e9fb4b788f46758cde46d54ecc4db32d23f12d1648897f8ce75ae2cd40087809904c9219df2

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in sonnet.gemspec

data/Gemfile.lock

@@ -1,14 +1,22 @@
 PATH
   remote: .
   specs:
-    sonnet (0.1.5)
+    sonnet (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ansi (1.5.0)
+    builder (3.2.3)
     byebug (11.0.1)
     minitest (5.11.3)
-    rake (12.3.2)
+    minitest-reporters (1.3.6)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    rake (13.0.1)
+    ruby-progressbar (1.10.0)
 
 PLATFORMS
   ruby
@@ -17,8 +25,9 @@ DEPENDENCIES
   bundler
   byebug
   minitest
+  minitest-reporters
   rake
   sonnet!
 
 BUNDLED WITH
-   2.0.1
+   2.1.4

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
 
@@ -7,4 +9,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => :test
+task default: :test

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "sonnet"

data/examples/sidekiq.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "sidekiq/job_logger"
 
 module SidekiqLogging
@@ -9,7 +11,7 @@ module SidekiqLogging
   end
 
   class JobLogger < Sidekiq::JobLogger
-    def call(job_hash, queue, &block)
+    def call(job_hash, _queue, &_block)
       Sidekiq.logger.with_context(SidekiqLogging.job_context(job_hash)) do
         begin
           start = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)

data/lib/sonnet/formatter.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "json"
-require "time"
+require 'json'
+require 'time'
 
 module Sonnet
   class Formatter
@@ -18,10 +18,11 @@ module Sonnet
       @time = time
       @progname = progname
       @data = data
+      @tags = []
     end
 
     def program
-      @progname || File.basename($0)
+      @progname || File.basename($0, '.rb').split(' ')[0]
     end
 
     def timestamp
@@ -52,7 +53,12 @@ module Sonnet
     end
 
     def context
-      self.class.current_context.inject({}, &:merge)
+      self.class.current_context.inject({}) do |memo, context|
+        context = context.dup
+        tags = memo.fetch(:tags, []) + [*context.delete(:tags)].flatten.compact
+        tag_context = tags.empty? ? {} : { tags: tags }
+        memo.merge(context).merge(tag_context)
+      end
     end
 
     def level
@@ -74,11 +80,11 @@ module Sonnet
         level: level,
         timestamp: timestamp,
         pid: pid
-      }.merge(data).merge(context).compact
+      }.merge(context).merge(data).compact
     end
 
-    def to_json
-      as_json.to_json + "\n"
+    def to_json(opts = nil)
+      as_json.to_json(opts) + "\n"
     end
   end
 end

data/lib/sonnet/logger.rb

@@ -2,6 +2,10 @@
 
 module Sonnet
   module Logger
+    def self.new(logger)
+      logger.extend self
+    end
+
     def self.extended(logger)
       logger.formatter = Formatter
       logger.level = log_level
@@ -11,10 +15,6 @@ module Sonnet
       ::Logger.const_get((ENV["LOG_LEVEL"] || "INFO").upcase)
     end
 
-    def self.new(logger)
-      logger.extend(self)
-    end
-
     def with_context(context = {})
       formatter.current_context.push(context)
       yield self

data/lib/sonnet/rails.rb

@@ -1,9 +1,73 @@
 # frozen_string_literal: true
 
+require 'sonnet'
+require 'concurrent'
+require 'fiber'
+
 module Sonnet
- class Rails < ::Rails::Engine
+  class Rails < ::Rails::Engine
     config.before_configuration do
-      require "sonnet/monkeypatch"
+      require "sonnet/rails_monkeypatch"
+    end
+  end
+
+  module RailsLogger
+    def self.included(base)
+
+      base.singleton_class.prepend (Module.new do
+        def extended(logger)
+          super(logger)
+          logger.after_initialize if logger.respond_to?(:after_initialize)
+        end
+      end)
+    end
+
+    def after_initialize
+      @local_levels = Concurrent::Map.new(initial_capacity: 2)
+    end
+
+    def tagged(*tags, &block)
+      if tags.present?
+        with_context(tags: tags.flatten, &block)
+      else
+        yield self
+      end
+    end
+
+    def local_log_id
+      Fiber.current.__id__
+    end
+
+    def local_level
+      @local_levels[local_log_id]
+    end
+
+    def local_level=(level)
+      if level
+        @local_levels[local_log_id] = level
+      else
+        @local_levels.delete(local_log_id)
+      end
+    end
+
+    def level
+      local_level || super
+    end
+  end
+
+  module RailsFormatter
+    def current_tags
+      current_context.inject([]) do |memo, context|
+        memo + [*context[:tags]].flatten.compact
+      end
     end
   end
+
+  module Logger
+    include RailsLogger
+  end
+
+  class Formatter
+    extend RailsFormatter
+  end
 end

data/lib/sonnet/{monkeypatch.rb → rails_monkeypatch.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 if ActiveSupport::VERSION::MAJOR < 6
   # Monkeypatch in Rails 6 ActiveSupport::TaggedLogging initializer.
   # Solves problem in which the TaggedLogging initializer modifies an existing logger
@@ -32,8 +34,10 @@ if ActiveSupport::VERSION::MAJOR < 6
       end
     end
   end
-else
-  ActiveSupport::Deprecation.warn('No longer need to monkeypatch ActiveSupport::TaggedLogging!')
-  ActiveSupport::Deprecation.warn('No longer need to monkeypatch ActionDispatch::DebugExceptions!')
-end
 
+  module Sonnet
+    module RailsLogger
+      include LoggerSilence
+    end
+  end
+end

data/lib/sonnet/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sonnet
-  VERSION = "0.1.5"
+  VERSION = "0.2.0"
 end

data/sonnet.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require "sonnet/version"
@@ -21,5 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-reporters"
   spec.add_development_dependency "rake"
 end

data/test/rails_logger_test.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+# Stub out some Rails constants and methods
+Rails = Module.new
+Rails::Engine = Class.new do
+  def self.config
+    OpenStruct.new
+  end
+end
+ActiveSupport = Module.new
+ActiveSupport::LoggerThreadSafeLevel = Module.new
+LoggerSilence = Module.new
+
+class Array
+  def present?
+    length > 0
+  end
+end
+
+require 'sonnet/rails'
+
+class RailsLoggerTest < Minitest::Test
+  def setup
+    logger.extend(Sonnet::Logger)
+  end
+
+  def test_tagged_string
+    logger.tagged('request_id') do
+      logger.info("What's the story, morning glory?")
+    end
+    assert_equal log[0][:tags], ['request_id']
+  end
+
+  def test_tagged_array
+    logger.tagged(['request_id']) do
+      logger.info("What's the story, morning glory?")
+    end
+    assert_equal log[0][:tags], ['request_id']
+  end
+end

data/test/sonnet/formatter_test.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+module Sonnet
+  class FormatterTest < Minitest::Test
+    def test_call
+      now = Time.now
+      with_program_name("sidekiq 5.2.5 diaco [0 of 10 busy]") do
+        log_line = JSON.parse(formatter.call("INFO", now, nil, "some message"), symbolize_names: true)
+        assert_equal log_line, {
+          program: "sidekiq",
+          level: "info",
+          timestamp: now.iso8601(3),
+          pid: $$,
+          message: "some message"
+        }
+      end
+    end
+
+    protected
+
+    def formatter
+      Formatter
+    end
+
+    def with_program_name(name)
+      original_program_name = $0
+      $0 = name
+      yield if block_given?
+    ensure
+      $0 = original_program_name
+    end
+  end
+end

data/test/{sonnet_test.rb → sonnet/logger_test.rb}

@@ -1,11 +1,17 @@
+# frozen_string_literal: true
+
 require "test_helper"
 
-class SonnetTest < Minitest::Test
+class LoggerTest < Minitest::Test
   Error = Class.new(StandardError)
 
+  def setup
+    logger.extend(Sonnet::Logger)
+  end
+
   def test_log_info
     logger.info("What's the story, morning glory?")
-    assert_log_line log[0], level: "info", message: "What's the story, morning glory?"
+    assert_equal log[0].slice(:level, :message), level: "info", message: "What's the story, morning glory?"
   end
 
   def test_log_debug
@@ -13,19 +19,19 @@ class SonnetTest < Minitest::Test
     assert_nil log[0]
     logger.level = Logger::DEBUG
     logger.debug("this should be logged")
-    assert_log_line log[0], level: "debug", message: "this should be logged"
+    assert_equal log[0].slice(:level, :message), level: "debug", message: "this should be logged"
   end
 
   def test_log_exception
     logger.error(Error.new("something went wrong"))
-    assert_log_line log[0], message: "something went wrong"
+    assert_equal messages(log), ["something went wrong"]
   end
 
   def test_log_with_context
     logger.with_context(color: "blue") { logger.info("What's the story, morning glory?") }
     logger.info("definitely maybe")
-    assert_log_line log[0], color: "blue", message: "What's the story, morning glory?"
-    assert_log_line log[1], message: "definitely maybe"
+    assert_equal log[0].slice(:color, :message), color: "blue", message: "What's the story, morning glory?"
+    assert_equal log[1].slice(:color, :message), message: "definitely maybe"
   end
 
   def test_new
@@ -34,20 +40,4 @@ class SonnetTest < Minitest::Test
     logger.info("What's the story, morning glory?")
     assert_log_line log[0], level: "info", message: "What's the story, morning glory?"
   end
-
-  def assert_log_line(actual, expected)
-    assert_equal expected, actual.slice(*expected.keys)
-  end
-
-  def logger
-    @logger ||= Logger.new(io).tap { |logger| logger.extend(Sonnet::Logger) }
-  end
-
-  def io
-    @io ||= StringIO.new
-  end
-
-  def log
-    io.string.each_line.map { |line| JSON.parse(line, symbolize_names: true) }
-  end
 end

data/test/test_helper.rb

@@ -1,6 +1,37 @@
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
-require "minitest/autorun"
-require "byebug"
-require "logger"
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'byebug'
+require 'logger'
+
+Minitest::Reporters.use! [Minitest::Reporters::ProgressReporter.new]
 
 require "sonnet"
+
+module LoggingHelpers
+  def logger
+    @logger ||= Logger.new(io)
+  end
+
+  def io
+    @io ||= StringIO.new
+  end
+
+  def assert_log_line(actual, expected)
+    assert_equal expected, actual.slice(*expected.keys)
+  end
+
+  def log
+    io.string.each_line.map { |line| JSON.parse(line, symbolize_names: true) }
+  end
+
+  def messages(lines)
+    lines.map { |line| line[:message] }
+  end
+end
+
+class Minitest::Test
+  include LoggingHelpers
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sonnet
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Cory Kaufman-Schofield
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-09 00:00:00.000000000 Z
+date: 2021-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -85,18 +99,20 @@ files:
 - lib/sonnet.rb
 - lib/sonnet/formatter.rb
 - lib/sonnet/logger.rb
-- lib/sonnet/monkeypatch.rb
 - lib/sonnet/rails.rb
+- lib/sonnet/rails_monkeypatch.rb
 - lib/sonnet/version.rb
 - sonnet.gemspec
-- test/sonnet_test.rb
+- test/rails_logger_test.rb
+- test/sonnet/formatter_test.rb
+- test/sonnet/logger_test.rb
 - test/test_helper.rb
 homepage: https://github.com/allspiritseve/sonnet
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -111,8 +127,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Structured logging for Ruby applications
 test_files: []