logit 1.0.3 → 1.0.4

data/README.rdoc

@@ -31,6 +31,15 @@ This will write logs to a publisher.log file in the current directory.
 
   logs_to '/var/log/publishing/publisher.log'
 
+==== Using a different log method name
+
+  logs_to :publisher, :log_method => :pub_log
+
+  def publish
+    pub_log.info("doing publish")
+    # do stuff...
+  end
+
 ==== Adding a progname to log entries
 
   logs_to :publisher, :progname => "Publisher #{Process.pid}"
@@ -50,10 +59,6 @@ bytes.
 
 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
   
@@ -90,12 +95,18 @@ environment to the log file name.  For example:
 
 == As a Rails plugin
 
- $ script/plugin install git://github.com/ssayles/logit.git
+ $ script/plugin install git://github.com/codemariner/logit.git
 
 
 
 = Release Notes
 
+[1.0.4]
+ * Removed reference to file handler.  Allowing Logger to manage this entirely.
+ * Added option :log_method that specifies what the name of the log method should be.
+ * Reimplemented flush to grab the underlying LogDevice file.
+ * Assigning Logger instance to class level variable.
+
 [1.0.3]
  * Changed default date format to month-day-year.
 

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('logit', '1.0.3') do |p|
+Echoe.new('logit', '1.0.4') 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

@@ -1,14 +1,14 @@
 module Logit
+
+  DEFAULT_OPTS = {:write_mode => 'a', :flush_mode => :default, :log_method => :logger, :stdout => false}
+
   def self.included(base)
     base.extend ClassMethods
   end
 
   module ClassMethods
-    DEFAULT_OPTS = {:write_mode => 'a', :flush_mode => :default, :stdout => false}
 
-    begin
-      Module.const_get(:Logger)
-    rescue NameError
+    unless Object.const_defined?(:Logger)
       require 'logger'
     end
 
@@ -19,6 +19,7 @@ module Logit
     # * +: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.
+    # * +:log_method+ - The name of the instance method to define to access the logger instance.  Defaults to <tt>:logger</tt>.
     #
     # === Examples
     # 
@@ -42,11 +43,22 @@ module Logit
     #      logger.info("doing something")
     #    end
     #  end
+    #
+    #  class Publisher3
+    #    include Logit
+    #
+    #    logs_to :publisher, :log_method => :pub_log
+    #
+    #    def do_it
+    #      pub_log.info("doing something")
+    #    end
+    #  end
     #  
     def logs_to(name, opts={})
       opts = DEFAULT_OPTS.merge(opts)
       path = logit_log_name(name, opts)
-      self.send :define_method, :logger do
+
+      self.class.send :define_method, :logit_logger do
         unless @logger
           @logger =  Logit::Logger.new(path, opts)
           if opts[:progname]
@@ -55,6 +67,10 @@ module Logit
         end
         @logger
       end
+
+      self.send :define_method, opts[:log_method] do
+        self.class.send :logit_logger
+      end
     end
 
 
@@ -112,20 +128,18 @@ module Logit
   #
   # when running under Rails.
   #
-  # You can flush the log by calling logger.flush().
-  #
   class Logger < Logger
   
-    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
+      f = File.open(log_path, @opts[:write_mode])
+      if (opts[:flush_mode] == :immediate)
+        f.sync = true
+      end
+      super f
     end
   
     def format_message(severity, timestamp, progname, msg)
-  
       name = (progname) ? " [#{progname}]" : ""
   
       message = "#{timestamp.strftime('%m-%d-%Y %H:%M:%S')} #{severity.ljust(6)}#{name}: #{msg}\n"
@@ -135,14 +149,26 @@ module Logit
 
     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()
+    # flushes any buffered content to the log
+    def flush
+      # get a handle to the actual file and then synchronize on the mutex
+      # that LogDevice is using (so we don't have the file closed or
+      # swapped out from under us)
+      if @logdev 
+        mutex = @logdev.instance_variable_get('@mutex')
+        if (mutex)
+          mutex.synchronize do 
+            dev = @logdev.dev
+            if (dev and !dev.closed?)
+              dev.flush()
+            end
+          end
+        end
+      end
+      true
     end
-
   end
 
 end

data/logit.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{logit}
-  s.version = "1.0.3"
+  s.version = "1.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Scott Sayles"]
-  s.date = %q{2010-12-10}
+  s.date = %q{2011-02-01}
   s.description = %q{Easily add custom logging abilities to your Ruby or Rails application.}
   s.email = %q{ssayles@users.sourceforge.net}
   s.extra_rdoc_files = ["LICENSE", "README.rdoc", "lib/logit.rb"]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: logit
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: false
   segments: 
   - 1
   - 0
-  - 3
-  version: 1.0.3
+  - 4
+  version: 1.0.4
 platform: ruby
 authors: 
 - Scott Sayles
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-10 00:00:00 -05:00
+date: 2011-02-01 00:00:00 -05:00
 default_executable: 
 dependencies: []