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, #or, should_enumerate?, surface_descriptions_in, unreadable_io?, #values_match?

Constructor Details

- (Include) initialize(*expecteds)

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

[View source]
11
12
13
 
# File 'lib/rspec/matchers/built_in/include.rb', line 11
def initialize(*expecteds)
  @expecteds = expecteds
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)
[View source]
29
30
31
 
# File 'lib/rspec/matchers/built_in/include.rb', line 29
def description
  improve_hash_formatting("include#{readable_list_of(expecteds)}")
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)
[View source]
47
48
49
 
# File 'lib/rspec/matchers/built_in/include.rb', line 47
def diffable?
  !diff_would_wrongly_highlight_matched_item?
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)
[View source]
23
24
25
 
# File 'lib/rspec/matchers/built_in/include.rb', line 23
def does_not_match?(actual)
  perform_match(actual) { |v| !v }
end

- (Array, Hash) 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:

  • (Array, Hash)
[View source]
53
54
55
56
57
58
59
 
# File 'lib/rspec/matchers/built_in/include.rb', line 53
def expected
  if expecteds.one? && Hash === expecteds.first
    expecteds.first
  else
    expecteds
  end
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)
[View source]
35
36
37
 
# File 'lib/rspec/matchers/built_in/include.rb', line 35
def failure_message
  format_failure_message("to") { super }
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)
[View source]
41
42
43
 
# File 'lib/rspec/matchers/built_in/include.rb', line 41
def failure_message_when_negated
  format_failure_message("not to") { super }
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)
[View source]
17
18
19
 
# File 'lib/rspec/matchers/built_in/include.rb', line 17
def matches?(actual)
  perform_match(actual) { |v| v }
end