relevance-log_buddy 0.0.2 → 0.0.3

data/CHANGELOG

@@ -1,17 +1,3 @@
-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.2  Attempting to fix rubygems errors
-
-v0.1.1. Handle exceptions from within the block
-
-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
 
 v0.0.3. specs and tweaks

data/Manifest

@@ -1,12 +1,8 @@
 CHANGELOG
+Manifest
+README.rdoc
+Rakefile
 examples.rb
 init.rb
 lib/log_buddy.rb
-LICENSE
-log_buddy.gemspec
-Manifest
-Rakefile
-README.rdoc
-examples/example_helper.rb
-examples/log_buddy_init_example.rb
-examples/log_buddy_example.rb
+test/test_log_buddy.rb

data/README.rdoc

@@ -6,18 +6,16 @@ log_buddy is your friendly little log buddy at your side, helping you dev, debug
 
 == 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:
+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") # logs to 'my_log.log'
+    obj.logger.debug("hi")
     class MyClass; end
-    MyClass.logger.info("heya") # also logs to 'my_log.log'
+    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
@@ -41,7 +39,7 @@ See examples.rb for live examples you can run.
 == REQUIREMENTS:
 
 * Ruby 1.8.6 or JRuby (tested with 1.1RC3)
-* untested on Ruby versions before 1.8.6, but should work fine
+* untested on Ruby < 1.8.6, but probably works
  
 == ISSUES
 
@@ -54,10 +52,10 @@ 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
+* Log bugs, issues, and suggestions on Trac: http://opensource.thinkrelevance.com/wiki/log_buddy
+* View Source: http://github.com/relevance/logbuddy/tree/master
 * Git clone Source: git://github.com/relevance/logbuddy.git
-* RDocs: http://thinkrelevance.rubyforge.org/log_buddy
+* RDocs: http://thinkrelevance.rubyforge.org/log_buddy/
 
 == LICENSE:
 
@@ -83,6 +81,3 @@ 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

@@ -1,9 +1,8 @@
 require 'rubygems'
-gem 'echoe'
 require 'echoe'
-require File.join(File.dirname(__FILE__), *%w[lib log_buddy version])
+require './lib/log_buddy.rb'
 
-echoe = Echoe.new('log_buddy', LogBuddy::VERSION::STRING) do |p|
+echoe = Echoe.new('log_buddy', LogBuddy::VERSION) do |p|
   p.rubyforge_name = 'thinkrelevance'
   p.author = 'Rob Sanheim - Relevance'
   p.email = 'opensource@thinkrelevance.com'
@@ -13,34 +12,8 @@ echoe = Echoe.new('log_buddy', LogBuddy::VERSION::STRING) do |p|
   p.rdoc_pattern = /^(lib|bin|ext)|txt|rdoc|CHANGELOG|LICENSE$/
   rdoc_template = `allison --path`.strip << ".rb"
   p.rdoc_template = rdoc_template
+  p.yaml_gemspec = false
 end
 
-Rake.application.instance_variable_get(:@tasks).delete("default")
-Rake.application.instance_variable_get(:@tasks).delete("test")
-
-namespace :micronaut do
-  
-  desc 'Run all examples'
-  task :examples do
-    examples = Dir["examples/**/*_example.rb"].map { |g| Dir.glob(g) }.flatten
-    examples.map! {|f| %Q(require "#{f}")}
-    command = "-e '#{examples.join("; ")}'"
-    ruby command
-  end
-  
-  desc "Run all examples using rcov"
-  task :coverage do
-    examples = Dir["examples/**/*_example.rb"].map { |g| Dir.glob(g) }.flatten
-    system "rcov --exclude \"examples/*,gems/*,db/*,/Library/Ruby/*,config/*\" --text-report --sort coverage --no-validator-links #{examples.join(' ')}"
-  end
-  
-end
-
-task :default => 'micronaut:coverage'
-
-# The below results in 'input stream exhausted' - dunno why?
-# task :release => [:test, :publish_docs, :announce]
-
-echoe.spec.add_development_dependency "echoe"
 echoe.spec.add_development_dependency "allison"
 echoe.spec.add_development_dependency "markaby"

data/examples.rb

@@ -15,7 +15,6 @@ 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,2 +1 @@
-require File.join(File.dirname(__FILE__), *%w[lib log_buddy])
-LogBuddy.init unless ENV["SAFE_LOG_BUDDY"]
+require 'log_buddy'

data/lib/log_buddy.rb

@@ -1,11 +1,7 @@
-require File.join(File.dirname(__FILE__), *%w[log_buddy utils])
-require File.join(File.dirname(__FILE__), *%w[log_buddy mixin])
-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 log shortcut method to give you easy, concise output of variables with their names and values.
+Log shortcut method to give you easy, concise output of variables with their names and values.
 
 Examples:
     a = "foo"
@@ -19,19 +15,15 @@ Examples:
     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, 
-  #   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+).
+class LogBuddy
+  VERSION = '0.0.3'
+
+  # Use LogBuddy!
   def self.init(options = {})
-    @logger = options[:logger]
-    @log_to_stdout = options.has_key?(:log_to_stdout) ? options[:log_to_stdout] : true
+    @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 { 
@@ -39,28 +31,73 @@ module LogBuddy
       extend LogBuddy::Mixin
     }
   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
 
-  class << self
-    include LogBuddy::Utils
+    # Add a default logger to everything, everywhere.
     def logger
-      return @logger if @logger
-      @logger = init_default_logger
-    end
-    
-    def log_to_stdout?
-      @log_to_stdout
+      LogBuddy.default_logger
     end
-    
-    private
-    
-    def 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
+  
+  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")
+    else
+      require 'logger'
+      @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_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
+    lines = File.readlines(file)
     
+    lines[line_number - 1]
   end
+  
 end

data/log_buddy.gemspec

@@ -1,41 +1,37 @@
-# -*- encoding: utf-8 -*-
-
 Gem::Specification.new do |s|
   s.name = %q{log_buddy}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  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-11-26}
+  s.date = %q{2008-07-01}
   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.rb", "LICENSE", "README.rdoc"]
-  s.files = ["CHANGELOG", "examples.rb", "init.rb", "lib/log_buddy.rb", "LICENSE", "log_buddy.gemspec", "Manifest", "Rakefile", "README.rdoc", "examples/example_helper.rb", "examples/log_buddy_init_example.rb", "examples/log_buddy_example.rb"]
+  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.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"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{thinkrelevance}
-  s.rubygems_version = %q{1.3.1}
+  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
     s.specification_version = 2
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<echoe>, [">= 0"])
+    if current_version >= 3 then
       s.add_development_dependency(%q<echoe>, [">= 0"])
       s.add_development_dependency(%q<allison>, [">= 0"])
       s.add_development_dependency(%q<markaby>, [">= 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"])
     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"])

data/test/test_log_buddy.rb

@@ -0,0 +1,124 @@
+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 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])
+      @@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 
+    
+    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: relevance-log_buddy
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Rob Sanheim - Relevance
@@ -9,18 +9,9 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-26 00:00:00 -08:00
+date: 2008-07-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: echoe
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
 - !ruby/object:Gem::Dependency 
   name: echoe
   version_requirement: 
@@ -56,22 +47,18 @@ extensions: []
 
 extra_rdoc_files: 
 - CHANGELOG
-- lib/log_buddy.rb
-- LICENSE
 - README.rdoc
+- lib/log_buddy.rb
 files: 
 - CHANGELOG
+- Manifest
+- README.rdoc
+- Rakefile
 - examples.rb
 - init.rb
 - lib/log_buddy.rb
-- LICENSE
+- test/test_log_buddy.rb
 - log_buddy.gemspec
-- Manifest
-- Rakefile
-- README.rdoc
-- examples/example_helper.rb
-- examples/log_buddy_init_example.rb
-- examples/log_buddy_example.rb
 has_rdoc: true
 homepage: http://opensource.thinkrelevance.com/wiki/log_buddy
 post_install_message: 
@@ -92,7 +79,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">="
+  - - "="
     - !ruby/object:Gem::Version 
       version: "1.2"
   version: 
@@ -103,5 +90,5 @@ rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Log Buddy is your little development buddy.
-test_files: []
-
+test_files: 
+- test/test_log_buddy.rb

data/LICENSE

@@ -1,20 +0,0 @@
-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/examples/example_helper.rb

@@ -1,16 +0,0 @@
-require 'logger'
-require 'rubygems'
-gem 'spicycode-micronaut', "= 0.0.4"
-gem 'mocha'
-require "mocha"
-require 'micronaut'
-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
-
-Micronaut::Runner.autorun

data/examples/log_buddy_example.rb

@@ -1,37 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), *%w[example_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
-  
-  describe "init" 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
-    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 "defaults to log to stdout (as well as logger)" do
-      LogBuddy.init
-      LogBuddy.log_to_stdout?.should == true
-    end
-
-    it "can be configured to log to stdout" do
-      LogBuddy.init :stdout => false
-      LogBuddy.log_to_stdout?.should == true
-    end
-  end
-
-end

data/examples/log_buddy_init_example.rb

@@ -1,30 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), *%w[example_helper]))
-
-describe LogBuddy do
-  describe "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
-
-end