sawmill 0.1.15 → 0.1.16

data/lib/sawmill/record_processor/format.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Sawmill record 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 RecordProcessor
-    
-    
+
+
     # This processor formats log records 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>]
@@ -62,7 +62,7 @@ module Sawmill
       # [<tt>:entry_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 (entry_length_limit_ = opts_.delete(:entry_length_limit))
           opts_ = opts_.merge(:length_limit => entry_length_limit_)
@@ -70,25 +70,25 @@ module Sawmill
         @formatter = EntryProcessor::Format.new(destination_, opts_)
         @classifier = EntryClassifier.new(@formatter)
       end
-      
-      
+
+
       def record(record_)
         record_.each_entry{ |entry_| @classifier.entry(entry_) }
         true
       end
-      
+
       def extra_entry(entry_)
         @classifier.entry(entry_)
         true
       end
-      
+
       def finish
         @formatter.finish
       end
-      
+
     end
-    
-    
+
+
   end
-  
+
 end

data/lib/sawmill/record_processor/simple_queue.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Sawmill record processor queues log records
-# 
+#
 # -----------------------------------------------------------------------------
 # 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
-  
-  
+
+
   module RecordProcessor
-    
-    
+
+
     # This processor simply queues up log records for later use.
-    
+
     class SimpleQueue < Base
-      
-      
+
+
       # Create a queue. This processor actually maintains two separate
       # queues, one for records and another for extra entries.
-      # 
+      #
       # Recognized options include:
-      # 
+      #
       # [<tt>:limit</tt>]
       #   Size limit for the queue. If not specified, the queue can grow
       #   arbitrarily large.
@@ -57,76 +57,76 @@ module Sawmill
       #   If set to true, then when an item is added to a full queue, the
       #   oldest item is dropped. If set to false or not specified, then
       #   the new item is not added.
-      
+
       def initialize(opts_={})
         @queue = Util::Queue.new(opts_)
         @extra_entries_queue = Util::Queue.new(opts_)
         @closed = false
       end
-      
-      
+
+
       # Return the oldest record in the record queue, or nil if the record
       # queue is empty.
-      
+
       def dequeue
         @queue.dequeue
       end
-      
-      
+
+
       # Return an array of the contents of the record queue, in order.
-      
+
       def dequeue_all
         @queue.dequeue_all
       end
-      
-      
+
+
       # Return the number of records in the record queue.
-      
+
       def size
         @queue.size
       end
-      
-      
+
+
       # Return the oldest entry in the extra entry queue, or nil if the
       # extra entry queue is empty.
-      
+
       def dequeue_extra_entry
         @extra_entries_queue.dequeue
       end
-      
-      
+
+
       # Return an array of the contents of the extra entry queue, in order.
-      
+
       def dequeue_all_extra_entries
         @extra_entries_queue.dequeue_all
       end
-      
-      
+
+
       # Return the number of entries in the extra entry queue.
-      
+
       def extra_entries_size
         @extra_entries_queue.size
       end
-      
-      
+
+
       def record(record_)
         @queue.enqueue(record_) unless @closed
       end
-      
+
       def extra_entry(entry_)
         @extra_entries_queue.enqueue(entry_) unless @closed
       end
-      
+
       def finish
         @closed = true
         nil
       end
-      
-      
+
+
     end
-    
-    
+
+
   end
-  
-  
+
+
 end

data/lib/sawmill/rotater.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Sawmill log rotation utility
-# 
+#
 # -----------------------------------------------------------------------------
 # 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,16 +38,16 @@ require 'monitor'
 
 
 module Sawmill
-  
-  
+
+
   # The Sawmill Rotater provides log rotation services for logfile
   # formatting, supporting several different log rotation strategies.
-  # 
+  #
   # The formatter implemented by Sawmill::EntryProcessor::Format already
   # recognizes a Rotater as a supported destination, and automatically
   # interfaces with it to ensure that log records aren't split into
   # multiple files by rotation.
-  # 
+  #
   # You may also interface with a rotater manually. The core of rotater
   # usage is the Channel, which lets you ensure that groups of log
   # entries end up in the same log file regardless of log rotation.
@@ -56,23 +56,23 @@ module Sawmill
   # where the allowable file breaks are, or by letting the rotater
   # break the file anywhere it wants. See the create_channel method
   # and the Channel object for more details.
-  
+
   class Rotater
-    
+
     # :stopdoc:
     SUPPORTS_ENCODING = defined?(::Encoding)
     ENCODING_OPTS = {:invalid => :replace, :undef => :replace}
     # :startdoc:
-    
-    
+
+
     # Create a rotater using the given rotation strategy.
     # See Sawmill::Rotater::DateBasedLogFile and
     # Sawmill::Rotater::ShiftingLogFile for examples of common strategies.
-    # 
+    #
     # The rotation strategy can be passed as an object or as a class with a
     # set of options that will be used to instantiate the strategy.
     # In addition to those options, the following options are recognized:
-    # 
+    #
     # [<tt>:omit_directives</tt>]
     #   If true, omit standard logfile directives. Default is false.
     # [<tt>:concurrent_writes</tt>]
@@ -85,7 +85,7 @@ module Sawmill
     #   Specify an encoding for file data. (Ruby 1.9 only).
     #   You may pass either an encoding object or an encoding name.
     #   If not specified, writes raw bytes (e.g. defaults to ASCII-8BIT).
-    
+
     def initialize(io_manager_, opts_={})
       @omit_directives = opts_.delete(:omit_directives)
       @concurrent_writes = opts_.delete(:concurrent_writes)
@@ -103,24 +103,24 @@ module Sawmill
       @handles ||= {}
       @mutex ||= ::Monitor.new
     end
-    
-    
+
+
     # Create a new Channel for this Rotater. See Sawmill::Rotater::Channel
     # for details on the Channel object.
-    # 
+    #
     # The following options are recognized:
-    # 
+    #
     # [<tt>:auto_rotate</tt>]
     #   Put the channel in auto-rotate mode. In this mode, the rotater is
     #   allowed to rotate the logfile at any time for that channel. It is
     #   the equivalent of calling check_rotate on the channel after every
     #   write. Default is false.
-    
+
     def create_channel(opts_={})
       Channel.new(self, opts_)
     end
-    
-    
+
+
     def _write_to_stream(io_, str_)  # :nodoc:
       if SUPPORTS_ENCODING && @encoding
         str_ = str_.encode(@encoding, ENCODING_OPTS)
@@ -136,8 +136,8 @@ module Sawmill
         io_.write(str_)
       end
     end
-    
-    
+
+
     def _obtain_handle  # :nodoc:
       handle_ = @io_manager.preferred_handle
       if @handles.include?(handle_)
@@ -155,8 +155,8 @@ module Sawmill
       end
       handle_
     end
-    
-    
+
+
     def _release_handle(handle_)  # :nodoc:
       info_ = @handles[handle_]
       info_[2] -= 1
@@ -166,8 +166,8 @@ module Sawmill
       end
       nil
     end
-    
-    
+
+
     def _check_rotate_handle(handle_)  # :nodoc:
       if handle_ != @io_manager.preferred_handle
         _release_handle(handle_)
@@ -176,15 +176,15 @@ module Sawmill
         handle_
       end
     end
-    
-    
+
+
     def _do_open  # :nodoc:
       @mutex.synchronize do
         _obtain_handle
       end
     end
-    
-    
+
+
     def _do_write(handle_, str_, auto_rotate_)  # :nodoc:
       @mutex.synchronize do
         @io_manager.before_write
@@ -196,84 +196,84 @@ module Sawmill
         handle_
       end
     end
-    
-    
+
+
     def _do_close(handle_)  # :nodoc:
       @mutex.synchronize do
         _release_handle(handle_)
       end
     end
-    
-    
+
+
     def _do_check_rotate(handle_)  # :nodoc:
       @mutex.synchronize do
         _check_rotate_handle(handle_)
       end
     end
-    
-    
+
+
     # A channel is a lightweight object that responds to the write and close
     # methods; that is, it is sufficient for Sawmill::Formatter.
-    # 
+    #
     # When a channel is opened, it locks down a path to the logfile and
     # ensures that the logfile will not rotate out from under it; that is,
     # writes to a channel are ensured to end up in the same physical file.
-    # 
+    #
     # You may choose, at intervals, to explicitly tell the channel that it
     # is okay to rotate the logfile now, by calling check_rotate.
-    # 
+    #
     # You must close a channel when you are done with it. Closing a channel
     # does not close the underlying logfile, but instead tells the rotater
     # that you are done with this channel and that the logfile is free to
     # rotate independent of it.
-    # 
+    #
     # You may have any number of channels open at any time, each on a
     # different rotation schedule. Each may possibly be writing to different
     # files in the rotation at any time, but this is all done automatically
     # behind the scenes.
-    
+
     class Channel
-      
+
       def initialize(rotater_, opts_={})  # :nodoc:
         @rotater = rotater_
         @auto_rotate = opts_[:auto_rotate]
         @io_handle = @rotater._do_open
       end
-      
-      
+
+
       # Write a string to this channel.
-      
+
       def write(str_)
         if @io_handle
           @rotater._do_write(@io_handle, str_, @auto_rotate)
         end
       end
-      
-      
+
+
       # Close this channel, telling the rotater that this channel no longer
       # needs to constrain the log rotation.
-      
+
       def close
         if @io_handle
           @rotater._do_close(@io_handle)
           @io_handle = nil
         end
       end
-      
-      
+
+
       # Manually tell the rotater that this channel is at a stopping point
       # and that the log file may rotate at this time.
-      
+
       def check_rotate
         if @io_handle
           @io_handle = @rotater._do_check_rotate(@io_handle)
         end
       end
-      
-      
+
+
     end
-    
-    
+
+
   end
-  
+
 end