twiglet 2.1.0 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a94a60f7f04b8a19fd27f483e9f8e29992a237fa03491ad417a385032b98401
-  data.tar.gz: 976a134b1c69aa19956b5979affa35fc0141cb5164a8fa67a0aa91da1f490b2a
+  metadata.gz: dd959654140f88727254fcf4d660dd017e8a00e12f3a68eabf6359246f7aeb97
+  data.tar.gz: ab14bddf0d5b9138634000a0fad1e7d4fd5d13d56e2e604aef87a74e2c0c7d78
 SHA512:
-  metadata.gz: 93c304efe8eeccbe2f6ed826499a288eee8d07897c79e1c0aca1f16e3908ea136a1731db7318228e5fa819b3cdafe6b196926a0fd1f9d387f94f7a315b0e868b
-  data.tar.gz: 74b4d3ec698510d3a236a159bf92fe1b0d07d6caf60fce91e46d24d89680ea5c93ffaee042606c5560d72709148756912d011405c113f51213f959c449d9e0ba
+  metadata.gz: 1effc27ff4f08c25d1b92789e7b7937da24d652c922bf0bc404a4ca106d5c670897b0e24bbee17ee0fd1d1e584457bba06034e5fb0432edf6d517cd6dc3f801b
+  data.tar.gz: 5e6a270d224fb73e077670036b2540a23787ac4d9cde08c8aa0912c2c94e2ec392e49b8d39e134d13c4a76b3e6294729b5241ac651504e9099e69509b8ddf044

data/.github/workflows/ruby.yml

@@ -3,8 +3,6 @@ name: Ruby CI
 on:
   push:
     branches:
-      - '*'         # matches every branch
-      - '*/*'       # matches every branch containing a single '/'
 
 jobs:
   build:
@@ -30,3 +28,6 @@ jobs:
     - name: Run all tests
       run: bundle exec rake test
       shell: bash
+    - name: Run example_app
+      run: bundle exec ruby example_app.rb
+      shell: bash

data/.gitignore

@@ -1,4 +1,5 @@
 *.gem
+Gemfile.lock
 *.rbc
 /.config
 /coverage/

data/README.md

@@ -22,7 +22,9 @@ A hash can optionally be passed in as a keyword argument for `default_properties
 
 You may also provide an optional `output` keyword argument which should be an object with a `puts` method - like `$stdout`.
 
-Lastly, you can provide another optional keyword argument called `now`, which should be a function returning a `Time` string in ISO8601 format.
+In addition, you can provide another optional keyword argument called `now`, which should be a function returning a `Time` string in ISO8601 format.
+
+Lastly, you may provide the optional keyword argument `level` to initialize the logger with a severity threshold. Alternatively, the threshold can be updated at runtime by calling the `level` instance method.
 
 The defaults for both `output` and `now` should serve for most uses, though you may want to override them for testing as we have done [here](test/logger_test.rb).
 

data/lib/twiglet/formatter.rb

@@ -0,0 +1,69 @@
+require 'logger'
+require_relative '../hash_extensions'
+
+module Twiglet
+  class Formatter < ::Logger::Formatter
+    Hash.include HashExtensions
+
+    def initialize(service_name,
+                   default_properties: {},
+                   now: -> { Time.now.utc })
+      @service_name = service_name
+      @now = now
+      @default_properties = default_properties
+
+      super()
+    end
+
+    def call(severity, _time, _progname, msg)
+      level = severity.downcase
+      log(level: level, message: msg)
+    end
+
+    private
+
+    def log(level:, message:)
+      case message
+      when String
+        log_text(level, message: message)
+      when Hash
+        log_object(level, message: message)
+      else
+        raise('Message must be String or Hash')
+      end
+    end
+
+    def log_text(level, message:)
+      raise('The \'message\' property of log object must not be empty') if message.strip.empty?
+
+      message = { message: message }
+      log_message(level, message: message)
+    end
+
+    def log_object(level, message:)
+      message = message.transform_keys(&:to_sym)
+      message.key?(:message) || raise('Log object must have a \'message\' property')
+      message[:message].strip.empty? && raise('The \'message\' property of log object must not be empty')
+
+      log_message(level, message: message)
+    end
+
+    def log_message(level, message:)
+      base_message = {
+        "@timestamp": @now.call.iso8601(3),
+        service: {
+          name: @service_name
+        },
+        log: {
+          level: level
+        }
+      }
+
+      base_message
+        .deep_merge(@default_properties.to_nested)
+        .deep_merge(message.to_nested)
+        .to_json
+        .concat("\n")
+    end
+  end
+end

data/lib/twiglet/logger.rb

@@ -1,112 +1,63 @@
 # frozen_string_literal: true
 
+require 'logger'
 require 'time'
 require 'json'
+require_relative 'formatter'
 require_relative '../hash_extensions'
 
 module Twiglet
-  class Logger
+  class Logger < ::Logger
     Hash.include HashExtensions
 
     def initialize(
       service_name,
       default_properties: {},
       now: -> { Time.now.utc },
-      output: $stdout
+      output: $stdout,
+      level: Logger::DEBUG
     )
       @service_name = service_name
       @now = now
       @output = output
+      @level = level
 
       raise 'Service name is mandatory' \
-        unless @service_name.is_a?(String) && !@service_name.strip.empty?
+        unless service_name.is_a?(String) && !service_name.strip.empty?
 
-      @default_properties = default_properties
+      formatter = Twiglet::Formatter.new(service_name, default_properties: default_properties, now: now)
+      super(output, formatter: formatter, level: level)
     end
 
-    def debug(message)
-      log(level: 'debug', message: message)
-    end
-
-    def info(message)
-      log(level: 'info', message: message)
-    end
-
-    def warning(message)
-      log(level: 'warning', message: message)
-    end
-
-    alias_method :warn, :warning
-
-    def error(message, error = nil)
+    def error(message = {}, error = nil, &block)
       if error
-        message = message.merge({
-                                  'error': {
-                                    'message': error.message,
-                                    'stack_trace': error.backtrace.join("\n")
-                                  }
-                                })
+        error_fields = {
+          'error': {
+            'message': error.message
+          }
+        }
+        add_stack_trace(error_fields, error)
+        message.is_a?(Hash) ? message.merge!(error_fields) : error_fields.merge!(message: message)
       end
 
-      log(level: 'error', message: message)
-    end
-
-    def critical(message)
-      log(level: 'critical', message: message)
+      super(message, &block)
     end
 
-    alias_method :fatal, :critical
-
     def with(default_properties)
       Logger.new(@service_name,
                  default_properties: default_properties,
                  now: @now,
-                 output: @output)
+                 output: @output,
+                 level: @level)
     end
 
-    private
+    alias_method :warning, :warn
+    alias_method :critical, :fatal
 
-    def log(level:, message:)
-      case message
-      when String
-        log_text(level, message: message)
-      when Hash
-        log_object(level, message: message)
-      else
-        raise('Message must be String or Hash')
-      end
-    end
-
-    def log_text(level, message:)
-      raise('The \'message\' property of log object must not be empty') if message.strip.empty?
-
-      message = { message: message }
-      log_message(level, message: message)
-    end
-
-    def log_object(level, message:)
-      message = message.transform_keys(&:to_sym)
-      message.key?(:message) || raise('Log object must have a \'message\' property')
-      message[:message].strip.empty? && raise('The \'message\' property of log object must not be empty')
-
-      log_message(level, message: message)
-    end
-
-    def log_message(level, message:)
-      base_message = {
-        "@timestamp": @now.call.iso8601(3),
-        service: {
-          name: @service_name
-        },
-        log: {
-          level: level
-        }
-      }
+    private
 
-      @output.puts base_message
-                       .deep_merge(@default_properties.to_nested)
-                       .deep_merge(message.to_nested)
-                       .to_json
+    def add_stack_trace(hash_to_add_to, error)
+      hash_to_add_to[:error][:stack_trace] = error.backtrace.join("\n") if error.backtrace
     end
   end
 end

data/lib/twiglet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Twiglet
-  VERSION = '2.1.0'
+  VERSION = '2.2.3'
 end

data/test/formatter_test.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'json'
+require_relative '../lib/twiglet/formatter'
+
+describe Twiglet::Formatter do
+  before do
+    @now = -> { Time.utc(2020, 5, 11, 15, 1, 1) }
+    @formatter = Twiglet::Formatter.new('petshop', now: @now)
+  end
+
+  it 'initializes an instance of a Ruby Logger Formatter' do
+    assert @formatter.is_a?(::Logger::Formatter)
+  end
+
+  it 'returns a formatted log from a string message' do
+    msg = @formatter.call('warn', nil, nil, 'shop is running low on dog food')
+    expected_log = {
+      "@timestamp" => '2020-05-11T15:01:01.000Z',
+      "service" => {
+        "name" => 'petshop'
+      },
+      "log" => {
+        "level" => 'warn'
+      },
+      "message" => 'shop is running low on dog food'
+    }
+    assert_equal JSON.parse(msg), expected_log
+  end
+end

data/test/logger_test.rb

@@ -3,6 +3,7 @@
 require 'minitest/autorun'
 require_relative '../lib/twiglet/logger'
 
+# rubocop:disable Metrics/BlockLength
 describe Twiglet::Logger do
   before do
     @now = -> { Time.utc(2020, 5, 11, 15, 1, 1) }
@@ -15,10 +16,10 @@ describe Twiglet::Logger do
   LEVELS = [
     { method: :debug, level: 'debug' },
     { method: :info, level: 'info' },
-    { method: :warning, level: 'warning' },
-    { method: :warn, level: 'warning' },
-    { method: :critical, level: 'critical' },
-    { method: :fatal, level: 'critical' },
+    { method: :warning, level: 'warn' },
+    { method: :warn, level: 'warn' },
+    { method: :critical, level: 'fatal' },
+    { method: :fatal, level: 'fatal' },
     { method: :error, level: 'error' }
   ].freeze
 
@@ -28,6 +29,13 @@ describe Twiglet::Logger do
     end
   end
 
+  it 'conforms to the standard Ruby Logger API' do
+    [:debug, :debug?, :info, :info?, :warn, :warn?, :fatal, :fatal?, :error, :error?,
+     :level, :level=, :sev_threshold=].each do |call|
+      assert @logger.respond_to?(call), "Logger does not respond to #{call}"
+    end
+  end
+
   describe 'JSON logging' do
     it 'should throw an error with an empty message' do
       assert_raises RuntimeError do
@@ -123,6 +131,21 @@ describe Twiglet::Logger do
       assert_equal 'Guinea pigs arrived', log[:message]
     end
 
+    it "should log multiple messages properly" do
+      @logger.debug({message: 'hi'})
+      @logger.info({message: 'there'})
+
+      expected_output =
+        '{"@timestamp":"2020-05-11T15:01:01.000Z",'\
+        '"service":{"name":"petshop"},"log":{"level":"debug"},"message":"hi"}'\
+        "\n"\
+        '{"@timestamp":"2020-05-11T15:01:01.000Z",'\
+        '"service":{"name":"petshop"},"log":{"level":"info"},"message":"there"}'\
+        "\n"\
+
+      assert_equal expected_output, @buffer.string
+    end
+
     it 'should be able to convert dotted keys to nested objects' do
       @logger.debug({
                       "trace.id": '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb',
@@ -193,6 +216,17 @@ describe Twiglet::Logger do
       assert_match 'logger_test.rb', actual_log[:error][:stack_trace].lines.first
     end
 
+    it 'should log an error without backtrace' do
+      e = StandardError.new('Connection timed-out')
+      @logger.error({message: 'Artificially raised exception'}, e)
+
+      actual_log = read_json(@buffer)
+
+      assert_equal 'Artificially raised exception', actual_log[:message]
+      assert_equal 'Connection timed-out', actual_log[:error][:message]
+      refute actual_log[:error].key?(:stack_trace)
+    end
+
     LEVELS.each do |attrs|
       it "should correctly log level when calling #{attrs[:method]}" do
         @logger.public_send(attrs[:method], {message: 'a log message'})
@@ -247,6 +281,36 @@ describe Twiglet::Logger do
     end
   end
 
+  describe 'logging with a block' do
+    LEVELS.each do |attrs|
+      it "should correctly log the block when calling #{attrs[:method]}" do
+        block = proc { 'a block log message' }
+        @logger.public_send(attrs[:method], &block)
+        actual_log = read_json(@buffer)
+
+        assert_equal attrs[:level], actual_log[:log][:level]
+        assert_equal 'a block log message', actual_log[:message]
+      end
+    end
+  end
+
+  describe 'logger level' do
+    [
+      { expression: :info, level: 1 },
+      { expression: 'warn', level: 2 },
+      { expression: Logger::DEBUG, level: 0 }
+    ].each do |args|
+      it "sets the severity threshold to level #{args[:level]}" do
+        @logger.level = args[:expression]
+        assert_equal args[:level], @logger.level
+      end
+    end
+
+    it 'initializes the logger with the provided level' do
+      assert_equal Logger::WARN, Twiglet::Logger.new('petshop', level: :warn).level
+    end
+  end
+
   private
 
   def read_json(buffer)
@@ -254,3 +318,4 @@ describe Twiglet::Logger do
     JSON.parse(buffer.read, symbolize_names: true)
   end
 end
+# rubocop:enable Metrics/BlockLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.3
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-10 00:00:00.000000000 Z
+date: 2020-06-29 00:00:00.000000000 Z
 dependencies: []
 description: Like a log, only smaller.
 email:
@@ -24,15 +24,16 @@ files:
 - ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - RATIONALE.md
 - README.md
 - Rakefile
 - example_app.rb
 - lib/hash_extensions.rb
+- lib/twiglet/formatter.rb
 - lib/twiglet/logger.rb
 - lib/twiglet/version.rb
+- test/formatter_test.rb
 - test/hash_extensions_test.rb
 - test/logger_test.rb
 - twiglet.gemspec
@@ -55,7 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Twiglet

data/Gemfile.lock

@@ -1,62 +0,0 @@
-GIT
-  remote: https://github.com/simplybusiness/simplycop.git
-  revision: 02b417277e3ff9eeab34d6b7c30a95a17d876731
-  specs:
-    simplycop (0.5.4)
-      rubocop (~> 0.80.0)
-      rubocop-rails
-      rubocop-rspec
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (6.0.3.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    ast (2.4.0)
-    concurrent-ruby (1.1.6)
-    i18n (1.8.2)
-      concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    minitest (5.14.0)
-    parallel (1.19.1)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
-    rack (2.2.2)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    rexml (3.2.4)
-    rubocop (0.80.1)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.7.0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      rexml
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-rails (2.5.2)
-      activesupport
-      rack (>= 1.1)
-      rubocop (>= 0.72.0)
-    rubocop-rspec (1.39.0)
-      rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.1)
-    zeitwerk (2.3.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  minitest
-  rake
-  simplycop!
-
-BUNDLED WITH
-   2.1.4