twiglet 2.3.11 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa67e232d4c30f51fa72893c00e3c348f82e70b5cfe4b65c3ed695ef96a10bd9
-  data.tar.gz: d67da5f68a44f3d4f382f2be0d507325a1698081664b2977f44139faa117581b
+  metadata.gz: a9eac4966bd34b02389637e38100f843f842fc115bad74d9480dc5b87a1dcad2
+  data.tar.gz: 3fb45d8d76a99246f4a215e42fa15dfa52b3f8f7cd8821edf8590653a114514c
 SHA512:
-  metadata.gz: 2100bc269dcd76fe9edefa2723f172e376ebb6340fb0f1b489cd8fc6b9629967385eb2bc081934ba42ac7d552fd63ce3232c58021df6fd74e2c331a0d4c04cbb
-  data.tar.gz: fc7f824c61cf1156551018a1adfe7ebae5313844725e837393d19082ff7d89487a54e8f5adcc8900c9bf3f67d398344b353b010d87c4c04f638d3be9bf7af07f
+  metadata.gz: 276587b79e63ad48de407c26ad113e64c6fb2819c991622f3f6ea50abe583853991a7f32ceafa4fc2008dff2a4ff4216766c53d0910ff8538ad26430474573f5
+  data.tar.gz: a963f5d218c7c8c327400245b122f83873201191c01828efa125418ea6e0b08d21c86a53ab791aedc9fb900a8642cb0e1130a835516388e922da6b00ccf83880

data/Makefile

@@ -1,9 +1,21 @@
-.PHONY: all build test
+.PHONY: all build clean shell test
 
-all: build test
+all: clean build test
 
 build:
 	docker build -t simplybusiness/ruby-dev:2.6.5 .
 
+clean:
+	rm -f *~
+
+shell:
+	docker run -it \
+	-v `pwd`:/var/app \
+	simplybusiness/ruby-dev:2.6.5 \
+	bash
+
 test:
-	docker run -it -v `pwd`:/var/app simplybusiness/ruby-dev:2.6.5 bundle exec rake test
+	docker run -it \
+	-v `pwd`:/var/app \
+	simplybusiness/ruby-dev:2.6.5 \
+	bundle exec rake test

data/lib/twiglet/logger.rb

@@ -34,6 +34,7 @@ module Twiglet
       if error
         error_fields = {
           'error': {
+            'type': error.class,
             'message': error.message
           }
         }

data/lib/twiglet/version.rb

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

data/test/logger_test.rb

@@ -149,39 +149,6 @@ describe Twiglet::Logger do
       assert_equal expected_output, @buffer.string
     end
 
-    it 'should be able to convert dotted keys to nested objects' do
-      @logger.debug({
-                      "trace.id": '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb',
-                      message: 'customer bought a dog',
-                      "pet.name": 'Barker',
-                      "pet.species": 'dog',
-                      "pet.breed": 'Bitsa'
-                    })
-      log = read_json(@buffer)
-
-      assert_equal '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb', log[:trace][:id]
-      assert_equal 'customer bought a dog', log[:message]
-      assert_equal 'Barker', log[:pet][:name]
-      assert_equal 'dog', log[:pet][:species]
-      assert_equal 'Bitsa', log[:pet][:breed]
-    end
-
-    it 'should be able to mix dotted keys and nested objects' do
-      @logger.debug({
-                      "trace.id": '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb',
-                      message: 'customer bought a dog',
-                      pet: {name: 'Barker', breed: 'Bitsa'},
-                      "pet.species": 'dog'
-                    })
-      log = read_json(@buffer)
-
-      assert_equal '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb', log[:trace][:id]
-      assert_equal 'customer bought a dog', log[:message]
-      assert_equal 'Barker', log[:pet][:name]
-      assert_equal 'dog', log[:pet][:species]
-      assert_equal 'Bitsa', log[:pet][:breed]
-    end
-
     it 'should work with mixed string and symbol properties' do
       log = {
         "trace.id": '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb'
@@ -205,6 +172,18 @@ describe Twiglet::Logger do
       assert_equal 'Bitsa', actual_log[:pet][:breed]
     end
 
+    LEVELS.each do |attrs|
+      it "should correctly log level when calling #{attrs[:method]}" do
+        @logger.public_send(attrs[:method], {message: 'a log message'})
+        actual_log = read_json(@buffer)
+
+        assert_equal attrs[:level], actual_log[:log][:level]
+        assert_equal 'a log message', actual_log[:message]
+      end
+    end
+  end
+
+  describe 'logging an exception' do
     it 'should log an error with backtrace' do
       begin
         1 / 0
@@ -216,6 +195,7 @@ describe Twiglet::Logger do
 
       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_match 'logger_test.rb', actual_log[:error][:stack_trace].lines.first
     end
 
@@ -226,6 +206,7 @@ describe Twiglet::Logger do
       actual_log = read_json(@buffer)
 
       assert_equal 'Artificially raised exception', actual_log[:message]
+      assert_equal 'StandardError', actual_log[:error][:type]
       assert_equal 'Connection timed-out', actual_log[:error][:message]
       refute actual_log[:error].key?(:stack_trace)
     end
@@ -237,18 +218,9 @@ describe Twiglet::Logger do
       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]
     end
-
-    LEVELS.each do |attrs|
-      it "should correctly log level when calling #{attrs[:method]}" do
-        @logger.public_send(attrs[:method], {message: 'a log message'})
-        actual_log = read_json(@buffer)
-
-        assert_equal attrs[:level], actual_log[:log][:level]
-        assert_equal 'a log message', actual_log[:message]
-      end
-    end
   end
 
   describe 'text logging' do
@@ -310,6 +282,41 @@ describe Twiglet::Logger do
     end
   end
 
+  describe 'dotted keys' do
+    it 'should be able to convert dotted keys to nested objects' do
+      @logger.debug({
+                      "trace.id": '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb',
+                      message: 'customer bought a dog',
+                      "pet.name": 'Barker',
+                      "pet.species": 'dog',
+                      "pet.breed": 'Bitsa'
+                    })
+      log = read_json(@buffer)
+
+      assert_equal '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb', log[:trace][:id]
+      assert_equal 'customer bought a dog', log[:message]
+      assert_equal 'Barker', log[:pet][:name]
+      assert_equal 'dog', log[:pet][:species]
+      assert_equal 'Bitsa', log[:pet][:breed]
+    end
+
+    it 'should be able to mix dotted keys and nested objects' do
+      @logger.debug({
+                      "trace.id": '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb',
+                      message: 'customer bought a dog',
+                      pet: {name: 'Barker', breed: 'Bitsa'},
+                      "pet.species": 'dog'
+                    })
+      log = read_json(@buffer)
+
+      assert_equal '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb', log[:trace][:id]
+      assert_equal 'customer bought a dog', log[:message]
+      assert_equal 'Barker', log[:pet][:name]
+      assert_equal 'dog', log[:pet][:species]
+      assert_equal 'Bitsa', log[:pet][:breed]
+    end
+  end
+
   describe 'logger level' do
     [
       { expression: :info, level: 1 },

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 2.3.11
+  version: 2.4.0
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-27 00:00:00.000000000 Z
+date: 2020-09-04 00:00:00.000000000 Z
 dependencies: []
 description: Like a log, only smaller.
 email: