relevance-log_buddy 0.1.3 → 0.1.5

data/CHANGELOG

@@ -1,3 +1,7 @@
+v0.1.5  Clean up specs and remove noise from spec run
+
+v0.1.4  Micronauts Unite! Test Suite now runs via Micronaut - http://github.com/spicycode/micronaut/
+
 v0.1.3  Use plain old echoe; really fix rubygems errors (I hope)
 
 v0.1.2  Attempting to fix rubygems errors

data/Manifest

@@ -1,12 +1,15 @@
 CHANGELOG
-examples.rb
-init.rb
-lib/log_buddy.rb
 LICENSE
-log_buddy.gemspec
 Manifest
-Rakefile
 README.rdoc
-spec/helper.rb
-spec/log_buddy_init_spec.rb
-spec/log_buddy_spec.rb
+Rakefile
+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

data/README.rdoc

@@ -54,10 +54,11 @@ See examples.rb for live examples you can run.
 
 == URLS
 
-* Log bugs, issues, and suggestions on Trac: http://opensource.thinkrelevance.com/wiki/log_buddy
-* View Source: http://github.com/relevance/logbuddy/tree/master
+* Log bugs, issues, and suggestions at Lighthouse: http://relevance.lighthouseapp.com/projects/19074-log-buddy/overview
+* View Source: http://github.com/relevance/logbuddy
 * Git clone Source: git://github.com/relevance/logbuddy.git
-* RDocs: http://thinkrelevance.rubyforge.org/log_buddy/
+* Continuous Integration: http://runcoderun.com/relevance/logbuddy
+* RDocs: http://thinkrelevance.rubyforge.org/log_buddy
 
 == LICENSE:
 

data/Rakefile

@@ -1,27 +1,43 @@
 require 'rubygems'
 gem 'echoe'
 require 'echoe'
-require './lib/log_buddy.rb'
+require File.join(File.dirname(__FILE__), *%w[lib log_buddy version])
 
-echoe = Echoe.new('log_buddy', LogBuddy::VERSION) do |p|
+echoe = Echoe.new('log_buddy', LogBuddy::VERSION::STRING) do |p|
   p.rubyforge_name = 'thinkrelevance'
   p.author = 'Rob Sanheim - Relevance'
   p.email = 'opensource@thinkrelevance.com'
   p.summary = 'Log Buddy is your little development buddy.'
   p.description = 'Log statements along with their name easily.  Mixin a logger everywhere when you need it.'
-  p.url = "http://opensource.thinkrelevance.com/wiki/log_buddy"
-  p.rdoc_pattern = /^(lib|bin|ext)|txt|rdoc|CHANGELOG|LICENSE$/
+  p.url = "http://github.com/relevance/logbuddy"
+  p.rdoc_pattern = /^(lib|bin|ext)|txt|rdoc|gemspec|CHANGELOG|LICENSE$/
   rdoc_template = `allison --path`.strip << ".rb"
   p.rdoc_template = rdoc_template
 end
 
-desc 'Test LogBuddy.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.pattern = 'spec/**/*_spec.rb'
-  t.verbose = true
+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 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(' ')}"
+  end
+  
 end
 
+task :default => 'micronaut:coverage'
+
 # The below results in 'input stream exhausted' - dunno why?
 # task :release => [:test, :publish_docs, :announce]
 

data/{spec/helper.rb → examples/example_helper.rb}

@@ -1,9 +1,9 @@
+require 'logger'
 require 'rubygems'
-require "test/unit"
-require "test/spec"
-require "test/spec/should-output"
+gem 'spicycode-micronaut', "= 0.0.4"
+gem 'mocha'
 require "mocha"
-require "redgreen" unless Object.const_defined?("TextMate")
+require 'micronaut'
 require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "log_buddy"))
 
 def silence_warnings
@@ -12,3 +12,5 @@ def silence_warnings
 ensure
   $VERBOSE = old_verbose
 end
+
+Micronaut::Runner.autorun

data/examples/log_buddy_example.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.join(File.dirname(__FILE__), *%w[example_helper]))
+
+describe LogBuddy do
+  
+  it "has logger" do
+    LogBuddy.should respond_to(:logger)
+  end
+  
+  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 "defaults to log to stdout (as well as logger)" do
+      LogBuddy.init
+      LogBuddy.log_to_stdout?.should == true
+    end
+
+    it "can be configured to log to stdout" do
+      LogBuddy.init :stdout => false
+      LogBuddy.log_to_stdout?.should == true
+    end
+  end
+
+end

data/examples/log_buddy_init_example.rb

@@ -0,0 +1,30 @@
+require File.expand_path(File.join(File.dirname(__FILE__), *%w[example_helper]))
+
+describe LogBuddy do
+  describe "init" do
+    after  { reset_safe_log_buddy_mode }
+
+    it "doesnt mixin to object if SAFE_LOG_BUDDY is true" do
+      LogBuddy.expects(:init).never
+      ENV["SAFE_LOG_BUDDY"] = "true"
+      load_init
+    end
+
+    it "mixin to object if SAFE_LOG_BUDDY is true" do
+      LogBuddy.expects(:init).once
+      load_init
+    end
+
+    def load_init
+      silence_warnings do
+        load File.join(File.dirname(__FILE__), *%w[.. init.rb])
+      end
+    end
+
+    def reset_safe_log_buddy_mode
+      ENV["SAFE_LOG_BUDDY"] = nil
+    end
+    
+  end
+
+end

data/{spec/log_buddy_spec.rb → examples/log_example.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), *%w[helper]))
+require File.expand_path(File.join(File.dirname(__FILE__), *%w[example_helper]))
 
 module SomeModule
   def self.say_something(name)
@@ -9,58 +9,45 @@ module SomeModule
     "hello"
   end
   
-  def self.raise_exception
-    raise Exception
+  def self.raise_runtime_error
+    raise RuntimeError
   end
 end
 
-describe "LogBuddy" do
-  describe "object extensions" 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
+describe LogBuddy::Mixin, " behavior" do
     
-    it "adds logger method to Object instance and class" do
+  it "uses RAILS_DEFAULT_LOGGER if its defined" do
+    begin
+      Object.const_set "RAILS_DEFAULT_LOGGER", stub_everything
       LogBuddy.init
-      Object.new.should.respond_to :logger
-      Object.should.respond_to :logger
-    end
-    
-    it "uses RAILS_DEFAULT_LOGGER if its defined" do
-      begin
-        Object.const_set "RAILS_DEFAULT_LOGGER", stub_everything
-        LogBuddy.init
-        Object.logger.should == RAILS_DEFAULT_LOGGER
-      ensure 
-        Object.send :remove_const, "RAILS_DEFAULT_LOGGER"
-      end
+      Object.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.default_logger
-    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 :default_logger => file_logger
-      Object.logger.should == file_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 }
+    before { LogBuddy.init :log_to_stdout => false }
     it "should log to default logger" do
-      LogBuddy.expects(:default_logger).returns(logger = mock)
+      LogBuddy.expects(:logger).returns(logger = mock)
       logger.expects(:debug).with(anything)
-      d {'hi'}
+      d {'hi man'}
     end
     
     it "should log a plain arg" do
-      LogBuddy.expects(:debug).with('hi')
-      d 'hi'
+      LogBuddy.expects(:debug).with('hey yo')
+      d 'hey yo'
     end
     
     it "logs both if given an arg and a block" do
@@ -71,7 +58,7 @@ describe "LogBuddy" do
     end
     
     it "does nothing without a block" do
-      should.not.raise { d }
+      lambda { d }.should_not raise_error
     end
     
     it "should output only local vars in the block" do
@@ -114,9 +101,25 @@ describe "LogBuddy" do
       d { local1; local2; @ivar1 }
     end
     
-    it "should gracefully handle exceptions" do
-      LogBuddy.expects(:debug).with('LogBuddy caught an exception: Exception')
-      d { SomeModule.raise_exception }
+    it "should gracefully handle runtimer errors" do
+      LogBuddy.expects(:debug).with('LogBuddy caught an exception: RuntimeError')
+      d { SomeModule.raise_runtime_error }
+    end
+    
+  end
+  
+  describe "stdout" do
+    before { Logger.any_instance.stubs(:debug) }
+    it "logs to stdout as well as the default logger" do
+      LogBuddy.init :log_to_stdout => true
+      LogBuddy.expects(:stdout_puts).with(%["foo" = 'foo'\n])
+      d { "foo" }
+    end
+    
+    it "doesnt log to stdout if stdout configured off" do
+      LogBuddy.init :log_to_stdout => false
+      LogBuddy.expects(:stdout_puts).never
+      d { "foo" }
     end
   end
 end

data/init.rb

@@ -1,2 +1,2 @@
-require 'log_buddy'
+require File.join(File.dirname(__FILE__), *%w[lib log_buddy])
 LogBuddy.init unless ENV["SAFE_LOG_BUDDY"]

data/lib/log_buddy.rb

@@ -1,7 +1,11 @@
+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 version])
+
 =begin rdoc
 LogBuddy is a developer tool for easy logging while testing, debugging, and inspecting.
   
-Log shortcut method to give you easy, concise output of variables with their names and values.
+The log shortcut method to give you easy, concise output of variables with their names and values.
 
 Examples:
     a = "foo"
@@ -15,15 +19,19 @@ Examples:
     d { bark }   # logs "bark = woof!"
     
 =end
-class LogBuddy
-  VERSION = '0.1.3'
-
-  # Use LogBuddy!
+module LogBuddy
+  # Configure and include LogBuddy into Object.
+  # You can pass in any of the following configuration options:
+  # 
+  # * <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+).
   def self.init(options = {})
-    @logger = options[:default_logger]
+    @logger = options[:logger]
+    @log_to_stdout = options.has_key?(:log_to_stdout) ? options[:log_to_stdout] : true
     mixin_to_object
   end
-  
+
   # Add the LogBuddy::Mixin to Object instance and class level.
   def self.mixin_to_object
     Object.class_eval { 
@@ -31,77 +39,28 @@ class LogBuddy
       extend LogBuddy::Mixin
     }
   end
-  
-  # The main Mixin that gets added on the #init call
-  module Mixin
-    # This is where the magic happens.  This method can take a plain old string, and it will log 
-    # it like any call to Logger#debug.  To get the name of the thing you are logging and its value,
-    # use the block form:
-    #    d { @a }
-    #
-    # Seperate with semicolons for multiple things - pretty much any valid ruby will work.
-    #    d { @@foo; MY_CONST }
-    #    d { @person; @@place; object.method() }
-    #
-    def d(msg = nil, &blk)
-      LogBuddy.debug(msg) if msg
-      return unless block_given?
-      begin
-        logged_line = LogBuddy.read_line(caller[0])
-        arguments = LogBuddy.parse_args(logged_line)
-        arguments.each do |arg|
-          result = eval(arg, blk.binding)
-          LogBuddy.debug(%[#{arg} = '#{result}'\n])
-        end
-      rescue Exception => e
-        LogBuddy.debug "LogBuddy caught an exception: #{e.message}"
-      end
-    end
 
-    # Add a default logger to everything, everywhere.
+  class << self
+    include LogBuddy::Utils
     def logger
-      LogBuddy.default_logger
+      return @logger if @logger
+      @logger = init_default_logger
     end
-  end
-  
-  private
-  
-  # Default logger LogBuddy will use
-  def self.default_logger
-    return @logger if @logger
-    @logger = init_default_logger
-  end
-  
-  # Attempt to establish a default logger - first try RAILS_DEFAULT_LOGGER,
-  # then fallback to default.
-  def self.init_default_logger
-    if Object.const_defined?("RAILS_DEFAULT_LOGGER")
-      @logger = Object.const_get("RAILS_DEFAULT_LOGGER")
-    else
-      require 'logger'
-      @logger = Logger.new(STDOUT)
+    
+    def log_to_stdout?
+      @log_to_stdout
+    end
+    
+    private
+    
+    def init_default_logger
+      if Object.const_defined?("RAILS_DEFAULT_LOGGER")
+        @logger = Object.const_get("RAILS_DEFAULT_LOGGER")
+      else
+        require 'logger'
+        @logger = Logger.new(STDOUT)
+      end
     end
-  end
-  
-  # Just debug it
-  def self.debug(str)
-    default_logger.debug(str)
-  end
-  
-  # Returns array of arguments in the block
-  # You must ues the brace form (ie d { "hi" }) and not do...end
-  def self.parse_args(logged_line)
-    block_contents = logged_line[/\{(.*)\}/, 1]
-    args = block_contents.split(";").map {|arg| arg.strip }
-  end
-  
-  # Return the calling line
-  def self.read_line(frame)
-    file, line_number = frame.split(/:/, 2)
-    line_number = line_number.to_i
-    lines = File.readlines(file)
     
-    lines[line_number - 1]
   end
-  
-end
+end

data/lib/log_buddy/mixin.rb

@@ -0,0 +1,32 @@
+module LogBuddy
+  # The main Mixin that gets added on the #init call
+  module Mixin
+    # This is where the magic happens.  This method can take a plain old string, and it will log 
+    # it like any call to Logger#debug.  To get the name of the thing you are logging and its value,
+    # use the block form:
+    #    d { @a }
+    #
+    # Seperate with semicolons for multiple things - pretty much any valid ruby will work.
+    #    d { @@foo; MY_CONST }
+    #    d { @person; @@place; object.method() }
+    #
+    def d(msg = nil, &blk)
+      LogBuddy.debug(msg) if msg
+      return unless block_given?
+      begin
+        logged_line = LogBuddy.read_line(caller[0])
+        arguments = LogBuddy.parse_args(logged_line)
+        arguments.each do |arg|
+          result = eval(arg, blk.binding)
+          LogBuddy.debug(%[#{arg} = '#{result}'\n])
+        end
+      rescue RuntimeError => e
+        LogBuddy.debug "LogBuddy caught an exception: #{e.message}"
+      end
+    end
+    
+    def logger
+      LogBuddy.logger
+    end 
+  end
+end

data/lib/log_buddy/utils.rb

@@ -0,0 +1,29 @@
+module LogBuddy
+  module Utils
+  
+    def debug(str)
+      stdout_puts(str) if log_to_stdout?
+      logger.debug(str)
+    end
+  
+    def stdout_puts(str)
+      puts str
+    end
+  
+    # Returns array of arguments in the block
+    # You must ues the brace form (ie d { "hi" }) and not do...end
+    def parse_args(logged_line)
+      block_contents = logged_line[/\{(.*)\}/, 1]
+      args = block_contents.split(";").map {|arg| arg.strip }
+    end
+  
+    # Return the calling line
+    def read_line(frame)
+      file, line_number = frame.split(/:/, 2)
+      line_number = line_number.to_i
+      lines = File.readlines(file)
+    
+      lines[line_number - 1]
+    end
+  end
+end

data/lib/log_buddy/version.rb

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

data/log_buddy.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{log_buddy}
-  s.version = "0.1.3"
+  s.version = "0.1.5"
 
   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-11-08}
+  s.date = %q{2008-12-05}
   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.rb", "LICENSE", "README.rdoc"]
-  s.files = ["CHANGELOG", "examples.rb", "init.rb", "lib/log_buddy.rb", "LICENSE", "log_buddy.gemspec", "Manifest", "Rakefile", "README.rdoc", "spec/helper.rb", "spec/log_buddy_init_spec.rb", "spec/log_buddy_spec.rb"]
+  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.rdoc", "lib/log_buddy/mixin.rb", "lib/log_buddy/utils.rb", "lib/log_buddy/version.rb", "lib/log_buddy.rb", "log_buddy.gemspec"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README.rdoc", "Rakefile", "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", "log_buddy.gemspec"]
   s.has_rdoc = true
-  s.homepage = %q{http://opensource.thinkrelevance.com/wiki/log_buddy}
+  s.homepage = %q{http://github.com/relevance/logbuddy}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Log_buddy", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{thinkrelevance}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: relevance-log_buddy
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors: 
 - Rob Sanheim - Relevance
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-08 00:00:00 -08:00
+date: 2008-12-05 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -56,24 +56,32 @@ extensions: []
 
 extra_rdoc_files: 
 - CHANGELOG
-- lib/log_buddy.rb
 - LICENSE
 - README.rdoc
+- lib/log_buddy/mixin.rb
+- lib/log_buddy/utils.rb
+- lib/log_buddy/version.rb
+- lib/log_buddy.rb
+- log_buddy.gemspec
 files: 
 - CHANGELOG
+- LICENSE
+- Manifest
+- README.rdoc
+- Rakefile
+- 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
-- spec/helper.rb
-- spec/log_buddy_init_spec.rb
-- spec/log_buddy_spec.rb
 has_rdoc: true
-homepage: http://opensource.thinkrelevance.com/wiki/log_buddy
+homepage: http://github.com/relevance/logbuddy
 post_install_message: 
 rdoc_options: 
 - --line-numbers

data/spec/log_buddy_init_spec.rb

@@ -1,27 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), *%w[helper]))
-
-describe "LogBuddy init" do
-  after  { reset_safe_log_buddy_mode }
-  
-  it "doesnt mixin to object if SAFE_LOG_BUDDY is true" do
-    LogBuddy.expects(:init).never
-    ENV["SAFE_LOG_BUDDY"] = "true"
-    load_init
-  end
-  
-  it "mixin to object if SAFE_LOG_BUDDY is true" do
-    LogBuddy.expects(:init).once
-    load_init
-  end
-  
-  def load_init
-    silence_warnings do
-      load File.join(File.dirname(__FILE__), *%w[.. init.rb])
-    end
-  end
-
-  def reset_safe_log_buddy_mode
-    ENV["SAFE_LOG_BUDDY"] = nil
-  end
-
-end