twiglet 3.9.0 → 3.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24bb01ca290d4e49c2a38e69a0566bcb0e06d38e5c1daa120abb90c2a88c1826
-  data.tar.gz: 00e825a9ae2164604a36b54811bf659321bc5bb1bf96afc198399c890058004a
+  metadata.gz: 3b87b30fcde8a6363eb43ef4451718f3e15066a686b6ecd5340cb504cc3f0ebd
+  data.tar.gz: 6efcea94e5b2623e3c01e974f34ad80f0c7238fb655f306415ad75a7105b0164
 SHA512:
-  metadata.gz: 8992a36124f946eb46fc63fd432d5ae1c5359101572a759eea3a70bb7d1b5d3ccadc9d76a075b42222906f6eb2a4c03de273b967a4e7bb8d977ec9f2a2095954
-  data.tar.gz: bfd2479a25d3d2f5212721941bd2400ad6179080f65a913efa4256c7ca7304e8042efc9ca50f294e19d5157e4d640e2c03e97c45891320ea445ef32792eaaa88
+  metadata.gz: 962d159d17c025956e0294d07ae9f452f10298c17fdaa3d56eb56e7547eee03ef324d260d58151553ada630eb2a5326650d22b6649ceb00ca8412dda7b27cb92
+  data.tar.gz: e5a2394439c12bedc56de394e5275ae383c4c40debba8cdcd9a81aefe962afc9d81089df599ed6201103646136969356d7101bb570be8736987cfb3c150edb65

data/catalog-info.yaml

@@ -1,8 +1,11 @@
 apiVersion: backstage.io/v1alpha1
 kind: Component
 metadata:
-  name: twiglet
+  name: twiglet-ruby
+  title: Twiglet
   description: simple logging
+  annotations:   
+    rubygems.org/name: "twiglet"
 spec:
   type: library
   lifecycle: production

data/lib/twiglet/formatter.rb

@@ -47,12 +47,12 @@ module Twiglet
 
       context = @context_provider&.call || {}
 
-      base_message
-        .deep_merge(@default_properties.to_nested)
-        .deep_merge(context.to_nested)
-        .deep_merge(message.to_nested)
-        .to_json
-        .concat("\n")
+      JSON.generate(
+        base_message
+          .deep_merge(@default_properties.to_nested)
+          .deep_merge(context.to_nested)
+          .deep_merge(message.to_nested)
+      ).concat("\n")
     end
   end
 end

data/lib/twiglet/logger.rb

@@ -62,8 +62,14 @@ module Twiglet
       super(message, &block)
     end
 
-    def error(message = nil, error = nil, &block)
-      message = error_message(error, message) if error
+    def error(message_or_error = nil, error = nil, &block)
+      message = if error
+                  error_message(error, message_or_error)
+                elsif message_or_error.is_a?(Exception)
+                  error_message(message_or_error)
+                else
+                  message_or_error
+                end
 
       super(message, &block)
     end

data/lib/twiglet/version.rb

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

data/test/logger_test.rb

@@ -335,8 +335,8 @@ describe Twiglet::Logger do
       actual_log = read_json(@buffer)
 
       assert_equal 'Artificially raised exception', actual_log[:message]
-      assert_equal 'divided by 0', actual_log[:error][:message]
       assert_equal 'ZeroDivisionError', actual_log[:error][:type]
+      assert_equal 'divided by 0', actual_log[:error][:message]
       assert_match 'test/logger_test.rb', actual_log[:error][:stack_trace].first
     end
 
@@ -353,35 +353,54 @@ describe Twiglet::Logger do
     end
 
     it 'should log an error with string message' do
-      e = StandardError.new('Unknown error')
+      e = StandardError.new('Some error')
       @logger.error('Artificially raised exception with string message', e)
 
       actual_log = read_json(@buffer)
 
       assert_equal 'Artificially raised exception with string message', actual_log[:message]
       assert_equal 'StandardError', actual_log[:error][:type]
-      assert_equal 'Unknown error', actual_log[:error][:message]
+      assert_equal 'Some error', actual_log[:error][:message]
     end
 
-    it 'should log error type properly even when active_support/json is required' do
-      require 'active_support/json'
-      e = StandardError.new('Unknown error')
-      @logger.error('Artificially raised exception with string message', e)
+    it 'should log an error if no message is given' do
+      e = StandardError.new('Some error')
+      @logger.error(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
 
-    it 'can log just an error as "error", if no message is given' do
-      e = StandardError.new('some error')
+    it 'should log an error if nil 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 'Some error', actual_log[:message]
+      assert_equal 'StandardError', actual_log[:error][:type]
+      assert_equal 'Some error', actual_log[:error][:message]
+    end
+
+    it 'should log a string if no error is given' do
+      @logger.error('Some error')
+
+      actual_log = read_json(@buffer)
+
+      assert_equal 'Some error', actual_log[:message]
+    end
+
+    it 'should log error type properly even when active_support/json is required' do
+      require 'active_support/json'
+      e = StandardError.new('Unknown error')
+      @logger.error('Artificially raised exception with string message', e)
+
+      actual_log = read_json(@buffer)
+
       assert_equal 'StandardError', actual_log[:error][:type]
-      assert_equal 'some error', actual_log[:error][:message]
     end
 
     [:debug, :info, :warn].each do |level|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 3.9.0
+  version: 3.9.2
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-18 00:00:00.000000000 Z
+date: 2023-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema