relevance-log_buddy 0.0.2

data/CHANGELOG

@@ -0,0 +1,21 @@
+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
+
+v0.0.2. rdocs; support for multiple statements in one "d" call separated by semicolons
+
+v0.0.1. Initial release to github; Birthday

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

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

data/README.rdoc

@@ -0,0 +1,88 @@
+= LogBuddy
+  
+== DESCRIPTION:
+
+log_buddy is your friendly little log buddy at your side, helping you dev, debug, and test.
+
+== 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:
+    
+    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'
+    class MyClass; end
+    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
+in the block and the result.  Examples:
+
+    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!"
+
+
+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
+ 
+== ISSUES
+
+* 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 install log_buddy
+
+== 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
+* RDocs: http://thinkrelevance.rubyforge.org/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,46 @@
+require 'rubygems'
+gem 'echoe'
+require 'echoe'
+require File.join(File.dirname(__FILE__), *%w[lib log_buddy version])
+
+echoe = Echoe.new('log_buddy', LogBuddy::VERSION::STRING) 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 = 'Log statements along with their name easily.  Mixin a logger everywhere when you need it.'
+  p.url = "http://opensource.thinkrelevance.com/wiki/log_buddy"
+  p.rdoc_pattern = /^(lib|bin|ext)|txt|rdoc|CHANGELOG|LICENSE$/
+  rdoc_template = `allison --path`.strip << ".rb"
+  p.rdoc_template = rdoc_template
+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/example_helper.rb

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

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

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

data/examples.rb

@@ -0,0 +1,23 @@
+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 "hi"                    # logs "hi" (regular old logging)
+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,2 @@
+require File.join(File.dirname(__FILE__), *%w[lib log_buddy])
+LogBuddy.init unless ENV["SAFE_LOG_BUDDY"]

data/lib/log_buddy.rb

@@ -0,0 +1,66 @@
+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.
+
+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
+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+).
+  def self.init(options = {})
+    @logger = options[:logger]
+    @log_to_stdout = options.has_key?(:log_to_stdout) ? options[:log_to_stdout] : true
+    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
+      extend LogBuddy::Mixin
+    }
+  end
+
+  class << self
+    include LogBuddy::Utils
+    def logger
+      return @logger if @logger
+      @logger = init_default_logger
+    end
+    
+    def log_to_stdout?
+      @log_to_stdout
+    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
+    
+  end
+end

data/log_buddy.gemspec

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{log_buddy}
+  s.version = "0.0.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-11-26}
+  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.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.summary = %q{Log Buddy is your little development buddy.}
+
+  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"])
+      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"])
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: relevance-log_buddy
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Rob Sanheim - Relevance
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-26 00:00:00 -08: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: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: allison
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: markaby
+  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: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/log_buddy.rb
+- LICENSE
+- README.rdoc
+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
+has_rdoc: true
+homepage: http://opensource.thinkrelevance.com/wiki/log_buddy
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Log_buddy
+- --main
+- README.rdoc
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: thinkrelevance
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Log Buddy is your little development buddy.
+test_files: []
+