loggable 0.0.1 → 0.1.0

data/HISTORY

@@ -1,3 +1,9 @@
+== 0.1.0 2008-05-09
+
+* 2 major enhancements:
+  * Changed the API for using the logging functionality (Class.logger=)
+  * Added in a LoggerStub to intercept calls to a non-existent logging facility
+
 == 0.0.1 2008-04-24
 
 * 1 major enhancement:

data/README

@@ -11,23 +11,17 @@ This code is available as a Ruby Gem:
   
 == Usage
 
-Using the Gem is easy, just include the <tt>loggable</tt> class method in your class 
-to enable it:
+Using the Gem is easy, just assign a new logger to your class:
 
   require 'rubygems'
   require 'logger'
   require 'loggable'
-  
-  class MyClass
-    loggable
-  end
 
-Now you can assign a logger instance to this class and have it write log messages to
-the specified file:
-
-  MyClass.logger = Logger.new('debug.log')
+  class MyClass; end
   
-Any class or instance methods now have access to the logger:
+  MyClass.logger = Logger.new('debug.log')
+
+Now, any class or instance methods have access to the logger:
 
   class MyClass
     def self.do_something
@@ -49,6 +43,14 @@ The above code will write into the log file when called:
   D, [2008-04-24T20:37:32.273930 #25821] DEBUG -- : doing something in the class
   D, [2008-04-24T20:37:32.274062 #25821] DEBUG -- : doing something in an instance
 
+== Removing Logger Functionality
+
+Calling the <tt>logger=</tt> class method to assign a logger to the class will 
+trigger the methods necessary to start logging messages.  If you want to turn off 
+logging temporarily (without removing the logging statements from your class), 
+comment out the line where you assign the new logger.  By default, the logger is
+stubbed out, so any calls to methods on it will just return nil.
+
 == Credits
 
 Copyright (c) 2008 Patrick Reagan of Viget Labs (mailto:patrick.reagan@viget.com)

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake/gempackagetask'
 require 'rake/testtask'
 
-require 'lib/version'
+require 'lib/loggable/version'
 
 GEM = "loggable"
 AUTHOR = "Patrick Reagan"

data/lib/loggable.rb

@@ -1,43 +1,5 @@
-module Loggable
-  
-  module LogMethods
-    
-    # Including this in your class definition will add the ability to use a logger within
-    # your class:
-    #
-    #  class MyClass
-    #    loggable
-    #  end
-    # 
-    # Now you can assign a logger instance to this class and have it write to the specified
-    # logfile.  See the README for details.
-    #
-    def loggable
-      extend ClassMethods
-      include InstanceMethods
-    end
-  end
-  
-  module ClassMethods
-    
-    @@logger = nil
-    
-    def logger=(logger)
-      @@logger = logger
-    end
-    
-    def logger
-      @@logger
-    end
-    
-  end
-  
-  module InstanceMethods
-    def logger
-      self.class.logger
-    end
-  end
-  
-end
+require 'loggable/log_methods'
+require 'loggable/logger_stub'
 
-Object.send(:extend, Loggable::LogMethods)
+Object.send(:extend, Loggable::ClassMethods)
+Object.send(:include, Loggable::InstanceMethods)

data/lib/loggable/log_methods.rb

@@ -0,0 +1,30 @@
+module Loggable
+  
+  module ClassMethods
+    
+    @@logger = nil
+    
+    # Use this method on any of your classes to trigger the logging facility:
+    #
+    #   MyClass.logger = Logger.new('/path/to/logfile)
+    #
+    # Now you can call the 'logger' method inside a class or instance method to log at
+    # the specified level.  See the README for details.
+    #
+    def logger=(logger)
+      @@logger = logger
+    end
+    
+    def logger
+      @@logger || LoggerStub.new
+    end
+    
+  end
+  
+  module InstanceMethods
+    def logger
+      self.class.logger
+    end
+  end
+  
+end

data/lib/loggable/logger_stub.rb

@@ -0,0 +1,9 @@
+class LoggerStub
+  
+  [:debug, :error, :fatal, :info, :warn].each do |method|
+    define_method(method) do
+      nil
+    end
+  end
+  
+end

data/lib/{version.rb → loggable/version.rb}

@@ -2,8 +2,8 @@ module Loggable
   
   module VERSION  #:nodoc:
     MAJOR = 0
-    MINOR = 0
-    TINY  = 1
+    MINOR = 1
+    TINY  = 0
     
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/examples/{loggable_test.rb → log_methods_test.rb}

@@ -1,6 +1,10 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
-class MyClass; loggable; end
+class MyClass
+  def logged_method
+    logger.debug 'message'
+  end
+end
 
 describe "MyClass, with loggable mix-in" do
   
@@ -8,8 +12,13 @@ describe "MyClass, with loggable mix-in" do
     @logger = mock()
   end
   
-  it "should have nothing as a logger by default" do
-    MyClass.logger.should.be nil
+  it "should have a logger stub by default" do
+    MyClass.logger.should.be.an.instance_of(LoggerStub)
+  end
+  
+  it "should not fail when an instance calls an uninitialized logger" do
+    m = MyClass.new
+    lambda { m.logged_method }.should.not.raise
   end
   
   it "should allow the asssignment of a logger" do

data/test/examples/logger_stub_test.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+describe "LoggerStub" do
+  
+  before(:each) do
+    @logger = LoggerStub.new
+  end
+  
+  it "should return nil for all standard logging methods" do
+    [:debug, :error, :fatal, :info, :warn].each do |method|
+      @logger.send(method).should.be.nil
+    end
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: loggable
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Patrick Reagan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-24 00:00:00 -04:00
+date: 2008-05-09 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -27,10 +27,14 @@ files:
 - README
 - HISTORY
 - Rakefile
+- lib/loggable
+- lib/loggable/log_methods.rb
+- lib/loggable/logger_stub.rb
+- lib/loggable/version.rb
 - lib/loggable.rb
-- lib/version.rb
 - test/examples
-- test/examples/loggable_test.rb
+- test/examples/log_methods_test.rb
+- test/examples/logger_stub_test.rb
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://viget.rubyforge.org/loggable