matahari 0.1.1

data/README.rdoc

@@ -0,0 +1,67 @@
+= matahari
+
+* https://github.com/mortice/matahari
+
+== DESCRIPTION:
+
+Matahari is a test spy library, heavily inspired by Java's Mockito and btakita's RR.
+
+It is designed to allow you to test interactions between objects *without* requiring
+you to specify all method calls, including uninteresting ones.
+
+== SYNOPSIS:
+
+  require 'matahari'
+
+  describe "my object" do
+    obj = MyAwesomeObject.new
+    collaborator = spy(:collaborator)
+
+    obj.my_awesome_method
+
+    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
+
+== 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
+
+== INSTALL:
+
+* gem install matahari
+
+== ACKNOWLEDGEMENTS:
+
+* 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
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010-2011 Tom Stuart
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/matahari.rb

@@ -0,0 +1,14 @@
+$:.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

data/lib/matahari/debriefing.rb

@@ -0,0 +1,62 @@
+class Debriefing
+  def initialize(expected_calls = nil)
+    @expected_calls = expected_calls
+  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
+  end
+
+  def failure_message_for_should_not
+    "Spy(:#{@subject.name}) expected not to receive :#{@call_to_verify} but received it #{prettify_times(@matching_calls)}"
+  end
+
+  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)}"
+    else
+      "Spy(:#{@subject.name}) expected to receive :#{@call_to_verify} #{prettify_times(@expected_calls)}, received #{prettify_times(@matching_calls)}"
+    end
+  end
+
+  def method_missing(sym, *args, &block)
+    @call_to_verify = sym
+    @args_to_verify = args
+    self
+  end
+
+  def prettify_times(times)
+    case times
+    when 1
+      "once"
+    when nil
+      "once"
+    when 2
+      "twice"
+    else
+      "#{times} times"
+    end
+  end
+  private :prettify_times
+end

data/lib/matahari/rspec/matchers.rb

@@ -0,0 +1,10 @@
+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/lib/matahari/spy.rb

@@ -0,0 +1,38 @@
+class Spy
+  attr_reader :name, :invocations
+
+  def initialize(name = nil)
+    @name = name if name
+    @invocations = []
+    @stubbed_calls = {}
+  end
+
+  def stubs(sym, &block)
+    @stubbed_calls[sym] = block
+  end
+
+  def method_missing(sym, *args, &block)
+    if @verifying
+      raise
+    else
+      record_invocation(sym, args)
+      @stubbed_calls[sym].call if @stubbed_calls[sym]
+    end
+  end
+
+  def has_received?(times=nil)
+    if times 
+      @calls_expected = 0
+      times.each { @calls_expected+= 1 }
+
+      Debriefing.new(@calls_expected)
+    else
+      Debriefing.new
+    end
+  end
+
+  private
+  def record_invocation(sym, *args)
+    @invocations << {:method => sym, :args => args}
+  end
+end

data/spec/debriefing_spec.rb

@@ -0,0 +1,86 @@
+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

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

data/spec/spy_spec.rb

@@ -0,0 +1,49 @@
+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

@@ -0,0 +1,16 @@
+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

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: matahari
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Tom Stuart
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-13 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: 
+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
+- lib/matahari/debriefing.rb
+- lib/matahari/rspec/matchers.rb
+- lib/matahari/spy.rb
+- lib/matahari.rb
+has_rdoc: true
+homepage: https://github.com/mortice/matahari
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Test spy library, inspired by Mockito and RR
+test_files: []
+