hatchet 0.0.18 → 0.0.19

data/RELEASE.md

@@ -1,5 +1,11 @@
 # Release notes
 
+## 0.0.19
+
+ * Changed core formatters to output an indented backtrace after a message when
+   an error is present, can be disabled via the formatter's `backtrace=`
+   attribute
+
 ## 0.0.18
 
  * Made the presence of a `formatter=` method on appenders optional

data/lib/hatchet/plain_formatter.rb

@@ -9,6 +9,17 @@ module Hatchet
   #
   class PlainFormatter
 
+    # Public: Gets or sets whether backtraces should be output when messages
+    # contain an error with one.
+    #
+    attr_accessor :backtrace
+
+    # Public: Creates a new instance.
+    #
+    def initialize
+      self.backtrace = true
+    end
+
     # Public: Returns the formatted message.
     #
     # level   - The severity of the log message.
@@ -18,9 +29,17 @@ module Hatchet
     # Returns messages in the format:
     #
     #   MESSAGE
+    #       BACKTRACE
+    #
+    # The backtrace is only present if the message contains an error.
     #
     def format(level, context, message)
-      message.to_s
+      unless self.backtrace && message.error && message.error.respond_to?(:backtrace)
+        message.to_s
+      else
+        indented_backtrace = message.error.backtrace.map { |line| "    #{line}" }.to_a
+        ([message.to_s] + indented_backtrace).join "\n"
+      end
     end
 
   end

data/lib/hatchet/simple_formatter.rb

@@ -7,6 +7,17 @@ module Hatchet
   #
   class SimpleFormatter
 
+    # Public: Gets or sets whether backtraces should be output when messages
+    # contain an error with one.
+    #
+    attr_accessor :backtrace
+
+    # Public: Creates a new instance.
+    #
+    def initialize
+      self.backtrace = true
+    end
+
     # Public: Returns the formatted message.
     #
     # level   - The severity of the log message.
@@ -16,10 +27,17 @@ module Hatchet
     # Returns messages in the format:
     #
     #   LEVEL - CONTEXT - MESSAGE
+    #       BACKTRACE
+    #
+    # The backtrace is only present if the message contains an error.
     #
     def format(level, context, message)
-      message = message.to_s.strip
-      "#{level.to_s.upcase} - #{context} - #{message}"
+      msg = message.to_s.strip
+      if self.backtrace && message.error && message.error.respond_to?(:backtrace)
+        indented_backtrace = message.error.backtrace.map { |line| "    #{line}" }.to_a
+        msg = ([msg] + indented_backtrace).join("\n")
+      end
+      "#{level.to_s.upcase} - #{context} - #{msg}"
     end
 
   end

data/lib/hatchet/standard_formatter.rb

@@ -6,10 +6,16 @@ module Hatchet
   #
   class StandardFormatter
 
+    # Public: Gets or sets whether backtraces should be output when messages
+    # contain an error with one.
+    #
+    attr_accessor :backtrace
+
     # Public: Creates a new instance.
     #
     def initialize
       @secs = 0
+      self.backtrace = true
     end
 
     # Public: Returns the formatted message.
@@ -21,10 +27,17 @@ module Hatchet
     # Returns messages in the format:
     #
     #   %Y-%m-%d %H:%M:%S.%L [THREAD] LEVEL CONTEXT - MESSAGE
+    #       BACKTRACE
+    #
+    # The backtrace is only present if the message contains an error.
     #
     def format(level, context, message)
-      message = message.to_s.strip
-      "#{timestamp} [#{thread_name}] #{format_level level} #{context} - #{message}"
+      msg = message.to_s.strip
+      if self.backtrace && message.error && message.error.respond_to?(:backtrace)
+        indented_backtrace = message.error.backtrace.map { |line| "    #{line}" }.to_a
+        msg = ([msg] + indented_backtrace).join("\n")
+      end
+      "#{timestamp} [#{thread_name}] #{format_level level} #{context} - #{msg}"
     end
 
     private

data/lib/hatchet/version.rb

@@ -4,6 +4,6 @@ module Hatchet
 
   # Public: The version of Hatchet.
   #
-  VERSION = '0.0.18'
+  VERSION = '0.0.19'
 
 end

data/spec/plain_formatter_spec.rb

@@ -6,13 +6,54 @@ describe PlainFormatter do
   let(:subject) { PlainFormatter.new }
 
   describe 'when formatting a message' do
-    before do
-      @message = subject.format(:info, 'Custom::Context', '  Hello, World  ')
+
+    describe 'without an error' do
+
+      before do
+        @message = Message.new('  Hello, World  ')
+      end
+
+      it 'outputs the message in the MESSAGE format' do
+        message = subject.format(:info, 'Custom::Context', @message)
+        assert '  Hello, World  ' == message, "got #{message}"
+      end
+
     end
 
-    it 'outputs the message in the MESSAGE format' do
-      assert '  Hello, World  ' == @message, "got #{@message}"
+    describe 'with an error' do
+
+      before do
+        error = OpenStruct.new(message: 'Boom!', backtrace: ['foo.rb:1:a', 'foo.rb:20:b'])
+        @message = Message.new('  Hello, World  ', error)
+      end
+
+      describe 'with backtraces enabled' do
+
+        it 'outputs the message in the MESSAGE format' do
+          message = subject.format(:info, 'Custom::Context', @message)
+          assert_equal %q{  Hello, World  
+    foo.rb:1:a
+    foo.rb:20:b}, message
+        end
+
+      end
+
+      describe 'with backtraces disabled' do
+
+        before do
+          subject.backtrace = false
+        end
+
+        it 'outputs the message in the MESSAGE format' do
+          message = subject.format(:info, 'Custom::Context', @message)
+          assert '  Hello, World  ' == message, "got #{message}"
+        end
+
+      end
+
     end
+
   end
+
 end
 

data/spec/simple_formatter_spec.rb

@@ -6,12 +6,51 @@ describe SimpleFormatter do
   let(:subject) { SimpleFormatter.new }
 
   describe 'when formatting a message' do
-    before do
-      @message = subject.format(:info, 'Custom::Context', 'Hello, World')
+
+    describe 'without an error' do
+
+      before do
+        @message = Message.new('  Hello, World  ')
+      end
+
+      it 'outputs the message in the LEVEL - CONTEXT - MESSAGE format' do
+        message = subject.format(:info, 'Custom::Context', @message)
+        assert 'INFO - Custom::Context - Hello, World' == message, "got #{message}"
+      end
+
     end
 
-    it 'outputs the message in the LEVEL - CONTEXT - MESSAGE format' do
-      assert 'INFO - Custom::Context - Hello, World' == @message, "got #{@message}"
+    describe 'with an error' do
+
+      before do
+        error = OpenStruct.new(message: 'Boom!', backtrace: ['foo.rb:1:a', 'foo.rb:20:b'])
+        @message = Message.new('  Hello, World  ', error)
+      end
+
+      describe 'with backtraces enabled' do
+
+        it 'outputs the message in the LEVEL - CONTEXT - MESSAGE format' do
+          message = subject.format(:info, 'Custom::Context', @message)
+          assert_equal %q{INFO - Custom::Context - Hello, World
+    foo.rb:1:a
+    foo.rb:20:b}, message
+        end
+
+      end
+
+      describe 'with backtraces disabled' do
+
+        before do
+          subject.backtrace = false
+        end
+
+        it 'outputs the message in the LEVEL - CONTEXT - MESSAGE format' do
+          message = subject.format(:info, 'Custom::Context', @message)
+          assert 'INFO - Custom::Context - Hello, World' == message, "got #{message}"
+        end
+
+      end
+
     end
   end
 end

data/spec/standard_formatter_spec.rb

@@ -10,7 +10,7 @@ describe StandardFormatter do
 
   describe 'when formatting a message' do
     before do
-      @message = 'Hello, World'
+      @message = Message.new('Hello, World')
       @context = 'Custom::Context'
       @level   = :info
       @formatted_message = subject.format(@level, @context, @message)
@@ -54,6 +54,39 @@ describe StandardFormatter do
       end
     end
 
+    describe 'with an error' do
+
+      before do
+        error = OpenStruct.new(message: 'Boom!', backtrace: ['foo.rb:1:a', 'foo.rb:20:b'])
+        @message = Message.new('  Hello, World  ', error)
+      end
+
+      describe 'with backtraces enabled' do
+
+        it 'outputs the message in the LEVEL - CONTEXT - MESSAGE format' do
+          formatted_message = subject.format(@level, @context, @message)
+          backtrace = formatted_message.split("\n").drop(1)
+          assert_equal ['    foo.rb:1:a', '    foo.rb:20:b'], backtrace
+        end
+
+      end
+
+      describe 'with backtraces disabled' do
+
+        before do
+          subject.backtrace = false
+        end
+
+        it 'outputs the message in the LEVEL - CONTEXT - MESSAGE format' do
+          formatted_message = subject.format(@level, @context, @message)
+          backtrace = formatted_message.split("\n").drop(1)
+          assert_empty backtrace
+        end
+
+      end
+
+    end
+
     if ENV["BENCH"] then
 
       describe 'benchmarks' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hatchet
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-04 00:00:00.000000000 Z
+date: 2012-11-07 00:00:00.000000000 Z
 dependencies: []
 description: Logging library that provides the ability to add class/module specific
   filters