test_rig 0.0.3

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jacob Rothstein
+
+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.textile

@@ -0,0 +1,140 @@
+h1. Test Rig
+
+Test Rig provides two separate modules that work together.
+*Dynamic assertions* are flexible xUnit style matchers called dynamically.
+*Smarter message* supplements test failure messages with a several-line context
+of the test failure.
+This library works well with something like "Context":http://github.com/jeremymcanally/context or Shoulda.
+
+h2. Installation
+
+If necessary, install "Gemcutter":http://gemcutter.org.
+<pre><code>sudo gem install gemcutter && sudo gem tumble</code></pre>
+
+Install test-rig
+<pre><code>sudo gem install test-rig</code></pre>
+
+Add @require 'test_rig'@ to test_helper.rb, and @include TestRig@ into @Test::Unit:TestCase@.
+If you only want dynamic assertions or smarter messages, @include TestRig::DynamicAssertions@
+or @include TestRig::SmarterMessage@ instead of @TestRig@.
+
+h2. Dynamic assertions
+
+h3. Background & Philosophy
+
+Rspec has never sat well for me.  Object.method.should be_true style testing reads neat and is
+really nicely like english.  Here's the problem: What we are strictly saying in rspec is that
+testing is the object's responsibility.  It's like "hey, you! test yourself."
+
+Testing is definitionally an external act.  It is manipulating a system by its control points
+(public api) and confirming that the behavior is as expected.  Passing a "modal verb":http://en.wikipedia.org/wiki/Modal_verb
+like "should" to the object in question does not describe this behavior.
+
+From a more practical perspective, defining rspec behaviors is way too much of
+a pain when we already have an easy way to define methods in ruby.
+
+@Test::Unit@, particularly when combined with Context or Shoulda, is good
+enough for most things.  The only real issue is that you find yourself defining
+a whole lot of helper methods, like @assert_new_record@, @assert_valid@, @assert_red@
+*Dynamic assertions* fixes this.  With the fantastic power of method missing,
+assertions are generated on the fly.
+
+One of the really nice things about Rspec is that every matcher automatically
+gets an inverse (logical not) matcher. *Dynamic assertions* provides this as well.
+
+h3. Example
+
+Let's say we have class named @Entry@ that has a boolean @published?@ and a
+boolean @saved?@ and a record @@foo@ that should be saved but not published.
+Oh, and it should have a user, which we'll represent as the string @"joe"@
+
+h4. Positive assertions
+
+In Rspec: @@foo.should be_saved@
+
+In Test::Unit: @assert @foo.saved?@
+
+With Dynamic assertions: @assert_saved @foo@
+
+h4. Negative assertions
+
+In Rspec: @@foo.should_not be_published@
+
+In Test::Unit: <code>assert !@foo.published?</code> or, if you've defined @assert_false@, <code>assert_false @foo.published</code>
+
+With Dynamic assertions: <code>assert_not_published @foo</code>
+
+h4. Nil assertions
+
+In Rspec: @@foo.something.should be_nil@
+
+In Test::Unit: @assert_nil @foo.something@
+
+With Dynamic assertions: @assert_no_something @foo@
+
+h4. Positive equality assertions
+
+In Rspec: <code>@foo.user.should == "joe"</code>
+
+In Test::Unit: <code>assert_equal "joe", @foo.user</code>
+
+With Dynamic assertions: <code>assert_user "joe", @foo</code>
+
+h4. Negative equality assertions
+
+In Rspec: <code>@foo.user.should == "joe"</code>
+
+In Test::Unit: <code>assert_not_equal "joe", @foo.user</code>
+
+With Dynamic assertions: <code>assert_not_user "joe", @foo</code>
+
+h4. Everything else
+
+<code>assert @foo.user.include?('j')</code>
+<code>assert_not @foo.user.include?('z')</code>
+
+h2. Smarter Message
+
+My bane: "false did not equal true" -- What you really want to know is what
+the variable names were or the method calls.
+
+If we have the stack trace, we should be able to show you the exact test that
+failed immediately.  Smarter Message does exactly that.
+
+h3. Example
+
+<pre><code>
+#demo_test.rb
+require File.join(File.dirname(__FILE__), "test_helper")
+require 'smarter_message'
+
+class DemoTest < Test::Unit::TestCase
+  include TestRig::SmarterMessage
+  test "demonstration" do
+    a = 'foo'
+    b = 'bar'
+    assert_equal a, b
+  end
+end
+</code></pre>
+
+<pre><code>
+1) Failure:
+test demonstration(DemoTest) [./test/demo_test.rb:11]:
+<"foo"> expected but was
+<"bar">.
+./test/smarter_message_test.rb:11:in `test demonstration'
+     9:    a = 'foo'
+    10:    b = 'bar'
+--> 11:    assert_equal a, b
+    12:  end
+    13:end
+</code></pre>
+
+h3. Settings
+
+@TestRig::SmarterMessage.context_lines = 2 #the default@
+
+This defaults to two (yielding five lines; two context on each side + the actual line).
+Set this in your test_helper.
+If context_lines is zero, it will just print your failure line.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "test_rig"
+    gem.summary = %Q{TestRig makes Test::Unit fun again}
+    gem.description = %Q{TestRig supplies dynamic assertions and contextual failure messages}
+    gem.email = "github@jacobrothstein.com"
+    gem.homepage = "http://github.com/jbr/test-rig"
+    gem.authors = ["Jacob Rothstein"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "test-rig #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.3

data/lib/test_rig/dynamic_assertions.rb

@@ -0,0 +1,38 @@
+require 'active_support'
+
+module TestRig
+  module DynamicAssertions
+    def self.included(klass)
+      klass.class_eval do
+        alias_method_chain :method_missing, :dynamic_assertions
+      end
+    end
+    
+    def assert_not(*args)
+      assert !args.shift, *args
+    end
+    
+    def method_missing_with_dynamic_assertions(method, *args)
+      case method.to_s
+      when /^assert_no_([a-z_]+)$/
+        method_name = $1.to_sym
+        if args.first.respond_to? method_name
+          assert_nil args.first.send(method_name)
+          return
+        end
+      when /^assert_(not_)?([a-z_]+)$/
+        method_name = $2.to_sym
+        if args.length == 1 && args.first.respond_to?(:"#{method_name}?")
+          actual = args.first.send :"#{method_name}?"
+          assert $1 ? !actual : actual
+          return
+        elsif args.length == 2 && args.last.respond_to?(method_name)
+          send :"assert_#{$1}equal", args.first, args.last.send(method_name)
+          return
+        end
+      end
+
+      method_missing_without_dynamic_assertions(method, *args)
+    end
+  end
+end

data/lib/test_rig/smarter_message.rb

@@ -0,0 +1,69 @@
+require 'active_support'
+
+module TestRig
+  module SmarterMessage
+    mattr_writer :backtrace_regex
+    mattr_accessor :context_lines
+    @@context_lines = 2
+    
+    def self.backtrace_regex
+      @@backtrace_regex ||= /_test\.rb/
+    end
+    
+    def self.included(klass)
+      klass.class_eval do
+        alias_method_chain :assert_block, :smarter_message
+      end
+    end
+    
+    def assert_block_with_smarter_message(*args, &blk)
+      assert_block_without_smarter_message(*args, &blk)
+    rescue Test::Unit::AssertionFailedError => e
+      backtrace = e.backtrace
+      relevant_traces = relevant_traces(backtrace)
+      raise if relevant_traces.blank?
+      new_error = Test::Unit::AssertionFailedError.new e.message + "\n" + message_for_backtrace(backtrace)
+      new_error.set_backtrace(relevant_traces)
+      raise new_error
+    end
+
+    private
+
+    def message_for_backtrace(backtrace)
+      trace = first_relevant_trace(backtrace)
+      line = line_at_backtrace(trace, SmarterMessage.context_lines)
+      "#{trace}\n#{line}"
+    end
+
+    def relevant_traces(backtrace)
+      backtrace.select do |trace|
+        trace =~ TestRig::SmarterMessage.backtrace_regex &&
+          trace !~ /#{File.basename(__FILE__)}/
+      end
+    end
+
+    def first_relevant_trace(backtrace)
+      backtrace.detect { |trace| trace =~ /_test\.rb/}
+    end
+    
+    def pad(number, width)
+      "#{" " * (width - number.to_s.size)}#{number}"
+    end
+
+    def line_at_backtrace(trace, context = 0)
+      file, line = trace.split(":")
+      line = line.to_i - 1
+      start, finish = line - context, line + context
+      width = [start, finish].map{|n| (n + 1).to_s.size }.max
+      
+      lines = File.open(file).readlines
+      (start..finish).map do |line_number|
+        if lines[line_number]
+          "#{line_number == line.to_i ? "--> " : "    "}"\
+          "#{pad line_number + 1, width}:" +
+          lines[line_number].rstrip
+        end
+      end.compact.join("\n")
+    end
+  end
+end

data/lib/test_rig.rb

@@ -0,0 +1,11 @@
+require 'test_rig/dynamic_assertions'
+require 'test_rig/smarter_message'
+
+module TestRig
+  def self.included(klass)
+    klass.class_eval do
+      include TestRig::DynamicAssertions
+      include TestRig::SmarterMessage
+    end
+  end
+end

data/test/dynamic_assertions_test.rb

@@ -0,0 +1,65 @@
+require File.join(File.dirname(__FILE__), "test_helper")
+
+class Entry
+  def published?() false end
+  def saved?() true end
+  def user() "joe" end
+  def something_nil() nil end
+  def something_not_nil() "not nil" end
+end
+
+class DynamicAssertionsTest < Test::Unit::TestCase
+  include TestRig::DynamicAssertions
+
+  def setup
+    @entry = Entry.new
+  end
+  
+  test 'assert not' do
+    assert_not @entry.published?
+  end
+  
+  test 'assert not failure' do
+    assert_test_failure { assert_not @entry.saved? }
+  end
+  
+  test "positive assertion" do
+    assert_saved @entry
+  end
+  
+  test "positive assertion failure" do
+    assert_test_failure { assert_not_saved @entry }
+  end
+  
+  test "negative assertion" do
+    assert_not_published @entry
+  end
+  
+  test "negative assertion failure" do
+    assert_test_failure { assert_published @entry }
+  end
+  
+  test "positive equality assertion" do
+    assert_user "joe", @entry
+  end
+  
+  test 'positive equality assertion failure' do
+    assert_test_failure { assert_user 'sue', @entry }
+  end
+  
+  test "negative equality assertion" do
+    assert_not_user "sally", @entry
+  end
+  
+  test 'negative equality assertion failure' do
+    assert_test_failure { assert_not_user 'joe', @entry }
+  end
+  
+  test "assert no" do
+    assert_no_something_nil @entry
+  end
+  
+  test "assert no failure" do
+    assert_test_failure { assert_no_something_not_nil @entry }
+  end
+end

data/test/smarter_message_test.rb

@@ -0,0 +1,51 @@
+require File.join(File.dirname(__FILE__), "test_helper")
+
+class SmarterMessageTest < Test::Unit::TestCase
+  include TestRig::SmarterMessage
+  
+  test "smarter message includes the relevent snippet" do
+    a, b = 'foo', 'bar'
+    e = assert_test_failure { assert_equal a, b }
+    [
+      "<\"foo\"> expected but was\n<\"bar\">.",
+      "a, b = 'foo', 'bar'",
+      "-->  8",
+      "assert_equal a, b"
+    ].each {|snippet| assert_match snippet, e.message}
+  end
+
+  test "backtrace includes only relevant lines" do
+    e = assert_test_failure { assert false }
+    [
+      "backtrace includes only relevant lines",
+      "#{__FILE__}:18"
+    ].each {|snippet| assert_match snippet, e.backtrace.first}
+  end
+  
+  test 'with four context lines' do
+    TestRig::SmarterMessage.context_lines = context = 4
+    e = assert_test_failure { assert false }
+    context_output = e.message.split("\n").select{|line| line =~ /^(-->)?\s+[0-9]+:/}
+    
+    assert_equal context * 2 + 1, context_output.size
+    assert_match "test 'with four context lines", context_output[2]
+    assert_match /-->.+assert false/, context_output[context]
+    TestRig::SmarterMessage.context_lines = 2
+  end
+  
+  test 'backtrace scrubbing' do
+    TestRig::SmarterMessage.backtrace_regex = /test_helper/
+    e = assert_test_failure { assert false }
+    assert_equal 1, e.backtrace.size
+
+    TestRig::SmarterMessage.backtrace_regex = /assert_test_failure/
+    e = assert_test_failure { assert false }
+    assert_equal 1, e.backtrace.size
+
+    TestRig::SmarterMessage.backtrace_regex = nil
+    assert_equal /_test\.rb/, TestRig::SmarterMessage.backtrace_regex
+  end
+end
+
+
+

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+$:.unshift File.instance_eval { expand_path join(dirname(__FILE__), "..", "lib") }
+
+require 'active_support'
+require 'test/unit'
+require 'test_rig'
+
+class Test::Unit::TestCase
+  def self.test(name, &blk) define_method(:"test #{name}", &blk) end
+  def assert_test_failure(&blk)
+    assert_raise Test::Unit::AssertionFailedError, &blk
+  end
+end

data/test-rig.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{test-rig}
+  s.version = "0.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jacob Rothstein"]
+  s.date = %q{2010-01-14}
+  s.description = %q{TestRig supplies dynamic assertions and contextual failure messages}
+  s.email = %q{github@jacobrothstein.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "lib/test_rig.rb",
+     "lib/test_rig/dynamic_assertions.rb",
+     "lib/test_rig/smarter_message.rb",
+     "test-rig.gemspec",
+     "test/dynamic_assertions_test.rb",
+     "test/smarter_message_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/jbr/test-rig}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{TestRig makes Test::Unit fun again}
+  s.test_files = [
+    "test/dynamic_assertions_test.rb",
+     "test/smarter_message_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: test_rig
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- Jacob Rothstein
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-23 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: TestRig supplies dynamic assertions and contextual failure messages
+email: github@jacobrothstein.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- lib/test_rig.rb
+- lib/test_rig/dynamic_assertions.rb
+- lib/test_rig/smarter_message.rb
+- test-rig.gemspec
+- test/dynamic_assertions_test.rb
+- test/smarter_message_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/jbr/test-rig
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: TestRig makes Test::Unit fun again
+test_files: 
+- test/dynamic_assertions_test.rb
+- test/smarter_message_test.rb
+- test/test_helper.rb