twiglet 3.9.1 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7e40c55a5e7824f229b8736b8c09168b7edd95d2c17fc7d88117892ed5839b4
-  data.tar.gz: 84524cfcbead9663eb2fc66668a5b5c54784e04e4a4f7c842f29dcaf12b8e033
+  metadata.gz: 6362109470f346c6703ed9e13e82904195f201cac31e1edf1dad8714c4312d79
+  data.tar.gz: a06b359e837cf995f78efdab94c53e5017ccc4ca6d06373a05148f0e4b93621c
 SHA512:
-  metadata.gz: 4fa6bb1c729728b551c8af2d1f1ca36b8a4d2eb75b517d6feff0c24f7135edbb45cccce3b3472f01e22c053100417ddbff0257f7d2818d47c556254994ca18e9
-  data.tar.gz: 47190de2fd3cc21aa36db244783fe8e7b335c7c1f0cc10f288eb71d4dc10372b68304c63817e1e83922290dd513f4b609564d29b46e5bdb850e8c2a85334ea9f
+  metadata.gz: cd56a05ee8a42910901a85de11940ea16b1e6a4578fd2501aeb4e794674561dd9594bb10fedc0b07c207df5823c44361cf1a72d753b241fe4e564e786464f459
+  data.tar.gz: 7fa75694d0ff55caa28df71703fd4e8c14e00185149c456b26c8030315519e0caafcc77e0e10efe1d04aae1093dd53c9f1b4462b97f04d8352c996241a271662

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/hash_extensions.rb

@@ -2,7 +2,7 @@
 
 module HashExtensions
   def to_nested
-    self unless contains_dotted_key?
+    return self unless contains_dotted_key?
 
     keys.reduce({}) do |nested, key|
       nested.deep_merge(build_nested_object(key, self[key]))

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
@@ -76,9 +82,15 @@ module Twiglet
     end
 
     def context_provider(&blk)
+      new_context_provider = blk
+      if @args[:context_provider]
+        new_context_provider = lambda do
+          @args[:context_provider].call.merge(blk.call)
+        end
+      end
       self.class.new(
         @service_name,
-        **@args.merge(context_provider: blk)
+        **@args.merge(context_provider: new_context_provider)
       )
     end
 

data/lib/twiglet/message.rb

@@ -8,7 +8,7 @@ module Twiglet
       when Hash
         replace(msg.transform_keys!(&:to_sym))
       else
-        super(msg)
+        super
       end
     end
   end

data/lib/twiglet/version.rb

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

data/test/logger_test.rb

@@ -3,6 +3,7 @@
 require 'minitest/autorun'
 require 'minitest/mock'
 require_relative '../lib/twiglet/logger'
+require 'active_support'
 
 LEVELS = [
   { method: :debug, level: 'debug' },
@@ -266,6 +267,27 @@ describe Twiglet::Logger do
       assert_equal 'my-context-id', log[:context][:id]
     end
 
+    it "previously supplied context providers should be preserved" do
+      # Let's add some context to this customer journey
+      purchase_logger = @logger
+                        .context_provider { { 'first-context' => { 'first-id' => 'my-first-context-id' } } }
+                        .context_provider { { 'second-context' => { 'second-id' => 'my-second-context-id' } } }
+      # do stuff
+      purchase_logger.info(
+        {
+          message: 'customer bought a dog',
+          pet: { name: 'Barker', species: 'dog', breed: 'Bitsa' }
+        }
+      )
+
+      log = read_json @buffer
+
+      assert_equal 'customer bought a dog', log[:message]
+      assert_equal 'Barker', log[:pet][:name]
+      assert_equal 'my-first-context-id', log[:'first-context'][:'first-id']
+      assert_equal 'my-second-context-id', log[:'second-context'][:'second-id']
+    end
+
     it "should log 'message' string property" do
       message = {}
       message['message'] = 'Guinea pigs arrived'
@@ -335,8 +357,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 +375,53 @@ 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 is required' do
+      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|

data/twiglet.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |gem|
 
   gem.license               = 'Copyright SimplyBusiness'
 
-  gem.add_runtime_dependency     'json-schema'
+  gem.add_dependency 'json-schema'
   gem.add_development_dependency 'minitest'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'simplecov', '0.17.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 3.9.1
+  version: 3.10.0
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-26 00:00:00.000000000 Z
+date: 2024-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema