Module: RSpec::Matchers::DSL::DefaultImplementations

Includes:
BuiltIn::BaseMatcher::DefaultFailureMessages
Included in:
Matcher
Defined in:
lib/rspec/matchers/dsl.rb

Overview

Defines default implementations of the matcher protocol methods for custom matchers. You can override any of these using the Macros methods from within an RSpec::Matchers.define block.

Instance Method Summary collapse

Methods included from BuiltIn::BaseMatcher::DefaultFailureMessages

#failure_message, #failure_message_when_negated

Instance Method Details

#descriptionObject

The default description.



309
310
311
312
313
# File 'lib/rspec/matchers/dsl.rb', line 309

def description
  english_name = EnglishPhrasing.split_words(name)
  expected_list = EnglishPhrasing.list(expected)
  "#{english_name}#{expected_list}#{chained_method_clause_sentences}"
end

#diffable?Boolean

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

Used internally by objects returns by should and should_not.

Returns:

  • (Boolean)


304
305
306
# File 'lib/rspec/matchers/dsl.rb', line 304

def diffable?
  false
end

#expects_call_stack_jump?Boolean

Most matchers do not expect call stack jumps.

Returns:

  • (Boolean)


322
323
324
# File 'lib/rspec/matchers/dsl.rb', line 322

def expects_call_stack_jump?
  false
end

#supports_block_expectations?Boolean

Matchers do not support block expectations by default. You must opt-in.

Returns:

  • (Boolean)


317
318
319
# File 'lib/rspec/matchers/dsl.rb', line 317

def supports_block_expectations?
  false
end