semantic_logger 2.20.0 → 2.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 141016c8a502a158974b0dfe589a90b5cd650826
-  data.tar.gz: 09cb7afdf37afe6280098b01f7257c8a21b5995e
+  metadata.gz: 7835135546f3ebf18ce484c594cd52fef0d4ecee
+  data.tar.gz: 12cd7ddcbf431f070a0b57792ad436f100aca649
 SHA512:
-  metadata.gz: 3f734075af2a306b37560903beb0d0003f912706f6d68446914832cbb76a404c7017dd536c587eb155309a1128ebf328719f33c727b0ca129d03d2bea8f6fa21
-  data.tar.gz: a96ffd5c36c47e4e7787dc53970dafe092203f6e717f6aba4289217b45e14b1e36317151dcbe2af60178e78d3266ed92f23bd3f7ba6c39d1592d5fbd37794458
+  metadata.gz: cfb139be7ea5cb63d9787638e4e2e2bc464c8bd0bf49f60a9447b4b2b28033e66de8766c8c5b648e544d8bd3068813765d13cee9275130f2823416881e20bfde
+  data.tar.gz: 92e4e1fc6e445696c04596f4f12839d6504d32a62df005baa83e82adb2b4ed4343b9a808193104bfd615ac159ceab7631e5cb36e70457c265efb6de1cb475e18

data/lib/semantic_logger/appender/base.rb

@@ -1,3 +1,9 @@
+# Load AwesomePrint if available
+begin
+  require 'awesome_print'
+rescue LoadError
+end
+
 # Base appender
 #
 #   Abstract base class for appenders

data/lib/semantic_logger/base.rb

@@ -108,6 +108,15 @@ module SemanticLogger
       end
     end
 
+    # If the tag being supplied is definitely a string then this fast
+    # tag api can be used for short lived tags
+    def fast_tag(tag)
+      (Thread.current[:semantic_logger_tags] ||= []) << tag
+      yield
+    ensure
+      Thread.current[:semantic_logger_tags].pop
+    end
+
     # Add the supplied tags to the list of tags to log for this thread whilst
     # the supplied block is active
     # Returns nil if no tags are currently set
@@ -290,7 +299,7 @@ module SemanticLogger
     end
 
     # Log message at the specified level
-    def log_internal(level, index, message=nil, payload=nil, exception=nil, &block)
+    def log_internal(level, index, message=nil, payload=nil, exception=nil)
       # Detect exception being logged
       if exception.nil? && payload.nil? && message.kind_of?(Exception)
         exception = message
@@ -303,7 +312,7 @@ module SemanticLogger
       end
 
       # Add result of block as message or payload if not nil
-      if block && (result = block.call)
+      if block_given? && (result = yield)
         if result.is_a?(String)
           message = message.nil? ? result : "#{message} -- #{result}"
         elsif payload && payload.respond_to?(:merge)
@@ -320,7 +329,7 @@ module SemanticLogger
 
       # Add caller stack trace
       backtrace =
-        if !exception && (index >= SemanticLogger.backtrace_level_index)
+        if index >= SemanticLogger.backtrace_level_index
           trace = caller
           # Remove call to this internal method
           trace.shift(1)
@@ -332,18 +341,18 @@ module SemanticLogger
     end
 
     # Measure the supplied block and log the message
-    def benchmark_internal(level, index, message, params, &block)
+    def benchmark_internal(level, index, message, params)
       start     = Time.now
       exception = nil
       begin
-        if block
+        if block_given?
           result    =
             if silence_level = params[:silence]
               # In case someone accidentally sets `silence: true` instead of `silence: :error`
               silence_level = :error if silence_level == true
-              silence(silence_level) { block.call(params) }
+              silence(silence_level) { yield(params) }
             else
-              block.call(params)
+              yield(params)
             end
           exception = params[:exception]
           result

data/lib/semantic_logger/log.rb

@@ -43,14 +43,14 @@ module SemanticLogger
 
     MAX_EXCEPTIONS_TO_UNWRAP = 5
     # Call the block for exception and any nested exception
-    def each_exception(&block)
+    def each_exception
       # With thanks to https://github.com/bugsnag/bugsnag-ruby/blob/6348306e44323eee347896843d16c690cd7c4362/lib/bugsnag/notification.rb#L81
       depth      = 0
       exceptions = []
       ex         = exception
       while ex != nil && !exceptions.include?(ex) && exceptions.length < MAX_EXCEPTIONS_TO_UNWRAP
         exceptions << ex
-        block.call(ex, depth)
+        yield(ex, depth)
 
         depth += 1
         ex    =

data/lib/semantic_logger/version.rb

@@ -1,3 +1,3 @@
 module SemanticLogger #:nodoc
-  VERSION = '2.20.0'
+  VERSION = '2.21.0'
 end

data/test/logger_test.rb

@@ -64,7 +64,7 @@ class LoggerTest < Minitest::Test
               end
             end
 
-            it "logs #{level} info with backtrace" do
+            it 'logs with backtrace' do
               SemanticLogger.stub(:backtrace_level_index, 0) do
                 @logger.send(level, 'hello world', @hash) { 'Calculations' }
                 SemanticLogger.flush
@@ -72,10 +72,34 @@ class LoggerTest < Minitest::Test
               end
             end
 
+            it 'logs with backtrace and exception' do
+              SemanticLogger.stub(:backtrace_level_index, 0) do
+                exc = RuntimeError.new("Test")
+                @logger.send(level, 'hello world', exc)
+                SemanticLogger.flush
+                assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ #{level_char} \[\d+:#{@thread_name}#{@file_name_reg_exp}\] LoggerTest -- hello world -- Exception: RuntimeError: Test/, @mock_logger.message
+              end
+            end
+
+            it 'logs payload' do
+              hash     = {tracking_number: '123456', even: 2, more: 'data'}
+              hash_str = hash.inspect.sub('{', '\{').sub('}', '\}')
+              @logger.send(level, 'Hello world', hash)
+              SemanticLogger.flush
+              assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ #{level_char} \[\d+:#{@thread_name}\] LoggerTest -- Hello world -- #{hash_str}/, @mock_logger.message
+            end
+
+            it 'does not log an empty payload' do
+              hash = {}
+              @logger.send(level, 'Hello world', hash)
+              SemanticLogger.flush
+              assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ #{level_char} \[\d+:#{@thread_name}\] LoggerTest -- Hello world/, @mock_logger.message
+            end
+
           end
         end
 
-        describe 'tagged logging' do
+        describe '#tagged' do
           it 'add tags to log entries' do
             @logger.tagged('12345', 'DJHSFK') do
               @logger.info('Hello world')
@@ -96,7 +120,9 @@ class LoggerTest < Minitest::Test
               assert_equal 'tags', @logger.tags.last
             end
           end
+        end
 
+        describe '#with_payload' do
           it 'logs tagged payload' do
             hash     = {tracking_number: "123456", even: 2, more: "data"}
             hash_str = hash.inspect.sub("{", "\\{").sub("}", "\\}")
@@ -108,24 +134,19 @@ class LoggerTest < Minitest::Test
               end
             end
           end
+        end
 
-          it 'logs payload' do
-            hash     = {tracking_number: "123456", even: 2, more: "data"}
-            hash_str = hash.inspect.sub("{", "\\{").sub("}", "\\}")
-            @logger.info('Hello world', hash)
-            SemanticLogger.flush
-            assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ I \[\d+:#{@thread_name}\] LoggerTest -- Hello world -- #{hash_str}/, @mock_logger.message
-          end
-
-          it 'does not log an empty payload' do
-            hash     = {}
-            @logger.info('Hello world', hash)
-            SemanticLogger.flush
-            assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ I \[\d+:#{@thread_name}\] LoggerTest -- Hello world/, @mock_logger.message
+        describe '#fast_tag' do
+          it 'add string tag to log entries' do
+            @logger.fast_tag('12345') do
+              @logger.info('Hello world')
+              SemanticLogger.flush
+              assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ I \[\d+:#{@thread_name}\] \[12345\] LoggerTest -- Hello world/, @mock_logger.message
+            end
           end
         end
 
-        describe 'Ruby Logger' do
+        describe 'Ruby Logger level' do
           # Ensure that any log level can be logged
           Logger::Severity.constants.each do |level|
             it "log Ruby logger #{level} info" do

data/test/mock_logger.rb

@@ -5,11 +5,11 @@ class MockLogger
 
   Logger::Severity.constants.each do |level|
     class_eval <<-EOT, __FILE__, __LINE__
-        def #{level.downcase}(message = nil, progname = nil, &block)
+        def #{level.downcase}(message = nil, progname = nil)
           if message
             self.message = message
-          elsif block
-            self.message = block.call
+          elsif block_given?
+            self.message = yield
           else
             self.message = progname
           end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: semantic_logger
 version: !ruby/object:Gem::Version
-  version: 2.20.0
+  version: 2.21.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2015-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -86,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Scalable, next generation enterprise logging for Ruby