rspec-expectations 3.0.0.beta1 → 3.0.0.beta2

data/spec/rspec/matchers/matcher_spec.rb

@@ -1,706 +0,0 @@
-# encoding: utf-8
-require 'spec_helper'
-
-class UnexpectedError < StandardError; end
-module MatcherHelperModule
-  def self.included(base)
-    base.module_exec do
-      def included_method; end
-    end
-  end
-
-  def self.extended(base)
-    base.instance_exec do
-      def extended_method; end
-    end
-  end
-
-  def greeting
-    "Hello, World"
-  end
-end
-
-module RSpec::Matchers::DSL
-  describe Matcher do
-    def new_matcher(name, *expected, &block)
-      RSpec::Matchers::DSL::Matcher.
-        new(name, block, *expected).
-        tap { |m| m.matcher_execution_context = self }
-    end
-
-    it "can be stored aside and used later" do
-      # Supports using rspec-expectation matchers as argument matchers in
-      # rspec-mocks.
-      RSpec::Matchers.define :example_matcher do |expected|
-        match do |actual|
-          actual == expected
-        end
-      end
-
-      m1 = example_matcher(1)
-      m2 = example_matcher(2)
-
-      expect(m1.matches?(1)).to be_truthy
-      expect(m2.matches?(2)).to be_truthy
-    end
-
-    context "with an included module" do
-      let(:matcher) do
-        new_matcher(:be_a_greeting) do
-          include MatcherHelperModule
-          match { |actual| actual == greeting }
-        end
-      end
-
-      it "has access to the module's methods" do
-        matcher.matches?("Hello, World")
-      end
-
-      it "runs the module's included hook" do
-        expect(matcher).to respond_to(:included_method)
-      end
-
-      it "does not run the module's extended hook" do
-        expect(matcher).not_to respond_to(:extended_method)
-      end
-
-      it 'allows multiple modules to be included at once' do
-        m = new_matcher(:multiple_modules) do
-          include Enumerable, Comparable
-        end
-        expect(m).to be_a(Enumerable)
-        expect(m).to be_a(Comparable)
-      end
-    end
-
-    context "without overrides" do
-      let(:matcher) do
-        new_matcher(:be_a_multiple_of, 3) do |multiple|
-          match do |actual|
-            actual % multiple == 0
-          end
-        end
-      end
-
-      it "provides a default description" do
-        expect(matcher.description).to eq "be a multiple of 3"
-      end
-
-      it "provides a default failure message for #should" do
-        matcher.matches?(8)
-        expect(matcher.failure_message_for_should).to eq "expected 8 to be a multiple of 3"
-      end
-
-      it "provides a default failure message for #should_not" do
-        matcher.matches?(9)
-        expect(matcher.failure_message_for_should_not).to eq "expected 9 not to be a multiple of 3"
-      end
-    end
-
-    context "with separate match logic for should and should not" do
-      let(:matcher) do
-        new_matcher(:to_be_composed_of, 7, 11) do |a, b|
-          match_for_should do |actual|
-            actual == a * b
-          end
-
-          match_for_should_not do |actual|
-            actual == a + b
-          end
-        end
-      end
-
-      it "invokes the match_for_should block for #matches?" do
-        expect(matcher.matches?(77)).to be_truthy
-        expect(matcher.matches?(18)).to be_falsey
-      end
-
-      it "invokes the match_for_should_not block for #does_not_match?" do
-        expect(matcher.does_not_match?(77)).to be_falsey
-        expect(matcher.does_not_match?(18)).to be_truthy
-      end
-
-      it "provides a default failure message for #should_not" do
-        matcher.does_not_match?(77)
-        expect(matcher.failure_message_for_should_not).to eq "expected 77 not to to be composed of 7 and 11"
-      end
-
-      it 'can access helper methods from `match_for_should_not`' do
-        matcher = new_matcher(:be_foo) do
-          def foo
-            :foo
-          end
-
-          match_for_should_not do |actual|
-            actual != foo
-          end
-        end
-
-        expect(matcher.does_not_match?(:bar)).to be true
-      end
-    end
-
-    it "allows helper methods to be defined with #define_method to have access to matcher parameters" do
-      matcher = new_matcher(:name, 3, 4) do |a, b|
-        define_method(:sum) { a + b }
-      end
-
-      expect(matcher.sum).to eq 7
-    end
-
-    it "is not diffable by default" do
-      matcher = new_matcher(:name) { }
-      expect(matcher).not_to be_diffable
-    end
-
-    it "is diffable when told to be" do
-      matcher = new_matcher(:name) { diffable }
-      expect(matcher).to be_diffable
-    end
-
-    it 'does not confuse the diffability of different matchers' do
-      # Necessary to guard against a regression that involved
-      # using a class variable to store the diffable state,
-      # which had the side effect of causing all custom matchers
-      # to share that state
-      m1 = new_matcher(:m1) { diffable }
-      m2 = new_matcher(:m2) { }
-      m3 = new_matcher(:m3) { diffable }
-
-      expect(m1).to be_diffable
-      expect(m2).not_to be_diffable
-      expect(m3).to be_diffable
-    end
-
-    it "provides expected" do
-      matcher = new_matcher(:name, "expected string") { }
-      expect(matcher.expected).to eq ['expected string']
-    end
-
-    it "provides actual when `match` is used" do
-      matcher = new_matcher(:name, 'expected string') do
-        match {|actual|}
-      end
-
-      matcher.matches?('actual string')
-
-      expect(matcher.actual).to eq 'actual string'
-    end
-
-    it "provides actual when the `match` block accepts splat args" do
-      matcher = new_matcher(:actual) do
-        match { |*actual| actual == [5] }
-      end
-
-      expect(matcher.matches?(5)).to be true
-      expect(matcher.matches?(4)).to be false
-    end
-
-    it 'allows an early `return` to be used from a `match` block' do
-      matcher = new_matcher(:with_return, 5) do |expected|
-        match { |actual| return true if expected == actual }
-      end
-
-      expect(matcher.matches?(5)).to be true
-      expect(matcher.matches?(4)).to be_falsey
-    end
-
-    it 'provides actual when `match_unless_raises` is used' do
-      matcher = new_matcher(:name, 'expected string') do
-        match_unless_raises(SyntaxError) {|actual|}
-      end
-
-      matcher.matches?('actual string')
-
-      expect(matcher.actual).to eq 'actual string'
-    end
-
-    it 'allows an early `return` to be used from a `match_unless_raises` block' do
-      matcher = new_matcher(:with_return) do |expected|
-        match_unless_raises(ArgumentError) do |actual|
-          return actual if [true, false].include?(actual)
-          raise ArgumentError
-        end
-      end
-
-      expect(matcher.matches?(true)).to be true
-      # It should match even if it returns false, because no error was raised.
-      expect(matcher.matches?(false)).to be true
-      expect(matcher.matches?(4)).to be_falsey
-    end
-
-    it 'provides actual when `match_for_should_not` is used' do
-      matcher = new_matcher(:name, 'expected string') do
-        match_for_should_not {|actual|}
-      end
-
-      matcher.does_not_match?('actual string')
-
-      expect(matcher.actual).to eq 'actual string'
-    end
-
-    it 'allows an early `return` to be used from a `match_for_should_not` block' do
-      matcher = new_matcher(:with_return, 5) do |expected|
-        match_for_should_not { |actual| return true if expected != actual }
-      end
-
-      expect(matcher.does_not_match?(5)).to be_falsey
-      expect(matcher.does_not_match?(4)).to be true
-    end
-
-    context "wrapping another expectation (expect(...).to eq ...)" do
-      let(:matcher) do
-        new_matcher(:name, "value") do |expected|
-          match do |actual|
-            expect(actual).to eq expected
-          end
-        end
-      end
-
-      it "returns true if the wrapped expectation passes" do
-        expect(matcher.matches?('value')).to be_truthy
-      end
-
-      it "returns false if the wrapped expectation fails" do
-        expect(matcher.matches?('other value')).to be_falsey
-      end
-
-      it "can use the `include` matcher from a `match` block" do
-        RSpec::Matchers.define(:descend_from) do |mod|
-          match do |klass|
-            expect(klass.ancestors).to include(mod)
-          end
-        end
-
-        expect(Fixnum).to descend_from(Object)
-        expect(Fixnum).not_to descend_from(Array)
-
-        expect {
-          expect(Fixnum).to descend_from(Array)
-        }.to fail_with(/expected Fixnum to descend from Array/)
-
-        expect {
-          expect(Fixnum).not_to descend_from(Object)
-        }.to fail_with(/expected Fixnum not to descend from Object/)
-      end
-
-      it "can use the `match` matcher from a `match` block" do
-        RSpec::Matchers.define(:be_a_phone_number_string) do
-          match do |string|
-            expect(string).to match(/\A\d{3}\-\d{3}\-\d{4}\z/)
-          end
-        end
-
-        expect("206-123-1234").to be_a_phone_number_string
-        expect("foo").not_to be_a_phone_number_string
-
-        expect {
-          expect("foo").to be_a_phone_number_string
-        }.to fail_with(/expected "foo" to be a phone number string/)
-
-        expect {
-          expect("206-123-1234").not_to be_a_phone_number_string
-        }.to fail_with(/expected "206-123-1234" not to be a phone number string/)
-      end
-    end
-
-    context "with overrides" do
-      let(:matcher) do
-        new_matcher(:be_boolean, true) do |boolean|
-          match do |actual|
-            actual
-          end
-          description do |actual|
-            "be the boolean #{boolean} (actual was #{actual})"
-          end
-          failure_message_for_should do |actual|
-            "expected #{actual} to be the boolean #{boolean}"
-          end
-          failure_message_for_should_not do |actual|
-            "expected #{actual} not to be the boolean #{boolean}"
-          end
-        end
-      end
-
-      it "does not hide result of match block when true" do
-        expect(matcher.matches?(true)).to be_truthy
-      end
-
-      it "does not hide result of match block when false" do
-        expect(matcher.matches?(false)).to be_falsey
-      end
-
-      it "overrides the description (which yields `actual`)" do
-        matcher.matches?(true)
-        expect(matcher.description).to eq "be the boolean true (actual was true)"
-      end
-
-      it "overrides the failure message for #should" do
-        matcher.matches?(false)
-        expect(matcher.failure_message_for_should).to eq "expected false to be the boolean true"
-      end
-
-      it "overrides the failure message for #should_not" do
-        matcher.matches?(true)
-        expect(matcher.failure_message_for_should_not).to eq "expected true not to be the boolean true"
-      end
-
-      it 'can access helper methods from `description`' do
-        matcher = new_matcher(:desc) do
-          def subdesc() "sub description" end
-          description { "Desc (#{subdesc})" }
-        end
-
-        expect(matcher.description).to eq("Desc (sub description)")
-      end
-
-      it 'can access helper methods from `failure_message_for_should`' do
-        matcher = new_matcher(:positive_failure_message) do
-          def helper() "helper" end
-          failure_message_for_should { helper }
-        end
-
-        expect(matcher.failure_message_for_should).to eq("helper")
-      end
-
-      it 'can access helper methods from `failure_message_for_should_not`' do
-        matcher = new_matcher(:negative_failure_message) do
-          def helper() "helper" end
-          failure_message_for_should_not { helper }
-        end
-
-        expect(matcher.failure_message_for_should_not).to eq("helper")
-      end
-
-      it 'can exit early with a `return` from `description` just like in a method' do
-        matcher = new_matcher(:desc) do
-          description { return "Desc" }
-        end
-
-        expect(matcher.description).to eq("Desc")
-      end
-
-      it 'can exit early with a `return` from `failure_message_for_should` just like in a method' do
-        matcher = new_matcher(:positive_failure_message) do
-          failure_message_for_should { return "msg" }
-        end
-
-        expect(matcher.failure_message_for_should).to eq("msg")
-      end
-
-      it 'can exit early with a `return` from `failure_message_for_should_not` just like in a method' do
-        matcher = new_matcher(:negative_failure_message) do
-          failure_message_for_should_not { return "msg" }
-        end
-
-        expect(matcher.failure_message_for_should_not).to eq("msg")
-      end
-    end
-
-    context "#new" do
-      it "passes matches? arg to match block" do
-        matcher = new_matcher(:ignore) do
-          match do |actual|
-            actual == 5
-          end
-        end
-        expect(matcher.matches?(5)).to be_truthy
-      end
-
-      it "exposes arg submitted through #new to matcher block" do
-        matcher = new_matcher(:ignore, 4) do |expected|
-          match do |actual|
-            actual > expected
-          end
-        end
-        expect(matcher.matches?(5)).to be_truthy
-      end
-    end
-
-    context "with no args" do
-      let(:matcher) do
-        new_matcher(:matcher_name) do
-          match do |actual|
-            actual == 5
-          end
-        end
-      end
-
-      it "matches" do
-        expect(matcher.matches?(5)).to be_truthy
-      end
-
-      it "describes" do
-        expect(matcher.description).to eq "matcher name"
-      end
-    end
-
-    context "with 1 arg" do
-      let(:matcher) do
-        new_matcher(:matcher_name, 1) do |expected|
-          match do |actual|
-            actual == 5 && expected == 1
-          end
-        end
-      end
-
-      it "matches" do
-        expect(matcher.matches?(5)).to be_truthy
-      end
-
-      it "describes" do
-        expect(matcher.description).to eq "matcher name 1"
-      end
-    end
-
-    context "with multiple args" do
-      let(:matcher) do
-        new_matcher(:matcher_name, 1, 2, 3, 4) do |a, b, c, d|
-          match do |sum|
-            a + b + c + d == sum
-          end
-        end
-      end
-
-      it "matches" do
-        expect(matcher.matches?(10)).to be_truthy
-      end
-
-      it "describes" do
-        expect(matcher.description).to eq "matcher name 1, 2, 3, and 4"
-      end
-    end
-
-    it "supports helper methods" do
-      matcher = new_matcher(:be_similar_to, [1, 2, 3]) do |sample|
-        match do |actual|
-          similar?(sample, actual)
-        end
-
-        def similar?(a, b)
-          a.sort == b.sort
-        end
-      end
-
-      expect(matcher.matches?([2,3,1])).to be_truthy
-    end
-
-    it "supports fluent interface" do
-      matcher = new_matcher(:first_word) do
-        def second_word
-          self
-        end
-      end
-
-      expect(matcher.second_word).to eq matcher
-    end
-
-    it "treats method missing normally for undeclared methods" do
-      matcher = new_matcher(:ignore) { }
-      expect { matcher.non_existent_method }.to raise_error(NoMethodError)
-    end
-
-    it "has access to other matchers" do
-      matcher = new_matcher(:ignore, 3) do |expected|
-        match do |actual|
-          extend RSpec::Matchers
-          expect(actual).to eql(5 + expected)
-        end
-      end
-
-      expect(matcher.matches?(8)).to be_truthy
-    end
-
-    context 'when multiple instances of the same matcher are used in the same example' do
-      RSpec::Matchers.define(:be_like_a) do |expected|
-        match { |actual| actual == expected }
-        description { "be like a #{expected}" }
-        failure_message_for_should { "expected to be like a #{expected}" }
-        failure_message_for_should_not { "expected not to be like a #{expected}" }
-      end
-
-      # Note: these bugs were only exposed when creating both instances
-      # first, then checking their descriptions/failure messages.
-      #
-      # That's why we eager-instantiate them here.
-      let!(:moose) { be_like_a("moose") }
-      let!(:horse) { be_like_a("horse") }
-
-      it 'allows them to use the expected value in the description' do
-        expect(horse.description).to eq("be like a horse")
-        expect(moose.description).to eq("be like a moose")
-      end
-
-      it 'allows them to use the expected value in the positive failure message' do
-        expect(moose.failure_message_for_should).to eq("expected to be like a moose")
-        expect(horse.failure_message_for_should).to eq("expected to be like a horse")
-      end
-
-      it 'allows them to use the expected value in the negative failure message' do
-        expect(moose.failure_message_for_should_not).to eq("expected not to be like a moose")
-        expect(horse.failure_message_for_should_not).to eq("expected not to be like a horse")
-      end
-
-      it 'allows them to match separately' do
-        expect("moose").to moose
-        expect("horse").to horse
-        expect("horse").not_to moose
-        expect("moose").not_to horse
-      end
-    end
-
-    describe "#match_unless_raises" do
-      context "with an assertion" do
-        mod = Module.new do
-          def assert_equal(a,b)
-            raise UnexpectedError.new("#{b} does not equal #{a}") unless a == b
-          end
-        end
-
-        let(:matcher) do
-          new_matcher(:equal, 4) do |expected|
-            include mod
-            match_unless_raises UnexpectedError do
-              assert_equal expected, actual
-            end
-          end
-        end
-
-        context "with passing assertion" do
-          it "passes" do
-            expect(matcher.matches?(4)).to be_truthy
-          end
-        end
-
-        context "with failing assertion" do
-          it "fails" do
-            expect(matcher.matches?(5)).to be_falsey
-          end
-
-          it "provides the raised exception" do
-            matcher.matches?(5)
-            expect(matcher.rescued_exception.message).to eq("5 does not equal 4")
-          end
-        end
-      end
-
-      context "with an unexpected error" do
-        let(:matcher) do
-          new_matcher(:foo, :bar) do |expected|
-            match_unless_raises SyntaxError do |actual|
-              raise "unexpected exception"
-            end
-          end
-        end
-
-        it "raises the error" do
-          expect {
-            matcher.matches?(:bar)
-          }.to raise_error("unexpected exception")
-        end
-      end
-
-      context "without a specified error class" do
-        let(:matcher) do
-          new_matcher(:foo) do
-            match_unless_raises do |actual|
-              raise Exception unless actual == 5
-            end
-          end
-        end
-
-        it 'passes if no error is raised' do
-          expect(matcher.matches?(5)).to be true
-        end
-
-        it 'fails if an exception is raised' do
-          expect(matcher.matches?(4)).to be false
-        end
-      end
-
-    end
-
-    it "can define chainable methods" do
-      matcher = new_matcher(:name) do
-        chain(:expecting) do |expected_value|
-          @expected_value = expected_value
-        end
-        match { |actual| actual == @expected_value }
-      end
-
-      expect(matcher.expecting('value').matches?('value')).to be_truthy
-      expect(matcher.expecting('value').matches?('other value')).to be_falsey
-    end
-
-    it 'can use an early return from a `chain` block' do
-      matcher = new_matcher(:name) do
-        chain(:expecting) do |expected_value|
-          @expected_value = expected_value
-          return
-        end
-        match { |actual| actual == @expected_value }
-      end
-
-      expect(matcher.expecting('value').matches?('value')).to be_truthy
-      expect(matcher.expecting('value').matches?('other value')).to be_falsey
-    end
-
-    it 'allows chainable methods to accept blocks' do
-      matcher = new_matcher(:name) do
-        chain(:for_block) { |&b| @block = b }
-        match { |value| @block.call == value }
-      end
-
-      expect(matcher.for_block { 5 }.matches?(5)).to be true
-      expect(matcher.for_block { 3 }.matches?(4)).to be false
-    end
-
-    it "prevents name collisions on chainable methods from different matchers" do
-      m1 = new_matcher(:m1) { chain(:foo) { raise "foo in m1" } }
-      m2 = new_matcher(:m2) { chain(:foo) { raise "foo in m2" } }
-
-      expect { m1.foo }.to raise_error("foo in m1")
-      expect { m2.foo }.to raise_error("foo in m2")
-    end
-
-    context "defined using the dsl" do
-      def a_method_in_the_example
-        "method defined in the example"
-      end
-
-      it "can access methods in the running example" do |example|
-        RSpec::Matchers.define(:__access_running_example) do
-          match do |actual|
-            a_method_in_the_example == "method defined in the example"
-          end
-        end
-        expect(example).to __access_running_example
-      end
-
-      it 'can get a method object for methods in the running example', :if => (RUBY_VERSION.to_f > 1.8) do
-        matcher = new_matcher(:get_method_object) { }
-        method  = matcher.method(:a_method_in_the_example)
-        expect(method.call).to eq("method defined in the example")
-      end
-
-      it 'indicates that it responds to a method from the running example' do
-        matcher = new_matcher(:respond_to) { }
-        expect(matcher).to respond_to(:a_method_in_the_example)
-        expect(matcher).not_to respond_to(:a_method_not_in_the_example)
-      end
-
-      it "raises NoMethodError for methods not in the running_example" do |example|
-        RSpec::Matchers.define(:__raise_no_method_error) do
-          match do |actual|
-            self.a_method_not_in_the_example == "method defined in the example"
-          end
-        end
-
-        expect {
-          expect(example).to __raise_no_method_error
-        }.to raise_error(NoMethodError, /Spec::Matchers::DSL::Matcher __raise_no_method_error/)
-      end
-    end
-
-  end
-end