hatchet 0.0.19 → 0.0.20

data/RELEASE.md

@@ -1,5 +1,11 @@
 # Release notes
 
+## 0.0.20
+
+ * Added a `#thread_context` attribute to the `SimpleFormatter` that is `false`
+   by default, but when set to `true` will output the context of the thread
+   within messages in the same style as the `StandardFormatter`
+
 ## 0.0.19
 
  * Changed core formatters to output an indented backtrace after a message when

data/lib/hatchet/backtrace_formatter.rb

@@ -0,0 +1,52 @@
+# -*- encoding: utf-8 -*-
+
+module Hatchet
+
+  # Internal: Module for handling the common code for conditionally including
+  # the backtrace within a formatted message.
+  #
+  module BacktraceFormatter
+
+    # Public: Gets whether backtraces are enabled.
+    #
+    # Defaults to true if it has not been set.
+    #
+    def backtrace
+      @backtrace.nil? ? true : @backtrace
+    end
+
+    # Public: Sets whether backtraces should be enabled.
+    #
+    # value - True if backtraces should be enabled, otherwise false.
+    #
+    def backtrace=(value)
+      @backtrace = value
+    end
+
+    private
+
+    # Private: Method that takes an already formatted message and appends the
+    # backtrace to it if there is one and backtraces are enabled.
+    #
+    # message                   - The Message that is being formatted.
+    # message_without_backtrace - The formatted message before a backtrace may
+    #                             be added.
+    #
+    # Returns a message with a backtrace optionally appended to it.
+    #
+    def with_backtrace(message, message_without_backtrace)
+      msg = message_without_backtrace
+      error = message.error
+
+      if self.backtrace && error && error.respond_to?(:backtrace)
+        indented_backtrace = error.backtrace.map { |line| "    #{line}" }.to_a
+        msg = ([msg] + indented_backtrace).join("\n")
+      end
+
+      msg
+    end
+
+  end
+
+end
+

data/lib/hatchet/plain_formatter.rb

@@ -8,17 +8,7 @@ module Hatchet
   # be human readable rather than useful for grepping, etc.
   #
   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
+    include BacktraceFormatter
 
     # Public: Returns the formatted message.
     #
@@ -34,12 +24,7 @@ module Hatchet
     # The backtrace is only present if the message contains an error.
     #
     def format(level, context, message)
-      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
+      with_backtrace(message, message.to_s)
     end
 
   end

data/lib/hatchet/simple_formatter.rb

@@ -6,17 +6,13 @@ module Hatchet
   # and message.
   #
   class SimpleFormatter
+    include BacktraceFormatter
+    include ThreadNameFormatter
 
-    # Public: Gets or sets whether backtraces should be output when messages
-    # contain an error with one.
+    # Public: Gets or sets whether the context of the thread (pid and thread ID)
+    # should be included into the output messages.
     #
-    attr_accessor :backtrace
-
-    # Public: Creates a new instance.
-    #
-    def initialize
-      self.backtrace = true
-    end
+    attr_accessor :thread_context
 
     # Public: Returns the formatted message.
     #
@@ -26,18 +22,23 @@ module Hatchet
     #
     # Returns messages in the format:
     #
-    #   LEVEL - CONTEXT - MESSAGE
+    #   [THREAD] - LEVEL - CONTEXT - MESSAGE
     #       BACKTRACE
     #
-    # The backtrace is only present if the message contains an error.
+    # The backtrace is only present if the message contains an error and the
+    # presence of the context of the thread context is managed via the
+    # #thread_context attribute.
     #
     def format(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")
+
+      if thread_context
+        msg = "[#{thread_name}] - #{level.to_s.upcase} - #{context} - #{msg}"
+      else
+        msg = "#{level.to_s.upcase} - #{context} - #{msg}"
       end
-      "#{level.to_s.upcase} - #{context} - #{msg}"
+
+      with_backtrace(message, msg)
     end
 
   end

data/lib/hatchet/standard_formatter.rb

@@ -5,17 +5,13 @@ module Hatchet
   # Public: Standard formatter class. Outputs messages in the TTCC of log4j.
   #
   class StandardFormatter
-
-    # Public: Gets or sets whether backtraces should be output when messages
-    # contain an error with one.
-    #
-    attr_accessor :backtrace
+    include BacktraceFormatter
+    include ThreadNameFormatter
 
     # Public: Creates a new instance.
     #
     def initialize
       @secs = 0
-      self.backtrace = true
     end
 
     # Public: Returns the formatted message.
@@ -33,11 +29,9 @@ module Hatchet
     #
     def format(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}"
+      msg = "#{timestamp} [#{thread_name}] #{format_level level} #{context} - #{msg}"
+
+      with_backtrace(message, msg)
     end
 
     private
@@ -61,17 +55,6 @@ module Hatchet
       @last = @date + "00#{millis}"[-3..-1]
     end
 
-    # Private: Returns the name of the current thread from the processes pid and
-    # the threads object_id when it is not the main thread for the process.
-    #
-    def thread_name
-      if Thread.current == Thread.main
-        Process.pid
-      else
-        "#{Process.pid}##{Thread.current.object_id}"
-      end
-    end
-
     # Private: Returns the level formatted for log output as a String.
     #
     def format_level(level)

data/lib/hatchet/thread_name_formatter.rb

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+
+module Hatchet
+
+  # Internal: Module for standardizing the formatting of thread contexts.
+  #
+  module ThreadNameFormatter
+
+    private
+
+    # Private: Returns the name of the current thread from the processes pid and
+    # the threads object_id when it is not the main thread for the process.
+    #
+    def thread_name
+      if Thread.current == Thread.main
+        Process.pid
+      else
+        "#{Process.pid}##{Thread.current.object_id}"
+      end
+    end
+
+  end
+
+end
+

data/lib/hatchet/version.rb

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

data/lib/hatchet.rb

@@ -3,6 +3,8 @@
 require 'logger'
 
 require_relative 'hatchet/level_manager'
+require_relative 'hatchet/backtrace_formatter'
+require_relative 'hatchet/thread_name_formatter'
 require_relative 'hatchet/configuration'
 require_relative 'hatchet/delegating_formatter'
 require_relative 'hatchet/hatchet_logger'

data/spec/simple_formatter_spec.rb

@@ -52,6 +52,22 @@ describe SimpleFormatter do
       end
 
     end
+
+    describe 'with thread context' do
+
+      before do
+        subject.thread_context = true
+        @message = Message.new('  Hello, World  ')
+      end
+
+      it 'outputs the message in the [THREAD] - LEVEL - CONTEXT - MESSAGE format' do
+        message = subject.format(:info, 'Custom::Context', @message)
+        assert "[#{Process.pid}] - INFO - Custom::Context - Hello, World" == message, "got #{message}"
+      end
+
+    end
+
   end
+
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hatchet
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.0.20
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-07 00:00:00.000000000 Z
+date: 2012-11-11 00:00:00.000000000 Z
 dependencies: []
 description: Logging library that provides the ability to add class/module specific
   filters
@@ -19,6 +19,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/hatchet/backtrace_formatter.rb
 - lib/hatchet/configuration.rb
 - lib/hatchet/delegating_formatter.rb
 - lib/hatchet/hatchet_logger.rb
@@ -29,6 +30,7 @@ files:
 - lib/hatchet/railtie.rb
 - lib/hatchet/simple_formatter.rb
 - lib/hatchet/standard_formatter.rb
+- lib/hatchet/thread_name_formatter.rb
 - lib/hatchet/version.rb
 - lib/hatchet.rb
 - spec/configuration_spec.rb