log_buddy 0.6.0 → 0.7.0

data/.gitignore

@@ -0,0 +1,8 @@
+.tm_last_run_ruby
+*.log
+doc/*
+pkg/*
+coverage
+TAGS
+coverage/
+Gemfile.lock

data/.rvmrc

@@ -1 +1 @@
-rvm use ruby-1.9.2-p0
+rvm use ruby-1.9.2

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby
+script: bundle exec rspec spec

data/CHANGELOG

@@ -1,3 +1,9 @@
+v0.7.0
+* Add use_awesome_print option for logging
+* Fix warning from #split called on nil
+* Put tests on travis
+* Clean up Rakefile and gemspec
+
 v0.6.0 Use Rails.logger if available - avoid deprecation warnings in Rails 3+
 
 v0.5.1 init automatically unless SAFE_LOG_BUDDY (in ENV) is set
@@ -39,4 +45,4 @@ v0.0.3. specs and tweaks
 
 v0.0.2. rdocs; support for multiple statements in one "d" call separated by semicolons
 
-v0.0.1. Initial release to github; Birthday
+v0.0.1. Initial release to github; Birthday

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.markdown

@@ -1,17 +1,19 @@
 # LogBuddy
-  
+
 ## DESCRIPTION
 
 log_buddy is your friendly little log buddy at your side, helping you dev, debug, and test.
 
+[![Build Status](https://secure.travis-ci.org/relevance/log_buddy.png?branch=master)](http://travis-ci.org/relevance/log_buddy)
+
 ## 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.
 
 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')
-    
+
+    LogBuddy.init :logger => Logger.new('my_log.log')
+
 Now you have your logger available from any object, at the instance level and class level:
 
     obj = Object.new
@@ -25,7 +27,7 @@ in the block and the result.  Examples:
 
     a = "foo"
     @a = "my var"
-    @@bar = "class var!"
+    @@bar = "class var!
     def bark
      "woof!"
     end
@@ -44,9 +46,8 @@ When you occasionally want to disable LogBuddy (but you don't want to have to re
 
 ## REQUIREMENTS
 
-* Ruby 1.8.6 or JRuby (tested with 1.1RC3)
-* untested on Ruby versions before 1.8.6, but should work fine
- 
+* Ruby 1.8.7 and greater or JRuby
+
 ## ISSUES
 
 * 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.
@@ -54,14 +55,14 @@ When you occasionally want to disable LogBuddy (but you don't want to have to re
 
 ## INSTALL
 
-	sudo gem install log_buddy
+	gem install log_buddy
 
 ## URLS
 
-* 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
-* RDocs: http://thinkrelevance.rubyforge.org/log_buddy
+* File Issues: http://github.com/relevance/log\_buddy/issues
+* View Source: http://github.com/relevance/log\_buddy
+* Git clone Source: git://github.com/relevance/log\_buddy.git
+* Documentation: http://rdoc.info/gems/log\_buddy
 
 ## LICENSE
 
@@ -86,4 +87,4 @@ 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.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,69 +1,33 @@
-$:.unshift File.expand_path('../lib', __FILE__)
+require 'bundler/gem_tasks'
 
 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 "rspec", "~> 2.2"
-    gem.add_development_dependency "mocha", "~> 0.9"
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler not available. Install it with: gem install jeweler"
-end
-
-begin 
   require 'rspec/core/rake_task'
-  
+
   RSpec::Core::RakeTask.new(:spec)
-  
+
   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
-  
-  RubyVersions = %w[1.8.7 1.9.1 1.9.2]
-  
+
+  require "yaml"
+  RubyVersions = YAML.load_file(".travis.yml")["rvm"]
   desc "Run Rspec against multiple Rubies: #{RubyVersions.join(", ")}"
   task :spec_all do
-    cmd = %[bash -c 'source ~/.rvm/scripts/rvm; rvm #{RubyVersions.join(",")} rake spec']
+    cmd = %[bash -c 'source ~/.rvm/scripts/rvm; rvm #{RubyVersions.join(",")} do rake spec']
     puts cmd
-    system %[bash -c 'source ~/.rvm/scripts/rvm; rvm #{RubyVersions.join(",")} rake spec']
+    system cmd
   end
-  
+
 
   if RUBY_VERSION <= "1.8.7"
-    task :default => [:check_dependencies, :coverage]
+    task :default => [:coverage]
   else
-    task :default => [:check_dependencies, :spec]
+    task :default => [:spec]
   end
 rescue LoadError => e
   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|
-  version = LogBuddy::Version::STRING
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "log_buddy #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/lib/log_buddy.rb

@@ -4,7 +4,7 @@ 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.
-  
+
 The <tt>d</tt> log method to give you easy, concise output of variables with their names and values.
 
 Requiring 'log_buddy' will _automatically_ mixin the <tt>d</tt> method into Object.  You can avoid this
@@ -20,26 +20,28 @@ Examples:
     d { a }      # logs "a = 'foo'"
     d { @a }     # logs "@a = 'my var'"
     d { bark }   # logs "bark = woof!"
-    
+
 =end
 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, 
+  #
+  # * <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>: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>:use_awesome_print</tt> - when true, LogBuddy will log object with awesome_print
   def self.init(options = {})
     @logger = options[:logger]
     @log_to_stdout = options.has_key?(:log_to_stdout) ? options[:log_to_stdout] : true
+    @use_awesome_print = options.has_key?(:use_awesome_print) ? options[:use_awesome_print] : false
     @disabled = (options[:disabled] == true)
     mixin_to_object
   end
 
   # Add the LogBuddy::Mixin to Object instance and class level.
   def self.mixin_to_object
-    Object.class_eval { 
+    Object.class_eval {
       include LogBuddy::Mixin
       extend LogBuddy::Mixin
     }
@@ -51,13 +53,17 @@ module LogBuddy
       return @logger if @logger
       @logger = init_default_logger
     end
-    
+
     def log_to_stdout?
       @log_to_stdout
     end
-    
+
+    def use_awesome_print?
+      @use_awesome_print
+    end
+
     private
-    
+
     # First try Rails.logger, then RAILS_DEFAULT_LOGGER (for older
     # versions of Rails), then just use a STDOUT Logger
     def init_default_logger
@@ -70,12 +76,12 @@ module LogBuddy
         Logger.new(STDOUT)
       end
     end
-    
+
     def rails_environment
       Object.const_defined?("Rails") && Object.const_get("Rails")
     end
-    
+
   end
-  
+
   init unless ENV["SAFE_LOG_BUDDY"]
-end
+end

data/lib/log_buddy/utils.rb

@@ -1,51 +1,51 @@
 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)
     end
-    
+
     def arg_and_blk_debug(arg, blk)
       result = eval(arg, blk.binding)
       result_str = obj_to_string(result, :quote_strings => true)
       LogBuddy.debug(%[#{arg} = #{result_str}\n])
     end
-  
+
     def stdout_puts(str)
       puts str
     end
-    
+
     # Returns array of arguments in the block
     # You must use 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 }
+      args = block_contents ? 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
-    
+
     def obj_to_string(obj, options = {})
       quote_strings = options.delete(:quote_strings)
       case obj
       when ::String
-        quote_strings ? %["#{obj}"] : obj 
+        quote_strings ? %["#{obj}"] : obj
       when ::Exception
         "#{ obj.message } (#{ obj.class })\n" <<
           (obj.backtrace || []).join("\n")
       else
-        obj.inspect
+        LogBuddy.use_awesome_print? && obj.respond_to?(:ai) ?
+          obj.ai : obj.inspect
       end
     end
-    
   end
-end
+end

data/lib/log_buddy/version.rb

@@ -1,7 +1,7 @@
 module LogBuddy
   module Version #:nodoc:
     MAJOR = 0
-    MINOR = 6
+    MINOR = 7
     TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')

data/log_buddy.gemspec

@@ -1,65 +1,20 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+require File.expand_path('../lib/log_buddy/version', __FILE__)
 
-Gem::Specification.new do |s|
-  s.name = %q{log_buddy}
-  s.version = "0.6.0"
+Gem::Specification.new do |gem|
+  gem.authors       = ["Rob Sanheim"]
+  gem.email         = ["rsanheim@gmail.com"]
+  gem.description   = %q{Log statements along with their name easily.  Mixin a logger everywhere when you need it.}
+  gem.summary       = %q{Log Buddy is your little development buddy.}
+  gem.homepage      = %q{http://github.com/relevance/log_buddy}
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Rob Sanheim"]
-  s.date = %q{2010-12-06}
-  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 = [
-    "LICENSE",
-    "README.markdown"
-  ]
-  s.files = [
-    ".rvmrc",
-    ".treasure_map.rb",
-    "CHANGELOG",
-    "LICENSE",
-    "README.markdown",
-    "Rakefile",
-    "examples.rb",
-    "init.rb",
-    "lib/log_buddy.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"
-  ]
-  s.homepage = %q{http://github.com/relevance/log_buddy}
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Log Buddy is your little development buddy.}
-  s.test_files = [
-    "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::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, ["~> 2.2"])
-      s.add_development_dependency(%q<mocha>, ["~> 0.9"])
-    else
-      s.add_dependency(%q<rspec>, ["~> 2.2"])
-      s.add_dependency(%q<mocha>, ["~> 0.9"])
-    end
-  else
-    s.add_dependency(%q<rspec>, ["~> 2.2"])
-    s.add_dependency(%q<mocha>, ["~> 0.9"])
-  end
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "log_buddy"
+  gem.version       = LogBuddy::Version::STRING
+  gem.add_development_dependency 'rspec', "~> 2.8"
+  gem.add_development_dependency 'mocha', "~> 0.9"
+  gem.add_development_dependency "rake", "~> 0.9.2"
+  gem.add_development_dependency 'bundler', '~> 1.1'
 end
-

data/spec/log_buddy/log_buddy_spec.rb

@@ -1,11 +1,11 @@
 require File.expand_path(File.join(File.dirname(__FILE__), *%w[spec_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
@@ -26,6 +26,16 @@ describe LogBuddy do
       LogBuddy.init :stdout => false
       LogBuddy.log_to_stdout?.should == true
     end
+
+    it "defaults to not using awesome_print for object inspection" do
+      LogBuddy.init
+      LogBuddy.use_awesome_print?.should == false
+    end
+
+    it "can be configured to use awesome_print for object inspection" do
+      LogBuddy.init :use_awesome_print => true
+      LogBuddy.use_awesome_print?.should == true
+    end
   end
-  
-end
+
+end

data/spec/log_buddy/log_spec.rb

@@ -152,6 +152,10 @@ describe LogBuddy::Mixin, " behavior" do
       def inspect
         "inspeck yo-self"
       end
+
+      def ai
+        "awesome_print y0"
+      end
     end
     
     it "logs string as-is" do
@@ -171,6 +175,11 @@ describe LogBuddy::Mixin, " behavior" do
     it "logs all other objects with #inspect" do
       obj_to_string(Foo.new).should == "inspeck yo-self"
     end
+
+    it "logs object using awesome_print" do
+      LogBuddy.init :use_awesome_print => true
+      obj_to_string(Foo.new).should == "awesome_print y0"
+    end
   end
   
   describe "stdout" do

data/spec/log_buddy/spec_helper.rb

@@ -10,7 +10,7 @@ ensure
   $VERBOSE = old_verbose
 end
 
-Rspec.configure do |config|
+RSpec.configure do |config|
   config.filter_run :focused => true
   config.run_all_when_everything_filtered = true
   config.color_enabled = true

metadata

@@ -1,63 +1,93 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: log_buddy
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 6
-  - 0
-  version: 0.6.0
+version: !ruby/object:Gem::Version
+  version: 0.7.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Rob Sanheim
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-12-06 00:00:00 -06:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 2
-        version: "2.2"
+      - !ruby/object:Gem::Version
+        version: '2.8'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
   name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 9
-        version: "0.9"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
   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
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Log statements along with their name easily.  Mixin a logger everywhere
+  when you need it.
+email:
+- rsanheim@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE
-- README.markdown
-files: 
+extra_rdoc_files: []
+files:
+- .gitignore
 - .rvmrc
-- .treasure_map.rb
+- .travis.yml
 - CHANGELOG
+- Gemfile
 - LICENSE
 - README.markdown
 - Rakefile
@@ -72,39 +102,37 @@ files:
 - 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: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 1993013800647532161
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 1993013800647532161
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Log Buddy is your little development buddy.
-test_files: 
+test_files:
 - spec/log_buddy/log_buddy_init_spec.rb
 - spec/log_buddy/log_buddy_spec.rb
 - spec/log_buddy/log_spec.rb

data/.treasure_map.rb

@@ -1,17 +0,0 @@
-map_for(:log_buddy) do |wizard|
-  
-  wizard.keep_a_watchful_eye_for 'lib', 'examples'
-
-  wizard.prepare_spell_for %r%examples/(.*)_example\.rb% do |spell_component|
-    ["examples/#{spell_component[1]}_example.rb"]
-  end
-  
-  wizard.prepare_spell_for %r%examples/example_helper\.rb% do |spell_component|
-    Dir["examples/**/*_example.rb"]
-  end
- 
-  wizard.prepare_spell_for %r%lib/(.*)\.rb% do |spell_component|
-    ["examples/#{spell_component[1]}_example.rb"]
-  end
-  
-end