mcmire-matchy 0.4.2 → 0.5.0

data/Rakefile

@@ -6,16 +6,19 @@ require File.dirname(__FILE__) + '/lib/matchy/version'
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
-    gem.version = Matchy::VERSION
+    gem.version = Matchy::VERSION::STRING
     gem.name = "mcmire-matchy"
     gem.summary = %Q{RSpec-esque matchers for use in Test::Unit}
     gem.description = %Q{RSpec-esque matchers for use in Test::Unit}
     gem.email = ["jeremy@entp.com"]
-    gem.homepage = %q{http://github.com/mcmire/matchy}
+    gem.homepage = %q{http://matchy.rubyforge.org}
     gem.authors = ["Jeremy McAnally"]
+    gem.files.exclude ".gitignore", "test/*", "*.gemspec"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
+  
+  task :test => :check_dependencies
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
@@ -40,16 +43,12 @@ rescue LoadError
   end
 end
 
-task :test => :check_dependencies
-
 task :default => :test
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "mcmire-matchy #{version}"
+  rdoc.title = "matchy #{Matchy::VERSION::STRING}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/lib/matchy.rb

@@ -1,25 +1,111 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+unless defined?(Test::Unit) || defined?(MiniTest)
+  raise LoadError, "Matchy couldn't find a testing library! You must require Test::Unit or MiniTest before requiring matchy." 
+end
 
-require 'test/unit/assertions'
+# Matchy works with either Test::Unit or MiniTest, on both Ruby 1.8 and >= 1.9.1.
+# Note that Ruby 1.9.0 is NOT supported... but you should really be using 1.9.1 ;)
+module Matchy
+  class Adapter < Struct.new(:name, :full_name)
+    def on_use; end
+  end
+  
+  @@adapters = {}
+  @@current_adapter = nil
+  
+  class << self
+    def adapter(adapter_name, full_name, &block)
+      @@adapters[adapter_name.to_s] = Adapter.new(adapter_name, full_name).extend(Module.new(&block))
+    end
+    def use(adapter_name)
+      adapter_name = adapter_name.to_s
+      @@current_adapter = @@adapters[adapter_name] or raise "Couldn't find adapter by name '#{adapter_name}'"
+      if ENV["MATCHY_DEBUG"] || $MATCHY_DEBUG
+        msg = "\n"
+        msg << " -- This is Ruby version #{RUBY_VERSION}, using #{@@current_adapter.full_name}"
+        msg << " (MiniTest-Test::Unit shim)" if @@current_adapter.name == :minitest && Matchy.minitest_tu_shim?
+        msg << "\n\n"
+        print msg
+      end
+      @@current_adapter.on_use
+      Matchy.init
+    end
+    def adapter_not_found_msg
+      "Matchy detected you have a testing library loaded, but it doesn't have an adapter for it. Try these adapters: #{@@adapters.keys.sort.join(", ")}"
+    end
+  end
+  
+  adapter :minitest, "MiniTest" do
+    def assertions_module; MiniTest::Assertions; end
+    def test_case_class; MiniTest::Unit::TestCase; end
+    def assertion_failed_error; MiniTest::Assertion; end
+    def on_use; MiniTest::Unit.autorun; end
+  end
+  adapter :testunit, "Test::Unit" do
+    def assertions_module; Test::Unit::Assertions; end
+    def test_case_class; Test::Unit::TestCase; end
+    def assertion_failed_error; Test::Unit::AssertionFailedError; end
+  end
+  
+  #---
+  
+  class << self
+    def minitest_tu_shim?
+      defined?(MiniTest) && defined?(MiniTest::Assertions) &&
+      defined?(Test::Unit::TestCase) && Test::Unit::TestCase < MiniTest::Assertions
+    end
+  
+    def classic?
+      defined?(Test::Unit) && defined?(Test::Unit::TestCase) && !minitest_tu_shim?
+    end
+  
+    def minitest?
+      # We have to decide if we really have a suite of MiniTest tests.
+      # Rails for example defines MiniTest, so to only check for
+      # defined?(MiniTest) would be malicious
+      defined?(MiniTest) && !classic?
+    end
+    
+    %w(assertions_module test_case_class assertion_failed_error).each do |method|
+      class_eval <<-EOT, __FILE__, __LINE__
+        def #{method}
+          @@current_adapter ? @@current_adapter.#{method} : raise(LoadError, Matchy.adapter_not_found_msg)
+        end
+      EOT
+    end
+  
+    def init
+      require 'matchy/expectation_builder'
+      require 'matchy/modals'
+      require 'matchy/matcher_builder'
+      require 'matchy/custom_matcher'
+      require 'matchy/version'
 
-require 'matchy/expectation_builder'
-require 'matchy/modals'
-require 'matchy/matcher_builder'
-require 'matchy/custom_matcher'
-require 'matchy/version'
+      require 'matchy/built_in/enumerable_expectations'
+      require 'matchy/built_in/error_expectations'
+      require 'matchy/built_in/truth_expectations'
+      require 'matchy/built_in/operator_expectations'
+      require 'matchy/built_in/change_expectations'
 
-require 'matchy/built_in/enumerable_expectations'
-require 'matchy/built_in/error_expectations'
-require 'matchy/built_in/truth_expectations'
-require 'matchy/built_in/operator_expectations'
-require 'matchy/built_in/change_expectations'
+      # Track the current testcase and 
+      # provide it to the operator matchers.
+      Matchy.test_case_class.class_eval do
+        alias_method :old_run_method_aliased_by_matchy, :run
+        def run(whatever, *args, &block)
+          $current_test_case = self
+          old_run_method_aliased_by_matchy(whatever, *args, &block)
+        end
+      end
 
-if Object.const_defined?(:Protest)
-  Protest::TestCase.send(:include, Matchy::Expectations::TestCaseExtensions)
-else
-  require 'test/unit'
-  Test::Unit::TestCase.send(:include, Matchy::Expectations::TestCaseExtensions)
+      Matchy.test_case_class.send(:include, Matchy::Expectations::TestCaseExtensions)
+      Object.send(:include, Matchy::CustomMatcher)
+    end
+  end
 end
 
-include Matchy::CustomMatcher
+autodetected_adapter = case
+  when Matchy.minitest? then :minitest
+  when Matchy.classic?  then :testunit
+end
+if autodetected_adapter
+  Matchy.use(autodetected_adapter)
+end

data/lib/matchy/built_in/change_expectations.rb

@@ -11,21 +11,26 @@ module Matchy
       def change(&block)
         build_matcher(:change) do |receiver, matcher, args|
           before, done, after = block.call, receiver.call, block.call
-          comparison = after != before
-          if list = matcher.chained_messages
-            comparison = case list[0].name
-              # todo: provide meaningful messages
-            when :by          then (after == before + list[0].args[0] || after == before - list[0].args[0])
-            when :by_at_least then (after >= before + list[0].args[0] || after <= before - list[0].args[0])
-            when :by_at_most  then (after <= before + list[0].args[0] && after >= before - list[0].args[0])
-            when :from        then (before == list[0].args[0]) && (after == list[1].args[0])
+	  change_description = ''
+          comparison = if list = matcher.chained_messages
+	    message = list.first
+	    arg = message.args.first
+	    name = message.name
+	    change_description = " #{name.to_s.gsub('_', ' ')} #{arg.inspect}"
+            case name
+            when :by          then (after == before + arg || after == before - arg)
+            when :by_at_least then (after >= before + arg || after <= before - arg)
+            when :by_at_most  then (after <= before + arg && after >= before - arg)
+            when :from        then (before == arg) && (after == list[1].args[0])
             end
+	  else
+	    after != before
           end
-          matcher.positive_failure_message = "given block shouldn't alter the block attached to change"
-          matcher.negative_failure_message = "given block should alter the block attached to change"
+          matcher.positive_failure_message = "given block should alter the given value#{change_description};\n  was #{before.inspect},\n  now #{after.inspect}"
+	  matcher.negative_failure_message = "given block should not alter the given value#{change_description};\n  was: #{before.inspect},\n  now: #{after.inspect}"
           comparison
         end
       end
     end
   end
-end
+end

data/lib/matchy/built_in/operator_expectations.rb

@@ -8,7 +8,7 @@ module Matchy
     #   "hello".length.should_not == 2
     #
     class OperatorExpectation #< Base
-      include Test::Unit::Assertions
+      include Matchy.assertions_module
            
       def initialize(receiver, match)
         @receiver, @match = receiver, match

data/lib/matchy/matcher_builder.rb

@@ -8,7 +8,7 @@ module Matchy
       end
       
       body = lambda do |klass|
-        include Test::Unit::Assertions
+        include Matchy.assertions_module
         @matcher_name = matcher_name.to_s
         
         def self.matcher_name

data/lib/matchy/version.rb

@@ -1,3 +1,9 @@
 module Matchy
-  VERSION = "0.4.2"
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 5
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
 end

data/test/test_change_expectation.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 
-class TestChangeExpectations < Test::Unit::TestCase
+class TestChangeExpectations < Matchy.test_case_class
   def test_change
     var = 1
     lambda {var += 1}.should change {var}

data/test/test_custom_matcher.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 
-class TestCustomMatcher < Test::Unit::TestCase
+class TestCustomMatcher < Matchy.test_case_class
   class Foo < Struct.new(:valid)
     def valid?
       valid == true
@@ -110,12 +110,12 @@ class TestCustomMatcher < Test::Unit::TestCase
     foo.valid = false
     lambda {
       foo.should be_valid
-    }.should raise_error("Expected to be valid but wasn't.")
+    }.should raise_error(/^Expected to be valid but wasn't/)
     
     foo.valid = true
     lambda {
       foo.should_not be_valid
-    }.should raise_error("Expected to not be valid but was.")
+    }.should raise_error(/^Expected to not be valid but was/)
   end
   
   def test_matcher_with_chained_messages

data/test/test_enumerable_expectations.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 
-class TestEnumerableExpectations < Test::Unit::TestCase
+class TestEnumerableExpectations < Matchy.test_case_class
   def test_include
     [1,2,3,4].should include(4)
   end
@@ -8,7 +8,7 @@ class TestEnumerableExpectations < Test::Unit::TestCase
   def test_include_fail
     lambda {
       [1,2,3,4].should include(6)
-    }.should raise_error(Test::Unit::AssertionFailedError)
+    }.should raise_error(Matchy.assertion_failed_error)
   end
   
   def test_exclude
@@ -18,7 +18,7 @@ class TestEnumerableExpectations < Test::Unit::TestCase
   def test_exclude_fail
     lambda {
       [1,2,3,4].should exclude(4)
-    }.should raise_error(Test::Unit::AssertionFailedError)
+    }.should raise_error(Matchy.assertion_failed_error)
   end
   
   def test_multi_include
@@ -28,7 +28,7 @@ class TestEnumerableExpectations < Test::Unit::TestCase
   def test_multi_include_fail
     lambda {
       [1,2,3,4].should include(6,7,8)
-    }.should raise_error(Test::Unit::AssertionFailedError)
+    }.should raise_error(Matchy.assertion_failed_error)
   end
   
   def test_multi_exclude
@@ -38,7 +38,7 @@ class TestEnumerableExpectations < Test::Unit::TestCase
   def test_multi_exclude_fail
     lambda {
       [1,2,3,4].should exclude(2,3,4)
-    }.should raise_error(Test::Unit::AssertionFailedError)
+    }.should raise_error(Matchy.assertion_failed_error)
   end
   
   def test_negative_include
@@ -48,7 +48,7 @@ class TestEnumerableExpectations < Test::Unit::TestCase
   def test_negative_include_fail
     lambda {
       [1,2,3,4].should_not include(4)
-    }.should raise_error(Test::Unit::AssertionFailedError)
+    }.should raise_error(Matchy.assertion_failed_error)
   end
   
   def test_negative_exclude
@@ -58,7 +58,7 @@ class TestEnumerableExpectations < Test::Unit::TestCase
   def test_negative_exclude_fail
     lambda {
       [1,2,3,4].should_not exclude(6,7)
-    }.should raise_error(Test::Unit::AssertionFailedError)
+    }.should raise_error(Matchy.assertion_failed_error)
   end
   
   def test_include_fail_message

data/test/test_error_expectations.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 
-class TestErrorExpectations < Test::Unit::TestCase
+class TestErrorExpectations < Matchy.test_case_class
   def test_raises_error
     lambda { raise "FAIL" }.should raise_error
   end
@@ -8,7 +8,7 @@ class TestErrorExpectations < Test::Unit::TestCase
   def test_raises_error_fail
     lambda {
       lambda { "WIN" }.should raise_error
-    }.should raise_error(Test::Unit::AssertionFailedError)
+    }.should raise_error(Matchy.assertion_failed_error)
   end
   
   def test_negative_raises_error
@@ -18,7 +18,7 @@ class TestErrorExpectations < Test::Unit::TestCase
   def test_negative_raises_error_fail
     lambda {
       lambda { raise "FAIL" }.should_not raise_error
-    }.should raise_error(Test::Unit::AssertionFailedError)
+    }.should raise_error(Matchy.assertion_failed_error)
   end
   
   def test_raises_specific_error
@@ -28,13 +28,13 @@ class TestErrorExpectations < Test::Unit::TestCase
   def test_raises_specific_error_fail_with_no_error
     lambda {
       lambda { "WIN" }.should raise_error(TypeError)
-    }.should raise_error(Test::Unit::AssertionFailedError)
+    }.should raise_error(Matchy.assertion_failed_error)
   end
   
   def test_raises_specific_error_fail_with_different_error
     lambda {
       lambda { raise StandardError }.should raise_error(TypeError)
-    }.should raise_error(Test::Unit::AssertionFailedError)
+    }.should raise_error(Matchy.assertion_failed_error)
   end
   
   def test_throws_symbol
@@ -48,7 +48,7 @@ class TestErrorExpectations < Test::Unit::TestCase
       lambda {
         throw :fail
       }.should throw_symbol(:win)
-    }.should raise_error(Test::Unit::AssertionFailedError)
+    }.should raise_error(Matchy.assertion_failed_error)
   end
   
   def test_negative_throws_symbol
@@ -63,7 +63,7 @@ class TestErrorExpectations < Test::Unit::TestCase
       lambda {
         throw :fail
       }.should_not throw_symbol(:fail)
-    }.should raise_error(Test::Unit::AssertionFailedError)
+    }.should raise_error(Matchy.assertion_failed_error)
   
   end
   

data/test/test_expectation_builder.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 
-class TestExpectationBuilder < Test::Unit::TestCase
+class TestExpectationBuilder < Matchy.test_case_class
   
   def setup
     @obj = Object.new

data/test/test_helper.rb

@@ -1 +1,87 @@
-require File.dirname(__FILE__) + '/../lib/matchy.rb'
+# Here we are ensuring the following cases are easily testable:
+#
+# * Ruby 1.8 with Test::Unit (in standard library)
+# * Ruby 1.8 with MiniTest (gem)
+# * Ruby 1.8 with MiniTest-Test::Unit shim (minitest_tu_shim gem)
+# * Ruby 1.8 with a different test library that uses parts from
+#   Test::Unit (e.g. Protest)
+# * Ruby 1.9.1 with MiniTest (in standard library)
+# * Ruby 1.9.1 with Test::Unit (in standard library; acts like a
+#   MiniTest-Test::Unit shim)
+# * Ruby 1.9.1 with Test::Unit 1.2.3 (gem)
+# * Ruby 1.9.1 with a different test library that uses parts from
+#   Test::Unit (e.g. Protest)
+#
+# Note that Ruby 1.9.0 is NOT supported... but really, who's using
+# that still :)
+#
+# To run through the tests, first go get RVM and install 1.9.1 using
+# that. Then you can just say:
+#
+#   rvm use system
+#   rake test USING=minitest_tu_shim
+#   rake test USING=minitest
+#   rake test USING=incompatible
+#   rake test (uses test/unit by default)
+#
+# and then:
+#
+#   rvm use 1.9.1
+#   rake test USING=minitest_tu_shim
+#   rake test USING=testunit
+#   rake test USING=incompatible
+#   rake test (uses minitest/unit by default)
+#
+# References:
+#
+#   * http://blog.floehopper.org/articles/2009/02/02/test-unit-and-minitest-with-different-ruby-versions
+#
+
+if RUBY_VERSION.to_f < 1.9
+  # Ruby 1.8.x
+  case ENV["USING"]
+    when "minitest_tu_shim"
+      require 'rubygems'
+      gem 'minitest'
+      dir = Config::CONFIG["sitelibdir"]
+      unless File.symlink?("#{dir}/minitest") && File.symlink?("#{dir}/test")
+        #puts
+        #puts "   ** To get a true test, you need to run `sudo use_minitest yes` to flip on minitest_tu_shim mode."
+        #puts
+        #exit 1
+        puts "Enabling the shim..."; `sudo use_minitest yes`
+        at_exit { puts "Disabling the shim..."; `sudo use_minitest no` }
+      end
+      require 'test/unit'
+    when "minitest"
+      require 'rubygems'
+      gem 'minitest'
+      require 'minitest/unit'
+    when "incompatible"
+      require 'rubygems'
+      gem 'protest'
+      require 'protest'
+    else
+      require 'test/unit'
+  end
+else
+  # Ruby 1.9.1 and above
+  case ENV["USING"]
+    when "minitest_tu_shim"
+      require 'rbconfig'
+      $:.unshift RbConfig::CONFIG['rubylibdir'] # in case you also have test-unit 1.2.3 installed
+      require 'test/unit'
+    when "testunit"
+      gem 'test-unit', "= 1.2.3"
+      require 'test/unit'
+    when "incompatible"
+      gem 'protest'
+      require 'protest'
+    else
+      require 'minitest/unit'
+  end
+end
+
+$MATCHY_DEBUG = true
+
+require 'matchy'