hatchet 0.0.16 → 0.0.17

data/lib/hatchet/hatchet_logger.rb

@@ -67,16 +67,34 @@ module Hatchet
       # Public: Logs a message at the given level.
       #
       # message - An already evaluated message, usually a String (default: nil).
+      # error   - An error which is associated with the message (default: nil).
       # block   - An optional block which will provide a message when invoked.
       #
       # One of message or block must be provided. If both are provided then the
       # block is preferred as it is assumed to provide more detail.
       #
+      # In general, you should use the block style for any message not related
+      # to an error. This is because any unneccessary String interpolation is
+      # avoided making unwritten debug calls, for example, less expensive.
+      #
+      # When logging errors it is advised that you include some details of the
+      # error within the regular message, perhaps the error's message, but leave
+      # the inclusion of the stack trace up to your appenders and their
+      # formatters.
+      #
+      # Examples
+      #
+      #   debug { "A fine grained message" }
+      #   info  { "An interesting message" }
+      #   warn  { "A message worth highlighting" }
+      #   error "A message relating to an exception", e
+      #   fatal "A message causing application failure", e
+      #
       # Returns nothing.
       #
-      define_method level do |message = nil, &block|
+      define_method level do |message = nil, error = nil, &block|
         return unless message or block
-        add level, Message.new(message, &block)
+        add level, Message.new(message, error, &block)
       end
 
       # Public: Returns true if any of the appenders will log messages for the
@@ -150,11 +168,12 @@ module Hatchet
           begin
             appender.add(level, @context, message)
           rescue => e
-            puts "Failed to log message for #{context} with appender #{appender} - #{level} - #{message}\n"
+            puts "Failed to log message for #{@context} with appender #{appender} - #{level} - #{message}\n"
             puts "#{e}\n"
           end
         end
       end
+      nil
     end
 
     # Private: Determines the contextual name of the host object.

data/lib/hatchet/message.rb

@@ -2,16 +2,24 @@
 
 module Hatchet
 
-  # Internal: Class for wrapping message strings and blocks in a way that means
+  # Public: Class for wrapping message strings and blocks in a way that means
   # they can be treated identically.
   #
+  # If an error is associated with the message this will be available via the
+  # #error attribute.
+  #
   # Blocks will be lazily evaluated once for all appenders when required.
   #
   class Message
 
+    # Public: Gets the error associated with this message, if given.
+    #
+    attr_reader :error
+
     # Internal: Creates a new message.
     #
     # message - An already evaluated message, usually a String (default: nil).
+    # error   - An error that is associated with the message (default: nil).
     # block   - An optional block which will provide a message when invoked.
     #
     # One of message or block must be provided. If both are provided then the
@@ -22,8 +30,9 @@ module Hatchet
     #   Message.new "Evaluated message"
     #   Message.new { "Lazily evaluated message" }
     #
-    def initialize(message = nil, &block)
+    def initialize(message = nil, error = nil, &block)
       @block = block
+      @error = error
       @message = message unless @block
     end
 

data/lib/hatchet/version.rb

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

data/spec/helpers/failing_appender.rb

@@ -0,0 +1,14 @@
+# -*- encoding: utf-8 -*-
+
+class FailingAppender
+  include LevelManager
+
+  def initialize
+    @levels = { nil => :info }
+  end
+
+  def add(level, context, message)
+    raise StandardError, 'Failing appender'
+  end
+end
+

data/spec/logger_spec.rb

@@ -40,6 +40,23 @@ describe HatchetLogger do
 
         refute disabled_appender.add_called
       end
+
+      it 'should return nil from the call' do
+        returned = subject.send(level, message)
+
+        assert returned.nil?, 'logging calls should return nil'
+      end
+
+      describe 'with an error' do
+        let(:error) { StandardError.new }
+
+        it 'should pass the error through to the appender' do
+          subject.send level, message, error
+          received = appender.messages.last
+
+          assert error == received.message.error
+        end
+      end
     end
   end
 
@@ -81,6 +98,16 @@ describe HatchetLogger do
     end
   end
 
+  describe 'failing appender' do
+    before do
+      configuration.appenders << FailingAppender.new
+    end
+
+    it 'does not fail' do
+      subject.info 'Will fail for one appender'
+    end
+  end
+
   describe 'naming context' do
     let(:context_name) do
       subject.fatal 'Message'

data/spec/spec_helper.rb

@@ -10,6 +10,7 @@ include Hatchet
 require_relative 'helpers/logger_double'
 require_relative 'helpers/test_formatter'
 require_relative 'helpers/disabled_appender'
+require_relative 'helpers/failing_appender'
 require_relative 'helpers/storing_appender'
 
 INITIAL_EXECUTION_CONTEXT = self

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hatchet
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-22 00:00:00.000000000 Z
+date: 2012-11-04 00:00:00.000000000 Z
 dependencies: []
 description: Logging library that provides the ability to add class/module specific
   filters
@@ -33,6 +33,7 @@ files:
 - lib/hatchet.rb
 - spec/configuration_spec.rb
 - spec/helpers/disabled_appender.rb
+- spec/helpers/failing_appender.rb
 - spec/helpers/logger_double.rb
 - spec/helpers/storing_appender.rb
 - spec/helpers/test_formatter.rb
@@ -60,7 +61,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 569280193996851270
+      hash: -2041677748427944104
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -69,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 569280193996851270
+      hash: -2041677748427944104
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.17
@@ -79,6 +80,7 @@ summary: Logging library that provides the ability to add class/module specific
 test_files:
 - spec/configuration_spec.rb
 - spec/helpers/disabled_appender.rb
+- spec/helpers/failing_appender.rb
 - spec/helpers/logger_double.rb
 - spec/helpers/storing_appender.rb
 - spec/helpers/test_formatter.rb