rr 0.3.3 → 0.3.4

data/examples/rr/scenario_example.rb

@@ -16,8 +16,12 @@ end
 describe Scenario, "#with" do
   it_should_behave_like "RR::Scenario"
 
+  it "returns ScenarioDefinition" do
+    @scenario.with(1).should === @scenario.definition
+  end
+
   it "sets an ArgumentEqualityExpectation" do
-    @scenario.with(1).should === @scenario
+    @scenario.with(1)
     @scenario.should be_exact_match(1)
     @scenario.should_not be_exact_match(2)
   end
@@ -35,8 +39,8 @@ describe Scenario, "#with_any_args" do
     @scenario.with_any_args {:return_value}
   end
 
-  it "returns self" do
-    @scenario.with_no_args.should === @scenario
+  it "returns ScenarioDefinition" do
+    @scenario.with_no_args.should === @scenario.definition
   end
 
   it "sets an AnyArgumentExpectation" do
@@ -56,8 +60,8 @@ describe Scenario, "#with_no_args" do
     @scenario.with_no_args {:return_value}
   end
 
-  it "returns self" do
-    @scenario.with_no_args.should === @scenario
+  it "returns ScenarioDefinition" do
+    @scenario.with_no_args.should === @scenario.definition
   end
 
   it "sets an ArgumentEqualityExpectation with no arguments" do
@@ -72,8 +76,8 @@ end
 describe Scenario, "#never" do
   it_should_behave_like "RR::Scenario"
 
-  it "returns self" do
-    @scenario.never.should === @scenario
+  it "returns ScenarioDefinition" do
+    @scenario.never.should === @scenario.definition
   end
 
   it "sets up a Times Called Expectation with 0" do
@@ -90,8 +94,12 @@ end
 describe Scenario, "#once" do
   it_should_behave_like "RR::Scenario"
 
+  it "returns ScenarioDefinition" do
+    @scenario.once.should === @scenario.definition
+  end
+
   it "sets up a Times Called Expectation with 1" do
-    @scenario.once.should === @scenario
+    @scenario.once
     @scenario.call(@double)
     proc {@scenario.call(@double)}.should raise_error(Errors::TimesCalledError)
   end
@@ -105,8 +113,12 @@ end
 describe Scenario, "#twice" do
   it_should_behave_like "RR::Scenario"
 
+  it "returns ScenarioDefinition" do
+    @scenario.twice.should === @scenario.definition
+  end
+
   it "sets up a Times Called Expectation with 2" do
-    @scenario.twice.should === @scenario
+    @scenario.twice
     @scenario.call(@double)
     @scenario.call(@double)
     proc {@scenario.call(@double)}.should raise_error(Errors::TimesCalledError)
@@ -121,13 +133,13 @@ end
 describe Scenario, "#at_least" do
   it_should_behave_like "RR::Scenario"
 
-  it "returns self" do
-    @scenario.with_any_args.at_least(2).should === @scenario
+  it "returns ScenarioDefinition" do
+    @scenario.with_any_args.at_least(2).should === @scenario.definition
   end
 
-  it "sets up a Times Called Expectation with 1" do
+  it "sets up a AtLeastMatcher with 2" do
     @scenario.at_least(2)
-    @scenario.times_matcher.should == TimesCalledMatchers::AtLeastMatcher.new(2)
+    @scenario.definition.times_matcher.should == TimesCalledMatchers::AtLeastMatcher.new(2)
   end
 
   it "sets return value when block passed in" do
@@ -139,8 +151,8 @@ end
 describe Scenario, "#at_most" do
   it_should_behave_like "RR::Scenario"
 
-  it "returns self" do
-    @scenario.with_any_args.at_most(2).should === @scenario
+  it "returns ScenarioDefinition" do
+    @scenario.with_any_args.at_most(2).should === @scenario.definition
   end
 
   it "sets up a Times Called Expectation with 1" do
@@ -164,8 +176,12 @@ end
 describe Scenario, "#times" do
   it_should_behave_like "RR::Scenario"
 
+  it "returns ScenarioDefinition" do
+    @scenario.times(3).should === @scenario.definition
+  end
+
   it "sets up a Times Called Expectation with passed in times" do
-    @scenario.times(3).should === @scenario
+    @scenario.times(3)
     @scenario.call(@double)
     @scenario.call(@double)
     @scenario.call(@double)
@@ -181,8 +197,8 @@ end
 describe Scenario, "#any_number_of_times" do
   it_should_behave_like "RR::Scenario"
 
-  it "returns self" do
-    @scenario.any_number_of_times.should === @scenario
+  it "returns ScenarioDefinition" do
+    @scenario.any_number_of_times.should === @scenario.definition
   end
 
   it "sets up a Times Called Expectation with AnyTimes matcher" do
@@ -232,8 +248,8 @@ end
 describe Scenario, "#yields" do
   it_should_behave_like "RR::Scenario"
 
-  it "returns self" do
-    @scenario.yields(:baz).should === @scenario
+  it "returns ScenarioDefinition" do
+    @scenario.yields(:baz).should === @scenario.definition
   end
 
   it "yields the passed in argument to the call block when there is no returns value set" do
@@ -260,8 +276,8 @@ end
 describe Scenario, "#after_call" do
   it_should_behave_like "RR::Scenario"
 
-  it "returns self" do
-    @scenario.after_call {}.should === @scenario
+  it "returns ScenarioDefinition" do
+    @scenario.after_call {}.should === @scenario.definition
   end
 
   it "sends return value of Scenario implementation to after_call" do
@@ -306,9 +322,9 @@ end
 describe Scenario, "#returns" do
   it_should_behave_like "RR::Scenario"
 
-  it "returns self" do
-    @scenario.returns {:baz}.should === @scenario
-    @scenario.returns(:baz).should === @scenario
+  it "returns ScenarioDefinition" do
+    @scenario.returns {:baz}.should === @scenario.definition
+    @scenario.returns(:baz).should === @scenario.definition
   end
 
   it "sets the value of the method when passed a block" do
@@ -336,8 +352,8 @@ end
 describe Scenario, "#implemented_by" do
   it_should_behave_like "RR::Scenario"
 
-  it "returns the scenario object" do
-    @scenario.implemented_by(proc{:baz}).should === @scenario
+  it "returns the ScenarioDefinition" do
+    @scenario.implemented_by(proc{:baz}).should === @scenario.definition
   end
 
   it "sets the implementation to the passed in proc" do
@@ -357,8 +373,8 @@ end
 describe Scenario, "#implemented_by_original_method" do
   it_should_behave_like "RR::Scenario"
 
-  it "returns the scenario object" do
-    @scenario.implemented_by_original_method.should === @scenario
+  it "returns the ScenarioDefinition object" do
+    @scenario.implemented_by_original_method.should === @scenario.definition
   end
 
   it "sets the implementation to the original method" do
@@ -573,7 +589,7 @@ describe Scenario, "#attempt?" do
 
   it "returns true when there is no Times Called expectation" do
     @scenario.with(1, 2, 3)
-    @scenario.times_called_expectation.should be_nil
+    @scenario.definition.times_matcher.should be_nil
     @scenario.should be_attempt
   end
 end
@@ -616,8 +632,8 @@ describe Scenario, "#terminal?" do
     @scenario.should_not be_terminal
   end
 
-  it "returns false when there is not times_called_expectation" do
-    @scenario.times_called_expectation.should be_nil
+  it "returns false when there is no times_matcher" do
+    @scenario.definition.times_matcher.should be_nil
     @scenario.should_not be_terminal
   end
 end

data/examples/rr/scenario_method_proxy_example.rb

@@ -32,7 +32,7 @@ describe ScenarioMethodProxy, ".new without block" do
     proxy_subclass.instance_methods.should include('i_should_be_a_scenario')
 
     proxy = proxy_subclass.new(@space, @creator, @subject)
-    proxy.i_should_be_a_scenario.should be_instance_of(Scenario)
+    proxy.i_should_be_a_scenario.should be_instance_of(ScenarioDefinition)
   end
 end
 
@@ -63,7 +63,7 @@ describe ScenarioMethodProxy, ".new with block" do
     proxy_subclass.instance_methods.should include('i_should_be_a_scenario')
 
     proxy_subclass.new(@space, @creator, @subject) do |m|
-      m.i_should_be_a_scenario.should be_instance_of(Scenario)
+      m.i_should_be_a_scenario.should be_instance_of(ScenarioDefinition)
     end
   end
 end

data/examples/rr/space/space_verify_example.rb

@@ -161,9 +161,9 @@ describe Space, "#verify_ordered_scenario where the passed in scenario is not at
   end
 
   def scenario
-    scenario = @space.scenario(@double).once
-    @space.register_ordered_scenario(scenario)
-    scenario
+    scenario_definition = @space.scenario(@double).once
+    @space.register_ordered_scenario(scenario_definition.scenario)
+    scenario_definition.scenario
   end
 end
 end

data/lib/rr.rb

@@ -1,3 +1,5 @@
+require "forwardable"
+
 require "rr/errors/rr_error"
 require "rr/errors/scenario_definition_error"
 require "rr/errors/scenario_not_found_error"
@@ -14,6 +16,8 @@ require "rr/scenario_method_proxy"
 require "rr/scenario_creator"
 
 require "rr/scenario"
+require "rr/scenario_definition"
+require "rr/scenario_definition_builder"
 require "rr/scenario_matches"
 
 require "rr/expectations/argument_equality_expectation"

data/lib/rr/expectations/times_called_expectation.rb

@@ -1,12 +1,11 @@
 module RR
   module Expectations
     class TimesCalledExpectation
-      attr_reader :matcher, :times_called
+      attr_reader :times_called
+      attr_accessor :matcher
       
-      def initialize(matcher=nil, &time_condition_block)
-        raise ArgumentError, "Cannot pass in both an argument and a block" if matcher && time_condition_block
-        matcher_value = matcher || time_condition_block
-        @matcher = TimesCalledMatchers::TimesCalledMatcher.create(matcher_value)
+      def initialize(matcher=nil)
+        @matcher = matcher
         @times_called = 0
         @verify_backtrace = caller[1..-1]
       end

data/lib/rr/extensions/instance_methods.rb

@@ -153,6 +153,22 @@ module Extensions
     alias_method :do_not_allow, :do_not_call
     alias_method :dont_allow, :do_not_call
 
+    # Calling instance_of will cause all instances of the passed in Class
+    # to have the Scenario defined.
+    #
+    # The following example mocks all User's valid? method and return false.
+    #   mock.instance_of(User).valid? {false}
+    #
+    # The following example mocks and probes User#projects and returns the
+    # first 3 projects.
+    #   mock.instance_of(User).projects do |projects|
+    #     projects[0..2]
+    #   end
+    def instance_of(subject=ScenarioCreator::NO_SUBJECT_ARG, method_name=nil, &definition)
+      creator = RR::Space.scenario_creator
+      creator.instance_of(subject, method_name, &definition)
+    end
+
     # Returns a AnyTimesMatcher. This is meant to be passed in as an argument
     # to Scenario#times.
     #

data/lib/rr/scenario.rb

@@ -15,19 +15,15 @@ module RR
         end.join("\n")
       end
     end
-    ORIGINAL_METHOD = Object.new
 
-    attr_reader :times_called, :argument_expectation, :times_called_expectation, :double
+    attr_reader :times_called, :double, :definition
 
-    def initialize(space, double)
+    def initialize(space, double, definition)
       @space = space
       @double = double
-      @implementation = nil
-      @argument_expectation = nil
-      @times_called_expectation = nil
+      @definition = definition
       @times_called = 0
-      @after_call = nil
-      @yields = nil
+      @times_called_expectation = Expectations::TimesCalledExpectation.new
     end
 
     # Scenario#with sets the expectation that the Scenario will receive
@@ -37,9 +33,7 @@ module RR
     #
     #   mock(subject).method_name.with(1, 2) {:return_value}
     def with(*args, &returns)
-      @argument_expectation = Expectations::ArgumentEqualityExpectation.new(*args)
-      returns(&returns) if returns
-      self
+      definition.with(*args, &returns)
     end
 
     # Scenario#with_any_args sets the expectation that the Scenario can receive
@@ -49,9 +43,7 @@ module RR
     #
     #   mock(subject).method_name.with_any_args {:return_value}
     def with_any_args(&returns)
-      @argument_expectation = Expectations::AnyArgumentExpectation.new
-      returns(&returns) if returns
-      self
+      definition.with_any_args(&returns)
     end
 
     # Scenario#with_no_args sets the expectation that the Scenario will receive
@@ -61,9 +53,7 @@ module RR
     #
     #   mock(subject).method_name.with_no_args {:return_value}
     def with_no_args(&returns)
-      @argument_expectation = Expectations::ArgumentEqualityExpectation.new()
-      returns(&returns) if returns
-      self
+      definition.with_no_args(&returns)
     end
 
     # Scenario#never sets the expectation that the Scenario will never be
@@ -73,8 +63,7 @@ module RR
     #
     #   mock(subject).method_name.never
     def never
-      @times_called_expectation = Expectations::TimesCalledExpectation.new(0)
-      self
+      definition.never
     end
 
     # Scenario#once sets the expectation that the Scenario will be called
@@ -84,9 +73,7 @@ module RR
     #
     #   mock(subject).method_name.once {:return_value}
     def once(&returns)
-      @times_called_expectation = Expectations::TimesCalledExpectation.new(1)
-      returns(&returns) if returns
-      self
+      definition.once(&returns)
     end
 
     # Scenario#twice sets the expectation that the Scenario will be called
@@ -96,9 +83,7 @@ module RR
     #
     #   mock(subject).method_name.twice {:return_value}
     def twice(&returns)
-      @times_called_expectation = Expectations::TimesCalledExpectation.new(2)
-      returns(&returns) if returns
-      self
+      definition.twice(&returns)
     end
 
     # Scenario#at_least sets the expectation that the Scenario
@@ -109,10 +94,7 @@ module RR
     #
     #   mock(subject).method_name.at_least(4) {:return_value}
     def at_least(number, &returns)
-      matcher = RR::TimesCalledMatchers::AtLeastMatcher.new(number)
-      @times_called_expectation = Expectations::TimesCalledExpectation.new(matcher)
-      returns(&returns) if returns
-      self
+      definition.at_least(number, &returns)
     end
 
     # Scenario#at_most allows sets the expectation that the Scenario
@@ -123,10 +105,7 @@ module RR
     #
     #   mock(subject).method_name.at_most(4) {:return_value}
     def at_most(number, &returns)
-      matcher = RR::TimesCalledMatchers::AtMostMatcher.new(number)
-      @times_called_expectation = Expectations::TimesCalledExpectation.new(matcher)
-      returns(&returns) if returns
-      self
+      definition.at_most(number, &returns)
     end
 
     # Scenario#any_number_of_times sets an that the Scenario will be called
@@ -137,9 +116,7 @@ module RR
     #
     #   mock(subject).method_name.any_number_of_times
     def any_number_of_times(&returns)
-      @times_called_expectation = Expectations::TimesCalledExpectation.new(TimesCalledMatchers::AnyTimesMatcher.new)
-      returns(&returns) if returns
-      self
+      definition.any_number_of_times(&returns)
     end
 
     # Scenario#times creates an TimesCalledExpectation of the passed
@@ -149,9 +126,7 @@ module RR
     #
     #   mock(subject).method_name.times(4) {:return_value}
     def times(number, &returns)
-      @times_called_expectation = Expectations::TimesCalledExpectation.new(number)
-      returns(&returns) if returns
-      self
+      definition.times(number, &returns)
     end
 
     # Scenario#ordered sets the Scenario to have an ordered
@@ -161,17 +136,14 @@ module RR
     #
     #   mock(subject).method_name.ordered {return_value}
     def ordered(&returns)
-      @ordered = true
-      @space.ordered_scenarios << self unless @space.ordered_scenarios.include?(self)
-      returns(&returns) if returns
-      self
+      definition.ordered(&returns)
     end
 
     # Scenario#ordered? returns true when the Scenario is ordered.
     #
     #   mock(subject).method_name.ordered?
     def ordered?
-      @ordered
+      definition.ordered?
     end
 
     # Scenario#yields sets the Scenario to invoke a passed in block when
@@ -184,9 +156,7 @@ module RR
     #   mock(subject).method_name.yields(yield_arg1, yield_arg2) {return_value}
     #   subject.method_name {|yield_arg1, yield_arg2|}
     def yields(*args, &returns)
-      @yields = args
-      returns(&returns) if returns
-      self
+      definition.yields(*args, &returns)
     end
 
     # Scenario#after_call creates a callback that occurs after call
@@ -200,9 +170,7 @@ module RR
     # This feature is built into probes.
     #   probe(User).find('1') {|user| mock(user).valid? {false}}
     def after_call(&block)
-      raise ArgumentError, "after_call expects a block" unless block
-      @after_call = block
-      self
+      definition.after_call &block
     end
 
     # Scenario#returns accepts an argument value or a block.
@@ -213,14 +181,7 @@ module RR
     #
     # Passing in an argument causes Scenario to return the argument.
     def returns(value=nil, &implementation)
-      if value && implementation
-        raise ArgumentError, "returns cannot accept both an argument and a block"
-      end
-      if value.nil?
-        implemented_by implementation
-      else
-        implemented_by proc {value}
-      end
+      definition.returns(value, &implementation)
     end
 
     # Scenario#implemented_by sets the implementation of the Scenario.
@@ -233,8 +194,7 @@ module RR
     #   end
     #   mock(obj).method_name.implemented_by(obj.method(:foobar))
     def implemented_by(implementation)
-      @implementation = implementation
-      self
+      definition.implemented_by implementation
     end
 
     # Scenario#implemented_by_original_method sets the implementation
@@ -248,8 +208,7 @@ module RR
     #   mock(obj).method_name.implemented_by_original_method
     #   obj.foobar {|arg| puts arg} # puts 1
     def implemented_by_original_method
-      implemented_by ORIGINAL_METHOD
-      self
+      definition.implemented_by_original_method
     end
 
     # Scenario#call calls the Scenario's implementation. The return
@@ -258,28 +217,28 @@ module RR
     # A TimesCalledError is raised when the times called
     # exceeds the expected TimesCalledExpectation.
     def call(double, *args, &block)
-      @times_called_expectation.attempt! if @times_called_expectation
+      self.times_called_expectation.attempt! if definition.times_matcher
       @space.verify_ordered_scenario(self) if ordered?
       yields!(block)
       return_value = call_implementation(double, *args, &block)
-      return return_value unless @after_call
-      @after_call.call(return_value)
+      return return_value unless definition.after_call_value
+      definition.after_call_value.call(return_value)
     end
 
     def yields!(block)
-      if @yields
+      if definition.yields_value
         unless block
           raise ArgumentError, "A Block must be passed into the method call when using yields"
         end
-        block.call(*@yields)
+        block.call(*definition.yields_value)
       end
     end
     protected :yields!
 
     def call_implementation(double, *args, &block)
-      return nil unless @implementation
+      return nil unless implementation
 
-      if @implementation === ORIGINAL_METHOD
+      if implementation === ScenarioDefinition::ORIGINAL_METHOD
         if double.original_method
           return double.original_method.call(*args, &block)
         else
@@ -292,11 +251,11 @@ module RR
         end
       end
 
-      if @implementation.is_a?(Method)
-        return @implementation.call(*args, &block)
+      if implementation.is_a?(Method)
+        return implementation.call(*args, &block)
       else
         args << block if block
-        return @implementation.call(*args)
+        return implementation.call(*args)
       end
     end
     protected :call_implementation
@@ -304,36 +263,34 @@ module RR
     # Scenario#exact_match? returns true when the passed in arguments
     # exactly match the ArgumentEqualityExpectation arguments.
     def exact_match?(*arguments)
-      return false unless @argument_expectation
-      @argument_expectation.exact_match?(*arguments)
+      definition.exact_match?(*arguments)
     end
 
     # Scenario#wildcard_match? returns true when the passed in arguments
     # wildcard match the ArgumentEqualityExpectation arguments.
     def wildcard_match?(*arguments)
-      return false unless @argument_expectation
-      @argument_expectation.wildcard_match?(*arguments)
+      definition.wildcard_match?(*arguments)
     end
 
     # Scenario#attempt? returns true when the
     # TimesCalledExpectation is satisfied.
     def attempt?
-      return true unless @times_called_expectation
-      @times_called_expectation.attempt?
+      return true unless definition.times_matcher
+      times_called_expectation.attempt?
     end
 
     # Scenario#verify verifies the the TimesCalledExpectation
     # is satisfied for this scenario. A TimesCalledError
     # is raised if the TimesCalledExpectation is not met.
     def verify
-      return true unless @times_called_expectation
-      @times_called_expectation.verify!
+      return true unless definition.times_matcher
+      times_called_expectation.verify!
       true
     end
 
     def terminal?
-      return false unless @times_called_expectation
-      @times_called_expectation.terminal?
+      return false unless definition.times_matcher
+      times_called_expectation.terminal?
     end
 
     # The method name that this Scenario is attatched to
@@ -351,5 +308,26 @@ module RR
     def times_matcher
       times_called_expectation.matcher
     end
+
+    def times_called_expectation
+      @times_called_expectation.matcher = definition.times_matcher
+      @times_called_expectation
+    end
+
+    def implementation
+      definition.implementation
+    end
+    def implementation=(value)
+      definition.implementation = value
+    end
+    protected :implementation=
+
+    def argument_expectation
+      definition.argument_expectation
+    end
+    def argument_expectation=(value)
+      definition.argument_expectation = value
+    end
+    protected :argument_expectation=
   end
 end