logit 1.0.1 → 1.0.2

data/README.rdoc

@@ -43,9 +43,27 @@ this will add something like 'Publisher 1234' to log entries.
 
 this will rotate logs up to a total of 5 files with max size of 102400
 bytes.
+
+==== Flushing each message to the log file immediately
+  
+  logs_to :publisher, :flush_mode => :immediate
+
+The default behavior is to use the default file buffering.  Turning this
+on will cause each message to be written to the log file immediately.
+Alternatively, you can control this programmatically like so:
+
+  logger.info("my message")
+  logger.flush()
+
+==== Also print to stdout
   
+  logs_to :publisher, :stdout => true
+
+This will print log messages to stdout in addition to writing them to the
+log file.
 
-=== Running in Rails
+
+= Rails
 
 LogIt automatically detects if you're running in a Rails environment.  If
 so, it will write to the Rails log directory and appends the
@@ -53,6 +71,7 @@ environment to the log file name.  For example:
 
   RAILS_ROOT/log/publisher_development.log
 
+
 = Example log
 
  09-12-2010 10:27:10 INFO   [publisher 4607]: Publishing files to endpoint.
@@ -62,23 +81,31 @@ environment to the log file name.  For example:
  09-12-2010 10:28:32 INFO   [publisher 4634]: Publishing files to endpoint.
  09-12-2010 10:28:32 WARN   [publisher 4634]: No files available to publish.
 
-= Installation
 
+= Installation
 == As a Gem
 
  $ gem install logit
 
+
 == As a Rails plugin
 
  $ script/plugin install git://github.com/ssayles/logit.git
 
 
+
+= Release Notes
+
+[1.0.2]
+ * Added :flush_mode option.  Set this to <tt>:immediate</tt> if you want each message flushed to the log file immediately.
+ * Added :stdout option.  Set this to <tt>true</tt> if you want logs printed to stdout as well.
+
+
 = TODO
 
 * Allow users to pass in a proc or a name of a method to call to handle formatting of log entries.
 * Add some tests?
 
-
 = Credits
 
 LogIt is written and maintained by {Scott Sayles}[mailto:ssayles@users.sourceforge.net].  

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('logit', '1.0.1') do |p|
+Echoe.new('logit', '1.0.2') do |p|
     p.description       = 'Easily add custom logging abilities to your Ruby or Rails application.'
     p.url               = 'http://github.com/codemariner/logit'
     p.author            = 'Scott Sayles'

data/lib/logit.rb

@@ -4,7 +4,7 @@ module Logit
   end
 
   module ClassMethods
-    DEFAULT_OPTS = {:write_mode => 'a'}
+    DEFAULT_OPTS = {:write_mode => 'a', :flush_mode => :default, :stdout => false}
 
     begin
       Module.const_get(:Logger)
@@ -17,6 +17,8 @@ module Logit
     # * +:shift_age+ - Number of old logs to keep or frequency of rotation.
     # * +:shift_size+ - Maximum logfile size that only applies when <tt>:shift_age</tt> is a number.
     # * +:progname+ - Logging program name.  The <tt>:progname</tt> value is used in the default logging format if defined.
+    # * +:flush_mode+ - One of <tt>:immediate</tt> or <tt>:default</tt>.  <tt>:immediate</tt> will cause a write to the log file for each message logged.  The default behavior is to use default file buffering.
+    # * +:stdout+ - If set to <tt>true</tt>, this will cause logs to be printed to stdout <b>in addition to</b> the log file.
     #
     # === Examples
     # 
@@ -114,8 +116,11 @@ module Logit
   #
   class Logger < Logger
   
-    def initialize(log_path, opts = {:write_mode => 'a'})
-      @f = File.open(log_path, 'a')
+    DEFAULT_OPTS = {:write_mode => 'a', :flush_mode => :default}
+
+    def initialize(log_path, opts = DEFAULT_OPTS)
+      @opts = DEFAULT_OPTS.merge(opts)
+      @f = File.open(log_path, @opts[:write_mode])
       super @f
     end
   
@@ -123,12 +128,21 @@ module Logit
   
       name = (progname) ? " [#{progname}]" : ""
   
-      "#{timestamp.strftime('%d-%m-%Y %H:%M:%S')} #{severity.ljust(6)}#{name}: #{msg}\n"
+      message = "#{timestamp.strftime('%d-%m-%Y %H:%M:%S')} #{severity.ljust(6)}#{name}: #{msg}\n"
+      puts message if @opts[:stdout]
+      message
     end
-  
+
+    def add(severity, message = nil, progname = nil, &block)
+      super(severity, message, progname, &block)
+      flush() if @opts[:flush_mode] == :immediate
+    end
+
+    # Causes any pending writes to be flushed to disk
     def flush()
       @f.flush()
     end
+
   end
 
 end

data/logit.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{logit}
-  s.version = "1.0.1"
+  s.version = "1.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Scott Sayles"]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: logit
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Scott Sayles