relevance-log_buddy 0.2.2 → 0.4.9

data/CHANGELOG

@@ -1,3 +1,7 @@
+v0.4.9  Added gem logging for debugging help when tracking down Gem activation errors
+
+v0.2.3  Updating Micronaut
+
 v0.2.0. Better log output of objects based on their type, very similar to Logger/irb behavior; update to micronaut 0.1.0
 
 v0.1.5. Clean up specs and remove noise from spec run

data/Manifest

@@ -1,10 +1,12 @@
 CHANGELOG
-examples/example_helper.rb
-examples/log_buddy_example.rb
-examples/log_buddy_init_example.rb
-examples/log_example.rb
+examples/log_buddy/example_helper.rb
+examples/log_buddy/gem_logger_example.rb
+examples/log_buddy/log_buddy_example.rb
+examples/log_buddy/log_buddy_init_example.rb
+examples/log_buddy/log_example.rb
 examples.rb
 init.rb
+lib/log_buddy/gem_logger.rb
 lib/log_buddy/mixin.rb
 lib/log_buddy/utils.rb
 lib/log_buddy/version.rb

data/README.rdoc

@@ -8,7 +8,7 @@ log_buddy is your friendly little log buddy at your side, helping you dev, debug
 
 Require the init.rb file to use log_buddy.  By default, it will add two methods to every object at the instance and class level: "d" and "logger".  To use log_buddy without the automatic object intrusion, set ENV["SAFE_LOG_BUDDY"] = true before requiring the init.rb.
 
-You can use your own logger with Logbuddy by passing it into init's options hash:
+You can use your own logger with LogBuddy by passing it into init's options hash:
     
     LogBuddy.init :default_logger => Logger.new('my_log.log')
     
@@ -38,6 +38,10 @@ in the block and the result.  Examples:
 
 See examples.rb for live examples you can run.
 
+When you occasionally want to disable LogBuddy (but you don't want to have to remove all your debug statements), you can pass the :disabled option into init's options hash:
+
+  LogBuddy.init :disabled => true
+
 == REQUIREMENTS:
 
 * Ruby 1.8.6 or JRuby (tested with 1.1RC3)
@@ -64,7 +68,7 @@ See examples.rb for live examples you can run.
 
 (The MIT License)
 
-Copyright (c) 2008 Relevance, Inc. - http://thinkrelevance.com
+Copyright (c) 2009 Relevance, Inc. - http://thinkrelevance.com
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,6 +1,9 @@
 require 'rubygems'
 gem 'echoe'
+gem "spicycode-micronaut", ">= 0.2.0"
 require 'echoe'
+require 'micronaut'
+require 'micronaut/rake_task'
 require File.join(File.dirname(__FILE__), *%w[lib log_buddy version])
 
 echoe = Echoe.new('log_buddy', LogBuddy::VERSION::STRING) do |p|
@@ -18,25 +21,18 @@ end
 Rake.application.instance_variable_get(:@tasks).delete("default")
 Rake.application.instance_variable_get(:@tasks).delete("test")
 
-namespace :micronaut do
-  
-  desc 'Run all examples'
-  task :examples do
-    examples = Dir["examples/**/*_example.rb"].map { |g| Dir.glob(g) }.flatten
-    examples.map! {|f| %Q(require "#{f}")}
-    command = "-e '#{examples.join("; ")}'"
-    ruby command
-  end
-  
+desc "Run all examples"
+Micronaut::RakeTask.new(:examples)
+
+namespace :examples do
   desc "Run all examples using rcov"
-  task :coverage do
-    examples = Dir["examples/**/*_example.rb"].map { |g| Dir.glob(g) }.flatten
-    system "rcov --exclude \"examples/*,gems/*,db/*,/Library/Ruby/*,config/*\" --text-report --sort coverage --no-validator-links #{examples.join(' ')}"
+  Micronaut::RakeTask.new :coverage do |t|
+    t.rcov = true
+    t.rcov_opts = %[--exclude "gems/*,/Library/Ruby/*,config/*" --text-summary  --sort coverage --no-validator-links]
   end
-  
 end
 
-task :default => 'micronaut:coverage'
+task :default => 'examples:coverage'
 
 # The below results in 'input stream exhausted' - dunno why?
 # task :release => [:test, :publish_docs, :announce]

data/examples/{example_helper.rb → log_buddy/example_helper.rb}

@@ -1,10 +1,10 @@
 require 'logger'
 require 'rubygems'
-gem 'spicycode-micronaut', "~> 0.1.5"
+gem "spicycode-micronaut", ">= 0.2.0"
 gem 'mocha'
 require "mocha"
 require 'micronaut'
-require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "log_buddy"))
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "lib", "log_buddy"))
 
 def silence_warnings
   old_verbose, $VERBOSE = $VERBOSE, nil
@@ -15,6 +15,7 @@ end
 
 Micronaut.configure do |config|
   config.mock_with :mocha
+  config.formatter = :documentation
+  config.color_enabled = true
   config.filter_run :options => { :focused => true }
-  config.autorun!
 end

data/examples/log_buddy/gem_logger_example.rb

@@ -0,0 +1,45 @@
+require File.expand_path(File.join(File.dirname(__FILE__), *%w[example_helper]))
+
+describe LogBuddy::GemLogger do
+
+  describe "starting Gem logging" do
+    
+    it "includes GemLogger into Gem when #log_gems! is called" do
+      Gem.expects(:include).with(LogBuddy::GemLogger)
+      LogBuddy::GemLogger.log_gems!
+    end
+    
+  end
+  
+  describe "Gem#activation monkey patching for logging" do
+    
+    before do 
+      LogBuddy.init
+      LogBuddy::GemLogger.log_gems!
+    end
+
+    it "should log the gem name and version and where it was called from" do
+      Gem.stubs(:activate_without_logging)
+    
+      LogBuddy.expects(:debug).with do |msg|
+        msg.should include(%[Gem activation for gem: 'gem-name' version: '0.5' called from:\n])
+        gem_calling_line = __LINE__ + 3
+        msg.should include(%[examples/log_buddy/gem_logger_example.rb:#{gem_calling_line}])
+      end
+      gem "gem-name", "0.5"
+    end
+  
+    it "should do the original gem activation call" do
+      LogBuddy.stubs(:debug)
+      Gem.expects(:activate_without_logging).with('gem-name', ">= 1.0.0")
+      gem "gem-name", ">= 1.0.0"
+    end
+  
+    it "should add alias gem_without_logging" do
+      Gem.should respond_to(:activate)
+      Gem.should respond_to(:activate_without_logging)
+    end
+    
+  end
+  
+end

data/examples/{log_buddy_init_example.rb → log_buddy/log_buddy_init_example.rb}

@@ -4,6 +4,11 @@ describe LogBuddy do
   describe "init" do
     after  { reset_safe_log_buddy_mode }
 
+    it "should call log_gems! if log_gems is true" do
+      LogBuddy::GemLogger.expects(:log_gems!)
+      LogBuddy.init :log_gems => true
+    end
+    
     it "doesnt mixin to object if SAFE_LOG_BUDDY is true" do
       LogBuddy.expects(:init).never
       ENV["SAFE_LOG_BUDDY"] = "true"
@@ -17,7 +22,7 @@ describe LogBuddy do
 
     def load_init
       silence_warnings do
-        load File.join(File.dirname(__FILE__), *%w[.. init.rb])
+        load File.join(File.dirname(__FILE__), *%w[.. .. init.rb])
       end
     end
 
@@ -25,6 +30,13 @@ describe LogBuddy do
       ENV["SAFE_LOG_BUDDY"] = nil
     end
     
+    it "should be disabled when the :disabled key is true" do
+      LogBuddy.init(:disabled => true)
+      fake_logger = mock('logger')
+      LogBuddy.stubs(:logger).returns(fake_logger)
+      fake_logger.expects(:debug).never
+      d { "Hello, World!" }
+    end
   end
 
 end

data/lib/log_buddy/gem_logger.rb

@@ -0,0 +1,24 @@
+module LogBuddy
+  module GemLogger
+
+    BACKTRACE_SIZE = 0..5
+    
+    def self.log_gems!
+      Gem.send :include, LogBuddy::GemLogger
+    end
+    
+    def self.included(mod)
+
+      class << mod
+        def activate_with_logging(gem, *version_requirements)
+          d %[Gem activation for gem: '#{gem}' version: '#{version_requirements}' called from:\n#{caller[BACKTRACE_SIZE].join("\n")}]
+          activate_without_logging(gem, *version_requirements)
+        end
+
+        alias_method :activate_without_logging, :activate
+        alias_method :activate, :activate_with_logging
+      end
+      
+    end
+  end
+end

data/lib/log_buddy/utils.rb

@@ -2,6 +2,7 @@ module LogBuddy
   module Utils
   
     def debug(obj)
+      return if @disabled
       str = obj_to_string(obj)
       stdout_puts(str) if log_to_stdout?
       logger.debug(str)

data/lib/log_buddy/version.rb

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

data/lib/log_buddy.rb

@@ -1,5 +1,6 @@
 require File.join(File.dirname(__FILE__), *%w[log_buddy utils])
 require File.join(File.dirname(__FILE__), *%w[log_buddy mixin])
+require File.join(File.dirname(__FILE__), *%w[log_buddy gem_logger])
 require File.join(File.dirname(__FILE__), *%w[log_buddy version])
 
 =begin rdoc
@@ -26,10 +27,15 @@ module LogBuddy
   # * <tt>:logger</tt> - the logger instance that LogBuddy should use (if not provided, 
   #   tries to default to RAILS_DEFAULT_LOGGER, and then to a STDOUT logger).
   # * <tt):log_to_stdout</tt> - whether LogBuddy should _also_ log to STDOUT, very helpful for Autotest (default is +true+).
+  # * <tt>:disabled</tt> - when true, LogBuddy will not produce any output
+  # * <tt>:log_gems</tt> - log Gem activation process - useful for tracking down Gem activation errors (default is +false+)
   def self.init(options = {})
     @logger = options[:logger]
     @log_to_stdout = options.has_key?(:log_to_stdout) ? options[:log_to_stdout] : true
+    @log_gems = options[:log_gems]
+    @disabled = (options[:disabled] == true)
     mixin_to_object
+    GemLogger.log_gems! if @log_gems
   end
 
   # Add the LogBuddy::Mixin to Object instance and class level.

data/log_buddy.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{log_buddy}
-  s.version = "0.2.2"
+  s.version = "0.4.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rob Sanheim - Relevance"]
-  s.date = %q{2008-12-23}
+  s.date = %q{2009-01-19}
   s.description = %q{Log statements along with their name easily.  Mixin a logger everywhere when you need it.}
   s.email = %q{opensource@thinkrelevance.com}
-  s.extra_rdoc_files = ["CHANGELOG", "lib/log_buddy/mixin.rb", "lib/log_buddy/utils.rb", "lib/log_buddy/version.rb", "lib/log_buddy.rb", "LICENSE", "log_buddy.gemspec", "README.rdoc"]
-  s.files = ["CHANGELOG", "examples/example_helper.rb", "examples/log_buddy_example.rb", "examples/log_buddy_init_example.rb", "examples/log_example.rb", "examples.rb", "init.rb", "lib/log_buddy/mixin.rb", "lib/log_buddy/utils.rb", "lib/log_buddy/version.rb", "lib/log_buddy.rb", "LICENSE", "log_buddy.gemspec", "Manifest", "Rakefile", "README.rdoc"]
+  s.extra_rdoc_files = ["CHANGELOG", "lib/log_buddy/gem_logger.rb", "lib/log_buddy/mixin.rb", "lib/log_buddy/utils.rb", "lib/log_buddy/version.rb", "lib/log_buddy.rb", "LICENSE", "log_buddy.gemspec", "README.rdoc"]
+  s.files = ["CHANGELOG", "examples/log_buddy/example_helper.rb", "examples/log_buddy/gem_logger_example.rb", "examples/log_buddy/log_buddy_example.rb", "examples/log_buddy/log_buddy_init_example.rb", "examples/log_buddy/log_example.rb", "examples.rb", "init.rb", "lib/log_buddy/gem_logger.rb", "lib/log_buddy/mixin.rb", "lib/log_buddy/utils.rb", "lib/log_buddy/version.rb", "lib/log_buddy.rb", "LICENSE", "log_buddy.gemspec", "Manifest", "Rakefile", "README.rdoc"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/relevance/log_buddy}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Log_buddy", "--main", "README.rdoc"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: relevance-log_buddy
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.4.9
 platform: ruby
 authors: 
 - Rob Sanheim - Relevance
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-23 00:00:00 -08:00
+date: 2009-01-19 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,6 +65,7 @@ extensions: []
 
 extra_rdoc_files: 
 - CHANGELOG
+- lib/log_buddy/gem_logger.rb
 - lib/log_buddy/mixin.rb
 - lib/log_buddy/utils.rb
 - lib/log_buddy/version.rb
@@ -74,12 +75,14 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - CHANGELOG
-- examples/example_helper.rb
-- examples/log_buddy_example.rb
-- examples/log_buddy_init_example.rb
-- examples/log_example.rb
+- examples/log_buddy/example_helper.rb
+- examples/log_buddy/gem_logger_example.rb
+- examples/log_buddy/log_buddy_example.rb
+- examples/log_buddy/log_buddy_init_example.rb
+- examples/log_buddy/log_example.rb
 - examples.rb
 - init.rb
+- lib/log_buddy/gem_logger.rb
 - lib/log_buddy/mixin.rb
 - lib/log_buddy/utils.rb
 - lib/log_buddy/version.rb