log_buddy 0.0.1 → 0.0.2

data/History.txt

@@ -1,3 +1,7 @@
+=== 0.0.2
+* rdocs
+* support for multiple statements in one "d" call separated by semicolons
+
 === 0.0.1 / 2008-03/28
 
 * Initial commit to github

data/Manifest.txt

@@ -1,7 +1,6 @@
 History.txt
 Manifest.txt
 README.rdoc
-README.txt
 Rakefile
 bin/log_buddy
 examples.rb

data/README.rdoc

@@ -1,45 +1,49 @@
 = LogBuddy
-
-* Log bugs/issues/suggestions here: http://opensource.thinkrelevance.com/wiki/log_buddy
-* Source: http://github.com/relevance/log_buddy/tree/master
-* git clone git://github.com/relevance/log_buddy.git
-* rdocs: 
-
+  
 == DESCRIPTION:
 
 log_buddy is your friendly little log buddy at your side, helping you dev, debug, and test.
 
 == SYNOPSIS:
 
-Call LogBuddy.init to use log_buddy.  It will add two methods to object instance and class level: "d" and "logger".  
+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:
+    
+    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:
 
-* The "logger" method is just a typical logger - it will use the Rails logger if its available.  
-* The "d" method is a special helper that will output the code in the block and its result - note that you *must* use the bracket block form - do...end is not supported.
+    obj = Object.new
+    obj.logger.debug("hi")
+    class MyClass; end
+    MyClass.logger.info("heya")
 
-== EXAMPLES:
+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
+in the block and the result.  Examples:
 
-* see also examples.rb...
+    a = "foo"
+    @a = "my var"
+    @@bar = "class var!"
+    def bark
+     "woof!"
+    end
 
-a = "foo"
-@a = "my var"
-@@bar = "class var!"
-def bark
- "woof!"
-end
+    d { a }      # logs "a = 'foo'"
+    d { @a }     # logs "@a = 'my var'"
+    d { @@bar }  # logs "@@bar = 'class var!'"
+    d { bark }   # logs "bark = woof!"
 
-d { a }      # logs "a = 'foo'"
-d { @a }     # logs "@a = 'my var'"
-d { @@bar }  # logs "@@bar = 'class var!'"
-d { bark }   # logs "bark = woof!"
 
+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
  
 == ISSUES
 
-* Be careful you don't depend on methods that log_buddy adds to Object in production!
 * 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.
 
@@ -47,6 +51,13 @@ d { bark }   # logs "bark = woof!"
 
 * sudo gem log_buddy
 
+== URLS
+
+* Log bugs, issues, and suggestions on Trac: http://opensource.thinkrelevance.com/wiki/log_buddy
+* View Source: http://github.com/relevance/log_buddy/tree/master
+* Git clone Source: git://github.com/relevance/log_buddy.git
+* RDocs: http://thinkrelevance.rubyforge.org/log_buddy/
+
 == LICENSE:
 
 (The MIT License)

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'hoe'
 require './lib/log_buddy.rb'
 
-Hoe.new('log_buddy', LogBuddy::VERSION) do |p|
+hoe = Hoe.new('log_buddy', LogBuddy::VERSION) do |p|
   p.rubyforge_name = 'thinkrelevance'
   p.author = 'Rob Sanheim - Relevance'
   p.email = 'opensource@thinkrelevance.com'
@@ -10,4 +10,24 @@ Hoe.new('log_buddy', LogBuddy::VERSION) do |p|
   p.description = p.paragraphs_of('README.rdoc', 2..5).join("\n\n")
   p.url = p.paragraphs_of('README.rdoc', 0).first.split(/\n/)[1..-1]
   p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.rdoc_pattern = /^(lib|bin|ext)|txt|rdoc$/
+end
+
+# Override RDoc to use allison template, and also use our .rdoc README as the main page instead of the default README.txt
+Rake::RDocTask.new(:docs) do |rd|
+  gem "allison"
+  gem "markaby"
+  rd.main = "README.rdoc"
+  # rd.options << '-d' if RUBY_PLATFORM !~ /win32/ and `which dot` =~ /\/dot/ and not ENV['NODOT']
+  rd.rdoc_dir = 'doc'
+  files = hoe.spec.files.grep(hoe.rdoc_pattern)
+  files -= ['Manifest.txt']
+  rd.rdoc_files.push(*files)
+
+  title = "#{hoe.name}-#{hoe.version} Documentation"
+  title = "#{hoe.rubyforge_name}'s " + title if hoe.rubyforge_name != hoe.name
+  rdoc_template = `allison --path`.strip << ".rb"
+  rd.template = rdoc_template
+  rd.options << "-t #{title}"
+  rd.options << '--line-numbers' << '--inline-source'
 end

data/lib/log_buddy.rb

@@ -1,5 +1,5 @@
 =begin rdoc
-  LogBuddy is a developer tool for easy logging while testing, debugging, and inspecting.
+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.
 
@@ -16,13 +16,15 @@ Examples:
     
 =end
 class LogBuddy
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 
+  # Use LogBuddy!
   def self.init(options = {})
     @logger = options[:default_logger]
     mixin_to_object
   end
   
+  # Add the LogBuddy::Mixin to Object instance and class level.
   def self.mixin_to_object
     Object.class_eval { 
       include LogBuddy::Mixin
@@ -30,11 +32,44 @@ class LogBuddy
     }
   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?
+      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
+    end
+
+    # Add a default logger to everything, everywhere.
+    def logger
+      LogBuddy.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")
@@ -43,15 +78,20 @@ class LogBuddy
       @logger = Logger.new(STDOUT)
     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_args = logged_line[/\{(.*)\}/, 1].strip
+    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
@@ -60,19 +100,4 @@ class LogBuddy
     lines[line_number - 1]
   end
   
-  module Mixin
-    def d(msg = nil, &blk)
-      LogBuddy.debug(msg) if msg
-      return unless block_given?
-      logged_line = LogBuddy.read_line(caller[0])
-      arguments = LogBuddy.parse_args(logged_line)
-      result = eval(arguments, blk.binding)
-      LogBuddy.debug(%[#{arguments} = '#{result}'\n])
-    end
-
-    def logger
-      LogBuddy.default_logger
-    end
-  end
-  
 end

data/test/test_log_buddy.rb

@@ -93,6 +93,12 @@ describe "LogBuddy" do
       @a = "foo"
       d { @a }
     end
+    
+    it "should output constants" do
+      FOO_CONST = "yo!"
+      LogBuddy.expects(:debug).with(%[FOO_CONST = 'yo!'\n])
+      d { FOO_CONST }
+    end
   
     it "should output class vars" do
       LogBuddy.expects(:debug).with(%[@@class_var = 'hi'\n])
@@ -104,5 +110,15 @@ describe "LogBuddy" do
       LogBuddy.expects(:debug).with(%[SomeModule.say_something("dude!!!!") = 'hello dude!!!!'\n])
       d { SomeModule.say_something("dude!!!!") }
     end 
+    
+    it "should output multiple things with each having their own log calls" do
+      local1 = '1'
+      local2 = '2'
+      @ivar1 = '1'
+      LogBuddy.expects(:debug).with(%[local1 = '1'\n])
+      LogBuddy.expects(:debug).with(%[local2 = '2'\n])
+      LogBuddy.expects(:debug).with(%[@ivar1 = '1'\n])
+      d { local1; local2; @ivar1 }
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: log_buddy
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Rob Sanheim - Relevance
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-03-28 00:00:00 -04:00
+date: 2008-04-04 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -21,7 +21,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.5.1
     version: 
-description: "== DESCRIPTION:  log_buddy is your friendly little log buddy at your side, helping you dev, debug, and test.  == SYNOPSIS:  Call LogBuddy.init to use log_buddy.  It will add two methods to object instance and class level: \"d\" and \"logger\"."
+description: "== 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:  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\") class MyClass; end MyClass.logger.info(\"heya\")  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 in the block and the result.  Examples:"
 email: opensource@thinkrelevance.com
 executables: 
 - log_buddy
@@ -30,12 +30,10 @@ extensions: []
 extra_rdoc_files: 
 - History.txt
 - Manifest.txt
-- README.txt
 files: 
 - History.txt
 - Manifest.txt
 - README.rdoc
-- README.txt
 - Rakefile
 - bin/log_buddy
 - examples.rb
@@ -43,7 +41,7 @@ files:
 - lib/log_buddy.rb
 - test/test_log_buddy.rb
 has_rdoc: true
-homepage: 
+homepage: "  "
 post_install_message: 
 rdoc_options: 
 - --main

data/README.txt

@@ -1,73 +0,0 @@
-= LogBuddy
-
-* Log bugs/issues/suggestions here: http://opensource.thinkrelevance.com/wiki/log_buddy
-* Source: http://github.com/relevance/log_buddy/tree/master
-* git clone git://github.com/relevance/log_buddy.git
-* rdocs: 
-
-== DESCRIPTION:
-
-log_buddy is your friendly little log buddy at your side, helping you dev, debug, and test.
-
-== SYNOPSIS:
-
-Call LogBuddy.init to use log_buddy.  It will add two methods to object instance and class level: "d" and "logger".  
-
-* The "logger" method is just a typical logger - it will use the Rails logger if its available.  
-* The "d" method is a special helper that will output the code in the block and its result - note that you *must* use the bracket block form - do...end is not supported.
-
-== EXAMPLES:
-
-* see also examples.rb...
-
-a = "foo"
-@a = "my var"
-@@bar = "class var!"
-def bark
- "woof!"
-end
-
-d { a }      # logs "a = 'foo'"
-d { @a }     # logs "@a = 'my var'"
-d { @@bar }  # logs "@@bar = 'class var!'"
-d { bark }   # logs "bark = woof!"
-
-
-== REQUIREMENTS:
-
-* Ruby 1.8.6 or JRuby (tested with 1.1RC3)
- 
-== ISSUES
-
-* Be careful you don't depend on methods that log_buddy adds to Object in production!
-* 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:
-
-* sudo gem log_buddy
-
-== LICENSE:
-
-(The MIT License)
-
-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.