twiglet 3.7.2 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdfe6db753dcf115b7965ff0cfd9682e23694b43765fd69cdd64986e7fc51d41
-  data.tar.gz: fb110c32f6b4556efd1eb3f4ff673ca7b2e975008973ad296445389d2372a8c8
+  metadata.gz: 24bb01ca290d4e49c2a38e69a0566bcb0e06d38e5c1daa120abb90c2a88c1826
+  data.tar.gz: 00e825a9ae2164604a36b54811bf659321bc5bb1bf96afc198399c890058004a
 SHA512:
-  metadata.gz: 7d0add22464cd885a861d2d7c5e85d7b7e2a444cb4516c26c261ea9992b1e2988a2a7e47d17d4d123d8131b34198af2d084350c2aa7262b44db513fccc33ea11
-  data.tar.gz: d9772fd14f86d73b17c25a0b4f469b1ff9248ecba733d0d09d31be1d6c6c69c01a2e4d8e1152d68b2b8fce57f1acb13745ae45d5069846df38119663ea8262ae
+  metadata.gz: 8992a36124f946eb46fc63fd432d5ae1c5359101572a759eea3a70bb7d1b5d3ccadc9d76a075b42222906f6eb2a4c03de273b967a4e7bb8d977ec9f2a2095954
+  data.tar.gz: bfd2479a25d3d2f5212721941bd2400ad6179080f65a913efa4256c7ca7304e8042efc9ca50f294e19d5157e4d640e2c03e97c45891320ea445ef32792eaaa88

data/.rubocop.yml

@@ -2,11 +2,8 @@ inherit_gem:
   simplycop: .simplycop.yml
 
 AllCops:
-  TargetRubyVersion: 2.6
-  Rails:
-    Enabled: false
-  Documentation:
-    Enabled: false
+  TargetRubyVersion: 3.0
+
 Metrics/BlockLength:
   Max: 250
 Metrics/AbcSize:

data/.ruby-version

@@ -1 +1 @@
-3.1.2
+3.2.2

data/lib/hash_extensions.rb

@@ -10,7 +10,7 @@ module HashExtensions
   end
 
   def deep_merge(hash_to_merge)
-    merger = proc { |_, val1, val2| val1.is_a?(Hash) && val2.is_a?(Hash) ? val1.merge(val2, &merger) : val2 }
+    merger = proc { |_, val_1, val_2| val_1.is_a?(Hash) && val_2.is_a?(Hash) ? val_1.merge(val_2, &merger) : val_2 }
     merge(hash_to_merge, &merger)
   end
 

data/lib/twiglet/error_serialiser.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Twiglet
+  class ErrorSerialiser
+    def serialise_error(error)
+      error_fields = {
+        error: {
+          type: error.class.to_s,
+          message: error.message
+        }
+      }
+      add_stack_trace(error_fields, error)
+    end
+
+    private
+
+    def add_stack_trace(hash_to_add_to, error)
+      hash_to_add_to[:error][:stack_trace] = error.backtrace if error.backtrace
+      hash_to_add_to
+    end
+  end
+end

data/lib/twiglet/formatter.rb

@@ -6,11 +6,13 @@ module Twiglet
   class Formatter < ::Logger::Formatter
     Hash.include HashExtensions
 
-    def initialize(service_name,
-                   validator:,
-                   default_properties: {},
-                   context_provider: nil,
-                   now: -> { Time.now.utc })
+    def initialize(
+      service_name,
+      validator:,
+      default_properties: {},
+      context_provider: nil,
+      now: -> { Time.now.utc }
+    )
       @service_name = service_name
       @now = now
       @default_properties = default_properties
@@ -34,7 +36,7 @@ module Twiglet
         ecs: {
           version: '1.5.0'
         },
-        "@timestamp": @now.call.iso8601(3),
+        '@timestamp': @now.call.iso8601(3),
         service: {
           name: @service_name
         },

data/lib/twiglet/logger.rb

@@ -6,6 +6,7 @@ require_relative 'formatter'
 require_relative '../hash_extensions'
 require_relative 'message'
 require_relative 'validator'
+require_relative 'error_serialiser'
 
 module Twiglet
   class Logger < ::Logger
@@ -87,19 +88,9 @@ 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)
+      error_hash = Twiglet::ErrorSerialiser.new.serialise_error(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
+      Message.new(message).merge(error_hash)
     end
   end
 end

data/lib/twiglet/version.rb

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

data/test/error_serialiser_test.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'minitest/mock'
+require_relative '../lib/twiglet/error_serialiser'
+
+describe Twiglet::ErrorSerialiser do
+  describe 'logging an exception' do
+    it 'should log an error with backtrace' do
+      1 / 0
+    rescue StandardError => e
+      error_hash = Twiglet::ErrorSerialiser.new.serialise_error(e)
+      assert_equal 'divided by 0', error_hash[:error][:message]
+      assert_equal 'ZeroDivisionError', error_hash[:error][:type]
+      assert_match 'test/error_serialiser_test.rb', error_hash[:error][:stack_trace].first
+    end
+  end
+end

data/test/hash_extensions_test.rb

@@ -17,7 +17,7 @@ describe HashExtensions do
       log: {
         level: 'error'
       },
-      "@timestamp": '2020-05-09T15:13:20.736Z'
+      '@timestamp': '2020-05-09T15:13:20.736Z'
     }
 
     expected = actual.to_nested
@@ -26,8 +26,8 @@ describe HashExtensions do
 
   it 'should convert keys with . into nested objects' do
     actual = {
-      "service.name": 'petshop',
-      "log.level": 'error'
+      'service.name': 'petshop',
+      'log.level': 'error'
     }
 
     nested = actual.to_nested
@@ -38,10 +38,10 @@ describe HashExtensions do
 
   it 'should group nested objects' do
     actual = {
-      "service.name": 'petshop',
-      "service.id": 'ps001',
-      "service.version": '0.9.1',
-      "log.level": 'error'
+      'service.name': 'petshop',
+      'service.id': 'ps001',
+      'service.version': '0.9.1',
+      'log.level': 'error'
     }
 
     nested = actual.to_nested
@@ -54,10 +54,10 @@ describe HashExtensions do
 
   it 'should cope with more than two levels' do
     actual = {
-      "http.request.method": 'get',
-      "http.request.body.bytes": 112,
-      "http.response.bytes": 1564,
-      "http.response.status_code": 200
+      'http.request.method': 'get',
+      'http.request.body.bytes': 112,
+      'http.response.bytes': 1564,
+      'http.response.status_code': 200
     }
 
     nested = actual.to_nested

data/test/logger_test.rb

@@ -34,8 +34,19 @@ describe Twiglet::Logger do
 
   it 'conforms to the standard Ruby Logger API' do
     [
-      :debug, :debug?, :info, :info?, :warn, :warn?, :fatal, :fatal?, :error, :error?,
-      :level, :level=, :sev_threshold=
+      :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
@@ -63,7 +74,7 @@ describe Twiglet::Logger do
         ecs: {
           version: '1.5.0'
         },
-        "@timestamp": '2020-05-11T15:01:01.000Z',
+        '@timestamp': '2020-05-11T15:01:01.000Z',
         service: {
           name: 'petshop'
         },
@@ -269,19 +280,19 @@ describe Twiglet::Logger do
       @logger.info({ message: 'there' })
 
       expected_output =
-        '{"ecs":{"version":"1.5.0"},"@timestamp":"2020-05-11T15:01:01.000Z",'\
-        '"service":{"name":"petshop"},"log":{"level":"debug"},"message":"hi"}'\
-        "\n"\
-        '{"ecs":{"version":"1.5.0"},"@timestamp":"2020-05-11T15:01:01.000Z",'\
-        '"service":{"name":"petshop"},"log":{"level":"info"},"message":"there"}'\
-        "\n"\
+        '{"ecs":{"version":"1.5.0"},"@timestamp":"2020-05-11T15:01:01.000Z",' \
+        '"service":{"name":"petshop"},"log":{"level":"debug"},"message":"hi"}' \
+        "\n" \
+        '{"ecs":{"version":"1.5.0"},"@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 work with mixed string and symbol properties' do
       log = {
-        "trace.id": '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb'
+        'trace.id': '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb'
       }
       event = {}
       log['event'] = event
@@ -404,7 +415,7 @@ describe Twiglet::Logger do
         ecs: {
           version: '1.5.0'
         },
-        "@timestamp": '2020-05-11T15:01:01.000Z',
+        '@timestamp': '2020-05-11T15:01:01.000Z',
         service: {
           name: 'petshop'
         },
@@ -460,11 +471,11 @@ describe Twiglet::Logger do
     it 'should be able to convert dotted keys to nested objects' do
       @logger.debug(
         {
-          "trace.id": '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb',
+          'trace.id': '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb',
           message: 'customer bought a dog',
-          "pet.name": 'Barker',
-          "pet.species": 'dog',
-          "pet.breed": 'Bitsa'
+          'pet.name': 'Barker',
+          'pet.species': 'dog',
+          'pet.breed': 'Bitsa'
         }
       )
       log = read_json(@buffer)
@@ -479,10 +490,10 @@ describe Twiglet::Logger do
     it 'should be able to mix dotted keys and nested objects' do
       @logger.debug(
         {
-          "trace.id": '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb',
+          'trace.id': '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb',
           message: 'customer bought a dog',
           pet: { name: 'Barker', breed: 'Bitsa' },
-          "pet.species": 'dog'
+          'pet.species': 'dog'
         }
       )
       log = read_json(@buffer)

data/twiglet.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.files                 = `git ls-files`.split("\n")
 
   gem.require_paths         = ['lib']
-  gem.required_ruby_version = '>= 2.6'
+  gem.required_ruby_version = '>= 3.0'
 
   gem.license               = 'Copyright SimplyBusiness'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 3.7.2
+  version: 3.9.0
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-11 00:00:00.000000000 Z
+date: 2023-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -113,6 +113,7 @@ files:
 - examples/rack/request_logger.rb
 - examples/rack/request_logger_test.rb
 - lib/hash_extensions.rb
+- lib/twiglet/error_serialiser.rb
 - lib/twiglet/formatter.rb
 - lib/twiglet/logger.rb
 - lib/twiglet/message.rb
@@ -120,6 +121,7 @@ files:
 - lib/twiglet/validator.rb
 - lib/twiglet/version.rb
 - mkdocs.yml
+- test/error_serialiser_test.rb
 - test/formatter_test.rb
 - test/hash_extensions_test.rb
 - test/logger_test.rb
@@ -139,14 +141,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Twiglet