log_buddy 0.4.12 → 0.5.0

data/CHANGELOG

@@ -1,3 +1,11 @@
+
+v0.x.x. Overall cleanup and making things safer:
+  - move to Rspec2
+  - move Version into the code base as a constant and out of yml
+  - remove GemLoger
+  - don't mixin in a logger method to Object, ever -- too dangerous.
+  - fix issue where logged line goes away and raises exception (GH-2)
+
 v0.4.10 Switch to jeweler; remove dependencies that were superfluous
 
 v0.4.9  Added gem logging for debugging help when tracking down Gem activation errors

data/README.markdown

@@ -1,10 +1,10 @@
 # LogBuddy
   
-## DESCRIPTION:
+## DESCRIPTION
 
 log_buddy is your friendly little log buddy at your side, helping you dev, debug, and test.
 
-## SYNOPSIS:
+## SYNOPSIS
 
 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.
 
@@ -42,7 +42,7 @@ When you occasionally want to disable LogBuddy (but you don't want to have to re
 
 	LogBuddy.init :disabled => true
 
-## REQUIREMENTS:
+## REQUIREMENTS
 
 * Ruby 1.8.6 or JRuby (tested with 1.1RC3)
 * untested on Ruby versions before 1.8.6, but should work fine
@@ -52,7 +52,7 @@ When you occasionally want to disable LogBuddy (but you don't want to have to re
 * This is meant for non-production use while developing and testing --> it does stuff that is slow and you probably don't want happening in your production environment.
 * Don't even try using this in irb.
 
-## INSTALL:
+## INSTALL
 
 	sudo gem install log_buddy
 
@@ -61,10 +61,9 @@ When you occasionally want to disable LogBuddy (but you don't want to have to re
 * Log bugs, issues, and suggestions at Lighthouse: http://relevance.lighthouseapp.com/projects/19074-log-buddy/overview
 * View Source: http://github.com/relevance/log_buddy
 * Git clone Source: git://github.com/relevance/log_buddy.git
-* Continuous Integration: http://runcoderun.com/relevance/log_buddy
 * RDocs: http://thinkrelevance.rubyforge.org/log_buddy
 
-## LICENSE:
+## LICENSE
 
 (The MIT License)
 

data/Rakefile

@@ -1,51 +1,67 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+
 begin
   require 'jeweler'
+  require 'log_buddy/version'
   Jeweler::Tasks.new do |gem|
     gem.name = "log_buddy"
+    gem.version = LogBuddy::Version::STRING
     gem.summary = %Q{Log Buddy is your little development buddy.}
     gem.description = %Q{Log statements along with their name easily.  Mixin a logger everywhere when you need it.}
     gem.email = "rsanheim@gmail.com"
     gem.homepage = "http://github.com/relevance/log_buddy"
     gem.authors = ["Rob Sanheim"]
-    gem.add_development_dependency "micronaut", ">= 0.3.0"
-    gem.add_development_dependency "mocha", ">= 0.3.0"
+    gem.add_development_dependency "rspec", "~> 2.0.0.beta.8"
+    gem.add_development_dependency "mocha", "~> 0.9.0"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+  puts "Jeweler not available. Install it with: gem install jeweler"
 end
 
 begin 
-  require 'micronaut/rake_task'
+  require 'rspec/core/rake_task'
+  
+  RSpec::Core::RakeTask.new(:spec)
   
-  Micronaut::RakeTask.new(:examples) do |examples|
-    examples.pattern = 'examples/**/*_example.rb'
-    examples.ruby_opts << '-Ilib -Iexamples'
+  RSpec::Core::RakeTask.new(:coverage) do |spec|
+    spec.pattern = 'spec/**/*_spec.rb'
+    spec.rcov_opts = %[-Ilib -Ispec --exclude "gems/*,/Library/Ruby/*,config/*" --text-summary  --sort coverage]
+    spec.rcov = true
   end
-
-  Micronaut::RakeTask.new(:rcov) do |examples|
-    examples.pattern = 'examples/**/*_example.rb'
-    examples.rcov_opts = %[-Ilib -Iexamples --exclude "gems/*,/Library/Ruby/*,config/*" --text-summary  --sort coverage]
-    examples.rcov = true
+  
+  RubyVersions = %w[1.8.7 1.9.1 1.9.2]
+  
+  desc "Run Rspec against multiple Rubies: #{RubyVersions.join(", ")}"
+  task :spec_all do
+    cmd = %[bash -c 'source ~/.rvm/scripts/rvm; rvm #{RubyVersions.join(",")} rake spec']
+    puts cmd
+    system %[bash -c 'source ~/.rvm/scripts/rvm; rvm #{RubyVersions.join(",")} rake spec']
   end
+  
 
-  task :default => [:check_dependencies, :rcov]
+  if RUBY_VERSION <= "1.8.7"
+    task :default => [:check_dependencies, :coverage]
+  else
+    task :default => [:check_dependencies, :spec]
+  end
 rescue LoadError => e
-  puts "Micronaut not available to run tests.  Install it with: sudo gem install spicycode-micronaut -s http://gems.github.com"
+  puts "Rspec not available to run tests.  Install it with: gem install rspec --pre"
   puts e
   puts e.backtrace
 end
 
+begin
+  %w{sdoc sdoc-helpers rdiscount}.each { |name| gem name }
+  require 'sdoc_helpers'
+rescue LoadError => ex
+  puts "sdoc support not enabled:"
+  puts ex.inspect
+end
+
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION.yml')
-    require 'yaml'
-    config = YAML.load(File.read('VERSION.yml'))
-    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
-  else
-    version = ""
-  end
-
+  version = LogBuddy::Version::STRING
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "log_buddy #{version}"
   rdoc.rdoc_files.include('README*')

data/lib/log_buddy/mixin.rb

@@ -19,13 +19,9 @@ module LogBuddy
         arguments.each do |arg|
           LogBuddy.arg_and_blk_debug(arg, blk)
         end
-      rescue RuntimeError => e
+      rescue => e
         LogBuddy.debug "LogBuddy caught an exception: #{e.message}"
       end
     end
-    
-    def logger
-      LogBuddy.logger
-    end 
   end
 end

data/lib/log_buddy/version.rb

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

data/lib/log_buddy.rb

@@ -1,6 +1,5 @@
 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
@@ -28,14 +27,11 @@ module LogBuddy
   #   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

@@ -1,12 +1,15 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{log_buddy}
-  s.version = "0.4.12"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rob Sanheim"]
-  s.date = %q{2009-05-22}
+  s.date = %q{2010-05-28}
   s.description = %q{Log statements along with their name easily.  Mixin a logger everywhere when you need it.}
   s.email = %q{rsanheim@gmail.com}
   s.extra_rdoc_files = [
@@ -20,45 +23,44 @@ Gem::Specification.new do |s|
      "LICENSE",
      "README.markdown",
      "Rakefile",
-     "VERSION.yml",
      "examples.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",
      "init.rb",
      "lib/log_buddy.rb",
-     "lib/log_buddy/gem_logger.rb",
      "lib/log_buddy/mixin.rb",
      "lib/log_buddy/utils.rb",
      "lib/log_buddy/version.rb",
-     "log_buddy.gemspec"
+     "log_buddy.gemspec",
+     "spec/log_buddy/log_buddy_init_spec.rb",
+     "spec/log_buddy/log_buddy_spec.rb",
+     "spec/log_buddy/log_spec.rb",
+     "spec/log_buddy/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/relevance/log_buddy}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{thinkrelevance}
-  s.rubygems_version = %q{1.3.3}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Log Buddy is your little development buddy.}
   s.test_files = [
-    "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"
+    "spec/log_buddy/log_buddy_init_spec.rb",
+     "spec/log_buddy/log_buddy_spec.rb",
+     "spec/log_buddy/log_spec.rb",
+     "spec/log_buddy/spec_helper.rb"
   ]
 
   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
-      s.add_development_dependency(%q<spicycode-micronaut>, [">= 0"])
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.0.0.beta.8"])
+      s.add_development_dependency(%q<mocha>, ["~> 0.9.0"])
     else
-      s.add_dependency(%q<spicycode-micronaut>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.8"])
+      s.add_dependency(%q<mocha>, ["~> 0.9.0"])
     end
   else
-    s.add_dependency(%q<spicycode-micronaut>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.8"])
+    s.add_dependency(%q<mocha>, ["~> 0.9.0"])
   end
 end
+

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

@@ -1,14 +1,9 @@
-require File.expand_path(File.join(File.dirname(__FILE__), *%w[example_helper]))
+require File.expand_path(File.join(File.dirname(__FILE__), *%w[spec_helper]))
 
 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"

data/{examples/log_buddy/log_buddy_example.rb → spec/log_buddy/log_buddy_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), *%w[example_helper]))
+require File.expand_path(File.join(File.dirname(__FILE__), *%w[spec_helper]))
 
 describe LogBuddy do
   
@@ -9,20 +9,14 @@ describe LogBuddy do
   it "has stdout config option" do
     LogBuddy.should respond_to(:log_to_stdout?)
   end
-  
-  describe "init" do
-    it "mixes itself into Object instance and class level by default" do
-      Object.expects(:include).with(LogBuddy::Mixin)
-      Object.expects(:extend).with(LogBuddy::Mixin)
-      LogBuddy.init
-    end
 
-    it "adds logger method to Object instance and class" do
-      LogBuddy.init
-      Object.new.should respond_to(:logger)
-      Object.should respond_to(:logger)
-    end
-    
+  it "can override the default logger" do
+    file_logger = Logger.new "test.log"
+    LogBuddy.init :logger => file_logger
+    LogBuddy.logger.should == file_logger
+  end
+
+  describe "init" do
     it "defaults to log to stdout (as well as logger)" do
       LogBuddy.init
       LogBuddy.log_to_stdout?.should == true
@@ -33,5 +27,5 @@ describe LogBuddy do
       LogBuddy.log_to_stdout?.should == true
     end
   end
-
+  
 end

data/{examples/log_buddy/log_example.rb → spec/log_buddy/log_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), *%w[example_helper]))
+require File.expand_path(File.join(File.dirname(__FILE__), *%w[spec_helper]))
 
 module SomeModule
   def self.say_something(name)
@@ -20,23 +20,12 @@ describe LogBuddy::Mixin, " behavior" do
     begin
       Object.const_set "RAILS_DEFAULT_LOGGER", stub_everything
       LogBuddy.init
-      Object.logger.should == RAILS_DEFAULT_LOGGER
+      LogBuddy.logger.should == RAILS_DEFAULT_LOGGER
     ensure 
       Object.send :remove_const, "RAILS_DEFAULT_LOGGER"
     end
   end
     
-  it "uses a plain STDOUT Ruby logger if there is no RAILS_DEFAULT_LOGGER" do
-    LogBuddy.init
-    Object.logger.should == LogBuddy.logger
-  end
-    
-  it "can override the default logger" do
-    file_logger = Logger.new "test.log"
-    LogBuddy.init :logger => file_logger
-    Object.logger.should == file_logger
-  end
-  
   describe "outputting the code being logged and its result" do
     before { LogBuddy.init :log_to_stdout => false }
     it "should log to default logger" do
@@ -101,11 +90,6 @@ describe LogBuddy::Mixin, " behavior" do
       d { local1; local2; @ivar1 }
     end
     
-    it "should gracefully handle runtimer errors" do
-      LogBuddy.expects(:debug).with('LogBuddy caught an exception: RuntimeError')
-      d { SomeModule.raise_runtime_error }
-    end
-    
     it "logs things okay with inline rdoc" do
       LogBuddy.stubs(:debug)
       hsh = {:foo=>"bar", "key"=>"value"}
@@ -122,6 +106,22 @@ describe LogBuddy::Mixin, " behavior" do
       d { hsh }
     end 
     
+    describe "error cases" do
+
+      it "should gracefully handle runtimer errors" do
+        LogBuddy.expects(:debug).with('LogBuddy caught an exception: RuntimeError')
+        d { SomeModule.raise_runtime_error }
+      end
+      
+      it "gracefully handles case where the line of code is empty" do
+        LogBuddy.expects(:read_line).returns("")
+        lambda {
+          d { SomeModule.raise_runtime_error }
+        }.should_not raise_error
+      end
+    end
+    
+    
   end
   
   describe "obj_to_string" do

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

@@ -1,6 +1,6 @@
-require 'logger'
+require "logger"
 require "mocha"
-require 'micronaut'
+require "rspec"
 require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "lib", "log_buddy"))
 
 def silence_warnings
@@ -10,10 +10,11 @@ ensure
   $VERBOSE = old_verbose
 end
 
-Micronaut.configure do |config|
+Rspec.configure do |config|
   config.mock_with :mocha
   config.formatter = :documentation
   config.color_enabled = true
   config.alias_example_to :fit, :focused => true
   config.filter_run :options => { :focused => true }
+  config.run_all_when_everything_filtered = true
 end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: log_buddy
 version: !ruby/object:Gem::Version 
-  version: 0.4.12
+  hash: 11
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Rob Sanheim
@@ -9,19 +15,43 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-22 00:00:00 -04:00
+date: 2010-05-28 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: spicycode-micronaut
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 62196467
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 8
+        version: 2.0.0.beta.8
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+        hash: 59
+        segments: 
+        - 0
+        - 9
+        - 0
+        version: 0.9.0
+  type: :development
+  version_requirements: *id002
 description: Log statements along with their name easily.  Mixin a logger everywhere when you need it.
 email: rsanheim@gmail.com
 executables: []
@@ -38,20 +68,17 @@ files:
 - LICENSE
 - README.markdown
 - Rakefile
-- VERSION.yml
 - examples.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
 - init.rb
 - lib/log_buddy.rb
-- lib/log_buddy/gem_logger.rb
 - lib/log_buddy/mixin.rb
 - lib/log_buddy/utils.rb
 - lib/log_buddy/version.rb
 - log_buddy.gemspec
+- spec/log_buddy/log_buddy_init_spec.rb
+- spec/log_buddy/log_buddy_spec.rb
+- spec/log_buddy/log_spec.rb
+- spec/log_buddy/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/relevance/log_buddy
 licenses: []
@@ -62,27 +89,32 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: thinkrelevance
-rubygems_version: 1.3.5
+rubyforge_project: 
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Log Buddy is your little development buddy.
 test_files: 
-- 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
+- spec/log_buddy/log_buddy_init_spec.rb
+- spec/log_buddy/log_buddy_spec.rb
+- spec/log_buddy/log_spec.rb
+- spec/log_buddy/spec_helper.rb

data/VERSION.yml

@@ -1,4 +0,0 @@
---- 
-:major: 0
-:minor: 4
-:patch: 12

data/examples/log_buddy/gem_logger_example.rb

@@ -1,49 +0,0 @@
-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
-
-  if RUBY_VERSION != '1.9.1'
-    
-    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
-  
-end

data/lib/log_buddy/gem_logger.rb

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