sawmill 0.0.3 → 0.0.4

data/History.rdoc

@@ -1,3 +1,9 @@
+=== 0.0.4 / 2009-??-??
+
+* API CHANGE: Renamed DateBasedLogFile options :prefix and :suffix to :path_prefix and :path_suffix
+* API CHANGE: Renamed ShiftingLogFile options :filepath and :max_logfile_size to :file_path and :max_file_size
+* Encoding can now be specified in file reading and writing methods (Rotaters and convenience interface methods)
+
 === 0.0.3 / 2009-10-31
 
 * API CHANGE: Renamed processor close methods to "finish" and introduced return value semantics for passing "final" information back up the processor tree.

data/Rakefile

@@ -88,8 +88,8 @@ gemspec_ = ::Gem::Specification.new do |s_|
   s_.has_rdoc = true
   s_.test_files = ::FileList['tests/tc_*.rb']
   s_.platform = ::Gem::Platform::RUBY
-  s_.add_dependency('blockenspiel', '>= 0.2.2')
-  s_.add_dependency('versionomy', '>= 0.1.2')
+  s_.add_dependency('blockenspiel', '>= 0.3.0')
+  s_.add_dependency('versionomy', '>= 0.2.0')
 end
 ::Rake::GemPackageTask.new(gemspec_) do |task_|
   task_.need_zip = false

data/lib/sawmill/interface.rb

@@ -164,10 +164,13 @@ module Sawmill
     #   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.
+    # <tt>:encoding</tt>::
+    #   Specify an encoding name for file data. (Ruby 1.9 only)
+    #   If not specified, uses the default external encoding.
     
     def shifting_logfile(filepath_, period_, max_size_, opts_={})
-      rotater_ = Rotater.new(Rotater::ShiftingLogFile, opts_.merge(:filepath => filepath_,
-        :max_logfile_size => max_size_, :shift_period => period_))
+      rotater_ = Rotater.new(Rotater::ShiftingLogFile, opts_.merge(:file_path => filepath_,
+        :max_file_size => max_size_, :shift_period => period_))
       processor_ = EntryProcessor::Format.new(rotater_, opts_)
       Logger.new(opts_.merge(:processor => processor_))
     end
@@ -225,16 +228,19 @@ module Sawmill
     # <tt>:basedir</tt>::
     #   The base directory used if the filepath is a relative path.
     #   If not specified, the current working directory is used.
-    # <tt>:suffix</tt>::
-    #   The logfile name prefix.
+    # <tt>:name_suffix</tt>::
+    #   The logfile name suffix.
     #   In the filename "rails.2009-10-11.log", the suffix is ".log".
     #   If not specified, defaults to ".log".
     # <tt>:local_datestamps</tt>::
     #   If true, use the local timezone to create datestamps.
     #   The default is to use UTC.
+    # <tt>:encoding</tt>::
+    #   Specify an encoding name for file data. (Ruby 1.9 only)
+    #   If not specified, uses the default external encoding.
     
     def date_based_logfile(filepath_, frequency_, opts_={})
-      rotater_ = Rotater.new(Rotater::DateBasedLogFile, opts_.merge(:prefix => filepath_,
+      rotater_ = Rotater.new(Rotater::DateBasedLogFile, opts_.merge(:path_prefix => filepath_,
         :turnover_frequency => frequency_))
       processor_ = EntryProcessor::Format.new(rotater_, opts_)
       Logger.new(opts_.merge(:processor => processor_))
@@ -254,6 +260,17 @@ module Sawmill
     # <tt>:emit_incomplete_records_at_eof</tt>::
     #   If set to true, causes any incomplete log records to be emitted
     #   in their incomplete state when EOF is reached on all streams.
+    # 
+    # Additionally, these options are recognized:
+    # 
+    # <tt>:encoding</tt>::
+    #   Specify an encoding for file data. (Ruby 1.9 only.)
+    #   You may specify an encoding name or an encoding object.
+    #   If not specified, uses the default external encoding.
+    # <tt>:internal_encoding</tt>::
+    #   Specify an encoding to transcode to. (Ruby 1.9 only.)
+    #   You may specify an encoding name or an encoding object.
+    #   If not specified, uses the default internal encoding.
     
     def open_entries(globs_, opts_={}, &block_)
       processor_ = EntryProcessor.build(&block_)
@@ -274,6 +291,17 @@ module Sawmill
     # <tt>:emit_incomplete_records_at_eof</tt>::
     #   If set to true, causes any incomplete log records to be emitted
     #   in their incomplete state when EOF is reached on all streams.
+    # 
+    # Additionally, these options are recognized:
+    # 
+    # <tt>:encoding</tt>::
+    #   Specify an encoding for file data. (Ruby 1.9 only.)
+    #   You may specify an encoding name or an encoding object.
+    #   If not specified, uses the default external encoding.
+    # <tt>:internal_encoding</tt>::
+    #   Specify an encoding to transcode to. (Ruby 1.9 only.)
+    #   You may specify an encoding name or an encoding object.
+    #   If not specified, uses the default internal encoding.
     
     def open_records(globs_, opts_={}, &block_)
       processor_ = RecordProcessor.build(&block_)
@@ -293,29 +321,74 @@ module Sawmill
     # <tt>:emit_incomplete_records_at_eof</tt>::
     #   If set to true, causes any incomplete log records to be emitted
     #   in their incomplete state when EOF is reached on all streams.
+    # 
+    # Additionally, these options are recognized:
+    # 
     # <tt>:finish</tt>::
     #   If set to true, the "finish" method is called on the processor
     #   after all files have been parsed, and the return value is returned.
     #   Otherwise, the processor is left open and nil is returned.
+    # <tt>:encoding</tt>::
+    #   Specify an encoding for file data. (Ruby 1.9 only.)
+    #   You may specify an encoding name or an encoding object.
+    #   If not specified, uses the default external encoding.
+    # <tt>:internal_encoding</tt>::
+    #   Specify an encoding to transcode to. (Ruby 1.9 only.)
+    #   You may specify an encoding name or an encoding object.
+    #   If not specified, uses the default internal encoding.
     
     def open_files(globs_, processor_, opts_={})
-      io_array_ = []
+      finish_opt_ = opts_.delete(:finish)
+      encoding_ = opts_.delete(:encoding)
+      internal_encoding_ = opts_.delete(:internal_encoding)
+      mode_ = 'r'
+      if defined?(::Encoding)
+        if encoding_
+          encoding_ = ::Encoding.find(encoding_) unless encoding_.respond_to?(:name)
+          encoding_ = nil if encoding_ == ::Encoding.default_external
+        end
+        if internal_encoding_
+          internal_encoding_ = ::Encoding.find(internal_encoding_) unless internal_encoding_.respond_to?(:name)
+          internal_encoding_ = nil if internal_encoding_ == ::Encoding.default_internal
+        end
+        if encoding_
+          mode_ << ":#{encoding_.name}"
+        elsif internal_encoding_
+          mode_ << ":#{::Encoding.default_external.name}"
+        end
+        mode_ << ":#{internal_encoding_.name}" if internal_encoding_
+      else
+        encoding_ = nil
+        internal_encoding_ = nil
+      end
       globs_ = [globs_] unless globs_.kind_of?(::Array)
+      io_array_ = []
+      encoding_array_ = []
+      internal_encoding_array_ = []
       begin
         globs_.each do |glob_|
           ::Dir.glob(glob_).each do |path_|
-            io_ = ::File.open(path_)
-            io_ = ::Zlib::GzipReader.new(io_) if path_ =~ /\.gz$/
-            io_array_ << io_
+            if path_ =~ /\.gz$/
+              io_ = ::File.open(path_, 'rb')
+              io_array_ << ::Zlib::GzipReader.new(io_)
+              encoding_array_ << encoding_
+              internal_encoding_array_ << internal_encoding_
+            else
+              io_array_ << ::File.open(path_, mode_)
+              encoding_array_ << nil
+              internal_encoding_array_ << nil
+            end
           end
         end
+        opts_[:encoding_array] = encoding_array_ if encoding_array_.find{ |elem_| elem_ }
+        opts_[:internal_encoding_array] = internal_encoding_array_ if internal_encoding_array_.find{ |elem_| elem_ }
         MultiParser.new(io_array_, processor_, opts_).parse_all
       ensure
         io_array_.each do |io_|
           io_.close rescue nil
         end
       end
-      opts_[:finish] ? processor_.finish : nil
+      finish_opt_ ? processor_.finish : nil
     end
     
     

data/lib/sawmill/multi_parser.rb

@@ -64,7 +64,14 @@ module Sawmill
       @emit_incomplete_records_at_eof = opts_.delete(:emit_incomplete_records_at_eof)
       @heap = Util::Heap.new{ |a_, b_| a_[1].timestamp <=> b_[1].timestamp }
       @queue = Util::Queue.new
-      io_array_.each{ |io_| _enqueue(Parser.new(io_, nil, opts_)) }
+      encoding_array_ = opts_.delete(:encoding_array)
+      internal_encoding_array_ = opts_.delete(:internal_encoding_array)
+      io_array_.each_with_index do |io_, index_|
+        opts2_ = opts_.dup
+        opts2_[:encoding] = encoding_array_[index_] if encoding_array_
+        opts2_[:internal_encoding] = internal_encoding_array_[index_] if internal_encoding_array_
+        _enqueue(Parser.new(io_, nil, opts2_))
+      end
       @processor = nil
       if processor_.respond_to?(:record) && processor_.respond_to?(:extra_entry)
         @processor = RecordBuilder.new(processor_)

data/lib/sawmill/parser.rb

@@ -78,6 +78,12 @@ module Sawmill
       @emit_incomplete_records_at_eof = opts_[:emit_incomplete_records_at_eof]
       @current_record_id = nil
       @parser_directives = {}
+      @encoding = opts_[:encoding]
+      @internal_encoding = opts_[:internal_encoding]
+      if defined?(::Encoding)
+        @encoding = ::Encoding.find(@encoding) if @encoding && !@encoding.kind_of?(::Encoding)
+        @internal_encoding = ::Encoding.find(@internal_encoding) if @internal_encoding && !@internal_encoding.kind_of?(::Encoding)
+      end
     end
     
     
@@ -86,7 +92,7 @@ module Sawmill
     # Returns nil if EOF has been reached.
     
     def parse_one_entry
-      str_ = @io.gets
+      str_ = _get_next_line
       entry_ = nil
       if str_
         match_ = LINE_REGEXP.match(str_)
@@ -113,7 +119,7 @@ module Sawmill
             count_ = $1.length
             str_ = $` + "\\"*(count_/2)
             while count_ % 2 == 1
-              str2_ = @io.gets
+              str2_ = _get_next_line
               if str2_ && str2_ =~ /(\\*)\n?$/
                 count_ = $1.length
                 str_ << "\n" << $` << "\\"*(count_/2)
@@ -174,6 +180,19 @@ module Sawmill
     end
     
     
+    private
+    
+    
+    def _get_next_line  # :nodoc:
+      str_ = @io.gets
+      if str_
+        str_.force_encoding(@encoding) if @encoding
+        str_.encode!(@internal_encoding) if @internal_encoding
+      end
+      str_
+    end
+    
+    
   end
   
   

data/lib/sawmill/rotater/date_based_log_file.rb

@@ -68,23 +68,26 @@ module Sawmill
       # <tt>:basedir</tt>::
       #   The base directory used if the filepath is a relative path.
       #   If not specified, the current working directory is used.
-      # <tt>:prefix</tt>::
+      # <tt>:path_prefix</tt>::
       #   The logfile path prefix.
       #   In the filename "rails.2009-10-11.log", the prefix is "rails".
       #   If not specified, defaults to "sawmill".
-      # <tt>:suffix</tt>::
+      # <tt>:path_suffix</tt>::
       #   The logfile name prefix.
       #   In the filename "rails.2009-10-11.log", the suffix is ".log".
       #   If not specified, defaults to ".log".
       # <tt>:local_datestamps</tt>::
       #   If true, use the local timezone to create datestamps.
       #   The default is to use UTC.
+      # <tt>:encoding</tt>::
+      #   Specify an encoding name for file data. (Ruby 1.9 only)
+      #   If not specified, uses the default external encoding.
       
       def initialize(options_)
         @turnover_frequency = options_[:turnover_frequency] || :none
-        @prefix = ::File.expand_path(options_[:prefix] || 'sawmill',
+        @prefix = ::File.expand_path(options_[:path_prefix] || options_[:prefix] || 'sawmill',
                                      options_[:basedir] || options_[:dirname] || ::Dir.getwd)
-        @suffix = options_[:suffix] || '.log'
+        @suffix = options_[:path_suffix] || options_[:suffix] || '.log'
         @local_datestamps = options_[:local_datestamps]
         @date_pattern =
           case @turnover_frequency
@@ -94,6 +97,10 @@ module Sawmill
           when :hourly then "%Y-%m-%d-%H"
           else nil
           end
+        @mode = 'a'
+        if defined?(::Encoding) && (encoding_ = options_[:encoding])
+          @mode << ":#{encoding_}"
+        end
       end
       
       
@@ -118,7 +125,7 @@ module Sawmill
         else
           path_ = @prefix+@suffix
         end
-        file_ = ::File.open(path_, ::File::CREAT | ::File::WRONLY | ::File::APPEND)
+        file_ = ::File.open(path_, @mode)
         file_.sync = true
         file_
       end

data/lib/sawmill/rotater/shifting_log_file.rb

@@ -59,11 +59,11 @@ module Sawmill
       # <tt>:basedir</tt>::
       #   The base directory used if the filepath is a relative path.
       #   If not specified, the current working directory is used.
-      # <tt>:filepath</tt>::
+      # <tt>:file_path</tt>::
       #   The path to the log file. This may be an absolute path or a
       #   path relative to basedir.
       #   If not specified, defaults to "sawmill.log".
-      # <tt>:max_logfile_size</tt>::
+      # <tt>:max_file_size</tt>::
       #   A logfile will try to rotate once it has reached this size in
       #   bytes. If not specified, the file size is not checked.
       # <tt>:shift_period</tt>::
@@ -76,9 +76,12 @@ module Sawmill
       #   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.
+      # <tt>:encoding</tt>::
+      #   Specify an encoding name for file data. (Ruby 1.9 only)
+      #   If not specified, uses the default external encoding.
       
       def initialize(options_)
-        @max_logfile_size = options_[:max_logfile_size]
+        @max_logfile_size = options_[:max_file_size] || options_[:max_logfile_size]
         @shift_period = options_[:shift_period]
         case @shift_period
         when :yearly
@@ -92,11 +95,15 @@ 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_[: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
+        @mode = 'a'
+        if defined?(::Encoding) && (encoding_ = options_[:encoding])
+          @mode << ":#{encoding_}"
+        end
       end
       
       
@@ -115,7 +122,7 @@ module Sawmill
         else
           path_ = "#{@normal_path}.#{@preferred_handle-handle_-1}"
         end
-        file_ = ::File.open(path_, ::File::CREAT | ::File::WRONLY | ::File::APPEND)
+        file_ = ::File.open(path_, @mode)
         file_.sync = true
         @open_handles[handle_] = true
         file_

data/lib/sawmill/version.rb

@@ -37,7 +37,7 @@
 module Sawmill
   
   # Current gem version, as a frozen string.
-  VERSION_STRING = '0.0.3'.freeze
+  VERSION_STRING = '0.0.4'.freeze
   
   # Current gem version, as a Versionomy::Value.
   VERSION = ::Versionomy.parse(VERSION_STRING, :standard)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sawmill
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Daniel Azuma
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-01 01:00:00 -07:00
+date: 2009-11-06 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.2.2
+        version: 0.3.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: versionomy
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.1.2
+        version: 0.2.0
     version: 
 description: Sawmill is a logging and log analysis system for Ruby. It extends the basic Ruby logging facility with log records and parsing abilities.
 email: dazuma@gmail.com