twiglet 2.3.10 → 2.3.11
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/twiglet/formatter.rb +2 -27
- data/lib/twiglet/logger.rb +2 -1
- data/lib/twiglet/message.rb +24 -0
- data/lib/twiglet/version.rb +1 -1
- data/test/message_test.rb +31 -0
- metadata +4 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: aa67e232d4c30f51fa72893c00e3c348f82e70b5cfe4b65c3ed695ef96a10bd9
|
4
|
+
data.tar.gz: d67da5f68a44f3d4f382f2be0d507325a1698081664b2977f44139faa117581b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2100bc269dcd76fe9edefa2723f172e376ebb6340fb0f1b489cd8fc6b9629967385eb2bc081934ba42ac7d552fd63ce3232c58021df6fd74e2c331a0d4c04cbb
|
7
|
+
data.tar.gz: fc7f824c61cf1156551018a1adfe7ebae5313844725e837393d19082ff7d89487a54e8f5adcc8900c9bf3f67d398344b353b010d87c4c04f638d3be9bf7af07f
|
data/lib/twiglet/formatter.rb
CHANGED
@@ -1,5 +1,6 @@
|
|
1
1
|
require 'logger'
|
2
2
|
require_relative '../hash_extensions'
|
3
|
+
require_relative 'message'
|
3
4
|
|
4
5
|
module Twiglet
|
5
6
|
class Formatter < ::Logger::Formatter
|
@@ -17,38 +18,12 @@ module Twiglet
|
|
17
18
|
|
18
19
|
def call(severity, _time, _progname, msg)
|
19
20
|
level = severity.downcase
|
20
|
-
log(level: level, message: msg)
|
21
|
+
log(level: level, message: Message.new(msg))
|
21
22
|
end
|
22
23
|
|
23
24
|
private
|
24
25
|
|
25
26
|
def log(level:, message:)
|
26
|
-
case message
|
27
|
-
when String
|
28
|
-
log_text(level, message: message)
|
29
|
-
when Hash
|
30
|
-
log_object(level, message: message)
|
31
|
-
else
|
32
|
-
raise('Message must be String or Hash')
|
33
|
-
end
|
34
|
-
end
|
35
|
-
|
36
|
-
def log_text(level, message:)
|
37
|
-
raise('The \'message\' property of log object must not be empty') if message.strip.empty?
|
38
|
-
|
39
|
-
message = { message: message }
|
40
|
-
log_message(level, message: message)
|
41
|
-
end
|
42
|
-
|
43
|
-
def log_object(level, message:)
|
44
|
-
message = message.transform_keys(&:to_sym)
|
45
|
-
message.key?(:message) || raise('Log object must have a \'message\' property')
|
46
|
-
message[:message].strip.empty? && raise('The \'message\' property of log object must not be empty')
|
47
|
-
|
48
|
-
log_message(level, message: message)
|
49
|
-
end
|
50
|
-
|
51
|
-
def log_message(level, message:)
|
52
27
|
base_message = {
|
53
28
|
ecs: {
|
54
29
|
version: '1.5.0'
|
data/lib/twiglet/logger.rb
CHANGED
@@ -5,6 +5,7 @@ require 'time'
|
|
5
5
|
require 'json'
|
6
6
|
require_relative 'formatter'
|
7
7
|
require_relative '../hash_extensions'
|
8
|
+
require_relative 'message'
|
8
9
|
|
9
10
|
module Twiglet
|
10
11
|
class Logger < ::Logger
|
@@ -37,7 +38,7 @@ module Twiglet
|
|
37
38
|
}
|
38
39
|
}
|
39
40
|
add_stack_trace(error_fields, error)
|
40
|
-
message =
|
41
|
+
message = Message.new(message).merge(error_fields)
|
41
42
|
end
|
42
43
|
|
43
44
|
super(message, &block)
|
@@ -0,0 +1,24 @@
|
|
1
|
+
module Twiglet
|
2
|
+
class Message < Hash
|
3
|
+
def initialize(msg)
|
4
|
+
case msg
|
5
|
+
when String
|
6
|
+
self[:message] = msg
|
7
|
+
when Hash
|
8
|
+
replace(msg.transform_keys!(&:to_sym))
|
9
|
+
end
|
10
|
+
|
11
|
+
validate!
|
12
|
+
end
|
13
|
+
|
14
|
+
private
|
15
|
+
|
16
|
+
def validate!
|
17
|
+
raise 'Message must be initialized with a String or a non-empty Hash' if empty?
|
18
|
+
|
19
|
+
raise 'Log object must have a \'message\' property' unless self[:message]
|
20
|
+
|
21
|
+
raise 'The \'message\' property of the log object must not be empty' if self[:message].strip.empty?
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
data/lib/twiglet/version.rb
CHANGED
@@ -0,0 +1,31 @@
|
|
1
|
+
require 'minitest/autorun'
|
2
|
+
require_relative '../lib/twiglet/message'
|
3
|
+
|
4
|
+
describe Twiglet::Message do
|
5
|
+
it 'raises if message is empty' do
|
6
|
+
assert_raises RuntimeError do
|
7
|
+
Twiglet::Message.new(' ')
|
8
|
+
end
|
9
|
+
end
|
10
|
+
|
11
|
+
it 'raises if message is not provided' do
|
12
|
+
assert_raises RuntimeError do
|
13
|
+
Twiglet::Message.new(foo: 'bar')
|
14
|
+
end
|
15
|
+
end
|
16
|
+
|
17
|
+
it 'raises on unrecognized inputs' do
|
18
|
+
assert_raises RuntimeError do
|
19
|
+
Twiglet::Message.new(OpenStruct.new(message: 'hello'))
|
20
|
+
end
|
21
|
+
end
|
22
|
+
|
23
|
+
it 'returns a message hash from a string' do
|
24
|
+
assert_equal Twiglet::Message.new('hello, world'), { message: 'hello, world' }
|
25
|
+
end
|
26
|
+
|
27
|
+
it 'returns a message hash with symbolized keys' do
|
28
|
+
input_message = { 'key' => 'value', 'message' => 'hello, world' }
|
29
|
+
assert_equal Twiglet::Message.new(input_message), { key: 'value', message: 'hello, world' }
|
30
|
+
end
|
31
|
+
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: twiglet
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 2.3.
|
4
|
+
version: 2.3.11
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Simply Business
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-08-
|
11
|
+
date: 2020-08-27 00:00:00.000000000 Z
|
12
12
|
dependencies: []
|
13
13
|
description: Like a log, only smaller.
|
14
14
|
email:
|
@@ -39,10 +39,12 @@ files:
|
|
39
39
|
- lib/hash_extensions.rb
|
40
40
|
- lib/twiglet/formatter.rb
|
41
41
|
- lib/twiglet/logger.rb
|
42
|
+
- lib/twiglet/message.rb
|
42
43
|
- lib/twiglet/version.rb
|
43
44
|
- test/formatter_test.rb
|
44
45
|
- test/hash_extensions_test.rb
|
45
46
|
- test/logger_test.rb
|
47
|
+
- test/message_test.rb
|
46
48
|
- test/test_coverage.rb
|
47
49
|
- twiglet.gemspec
|
48
50
|
homepage: https://github.com/simplybusiness/twiglet-ruby
|