dchelimsky-rspec 1.1.10

data/spec/spec/matchers/eql_spec.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+module Spec
+  module Matchers
+    describe Eql do
+      it "should match when actual.eql?(expected)" do
+        Eql.new(1).matches?(1).should be_true
+      end
+      it "should not match when !actual.eql?(expected)" do
+        Eql.new(1).matches?(2).should be_false
+      end
+      it "should describe itself" do
+        matcher = Eql.new(1)
+        matcher.description.should == "eql 1"
+      end
+      it "should provide message, expected and actual on #failure_message" do
+        matcher = Eql.new("1")
+        matcher.matches?(1)
+        matcher.failure_message.should == ["expected \"1\", got 1 (using .eql?)", "1", 1]
+      end
+      it "should provide message, expected and actual on #negative_failure_message" do
+        matcher = Eql.new(1)
+        matcher.matches?(1)
+        matcher.negative_failure_message.should == ["expected 1 not to equal 1 (using .eql?)", 1, 1]
+      end
+    end
+  end
+end

data/spec/spec/matchers/equal_spec.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+module Spec
+  module Matchers
+    describe Equal do
+      it "should match when actual.equal?(expected)" do
+        Equal.new(1).matches?(1).should be_true
+      end
+      it "should not match when !actual.equal?(expected)" do
+        Equal.new("1").matches?("1").should be_false
+      end
+      it "should describe itself" do
+        matcher = Equal.new(1)
+        matcher.description.should == "equal 1"
+      end
+      it "should provide message, expected and actual on #failure_message" do
+        matcher = Equal.new("1")
+        matcher.matches?(1)
+        matcher.failure_message.should == ["expected \"1\", got 1 (using .equal?)", "1", 1]
+      end
+      it "should provide message, expected and actual on #negative_failure_message" do
+        matcher = Equal.new(1)
+        matcher.matches?(1)
+        matcher.negative_failure_message.should == ["expected 1 not to equal 1 (using .equal?)", 1, 1]
+      end
+    end
+  end
+end

data/spec/spec/matchers/exist_spec.rb

@@ -0,0 +1,57 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+class Substance
+  def initialize exists, description
+    @exists = exists
+    @description = description
+  end
+  def exist?
+    @exists
+  end
+  def inspect
+    @description
+  end
+end
+  
+class SubstanceTester
+  include Spec::Matchers
+  def initialize substance
+    @substance = substance
+  end
+  def should_exist
+    @substance.should exist
+  end
+end
+
+describe "should exist," do
+  
+  before(:each) do
+    @real = Substance.new true, 'something real'
+    @imaginary = Substance.new false, 'something imaginary'
+  end
+
+  describe "within an example group" do
+  
+    it "should pass if target exists" do
+      @real.should exist
+    end
+  
+    it "should fail if target does not exist" do
+      lambda { @imaginary.should exist }.should fail
+    end
+    
+    it "should pass if target doesn't exist" do
+      lambda { @real.should_not exist }.should fail
+    end
+  end
+
+  describe "outside of an example group" do
+
+    it "should pass if target exists" do
+      real_tester = SubstanceTester.new @real
+      real_tester.should_exist
+    end
+
+  end
+
+end

data/spec/spec/matchers/handler_spec.rb

@@ -0,0 +1,150 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+module ExampleExpectations
+  
+  class ArbitraryMatcher
+    def initialize(*args, &block)
+      if args.last.is_a? Hash
+        @expected = args.last[:expected]
+      end
+      if block_given?
+        @expected = block.call
+      end
+      @block = block
+    end
+    
+    def matches?(target)
+      @target = target
+      return @expected == target
+    end
+    
+    def with(new_value)
+      @expected = new_value
+      self
+    end
+    
+    def failure_message
+      "expected #{@expected}, got #{@target}"
+    end
+    
+    def negative_failure_message
+      "expected not #{@expected}, got #{@target}"
+    end
+  end
+  
+  class PositiveOnlyMatcher < ArbitraryMatcher
+    undef negative_failure_message rescue nil
+  end
+  
+  def arbitrary_matcher(*args, &block)
+    ArbitraryMatcher.new(*args, &block)
+  end
+  
+  def positive_only_matcher(*args, &block)
+    PositiveOnlyMatcher.new(*args, &block)
+  end
+  
+end
+
+module Spec
+  module Expectations
+    describe ExpectationMatcherHandler do
+      describe "#handle_matcher" do
+        it "should ask the matcher if it matches" do
+          matcher = mock("matcher")
+          actual = Object.new
+          matcher.should_receive(:matches?).with(actual).and_return(true)
+          ExpectationMatcherHandler.handle_matcher(actual, matcher)
+        end
+      
+        it "should explain when the matcher parameter is not a matcher" do
+          begin
+            nonmatcher = mock("nonmatcher")
+            actual = Object.new
+            ExpectationMatcherHandler.handle_matcher(actual, nonmatcher)
+          rescue Spec::Expectations::InvalidMatcherError => e
+          end
+
+          e.message.should =~ /^Expected a matcher, got /
+        end
+        
+        it "should return the match value" do
+          matcher = mock("matcher")
+          actual = Object.new
+          matcher.should_receive(:matches?).with(actual).and_return(:this_value)
+          ExpectationMatcherHandler.handle_matcher(actual, matcher).should == :this_value
+        end
+      end
+    end
+
+    describe NegativeExpectationMatcherHandler do
+      describe "#handle_matcher" do
+        it "should explain when matcher does not support should_not" do
+          matcher = mock("matcher")
+          matcher.stub!(:matches?)
+          actual = Object.new
+          lambda {
+            NegativeExpectationMatcherHandler.handle_matcher(actual, matcher)
+          }.should fail_with(/Matcher does not support should_not.\n/)
+        end      
+      
+        it "should ask the matcher if it matches" do
+          matcher = mock("matcher")
+          actual = Object.new
+          matcher.stub!(:negative_failure_message)
+          matcher.should_receive(:matches?).with(actual).and_return(false)
+          NegativeExpectationMatcherHandler.handle_matcher(actual, matcher)
+        end
+      
+        it "should explain when the matcher parameter is not a matcher" do
+          begin
+            nonmatcher = mock("nonmatcher")
+            actual = Object.new
+            NegativeExpectationMatcherHandler.handle_matcher(actual, nonmatcher)
+          rescue Spec::Expectations::InvalidMatcherError => e
+          end
+
+          e.message.should =~ /^Expected a matcher, got /
+        end
+
+        
+        it "should return the match value" do
+          matcher = mock("matcher")
+          actual = Object.new
+          matcher.should_receive(:matches?).with(actual).and_return(false)
+          matcher.stub!(:negative_failure_message).and_return("ignore")
+          NegativeExpectationMatcherHandler.handle_matcher(actual, matcher).should be_false
+        end
+      end
+    end
+    
+    describe ExpectationMatcherHandler do
+      include ExampleExpectations
+      
+      it "should handle submitted args" do
+        5.should arbitrary_matcher(:expected => 5)
+        5.should arbitrary_matcher(:expected => "wrong").with(5)
+        lambda { 5.should arbitrary_matcher(:expected => 4) }.should fail_with("expected 4, got 5")
+        lambda { 5.should arbitrary_matcher(:expected => 5).with(4) }.should fail_with("expected 4, got 5")
+        5.should_not arbitrary_matcher(:expected => 4)
+        5.should_not arbitrary_matcher(:expected => 5).with(4)
+        lambda { 5.should_not arbitrary_matcher(:expected => 5) }.should fail_with("expected not 5, got 5")
+        lambda { 5.should_not arbitrary_matcher(:expected => 4).with(5) }.should fail_with("expected not 5, got 5")
+      end
+
+      it "should handle the submitted block" do
+        5.should arbitrary_matcher { 5 }
+        5.should arbitrary_matcher(:expected => 4) { 5 }
+        5.should arbitrary_matcher(:expected => 4).with(5) { 3 }
+      end
+  
+      it "should explain when matcher does not support should_not" do
+        lambda {
+          5.should_not positive_only_matcher(:expected => 5)
+        }.should fail_with(/Matcher does not support should_not.\n/)
+      end
+
+
+    end
+  end
+end

data/spec/spec/matchers/has_spec.rb

@@ -0,0 +1,63 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+describe "should have_sym(*args)" do
+  it "should pass if #has_sym?(*args) returns true" do
+    {:a => "A"}.should have_key(:a)
+  end
+
+  it "should fail if #has_sym?(*args) returns false" do
+    lambda {
+      {:b => "B"}.should have_key(:a)
+    }.should fail_with("expected #has_key?(:a) to return true, got false")
+  end
+
+  it "should fail if target does not respond to #has_sym?" do
+    lambda {
+      Object.new.should have_key(:a)
+    }.should raise_error(NoMethodError)
+  end
+  
+  it "should reraise an exception thrown in #has_sym?(*args)" do
+    o = Object.new
+    def o.has_sym?(*args)
+      raise "Funky exception"
+    end
+    lambda { o.should have_sym(:foo) }.should raise_error("Funky exception")
+  end
+end
+
+describe "should_not have_sym(*args)" do
+  it "should pass if #has_sym?(*args) returns false" do
+    {:a => "A"}.should_not have_key(:b)
+  end
+
+  it "should fail if #has_sym?(*args) returns true" do
+    lambda {
+      {:a => "A"}.should_not have_key(:a)
+    }.should fail_with("expected #has_key?(:a) to return false, got true")
+  end
+
+  it "should fail if target does not respond to #has_sym?" do
+    lambda {
+      Object.new.should have_key(:a)
+    }.should raise_error(NoMethodError)
+  end
+  
+  it "should reraise an exception thrown in #has_sym?(*args)" do
+    o = Object.new
+    def o.has_sym?(*args)
+      raise "Funky exception"
+    end
+    lambda { o.should_not have_sym(:foo) }.should raise_error("Funky exception")
+  end
+end
+
+describe Spec::Matchers::Has do
+  it "should work when the target implements #send" do
+    o = {:a => "A"}
+    def o.send(*args); raise "DOH! Library developers shouldn't use #send!" end
+    lambda {
+      o.should have_key(:a)
+    }.should_not raise_error
+  end
+end

data/spec/spec/matchers/have_spec.rb

@@ -0,0 +1,394 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+module HaveSpecHelper
+  def create_collection_owner_with(n)
+    owner = Spec::Expectations::Helper::CollectionOwner.new
+    (1..n).each do |n|
+      owner.add_to_collection_with_length_method(n)
+      owner.add_to_collection_with_size_method(n)
+    end
+    owner
+  end
+end
+
+describe "should have(n).items" do
+  include HaveSpecHelper
+
+  it "should pass if target has a collection of items with n members" do
+    owner = create_collection_owner_with(3)
+    owner.should have(3).items_in_collection_with_length_method
+    owner.should have(3).items_in_collection_with_size_method
+  end
+
+  it "should convert :no to 0" do
+    owner = create_collection_owner_with(0)
+    owner.should have(:no).items_in_collection_with_length_method
+    owner.should have(:no).items_in_collection_with_size_method
+  end
+
+  it "should fail if target has a collection of items with < n members" do
+    owner = create_collection_owner_with(3)
+    lambda {
+      owner.should have(4).items_in_collection_with_length_method
+    }.should fail_with("expected 4 items_in_collection_with_length_method, got 3")
+    lambda {
+      owner.should have(4).items_in_collection_with_size_method
+    }.should fail_with("expected 4 items_in_collection_with_size_method, got 3")
+  end
+  
+  it "should fail if target has a collection of items with > n members" do
+    owner = create_collection_owner_with(3)
+    lambda {
+      owner.should have(2).items_in_collection_with_length_method
+    }.should fail_with("expected 2 items_in_collection_with_length_method, got 3")
+    lambda {
+      owner.should have(2).items_in_collection_with_size_method
+    }.should fail_with("expected 2 items_in_collection_with_size_method, got 3")
+  end
+end
+
+describe 'should have(1).item when ActiveSupport::Inflector is defined' do
+  include HaveSpecHelper
+  
+  before(:each) do
+    unless defined?(ActiveSupport::Inflector)
+      @active_support_was_not_defined
+      module ActiveSupport
+        class Inflector
+          def self.pluralize(string)
+            string.to_s + 's'
+          end
+        end
+      end
+    end
+  end
+  
+  it 'should pluralize the collection name' do
+    owner = create_collection_owner_with(1)
+    owner.should have(1).item
+  end
+  
+  after(:each) do
+    if @active_support_was_not_defined
+      Object.send :remove_const, :ActiveSupport
+    end
+  end
+end
+
+describe 'should have(1).item when Inflector is defined' do
+  include HaveSpecHelper
+  
+  before(:each) do
+    unless defined?(Inflector)
+      @inflector_was_not_defined
+      class Inflector
+        def self.pluralize(string)
+          string.to_s + 's'
+        end
+      end
+    end
+  end
+  
+  it 'should pluralize the collection name' do
+    owner = create_collection_owner_with(1)
+    owner.should have(1).item
+  end
+
+  after(:each) do
+    if @inflector_was_not_defined
+      Object.send :remove_const, :Inflector
+    end
+  end
+end
+
+describe "should have(n).items where result responds to items but returns something other than a collection" do
+  it "should provide a meaningful error" do
+    owner = Class.new do
+      def items
+        Object.new
+      end
+    end.new
+    lambda do
+      owner.should have(3).items
+    end.should raise_error("expected items to be a collection but it does not respond to #length or #size")
+  end
+end
+
+describe "should_not have(n).items" do
+  include HaveSpecHelper
+
+  it "should pass if target has a collection of items with < n members" do
+    owner = create_collection_owner_with(3)
+    owner.should_not have(4).items_in_collection_with_length_method
+    owner.should_not have(4).items_in_collection_with_size_method
+  end
+  
+  it "should pass if target has a collection of items with > n members" do
+    owner = create_collection_owner_with(3)
+    owner.should_not have(2).items_in_collection_with_length_method
+    owner.should_not have(2).items_in_collection_with_size_method
+  end
+
+  it "should fail if target has a collection of items with n members" do
+    owner = create_collection_owner_with(3)
+    lambda {
+      owner.should_not have(3).items_in_collection_with_length_method
+    }.should fail_with("expected target not to have 3 items_in_collection_with_length_method, got 3")
+    lambda {
+      owner.should_not have(3).items_in_collection_with_size_method
+      }.should fail_with("expected target not to have 3 items_in_collection_with_size_method, got 3")
+  end
+end
+
+describe "should have_exactly(n).items" do
+  include HaveSpecHelper
+
+  it "should pass if target has a collection of items with n members" do
+    owner = create_collection_owner_with(3)
+    owner.should have_exactly(3).items_in_collection_with_length_method
+    owner.should have_exactly(3).items_in_collection_with_size_method
+  end
+
+  it "should convert :no to 0" do
+    owner = create_collection_owner_with(0)
+    owner.should have_exactly(:no).items_in_collection_with_length_method
+    owner.should have_exactly(:no).items_in_collection_with_size_method
+  end
+
+  it "should fail if target has a collection of items with < n members" do
+    owner = create_collection_owner_with(3)
+    lambda {
+      owner.should have_exactly(4).items_in_collection_with_length_method
+    }.should fail_with("expected 4 items_in_collection_with_length_method, got 3")
+    lambda {
+      owner.should have_exactly(4).items_in_collection_with_size_method
+    }.should fail_with("expected 4 items_in_collection_with_size_method, got 3")
+  end
+  
+  it "should fail if target has a collection of items with > n members" do
+    owner = create_collection_owner_with(3)
+    lambda {
+      owner.should have_exactly(2).items_in_collection_with_length_method
+    }.should fail_with("expected 2 items_in_collection_with_length_method, got 3")
+    lambda {
+      owner.should have_exactly(2).items_in_collection_with_size_method
+    }.should fail_with("expected 2 items_in_collection_with_size_method, got 3")
+  end
+end
+
+describe "should have_at_least(n).items" do
+  include HaveSpecHelper
+
+  it "should pass if target has a collection of items with n members" do
+    owner = create_collection_owner_with(3)
+    owner.should have_at_least(3).items_in_collection_with_length_method
+    owner.should have_at_least(3).items_in_collection_with_size_method
+  end
+  
+  it "should pass if target has a collection of items with > n members" do
+    owner = create_collection_owner_with(3)
+    owner.should have_at_least(2).items_in_collection_with_length_method
+    owner.should have_at_least(2).items_in_collection_with_size_method
+  end
+
+  it "should fail if target has a collection of items with < n members" do
+    owner = create_collection_owner_with(3)
+    lambda {
+      owner.should have_at_least(4).items_in_collection_with_length_method
+    }.should fail_with("expected at least 4 items_in_collection_with_length_method, got 3")
+    lambda {
+      owner.should have_at_least(4).items_in_collection_with_size_method
+    }.should fail_with("expected at least 4 items_in_collection_with_size_method, got 3")
+  end
+  
+  it "should provide educational negative failure messages" do
+    #given
+    owner = create_collection_owner_with(3)
+    length_matcher = have_at_least(3).items_in_collection_with_length_method
+    size_matcher = have_at_least(3).items_in_collection_with_size_method
+    
+    #when
+    length_matcher.matches?(owner)
+    size_matcher.matches?(owner)
+    
+    #then
+    length_matcher.negative_failure_message.should == <<-EOF
+Isn't life confusing enough?
+Instead of having to figure out the meaning of this:
+  should_not have_at_least(3).items_in_collection_with_length_method
+We recommend that you use this instead:
+  should have_at_most(2).items_in_collection_with_length_method
+EOF
+
+    size_matcher.negative_failure_message.should == <<-EOF
+Isn't life confusing enough?
+Instead of having to figure out the meaning of this:
+  should_not have_at_least(3).items_in_collection_with_size_method
+We recommend that you use this instead:
+  should have_at_most(2).items_in_collection_with_size_method
+EOF
+  end
+end
+
+describe "should have_at_most(n).items" do
+  include HaveSpecHelper
+
+  it "should pass if target has a collection of items with n members" do
+    owner = create_collection_owner_with(3)
+    owner.should have_at_most(3).items_in_collection_with_length_method
+    owner.should have_at_most(3).items_in_collection_with_size_method
+  end
+
+  it "should fail if target has a collection of items with > n members" do
+    owner = create_collection_owner_with(3)
+    lambda {
+      owner.should have_at_most(2).items_in_collection_with_length_method
+    }.should fail_with("expected at most 2 items_in_collection_with_length_method, got 3")
+    lambda {
+      owner.should have_at_most(2).items_in_collection_with_size_method
+    }.should fail_with("expected at most 2 items_in_collection_with_size_method, got 3")
+  end
+  
+  it "should pass if target has a collection of items with < n members" do
+    owner = create_collection_owner_with(3)
+    owner.should have_at_most(4).items_in_collection_with_length_method
+    owner.should have_at_most(4).items_in_collection_with_size_method
+  end
+
+  it "should provide educational negative failure messages" do
+    #given
+    owner = create_collection_owner_with(3)
+    length_matcher = have_at_most(3).items_in_collection_with_length_method
+    size_matcher = have_at_most(3).items_in_collection_with_size_method
+    
+    #when
+    length_matcher.matches?(owner)
+    size_matcher.matches?(owner)
+    
+    #then
+    length_matcher.negative_failure_message.should == <<-EOF
+Isn't life confusing enough?
+Instead of having to figure out the meaning of this:
+  should_not have_at_most(3).items_in_collection_with_length_method
+We recommend that you use this instead:
+  should have_at_least(4).items_in_collection_with_length_method
+EOF
+    
+    size_matcher.negative_failure_message.should == <<-EOF
+Isn't life confusing enough?
+Instead of having to figure out the meaning of this:
+  should_not have_at_most(3).items_in_collection_with_size_method
+We recommend that you use this instead:
+  should have_at_least(4).items_in_collection_with_size_method
+EOF
+  end
+end
+
+describe "have(n).items(args, block)" do
+  it "should pass args to target" do
+    target = mock("target")
+    target.should_receive(:items).with("arg1","arg2").and_return([1,2,3])
+    target.should have(3).items("arg1","arg2")
+  end
+
+  it "should pass block to target" do
+    target = mock("target")
+    block = lambda { 5 }
+    target.should_receive(:items).with("arg1","arg2", block).and_return([1,2,3])
+    target.should have(3).items("arg1","arg2", block)
+  end
+end
+
+describe "have(n).items where target IS a collection" do
+  it "should reference the number of items IN the collection" do
+    [1,2,3].should have(3).items
+  end
+
+  it "should fail when the number of items IN the collection is not as expected" do
+    lambda { [1,2,3].should have(7).items }.should fail_with("expected 7 items, got 3")
+  end
+end
+
+describe "have(n).characters where target IS a String" do
+  it "should pass if the length is correct" do
+    "this string".should have(11).characters
+  end
+
+  it "should fail if the length is incorrect" do
+    lambda { "this string".should have(12).characters }.should fail_with("expected 12 characters, got 11")
+  end
+end
+
+describe "have(n).things on an object which is not a collection nor contains one" do
+  it "should fail" do
+    lambda { Object.new.should have(2).things }.should raise_error(NoMethodError, /undefined method `things' for #<Object:/)
+  end
+end
+
+describe Spec::Matchers::Have, "for a collection owner that implements #send" do
+  include HaveSpecHelper
+
+  before(:each) do
+    @collection = Object.new
+    def @collection.floozles; [1,2] end
+    def @collection.send(*args); raise "DOH! Library developers shouldn't use #send!" end
+  end
+  
+  it "should work in the straightforward case" do
+    lambda {
+      @collection.should have(2).floozles
+    }.should_not raise_error
+  end
+
+  it "should work when doing automatic pluralization" do
+    lambda {
+      @collection.should have_at_least(1).floozle
+    }.should_not raise_error
+  end
+
+  it "should blow up when the owner doesn't respond to that method" do
+    lambda {
+      @collection.should have(99).problems
+    }.should raise_error(NoMethodError, /problems/)
+  end
+end
+
+module Spec
+  module Matchers
+    describe Have do
+      it "should have method_missing as private" do
+        Have.private_instance_methods.should include("method_missing")
+      end
+      
+      describe "respond_to?" do
+        before :each do
+          @have = Have.new(:foo)
+          @a_method_which_have_defines = Have.instance_methods.first
+          @a_method_which_object_defines = Object.instance_methods.first
+        end
+        
+        it "should be true for a method which Have defines" do
+          @have.should respond_to(@a_method_which_have_defines)
+        end
+        
+        it "should be true for a method that it's superclass (Object) defines" do
+          @have.should respond_to(@a_method_which_object_defines)
+        end
+        
+        it "should be false for a method which neither Object nor nor Have defines" do
+          @have.should_not respond_to(:foo_bar_baz)
+        end
+        
+        it "should be false if the owner doesn't respond to the method" do
+          have = Have.new(99)
+          have.should_not respond_to(:problems)
+        end
+        
+        it "should be true if the owner responds to the method" do
+          have = Have.new(:a_symbol)
+          have.should respond_to(:to_sym)
+        end
+      end
+    end
+  end
+end