Class: RSpec::Matchers::BuiltIn::BaseMatcher Private

Inherits:

Object

• Object
• RSpec::Matchers::BuiltIn::BaseMatcher

show all

Includes:

MatchAliases, Pretty

Defined in:

lib/rspec/matchers/built_in/base_matcher.rb

Overview

Constant Summary

UNDEFINED =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Object.new.freeze

Instance Attribute Summary (collapse)

• - (Object) actual readonly private
• - (Object) expected readonly private
• - (Object) rescued_exception readonly private

Instance Method Summary (collapse)

• - (Object) description private
• - (Boolean) diffable? private
• - (Object) failure_message_for_should private
• - (Object) failure_message_for_should_not private
• - (BaseMatcher) initialize(expected = UNDEFINED) constructor private

  A new instance of BaseMatcher.

• - (Object) match_unless_raises(*exceptions) private
• - (Boolean) matches?(actual) private
• - (Boolean) supports_block_expectations? private

  Most matchers are value matchers (i.e. meant to work with expect(value)) rather than block matchers (i.e. meant to work with expect { }), so this defaults to false.

Methods included from MatchAliases

#==, #===

Methods included from Pretty

#_pretty_print, #expected_to_sentence, #name, #name_to_sentence, #split_words, #to_sentence, #to_word, #underscore

22
23
24

# File 'lib/rspec/matchers/built_in/base_matcher.rb', line 22
def initialize(expected = UNDEFINED)
  @expected = expected unless UNDEFINED.equal?(expected)
end

20
21
22

# File 'lib/rspec/matchers/built_in/base_matcher.rb', line 20
def actual
  @actual
end

20
21
22

# File 'lib/rspec/matchers/built_in/base_matcher.rb', line 20
def expected
  @expected
end

20
21
22

# File 'lib/rspec/matchers/built_in/base_matcher.rb', line 20
def rescued_exception
  @rescued_exception
end

51
52
53

# File 'lib/rspec/matchers/built_in/base_matcher.rb', line 51
def description
  defined?(@expected) ? "#{name_to_sentence} #{@expected.inspect}" : name_to_sentence
end

55
56
57

# File 'lib/rspec/matchers/built_in/base_matcher.rb', line 55
def diffable?
  false
end

41
42
43
44

# File 'lib/rspec/matchers/built_in/base_matcher.rb', line 41
def failure_message_for_should
  assert_ivars :@actual
  "expected #{@actual.inspect} to #{name_to_sentence}#{to_sentence expected}"
end

46
47
48
49

# File 'lib/rspec/matchers/built_in/base_matcher.rb', line 46
def failure_message_for_should_not
  assert_ivars :@actual
  "expected #{@actual.inspect} not to #{name_to_sentence}#{to_sentence expected}"
end

31
32
33
34
35
36
37
38
39

# File 'lib/rspec/matchers/built_in/base_matcher.rb', line 31
def match_unless_raises(*exceptions)
  exceptions.unshift Exception if exceptions.empty?
  begin
    yield
    true
  rescue *exceptions => @rescued_exception
    false
  end
end

26
27
28
29

# File 'lib/rspec/matchers/built_in/base_matcher.rb', line 26
def matches?(actual)
  @actual = actual
  match(expected, actual)
end

63
64
65

# File 'lib/rspec/matchers/built_in/base_matcher.rb', line 63
def supports_block_expectations?
  false
end