rspec-mocks-diag 3.8.1.1

data/lib/rspec/mocks/targets.rb

@@ -0,0 +1,124 @@
+module RSpec
+  module Mocks
+    # @private
+    module TargetDelegationClassMethods
+      def delegate_to(matcher_method)
+        define_method(:to) do |matcher, &block|
+          unless matcher_allowed?(matcher)
+            raise_unsupported_matcher(:to, matcher)
+          end
+          define_matcher(matcher, matcher_method, &block)
+        end
+      end
+
+      def delegate_not_to(matcher_method, options={})
+        method_name = options.fetch(:from)
+        define_method(method_name) do |matcher, &block|
+          case matcher
+          when Matchers::Receive, Matchers::HaveReceived
+            define_matcher(matcher, matcher_method, &block)
+          when Matchers::ReceiveMessages, Matchers::ReceiveMessageChain
+            raise_negation_unsupported(method_name, matcher)
+          else
+            raise_unsupported_matcher(method_name, matcher)
+          end
+        end
+      end
+
+      def disallow_negation(method_name)
+        define_method(method_name) do |matcher, *_args|
+          raise_negation_unsupported(method_name, matcher)
+        end
+      end
+    end
+
+    # @private
+    module TargetDelegationInstanceMethods
+      attr_reader :target
+
+    private
+
+      def matcher_allowed?(matcher)
+        Matchers::Matcher === matcher
+      end
+
+      def define_matcher(matcher, name, &block)
+        matcher.__send__(name, target, &block)
+      end
+
+      def raise_unsupported_matcher(method_name, matcher)
+        raise UnsupportedMatcherError,
+              "only the `receive`, `have_received` and `receive_messages` matchers are supported " \
+              "with `#{expression}(...).#{method_name}`, but you have provided: #{matcher}"
+      end
+
+      def raise_negation_unsupported(method_name, matcher)
+        raise NegationUnsupportedError,
+              "`#{expression}(...).#{method_name} #{matcher.name}` is not supported since it " \
+              "doesn't really make sense. What would it even mean?"
+      end
+    end
+
+    # @private
+    class TargetBase
+      def initialize(target)
+        @target = target
+      end
+
+      extend TargetDelegationClassMethods
+      include TargetDelegationInstanceMethods
+    end
+
+    # @private
+    module ExpectationTargetMethods
+      extend TargetDelegationClassMethods
+      include TargetDelegationInstanceMethods
+
+      delegate_to :setup_expectation
+      delegate_not_to :setup_negative_expectation, :from => :not_to
+      delegate_not_to :setup_negative_expectation, :from => :to_not
+
+      def expression
+        :expect
+      end
+    end
+
+    # @private
+    class ExpectationTarget < TargetBase
+      include ExpectationTargetMethods
+    end
+
+    # @private
+    class AllowanceTarget < TargetBase
+      def expression
+        :allow
+      end
+
+      delegate_to :setup_allowance
+      disallow_negation :not_to
+      disallow_negation :to_not
+    end
+
+    # @private
+    class AnyInstanceAllowanceTarget < TargetBase
+      def expression
+        :allow_any_instance_of
+      end
+
+      delegate_to :setup_any_instance_allowance
+      disallow_negation :not_to
+      disallow_negation :to_not
+    end
+
+    # @private
+    class AnyInstanceExpectationTarget < TargetBase
+      def expression
+        :expect_any_instance_of
+      end
+
+      delegate_to :setup_any_instance_expectation
+      delegate_not_to :setup_any_instance_negative_expectation, :from => :not_to
+      delegate_not_to :setup_any_instance_negative_expectation, :from => :to_not
+    end
+  end
+end

data/lib/rspec/mocks/test_double.rb

@@ -0,0 +1,171 @@
+module RSpec
+  module Mocks
+    # Implements the methods needed for a pure test double.  RSpec::Mocks::Double
+    # includes this module, and it is provided for cases where you want a
+    # pure test double without subclassing RSpec::Mocks::Double.
+    module TestDouble
+      # Creates a new test double with a `name` (that will be used in error
+      # messages only)
+      def initialize(name=nil, stubs={})
+        @__expired = false
+        if Hash === name && stubs.empty?
+          stubs = name
+          @name = nil
+        else
+          @name = name
+        end
+        assign_stubs(stubs)
+      end
+
+      # Tells the object to respond to all messages. If specific stub values
+      # are declared, they'll work as expected. If not, the receiver is
+      # returned.
+      def as_null_object
+        __mock_proxy.as_null_object
+      end
+
+      # Returns true if this object has received `as_null_object`
+      def null_object?
+        __mock_proxy.null_object?
+      end
+
+      # This allows for comparing the mock to other objects that proxy such as
+      # ActiveRecords belongs_to proxy objects. By making the other object run
+      # the comparison, we're sure the call gets delegated to the proxy
+      # target.
+      def ==(other)
+        other == __mock_proxy
+      end
+
+      # @private
+      def inspect
+        TestDoubleFormatter.format(self)
+      end
+
+      # @private
+      def to_s
+        inspect.tr('<', '[').tr('>', ']')
+      end
+
+      # @private
+      def respond_to?(message, incl_private=false)
+        __mock_proxy.null_object? ? true : super
+      end
+
+      # @private
+      def __build_mock_proxy_unless_expired(order_group)
+        __raise_expired_error || __build_mock_proxy(order_group)
+      end
+
+      # @private
+      def __disallow_further_usage!
+        @__expired = true
+      end
+
+      # Override for default freeze implementation to prevent freezing of test
+      # doubles.
+      def freeze
+        RSpec.warn_with("WARNING: you attempted to freeze a test double. This is explicitly a no-op as freezing doubles can lead to undesired behaviour when resetting tests.")
+        self
+      end
+
+    private
+
+      def method_missing(message, *args, &block)
+        proxy = __mock_proxy
+        proxy.record_message_received(message, *args, &block)
+
+        if proxy.null_object?
+          case message
+          when :to_int        then return 0
+          when :to_a, :to_ary then return nil
+          when :to_str        then return to_s
+          else return self
+          end
+        end
+
+        # Defined private and protected methods will still trigger `method_missing`
+        # when called publicly. We want ruby's method visibility error to get raised,
+        # so we simply delegate to `super` in that case.
+        # ...well, we would delegate to `super`, but there's a JRuby
+        # bug, so we raise our own visibility error instead:
+        # https://github.com/jruby/jruby/issues/1398
+        visibility = proxy.visibility_for(message)
+        if visibility == :private || visibility == :protected
+          ErrorGenerator.new(self).raise_non_public_error(
+            message, visibility
+          )
+        end
+
+        # Required wrapping doubles in an Array on Ruby 1.9.2
+        raise NoMethodError if [:to_a, :to_ary].include? message
+        proxy.raise_unexpected_message_error(message, args)
+      end
+
+      def assign_stubs(stubs)
+        stubs.each_pair do |message, response|
+          __mock_proxy.add_simple_stub(message, response)
+        end
+      end
+
+      def __mock_proxy
+        ::RSpec::Mocks.space.proxy_for(self)
+      end
+
+      def __build_mock_proxy(order_group)
+        TestDoubleProxy.new(self, order_group)
+      end
+
+      def __raise_expired_error
+        return false unless @__expired
+        ErrorGenerator.new(self).raise_expired_test_double_error
+      end
+
+      def initialize_copy(other)
+        as_null_object if other.null_object?
+        super
+      end
+    end
+
+    # A generic test double object. `double`, `instance_double` and friends
+    # return an instance of this.
+    class Double
+      include TestDouble
+    end
+
+    # @private
+    module TestDoubleFormatter
+      def self.format(dbl, unwrap=false)
+        format = "#{type_desc(dbl)}#{verified_module_desc(dbl)} #{name_desc(dbl)}"
+        return format if unwrap
+        "#<#{format}>"
+      end
+
+      class << self
+      private
+
+        def type_desc(dbl)
+          case dbl
+          when InstanceVerifyingDouble then "InstanceDouble"
+          when ClassVerifyingDouble    then "ClassDouble"
+          when ObjectVerifyingDouble   then "ObjectDouble"
+          else "Double"
+          end
+        end
+
+        # @private
+        IVAR_GET = Object.instance_method(:instance_variable_get)
+
+        def verified_module_desc(dbl)
+          return nil unless VerifyingDouble === dbl
+          "(#{IVAR_GET.bind(dbl).call(:@doubled_module).description})"
+        end
+
+        def name_desc(dbl)
+          return "(anonymous)" unless (name = IVAR_GET.bind(dbl).call(:@name))
+          name.inspect
+        end
+      end
+    end
+  end
+end

data/lib/rspec/mocks/verifying_double.rb

@@ -0,0 +1,129 @@
+RSpec::Support.require_rspec_mocks 'verifying_proxy'
+
+module RSpec
+  module Mocks
+    # @private
+    module VerifyingDouble
+      def respond_to?(message, include_private=false)
+        return super unless null_object?
+
+        method_ref = __mock_proxy.method_reference[message]
+
+        case method_ref.visibility
+        when :public    then true
+        when :private   then include_private
+        when :protected then include_private || RUBY_VERSION.to_f < 2.0
+        else !method_ref.unimplemented?
+        end
+      end
+
+      def method_missing(message, *args, &block)
+        # Null object conditional is an optimization. If not a null object,
+        # validity of method expectations will have been checked at definition
+        # time.
+        if null_object?
+          if @__sending_message == message
+            __mock_proxy.ensure_implemented(message)
+          else
+            __mock_proxy.ensure_publicly_implemented(message, self)
+          end
+
+          __mock_proxy.validate_arguments!(message, args)
+        end
+
+        super
+      end
+
+      # @private
+      module SilentIO
+        def self.method_missing(*); end
+        def self.respond_to?(*)
+          true
+        end
+      end
+
+      # Redefining `__send__` causes ruby to issue a warning.
+      old, $stderr = $stderr, SilentIO
+      def __send__(name, *args, &block)
+        @__sending_message = name
+        super
+      ensure
+        @__sending_message = nil
+      end
+      $stderr = old
+
+      def send(name, *args, &block)
+        __send__(name, *args, &block)
+      end
+
+      def initialize(doubled_module, *args)
+        @doubled_module = doubled_module
+
+        possible_name = args.first
+        name = if String === possible_name || Symbol === possible_name
+                 args.shift
+               end
+
+        super(name, *args)
+        @__sending_message = nil
+      end
+    end
+
+    # A mock providing a custom proxy that can verify the validity of any
+    # method stubs or expectations against the public instance methods of the
+    # given class.
+    #
+    # @private
+    class InstanceVerifyingDouble
+      include TestDouble
+      include VerifyingDouble
+
+      def __build_mock_proxy(order_group)
+        VerifyingProxy.new(self, order_group,
+                           @doubled_module,
+                           InstanceMethodReference
+        )
+      end
+    end
+
+    # An awkward module necessary because we cannot otherwise have
+    # ClassVerifyingDouble inherit from Module and still share these methods.
+    #
+    # @private
+    module ObjectVerifyingDoubleMethods
+      include TestDouble
+      include VerifyingDouble
+
+      def as_stubbed_const(options={})
+        ConstantMutator.stub(@doubled_module.const_to_replace, self, options)
+        self
+      end
+
+    private
+
+      def __build_mock_proxy(order_group)
+        VerifyingProxy.new(self, order_group,
+                           @doubled_module,
+                           ObjectMethodReference
+        )
+      end
+    end
+
+    # Similar to an InstanceVerifyingDouble, except that it verifies against
+    # public methods of the given object.
+    #
+    # @private
+    class ObjectVerifyingDouble
+      include ObjectVerifyingDoubleMethods
+    end
+
+    # Effectively the same as an ObjectVerifyingDouble (since a class is a type
+    # of object), except with Module in the inheritance chain so that
+    # transferring nested constants to work.
+    #
+    # @private
+    class ClassVerifyingDouble < Module
+      include ObjectVerifyingDoubleMethods
+    end
+  end
+end

data/lib/rspec/mocks/verifying_message_expectation.rb

@@ -0,0 +1,54 @@
+RSpec::Support.require_rspec_support 'method_signature_verifier'
+
+module RSpec
+  module Mocks
+    # A message expectation that knows about the real implementation of the
+    # message being expected, so that it can verify that any expectations
+    # have the valid arguments.
+    # @api private
+    class VerifyingMessageExpectation < MessageExpectation
+      # A level of indirection is used here rather than just passing in the
+      # method itself, since method look up is expensive and we only want to
+      # do it if actually needed.
+      #
+      # Conceptually the method reference makes more sense as a constructor
+      # argument since it should be immutable, but it is significantly more
+      # straight forward to build the object in pieces so for now it stays as
+      # an accessor.
+      attr_accessor :method_reference
+
+      def initialize(*args)
+        super
+      end
+
+      # @private
+      def with(*args, &block)
+        super(*args, &block).tap do
+          validate_expected_arguments! do |signature|
+            example_call_site_args = [:an_arg] * signature.min_non_kw_args
+            example_call_site_args << :kw_args_hash if signature.required_kw_args.any?
+            @argument_list_matcher.resolve_expected_args_based_on(example_call_site_args)
+          end
+        end
+      end
+
+    private
+
+      def validate_expected_arguments!
+        return if method_reference.nil?
+
+        method_reference.with_signature do |signature|
+          args     = yield signature
+          verifier = Support::LooseSignatureVerifier.new(signature, args)
+
+          unless verifier.valid?
+            # Fail fast is required, otherwise the message expectation will fail
+            # as well ("expected method not called") and clobber this one.
+            @failed_fast = true
+            @error_generator.raise_invalid_arguments_error(verifier)
+          end
+        end
+      end
+    end
+  end
+end