debug_log 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Peter Marklund
+
+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,14 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Run all tests'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/lib/debug_log.rb

@@ -0,0 +1,54 @@
+require 'active_support'
+
+module Kernel
+  alias_method :debug, :binding
+end
+
+class Binding
+  def log(comment, *expressions)
+    DebugLog.log(self, comment, *expressions)
+  end
+end
+
+module DebugLog
+  mattr_accessor :logger
+  self.logger = nil
+
+  mattr_accessor :stdout
+  self.stdout = true
+
+  mattr_accessor :enabled
+  self.enabled = true
+
+  def self.prefix
+    name
+  end
+
+  def self.separator
+    " | "
+  end
+
+  def self.log(binding, comment, *expressions)
+    return unless enabled
+    message = [prefix, comment, expression_string(binding, *expressions), calling_method].join(separator)
+    puts(message) if stdout
+    logger.info(message) if logger
+  end
+
+  def self.expression_string(binding, *expressions)
+    expressions.map { |expression| format_expression(binding, expression) }.join(", ")
+  end
+
+  def self.calling_method
+    Kernel.caller(3).first
+  end
+
+  def self.format_value(value)
+    value.inspect
+  end
+
+  def self.format_expression(binding, expression)
+    value = eval(expression, binding)
+    %Q{#{expression}="#{format_value(value)}" (#{value.class.name})}
+  end
+end

data/test/core_extensions_test.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class CoreExtensionsTest < Test::Unit::TestCase
+  context "Kernel.debug" do
+    it "should return a Binding object" do
+      assert debug.is_a?(Binding)
+    end
+
+    it "should allow evaluation of local variables in the binding" do
+      assert_equal 5, eval("my_variable", debug_with_my_variable)
+    end
+  end
+
+  context "Binding" do
+    it "should have a log method" do
+      args = ["a debug message", 'var1', 'var2']
+      the_binding = binding
+      DebugLog.expects(:log).with(the_binding, *args)
+      the_binding.log(*args)
+    end
+  end
+
+  def debug_with_my_variable
+    my_variable = 5
+    debug
+  end
+end

data/test/debug_log_test.rb

@@ -0,0 +1,146 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class DebugLogTest < Test::Unit::TestCase
+  context "log" do
+    before do
+      @comment = "a debug printout"
+      @expression_string = "expression string"
+      @the_binding = binding
+      @calling_method = "calling method"
+      @expected_message = [DebugLog.prefix, @comment, @expression_string, @calling_method].join(DebugLog.separator)
+      DebugLog.stdout = true
+      DebugLog.enabled = true
+    end
+
+    it "should output a message and a number of variables to stdout" do
+      DebugLog.logger = nil
+
+      log_expectations
+      DebugLog.expects(:puts).with(@expected_message)
+
+      invoke_log
+    end
+
+    it "does not output to stdout if DebugLog.stdout is false" do
+      DebugLog.stdout = false
+
+      log_expectations
+      DebugLog.expects(:puts).never
+
+      invoke_log
+    end
+
+    it "invokes info on the logger object if there is one" do
+      logger = Logger.new($stdout)
+      DebugLog.logger = logger
+
+      log_expectations
+      DebugLog.expects(:puts).with(@expected_message)
+      logger.expects(:info).with(@expected_message)
+
+      invoke_log
+    end
+
+    it "does nothing if DebugLog.enabled = false" do
+      DebugLog.enabled = false
+
+      DebugLog.expects(:puts).never
+
+      invoke_log
+    end
+
+    def log_expectations
+      DebugLog.expects(:calling_method).returns(@calling_method)
+      DebugLog.expects(:expression_string).with(@the_binding, 'my_var', 'my_var[0]').returns(@expression_string)
+    end
+
+    def invoke_log
+      DebugLog.log(@the_binding, @comment, 'my_var', 'my_var[0]')      
+    end
+  end
+
+  context "logger" do
+    it "defaults to nil but can be initialized to a logger object" do
+      assert_equal nil, DebugLog.logger
+      logger = Logger.new($stdout)
+      DebugLog.logger = logger
+      assert_equal logger, DebugLog.logger
+    end
+  end
+
+  context "stdout" do
+    it "is true by default but can be set to false" do
+      assert_equal true, DebugLog.stdout
+      DebugLog.stdout = false
+      assert_equal false, DebugLog.stdout
+    end
+  end
+
+  context "enabled" do
+    it "is true by default but can be set to false" do
+      assert_equal true, DebugLog.enabled
+      DebugLog.enabled = false
+      assert_equal false, DebugLog.enabled
+    end
+  end
+
+  context "calling_method" do
+    it "should get the calling method from the Kernel.caller stack, three steps up" do
+      assert_match /method_that_invokes_debug_log/, method_that_invokes_debug_log
+    end
+
+    def method_that_invokes_debug_log
+      invoke_binding_log
+    end
+
+    def invoke_binding_log
+      invoke_debug_log
+    end
+
+    def invoke_debug_log
+      DebugLog.calling_method
+    end
+  end
+
+  context "format_value" do
+    it "invokes inspect by default" do
+      the_value = [:foo, :bar]
+      assert_equal the_value.inspect, DebugLog.format_value(the_value)
+    end
+  end
+
+  context "format_expression" do
+    it "evaluates an expression and also prints the class" do
+      the_value = [:foo, :bar]
+      formated_value = "formated value"
+      DebugLog.expects(:format_value).with(the_value).returns(formated_value)
+      expected_format = %Q{the_value="#{formated_value}" (#{the_value.class.name})}
+      assert_equal expected_format, DebugLog.format_expression(binding, 'the_value')
+    end
+  end
+
+  context "separator" do
+    it "returns pipe by default" do
+      assert_equal " | ", DebugLog.separator
+    end
+  end
+
+  context "expression_string" do
+    it "creates a comma separated key-value string from a number of expressions and a binding object" do
+      my_var = "Peter"
+      the_binding = binding
+      expressions = ['my_var', 'my_var[0,1]']
+      formats = ['my_var formated', 'myvar[0,1] formated']
+      DebugLog.expects(:format_expression).with(the_binding, 'my_var').returns(formats[0])
+      DebugLog.expects(:format_expression).with(the_binding, 'my_var[0,1]').returns(formats[1])
+      expected_string = formats.join(", ")      
+      assert_equal expected_string, DebugLog.expression_string(the_binding, 'my_var', 'my_var[0,1]')
+    end
+  end
+
+  context "prefix" do
+    it "returns class name by default" do
+      assert_equal "DebugLog", DebugLog.prefix
+    end
+  end
+end

data/test/manual.rb

@@ -0,0 +1,10 @@
+# Manual sanity check test
+
+require 'rubygems'
+require File.join(File.dirname(__FILE__), "..", "lib", "debug_log")
+
+def hello
+  foo = "fOOOOOOO"
+  debug.log("pm debug hello there", 'foo')
+end
+hello

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+gem 'jeremymcanally-context', '0.5.5'
+gem 'mocha', '0.9.8'
+require 'context'
+require 'mocha'
+require File.dirname(__FILE__) + '/../lib/debug_log'

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: debug_log
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Peter Marklund
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-17 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 3
+        - 8
+        version: 2.3.8
+  type: :runtime
+  version_requirements: *id001
+description: "    Allows you to easily and readably printout variable values (or any other Ruby expressions) to stdout\n    and/or a log file of your choice for debugging purposes. The approach to accessing\n    the binding object was inspired by the dp gem by Niclas Nilsson.\n"
+email: peter@marklunds.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- Rakefile
+- lib/debug_log.rb
+- test/core_extensions_test.rb
+- test/debug_log_test.rb
+- test/manual.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://marklunds.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A more powerful way to do debug printouts than puts
+test_files: 
+- test/core_extensions_test.rb
+- test/debug_log_test.rb
+- test/manual.rb
+- test/test_helper.rb