sawmill 0.1.15 → 0.1.16

data/lib/sawmill/rotater/base.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Sawmill formatter 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
@@ -35,56 +35,56 @@
 
 
 module Sawmill
-  
+
   class Rotater
-    
-    
+
+
     # This class defines the rotation strategy contract. Classes that
     # implement rotation strategies need not subclass this base class, but
     # must implement the methods defined here.
-    # 
+    #
     # This base class itself merely writes to STDOUT and does not do
     # any rotation.
-    
+
     class Base
-      
-      
+
+
       # Return the currently preferred handle, identifying which io stream
       # should be written to preferentially unless a channel is constrained
       # to use an earlier stream.
-      
+
       def preferred_handle
         0
       end
-      
-      
+
+
       # Open and return an IO object for the given handle.
       # This is guaranteed not to be called twice unless the stream has been
       # closed in the meantime.
-      
+
       def open_handle(handle_)
         ::STDOUT
       end
-      
-      
+
+
       # Close the IO object for the given handle.
       # This is guaranteed not be called unless the stream has been opened.
-      
+
       def close_handle(handle_, io_)
       end
-      
-      
+
+
       # This is a hook that is called before every write request to any
       # stream managed by this rotater. You may optionally perform any
       # periodic tasks here, such as renaming log files.
-      
+
       def before_write
       end
-      
-      
+
+
     end
-    
-    
+
+
   end
-  
+
 end

data/lib/sawmill/rotater/date_based_log_file.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Sawmill formatter 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
@@ -35,35 +35,35 @@
 
 
 module Sawmill
-  
+
   class Rotater
-    
-    
+
+
     # A rotation strategy that produces log files with the date stamp in the
     # file name. For example, you could set up an hourly log rotation that
     # produces the following files:
-    # 
+    #
     #  rails.2009-10-09-22.log
     #  rails.2009-10-09-23.log
     #  rails.2009-10-10-00.log
     #  rails.2009-10-10-01.log
     #  etc...
-    # 
+    #
     # The exact format depends on the rotation frequency, which could be
     # anywhere from yearly to hourly. For settings less frequent than
     # hourly, fewer fields will appear in the date stamp portion of the
     # file name.
-    
+
     class DateBasedLogFile
-      
-      
+
+
       # Create a new date-based log file rotation strategy.
-      # 
+      #
       # Recognized options include:
-      # 
+      #
       # [<tt>:turnover_frequency</tt>]
       #   How often the log files should turn over. Allowed values are:
-      #   <tt>:yearly</tt>, <tt>:monthly</tt>, <tt>:daily</tt>, 
+      #   <tt>:yearly</tt>, <tt>:monthly</tt>, <tt>:daily</tt>,
       #   <tt>:hourly</tt>, and <tt>:never</tt>.
       # [<tt>:basedir</tt>]
       #   The base directory used if the filepath is a relative path.
@@ -86,16 +86,16 @@ module Sawmill
       # [<tt>:local_datestamps</tt>]
       #   If true, use the local timezone to create datestamps.
       #   The default is to use UTC.
-      # 
+      #
       # === Uniquifiers
-      # 
+      #
       # DateBasedLogFile provides a facility for ensuring that log files
       # are written to by only one process, by generating unique file
       # names for log files. This facility is useful, for example, if you
       # are deploying via Phusion Passenger where you may have a variable
       # number of rails processes, and you want each process to own its
       # own logfile so entries in log records are not interleaved.
-      # 
+      #
       # To activate this feature, pass a proc to the <tt>:uniquifier</tt>
       # option. When DateBasedLogFile wants to open a log file for
       # writing, it first calls this proc. The proc should return a file
@@ -105,13 +105,13 @@ module Sawmill
       # the file already exists, the proc will be called again, and
       # repeatedly until it either returns a path that has not yet been
       # created, or nil indicating that it has given up.
-      # 
+      #
       # The proc is passed a single hash that provides information about
       # what path to generate, as well as space for the proc to store any
       # state it wishes to persist through the process. These keys are
       # given to the proc by DateBasedLogFile. Any other keys are
       # available for use by the proc.
-      # 
+      #
       # [<tt>:original_path</tt>]
       #   The original file path generated by DateBasedLogFile, which
       #   would have been used if there were no uniquifier.
@@ -124,7 +124,7 @@ module Sawmill
       #   The path_prefix of the DateBasedLogFile.
       # [<tt>:path_suffix</tt>]
       #   The path_suffix of the DateBasedLogFile.
-      
+
       def initialize(options_)
         @turnover_frequency = options_[:turnover_frequency] || :none
         @basedir = options_[:basedir] || options_[:dirname] || ::Dir.getwd
@@ -142,10 +142,10 @@ module Sawmill
           else nil
           end
       end
-      
-      
+
+
       # Implements the rotation strategy contract.
-      
+
       def preferred_handle
         if @date_pattern
           time_ = ::Time.now
@@ -155,10 +155,10 @@ module Sawmill
           ''
         end
       end
-      
-      
+
+
       # Implements the rotation strategy contract.
-      
+
       def open_handle(handle_)
         path_ = ::File.expand_path(@date_pattern ? "#{@prefix}.#{handle_}#{@suffix}" : @prefix+@suffix, @basedir)
         file_ = nil
@@ -181,35 +181,35 @@ module Sawmill
         file_.sync = true
         file_
       end
-      
-      
+
+
       # Implements the rotation strategy contract.
-      
+
       def close_handle(handle_, io_)
         io_.close
       end
-      
-      
+
+
       # Implements the rotation strategy contract.
-      
+
       def before_write
       end
-      
-      
+
+
       class << self
-        
-        
+
+
         # Returns a simple uniquifier that inserts an incrementing number
         # before the path suffix. i.e. if the non-uniquified filename is
         # "rails.2009-10-11.log", then these names are generated:
-        # 
+        #
         #  rails.2009-10-11.0.log
         #  rails.2009-10-11.1.log
         #  rails.2009-10-11.2.log
         #  etc.
-        # 
+        #
         # The following options are available:
-        # 
+        #
         # [<tt>:min_digits</tt>]
         #   If provided, indicates the minimum number of digits for the
         #   unique number. For example, if :digits is set to 2, these
@@ -229,7 +229,7 @@ module Sawmill
         #   The default is 1.
         # [<tt>:start_value</tt>]
         #   The first value for the unique number. Default is 0.
-        
+
         def simple_uniquifier(opts_={})
           if (digits_ = opts_[:min_digits])
             pattern_ = "%s.%0#{digits_.to_i}d%s"
@@ -257,14 +257,14 @@ module Sawmill
             pattern_ % [hash_[:pre], hash_[:value], hash_[:post]]
           end
         end
-        
-        
+
+
       end
-      
-      
+
+
     end
-    
-    
+
+
   end
-  
+
 end

data/lib/sawmill/rotater/shifting_log_file.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Sawmill formatter 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
@@ -35,10 +35,10 @@
 
 
 module Sawmill
-  
+
   class Rotater
-    
-    
+
+
     # A rotation strategy that "shifts" log files by appending index numbers
     # to the filename when the file reaches a certain size or age. So when
     # the file "foo.log" is ready to rotate, it is renamed "foo.log.0", and
@@ -48,14 +48,14 @@ module Sawmill
     # logfile is always the one with the largest number suffix, and the
     # file currently being written to has no suffix.
     # This is a common rotation strategy for many unix tools.
-    
+
     class ShiftingLogFile
-      
-      
+
+
       # Create a new shifting log file rotation strategy.
-      # 
+      #
       # Recognized options include:
-      # 
+      #
       # [<tt>:basedir</tt>]
       #   The base directory used if the filepath is a relative path.
       #   If not specified, the current working directory is used.
@@ -69,14 +69,14 @@ module Sawmill
       # [<tt>:shift_period</tt>]
       #   A logfile will try to rotate once it has been in service for
       #   this many seconds. This parameter also recognizes the values
-      #   <tt>:yearly</tt>, <tt>:monthly</tt>, <tt>:daily</tt>, 
+      #   <tt>:yearly</tt>, <tt>:monthly</tt>, <tt>:daily</tt>,
       #   and <tt>:hourly</tt>. If not specified, the file's age is
       #   not checked.
       # [<tt>:history_size</tt>]
       #   The maximum number of old logfiles (files with indexes) to
       #   keep. Files beyond this history size will be automatically
       #   deleted. Default is 1. This value must be at least 1.
-      
+
       def initialize(options_)
         @max_logfile_size = options_[:max_file_size] || options_[:max_logfile_size]
         @shift_period = options_[:shift_period]
@@ -92,23 +92,23 @@ module Sawmill
         end
         @history_size = options_[:history_size].to_i
         @history_size = 1 if @history_size < 1 && (@max_logfile_size || @shift_period)
-        @normal_path = ::File.expand_path(options_[:file_path] || options_[:filepath] || 'sawmill.log', 
+        @normal_path = ::File.expand_path(options_[:file_path] || options_[:filepath] || 'sawmill.log',
                                           options_[:basedir] || ::Dir.getwd)
         @preferred_handle = 0
         @open_handles = {}
         @last_shift = ::Time.now
       end
-      
-      
+
+
       # Implements the rotation strategy contract.
-      
+
       def preferred_handle
         @preferred_handle
       end
-      
-      
+
+
       # Implements the rotation strategy contract.
-      
+
       def open_handle(handle_)
         if handle_ == @preferred_handle
           path_ = @normal_path
@@ -120,10 +120,10 @@ module Sawmill
         @open_handles[handle_] = true
         file_
       end
-      
-      
+
+
       # Implements the rotation strategy contract.
-      
+
       def close_handle(handle_, io_)
         io_.close
         if @preferred_handle - handle_ > @history_size
@@ -132,10 +132,10 @@ module Sawmill
         @open_handles.delete(handle_)
         nil
       end
-      
-      
+
+
       # Implements the rotation strategy contract.
-      
+
       def before_write
         return unless @max_logfile_size || @shift_period
         turnover_ = false
@@ -157,11 +157,11 @@ module Sawmill
           @last_shift = ::Time.now
         end
       end
-      
-      
+
+
     end
-    
-    
+
+
   end
-  
+
 end