twiglet 2.0.0.pre.alpha.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2bb718963cc1602d548f4f80bbf03a932feac4ceaa5b11bc3b6d19a1ee58e10
-  data.tar.gz: 6ee69671edd4a487a905c45dec2833141fc6a4a7b8702bdffdc2dc0b81e6e9e4
+  metadata.gz: 8f7e6901994e7715bab639be94853dbbcce697e16da26f2f8340404ebe4c0211
+  data.tar.gz: 1758572f62c689a68642cfb8887dc2ea380a3602332cf2321b06d51e80a7066d
 SHA512:
-  metadata.gz: 3ccecc55b8320608406a0dfec87f617e12501dbdebbe62de7b74881afde44439ba789c59b80c1530c9e4325dc424a202c1ea71958adf32ce1bda020103b38a48
-  data.tar.gz: 2762f0a75ac22ae69ef30de4afa022dc91e1504e578ce0fcf3198291e0f4963adbda2ab57e7e5b8a852ff2bfe6f058f3478d23c622a09a0eef98cc2821881c4b
+  metadata.gz: 808fb4ddbdaff2287331e022ec4a593469335a40476fa59cb0546facd126113c6b564f7538c3366984bb40ed178a131861b0a97e9ea571640caa68db0354a906
+  data.tar.gz: 83913e66900495ee39ba12d8f38e16e83fbc3621c4caf7bdaa128c6b44568f82face4498f1b2081e798ff6265b79a7758dd97eff08bd6224e8b0b7d077e8cb81

data/.github/CODEOWNERS

@@ -1,4 +1,3 @@
 # Add your project owners info here
 # More information: https://help.github.com/articles/about-codeowners/
 * @simplybusiness/application-tooling
-*

data/README.md

@@ -40,6 +40,13 @@ This will write to STDOUT a JSON string:
 
 Obviously the timestamp will be different.
 
+Errors can be logged as well, and this will log the error message and backtrace in the relevant ECS compliant fields:
+
+```ruby
+db_err = StandardError.new('Connection timed-out')
+logger.error({ message: 'DB connection failed.' }, db_err)
+```
+
 Add log event specific information simply as attributes in a hash:
 
 ```ruby
@@ -126,7 +133,7 @@ First: Please read our project [Code of Conduct](../CODE_OF_CONDUCT.md).
 Second: run the tests and make sure your changes don't break anything:
 
 ```bash
-for file in test/*test.rb; do ruby $file; done
+bundle exec rake test
 ```
 
 Then please feel free to submit a PR.

data/lib/twiglet/logger.rb

@@ -36,11 +36,15 @@ module Twiglet
       log(level: 'warning', message: message)
     end
 
+    alias_method :warn, :warning
+
     def error(message, error = nil)
       if error
         message = message.merge({
-                                  error_name: error.message,
-                                  backtrace: error.backtrace
+                                  'error': {
+                                    'message': error.message,
+                                    'stack_trace': error.backtrace.join("\n")
+                                  }
                                 })
       end
 

data/lib/twiglet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Twiglet
-  VERSION = '2.0.0-alpha.1'
+  VERSION = '2.0.0'
 end

data/test/logger_test.rb

@@ -178,8 +178,26 @@ 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_name]
-    assert_match 'logger_test.rb', actual_log[:backtrace].first
+    assert_equal 'divided by 0', actual_log[:error][:message]
+    assert_match 'logger_test.rb', actual_log[:error][:stack_trace].lines.first
+  end
+
+  levels = [
+    { method: :debug, level: 'debug' },
+    { method: :info, level: 'info' },
+    { method: :warning, level: 'warning' },
+    { method: :warn, level: 'warning' },
+    { method: :error, level: 'error' }
+  ]
+
+  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
 
   private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.alpha.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-03 00:00:00.000000000 Z
+date: 2020-06-05 00:00:00.000000000 Z
 dependencies: []
 description: Like a log, only smaller.
 email:
@@ -51,9 +51,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.2
 signing_key: