sawmill 0.1.15 → 0.1.16

data/lib/sawmill/level.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Sawmill level class
-# 
+#
 # -----------------------------------------------------------------------------
 # Copyright 2009 Daniel Azuma
-# 
+#
 # All rights reserved.
-# 
+#
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
-# 
+#
 # * Redistributions of source code must retain the above copyright notice,
 #   this list of conditions and the following disclaimer.
 # * Redistributions in binary form must reproduce the above copyright notice,
@@ -18,7 +18,7 @@
 # * Neither the name of the copyright holder, nor the names of any other
 #   contributors to this software, may be used to endorse or promote products
 #   derived from this software without specific prior written permission.
-# 
+#
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
@@ -35,37 +35,37 @@
 
 
 module Sawmill
-  
-  
+
+
   # Level objects represent logging levels, sometimes known as severities.
-  # 
+  #
   # A level object has a name and a numeric value. The name controls how the
   # level is represented in a logfile. The value indicates its severity rank
   # compared to other levels.
-  # 
+  #
   # Levels are organized into groups. Levels are comparable with one another
   # if they are part of the same group.
-  
+
   class Level
 
-    
+
     def initialize(group_, name_, value_)  # :nodoc:
       @group = group_
       @name = name_
       @value = value_
     end
-    
-    
+
+
     # The LevelGroup of which this Level is a member
     attr_reader :group
-    
+
     # The name of the level, as a string.
     attr_reader :name
-    
+
     # The numeric value of the level.
     attr_reader :value
-    
-    
+
+
     # Compare this level with another level of the same group.
     def <=>(obj_)
       if obj_.respond_to?(:value) && obj_.respond_to?(:group)
@@ -74,40 +74,40 @@ module Sawmill
         nil
       end
     end
-    
-    
+
+
     # Returns the name.
     def to_s
       @name
     end
-    
-    
+
+
     def inspect  # :nodoc:
       "#<#{self.class}:0x#{object_id.to_s(16)} name=#{@name.inspect} value=#{@value}>"
     end
-    
-    
+
+
     include ::Comparable
-    
-    
+
+
   end
-  
-  
+
+
   # A level group is a group of related levels that can be ordered and used
   # in a log. A given log is always associated with exactly one group, which
   # controls what levels are available for log entries.
-  # 
+  #
   # Normally, you will use Sawmill::STANDARD_LEVELS, which defines levels
   # corresponding to the ones available in the classic ruby logger class.
   # However, this class is available to define custom level hierarchies.
-  
+
   class LevelGroup
-    
-    
+
+
     # Create a level group.
     # You must provide a block that calls methods of
     # Sawmill::LevelGroup::Builder to define the levels in the group.
-    
+
     def initialize(&block_)
       @level_order = []
       @level_names = {}
@@ -115,58 +115,58 @@ module Sawmill
       @default = nil
       ::Blockenspiel.invoke(block_, Builder.new(self))
     end
-    
-    
+
+
     def inspect  # :nodoc:
       "#<#{self.class}:0x#{object_id.to_s(16)} levels=[#{@level_order.map{|lvl_| lvl_.name.inspect}.join(',')}]>"
     end
-    
-    
+
+
     # Return the default level, the one used when no level is specified.
-    
+
     def default
       @default ||= highest
     end
-    
-    
+
+
     # Return the lowest level in the group.
-    
+
     def lowest
       @level_order.first
     end
-    
-    
+
+
     # Return the highest level in the group.
-    
+
     def highest
       @level_order.last
     end
-    
-    
+
+
     # Return the length of the longest name in the group.
-    
+
     def column_width
       @level_order.inject(0) do |width_, level_|
         w_ = level_.name.size
         w_ > width_ ? w_ : width_
       end
     end
-    
-    
+
+
     # Look up a level by a logger method name.
-    
+
     def lookup_method(method_name_)
       @level_methods[method_name_.to_sym]
     end
-    
-    
+
+
     # Get a level in this group.
-    # 
+    #
     # You may pass either an integer value, a level name, a level object,
     # or nil. If you pass nil, the default level is returned. Otherwise,
     # the level corresponding to the given parameter is returned. If no
     # level in this group corresponds to the parameter, nil is returned.
-    
+
     def get(name_)
       case name_
       when ::Integer
@@ -181,8 +181,8 @@ module Sawmill
         nil
       end
     end
-    
-    
+
+
     def _add(name_, opts_={})  # :nodoc:
       name_ = name_.to_sym
       default_ = opts_[:default]
@@ -211,26 +211,26 @@ module Sawmill
         end
       end
     end
-    
-    
+
+
     # You may call methods of this object in the block passed to
     # Sawmill::LevelGroup#new.
-    
+
     class Builder
-      
+
       include ::Blockenspiel::DSL
-      
-      
+
+
       def initialize(group_)  # :nodoc:
         @group = group_
       end
-      
-      
+
+
       # Add a level to this group. The level is assigned the next value in
       # sequence, and the given name.
-      # 
+      #
       # You may also provide these options:
-      # 
+      #
       # [<tt>:default</tt>]
       #   If set to true, this level is made the default.
       # [<tt>:methods</tt>]
@@ -238,19 +238,19 @@ module Sawmill
       #   mapped to this level. You may then use those methods in the
       #   Sawmill::Logger class as a shortcut for creating log messages with
       #   this level.
-      
+
       def add(name_, opts_={})
         @group._add(name_, opts_)
       end
-      
-      
+
+
     end
-    
+
   end
-  
-  
+
+
   # A LevelGroup that corresponds to the classic ruby logger levels.
-  
+
   STANDARD_LEVELS = LevelGroup.new do
     add(:DEBUG, :methods => 'debug')
     add(:INFO, :methods => 'info', :default => true)
@@ -259,6 +259,6 @@ module Sawmill
     add(:FATAL, :methods => 'fatal')
     add(:ANY, :methods => ['any', 'unknown'])
   end
-  
-  
+
+
 end

data/lib/sawmill/log_record_middleware.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Sawmill logger class
-# 
+#
 # -----------------------------------------------------------------------------
 # Copyright 2009 Daniel Azuma
-# 
+#
 # All rights reserved.
-# 
+#
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
-# 
+#
 # * Redistributions of source code must retain the above copyright notice,
 #   this list of conditions and the following disclaimer.
 # * Redistributions in binary form must reproduce the above copyright notice,
@@ -18,7 +18,7 @@
 # * Neither the name of the copyright holder, nor the names of any other
 #   contributors to this software, may be used to endorse or promote products
 #   derived from this software without specific prior written permission.
-# 
+#
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
@@ -35,21 +35,21 @@
 
 
 module Sawmill
-  
-  
+
+
   # A Rack middleware that starts and ends a log record.
   # Insert this in your Rack stack to wrap requests in a log record.
-  
+
   class LogRecordMiddleware
-    
-    
+
+
     # Create a middleware object for Rack.
-    # 
+    #
     # If you do not provide a logger object, one will be generated for you
     # that simply logs to STDOUT.
-    # 
+    #
     # Recognized options include:
-    # 
+    #
     # [<tt>:request_id_key</tt>]
     #   The name of a rack environment key where the request ID should be
     #   stored. If not specified, defaults to "sawmill.request_id".
@@ -68,7 +68,7 @@ module Sawmill
     # [<tt>:post_logger</tt>]
     #   A proc that is called at the end of the request, and passed the
     #   logger and the rack environment. Optional.
-    
+
     def initialize(app_, logger_=nil, opts_={})
       @app = app_
       @logger = logger_ || Logger.new(:progname => 'rack', :processor => Formatter.new(::STDOUT))
@@ -79,8 +79,8 @@ module Sawmill
       @pre_logger = opts_[:pre_logger]
       @post_logger = opts_[:post_logger]
     end
-    
-    
+
+
     def call(env_)
       env_[@request_id_key] = @logger.begin_record
       start_time_ = ::Time.now.utc
@@ -106,9 +106,9 @@ module Sawmill
         @logger.end_record
       end
     end
-    
-    
+
+
   end
-  
-  
+
+
 end

data/lib/sawmill/logger.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Sawmill logger class
-# 
+#
 # -----------------------------------------------------------------------------
 # Copyright 2009 Daniel Azuma
-# 
+#
 # All rights reserved.
-# 
+#
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
-# 
+#
 # * Redistributions of source code must retain the above copyright notice,
 #   this list of conditions and the following disclaimer.
 # * Redistributions in binary form must reproduce the above copyright notice,
@@ -18,7 +18,7 @@
 # * Neither the name of the copyright holder, nor the names of any other
 #   contributors to this software, may be used to endorse or promote products
 #   derived from this software without specific prior written permission.
-# 
+#
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
@@ -38,19 +38,19 @@ require 'securerandom'
 
 
 module Sawmill
-  
-  
+
+
   # This is the Sawmill logger.
   # It duck-types most of the API of the logger class from the ruby
   # standard library, and adds capabilities specific to Sawmill.
-  
+
   class Logger
-    
-    
+
+
     # Create a new logger.
-    # 
+    #
     # Supported options include:
-    # 
+    #
     # [<tt>:level_group</tt>]
     #   Use a custom Sawmill::LevelGroup. Normally, you should leave this
     #   set to the default, which is Sawmill::STANDARD_LEVELS.
@@ -76,7 +76,7 @@ module Sawmill
     # [<tt>:processor</tt>]
     #   A processor for log entries generated by this logger.
     #   If not specified, log entries are written out to STDOUT.
-    
+
     def initialize(opts_={})
       @level_group = opts_[:level_group] || opts_[:levels] || STANDARD_LEVELS
       @level = @level_group.get(opts_[:level])
@@ -91,11 +91,11 @@ module Sawmill
       @processor = opts_[:processor] || Formatter.new(::STDOUT)
       @current_record_id = nil
     end
-    
-    
+
+
     # Emit a log message. This method has the same behavior as the
     # corresponding method in ruby's logger class.
-    
+
     def add(level_, message_=nil, progname_=nil, &block_)
       level_obj_ = @level_group.get(level_)
       if level_obj_.nil?
@@ -124,58 +124,58 @@ module Sawmill
       true
     end
     alias_method :log, :add
-    
-    
+
+
     def to_s  # :nodoc:
       inspect
     end
-    
+
     def inspect  # :nodoc:
       "#<#{self.class}:0x#{object_id.to_s(16)} progname=#{@progname.inspect} level=#{@level.name}>"
     end
-    
-    
+
+
     # Emits an "unknown" log entry. This is equivalent to the corresponding
     # method in ruby's logger class, which dumps the given string to the log
     # device without any formatting. Normally, you would not use this method
     # because it bypasses the log formatting and parsing capability.
-    
+
     def <<(message_)
       add(@level_group.default, message_)
     end
-    
-    
+
+
     # Emits a begin_record log entry. This begins a new log record.
-    # 
+    #
     # If you pass a string ID, that ID is used as the record ID for the new
     # log record. If you leave it as nil, an ID is generated for you, using
     # the record id generator for this logger. In either case, the record ID
     # for the new record is returned.
-    # 
+    #
     # If you call this when a record is already open, the current record is
     # automatically closed before the new record is opened. That is, an
     # end_record is implicitly called in this case.
-    
+
     def begin_record(id_=nil)
       end_record if @current_record_id
       @current_record_id = (id_ || @record_id_generator.call).to_s
       @processor.begin_record(Entry::BeginRecord.new(@level_group.highest, ::Time.now, @record_progname || @progname, @current_record_id))
       @current_record_id
     end
-    
-    
+
+
     # Returns the record ID for the currently open log record, or nil if
     # there is not a log record currently open.
-    
+
     def current_record_id
       @current_record_id
     end
-    
-    
+
+
     # Ends the current log record by emitting an end_record log entry, if
     # a record is currently open. Returns the record ID of the ended log
     # record if one was open, or nil if no log record was open.
-    
+
     def end_record
       if @current_record_id
         @processor.end_record(Entry::EndRecord.new(@level_group.highest, ::Time.now, @record_progname || @progname, @current_record_id))
@@ -186,17 +186,17 @@ module Sawmill
         nil
       end
     end
-    
-    
+
+
     # Emits an attribute log entry in the current record.
     # You must specify a key and a value as strings, and an operation.
     # The operation defaults to <tt>:set</tt> if not specified.
-    # 
+    #
     # If you specify a level, it will be used; otherwise the logger's
     # default attribute level is used.
     # Raises Errors::UnknownLevelError if you specify a level that doesn't
     # exist.
-    
+
     def attribute(key_, value_, operation_=nil, level_=true, progname_=nil)
       if level_ == true
         level_obj_ = @attribute_level
@@ -210,73 +210,73 @@ module Sawmill
       @processor.attribute(Entry::Attribute.new(level_obj_, ::Time.now, progname_ || @record_progname || @progname, @current_record_id, key_, value_, operation_))
       true
     end
-    
-    
+
+
     # Emits a set-attribute log entry in the current record.
     # You must specify a key and a value as strings.
-    
+
     def set_attribute(key_, value_)
       attribute(key_, value_, :set)
     end
-    
-    
+
+
     # Emits an append-attribute log entry in the current record.
     # You must specify a key and a value as strings.
-    
+
     def append_attribute(key_, value_)
       attribute(key_, value_, :append)
     end
-    
-    
+
+
     # Close the logger by finishing the log entry processor to which it is
     # emitting log entries. Returns the value returned by the processor's
     # finish method.
-    
+
     def close
       @processor.finish
     end
-    
-    
+
+
     # Get the current progname setting for this logger
-    
+
     def progname
       @progname
     end
-    
-    
+
+
     # Set the current progname setting for this logger
-    
+
     def progname=(value_)
       @progname = value_.to_s.gsub(/\s+/, '')
     end
-    
-    
+
+
     # Get the current record progname setting for this logger
-    
+
     def record_progname
       @record_progname
     end
-    
-    
+
+
     # Set the current record progname setting for this logger
-    
+
     def record_progname=(value_)
       @record_progname = value_.to_s.gsub(/\s+/, '')
     end
-    
-    
+
+
     # Get the current level setting for this logger as a Sawmill::Level.
-    
+
     def level
       @level
     end
-    
-    
+
+
     # Set the current level setting for this logger.
     # You may specify the level as a string, a symbol, an integer, or a
     # Sawmill::Level. Ruby's logger constants such as ::Logger::INFO
     # will also work.
-    
+
     def level=(value_)
       if value_.kind_of?(Level)
         @level = value_
@@ -288,24 +288,24 @@ module Sawmill
         @level = level_obj_
       end
     end
-    
+
     alias_method :sev_threshold=, :level=
     alias_method :sev_threshold, :level
-    
-    
+
+
     # Get the current attribute level setting for this logger as a
     # Sawmill::Level.
-    
+
     def attribute_level
       @attribute_level
     end
-    
-    
+
+
     # Set the current attribute level setting for this logger.
     # You may specify the level as a string, a symbol, an integer, or a
     # Sawmill::Level. Ruby's logger constants such as ::Logger::INFO
     # will also work.
-    
+
     def attribute_level=(value_)
       if value_.kind_of?(Level)
         @attribute_level = value_
@@ -317,47 +317,47 @@ module Sawmill
         @attribute_level = level_obj_
       end
     end
-    
-    
+
+
     # Get the LevelGroup in use by this Logger. This setting cannot be
     # changed once the logger is constructed.
-    
+
     def level_group
       @level_group
     end
-    
-    
+
+
     # Provide a block that generates and returns a unique record ID string.
     # This block will be called when begin_record is called without an
     # explicit ID provided. If you do not provide a block, Sawmill will use
     # a default generator which uses the variant 4 (random) UUID standard.
-    
+
     def to_generate_record_id(&block_)
       @record_id_generator = block_ || Logger._get_default_record_id_generator
     end
-    
-    
+
+
     # You may call additional methods on the logger as shortcuts to log
     # messages at specific levels, or to query whether the logger is logging
     # to a given level. These methods match the corresponding methods in the
     # classic ruby logger object, except that they are configurable for
     # custom level schemes.
-    # 
+    #
     # For example, in the standard level scheme, the method "info" is
     # defined, so you may call:
-    # 
+    #
     #   logger.info("MainApp") { "Received connection from #{ip}" }
     #   # ...
     #   logger.info "Waiting for input from user"
     #   # ...
     #   logger.info { "User typed #{input}" }
-    # 
+    #
     # You may also call:
-    # 
+    #
     #   logger.info?  # Returns true if INFO messages are accepted
-    # 
+    #
     # Methods available in the standard level scheme are as follows:
-    # 
+    #
     # * <tt>debug</tt>
     # * <tt>info</tt>
     # * <tt>warn</tt>
@@ -365,11 +365,11 @@ module Sawmill
     # * <tt>fatal</tt>
     # * <tt>unknown</tt>
     # * <tt>any</tt>
-    # 
+    #
     # The "unknown" and "any" methods both correspond to the +ANY+ level.
     # The latter is the preferred name under Sawmill. The former is for
     # backward compatibility with ruby's classic logger.
-    
+
     def method_missing(method_, *args_, &block_)
       method_name_ = method_.to_s
       question_ = method_name_[-1..-1] == '?'
@@ -382,8 +382,8 @@ module Sawmill
         add(level_, nil, args_[0], &block_)
       end
     end
-    
-    
+
+
     def self._get_default_record_id_generator  # :nodoc:
       @_default_generator ||= ::Proc.new do
         uuid_ = ::SecureRandom.hex(16)
@@ -396,9 +396,9 @@ module Sawmill
         uuid_
       end
     end
-    
-    
+
+
   end
-  
-  
+
+
 end