hatchet 0.0.10 → 0.0.11

data/lib/hatchet/configuration.rb

@@ -19,11 +19,75 @@ module Hatchet
       reset!
     end
 
+    # Public: Returns the default formatter given to the appenders that have not
+    # had their formatter explicitly set.
+    #
+    # If not otherwise set, will be a StandardFormatter.
+    #
+    def formatter
+      @formatter.formatter
+    end
+
+    # Public: Sets the default formatter given to the appenders that have not
+    # had their formatter explicitly set.
+    #
+    def formatter=(formatter)
+      @formatter.formatter = formatter
+    end
+
     # Public: Resets the configuration's internal state to the defaults.
     #
     def reset!
       @levels = { nil => :info }
       @appenders = []
+
+      # If a DelegatingFormatter has already been set up replace its
+      # formatter, otherwise create a new one.
+      #
+      if @formatter
+        @formatter.formatter = StandardFormatter.new
+      else
+        @formatter = DelegatingFormatter.new(StandardFormatter.new)
+      end
+    end
+
+    # Public: Yields the configuration object to the given block to make it
+    # tidier when setting multiple values against a referenced configuration.
+    #
+    # block - Mandatory block which receives a Configuration object that can be
+    #         used to setup Hatchet.
+    #
+    # Once the block returns each of the configured appenders has its formatter
+    # set to the default formatter if one is not already set, and its levels
+    # Hash is set to the shared levels Hash if an explicit one has not been
+    # provided.
+    #
+    # Example
+    #
+    #   configuration.configure do |config|
+    #     # Set the level to use unless overridden (defaults to :info)
+    #     config.level :info
+    #     # Set the level for a specific class/module and its children
+    #     config.level :debug, 'Namespace::Something::Nested'
+    #
+    #     # Add as many appenders as you like
+    #     config.appenders << Hatchet::LoggerAppender.new do |appender|
+    #       # Set the logger that this is wrapping (required)
+    #       appender.logger = Logger.new('log/test.log')
+    #     end
+    #   end
+    #
+    # Returns nothing.
+    #
+    def configure
+      yield self
+
+      # Ensure every appender has a formatter and a level configuration.
+      #
+      appenders.each do |appender|
+        appender.formatter ||= @formatter
+        appender.levels = @levels if appender.levels.empty?
+      end
     end
 
   end

data/lib/hatchet/delegating_formatter.rb

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+module Hatchet
+
+  # Internal: Formatter class that delegates to another formatter
+  # implementation. Used within the configuration to make it possible to switch
+  # the default formatter at any time.
+  #
+  class DelegatingFormatter
+
+    # Internal: Gets or sets the formatter that is delegated to.
+    #
+    attr_accessor :formatter
+
+    # Internal: Creates a new instance.
+    #
+    # formatter - The formatter to delegate to initially.
+    #
+    def initialize(formatter)
+      @formatter = formatter
+    end
+
+    # Public: Returns the formatted message.
+    #
+    # level   - The severity of the log message.
+    # context - The context of the log message.
+    # message - The message provided by the log caller.
+    #
+    # Returns messages as formatted by the formatter being delegated to.
+    #
+    def format(level, context, message)
+      @formatter.format(level, context, message)
+    end
+
+  end
+
+end
+

data/lib/hatchet/railtie.rb

@@ -13,9 +13,7 @@ module Hatchet
     # Expose Hatchet's configuration object to consumers through the Rails
     # config object.
     #
-    Hatchet.configure do |config|
-      self.config.hatchet = config
-    end
+    self.config.hatchet = Hatchet.configuration
 
     # Wrap the default Rails.logger, Rails.application.assets.logger, and all
     # log subscribers found in ActiveSupport::LogSubscriber.log_subscribers
@@ -27,10 +25,23 @@ module Hatchet
       #
       logger = Rails.logger
 
+      # Map the level of the logger so Hatchet uses the same.
+      #
+      current_level =
+        case logger.level
+        when Logger::DEBUG then :debug
+        when Logger::INFO  then :info
+        when Logger::WARN  then :warn
+        when Logger::ERROR then :error
+        when Logger::FATAL then :fatal
+        else nil # If not recognized use Hatchet's default
+        end
+
       # Add an appender that delegates to the current Rails.logger to Hatchet's
       # configuration.
       #
       Hatchet.configure do |config|
+        config.level(current_level) if current_level
         config.appenders << Hatchet::LoggerAppender.new(logger: logger)
       end
 
@@ -41,14 +52,15 @@ module Hatchet
       begin
         # Replace the Rails.logger with the application's Hatchet logger.
         #
-        logger.debug 'Replacing Rails logger with Hatchet'
         Rails.logger = app.logger
+        app.logger.debug { 'Replaced Rails logger with Hatchet' }
 
         # Replace the logger of every subscriber in the
         # ActiveSupport::LogSubscriber.log_subscribers collection by extending
+        # them with Hatchet.
         #
         ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
-          logger.debug "Replacing #{subscriber.class} logger with Hatchet"
+          app.logger.debug { "Replacing #{subscriber.class} logger with Hatchet" }
           subscriber.extend Hatchet
         end
 
@@ -59,7 +71,7 @@ module Hatchet
         # As you can guess by the description this is probably the riskiest so
         # we do it last.
         #
-        logger.debug 'Replacing Rails asset logger with Hatchet'
+        app.logger.debug { 'Replacing Rails asset logger with Hatchet' }
 
         # Initially replace it with the application logger as it's better for
         # this to be done if the next part fails.
@@ -78,8 +90,8 @@ module Hatchet
         # If anything goes wrong along the way log it and let the application
         # continue.
         #
-        logger.error 'Failed to replace logger with Hatchet'
-        logger.error $!
+        logger.error { 'Failed to replace logger with Hatchet' }
+        logger.error { $! }
       end
     end
   end

data/lib/hatchet/standard_formatter.rb

@@ -6,6 +6,8 @@ module Hatchet
   #
   class StandardFormatter
 
+    # Public: Creates a new instance.
+    #
     def initialize
       @secs = 0
     end

data/lib/hatchet/version.rb

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

data/lib/hatchet.rb

@@ -2,6 +2,7 @@
 
 require_relative 'hatchet/level_manager'
 require_relative 'hatchet/configuration'
+require_relative 'hatchet/delegating_formatter'
 require_relative 'hatchet/hatchet_logger'
 require_relative 'hatchet/logger_appender'
 require_relative 'hatchet/message'
@@ -117,12 +118,10 @@ module Hatchet
   #   Hatchet.configure do |config|
   #     # Set the level to use unless overridden (defaults to :info)
   #     config.level :info
-  #     # Set the level for a specific class/module and its children (can be a
-  #     # string)
-  #     config.level :debug, Namespace::Something::Nested
+  #     # Set the level for a specific class/module and its children
+  #     config.level :debug, 'Namespace::Something::Nested'
   #
-  #     # Add as many appenders as you like, Hatchet comes with one that formats
-  #     # the standard logger in the TTCC style of log4j.
+  #     # Add as many appenders as you like
   #     config.appenders << Hatchet::LoggerAppender.new do |appender|
   #       # Set the logger that this is wrapping (required)
   #       appender.logger = Logger.new('log/test.log')
@@ -130,13 +129,9 @@ module Hatchet
   #   end
   #
   # Returns nothing.
-  def self.configure
-    yield configuration
-    default_formatter = StandardFormatter.new
-    configuration.appenders.each do |appender|
-      appender.formatter ||= default_formatter
-      appender.levels = configuration.levels if appender.levels.empty?
-    end
+  #
+  def self.configure(&block)
+    configuration.configure(&block)
   end
 
   # Public: Callback method for when Hatchet is registered as a Sinatra helper.
@@ -146,6 +141,7 @@ module Hatchet
   #   register Hatchet
   #
   # Returns nothing.
+  #
   def self.registered(app)
     app.helpers Hatchet
   end
@@ -156,9 +152,7 @@ module Hatchet
     configuration.appenders
   end
 
-  private
-
-  # Private: Returns the configuration object, initializing it when necessary.
+  # Internal: Returns the configuration object, initializing it when necessary.
   #
   def self.configuration
     @config ||= Configuration.new

data/spec/configuration_spec.rb

@@ -25,7 +25,30 @@ describe 'configuration' do
     end
 
     it 'formatter set as a StandardFormatter' do
-      assert appender.formatter.instance_of? StandardFormatter
+      assert appender.formatter.instance_of? DelegatingFormatter
+      assert appender.formatter.formatter.instance_of? StandardFormatter
+    end
+
+    describe 'with an explicit default formatter' do
+      let(:formatter) { SimpleFormatter.new }
+      let(:second_appender)   { StoringAppender.new }
+
+      before do
+        Hatchet.configure do |config|
+          config.formatter = formatter
+          config.appenders << second_appender
+        end
+      end
+
+      it 'original formatter set as the configured default' do
+        assert appender.formatter.instance_of? DelegatingFormatter
+        assert appender.formatter.formatter == formatter
+      end
+
+      it 'second formatter set as the configured default' do
+        assert appender.formatter.instance_of? DelegatingFormatter
+        assert second_appender.formatter.formatter == formatter
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hatchet
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-23 00:00:00.000000000 Z
+date: 2012-07-29 00:00:00.000000000 Z
 dependencies: []
 description: Logging library that provides the ability to add class/module specific
   filters
@@ -20,6 +20,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/hatchet/configuration.rb
+- lib/hatchet/delegating_formatter.rb
 - lib/hatchet/hatchet_logger.rb
 - lib/hatchet/level_manager.rb
 - lib/hatchet/logger_appender.rb
@@ -62,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Logging library that provides the ability to add class/module specific filters