loggable 0.1.0 → 0.2.0

data/README.rdoc

@@ -0,0 +1,81 @@
+= Loggable
+
+Loggable is a gem that's designed to add a logging interface to classes that don't 
+automatically support it.
+
+== Installation
+
+Stable:
+
+  sudo gem install loggable
+  
+Bleeding Edge (hardly):
+
+  sudo gem install vigetlabs-loggable --source=http://gems.github.com
+
+== Usage
+
+Using the Gem is easy, just assign a new logger to your class:
+
+    require 'rubygems'
+    require 'logger'
+    require 'loggable'
+
+    class MyClass; end
+  
+    MyClass.logger = Logger.new('debug.log')
+
+Now, any class or instance methods have access to the logger:
+
+    class MyClass
+      def self.do_something
+        logger.debug 'doing something in the class'
+      end
+      
+      def do_something
+        logger.debug 'doing something in an instance'
+      end
+    end
+
+The above code will write into the log file when called:
+
+    MyClass.do_something
+    MyClass.new.do_something
+
+    debug.log:
+  
+    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)
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -4,41 +4,35 @@ require 'rake/testtask'
 
 require 'lib/loggable/version'
 
-GEM = "loggable"
-AUTHOR = "Patrick Reagan"
-EMAIL = "patrick.reagan@viget.com"
-HOMEPAGE = "http://viget.rubyforge.org/loggable"
-SUMMARY = "A gem that provides logging capabilities to any class"
-
 task :default => :test
 
 spec = Gem::Specification.new do |s|
-  s.name = GEM
-  s.version = Loggable::VERSION::STRING
-  s.platform = Gem::Platform::RUBY
-  s.has_rdoc = true
-  s.extra_rdoc_files = ["README", "LICENSE"]
-  s.summary = SUMMARY
-  s.description = s.summary
-  s.author = AUTHOR
-  s.email = EMAIL
-  s.homepage = HOMEPAGE
+  s.name              = 'loggable'
+  s.version           = Loggable::Version.to_s
+  s.has_rdoc          = true
+  s.extra_rdoc_files  = %w(README.rdoc)
+  s.rdoc_options      = %w(--main README.rdoc)
+  s.summary           = "A gem that provides logging capabilities to any class"
+  s.author            = 'Patrick Reagan'
+  s.email             = 'patrick.reagan@viget.com'
+  s.homepage          = 'http://viget.com/extend'
   s.rubyforge_project = 'viget'
-  
-  s.require_path = 'lib'
-  s.files = %w(LICENSE README HISTORY Rakefile) + Dir.glob("{lib,test}/**/*")
+  s.files             = %w(README.rdoc Rakefile) + Dir.glob("{lib,test}/**/*")
 end
 
 Rake::GemPackageTask.new(spec) do |pkg|
   pkg.gem_spec = spec
 end
 
-task :install => [:package] do
-  sh %{sudo gem install pkg/#{GEM}-#{VERSION}}
-end
-
 Rake::TestTask.new do |t|
   t.libs << 'test'
-  t.pattern = FileList['test/examples/*_test.rb']
+  t.test_files = FileList["test/**/*_test.rb"]
   t.verbose = true
+end
+
+desc 'Generate the gemspec to serve this Gem from Github'
+task :github do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  puts "Created gemspec: #{file}"
 end

data/lib/loggable.rb

@@ -1,5 +1,16 @@
+$:.unshift File.dirname(__FILE__)
+
 require 'loggable/log_methods'
 require 'loggable/logger_stub'
 
-Object.send(:extend, Loggable::ClassMethods)
-Object.send(:include, Loggable::InstanceMethods)
+class Object
+  include Loggable::InstanceMethods
+end
+
+class Class
+  include Loggable::ClassMethods
+end
+
+class Module
+  include Loggable::ClassMethods
+end

data/lib/loggable/log_methods.rb

@@ -6,7 +6,7 @@ module Loggable
     
     # Use this method on any of your classes to trigger the logging facility:
     #
-    #   MyClass.logger = Logger.new('/path/to/logfile)
+    #   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.

data/lib/loggable/version.rb

@@ -1,11 +1,13 @@
 module Loggable
-  
-  module VERSION  #:nodoc:
+  module Version
+    
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     TINY  = 0
     
-    STRING = [MAJOR, MINOR, TINY].join('.')
+    def self.to_s # :nodoc:
+      [MAJOR, MINOR, TINY].join('.')
+    end
+    
   end
-  
 end

data/test/examples/log_methods_test.rb

@@ -6,12 +6,18 @@ class MyClass
   end
 end
 
+module MyModule; end
+
 describe "MyClass, with loggable mix-in" do
   
   before(:each) do
     @logger = mock()
   end
   
+  after(:each) do
+    MyClass.logger = nil
+  end
+  
   it "should have a logger stub by default" do
     MyClass.logger.should.be.an.instance_of(LoggerStub)
   end
@@ -31,4 +37,18 @@ describe "MyClass, with loggable mix-in" do
     MyClass.new.logger.should.equal @logger
   end
   
+end
+
+describe "MyModule, with loggable mix-in" do
+  
+  it "should have a logger stub by default" do
+    MyModule.logger.should.be.an.instance_of(LoggerStub)
+  end
+  
+  it "should be able to log messages" do
+    logger = mock {|m| m.expects(:debug).with('blip') }
+    MyModule.logger = logger
+    MyModule.logger.debug('blip')
+  end
+  
 end

data/test/test_helper.rb

@@ -2,7 +2,4 @@ require 'rubygems'
 require 'test/spec'
 require 'mocha'
 
-$TESTING=true
-$:.push File.join(File.dirname(__FILE__), '..', 'lib')
-
-require 'loggable'
+require File.dirname(__FILE__) + '/../lib/loggable'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: loggable
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Patrick Reagan
@@ -9,23 +9,20 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-05-09 00:00:00 -04:00
+date: 2009-01-21 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
-description: A gem that provides logging capabilities to any class
+description: 
 email: patrick.reagan@viget.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README
-- LICENSE
+- README.rdoc
 files: 
-- LICENSE
-- README
-- HISTORY
+- README.rdoc
 - Rakefile
 - lib/loggable
 - lib/loggable/log_methods.rb
@@ -37,10 +34,11 @@ files:
 - test/examples/logger_stub_test.rb
 - test/test_helper.rb
 has_rdoc: true
-homepage: http://viget.rubyforge.org/loggable
+homepage: http://viget.com/extend
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --main
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -58,7 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: viget
-rubygems_version: 1.1.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: A gem that provides logging capabilities to any class

data/HISTORY

@@ -1,10 +0,0 @@
-== 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:
-  * Initial release

data/LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2007 YOUR NAME
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -1,57 +0,0 @@
-= Loggable
-
-Loggable is a gem that's designed to add a logging interface to classes that don't 
-automatically support it.
-
-== Installation
-
-This code is available as a Ruby Gem:
-
-  sudo gem install loggable
-  
-== Usage
-
-Using the Gem is easy, just assign a new logger to your class:
-
-  require 'rubygems'
-  require 'logger'
-  require 'loggable'
-
-  class MyClass; end
-  
-  MyClass.logger = Logger.new('debug.log')
-
-Now, any class or instance methods have access to the logger:
-
-  class MyClass
-    def self.do_something
-      logger.debug 'doing something in the class'
-    end
-      
-    def do_something
-      logger.debug 'doing something in an instance'
-    end
-  end
-
-The above code will write into the log file when called:
-
-  MyClass.do_something
-  MyClass.new.do_something
-
-  debug.log:
-  
-  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)
-Released under the MIT license