Class: RSpec::Matchers::BuiltIn::Include Private

Inherits:
BaseMatcher show all
Defined in:
lib/rspec/matchers/built_in/include.rb

Overview

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

Provides the implementation for include. Not intended to be instantiated directly.

Constant Summary

Constant Summary

Constants inherited from BaseMatcher

BaseMatcher::UNDEFINED

Instance Method Summary (collapse)

Methods inherited from BaseMatcher

#expects_call_stack_jump?, #match_unless_raises, #supports_block_expectations?

Methods included from Composable

#===, #and, #description_of, enumerable?, #or, surface_descriptions_in, #values_match?

Methods included from Pretty

#name, split_words, #to_sentence, #to_word

Constructor Details

- (Include) initialize(*expected)

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.

Returns a new instance of Include



8
9
10
# File 'lib/rspec/matchers/built_in/include.rb', line 8

def initialize(*expected)
  @expected = expected
end

Instance Method Details

- (String) description

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.

Returns:

  • (String)


28
29
30
31
# File 'lib/rspec/matchers/built_in/include.rb', line 28

def description
  described_items = surface_descriptions_in(expected)
  improve_hash_formatting "include#{to_sentence(described_items)}"
end

- (Boolean) diffable?

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.

Returns:

  • (Boolean)


47
48
49
# File 'lib/rspec/matchers/built_in/include.rb', line 47

def diffable?
  true
end

- (Boolean) does_not_match?(actual)

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.

Returns:

  • (Boolean)


21
22
23
24
# File 'lib/rspec/matchers/built_in/include.rb', line 21

def does_not_match?(actual)
  @actual = actual
  perform_match(:none?, :any?)
end

- (String) failure_message

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.

Returns:

  • (String)


35
36
37
# File 'lib/rspec/matchers/built_in/include.rb', line 35

def failure_message
  improve_hash_formatting(super) + invalid_type_message
end

- (String) failure_message_when_negated

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.

Returns:

  • (String)


41
42
43
# File 'lib/rspec/matchers/built_in/include.rb', line 41

def failure_message_when_negated
  improve_hash_formatting(super) + invalid_type_message
end

- (Boolean) matches?(actual)

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.

Returns:

  • (Boolean)


14
15
16
17
# File 'lib/rspec/matchers/built_in/include.rb', line 14

def matches?(actual)
  @actual = actual
  perform_match(:all?, :all?)
end