matahari 0.1.1 → 0.1.2

data/README.rdoc

@@ -16,6 +16,7 @@ you to specify all method calls, including uninteresting ones.
   describe "my object" do
     obj = MyAwesomeObject.new
     collaborator = spy(:collaborator)
+    obj.collaborator = collaborator
 
     obj.my_awesome_method
 
@@ -24,11 +25,43 @@ you to specify all method calls, including uninteresting ones.
 
 See also the cucumber feature, easily viewable at http://relishapp.com/Mortice/matahari
 
+== CONTEXT:
+
+Traditional mocks require you to put expectations (my_mock.should_receive) before action, 
+potentially with assertions coming after that. They also do stubbing at the same time as 
+setting up expectations (my_mock.should_receive(:something).and_return). These issues 
+lead to less readable tests and a tendency to set an expectation when only a stub is
+required, or vice versa.
+
+Test spies present an alternative philosophy to traditional mocking by acting as null 
+objects and then allowing assertions after the fact on method calls they have received. 
+This means that stubbing and asserting on collaborations can be separated and that all 
+assertions in a given test go in the same place.
+
+The RR project provides test spies, but due to the way it is built (it supports a 
+variety of different double strategies), it requires the user to call 'stub' on any 
+method which will later be asserted on. As @dchemlimsky puts it, this 'adds the need 
+for an extra line, binds these two lines [the stub call and the assertion] together, 
+and generally makes [the test] more difficult to understand.'
+
+By sticking to spies as a double strategy, matahari is able to avoid the need for a 
+similar call in the setup portion of the test - matahari spies simply collect the 
+details of all messages passed to them and provide a means for inspecting those 
+messages later.
+
+=== Further reading
+https://gist.github.com/716640 - Conversation between dchelimsky and myself about Ruby test 
+doubles
+
+http://dannorth.net/2008/09/14/the-end-of-endotesting/ - Article about mockito, which heavily 
+influenced the creation of Matahari
+
 == KNOWN ISSUES/TODO:
 
 * Stubbing implementation is incredibly basic
 * Not very usable at all for test/unit users (but this is easily fixed with an assert_received method)
 * No support for argument matchers - arguments must match exactly via == or not at all
+* We need to be able to remote-control BMWs.
 
 == INSTALL:
 
@@ -36,10 +69,11 @@ See also the cucumber feature, easily viewable at http://relishapp.com/Mortice/m
 
 == ACKNOWLEDGEMENTS:
 
-* David Chelimsky, for putting up with my 'robust' criticisms of RSpec mocks
+* David Chelimsky, for putting up with my robust criticisms of RSpec mocks
 * Aslak Hellesøy, for giving interesting feedback on an early version
 * Szczepan Faber, for creating Mockito
 * Brian Takita, for creating RR
+* James Adam, for encouraging people to add CONTEXT sections to their READMEs
 
 == LICENSE:
 

data/lib/matahari/debriefing.rb

@@ -1,31 +1,14 @@
 class Debriefing
-  def initialize(expected_calls = nil)
-    @expected_calls = expected_calls
+  def initialize(expected_call_count = nil)
+    @expected_call_count = expected_call_count
   end
 
   def matches?(subject)
     @subject = subject
-    invocations_matching_method = subject.invocations.select {|i| i[:method] == @call_to_verify}
-    method_matched = invocations_matching_method.size > 0 
-    no_args = @args_to_verify.size == 0
-    @matching_calls = invocations_matching_method.select {|i| i[:args].flatten === @args_to_verify}.size
-    if @expected_calls
-      checked_number_of_calls = true
-      args_match = @matching_calls == @expected_calls
-    else
-      args_match = @matching_calls > 0
-    end
-    matching = if checked_number_of_calls
-                 args_match
-               else
-                 method_matched && no_args || args_match
-               end
-
-    if matching
-      true
-    else
-      false
-    end
+    @invocations_of_method = subject.invocations.select {|i| i[:method] == @call_to_verify}
+    verifying_args = @args_to_verify.size != 0
+
+    match_passes?(verifying_args)
   end
 
   def failure_message_for_should_not
@@ -34,9 +17,9 @@ class Debriefing
 
   def failure_message_for_should
     if @args_to_verify.size > 0
-      "Spy(:#{@subject.name}) expected to receive :#{@call_to_verify}(#{@args_to_verify.map(&:inspect).join(", ")}) #{prettify_times(@expected_calls)}, received #{prettify_times(@matching_calls)}"
+      "Spy(:#{@subject.name}) expected to receive :#{@call_to_verify}(#{@args_to_verify.map(&:inspect).join(", ")}) #{prettify_times(@expected_call_count)}, received #{prettify_times(@matching_calls)}"
     else
-      "Spy(:#{@subject.name}) expected to receive :#{@call_to_verify} #{prettify_times(@expected_calls)}, received #{prettify_times(@matching_calls)}"
+      "Spy(:#{@subject.name}) expected to receive :#{@call_to_verify} #{prettify_times(@expected_call_count)}, received #{prettify_times(@matching_calls)}"
     end
   end
 
@@ -59,4 +42,22 @@ class Debriefing
     end
   end
   private :prettify_times
+
+	def matching_calls(verifying_args=true)
+		@matching_calls ||= if verifying_args
+			@invocations_of_method.select {|i| i[:args].flatten === @args_to_verify}.size
+		else
+			@invocations_of_method.size
+		end
+	end
+	private :matching_calls
+
+	def match_passes?(verifying_args)
+		if @expected_call_count
+			matching_calls(verifying_args) == @expected_call_count
+		else
+			matching_calls(verifying_args) > 0
+		end
+	end
+	private :match_passes?
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: matahari
 version: !ruby/object:Gem::Version 
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Tom Stuart
@@ -25,6 +26,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -38,6 +40,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -76,6 +79,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -84,6 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"