class RSpec::Matchers::BuiltIn::Include
@api private Provides the implementation for `include`. Not intended to be instantiated directly.
Public Class Methods
new(*expected)
click to toggle source
# File lib/rspec/matchers/built_in/include.rb, line 8 def initialize(*expected) @expected = expected end
Public Instance Methods
description()
click to toggle source
@api private @return [String]
# 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
diffable?()
click to toggle source
@api private @return [Boolean]
# File lib/rspec/matchers/built_in/include.rb, line 47 def diffable? true end
does_not_match?(actual)
click to toggle source
@api private @return [Boolean]
# File lib/rspec/matchers/built_in/include.rb, line 21 def does_not_match?(actual) @actual = actual perform_match(:none?, :any?) end
failure_message()
click to toggle source
@api private @return [String]
Calls superclass method
RSpec::Matchers::BuiltIn::BaseMatcher::DefaultFailureMessages#failure_message
# File lib/rspec/matchers/built_in/include.rb, line 35 def failure_message improve_hash_formatting(super) + invalid_object_message end
failure_message_when_negated()
click to toggle source
@api private @return [String]
Calls superclass method
RSpec::Matchers::BuiltIn::BaseMatcher::DefaultFailureMessages#failure_message_when_negated
# File lib/rspec/matchers/built_in/include.rb, line 41 def failure_message_when_negated improve_hash_formatting(super) + invalid_object_message end
matches?(actual)
click to toggle source
@api private @return [Boolean]
# File lib/rspec/matchers/built_in/include.rb, line 14 def matches?(actual) @actual = actual perform_match(:all?, :all?) end
Private Instance Methods
actual_collection_includes?(expected_item)
click to toggle source
# File lib/rspec/matchers/built_in/include.rb, line 94 def actual_collection_includes?(expected_item) return true if actual.include?(expected_item) # String lacks an `any?` method... return false unless actual.respond_to?(:any?) actual.any? { |value| values_match?(expected_item, value) } end
actual_hash_has_key?(expected_key)
click to toggle source
# File lib/rspec/matchers/built_in/include.rb, line 87 def actual_hash_has_key?(expected_key) # We check `key?` first for perf: # `key?` is O(1), but `any?` is O(N). actual.key?(expected_key) || actual.keys.any? { |key| values_match?(expected_key, key) } end
actual_hash_includes?(expected_key, expected_value)
click to toggle source
# File lib/rspec/matchers/built_in/include.rb, line 78 def actual_hash_includes?(expected_key, expected_value) actual_value = actual.fetch(expected_key) { return false } values_match?(expected_value, actual_value) end
comparing_hash_keys?(expected_item)
click to toggle source
# File lib/rspec/matchers/built_in/include.rb, line 83 def comparing_hash_keys?(expected_item) actual.is_a?(Hash) && !expected_item.is_a?(Hash) end
comparing_hash_to_a_subset?(expected_item)
click to toggle source
# File lib/rspec/matchers/built_in/include.rb, line 74 def comparing_hash_to_a_subset?(expected_item) actual.is_a?(Hash) && expected_item.is_a?(Hash) end
invalid_object_message()
click to toggle source
# File lib/rspec/matchers/built_in/include.rb, line 53 def invalid_object_message return '' if actual.respond_to?(:include?) ", but it does not respond to `include?`" end
perform_match(predicate, hash_subset_predicate)
click to toggle source
# File lib/rspec/matchers/built_in/include.rb, line 58 def perform_match(predicate, hash_subset_predicate) return false unless actual.respond_to?(:include?) expected.__send__(predicate) do |expected_item| if comparing_hash_to_a_subset?(expected_item) expected_item.__send__(hash_subset_predicate) do |(key, value)| actual_hash_includes?(key, value) end elsif comparing_hash_keys?(expected_item) actual_hash_has_key?(expected_item) else actual_collection_includes?(expected_item) end end end