matahari 0.1.2 → 0.2.0

data/README.rdoc

@@ -1,6 +1,6 @@
 = matahari
 
-* https://github.com/mortice/matahari
+* http://tomstuart.co.uk/2011/06/05/mocks-suck-matahari-sucks-less.html
 
 == DESCRIPTION:
 
@@ -10,8 +10,7 @@ It is designed to allow you to test interactions between objects *without* requi
 you to specify all method calls, including uninteresting ones.
 
 == SYNOPSIS:
-
-  require 'matahari'
+Matahari allows you to do this (RSpec example)
 
   describe "my object" do
     obj = MyAwesomeObject.new
@@ -23,7 +22,24 @@ you to specify all method calls, including uninteresting ones.
     collaborator.should have_received(3.times).some_interesting_method("Some", "arguments")
   end
 
-See also the cucumber feature, easily viewable at http://relishapp.com/Mortice/matahari
+See also the cucumber features, easily viewable at http://relishapp.com/mortice/matahari
+
+== USING:
+
+=== RSpec
+
+In your spec_helper, include this:
+
+  RSpec.configure do |config|
+    config.include Matahari::Adapters::RSpec
+  end
+
+=== test/unit
+In your test_helper, include this:
+
+  class Test::Unit::TestCase
+    include Matahari::Adapters::TestUnit
+  end
 
 == CONTEXT:
 

data/lib/matahari.rb

@@ -1,14 +1,9 @@
 $:.unshift(File.dirname(__FILE__)) unless
 $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
-module Matahari
-  VERSION = '0.1.1'
-end
-
 require 'matahari/spy'
 require 'matahari/debriefing'
-require 'matahari/rspec/matchers'
-
-def spy(name = nil)
-  Spy.new(name)
-end
+require 'matahari/adapters/matahari_methods'
+require 'matahari/adapters/rspec'
+require 'matahari/adapters/test_unit'
+require 'matahari/version'

data/lib/matahari/adapters/matahari_methods.rb

@@ -0,0 +1,9 @@
+module Matahari
+  module Adapters
+    module MatahariMethods
+      def spy(name = nil)
+        Spy.new(name)
+      end
+    end
+  end
+end

data/lib/matahari/adapters/rspec.rb

@@ -0,0 +1,18 @@
+module Matahari
+  module Adapters
+    module RSpec
+      include Matahari::Adapters::MatahariMethods
+
+      def have_received(times = nil)
+        if times 
+          @calls_expected = 0
+          times.each { @calls_expected+= 1 }
+
+          Debriefing.new(@calls_expected)
+        else
+          Debriefing.new
+        end
+      end
+    end
+  end
+end

data/lib/matahari/adapters/test_unit.rb

@@ -0,0 +1,17 @@
+module Matahari
+  module Adapters
+    module TestUnit
+      include Matahari::Adapters::MatahariMethods
+
+      def assert_received(subject, &block)
+        result = block.call
+        assert result.matches?(subject), result.failure_message_for_should
+      end
+
+			def assert_not_received(subject, &block)
+				result = block.call
+				assert !result.matches?(subject), result.failure_message_for_should_not
+			end
+    end
+  end
+end

data/lib/matahari/debriefing.rb

@@ -1,4 +1,11 @@
 class Debriefing
+
+  #TODO I can't work out how to disentangle the 2 responsibilities of this class:
+  #1. Inspecting and acting on spy invocations
+  #2. Presenting the results of those inspections.
+  #
+  #One to revisit later when my head is less befuddled.
+
   def initialize(expected_call_count = nil)
     @expected_call_count = expected_call_count
   end
@@ -23,6 +30,9 @@ class Debriefing
     end
   end
 
+  #Allows chaining of method calls following has_received?/should have_received,
+  #e.g. spy.should_have received.some_method, where #some_method is handled by
+  #method_missing, its arguments and name being stored until #matches? is called.
   def method_missing(sym, *args, &block)
     @call_to_verify = sym
     @args_to_verify = args

data/lib/matahari/spy.rb

@@ -5,12 +5,23 @@ class Spy
     @name = name if name
     @invocations = []
     @stubbed_calls = {}
+    self.class.instance_methods.each do |meth|
+      next if [:define_method, :stubs, :method_missing, :record_invocation].include?(meth)
+    end
+    class << self
+      instance_methods.each do |meth|
+        next if [:name, :define_method, :stubs, :method_missing, :record_invocation, :invocations, :has_received?, :object_id, :respond_to?, :respond_to_missing?, :instance_eval, :instance_exec, :class_eval, :__send__, :send, :should, :should_not].include?(meth)
+        undef_method(meth)
+      end
+    end
   end
 
+  #When a given method call, sym, is invoked on self, call block and return its result
   def stubs(sym, &block)
     @stubbed_calls[sym] = block
   end
 
+  #Captures the details of any method call and store for later inspection
   def method_missing(sym, *args, &block)
     if @verifying
       raise
@@ -20,12 +31,16 @@ class Spy
     end
   end
 
+  #Pass an iterator to this method to specify the number of times the method should
+  #have been called. E.g. spy.has_received?(3.times). While other iterators might work,
+  #the idea is to allow this nice DSL-ish way of asserting on the number of calls, hence
+  #the odd method signature.
   def has_received?(times=nil)
     if times 
-      @calls_expected = 0
-      times.each { @calls_expected+= 1 }
+      calls_expected = 0
+      times.each { calls_expected += 1 }
 
-      Debriefing.new(@calls_expected)
+      Debriefing.new(calls_expected)
     else
       Debriefing.new
     end

data/lib/matahari/version.rb

@@ -0,0 +1,3 @@
+module Matahari
+  VERSION = "0.2.0"
+end

metadata

@@ -1,103 +1,88 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: matahari
-version: !ruby/object:Gem::Version 
-  hash: 31
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 2
-  version: 0.1.2
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Tom Stuart
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-01-13 00:00:00 +00:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2157293000 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: *2157293000
+- !ruby/object:Gem::Dependency
   name: cucumber
+  requirement: &2157292460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2157292460
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: &2157292040 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-description: 
-email: tom@therye.org
+  prerelease: false
+  version_requirements: *2157292040
+description: Matahari provides test spies for Ruby
+email:
+- tom@therye.org
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.rdoc
-files: 
-- README.rdoc
-- test/spy_test.rb
-- spec/debriefing_spec.rb
-- spec/spec_helper.rb
-- spec/spy_spec.rb
+extra_rdoc_files: []
+files:
+- lib/matahari/adapters/matahari_methods.rb
+- lib/matahari/adapters/rspec.rb
+- lib/matahari/adapters/test_unit.rb
 - lib/matahari/debriefing.rb
-- lib/matahari/rspec/matchers.rb
 - lib/matahari/spy.rb
+- lib/matahari/version.rb
 - lib/matahari.rb
-has_rdoc: true
+- README.rdoc
 homepage: https://github.com/mortice/matahari
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.rdoc
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Test spy library, inspired by Mockito and RR
 test_files: []
-

data/lib/matahari/rspec/matchers.rb

@@ -1,10 +0,0 @@
-def have_received(times = nil)
-  if times 
-    @calls_expected = 0
-    times.each { @calls_expected+= 1 }
-
-    Debriefing.new(@calls_expected)
-  else
-    Debriefing.new
-  end
-end

data/spec/debriefing_spec.rb

@@ -1,86 +0,0 @@
-require 'spec_helper'
-describe Debriefing do
-  it "matches simple invocations" do
-    #we have to use rspec mocks here because testing matahari with matahari
-    #makes my brain hurt
-
-    subject = mock(:subject)
-    debriefing = Debriefing.new
-
-    subject.should_receive(:invocations).and_return([{:method => :one, :args => [[]]}])
-
-    debriefing.one
-
-    debriefing.matches?(subject).should be_true
-  end
-
-  it "matches invocations based on arguments" do
-    subject = mock(:subject)
-    correct_debriefing = Debriefing.new
-    incorrect_debriefing = Debriefing.new
-
-    subject.should_receive(:invocations).twice.and_return([{:method => :one, :args => [["Hello", "goodbye"]]}])
-
-    correct_debriefing.one("Hello", "goodbye")
-    incorrect_debriefing.one("Hello", "goodbye", "Hello again")
-
-    correct_debriefing.matches?(subject).should be_true
-    incorrect_debriefing.matches?(subject).should be_false
-  end
-
-  it "gives a failure message for should when method not called" do
-    subject = mock(:subject)
-    debriefing = Debriefing.new
-
-    subject.should_receive(:invocations).and_return([{:method => :one, :args => [[]]}])
-    subject.should_receive(:name).and_return(:subject)
-
-    debriefing.two
-
-    debriefing.matches?(subject).should be_false
-
-    debriefing.failure_message_for_should.should == "Spy(:subject) expected to receive :two once, received 0 times"
-  end
-
-  it "gives a failure message for should when method called with wrong arguments" do
-    subject = mock(:subject)
-    debriefing = Debriefing.new
-
-    subject.should_receive(:invocations).and_return([{:method => :one, :args => [[]]}])
-    subject.should_receive(:name).and_return(:subject)
-
-    debriefing.one("Hello")
-
-    debriefing.matches?(subject).should be_false
-
-    debriefing.failure_message_for_should.should ==  "Spy(:subject) expected to receive :one(\"Hello\") once, received 0 times"
-  end
-
-  it "gives a failure message for should when method called wrong number of times" do
-    subject = mock(:subject)
-    debriefing = Debriefing.new(2)
-
-    subject.should_receive(:invocations).and_return([{:method => :one, :args => [[]]}])
-    subject.should_receive(:name).and_return(:subject)
-
-    debriefing.one
-
-    debriefing.matches?(subject).should be_false
-
-    debriefing.failure_message_for_should.should == "Spy(:subject) expected to receive :one twice, received once"
-  end
-
-  it "gives a failure message for should not" do
-    subject = mock(:subject)
-    debriefing = Debriefing.new
-
-    subject.should_receive(:invocations).and_return([{:method => :two, :args => [[]]}])
-    subject.should_receive(:name).and_return(:subject)
-
-    debriefing.two
-
-    debriefing.matches?(subject).should be_true
-
-    debriefing.failure_message_for_should_not.should == "Spy(:subject) expected not to receive :two but received it once"
-  end
-end

data/spec/spec_helper.rb

@@ -1,2 +0,0 @@
-require File.dirname(__FILE__) + "/../lib/matahari"
-require 'rspec'

data/spec/spy_spec.rb

@@ -1,49 +0,0 @@
-require 'spec_helper'
-
-describe "Spy" do
-  it "takes an optional name parameter" do
-    named = Spy.new(:bond)
-    unnamed = Spy.new
-
-    named.name.should == :bond
-    unnamed.name.should == nil
-  end
-
-  context "in the field" do
-    it "remains as a sleeper agent until called upon" do
-      mata_hari = Spy.new(:mata_hari)
-      lambda do 
-        mata_hari.one
-        mata_hari.two
-        mata_hari.three
-      end.should_not raise_error NoMethodError
-    end
-
-    it "captures communications" do
-      mata_hari = Spy.new(:mata_hari)
-
-      mata_hari.one
-      mata_hari.two
-
-      mata_hari.invocations.should == [{:method => :one, :args => [[]]}, {:method => :two, :args => [[]]}]
-    end
-
-    it "captures the details of communications" do
-      mata_hari = Spy.new(:mata_hari)
-
-      mata_hari.one
-      mata_hari.two("Hello")
-
-      mata_hari.invocations.should == [{:method => :one, :args => [[]]}, {:method => :two, :args => [["Hello"]]}]
-    end
-
-    it "doesn't stop you stubbing" do
-      mata_hari = Spy.new(:mata_hari)
-
-      mata_hari.stubs(:test) { "Hello" }
-
-      mata_hari.test.should == "Hello"
-      mata_hari.invocations.should == [{:method => :test, :args => [[]]}]
-    end
-  end
-end

data/test/spy_test.rb

@@ -1,16 +0,0 @@
-require 'test/unit'
-require 'matahari'
-
-class SpyTest < Test::Unit::TestCase
-  #minimal test to make sure we stay compatible. For full tests, see spec/
-  def test_matahari_works_with_test_unit
-    mata_hari = spy(:mata_hari)
-
-    mata_hari.one
-
-    #I know this syntax sucks but at least it shows you don't *need* rspec to use matahari.
-    #TODO make an assert_received method for test/unit
-    assert mata_hari.has_received?.one.matches?(mata_hari)
-    assert !mata_hari.has_received?.two.matches?(mata_hari)
-  end
-end