hatchet 0.0.5 → 0.0.6

data/lib/hatchet.rb

@@ -20,9 +20,9 @@ require_relative 'hatchet/version'
 #
 module Hatchet
 
-  # Public: Returns a Logger for the object.
+  # Public: Returns a HatchetLogger for the object.
   #
-  # The returned logger has 5 methods. Those are, in decreasing order of
+  # The logger has 5 logging methods. Those are, in decreasing order of
   # severity:
   #
   #  * fatal
@@ -31,8 +31,8 @@ module Hatchet
   #  * info
   #  * debug
   #
-  # All the methods have the same signature. You can either provide a message as
-  # a direct string, or as a block to the method is lazily evaluated (this is
+  # All these methods have the same signature. You can either provide a message
+  # as a direct string, or as a block to the method is lazily evaluated (this is
   # the recommended option).
   #
   # Examples
@@ -40,18 +40,31 @@ module Hatchet
   #   logger.info "Informational message"
   #   logger.info { "Informational message #{potentially_expensive}" }
   #
-  # Log messages are sent to appender where they will be filtered and invoked as
-  # configured.
+  # Log messages are sent to each appender where they will be filtered and
+  # invoked as configured.
   #
-  # Returns a Logger for the object.
+  # The logger also has 5 inspection methods. Those are, in decreasing order of
+  # severity:
+  #
+  #  * fatal?
+  #  * error?
+  #  * warn?
+  #  * info?
+  #  * debug?
+  #
+  # All these methods take no arguments and return true if any of the loggers'
+  # appenders will log a message at that level for the current context,
+  # otherwise they will return false.
+  #
+  # Returns a HatchetLogger for the object.
   #
   def logger
     @_hatchet_logger ||= HatchetLogger.new self, Hatchet.appenders
   end
 
-  # Public: Returns a logger for the object.
+  # Public: Returns a HatchetLogger for the object.
   #
-  # The returned logger has 5 methods. Those are, in decreasing order of
+  # The logger has 5 logging methods. Those are, in decreasing order of
   # severity:
   #
   #  * fatal
@@ -60,8 +73,8 @@ module Hatchet
   #  * info
   #  * debug
   #
-  # All the methods have the same signature. You can either provide a message as
-  # a direct string, or as a block to the method is lazily evaluated (this is
+  # All these methods have the same signature. You can either provide a message
+  # as a direct string, or as a block to the method is lazily evaluated (this is
   # the recommended option).
   #
   # Examples
@@ -69,10 +82,23 @@ module Hatchet
   #   log.info "Informational message"
   #   log.info { "Informational message #{potentially_expensive}" }
   #
-  # Log messages are sent to appender where they will be filtered and invoked as
-  # configured.
+  # Log messages are sent to each appender where they will be filtered and
+  # invoked as configured.
+  #
+  # The logger also has 5 inspection methods. Those are, in decreasing order of
+  # severity:
+  #
+  #  * fatal?
+  #  * error?
+  #  * warn?
+  #  * info?
+  #  * debug?
+  #
+  # All these methods take no arguments and return true if any of the loggers'
+  # appenders will log a message at that level for the current context,
+  # otherwise they will return false.
   #
-  # Returns a Logger for the object.
+  # Returns a HatchetLogger for the object.
   #
   alias_method :log, :logger
 
@@ -106,8 +132,9 @@ module Hatchet
   def self.configure
     @@config = Configuration.new
     yield @@config
+    default_formatter = StandardFormatter.new
     @@config.appenders.each do |appender|
-      appender.formatter ||= StandardFormatter.new
+      appender.formatter ||= default_formatter
       appender.levels = @@config.levels if appender.levels.empty?
     end
   end

data/lib/hatchet/hatchet_logger.rb

@@ -2,10 +2,11 @@
 
 module Hatchet
 
-  # Internal: Class that handles logging calls and distributes them to all its
+  # Public: Class that handles logging calls and distributes them to all its
   # appenders.
   #
-  # Each logger has 5 methods. Those are, in decreasing order of severity:
+  # Each logger has 5 logging methods. Those are, in decreasing order of
+  # severity:
   #
   #  * fatal
   #  * error
@@ -13,8 +14,8 @@ module Hatchet
   #  * info
   #  * debug
   #
-  # All the methods have the same signature. You can either provide a message as
-  # a direct string, or as a block to the method is lazily evaluated (this is
+  # All these methods have the same signature. You can either provide a message
+  # as a direct string, or as a block to the method is lazily evaluated (this is
   # the recommended option).
   #
   # Examples
@@ -25,6 +26,19 @@ module Hatchet
   # Log messages are sent to each appender where they will be filtered and
   # invoked as configured.
   #
+  # Each logger also has 5 inspection methods. Those are, in decreasing order of
+  # severity:
+  #
+  #  * fatal?
+  #  * error?
+  #  * warn?
+  #  * info?
+  #  * debug?
+  #
+  # All these methods take no arguments and return true if any of the loggers'
+  # appenders will log a message at that level for the current context,
+  # otherwise they will return false.
+  #
   class HatchetLogger
 
     # Internal: Creates a new logger.

data/lib/hatchet/logger_appender.rb

@@ -45,7 +45,7 @@ module Hatchet
       yield self if block_given?
 
       @logger.level = ::Logger::DEBUG
-      return unless @logger.instance_of? Logger
+      return unless @logger.respond_to? :formatter
 
       # Wipe the format of the core Logger. The Rails.logger doesn't have this
       # method for example.

data/lib/hatchet/standard_formatter.rb

@@ -6,6 +6,10 @@ module Hatchet
   #
   class StandardFormatter
 
+    def initialize
+      @secs = 0
+    end
+
     # Public: Returns the formatted message.
     #
     # level   - The severity of the log message.
@@ -15,6 +19,7 @@ module Hatchet
     # Returns the context and message separated by a hypen.
     #
     def format(level, context, message)
+      message = message.to_s.strip
       "#{timestamp} [#{thread_name}] #{format_level level} #{context} - #{message}"
     end
 
@@ -23,7 +28,20 @@ module Hatchet
     # Private: Returns the current time as a String.
     #
     def timestamp
-      Time.now.strftime('%Y-%m-%d %H:%M:%S.%L')
+      time = Time.now
+
+      secs = time.to_i
+      millis = time.nsec/1000000
+
+      return @last if @millis == millis && @secs == secs
+
+      unless secs == @secs
+        @secs = secs
+        @date = time.strftime('%Y-%m-%d %H:%M:%S.')
+      end
+
+      @millis = millis
+      @last = @date + "00#{millis}"[1..3]
     end
 
     # Private: Returns the name of the current thread from the processes pid and

data/lib/hatchet/version.rb

@@ -4,6 +4,6 @@ module Hatchet
 
   # Public: The version of Hatchet.
   #
-  VERSION = "0.0.5"
+  VERSION = '0.0.6'
 
 end

data/spec/standard_formatter_spec.rb

@@ -54,6 +54,20 @@ describe StandardFormatter do
       end
     end
 
+    describe 'benchmarks' do
+      it 'is reasonably quick' do
+        start = Time.now
+
+        50_000.times do
+          subject.format(:info, @context, @message)
+        end
+
+        took = Time.now - start
+        limit = 0.4
+        assert took < limit, "Expected messages to take less than #{limit} but took #{took}"
+      end
+    end
+
     def format_as_string(time)
       time.strftime TIME_FORMAT
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hatchet
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-08 00:00:00.000000000 Z
+date: 2012-07-10 00:00:00.000000000 Z
 dependencies: []
 description: Logging library that provides the ability to add class/module specific
   filters
@@ -58,7 +58,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