rspec-expectations 2.14.0 → 3.13.0

data/lib/rspec/matchers/built_in/have_attributes.rb

@@ -0,0 +1,114 @@
+module RSpec
+  module Matchers
+    module BuiltIn
+      # @api private
+      # Provides the implementation for `have_attributes`.
+      # Not intended to be instantiated directly.
+      class HaveAttributes < BaseMatcher
+        # @private
+        attr_reader :respond_to_failed
+
+        def initialize(expected)
+          @expected = expected
+          @values = {}
+          @respond_to_failed = false
+          @negated = false
+        end
+
+        # @private
+        def actual
+          @values
+        end
+
+        # @api private
+        # @return [Boolean]
+        def matches?(actual)
+          @actual = actual
+          @negated = false
+          return false unless respond_to_attributes?
+          perform_match(:all?)
+        end
+
+        # @api private
+        # @return [Boolean]
+        def does_not_match?(actual)
+          @actual = actual
+          @negated = true
+          return false unless respond_to_attributes?
+          perform_match(:none?)
+        end
+
+        # @api private
+        # @return [String]
+        def description
+          described_items = surface_descriptions_in(expected)
+          improve_hash_formatting "have attributes #{RSpec::Support::ObjectFormatter.format(described_items)}"
+        end
+
+        # @api private
+        # @return [Boolean]
+        def diffable?
+          !@respond_to_failed && !@negated
+        end
+
+        # @api private
+        # @return [String]
+        def failure_message
+          respond_to_failure_message_or do
+            "expected #{actual_formatted} to #{description} but had attributes #{ formatted_values }"
+          end
+        end
+
+        # @api private
+        # @return [String]
+        def failure_message_when_negated
+          respond_to_failure_message_or { "expected #{actual_formatted} not to #{description}" }
+        end
+
+      private
+
+        def cache_all_values
+          @values = {}
+          expected.each do |attribute_key, _attribute_value|
+            actual_value = @actual.__send__(attribute_key)
+            @values[attribute_key] = actual_value
+          end
+        end
+
+        def perform_match(predicate)
+          cache_all_values
+          expected.__send__(predicate) do |attribute_key, attribute_value|
+            actual_has_attribute?(attribute_key, attribute_value)
+          end
+        end
+
+        def actual_has_attribute?(attribute_key, attribute_value)
+          values_match?(attribute_value, @values.fetch(attribute_key))
+        end
+
+        def respond_to_attributes?
+          matches = respond_to_matcher.matches?(@actual)
+          @respond_to_failed = !matches
+          matches
+        end
+
+        def respond_to_matcher
+          @respond_to_matcher ||= RespondTo.new(*expected.keys).with(0).arguments.tap { |m| m.ignoring_method_signature_failure! }
+        end
+
+        def respond_to_failure_message_or
+          if respond_to_failed
+            respond_to_matcher.failure_message
+          else
+            improve_hash_formatting(yield)
+          end
+        end
+
+        def formatted_values
+          values = RSpec::Support::ObjectFormatter.format(@values)
+          improve_hash_formatting(values)
+        end
+      end
+    end
+  end
+end

data/lib/rspec/matchers/built_in/include.rb

@@ -1,59 +1,211 @@
+require 'rspec/matchers/built_in/count_expectation'
+
 module RSpec
   module Matchers
     module BuiltIn
-      class Include < BaseMatcher
-        def initialize(*expected)
-          @expected = expected
+      # @api private
+      # Provides the implementation for `include`.
+      # Not intended to be instantiated directly.
+      class Include < BaseMatcher # rubocop:disable Metrics/ClassLength
+        include CountExpectation
+        # @private
+        attr_reader :expecteds
+
+        # @api private
+        def initialize(*expecteds)
+          @expecteds = expecteds
         end
 
+        # @api private
+        # @return [Boolean]
         def matches?(actual)
-          @actual = actual
-          perform_match(:all?, :all?, @actual, @expected)
+          check_actual?(actual) &&
+            if check_expected_count?
+              expected_count_matches?(count_inclusions)
+            else
+              perform_match { |v| v }
+            end
         end
 
+        # @api private
+        # @return [Boolean]
         def does_not_match?(actual)
-          @actual = actual
-          perform_match(:none?, :any?, @actual, @expected)
+          check_actual?(actual) &&
+            if check_expected_count?
+              !expected_count_matches?(count_inclusions)
+            else
+              perform_match { |v| !v }
+            end
         end
 
+        # @api private
+        # @return [String]
         def description
-          "include#{expected_to_sentence}"
+          improve_hash_formatting("include#{readable_list_of(expecteds)}#{count_expectation_description}")
+        end
+
+        # @api private
+        # @return [String]
+        def failure_message
+          format_failure_message("to") { super }
         end
 
+        # @api private
+        # @return [String]
+        def failure_message_when_negated
+          format_failure_message("not to") { super }
+        end
+
+        # @api private
+        # @return [Boolean]
         def diffable?
-          # Matchers do not diff well, since diff uses their inspect
-          # output, which includes their instance variables and such.
-          @expected.none? { |e| RSpec::Matchers.is_a_matcher?(e) }
-        end
-
-        private
-
-        def perform_match(predicate, hash_predicate, actuals, expecteds)
-          expecteds.__send__(predicate) do |expected|
-            if comparing_hash_values?(actuals, expected)
-              expected.__send__(hash_predicate) { |k,v|
-                actuals.has_key?(k) && actuals[k] == v
-              }
-            elsif comparing_hash_keys?(actuals, expected)
-              actuals.has_key?(expected)
-            elsif comparing_with_matcher?(actual, expected)
-              actual.any? { |value| expected.matches?(value) }
+          !diff_would_wrongly_highlight_matched_item?
+        end
+
+        # @api private
+        # @return [Array, Hash]
+        def expected
+          if expecteds.one? && Hash === expecteds.first
+            expecteds.first
+          else
+            expecteds
+          end
+        end
+
+      private
+
+        def check_actual?(actual)
+          actual = actual.to_hash if convert_to_hash?(actual)
+          @actual = actual
+          @actual.respond_to?(:include?)
+        end
+
+        def check_expected_count?
+          case
+          when !has_expected_count?
+            return false
+          when expecteds.size != 1
+            raise NotImplementedError, 'Count constraint supported only when testing for a single value being included'
+          when actual.is_a?(Hash)
+            raise NotImplementedError, 'Count constraint on hash keys not implemented'
+          end
+          true
+        end
+
+        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
+
+        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
+
+        def perform_match(&block)
+          @divergent_items = excluded_from_actual(&block)
+          @divergent_items.empty?
+        end
+
+        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
-              actuals.include?(expected)
+              memo << expected_item unless yield actual_collection_includes?(expected_item)
             end
+            memo
           end
         end
 
-        def comparing_hash_keys?(actual, expected)
-          actual.is_a?(Hash) && !expected.is_a?(Hash)
+        def comparing_hash_to_a_subset?(expected_item)
+          actual.is_a?(Hash) && expected_item.is_a?(Hash)
+        end
+
+        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
+
+        def comparing_hash_keys?(expected_item)
+          actual.is_a?(Hash) && !expected_item.is_a?(Hash)
+        end
+
+        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
 
-        def comparing_hash_values?(actual, expected)
-          actual.is_a?(Hash) && expected.is_a?(Hash)
+        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
+
+        if RUBY_VERSION < '1.9'
+          def count_enumerable(expected_item)
+            actual.select { |value| values_match?(expected_item, value) }.size
+          end
+        else
+          def count_enumerable(expected_item)
+            actual.count { |value| values_match?(expected_item, value) }
+          end
+        end
+
+        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
+
+        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
 
-        def comparing_with_matcher?(actual, expected)
-          actual.is_a?(Array) && RSpec::Matchers.is_a_matcher?(expected)
+        def convert_to_hash?(obj)
+          !obj.respond_to?(:include?) && obj.respond_to?(:to_hash)
         end
       end
     end

data/lib/rspec/matchers/built_in/match.rb

@@ -1,11 +1,105 @@
 module RSpec
   module Matchers
     module BuiltIn
+      # @api private
+      # Provides the implementation for `match`.
+      # Not intended to be instantiated directly.
       class Match < BaseMatcher
+        def initialize(expected)
+          super(expected)
+
+          @expected_captures = nil
+        end
+        # @api private
+        # @return [String]
+        def description
+          if @expected_captures && @expected.match(actual)
+            "match #{surface_descriptions_in(expected).inspect} with captures #{surface_descriptions_in(@expected_captures).inspect}"
+          else
+            "match #{surface_descriptions_in(expected).inspect}"
+          end
+        end
+
+        # @api private
+        # @return [Boolean]
+        def diffable?
+          true
+        end
+
+        # Used to specify the captures we match against
+        # @return [self]
+        def with_captures(*captures)
+          @expected_captures = captures
+          self
+        end
+
+      private
 
         def match(expected, actual)
-          actual.match expected
+          return match_captures(expected, actual) if @expected_captures
+          return true if values_match?(expected, actual)
+          return false unless can_safely_call_match?(expected, actual)
+          actual.match(expected)
+        end
+
+        def can_safely_call_match?(expected, actual)
+          return false unless actual.respond_to?(:match)
+
+          !(RSpec::Matchers.is_a_matcher?(expected) &&
+            (String === actual || Regexp === actual))
         end
+
+        def match_captures(expected, actual)
+          match = actual.match(expected)
+          if match
+            match = ReliableMatchData.new(match)
+            if match.names.empty?
+              values_match?(@expected_captures, match.captures)
+            else
+              expected_matcher = @expected_captures.last
+              values_match?(expected_matcher, Hash[match.names.zip(match.captures)]) ||
+                values_match?(expected_matcher, Hash[match.names.map(&:to_sym).zip(match.captures)]) ||
+                values_match?(@expected_captures, match.captures)
+            end
+          else
+            false
+          end
+        end
+      end
+
+      # @api private
+      # Used to wrap match data and make it reliable for 1.8.7
+      class ReliableMatchData
+        def initialize(match_data)
+          @match_data = match_data
+        end
+
+        if RUBY_VERSION == "1.8.7"
+          # @api private
+          # Returns match data names for named captures
+          # @return Array
+          def names
+            []
+          end
+        else
+          # @api private
+          # Returns match data names for named captures
+          # @return Array
+          def names
+            match_data.names
+          end
+        end
+
+        # @api private
+        # returns an array of captures from the match data
+        # @return Array
+        def captures
+          match_data.captures
+        end
+
+      protected
+
+        attr_reader :match_data
       end
     end
   end

data/lib/rspec/matchers/built_in/operators.rb

@@ -0,0 +1,128 @@
+require 'rspec/support'
+
+module RSpec
+  module Matchers
+    module BuiltIn
+      # @api private
+      # Provides the implementation for operator matchers.
+      # Not intended to be instantiated directly.
+      # Only available for use with `should`.
+      class OperatorMatcher
+        class << self
+          # @private
+          def registry
+            @registry ||= {}
+          end
+
+          # @private
+          def register(klass, operator, matcher)
+            registry[klass] ||= {}
+            registry[klass][operator] = matcher
+          end
+
+          # @private
+          def unregister(klass, operator)
+            registry[klass] && registry[klass].delete(operator)
+          end
+
+          # @private
+          def get(klass, operator)
+            klass.ancestors.each do |ancestor|
+              matcher = registry[ancestor] && registry[ancestor][operator]
+              return matcher if matcher
+            end
+
+            nil
+          end
+        end
+
+        register Enumerable, '=~', BuiltIn::ContainExactly
+
+        def initialize(actual)
+          @actual = actual
+        end
+
+        # @private
+        def self.use_custom_matcher_or_delegate(operator)
+          define_method(operator) do |expected|
+            if !has_non_generic_implementation_of?(operator) && (matcher = OperatorMatcher.get(@actual.class, operator))
+              @actual.__send__(::RSpec::Matchers.last_expectation_handler.should_method, matcher.new(expected))
+            else
+              eval_match(@actual, operator, expected)
+            end
+          end
+
+          negative_operator = operator.sub(/^=/, '!')
+          if negative_operator != operator && respond_to?(negative_operator)
+            define_method(negative_operator) do |_expected|
+              opposite_should = ::RSpec::Matchers.last_expectation_handler.opposite_should_method
+              raise "RSpec does not support `#{::RSpec::Matchers.last_expectation_handler.should_method} #{negative_operator} expected`.  " \
+                "Use `#{opposite_should} #{operator} expected` instead."
+            end
+          end
+        end
+
+        ['==', '===', '=~', '>', '>=', '<', '<='].each do |operator|
+          use_custom_matcher_or_delegate operator
+        end
+
+        # @private
+        def fail_with_message(message)
+          RSpec::Expectations.fail_with(message, @expected, @actual)
+        end
+
+        # @api private
+        # @return [String]
+        def description
+          "#{@operator} #{RSpec::Support::ObjectFormatter.format(@expected)}"
+        end
+
+      private
+
+        def has_non_generic_implementation_of?(op)
+          Support.method_handle_for(@actual, op).owner != ::Kernel
+        rescue NameError
+          false
+        end
+
+        def eval_match(actual, operator, expected)
+          ::RSpec::Matchers.last_matcher = self
+          @operator, @expected = operator, expected
+          __delegate_operator(actual, operator, expected)
+        end
+      end
+
+      # @private
+      # Handles operator matcher for `should`.
+      class PositiveOperatorMatcher < OperatorMatcher
+        def __delegate_operator(actual, operator, expected)
+          if actual.__send__(operator, expected)
+            true
+          else
+            expected_formatted = RSpec::Support::ObjectFormatter.format(expected)
+            actual_formatted   = RSpec::Support::ObjectFormatter.format(actual)
+
+            if ['==', '===', '=~'].include?(operator)
+              fail_with_message("expected: #{expected_formatted}\n     got: #{actual_formatted} (using #{operator})")
+            else
+              fail_with_message("expected: #{operator} #{expected_formatted}\n     got: #{operator.gsub(/./, ' ')} #{actual_formatted}")
+            end
+          end
+        end
+      end
+
+      # @private
+      # Handles operator matcher for `should_not`.
+      class NegativeOperatorMatcher < OperatorMatcher
+        def __delegate_operator(actual, operator, expected)
+          return false unless actual.__send__(operator, expected)
+
+          expected_formatted = RSpec::Support::ObjectFormatter.format(expected)
+          actual_formatted   = RSpec::Support::ObjectFormatter.format(actual)
+
+          fail_with_message("expected not: #{operator} #{expected_formatted}\n         got: #{operator.gsub(/./, ' ')} #{actual_formatted}")
+        end
+      end
+    end
+  end
+end