loggable 0.0.1

data/HISTORY

@@ -0,0 +1,4 @@
+== 0.0.1 2008-04-24
+
+* 1 major enhancement:
+  * Initial release

data/LICENSE

@@ -0,0 +1,20 @@
+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

@@ -0,0 +1,55 @@
+= 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 include the <tt>loggable</tt> class method in your class 
+to enable it:
+
+  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')
+  
+Any class or instance methods now 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
+
+== Credits
+
+Copyright (c) 2008 Patrick Reagan of Viget Labs (mailto:patrick.reagan@viget.com)
+Released under the MIT license

data/Rakefile

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+require 'lib/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.rubyforge_project = 'viget'
+  
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README HISTORY 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.verbose = true
+end

data/lib/loggable.rb

@@ -0,0 +1,43 @@
+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
+
+Object.send(:extend, Loggable::LogMethods)

data/lib/version.rb

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

data/test/examples/loggable_test.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class MyClass; loggable; end
+
+describe "MyClass, with loggable mix-in" do
+  
+  before(:each) do
+    @logger = mock()
+  end
+  
+  it "should have nothing as a logger by default" do
+    MyClass.logger.should.be nil
+  end
+  
+  it "should allow the asssignment of a logger" do
+    MyClass.logger = @logger
+    MyClass.logger.should.equal @logger
+  end
+  
+  it "should allow access to the logger from an instance" do
+    MyClass.logger = @logger
+    MyClass.new.logger.should.equal @logger
+  end
+  
+end

data/test/test_helper.rb

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

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: loggable
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Patrick Reagan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-04-24 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: A gem that provides logging capabilities to any class
+email: patrick.reagan@viget.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- LICENSE
+- README
+- HISTORY
+- Rakefile
+- lib/loggable.rb
+- lib/version.rb
+- test/examples
+- test/examples/loggable_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://viget.rubyforge.org/loggable
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: viget
+rubygems_version: 1.1.0
+signing_key: 
+specification_version: 2
+summary: A gem that provides logging capabilities to any class
+test_files: []
+