log_buddy 0.2.0 → 0.2.2

data/CHANGELOG

@@ -1,12 +1,12 @@
-v0.2.0  Better log output of objects based on their type, very similiar to Logger/irb behavior; update to micronaut 0.1.0
+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
+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.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.3. Use plain old echoe; really fix rubygems errors (I hope)
 
-v0.1.2  Attempting to fix rubygems errors
+v0.1.2. Attempting to fix rubygems errors
 
 v0.1.1. Handle exceptions from within the block
 

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)
@@ -55,9 +59,9 @@ See examples.rb for live examples you can run.
 == URLS
 
 * 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
-* Continuous Integration: http://runcoderun.com/relevance/logbuddy
+* 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:

data/Rakefile

@@ -9,7 +9,7 @@ echoe = Echoe.new('log_buddy', LogBuddy::VERSION::STRING) do |p|
   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://github.com/relevance/logbuddy"
+  p.url = "http://github.com/relevance/log_buddy"
   p.rdoc_pattern = /^(lib|bin|ext)|txt|rdoc|gemspec|CHANGELOG|LICENSE$/
   rdoc_template = `allison --path`.strip << ".rb"
   p.rdoc_template = rdoc_template
@@ -43,4 +43,5 @@ task :default => 'micronaut:coverage'
 
 echoe.spec.add_development_dependency "echoe"
 echoe.spec.add_development_dependency "allison"
-echoe.spec.add_development_dependency "markaby"
+echoe.spec.add_development_dependency "markaby"
+echoe.spec.add_development_dependency "spicycode-micronaut"

data/examples/example_helper.rb

@@ -1,6 +1,6 @@
 require 'logger'
 require 'rubygems'
-gem 'spicycode-micronaut', "~> 0.1.0"
+gem 'spicycode-micronaut', "~> 0.1.5"
 gem 'mocha'
 require "mocha"
 require 'micronaut'
@@ -15,6 +15,6 @@ end
 
 Micronaut.configure do |config|
   config.mock_with :mocha
-end
-
-Micronaut::Runner.autorun
+  config.filter_run :options => { :focused => true }
+  config.autorun!
+end

data/examples/log_buddy_init_example.rb

@@ -25,6 +25,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.rb

@@ -26,9 +26,11 @@ 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
   def self.init(options = {})
     @logger = options[:logger]
     @log_to_stdout = options.has_key?(:log_to_stdout) ? options[:log_to_stdout] : true
+    @disabled = (options[:disabled] == true)
     mixin_to_object
   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

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

data/log_buddy.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{log_buddy}
-  s.version = "0.2.0"
+  s.version = "0.2.2"
 
   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-09}
+  s.date = %q{2009-01-09}
   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.has_rdoc = true
-  s.homepage = %q{http://github.com/relevance/logbuddy}
+  s.homepage = %q{http://github.com/relevance/log_buddy}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Log_buddy", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{thinkrelevance}
@@ -28,16 +28,19 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<echoe>, [">= 0"])
       s.add_development_dependency(%q<allison>, [">= 0"])
       s.add_development_dependency(%q<markaby>, [">= 0"])
+      s.add_development_dependency(%q<spicycode-micronaut>, [">= 0"])
     else
       s.add_dependency(%q<echoe>, [">= 0"])
       s.add_dependency(%q<echoe>, [">= 0"])
       s.add_dependency(%q<allison>, [">= 0"])
       s.add_dependency(%q<markaby>, [">= 0"])
+      s.add_dependency(%q<spicycode-micronaut>, [">= 0"])
     end
   else
     s.add_dependency(%q<echoe>, [">= 0"])
     s.add_dependency(%q<echoe>, [">= 0"])
     s.add_dependency(%q<allison>, [">= 0"])
     s.add_dependency(%q<markaby>, [">= 0"])
+    s.add_dependency(%q<spicycode-micronaut>, [">= 0"])
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: log_buddy
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors: 
 - Rob Sanheim - Relevance
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-09 00:00:00 -05:00
+date: 2009-01-09 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,6 +52,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: spicycode-micronaut
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: Log statements along with their name easily.  Mixin a logger everywhere when you need it.
 email: opensource@thinkrelevance.com
 executables: []
@@ -85,7 +95,7 @@ files:
 - Rakefile
 - README.rdoc
 has_rdoc: true
-homepage: http://github.com/relevance/logbuddy
+homepage: http://github.com/relevance/log_buddy
 post_install_message: 
 rdoc_options: 
 - --line-numbers