sawmill 0.1.15 → 0.1.16

data/lib/sawmill/entry_processor/count_entries.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Sawmill entry processor that generates reports
-# 
+#
 # -----------------------------------------------------------------------------
 # 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,19 +35,19 @@
 
 
 module Sawmill
-  
+
   module EntryProcessor
-    
-    
+
+
     # This processor reports the number of entries processed.
-    
+
     class CountEntries < Base
-      
-      
+
+
       # Create a count-entries report.
-      # 
+      #
       # Recognized options include:
-      # 
+      #
       # [<tt>:label</tt>]
       #   Label to use for the report.
       #   If provided, the report is returned as a string of the form
@@ -62,7 +62,7 @@ module Sawmill
       # [<tt>:omit_record_delimiters</tt>]
       #   If set to true, omits begin_record and end_record from the count.
       #   Default is false.
-      
+
       def initialize(opts_={})
         @label = opts_[:label]
         @omit_unknown_data = opts_[:omit_unknown_data]
@@ -71,42 +71,42 @@ module Sawmill
         @finished = false
         @count = 0
       end
-      
-      
+
+
       def begin_record(entry_)
         @count += 1 unless @finished || @omit_record_delimiters
         true
       end
-      
+
       def end_record(entry_)
         @count += 1 unless @finished || @omit_record_delimiters
         true
       end
-      
+
       def message(entry_)
         @count += 1 unless @finished
         true
       end
-      
+
       def attribute(entry_)
         @count += 1 unless @finished || @omit_attributes
         true
       end
-      
+
       def unknown_data(entry_)
         @count += 1 unless @finished || @omit_unknown_data
         true
       end
-      
+
       def finish
         @finished = true
         @label ? "#{@label}#{@count}" : @count
       end
-      
-      
+
+
     end
-    
-    
+
+
   end
-  
+
 end

data/lib/sawmill/entry_processor/filter_by_basic_fields.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Sawmill entry processor that checks for entry field values.
-# 
+#
 # -----------------------------------------------------------------------------
 # 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,23 +35,23 @@
 
 
 module Sawmill
-  
+
   module EntryProcessor
-    
-    
+
+
     # A basic filter that knows how to check level and progname.
-    # 
+    #
     # This is a boolean processor, so it merely returns true or false based
     # on the filter result. Use this in conjunction with an If processor to
     # actually perform other actions based on the result.
-    
+
     class FilterByBasicFields < Base
-      
-      
+
+
       # Create a new filter.
-      # 
+      #
       # Recognized options include:
-      # 
+      #
       # [<tt>:level</tt>]
       #   Lowest level that will be accepted. This should be either a
       #   Sawmill::Level object or an integer value or string/symbol that
@@ -77,7 +77,7 @@ module Sawmill
       # [<tt>:accept_unknown</tt>]
       #   If set to true, accepts all entries of type :unknown_data.
       #   Otherwise, rejects all such entries.
-      
+
       def initialize(opts_={})
         @level = opts_[:level]
         @progname = opts_[:progname]
@@ -86,36 +86,36 @@ module Sawmill
         @accept_incomparable_levels = opts_[:accept_incomparable_levels]
         @accept_unknown = opts_[:accept_unknown]
       end
-      
-      
+
+
       def begin_record(entry_)
         @accept_record_delimiters.nil? ? _check_filter(entry_) : @accept_record_delimiters
       end
-      
+
       def end_record(entry_)
         @accept_record_delimiters.nil? ? _check_filter(entry_) : @accept_record_delimiters
       end
-      
+
       def message(entry_)
         _check_filter(entry_)
       end
-      
+
       def attribute(entry_)
         @accept_attributes.nil? ? _check_filter(entry_) : @accept_attributes
       end
-      
+
       def unknown_data(entry_)
         @accept_unknown
       end
-      
+
       def finish
         nil
       end
-      
-      
+
+
       private
-      
-      
+
+
       def _check_filter(entry_)  # :nodoc:
         if @level
           level_ = entry_.level
@@ -135,11 +135,11 @@ module Sawmill
         return false if @progname && entry_.progname != @progname
         true
       end
-      
-      
+
+
     end
-    
-    
+
+
   end
-  
+
 end

data/lib/sawmill/entry_processor/filter_by_block.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Sawmill entry processor that calls a block
-# 
+#
 # -----------------------------------------------------------------------------
 # 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,62 +35,62 @@
 
 
 module Sawmill
-  
+
   module EntryProcessor
-    
-    
+
+
     # A entry filter that calls a block to perform its check.
-    # 
+    #
     # This is a boolean processor, so it merely returns true or false based
     # on the filter result. Use this in conjunction with an If processor to
     # actually perform other actions based on the result.
-    
+
     class FilterByBlock < Base
-      
-      
+
+
       # Create a new filter. Provide the block, which should take an entry
       # object as the parameter and return a boolean.
-      
+
       def initialize(&block_)
         to_filter_entry(&block_)
       end
-      
-      
+
+
       # Provide a block to filter entries. It should take an entry object
       # as the parameter, and return a boolean.
-      
+
       def to_filter_entry(&block_)
         @block = block_ || Proc.new{ |entry_| false }
       end
-      
-      
+
+
       def begin_record(entry_)
         @block.call(entry_)
       end
-      
+
       def end_record(entry_)
         @block.call(entry_)
       end
-      
+
       def message(entry_)
         @block.call(entry_)
       end
-      
+
       def attribute(entry_)
         @block.call(entry_)
       end
-      
+
       def unknown_data(entry_)
         @block.call(entry_)
       end
-      
+
       def finish
         nil
       end
-      
+
     end
-    
-    
+
+
   end
-  
+
 end

data/lib/sawmill/entry_processor/format.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Sawmill entry processor that formats for log files
-# 
+#
 # -----------------------------------------------------------------------------
 # 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,23 +35,23 @@
 
 
 module Sawmill
-  
+
   module EntryProcessor
-    
-    
+
+
     # This processor formats log entries and writes them to a destination.
-    
+
     class Format < Base
-      
-      
+
+
       # Create a formatter.
-      # 
+      #
       # The destination can be a ruby IO object, a Sawmill::Rotater, or any
       # object that responds to the "write" and "close" methods as defined
       # by the ruby IO class.
-      # 
+      #
       # Recognized options include:
-      # 
+      #
       # [<tt>:include_id</tt>]
       #   Include the record ID in every log entry. Default is false.
       # [<tt>:fractional_second_digits</tt>]
@@ -68,16 +68,19 @@ module Sawmill
       # [<tt>:length_limit</tt>]
       #   Limit to the entry length. Entries are truncated to this length
       #   when written. If not specified, entries are not truncated.
-      
+
       def initialize(destination_, opts_={})
         if destination_.kind_of?(Rotater)
           @rotater = destination_
           @channels = {}
           @standby_channel = nil
-        elsif destination_.respond_to?(:close) && destination_.respond_to?(:write)
-          @io = destination_
         else
-          raise ::ArgumentError, "Unknown destination type"
+          @rotater = nil
+          if destination_.respond_to?(:close) && destination_.respond_to?(:write)
+            @io = destination_
+          else
+            raise ::ArgumentError, "Unknown destination type"
+          end
         end
         @include_id = opts_[:include_id]
         @fractional_second_digits = (opts_[:fractional_second_digits] || 2).to_i
@@ -87,9 +90,11 @@ module Sawmill
         (6 - @fractional_second_digits).times{ @usec_factor *= 10 }
         @level_width = opts_[:level_width]
         @length_limit = opts_[:length_limit]
+        @local_time = opts_[:local_time]
+        @iso_8601_time = opts_[:iso_8601_time]
       end
-      
-      
+
+
       def begin_record(entry_)
         return false unless @io || @rotater
         record_id_ = entry_.record_id
@@ -108,7 +113,7 @@ module Sawmill
         io_.write(_format_entry(entry_, '^', "BEGIN #{record_id_}"))
         true
       end
-      
+
       def end_record(entry_)
         return false unless @io || @rotater
         record_id_ = entry_.record_id
@@ -127,13 +132,13 @@ module Sawmill
         end
         true
       end
-      
+
       def message(entry_)
         return false unless @io || @rotater
         _write_str(_format_entry(entry_, '.', entry_.message), entry_.record_id)
         true
       end
-      
+
       def attribute(entry_)
         return false unless @io || @rotater
         opcode_ = entry_.operation == :append ? '+' : '='
@@ -141,13 +146,13 @@ module Sawmill
         _write_str(str_, entry_.record_id)
         true
       end
-      
+
       def unknown_data(entry_)
         return false unless @io || @rotater
         _write_str(entry_.line+"\n", nil)
         true
       end
-      
+
       def finish
         if @rotater
           @default_channel.close
@@ -159,9 +164,9 @@ module Sawmill
         end
         nil
       end
-      
+
       private
-      
+
       def _write_str(str_, record_id_)  # :nodoc:
         if @rotater
           io_ = @channels[record_id_]
@@ -176,7 +181,7 @@ module Sawmill
           @io.write(str_)
         end
       end
-      
+
       def _format_entry(entry_, marker_, str_)  # :nodoc:
         id_ = @include_id ? entry_.record_id : nil
         id_ = id_ ? ' '+id_ : ''
@@ -222,16 +227,16 @@ module Sawmill
         end
         "[#{levelstr_} #{timestr_} #{entry_.progname}#{id_} #{marker_}] #{str_}\n"
       end
-      
+
     end
-    
-    
+
+
   end
-  
-  
+
+
   # Sawmill::Formatter is an alternate name for
   # Sawmill::EntryProcessor::Format
   Formatter = EntryProcessor::Format
-  
-  
+
+
 end