mcmire-matchy 0.4.1

data/lib/matchy.rb

@@ -0,0 +1,19 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'test/unit'
+
+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'
+
+Test::Unit::TestCase.send(:include, Matchy::Expectations::TestCaseExtensions)
+include Matchy::CustomMatcher

data/lib/matchy/built_in/change_expectations.rb

@@ -0,0 +1,31 @@
+module Matchy
+  module Expectations
+    module TestCaseExtensions
+      # Checks if the given block alters the value of the block attached to change
+      #
+      # ==== Examples
+      #   lambda {var += 1}.should change {var}.by(1)
+      #   lambda {var += 2}.should change {var}.by_at_least(1)
+      #   lambda {var += 1}.should change {var}.by_at_most(1)
+      #   lambda {var += 2}.should change {var}.from(1).to(3) if var = 1
+      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])
+            end
+          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"
+          comparison
+        end
+      end
+    end
+  end
+end

data/lib/matchy/built_in/enumerable_expectations.rb

@@ -0,0 +1,41 @@
+module Matchy
+  module Expectations 
+    module TestCaseExtensions
+      
+      # Calls +include?+ on the receiver for any object.  You can also provide
+      # multiple arguments to see if all of them are included.
+      #
+      # ==== Examples
+      #   
+      #   [1,2,3].should include(1)
+      #   [7,8,8].should_not include(3)
+      #   ['a', 'b', 'c'].should include('a', 'c')
+      #
+      def include(*obj)
+        _clude(:include, obj)
+      end
+      
+      # Expects the receiver to exclude the given object(s). You can provide
+      # multiple arguments to see if all of them are included.
+      #
+      # ==== Examples
+      #   
+      #   [1,2,3].should exclude(16)
+      #   [7,8,8].should_not exclude(7)
+      #   ['a', 'b', 'c'].should exclude('e', 'f', 'g')
+      #
+      def exclude(*obj)
+        _clude(:exclude, obj)
+      end
+      
+      private
+      def _clude(sym, obj)
+        build_matcher(sym, obj) do |given, matcher, args|
+          matcher.positive_failure_message = "Expected #{given.inspect} to #{sym} #{args.inspect}."
+          matcher.negative_failure_message = "Expected #{given.inspect} to not #{sym} #{args.inspect}."
+          args.inject(true) {|m,o| m && (given.include?(o) == (sym == :include)) }
+        end
+      end
+    end
+  end
+end

data/lib/matchy/built_in/error_expectations.rb

@@ -0,0 +1,74 @@
+module Matchy
+  module Expectations
+    module TestCaseExtensions
+      # Expects a lambda to raise an error.  You can specify the error or leave it blank to encompass
+      # any error.
+      #
+      # ==== Examples
+      #
+      #   lambda { raise "FAILURE." }.should raise_error
+      #   lambda { puts i_dont_exist }.should raise_error(NameError)
+      #
+      def raise_error(*obj)
+        build_matcher(:raise_error, obj) do |receiver, matcher, args|
+          expected = args[0] || Exception
+          if args.size > 1
+            expected_message = args[1]
+          end
+          
+          raised = false
+          error = nil
+          begin
+            receiver.call
+          rescue Exception => e
+            raised = true
+            error = e
+          end
+          if expected.respond_to?(:ancestors) && expected.ancestors.include?(Exception)
+            matcher.positive_failure_message = "Expected #{receiver.inspect} to raise #{expected.name}, " + 
+              (error ? "but #{error.class.name} was raised instead." : "but none was raised.")
+            matcher.negative_failure_message = "Expected #{receiver.inspect} to not raise #{expected.name}."
+            comparison = (raised && error.class.ancestors.include?(expected))
+          else
+            expected_message = expected
+          end
+          
+          if expected_message
+            message = error ? error.message : "none"
+            matcher.positive_failure_message = "Expected #{receiver.inspect} to raise error with message matching '#{expected_message}', but '#{message}' was raised."
+            matcher.negative_failure_message = "Expected #{receiver.inspect} to raise error with message not matching '#{expected_message}', but '#{message}' was raised."
+            comparison = (raised && (expected_message.kind_of?(Regexp) ? ((error.message =~ expected_message) ? true : false) : expected_message == error.message))
+          end
+          comparison
+        end
+      end
+      
+      # Expects a lambda to throw an error.
+      #
+      # ==== Examples
+      #
+      #   lambda { throw :thing }.should throw_symbol(:thing)
+      #   lambda { "not this time" }.should_not throw_symbol(:hello)
+      #
+      def throw_symbol(*obj)
+        build_matcher(:throw_symbol, obj) do |receiver, matcher, args|
+          raised, thrown_symbol, expected = false, nil, args[0]
+          begin
+            receiver.call
+          rescue NameError => e
+            raise e unless e.message =~ /uncaught throw/
+            raised = true
+            thrown_symbol = e.name.to_sym if e.respond_to?(:name)
+          rescue ArgumentError => e
+            raise e unless e.message =~ /uncaught throw/
+            thrown_symbol = e.message.match(/uncaught throw :(.+)/)[1].to_sym
+          end
+          matcher.positive_failure_message = "Expected #{receiver.inspect} to throw :#{expected}, but " +
+            "#{thrown_symbol ? ':' + thrown_symbol.to_s + ' was thrown instead' : 'no symbol was thrown'}."
+          matcher.negative_failure_message = "Expected #{receiver.inspect} to not throw :#{expected}."
+          expected == thrown_symbol
+        end
+      end      
+    end
+  end
+end

data/lib/matchy/built_in/operator_expectations.rb

@@ -0,0 +1,48 @@
+module Matchy
+  module Expectations
+    # Class to handle operator expectations.
+    #
+    # ==== Examples
+    #   
+    #   13.should == 13
+    #   "hello".length.should_not == 2
+    #
+    class OperatorExpectation #< Base
+      include Test::Unit::Assertions
+           
+      def initialize(receiver, match)
+        @receiver, @match = receiver, match
+      end
+      
+      ['==', '===', '=~', '>', '>=', '<', '<='].each do |op|
+        define_method(op) do |expected|
+          @expected = expected
+          (@receiver.send(op,expected) ? true : false) == @match ? pass! : fail!(op)
+        end
+      end
+      
+      protected
+      def pass!
+        defined?($current_test_case) ? $current_test_case.assert(true) : (assert true)
+      end
+      
+      def fail!(operator)
+        flunk @match ? failure_message(operator) : negative_failure_message(operator)
+      end
+      
+      def failure_message(operator)
+        out = "Expected #{@receiver.inspect} to #{operator} #{@expected.inspect}"
+        if Hash === @receiver && Hash === @expected
+          # Hash#diff, from ActiveSupport
+          diff = @receiver.dup.delete_if { |k, v| @expected[k] == v }.merge(@expected.dup.delete_if { |k, v| @receiver.has_key?(k) })
+          out += " (diff: #{diff.inspect})"
+        end
+        out += "."
+      end
+      
+      def negative_failure_message(operator)
+        "Expected #{@receiver.inspect} to not #{operator} #{@expected.inspect}."
+      end
+    end
+  end
+end

data/lib/matchy/built_in/truth_expectations.rb

@@ -0,0 +1,146 @@
+module Matchy
+  module Expectations
+    module TestCaseExtensions
+      # Simply checks if the receiver matches the expected object.
+      # TODO: Fill this out to implement much of the RSpec functionality (and then some)
+      #
+      # ==== Examples
+      #
+      #   "hello".should be("hello")
+      #   (13 < 20).should be(true)
+      #
+      def be(*obj)
+        build_matcher(:be, obj) do |receiver, matcher, args|
+          @receiver, expected = receiver, args[0]
+          matcher.positive_failure_message = "Expected #{@receiver.inspect} to be #{expected.inspect}."
+          matcher.negative_failure_message = "Expected #{@receiver.inspect} to not be #{expected.inspect}."
+          expected == @receiver
+        end
+      end
+      
+      # Checks if the given object is within a given object and delta.
+      #
+      # ==== Examples
+      #
+      #   (20.0 - 2.0).should be_close(18.0)
+      #   (13.0 - 4.0).should be_close(9.0, 0.5)
+      #
+      def be_close(obj, delta = 0.3)
+        build_matcher(:be_close, [obj, delta]) do |receiver, matcher, args|
+          @receiver, expected, delta = receiver, args[0], args[1]
+          matcher.positive_failure_message = "Expected #{@receiver.inspect} to be close to #{expected.inspect} (delta: #{delta})."
+          matcher.negative_failure_message = "Expected #{@receiver.inspect} to not be close to #{expected.inspect} (delta: #{delta})."
+          (@receiver - expected).abs < delta
+        end
+      end
+      
+      # Calls +exist?+ on the given object.
+      #
+      # ==== Examples
+      #
+      #   # found_user.exist?
+      #   found_user.should exist
+      #
+      def exist
+        ask_for(:exist, :with_arg => nil)
+      end   
+      
+      # Calls +eql?+ on the given object (i.e., are the objects the same value?)
+      #
+      # ==== Examples
+      #   
+      #    1.should_not eql(1.0)
+      #    (12 / 6).should eql(6)
+      #
+      def eql(*obj)
+        ask_for(:eql, :with_arg => obj)
+      end
+      
+      # Calls +equal?+ on the given object (i.e., do the two objects have the same +object_id+?)
+      #
+      # ==== Examples
+      # 
+      #   x = [1,2,3]
+      #   y = [1,2,3]
+      #
+      #   # Different object_id's...
+      #   x.should_not equal(y)
+      #
+      #   # The same object_id
+      #   x[0].should equal(y[0])
+      #
+      def equal(*obj)
+        ask_for(:equal, :with_arg => obj)
+      end
+      
+      # A last ditch way to implement your testing logic.  You probably shouldn't use this unless you
+      # have to.
+      #
+      # ==== Examples
+      #
+      #   (13 - 4).should satisfy(lambda {|i| i < 20})
+      #   "hello".should_not satisfy(lambda {|s| s =~ /hi/})
+      #
+      def satisfy(*obj)
+        build_matcher(:satisfy, obj) do |receiver, matcher, args|
+          @receiver, expected = receiver, args[0]
+          matcher.positive_failure_message = "Expected #{@receiver.inspect} to satisfy given block."
+          matcher.negative_failure_message = "Expected #{@receiver.inspect} to not satisfy given block."
+          expected.call(@receiver) == true
+        end
+      end
+      
+      # Checks if the given object responds to the given method
+      #
+      # ==== Examples
+      #
+      #   "foo".should respond_to(:length)
+      #   {}.should respond_to(:has_key?)
+      def respond_to(*meth)
+        ask_for(:respond_to, :with_arg => meth)
+      end
+      
+      # Asks given for success?().
+      # This is necessary because Rails Integration::Session
+      # overides method_missing without grace.
+      #
+      # ==== Examples
+      #
+      #   @response.should be_success
+      def be_success
+        ask_for(:success, :with_arg => nil)
+      end
+
+      alias_method :old_missing, :method_missing
+      # ==be_*something(*args)
+      #
+      # ===This method_missing acts as a matcher builder. 
+      # If a call to be_xyz() reaches this method_missing (say: obj.should be_xyz), 
+      # a matcher with the name xyz will be built, whose defining property
+      # is that it returns the value of obj.xyz? for matches?.
+      # ==== Examples
+      #
+      #   nil.should be_nil
+      #   17.should be_kind_of(Fixnum)
+      #   obj.something? #=> true
+      #   obj.should be_something
+      def method_missing(name, *args, &block)
+        if (name.to_s =~ /^be_(.+)/)
+          ask_for($1, :with_arg => args)
+        else
+          old_missing(name, *args, &block)
+        end
+      end
+      
+    private
+      def ask_for(sym, option={})
+        build_matcher(sym, (option[:with_arg] || [])) do |receiver, matcher, args|
+          expected, meth = args[0], (sym.to_s + "?" ).to_sym
+          matcher.positive_failure_message = "Expected #{receiver.inspect} to return true for #{sym}?, with '#{(expected && expected.inspect) || 'no args'}'."
+          matcher.negative_failure_message = "Expected #{receiver.inspect} to not return true for #{sym}?, with '#{(expected && expected.inspect) || 'no args'}'."
+          expected ? receiver.send(meth, expected) : receiver.send(meth)
+        end
+      end
+    end
+  end
+end

data/lib/matchy/custom_matcher.rb

@@ -0,0 +1,10 @@
+module Matchy
+  module CustomMatcher
+    include Matchy::MatcherBuilder
+    def custom_matcher(matcher_name, &block)
+      define_method matcher_name do |*args|
+        build_matcher(matcher_name, args, &block)
+      end
+    end
+  end
+end

data/lib/matchy/expectation_builder.rb

@@ -0,0 +1,9 @@
+module Matchy
+  module ExpectationBuilder
+    def self.build_expectation(match, exp, obj)
+      return Matchy::Expectations::OperatorExpectation.new(obj, match) unless exp
+      
+      (exp.matches?(obj) != match) ? exp.fail!(match) : exp.pass!(match)
+    end
+  end
+end

data/lib/matchy/matcher_builder.rb

@@ -0,0 +1,51 @@
+module Matchy
+  module MatcherBuilder
+    class ChainedMessage < Struct.new(:name, :args, :block); end
+    
+    def build_matcher(matcher_name=nil, args=[], &block)
+      match_block = lambda do |actual, matcher|
+        block.call(actual, matcher, args)
+      end
+      
+      body = lambda do |klass|
+        include Test::Unit::Assertions
+        @matcher_name = matcher_name.to_s
+        
+        def self.matcher_name
+          @matcher_name
+        end
+
+        attr_reader :matcher_name
+        attr_accessor :positive_failure_message, :negative_failure_message, :chained_messages
+        
+        def initialize(match_block, test_case)
+          @match_block, @test_case = match_block, test_case
+          @matcher_name = self.class.matcher_name
+        end
+
+        def method_missing(id, *args, &block)
+          (self.chained_messages ||= []) << ChainedMessage.new(id, args, block)
+          self
+        end
+
+        def matches?(given)
+          @positive_failure_message ||= "Matching with '#{matcher_name}' failed, although it should match."
+          @negative_failure_message ||= "Matching with '#{matcher_name}' passed, although it should_not match."
+          @match_block.call(given, self)
+        end
+        
+        def fail!(which)
+          @test_case.flunk(which ? failure_message : negative_failure_message)
+        end
+
+        def pass!(which)
+          @test_case.assert true
+        end
+        
+        alias_method :failure_message, :positive_failure_message
+      end
+      
+      Class.new(&body).new(match_block, self)
+    end
+  end
+end

data/lib/matchy/modals.rb

@@ -0,0 +1,34 @@
+module Matchy
+  module Modals
+    # Tests an expectation against the given object.
+    #
+    # ==== Examples
+    # 
+    #   "hello".should eql("hello")
+    #   13.should equal(13)
+    #   lambda { raise "u r doomed" }.should raise_error
+    #
+    def should(expectation = nil)
+      Matchy::ExpectationBuilder.build_expectation(true, expectation, self)
+    end
+    
+    alias :will :should
+    
+    # Tests that an expectation doesn't match the given object.
+    #
+    # ==== Examples
+    # 
+    #   "hello".should_not eql("hi")
+    #   41.should_not equal(13)
+    #   lambda { "savd bai da bell" }.should_not raise_error
+    #
+    def should_not(expectation = nil)
+      Matchy::ExpectationBuilder.build_expectation(false, expectation, self)
+    end
+    
+    alias :will_not :should_not
+    alias :wont :should_not
+  end
+end
+
+Object.send(:include, Matchy::Modals)