relevance-log_buddy 0.0.5 → 0.1.0

data/CHANGELOG

@@ -1,3 +1,7 @@
+v0.1.0. Specify, clean up
+
+v0.0.6. changed to mixing to Object by default - set ENV["SAFE_LOG_BUDDY"] = true to override
+
 v0.0.5. update echoe dependency to work with github
 
 v0.0.4. add dev dependencies, remove gem calls from rdoc task

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 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
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/Manifest

@@ -1,8 +1,12 @@
 CHANGELOG
-Manifest
-README.rdoc
-Rakefile
 examples.rb
 init.rb
 lib/log_buddy.rb
-test/test_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

data/README.rdoc

@@ -6,16 +6,18 @@ log_buddy is your friendly little log buddy at your side, helping you dev, debug
 
 == SYNOPSIS:
 
-Call LogBuddy.init to use log_buddy.  It will add two methods to object instance and class level: "d" and "logger".  You can use your own logger with Logbuddy by passing it into init's options hash:
+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')
     
 Now you have your logger available from any object, at the instance level and class level:
 
     obj = Object.new
-    obj.logger.debug("hi")
+    obj.logger.debug("hi") # logs to 'my_log.log'
     class MyClass; end
-    MyClass.logger.info("heya")
+    MyClass.logger.info("heya") # also logs to 'my_log.log'
 
 You also have a method called "d" (for "debug") on any object, which is used for quick debugging and logging of things while you are developing.
 Its especially useful while using autotest.  When you call the "d" method with an inline block, it will log the name of the things
@@ -39,7 +41,7 @@ See examples.rb for live examples you can run.
 == REQUIREMENTS:
 
 * Ruby 1.8.6 or JRuby (tested with 1.1RC3)
-* untested on Ruby < 1.8.6, but probably works
+* untested on Ruby versions before 1.8.6, but should work fine
  
 == ISSUES
 
@@ -81,3 +83,6 @@ 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.
+ 
+ 
+ 

data/Rakefile

@@ -22,5 +22,12 @@ echoe = Echoe.new('log_buddy', LogBuddy::VERSION) do |p|
   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
+end
+
 echoe.spec.add_development_dependency "allison"
 echoe.spec.add_development_dependency "markaby"

data/examples.rb

@@ -15,6 +15,7 @@ module Foo;
 end
   
 
+d "hi"                    # logs "hi" (regular old logging)
 d { a }                   # logs "a = 'foo'"
 d { @a }                  # logs "@a = 'my var'"
 d { @@bar }               # logs "@@bar = 'class var!'"

data/init.rb

@@ -1 +1,2 @@
-require 'log_buddy'
+require 'log_buddy'
+LogBuddy.init unless ENV["SAFE_LOG_BUDDY"]

data/lib/log_buddy.rb

@@ -16,7 +16,7 @@ Examples:
     
 =end
 class LogBuddy
-  VERSION = '0.0.5'
+  VERSION = '0.1.0'
 
   # Use LogBuddy!
   def self.init(options = {})

data/log_buddy.gemspec

@@ -1,14 +1,14 @@
 Gem::Specification.new do |s|
   s.name = %q{log_buddy}
-  s.version = "0.0.5"
+  s.version = "0.1.0"
 
   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-07-04}
+  s.date = %q{2008-09-29}
   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", "README.rdoc", "lib/log_buddy.rb"]
-  s.files = ["CHANGELOG", "Manifest", "README.rdoc", "Rakefile", "examples.rb", "init.rb", "lib/log_buddy.rb", "test/test_log_buddy.rb", "log_buddy.gemspec"]
+  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.has_rdoc = true
   s.homepage = %q{http://opensource.thinkrelevance.com/wiki/log_buddy}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Log_buddy", "--main", "README.rdoc"]
@@ -16,7 +16,6 @@ Gem::Specification.new do |s|
   s.rubyforge_project = %q{thinkrelevance}
   s.rubygems_version = %q{1.2.0}
   s.summary = %q{Log Buddy is your little development buddy.}
-  s.test_files = ["test/test_log_buddy.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/spec/helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require "test/unit"
+require "test/spec"
+require "test/spec/should-output"
+require "mocha"
+require "redgreen" rescue nil
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "log_buddy"))
+
+def silence_warnings
+  old_verbose, $VERBOSE = $VERBOSE, nil
+  yield
+ensure
+  $VERBOSE = old_verbose
+end

data/spec/log_buddy_init_spec.rb

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

data/{test/test_log_buddy.rb → spec/log_buddy_spec.rb}

@@ -1,10 +1,4 @@
-require 'rubygems'
-require "test/unit"
-require "test/spec"
-require "test/spec/should-output"
-require 'mocha'
-require 'logger'
-require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "log_buddy"))
+require File.expand_path(File.join(File.dirname(__FILE__), *%w[helper]))
 
 module SomeModule
   def self.say_something(name)
@@ -17,13 +11,8 @@ module SomeModule
 end
 
 describe "LogBuddy" do
-  
-  describe "raise no method error if init isn't called" do
-    lambda { Object.new.d }.should.raise NoMethodError
-  end
-  
   describe "object extensions" do
-    it "mixes itself into Object intance and class level by default" 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: relevance-log_buddy
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors: 
 - Rob Sanheim - Relevance
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-04 00:00:00 -07:00
+date: 2008-09-29 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,18 +47,22 @@ extensions: []
 
 extra_rdoc_files: 
 - CHANGELOG
-- README.rdoc
 - lib/log_buddy.rb
+- LICENSE
+- README.rdoc
 files: 
 - CHANGELOG
-- Manifest
-- README.rdoc
-- Rakefile
 - examples.rb
 - init.rb
 - lib/log_buddy.rb
-- test/test_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
 post_install_message: 
@@ -90,5 +94,5 @@ rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Log Buddy is your little development buddy.
-test_files: 
-- test/test_log_buddy.rb
+test_files: []
+