twiglet 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f97187804f27d00e7b8231880b43c50769b70a1598dcb3eedb42d2afad4fe0c
-  data.tar.gz: 18f126aef6c1b43bde8b4e343d2c7595e4fc3f1c07608e02214b3bf7ab2e36e4
+  metadata.gz: 356d8c7fec6c41823029cc36bef1cc49bacae6157342b251e9b57f49dcb8151f
+  data.tar.gz: bd58a67b48daa9bf6108dc78098f46ad0204f98ca600c29bacd713f6cb54ea2e
 SHA512:
-  metadata.gz: 2bf3104cbb1e9f4051f58d6969cf7a761f8aac44a50dfee5677ed52b8ddc0679692357b513b0c995f40fe29f9327f339c8491db326bff261e167e1e8bf6d61b1
-  data.tar.gz: d1ee7cd4c20da132b3cfa8ca88ef117cc93bbb77773671274792cf67746f6b1947ff8c426099a2417ccbc291ff95853adaf1ded2be007f1deb85ebce265567ef
+  metadata.gz: 4bc443482b93b1bba853fbe67605d9b0673830726cf1ef89e941860bc7f832d1efb5f82d5890197ae279b9edf97bf19edf8dc2d8bf61d56d082d6e641f94a245
+  data.tar.gz: 8d5e178fca01957147dca807aab4117958b18514d568440e72f53cfc8931aad62035a71633646776368f4409d9be48ab8598c66aad4347edd59f79a0bfc281ae

data/lib/twiglet/formatter.rb

@@ -0,0 +1,68 @@
+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
+    end
+  end
+end

data/lib/twiglet/logger.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require 'logger'
 require 'time'
 require 'json'
+require 'twiglet/formatter'
 require_relative '../hash_extensions'
 
 module Twiglet
-  class Logger
+  class Logger < ::Logger
     Hash.include HashExtensions
 
     def initialize(
@@ -19,26 +21,13 @@ module Twiglet
       @output = output
 
       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)
     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
         error_fields = {
           'error': {
@@ -46,18 +35,12 @@ module Twiglet
           }
         }
         add_stack_trace(error_fields, error)
-        message = message.merge(error_fields)
+        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,
@@ -65,50 +48,10 @@ module Twiglet
                  output: @output)
     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')
+    alias_method :warning, :warn
+    alias_method :critical, :fatal
 
-      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
-        }
-      }
-
-      @output.puts base_message
-                       .deep_merge(@default_properties.to_nested)
-                       .deep_merge(message.to_nested)
-                       .to_json
-    end
+    private
 
     def add_stack_trace(hash_to_add_to, error)
       hash_to_add_to[:error][:stack_trace] = error.backtrace.join("\n") if error.backtrace

data/lib/twiglet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Twiglet
-  VERSION = '2.1.1'
+  VERSION = '2.2.0'
 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

@@ -15,10 +15,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 +28,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
@@ -258,6 +265,32 @@ 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
+  end
+
   private
 
   def read_json(buffer)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-11 00:00:00.000000000 Z
+date: 2020-06-22 00:00:00.000000000 Z
 dependencies: []
 description: Like a log, only smaller.
 email:
@@ -31,8 +31,10 @@ files:
 - 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 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Twiglet