rspec 1.1.4 → 1.1.5

data/lib/spec/mocks.rb

@@ -1,6 +1,6 @@
 require 'spec/mocks/framework'
 require 'spec/mocks/methods'
-require 'spec/mocks/argument_constraint_matchers'
+require 'spec/mocks/argument_constraints'
 require 'spec/mocks/spec_methods'
 require 'spec/mocks/proxy'
 require 'spec/mocks/mock'

data/lib/spec/mocks/argument_constraints.rb

@@ -0,0 +1,185 @@
+module Spec
+  module Mocks
+
+    # ArgumentConstraints are messages that you can include in message
+    # expectations to match arguments against a broader check than simple
+    # equality.
+    #
+    # With the exception of any_args() and no_args(), the constraints
+    # are all positional - they match against the arg in the given position.
+    module ArgumentConstraints
+
+      class AnyArgsConstraint
+        def description
+          "any args"
+        end
+      end
+
+      class AnyArgConstraint
+        def initialize(ignore)
+        end
+
+        def ==(other)
+          true
+        end
+      end
+
+      class NoArgsConstraint
+        def description
+          "no args"
+        end
+
+        def ==(args)
+          args == []
+        end
+      end
+
+      class RegexpArgConstraint
+        def initialize(regexp)
+          @regexp = regexp
+        end
+
+        def ==(value)
+          return value =~ @regexp unless value.is_a?(Regexp)
+          value == @regexp
+        end
+      end
+
+      class BooleanArgConstraint
+        def initialize(ignore)
+        end
+
+        def ==(value)
+          TrueClass === value || FalseClass === value
+        end
+      end
+
+      class HashIncludingConstraint
+        def initialize(expected)
+          @expected = expected
+        end
+
+        def ==(actual)
+          @expected.each do | key, value |
+            return false unless actual.has_key?(key) && value == actual[key]
+          end
+          true
+        rescue NoMethodError => ex
+          return false
+        end
+
+        def description
+          "hash_including(#{@expected.inspect.sub(/^\{/,"").sub(/\}$/,"")})"
+        end
+      end
+      
+      class DuckTypeArgConstraint
+        def initialize(*methods_to_respond_to)
+          @methods_to_respond_to = methods_to_respond_to
+        end
+
+        def ==(value)
+          @methods_to_respond_to.all? { |sym| value.respond_to?(sym) }
+        end
+      end
+
+      class MatcherConstraint
+        def initialize(matcher)
+          @matcher = matcher
+        end
+
+        def ==(value)
+          @matcher.matches?(value)
+        end
+      end
+
+      class EqualityProxy
+        def initialize(given)
+          @given = given
+        end
+
+        def ==(expected)
+          @given == expected
+        end
+      end
+
+      module Deprecated
+        class NumericArgConstraint
+          def initialize(ignore)
+          end
+
+          def ==(value)
+            value.is_a?(Numeric)
+          end
+        end
+
+        class StringArgConstraint
+          def initialize(ignore)
+          end
+
+          def ==(value)
+            String === value
+          end
+        end
+      end
+
+      # :call-seq:
+      #   object.should_receive(:message).with(any_args())
+      #
+      # Passes if object receives :message with any args at all. This is
+      # really a more explicit variation of object.should_receive(:message)
+      def any_args
+        AnyArgsConstraint.new
+      end
+      
+      # :call-seq:
+      #   object.should_receive(:message).with(anything())
+      #
+      # Passes as long as there is an argument.
+      def anything
+        AnyArgConstraint.new(nil)
+      end
+      
+      # :call-seq:
+      #   object.should_receive(:message).with(no_args)
+      #
+      # Passes if no arguments are passed along with the message
+      def no_args
+        NoArgsConstraint.new
+      end
+      
+      # :call-seq:
+      #   object.should_receive(:message).with(duck_type(:hello))
+      #   object.should_receive(:message).with(duck_type(:hello, :goodbye))
+      #
+      # Passes if the argument responds to the specified messages.
+      #
+      # == Examples
+      #
+      #   array = []
+      #   display = mock('display')
+      #   display.should_receive(:present_names).with(duck_type(:length, :each))
+      #   => passes
+      def duck_type(*args)
+        DuckTypeArgConstraint.new(*args)
+      end
+
+      # :call-seq:
+      #   object.should_receive(:message).with(boolean())
+      #
+      # Passes if the argument is boolean.
+      def boolean
+        BooleanArgConstraint.new(nil)
+      end
+      
+      # :call-seq:
+      #   object.should_receive(:message).with(hash_including(:this => that))
+      #
+      # Passes if the argument is a hash that includes the specified key/value
+      # pairs. If the hash includes other keys, it will still pass.
+      def hash_including(expected={})
+        HashIncludingConstraint.new(expected)
+      end
+    end
+  end
+end

data/lib/spec/mocks/argument_expectation.rb

@@ -1,175 +1,40 @@
 module Spec
   module Mocks
-  
-    class MatcherConstraint
-      def initialize(matcher)
-        @matcher = matcher
-      end
-      
-      def matches?(value)
-        @matcher.matches?(value)
-      end
-    end
-      
-    class LiteralArgConstraint
-      def initialize(literal)
-        @literal_value = literal
-      end
-      
-      def matches?(value)
-        @literal_value == value
-      end
-    end
-    
-    class RegexpArgConstraint
-      def initialize(regexp)
-        @regexp = regexp
-      end
-      
-      def matches?(value)
-        return value =~ @regexp unless value.is_a?(Regexp)
-        value == @regexp
-      end
-    end
-    
-    class AnyArgConstraint
-      def initialize(ignore)
-      end
-      
-      def ==(other)
-        true
-      end
-      
-      # TODO - need this?
-      def matches?(value)
-        true
-      end
-    end
-    
-    class AnyArgsConstraint
-      def description
-        "any args"
-      end
-    end
-    
-    class NoArgsConstraint
-      def description
-        "no args"
-      end
-      
-      def ==(args)
-        args == []
-      end
-    end
-    
-    class NumericArgConstraint
-      def initialize(ignore)
-      end
-      
-      def matches?(value)
-        value.is_a?(Numeric)
-      end
-    end
     
-    class BooleanArgConstraint
-      def initialize(ignore)
-      end
-      
-      def ==(value)
-        matches?(value)
-      end
-      
-      def matches?(value)
-        return true if value.is_a?(TrueClass)
-        return true if value.is_a?(FalseClass)
-        false
-      end
-    end
-    
-    class StringArgConstraint
-      def initialize(ignore)
-      end
-      
-      def matches?(value)
-        value.is_a?(String)
-      end
-    end
-    
-    class DuckTypeArgConstraint
-      def initialize(*methods_to_respond_to)
-        @methods_to_respond_to = methods_to_respond_to
-      end
-  
-      def matches?(value)
-        @methods_to_respond_to.all? { |sym| value.respond_to?(sym) }
-      end
-      
-      def description
-        "duck_type"
-      end
-    end
-    
-    class HashIncludingConstraint
-      def initialize(expected)
-        @expected = expected
-      end
-      
-      def ==(actual)
-        @expected.each do | key, value |
-          # check key for case that value evaluates to nil
-          return false unless actual.has_key?(key) && actual[key] == value
-        end
-        true
-      rescue NoMethodError => ex
-        return false
-      end
-      
-      def matches?(value)
-        self == value
-      end
-      
-      def description
-        "hash_including(#{@expected.inspect.sub(/^\{/,"").sub(/\}$/,"")})"
-      end
-      
-    end
-    
-
     class ArgumentExpectation
       attr_reader :args
-      @@constraint_classes = Hash.new { |hash, key| LiteralArgConstraint}
-      @@constraint_classes[:anything] = AnyArgConstraint
-      @@constraint_classes[:numeric] = NumericArgConstraint
-      @@constraint_classes[:boolean] = BooleanArgConstraint
-      @@constraint_classes[:string] = StringArgConstraint
+      @@constraint_classes = Hash.new
+      @@constraint_classes[:anything] = ArgumentConstraints::AnyArgConstraint
+      @@constraint_classes[:boolean] = ArgumentConstraints::BooleanArgConstraint
+      @@constraint_classes[:numeric] = ArgumentConstraints::Deprecated::NumericArgConstraint
+      @@constraint_classes[:string] = ArgumentConstraints::Deprecated::StringArgConstraint
       
-      def initialize(args)
+      def initialize(args, &block)
         @args = args
+        @constraints_block = block
+        
         if [:any_args] == args
-          @expected_params = nil
-          warn_deprecated(:any_args.inspect, "any_args()")
-        elsif args.length == 1 && args[0].is_a?(AnyArgsConstraint) then @expected_params = nil
+          @expected_args = nil
+          warn_constraint_symbol_deprecated(:any_args.inspect, "any_args()")
+        elsif ArgumentConstraints::AnyArgsConstraint === args.first
+          @expected_args = nil
         elsif [:no_args] == args
-          @expected_params = []
-          warn_deprecated(:no_args.inspect, "no_args()")
-        elsif args.length == 1 && args[0].is_a?(NoArgsConstraint) then @expected_params = []
-        else @expected_params = process_arg_constraints(args)
-        end
-      end
-      
-      def process_arg_constraints(constraints)
-        constraints.collect do |constraint| 
-          convert_constraint(constraint)
+          @expected_args = []
+          warn_constraint_symbol_deprecated(:no_args.inspect, "no_args()")
+        elsif ArgumentConstraints::NoArgsConstraint === args.first
+          @expected_args = []
+        else
+          @expected_args = args.collect {|arg| constraint_for(arg)}
         end
       end
       
-      def warn_deprecated(deprecated_method, instead)
-        Kernel.warn "The #{deprecated_method} constraint is deprecated. Use #{instead} instead."
+      def warn_constraint_symbol_deprecated(deprecated_method, instead)
+        Kernel.warn "The #{deprecated_method} constraint is deprecated and will be removed after RSpec 1.1.5. Use #{instead} instead."
       end
       
-      def convert_constraint(constraint)
-        if [:anything, :numeric, :boolean, :string].include?(constraint)
-          case constraint
+      def constraint_for(arg)
+        if [:anything, :numeric, :boolean, :string].include?(arg)
+          case arg
           when :anything
             instead = "anything()"
           when :boolean
@@ -179,30 +44,27 @@ module Spec
           when :string
             instead = "an_instance_of(String)"
           end
-          warn_deprecated(constraint.inspect, instead)
-          return @@constraint_classes[constraint].new(constraint)
+          warn_constraint_symbol_deprecated(arg.inspect, instead)
+          return @@constraint_classes[arg].new(arg)
         end
-        return MatcherConstraint.new(constraint) if is_matcher?(constraint)
-        return RegexpArgConstraint.new(constraint) if constraint.is_a?(Regexp)
-        return LiteralArgConstraint.new(constraint)
+        return ArgumentConstraints::MatcherConstraint.new(arg) if is_matcher?(arg)
+        return ArgumentConstraints::RegexpArgConstraint.new(arg) if arg.is_a?(Regexp)
+        return ArgumentConstraints::EqualityProxy.new(arg)
       end
       
       def is_matcher?(obj)
         return obj.respond_to?(:matches?) && obj.respond_to?(:description)
       end
       
-      def check_args(args)
-        return true if @expected_params.nil?
-        return true if @expected_params == args
-        return constraints_match?(args)
+      def args_match?(given_args)
+        if @constraints_block
+          @constraints_block.call(*given_args)
+          return true
+        end
+        
+        @expected_args.nil? || @expected_args == given_args
       end
       
-      def constraints_match?(args)
-        return false if args.length != @expected_params.length
-        @expected_params.each_index { |i| return false unless @expected_params[i].matches?(args[i]) }
-        return true
-      end
-  
     end
     
   end

data/lib/spec/mocks/framework.rb

@@ -3,7 +3,7 @@
 # object in the system.
 
 require 'spec/mocks/methods'
-require 'spec/mocks/argument_constraint_matchers'
+require 'spec/mocks/argument_constraints'
 require 'spec/mocks/spec_methods'
 require 'spec/mocks/proxy'
 require 'spec/mocks/mock'

data/lib/spec/mocks/message_expectation.rb

@@ -3,6 +3,10 @@ module Spec
 
     class BaseExpectation
       attr_reader :sym
+      attr_writer :expected_received_count, :method_block, :expected_from, :args_to_yield
+      protected :expected_received_count=, :method_block=, :expected_from=, :args_to_yield=
+      attr_accessor :error_generator
+      protected :error_generator, :error_generator=
       
       def initialize(error_generator, expectation_ordering, expected_from, sym, method_block, expected_received_count=1, opts={})
         @error_generator = error_generator
@@ -13,7 +17,7 @@ module Spec
         @return_block = nil
         @actual_received_count = 0
         @expected_received_count = expected_received_count
-        @args_expectation = ArgumentExpectation.new([AnyArgsConstraint.new])
+        @args_expectation = ArgumentExpectation.new([ArgumentConstraints::AnyArgsConstraint.new])
         @consecutive = false
         @exception_to_raise = nil
         @symbol_to_throw = nil
@@ -23,6 +27,23 @@ module Spec
         @args_to_yield = []
       end
       
+      def build_child(expected_from, method_block, expected_received_count, opts={})
+        child = clone
+        child.expected_from = expected_from
+        child.method_block = method_block
+        child.expected_received_count = expected_received_count
+        new_gen = error_generator.clone
+        new_gen.opts = opts
+        child.error_generator = new_gen
+        child.args_to_yield = @args_to_yield.clone
+        child
+      end
+      
+      def error_generator_opts=(opts={})
+        @error_generator.opts = opts
+      end
+      protected :error_generator_opts=
+      
       def expected_args
         @args_expectation.args
       end
@@ -68,7 +89,7 @@ module Spec
       end
   
       def matches(sym, args)
-        @sym == sym and @args_expectation.check_args(args)
+        @sym == sym and @args_expectation.args_match?(args)
       end
       
       def invoke(args, block)
@@ -103,6 +124,11 @@ module Spec
           @actual_received_count += 1
         end
       end
+
+      def called_max_times?
+        @expected_received_count != :any &&
+          @actual_received_count >= @expected_received_count
+      end
       
       protected
 
@@ -152,7 +178,7 @@ module Spec
     class MessageExpectation < BaseExpectation
       
       def matches_name_but_not_args(sym, args)
-        @sym == sym and not @args_expectation.check_args(args)
+        @sym == sym and not @args_expectation.args_match?(args)
       end
        
       def verify_messages_received   
@@ -202,8 +228,7 @@ module Spec
       end
 
       def with(*args, &block)
-        @method_block = block if block
-        @args_expectation = ArgumentExpectation.new(args)
+        @args_expectation = ArgumentExpectation.new(args, &block)
         self
       end