log_buddy 0.0.1

data/History.txt

@@ -0,0 +1,5 @@
+=== 0.0.1 / 2008-03/28
+
+* Initial commit to github
+* Birthday!
+

data/Manifest.txt

@@ -0,0 +1,10 @@
+History.txt
+Manifest.txt
+README.rdoc
+README.txt
+Rakefile
+bin/log_buddy
+examples.rb
+init.rb
+lib/log_buddy.rb
+test/test_log_buddy.rb

data/README.rdoc

@@ -0,0 +1,73 @@
+= 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.

data/README.txt

@@ -0,0 +1,73 @@
+= 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.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'hoe'
+require './lib/log_buddy.rb'
+
+Hoe.new('log_buddy', LogBuddy::VERSION) 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 = 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")
+end

data/examples.rb

@@ -0,0 +1,22 @@
+require 'lib/log_buddy'
+LogBuddy.init
+
+a = "foo"
+@a = "my var"
+@@bar = "class var!"
+def bark
+ "woof!"
+end
+
+module Foo;
+  def self.module_method
+    "hi!!"
+  end
+end
+  
+
+d { a }                   # logs "a = 'foo'"
+d { @a }                  # logs "@a = 'my var'"
+d { @@bar }               # logs "@@bar = 'class var!'"
+d { bark }                # logs "bark = woof!"
+d { Foo::module_method }  # logs Foo::module_method = 'hi!!'

data/init.rb

@@ -0,0 +1 @@
+require 'log_buddy'

data/lib/log_buddy.rb

@@ -0,0 +1,78 @@
+=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.
+
+Examples:
+    a = "foo"
+    @a = "my var"
+    def bark
+     "woof!"
+    end
+
+    d { a }      # logs "a = 'foo'"
+    d { @a }     # logs "@a = 'my var'"
+    d { bark }   # logs "bark = woof!"
+    
+=end
+class LogBuddy
+  VERSION = '0.0.1'
+
+  def self.init(options = {})
+    @logger = options[:default_logger]
+    mixin_to_object
+  end
+  
+  def self.mixin_to_object
+    Object.class_eval { 
+      include LogBuddy::Mixin
+      extend LogBuddy::Mixin
+    }
+  end
+  
+  def self.default_logger
+    return @logger if @logger
+    @logger = init_default_logger
+  end
+  
+  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)
+    end
+  end
+
+  def self.debug(str)
+    default_logger.debug(str)
+  end
+  
+  def self.parse_args(logged_line)
+    block_args = logged_line[/\{(.*)\}/, 1].strip
+  end
+  
+  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
+  
+  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

@@ -0,0 +1,108 @@
+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"))
+
+module SomeModule
+  def self.say_something(name)
+    "#{message} #{name}"
+  end
+  
+  def self.message
+    "hello"
+  end
+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
+      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 "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
+    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 "can override the default logger" do
+      file_logger = Logger.new "test.log"
+      LogBuddy.init :default_logger => file_logger
+      Object.logger.should == file_logger
+    end
+  end
+  
+  describe "outputting the code being logged and its result" do
+    before { LogBuddy.init }
+    it "should log to default logger" do
+      LogBuddy.expects(:default_logger).returns(logger = mock)
+      logger.expects(:debug).with(anything)
+      d {'hi'}
+    end
+    
+    it "should log a plain arg" do
+      LogBuddy.expects(:debug).with('hi')
+      d 'hi'
+    end
+    
+    it "logs both if given an arg and a block" do
+      LogBuddy.expects(:debug).with('hi mom')
+      LogBuddy.expects(:debug).with(%[foo = 'foo'\n])
+      foo = "foo"
+      d("hi mom") { foo }
+    end
+    
+    it "does nothing without a block" do
+      should.not.raise { d }
+    end
+    
+    it "should output only local vars in the block" do
+      LogBuddy.expects(:debug).with(%[a = 'foo'\n])
+      b = "bad"
+      a = "foo"
+      d { a }
+    end
+  
+    it "should output instance vars" do
+      LogBuddy.expects(:debug).with(%[@a = 'foo'\n])
+      @a = "foo"
+      d { @a }
+    end
+  
+    it "should output class vars" do
+      LogBuddy.expects(:debug).with(%[@@class_var = 'hi'\n])
+      @@class_var = "hi"
+      d { @@class_var }
+    end
+  
+    it "should output method calls" do
+      LogBuddy.expects(:debug).with(%[SomeModule.say_something("dude!!!!") = 'hello dude!!!!'\n])
+      d { SomeModule.say_something("dude!!!!") }
+    end 
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: log_buddy
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Rob Sanheim - Relevance
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-03-28 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !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\"."
+email: opensource@thinkrelevance.com
+executables: 
+- log_buddy
+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
+- init.rb
+- lib/log_buddy.rb
+- test/test_log_buddy.rb
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: thinkrelevance
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Log Buddy is your little development buddy.
+test_files: 
+- test/test_log_buddy.rb