mediashelf-loggable 0.4.0

data/.gitignore

@@ -0,0 +1,4 @@
+pkg
+doc
+/.rvmrc
+/.bundle

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+group :development, :test do
+  gem "jeweler"
+  gem "mocha"
+  gem "jnunemaker-matchy"
+  gem "thoughtbot-shoulda"
+end

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    gemcutter (0.6.1)
+    git (1.2.5)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    jnunemaker-matchy (0.4.0)
+    json_pure (1.4.6)
+    mocha (0.9.9)
+      rake
+    rake (0.8.7)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    thoughtbot-shoulda (2.11.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  jnunemaker-matchy
+  mocha
+  thoughtbot-shoulda

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

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mediashelf-loggable"
+    gem.summary = %Q{A gem that provides logging capabilities to any class}
+    gem.description = %Q{A gem that provides logging capabilities to any class.  Relies on Rails logger if it's available.  Extended from loggable gem by viget}
+    gem.email = "matt.zumwalt@yourmediashelf.com"
+    gem.homepage = "http://github.com/mediashelf/mediashelf-loggable"
+    gem.authors = ['Patrick Reagan',"Matt Zumwalt"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.4.0

data/lib/loggable.rb

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

data/lib/loggable/log_methods.rb

@@ -0,0 +1,33 @@
+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
+    
+    # If RAILS_DEFAULT_LOGGER is defined, that will be returned.
+    # If no logger has been defined, a new STDOUT Logger will be created.
+    def logger
+      # @@logger || LoggerStub.new
+      @@logger ||= defined?(RAILS_DEFAULT_LOGGER) ? RAILS_DEFAULT_LOGGER : ::Logger.new(STDOUT)
+    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|
+    class_eval <<-CODE
+      def #{method}(message); nil; end
+    CODE
+  end
+  
+end

data/lib/loggable/version.rb

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

data/loggable.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{loggable}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Patrick Reagan"]
+  s.date = %q{2009-04-28}
+  s.email = %q{patrick.reagan@viget.com}
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.files = ["README.rdoc", "Rakefile", "lib/loggable", "lib/loggable/log_methods.rb", "lib/loggable/logger_stub.rb", "lib/loggable/version.rb", "lib/loggable.rb", "test/examples", "test/examples/log_methods_test.rb", "test/examples/logger_stub_test.rb", "test/test_helper.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://viget.com/extend}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{viget}
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{A gem that provides logging capabilities to any class}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/test/examples/log_methods_test.rb

@@ -0,0 +1,54 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class MyClass
+  def logged_method
+    logger.debug 'message'
+  end
+end
+
+module MyModule; end
+
+class LogMethodsTest < Test::Unit::TestCase
+  context "An instance of MyClass, with loggable mix-in" do
+
+    setup    { @logger = mock() }
+    teardown { MyClass.logger = nil}
+
+    should "have a logger stub by default" do
+      MyClass.logger.should be_instance_of(Logger)
+    end
+
+    should "not fail when an instance calls an uninitialized logger" do
+      m = MyClass.new
+      lambda { m.logged_method }.should_not raise_error
+    end
+
+    should "allow the asssignment of a logger" do
+      MyClass.logger = @logger
+      MyClass.logger.should == @logger
+    end
+
+    should "allow access to the logger from an instance" do
+      MyClass.logger = @logger
+      MyClass.new.logger.should == @logger
+    end
+
+  end
+
+  context "MyModule, with loggable mix-in" do
+
+    should "have a logger stub by default" do
+      MyModule.logger = nil
+      MyModule.logger.should be_kind_of(Logger)
+    end
+
+    should "be able to log messages" do
+      logger = mock()
+      logger.expects(:debug).with('blip')
+      
+      MyModule.logger = logger
+      MyModule.logger.debug('blip')
+    end
+
+  end
+end

data/test/examples/logger_stub_test.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class LoggerStubTest < Test::Unit::TestCase
+  context "An instance of the LoggerStub class" do
+
+    setup { @logger = LoggerStub.new }
+
+    should "return nil for all standard logging methods" do
+      [:debug, :error, :fatal, :info, :warn].each do |method|
+        @logger.send(method, 'message').should be(nil)
+      end
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'test/unit'
+require 'mocha'
+require 'shoulda'
+require 'matchy'
+
+require File.dirname(__FILE__) + '/../lib/loggable'

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: mediashelf-loggable
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
+platform: ruby
+authors: 
+- Patrick Reagan
+- Matt Zumwalt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-26 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: A gem that provides logging capabilities to any class.  Relies on Rails logger if it's available.  Extended from loggable gem by viget
+email: matt.zumwalt@yourmediashelf.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/loggable.rb
+- lib/loggable/log_methods.rb
+- lib/loggable/logger_stub.rb
+- lib/loggable/version.rb
+- loggable.gemspec
+- test/examples/log_methods_test.rb
+- test/examples/logger_stub_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/mediashelf/mediashelf-loggable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A gem that provides logging capabilities to any class
+test_files: 
+- test/examples/log_methods_test.rb
+- test/examples/logger_stub_test.rb
+- test/test_helper.rb