debug_log 0.0.3 → 0.1.0

data/.gitignore

@@ -1,3 +1,4 @@
 pkg/*
 *.gem
 .bundle
+doc/*

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    debug_log (0.0.3)
+    debug_log (0.1.0)
 
 GEM
   remote: http://rubygems.org/

data/README.rdoc

@@ -0,0 +1,30 @@
+= Debug Log
+
+This is a simple RubyGem that provides a more convenient and powerful way of doing debug printouts than using
+puts or a logger directly.
+
+== Usage
+
+Require the gem. If you are using Bundler, add this to your Gemfile:
+
+ gem 'debug_log', '~> version known to work'
+
+Now you can do debug printouts like this:
+
+ my_list = [:a, :b, :c]
+ my_number = 5
+ debug.log("at the end of bar", "my_number", "my_list.size")
+
+The first argument to the log method is a comment and the following arguments are Ruby expression that will be evaluated. Here is an example of what the output can look like:
+
+ DebugLog | at the end of bar | my_number="5" (Fixnum), my_list.size="3" (Fixnum) | /Users/peter/tmp/debug-example.rb:7:in `foo'
+
+By default the logger will log to stdout, but you can change that through the configuration options:
+
+  DebugLog.logger = lambda { |message| Rails.logger.info(message) }
+  DebugLog.stdout = false # defaults to true
+  DebugLog.enabled = false # defaults to true
+
+== Credit
+
+The approach to patching the binding object was taken from Niclas Nilssons presentation "The Ruby advantage - metaprogramming and DSLs" at Nordic Ruby 2010. Niclas has packaged up his own solution to debug printouts in his {dp gem}[https://github.com/niclasnilsson/dp].

data/lib/debug_log.rb

@@ -33,7 +33,7 @@ module DebugLog
     return unless enabled
     message = [prefix, comment, expression_string(binding, *expressions), calling_method].join(separator)
     puts(message) if stdout
-    logger.info(message) if logger
+    logger.call(message) if logger
   end
 
   def self.expression_string(binding, *expressions)

data/lib/debug_log/version.rb

@@ -1,3 +1,3 @@
 module DebugLog
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/spec/debug_log_spec.rb

@@ -39,9 +39,9 @@ describe DebugLog do
       invoke_log
     end
 
-    it "invokes info on the logger object if there is one" do
+    it "invokes logger object if there is one" do
       logger = Logger.new($stdout)
-      DebugLog.logger = logger
+      DebugLog.logger = lambda { |message| logger.info(message) }
 
       log_expectations
       DebugLog.expects(:puts).with(@expected_message)
@@ -71,7 +71,7 @@ describe DebugLog do
   describe "logger" do
     it "defaults to nil but can be initialized to a logger object" do
       DebugLog.logger.should be_nil
-      logger = Logger.new($stdout)
+      logger = lambda { |message| puts message }
       DebugLog.logger = logger
       DebugLog.logger.should == logger
     end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 3
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors: 
 - Peter Marklund
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-01 00:00:00 +01:00
+date: 2010-11-05 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,6 +60,7 @@ files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
+- README.rdoc
 - Rakefile
 - debug_log.gemspec
 - lib/debug_log.rb
@@ -81,7 +82,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -634113617
+      hash: -720494829
       segments: 
       - 0
       version: "0"
@@ -90,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -634113617
+      hash: -720494829
       segments: 
       - 0
       version: "0"