twiglet 3.5.4 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b8ba648b25202c2ee3c47bdd3885e879681ec1b4e3685edf97905b16a6caeb7
-  data.tar.gz: 78547321be656034d05e9dfacb29f913214a5ed540355d4050675e55b5302ac0
+  metadata.gz: 65882a52b10620b9a6ab5ff439b9f377e135308055618474510f232d14be0ec5
+  data.tar.gz: 97fb56dced537bc5bf3e0ddebfc6cf2be076466241eaef4b63437a278664fe47
 SHA512:
-  metadata.gz: a9c8563acaa808a3491c386a5c57025089d83033cf35d38baf92b4abb2d9cb88ee52827155c03504c4d012d50df8acecb084b649239e558dbeca2817b016734d
-  data.tar.gz: 97d2797e525c3dd2dd19d9a6e5fde20226fa2675d40be1d3e7c2ba57dc6833dcb601ebe1e62f7c7827113f9a260cb642c40b3cfbc32bed0db9ba4b5d76f0dd61
+  metadata.gz: '09a38113c797bec07068cd08a3d2c00fceac2f1617956ce88cb775c8c2fb86344377569f0df5b75d47e93ab8bc1a6c94fadd6d2ec2190edfcefc0d648a471f67'
+  data.tar.gz: e37658db9af2be233a93c3f6ef7ea776a4ae51bbbbd09afb85a5e77c5b13a7172fd7ca141b87241edb1ebf7678f7a4ca1485629a6ef97c7921da7b9a33b32009

data/lib/twiglet/logger.rb

@@ -42,17 +42,26 @@ module Twiglet
       @validator.custom_error_handler = block
     end
 
+    def debug(message_or_error = nil, &block)
+      message = message_or_error.is_a?(Exception) ? error_message(message_or_error) : message_or_error
+
+      super(message, &block)
+    end
+
+    def info(message_or_error = nil, &block)
+      message = message_or_error.is_a?(Exception) ? error_message(message_or_error) : message_or_error
+
+      super(message, &block)
+    end
+
+    def warn(message_or_error = nil, &block)
+      message = message_or_error.is_a?(Exception) ? error_message(message_or_error) : message_or_error
+
+      super(message, &block)
+    end
+
     def error(message = nil, error = nil, &block)
-      if error
-        error_fields = {
-          error: {
-            type: error.class.to_s,
-            message: error.message
-          }
-        }
-        add_stack_trace(error_fields, error)
-        message = Message.new(message).merge(error_fields)
-      end
+      message = error_message(error, message) if error
 
       super(message, &block)
     end
@@ -76,6 +85,18 @@ module Twiglet
 
     private
 
+    def error_message(error, message = nil)
+      error_fields = {
+        error: {
+          type: error.class.to_s,
+          message: error.message
+        }
+      }
+      add_stack_trace(error_fields, error)
+      message = error.message if message.nil? || message.empty?
+      Message.new(message).merge(error_fields)
+    end
+
     def add_stack_trace(hash_to_add_to, error)
       hash_to_add_to[:error][:stack_trace] = error.backtrace if error.backtrace
     end

data/lib/twiglet/version.rb

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

data/test/logger_test.rb

@@ -361,6 +361,31 @@ describe Twiglet::Logger do
 
       assert_equal 'StandardError', actual_log[:error][:type]
     end
+
+    it 'can log just an error as "error", if no message is given' do
+      e = StandardError.new('some error')
+      @logger.error(nil, e)
+
+      actual_log = read_json(@buffer)
+
+      assert_equal 'some error', actual_log[:message]
+      assert_equal 'StandardError', actual_log[:error][:type]
+      assert_equal 'some error', actual_log[:error][:message]
+    end
+
+    [:debug, :info, :warn].each do |level|
+      it "can log an error with type, error message etc.. as '#{level}'" do
+        error_message = "error to be logged as #{level}"
+        e = StandardError.new(error_message)
+        @logger.public_send(level, e)
+
+        actual_log = read_json(@buffer)
+
+        assert_equal error_message, actual_log[:message]
+        assert_equal 'StandardError', actual_log[:error][:type]
+        assert_equal error_message, actual_log[:error][:message]
+      end
+    end
   end
 
   describe 'text logging' do
@@ -420,6 +445,15 @@ describe Twiglet::Logger do
         assert_equal 'a block log message', actual_log[:message]
       end
     end
+
+    it 'should ignore the given progname if a block is also given' do
+      block = proc { 'a block log message' }
+      @logger.info('my-program-name', &block)
+      actual_log = read_json(@buffer)
+
+      assert_equal 'info', actual_log[:log][:level]
+      assert_equal 'a block log message', actual_log[:message]
+    end
   end
 
   describe 'dotted keys' do

data/twiglet.gemspec

@@ -15,7 +15,6 @@ Gem::Specification.new do |gem|
   gem.description           = 'Like a log, only smaller.'
 
   gem.files                 = `git ls-files`.split("\n")
-  gem.test_files            = `git ls-files -- {test}/*`.split("\n")
 
   gem.require_paths         = ['lib']
   gem.required_ruby_version = '>= 2.6'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 3.5.4
+  version: 3.6.0
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-11 00:00:00.000000000 Z
+date: 2022-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema