sonnet 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fde1c29033040450a05efda38fc80a4ab39647af542de057bf1a51a12ae9c98
-  data.tar.gz: e02bacca362f4992aa567576d88720c961e3b733e7c9abdba5bdba9487aad0ac
+  metadata.gz: 3961783bc4eb8f519c30df1a232e34031827335f1e4804f5c5d444ef15bfb57c
+  data.tar.gz: 2fccb0e4851778f673a1ff10de4a6ed771a919c7692612d0320cfabf3728d849
 SHA512:
-  metadata.gz: 1bb24a4c08a4429764bd50319d088e342147fbf794ccb908213bd0dc74f010d01acafe9aa2c39f87b3b09396f9d29f072ae3f37a76fd6b2ef2730cd437ba8f0e
-  data.tar.gz: 65509aff4d33b784ec8576e3e78f2ef6bfe2fb9ffea11f9cf03f2877955eba628b12a7051667c68f679ecaf8381d7ac2142bf6f8b4448bcb5a86acfd6f8fc281
+  metadata.gz: 133fb98a3a340477a2076b35d7256aaeb52f6b43e62c1f1b7703d0b4b16a599dabd7defbd7127f3d7ad1463a4de175946db9ca4d05735e63616be0a5b6749c4c
+  data.tar.gz: bde201a3bddec39c6179d0b371aabfae9d2a9039f1975bb155ad68db0ccb4bebeb5c416f3ab5c933334a03b3196edde874360699823c4afa6f3c0c2d5cc14463

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.1.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ansi (1.5.0)
+    builder (3.2.3)
     byebug (11.0.1)
     minitest (5.11.3)
+    minitest-reporters (1.3.6)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
     rake (12.3.2)
+    ruby-progressbar (1.10.0)
 
 PLATFORMS
   ruby
@@ -17,6 +25,7 @@ DEPENDENCIES
   bundler
   byebug
   minitest
+  minitest-reporters
   rake
   sonnet!
 

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,11 @@ module Sonnet
     end
 
     def context
-      self.class.current_context.inject({}, &:merge)
+      self.class.current_context.inject({}) do |memo, context|
+        tags = memo.fetch(:tags, []) + [*context.delete(:tags)].compact
+        tag_context = tags.empty? ? {} : { tags: tags }
+        memo.merge(context).merge(tag_context)
+      end
     end
 
     def level
@@ -74,11 +79,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,37 @@
 # frozen_string_literal: true
 
+require 'sonnet'
+
 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
+    include ActiveSupport::LoggerThreadSafeLevel
+    include LoggerSilence
+
+    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 tagged(*tags, &block)
+      if tags.present?
+        with_context(tags: tags, &block)
+      else
+        yield self
+      end
+    end
+  end
+
+  module Logger
+    include RailsLogger
   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
@@ -36,4 +38,3 @@ else
   ActiveSupport::Deprecation.warn('No longer need to monkeypatch ActiveSupport::TaggedLogging!')
   ActiveSupport::Deprecation.warn('No longer need to monkeypatch ActionDispatch::DebugExceptions!')
 end
-

data/lib/sonnet/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sonnet
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 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/logger_test.rb

@@ -0,0 +1,34 @@
+require "test_helper"
+
+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_equal log[0].slice(:level, :message), level: "info", message: "What's the story, morning glory?"
+  end
+
+  def test_log_debug
+    logger.debug("this should not be logged")
+    assert_nil log[0]
+    logger.level = Logger::DEBUG
+    logger.debug("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_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_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
+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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "test_helper"
 
 class SonnetTest < Minitest::Test

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.1.6
 platform: ruby
 authors:
 - Cory Kaufman-Schofield
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-09 00:00:00.000000000 Z
+date: 2019-05-15 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,10 +99,12 @@ 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/logger_test.rb
+- test/sonnet/formatter_test.rb
 - test/sonnet_test.rb
 - test/test_helper.rb
 homepage: https://github.com/allspiritseve/sonnet