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

# File 'rspec-expectations/lib/rspec/matchers/built_in/include.rb', line 198

def diff_would_wrongly_highlight_matched_item?
  return false unless actual.is_a?(String) && expected.is_a?(Array)

  lines = actual.split("\n")
  expected.any? do |str|
    actual.include?(str) && lines.none? { |line| line == str }
  end
end

# File 'rspec-expectations/lib/rspec/matchers/built_in/include.rb', line 61

def diffable?
  !diff_would_wrongly_highlight_matched_item?
end

# File 'rspec-expectations/lib/rspec/matchers/built_in/include.rb', line 12

attr_reader :expecteds

# File 'rspec-expectations/lib/rspec/matchers/built_in/include.rb', line 153

def actual_hash_has_key?(expected_key)
  # We check `key?` first for perf:
  # `key?` is O(1), but `any?` is O(N).

  has_exact_key =
    begin
      actual.key?(expected_key)
    rescue
      false
    end

  has_exact_key || actual.keys.any? { |key| values_match?(expected_key, key) }
end

# File 'rspec-expectations/lib/rspec/matchers/built_in/include.rb', line 141

def actual_hash_includes?(expected_key, expected_value)
  actual_value =
    actual.fetch(expected_key) do
      actual.find(Proc.new { return false }) { |actual_key, _| values_match?(expected_key, actual_key) }[1]
    end
  values_match?(expected_value, actual_value)
end

# File 'rspec-expectations/lib/rspec/matchers/built_in/include.rb', line 77

def check_actual?(actual)
  actual = actual.to_hash if convert_to_hash?(actual)
  @actual = actual
  @actual.respond_to?(:include?)
end

# File 'rspec-expectations/lib/rspec/matchers/built_in/include.rb', line 149

def comparing_hash_keys?(expected_item)
  actual.is_a?(Hash) && !expected_item.is_a?(Hash)
end

# File 'rspec-expectations/lib/rspec/matchers/built_in/include.rb', line 137

def comparing_hash_to_a_subset?(expected_item)
  actual.is_a?(Hash) && expected_item.is_a?(Hash)
end

# File 'rspec-expectations/lib/rspec/matchers/built_in/include.rb', line 207

def convert_to_hash?(obj)
  !obj.respond_to?(:include?) && obj.respond_to?(:to_hash)
end

# File 'rspec-expectations/lib/rspec/matchers/built_in/include.rb', line 181

def count_enumerable(expected_item)
  actual.select { |value| values_match?(expected_item, value) }.size
end

# File 'rspec-expectations/lib/rspec/matchers/built_in/include.rb', line 186

def count_inclusions
  @divergent_items = expected
  case actual
  when String
    actual.scan(expected.first).length
  when Enumerable
    count_enumerable(Hash === expected ? expected : expected.first)
  else
    raise NotImplementedError, 'Count constraints are implemented for Enumerable and String values only'
  end
end

# File 'rspec-expectations/lib/rspec/matchers/built_in/include.rb', line 43

def description
  improve_hash_formatting("include#{readable_list_of(expecteds)}#{count_expectation_description}")
end

# File 'rspec-expectations/lib/rspec/matchers/built_in/include.rb', line 32

def does_not_match?(actual)
  check_actual?(actual) &&
    if check_expected_count?
      !expected_count_matches?(count_inclusions)
    else
      perform_match { |v| !v }
    end
end

# File 'rspec-expectations/lib/rspec/matchers/built_in/include.rb', line 120

def excluded_from_actual
  return [] unless @actual.respond_to?(:include?)

  expecteds.inject([]) do |memo, expected_item|
    if comparing_hash_to_a_subset?(expected_item)
      expected_item.each do |(key, value)|
        memo << { key => value } unless yield actual_hash_includes?(key, value)
      end
    elsif comparing_hash_keys?(expected_item)
      memo << expected_item unless yield actual_hash_has_key?(expected_item)
    else
      memo << expected_item unless yield actual_collection_includes?(expected_item)
    end
    memo
  end
end

# File 'rspec-expectations/lib/rspec/matchers/built_in/include.rb', line 67

def expected
  if expecteds.one? && Hash === expecteds.first
    expecteds.first
  else
    expecteds
  end
end

# File 'rspec-expectations/lib/rspec/matchers/built_in/include.rb', line 49

def failure_message
  format_failure_message("to") { super }
end

# File 'rspec-expectations/lib/rspec/matchers/built_in/include.rb', line 55

def failure_message_when_negated
  format_failure_message("not to") { super }
end

# File 'rspec-expectations/lib/rspec/matchers/built_in/include.rb', line 95

def format_failure_message(preposition)
  msg = if actual.respond_to?(:include?)
          "expected #{description_of @actual} #{preposition}" \
          " include#{readable_list_of @divergent_items}" \
          "#{count_failure_reason('it is included') if has_expected_count?}"
        else
          "#{yield}, but it does not respond to `include?`"
        end
  improve_hash_formatting(msg)
end

# File 'rspec-expectations/lib/rspec/matchers/built_in/include.rb', line 21

def matches?(actual)
  check_actual?(actual) &&
    if check_expected_count?
      expected_count_matches?(count_inclusions)
    else
      perform_match { |v| v }
    end
end

# File 'rspec-expectations/lib/rspec/matchers/built_in/include.rb', line 115

def perform_match(&block)
  @divergent_items = excluded_from_actual(&block)
  @divergent_items.empty?
end

# File 'rspec-expectations/lib/rspec/matchers/built_in/include.rb', line 106

def readable_list_of(items)
  described_items = surface_descriptions_in(items)
  if described_items.all? { |item| item.is_a?(Hash) }
    " #{described_items.inject(:merge).inspect}"
  else
    EnglishPhrasing.list(described_items)
  end
end