twiglet 2.3.10 → 2.3.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 113edbe5053c76bc7490f90c4e3d85e68077547d26d9dc4e6e98ea474cc5beea
-  data.tar.gz: 94b8925876c5cc095db0f5a8380701ebd9e85d22dbca3bf2aa91cd46012920db
+  metadata.gz: aa67e232d4c30f51fa72893c00e3c348f82e70b5cfe4b65c3ed695ef96a10bd9
+  data.tar.gz: d67da5f68a44f3d4f382f2be0d507325a1698081664b2977f44139faa117581b
 SHA512:
-  metadata.gz: 38f61f947ee52bfd29a0990d9dd2624ae68f628e66ecb2e67569499e3d7a81459f66d0316c9edd4ec45b2d514707474a91c0d6bd2c7661646d21ad0322a40f33
-  data.tar.gz: 20afdfefcd5b37363eca9797472bf1fb9f0947af68b53e994786671a69c2d26acce667351794c2e5540de786115c95cec34b8d8a52d16a206128a88382d71ff2
+  metadata.gz: 2100bc269dcd76fe9edefa2723f172e376ebb6340fb0f1b489cd8fc6b9629967385eb2bc081934ba42ac7d552fd63ce3232c58021df6fd74e2c331a0d4c04cbb
+  data.tar.gz: fc7f824c61cf1156551018a1adfe7ebae5313844725e837393d19082ff7d89487a54e8f5adcc8900c9bf3f67d398344b353b010d87c4c04f638d3be9bf7af07f

data/lib/twiglet/formatter.rb

@@ -1,5 +1,6 @@
 require 'logger'
 require_relative '../hash_extensions'
+require_relative 'message'
 
 module Twiglet
   class Formatter < ::Logger::Formatter
@@ -17,38 +18,12 @@ module Twiglet
 
     def call(severity, _time, _progname, msg)
       level = severity.downcase
-      log(level: level, message: msg)
+      log(level: level, message: Message.new(msg))
     end
 
     private
 
     def log(level:, message:)
-      case message
-      when String
-        log_text(level, message: message)
-      when Hash
-        log_object(level, message: message)
-      else
-        raise('Message must be String or Hash')
-      end
-    end
-
-    def log_text(level, message:)
-      raise('The \'message\' property of log object must not be empty') if message.strip.empty?
-
-      message = { message: message }
-      log_message(level, message: message)
-    end
-
-    def log_object(level, message:)
-      message = message.transform_keys(&:to_sym)
-      message.key?(:message) || raise('Log object must have a \'message\' property')
-      message[:message].strip.empty? && raise('The \'message\' property of log object must not be empty')
-
-      log_message(level, message: message)
-    end
-
-    def log_message(level, message:)
       base_message = {
         ecs: {
           version: '1.5.0'

data/lib/twiglet/logger.rb

@@ -5,6 +5,7 @@ require 'time'
 require 'json'
 require_relative 'formatter'
 require_relative '../hash_extensions'
+require_relative 'message'
 
 module Twiglet
   class Logger < ::Logger
@@ -37,7 +38,7 @@ module Twiglet
           }
         }
         add_stack_trace(error_fields, error)
-        message = message.is_a?(Hash) ? message.merge(error_fields) : error_fields.merge(message: message)
+        message = Message.new(message).merge(error_fields)
       end
 
       super(message, &block)

data/lib/twiglet/message.rb

@@ -0,0 +1,24 @@
+module Twiglet
+  class Message < Hash
+    def initialize(msg)
+      case msg
+      when String
+        self[:message] = msg
+      when Hash
+        replace(msg.transform_keys!(&:to_sym))
+      end
+
+      validate!
+    end
+
+    private
+
+    def validate!
+      raise 'Message must be initialized with a String or a non-empty Hash' if empty?
+
+      raise 'Log object must have a \'message\' property' unless self[:message]
+
+      raise 'The \'message\' property of the log object must not be empty' if self[:message].strip.empty?
+    end
+  end
+end

data/lib/twiglet/version.rb

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

data/test/message_test.rb

@@ -0,0 +1,31 @@
+require 'minitest/autorun'
+require_relative '../lib/twiglet/message'
+
+describe Twiglet::Message do
+  it 'raises if message is empty' do
+    assert_raises RuntimeError do
+      Twiglet::Message.new('   ')
+    end
+  end
+
+  it 'raises if message is not provided' do
+    assert_raises RuntimeError do
+      Twiglet::Message.new(foo: 'bar')
+    end
+  end
+
+  it 'raises on unrecognized inputs' do
+    assert_raises RuntimeError do
+      Twiglet::Message.new(OpenStruct.new(message: 'hello'))
+    end
+  end
+
+  it 'returns a message hash from a string' do
+    assert_equal Twiglet::Message.new('hello, world'), { message: 'hello, world' }
+  end
+
+  it 'returns a message hash with symbolized keys' do
+    input_message = { 'key' => 'value', 'message' => 'hello, world' }
+    assert_equal Twiglet::Message.new(input_message), { key: 'value', message: 'hello, world' }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 2.3.10
+  version: 2.3.11
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2020-08-27 00:00:00.000000000 Z
 dependencies: []
 description: Like a log, only smaller.
 email:
@@ -39,10 +39,12 @@ files:
 - lib/hash_extensions.rb
 - lib/twiglet/formatter.rb
 - lib/twiglet/logger.rb
+- lib/twiglet/message.rb
 - lib/twiglet/version.rb
 - test/formatter_test.rb
 - test/hash_extensions_test.rb
 - test/logger_test.rb
+- test/message_test.rb
 - test/test_coverage.rb
 - twiglet.gemspec
 homepage: https://github.com/simplybusiness/twiglet-ruby