mocha 0.5.6 → 3.0.2

data/lib/mocha/block_matchers.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Mocha
+  module BlockMatchers
+    class OptionalBlock
+      def match?(_actual_block)
+        true
+      end
+
+      def mocha_inspect; end
+    end
+
+    class BlockGiven
+      def match?(actual_block)
+        !actual_block.nil?
+      end
+
+      def mocha_inspect
+        'with block given'
+      end
+    end
+
+    class NoBlockGiven
+      def match?(actual_block)
+        actual_block.nil?
+      end
+
+      def mocha_inspect
+        'with no block given'
+      end
+    end
+  end
+end

data/lib/mocha/cardinality.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Mocha
+  class Cardinality
+    INFINITY = 1 / 0.0
+
+    def initialize(required = 0, maximum = INFINITY)
+      update(required, maximum)
+      @invocations = []
+    end
+
+    def exactly(count)
+      update(count, count)
+    end
+
+    def at_least(count)
+      update(count, INFINITY)
+    end
+
+    def at_most(count)
+      update(0, count)
+    end
+
+    def times(range_or_count)
+      case range_or_count
+      when Range then update(range_or_count.first, range_or_count.last)
+      else update(range_or_count, range_or_count)
+      end
+    end
+
+    def <<(invocation)
+      @invocations << invocation
+    end
+
+    def invocations_allowed?
+      @invocations.size < maximum
+    end
+
+    def invocations_never_allowed?
+      maximum.zero?
+    end
+
+    def satisfied?
+      @invocations.size >= required
+    end
+
+    def needs_verifying?
+      !allowed_any_number_of_times?
+    end
+
+    def verified?
+      (@invocations.size >= required) && (@invocations.size <= maximum)
+    end
+
+    def allowed_any_number_of_times?
+      required.zero? && infinite?(maximum)
+    end
+
+    def used?
+      @invocations.any? || maximum.zero?
+    end
+
+    def anticipated_times
+      if allowed_any_number_of_times?
+        'allowed any number of times'
+      elsif required.zero? && maximum.zero?
+        "expected #{count(maximum)}"
+      elsif required == maximum
+        "expected exactly #{count(required)}"
+      elsif infinite?(maximum)
+        "expected at least #{count(required)}"
+      elsif required.zero?
+        "expected at most #{count(maximum)}"
+      else
+        "expected between #{required} and #{count(maximum)}"
+      end
+    end
+
+    def invoked_times
+      "invoked #{count(@invocations.size)}"
+    end
+
+    def actual_invocations
+      @invocations.map(&:full_description).join
+    end
+
+    protected
+
+    attr_reader :required, :maximum
+
+    def count(number)
+      case number
+      when 0 then 'never'
+      when 1 then 'once'
+      when 2 then 'twice'
+      else "#{number} times"
+      end
+    end
+
+    def update(required, maximum)
+      @required = required
+      @maximum = maximum
+      self
+    end
+
+    def infinite?(number)
+      number.respond_to?(:infinite?) && number.infinite?
+    end
+  end
+end

data/lib/mocha/central.rb

@@ -1,35 +1,46 @@
+# frozen_string_literal: true
+
 module Mocha
-  
   class Central
-  
+    class Null < self
+      def initialize(&block)
+        super
+        @raise_not_initialized_error = block
+      end
+
+      def stub(*)
+        @raise_not_initialized_error.call
+      end
+
+      def unstub(*)
+        @raise_not_initialized_error.call
+      end
+    end
+
     attr_accessor :stubba_methods
-  
+
     def initialize
       self.stubba_methods = []
     end
-   
+
     def stub(method)
-      unless stubba_methods.include?(method)
-        method.stub 
-        stubba_methods.push method
-      end
-    end
-    
-    def verify_all(&block)
-      unique_mocks.each { |mock| mock.verify(&block) }
+      return if stubba_methods.detect { |m| m.matches?(method) }
+
+      method.stub
+      stubba_methods.push(method)
     end
-    
-    def unique_mocks
-      stubba_methods.inject({}) { |mocks, method| mocks[method.mock.__id__] = method.mock; mocks }.values
+
+    def unstub(method)
+      return unless (existing = stubba_methods.detect { |m| m.matches?(method) })
+
+      existing.unstub
+      stubba_methods.delete(existing)
     end
-  
+
     def unstub_all
-      while stubba_methods.length > 0
-        method = stubba_methods.pop
-        method.unstub
+      while stubba_methods.any?
+        unstub(stubba_methods.first)
       end
     end
-
   end
-
-end
+end

data/lib/mocha/change_state_side_effect.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Mocha
+  class ChangeStateSideEffect
+    def initialize(state)
+      @state = state
+    end
+
+    def perform
+      @state.activate
+    end
+
+    def mocha_inspect
+      "then #{@state.mocha_inspect}"
+    end
+  end
+end

data/lib/mocha/class_methods.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'mocha/mockery'
+require 'mocha/any_instance_method'
+
+module Mocha
+  # Methods added to all classes to allow mocking and stubbing on real (i.e. non-mock) objects.
+  module ClassMethods
+    # @private
+    class AnyInstance
+      def initialize(klass)
+        @stubba_object = klass
+      end
+
+      def mocha(instantiate: true)
+        if instantiate
+          @mocha ||= Mocha::Mockery.instance.mock_impersonating_any_instance_of(@stubba_object)
+        else
+          defined?(@mocha) ? @mocha : nil
+        end
+      end
+
+      def stubba_method
+        Mocha::AnyInstanceMethod
+      end
+
+      def stubba_class
+        @stubba_object
+      end
+
+      def stubba_respond_to?(symbol)
+        @stubba_object.allocate.respond_to?(symbol.to_sym)
+      end
+
+      attr_reader :stubba_object
+    end
+
+    # @return [Mock] a mock object which will detect calls to any instance of this class.
+    # @raise [StubbingError] if attempting to stub method which is not allowed.
+    #
+    # @example Return false to invocation of +Product#save+ for any instance of +Product+.
+    #   Product.any_instance.stubs(:save).returns(false)
+    #   product_1 = Product.new
+    #   assert_equal false, product_1.save
+    #   product_2 = Product.new
+    #   assert_equal false, product_2.save
+    def any_instance
+      if frozen?
+        raise StubbingError.new("can't stub method on frozen object: #{mocha_inspect}.any_instance", caller)
+      end
+
+      @any_instance ||= AnyInstance.new(self)
+    end
+
+    # @private
+    def __method_visibility__(method, include_public_methods: true)
+      if include_public_methods && public_method_defined?(method)
+        :public
+      elsif protected_method_defined?(method)
+        :protected
+      else
+        private_method_defined?(method) ? :private : nil
+      end
+    end
+    alias_method :__method_exists__?, :__method_visibility__
+  end
+end

data/lib/mocha/configuration.rb

@@ -0,0 +1,338 @@
+# frozen_string_literal: true
+
+require 'mocha/ruby_version'
+require 'mocha/deprecation'
+
+module Mocha
+  # Allows setting of configuration options. See {Configuration} for the available options.
+  #
+  # Typically the configuration is set globally in a +test_helper.rb+ or +spec_helper.rb+ file.
+  #
+  # @see Configuration
+  #
+  # @yieldparam configuration [Configuration] the configuration for modification
+  #
+  # @example Setting multiple configuration options
+  #   Mocha.configure do |c|
+  #     c.stubbing_method_unnecessarily = :prevent
+  #     c.stubbing_method_on_non_mock_object = :warn
+  #   end
+  #
+  def self.configure
+    yield configuration
+  end
+
+  # @private
+  def self.configuration
+    Configuration.configuration
+  end
+
+  # This class provides a number of ways to configure the library.
+  #
+  # Typically the configuration is set globally in a +test_helper.rb+ or +spec_helper.rb+ file.
+  #
+  # @example Setting multiple configuration options
+  #   Mocha.configure do |c|
+  #     c.stubbing_method_unnecessarily = :prevent
+  #     c.stubbing_method_on_non_mock_object = :warn
+  #   end
+  #
+  class Configuration
+    # @private
+    DEFAULTS = {
+      stubbing_method_unnecessarily: :allow,
+      stubbing_method_on_non_mock_object: :allow,
+      stubbing_non_existent_method: :allow,
+      stubbing_non_public_method: :allow,
+      display_matching_invocations_on_failure: false,
+      strict_keyword_argument_matching: Mocha::RUBY_V30_PLUS
+    }.freeze
+
+    attr_reader :options
+    protected :options
+
+    # @private
+    def initialize(options = {})
+      @options = DEFAULTS.merge(options)
+    end
+
+    # @private
+    def initialize_copy(other)
+      @options = other.options.dup
+    end
+
+    # @private
+    def merge(other)
+      self.class.new(@options.merge(other.options))
+    end
+
+    # Configure whether stubbing methods unnecessarily is allowed.
+    #
+    # This is useful for identifying unused stubs. Unused stubs are often accidentally introduced when code is {http://martinfowler.com/bliki/DefinitionOfRefactoring.html refactored}.
+    #
+    # When +value+ is +:allow+, do nothing. This is the default.
+    # When +value+ is +:warn+, display a warning.
+    # When +value+ is +:prevent+, raise a {StubbingError}.
+    #
+    # @param [Symbol] value one of +:allow+, +:warn+, +:prevent+.
+    #
+    # @example Preventing unnecessary stubbing of a method
+    #   Mocha.configure do |c|
+    #     c.stubbing_method_unnecessarily = :prevent
+    #   end
+    #
+    #   example = mock('example')
+    #   example.stubs(:unused_stub)
+    #   # => Mocha::StubbingError: stubbing method unnecessarily:
+    #   # =>   #<Mock:example>.unused_stub(any_parameters)
+    #
+    def stubbing_method_unnecessarily=(value)
+      @options[:stubbing_method_unnecessarily] = value
+    end
+
+    # @private
+    def stubbing_method_unnecessarily
+      @options[:stubbing_method_unnecessarily]
+    end
+
+    # Configure whether stubbing methods on non-mock objects is allowed.
+    #
+    # If you like the idea of {http://www.jmock.org/oopsla2004.pdf mocking roles not objects} and {http://www.mockobjects.com/2007/04/test-smell-mocking-concrete-classes.html you don't like stubbing concrete classes}, this is the setting for you. However, while this restriction makes a lot of sense in Java with its {http://java.sun.com/docs/books/tutorial/java/concepts/interface.html explicit interfaces}, it may be moot in Ruby where roles are probably best represented as Modules.
+    #
+    # When +value+ is +:allow+, do nothing. This is the default.
+    # When +value+ is +:warn+, display a warning.
+    # When +value+ is +:prevent+, raise a {StubbingError}.
+    #
+    # @param [Symbol] value one of +:allow+, +:warn+, +:prevent+.
+    #
+    # @example Preventing stubbing of a method on a non-mock object
+    #   Mocha.configure do |c|
+    #     c.stubbing_method_on_non_mock_object = :prevent
+    #   end
+    #
+    #   class Example
+    #     def example_method; end
+    #   end
+    #
+    #   example = Example.new
+    #   example.stubs(:example_method)
+    #   # => Mocha::StubbingError: stubbing method on non-mock object:
+    #   # =>   #<Example:0x593620>.example_method
+    #
+    def stubbing_method_on_non_mock_object=(value)
+      @options[:stubbing_method_on_non_mock_object] = value
+    end
+
+    # @private
+    def stubbing_method_on_non_mock_object
+      @options[:stubbing_method_on_non_mock_object]
+    end
+
+    # Configure whether stubbing of non-existent methods is allowed.
+    #
+    # This is useful if you want to ensure that methods you're mocking really exist. A common criticism of unit tests with mock objects is that such a test may (incorrectly) pass when an equivalent non-mocking test would (correctly) fail. While you should always have some integration tests, particularly for critical business functionality, this Mocha configuration setting should catch scenarios when mocked methods and real methods have become misaligned.
+    #
+    # When +value+ is +:allow+, do nothing. This is the default.
+    # When +value+ is +:warn+, display a warning.
+    # When +value+ is +:prevent+, raise a {StubbingError}.
+    #
+    # @param [Symbol] value one of +:allow+, +:warn+, +:prevent+.
+    #
+    # @example Preventing stubbing of a non-existent method
+    #
+    #   Mocha.configure do |c|
+    #     c.stubbing_non_existent_method = :prevent
+    #   end
+    #
+    #   class Example
+    #   end
+    #
+    #   example = Example.new
+    #   example.stubs(:method_that_doesnt_exist)
+    #   # => Mocha::StubbingError: stubbing non-existent method:
+    #   # =>   #<Example:0x593760>.method_that_doesnt_exist
+    #
+    def stubbing_non_existent_method=(value)
+      @options[:stubbing_non_existent_method] = value
+    end
+
+    # @private
+    def stubbing_non_existent_method
+      @options[:stubbing_non_existent_method]
+    end
+
+    # Configure whether stubbing of non-public methods is allowed.
+    #
+    # Many people think that it's good practice only to mock public methods. This is one way to prevent your tests being too tightly coupled to the internal implementation of a class. Such tests tend to be very brittle and not much use when refactoring.
+    #
+    # When +value+ is +:allow+, do nothing. This is the default.
+    # When +value+ is +:warn+, display a warning.
+    # When +value+ is +:prevent+, raise a {StubbingError}.
+    #
+    # @param [Symbol] value one of +:allow+, +:warn+, +:prevent+.
+    #
+    # @example Preventing stubbing of a non-public method
+    #   Mocha.configure do |c|
+    #     c.stubbing_non_public_method = :prevent
+    #   end
+    #
+    #   class Example
+    #     def internal_method; end
+    #     private :internal_method
+    #   end
+    #
+    #   example = Example.new
+    #   example.stubs(:internal_method)
+    #   # => Mocha::StubbingError: stubbing non-public method:
+    #   # =>   #<Example:0x593530>.internal_method
+    #
+    def stubbing_non_public_method=(value)
+      @options[:stubbing_non_public_method] = value
+    end
+
+    # @private
+    def stubbing_non_public_method
+      @options[:stubbing_non_public_method]
+    end
+
+    # Display matching invocations alongside expectations on Mocha-related test failure.
+    #
+    # @param [Boolean] value +true+ to enable display of matching invocations; disabled by default.
+    #
+    # @example Enable display of matching invocations
+    #   Mocha.configure do |c|
+    #     c.display_matching_invocations_on_failure = true
+    #   end
+    #
+    #   foo = mock('foo')
+    #   foo.expects(:bar)
+    #   foo.stubs(:baz).returns('baz').raises(RuntimeError).throws(:tag, 'value')
+    #
+    #   foo.baz(1, 2)
+    #   assert_raises(RuntimeError) { foo.baz(3, 4) }
+    #   assert_throws(:tag) { foo.baz(5, 6) }
+    #
+    #   not all expectations were satisfied
+    #   unsatisfied expectations:
+    #   - expected exactly once, invoked never: #<Mock:foo>.bar
+    #   satisfied expectations:
+    #   - allowed any number of times, invoked 3 times: #<Mock:foo>.baz(any_parameters)
+    #     - #<Mock:foo>.baz(1, 2) # => "baz"
+    #     - #<Mock:foo>.baz(3, 4) # => raised RuntimeError
+    #     - #<Mock:foo>.baz(5, 6) # => threw (:tag, "value")
+    def display_matching_invocations_on_failure=(value)
+      @options[:display_matching_invocations_on_failure] = value
+    end
+
+    # @private
+    def display_matching_invocations_on_failure?
+      @options[:display_matching_invocations_on_failure]
+    end
+
+    # Perform strict keyword argument comparison. Only supported in Ruby >= v2.7.
+    #
+    # When this option is set to +false+ a positional +Hash+ and a set of keyword arguments are treated the same during comparison, which can lead to misleading passing tests in Ruby >= v3.0 (see examples below). However, a deprecation warning will be displayed if a positional +Hash+ matches a set of keyword arguments or vice versa.
+    #
+    # For more details on keyword arguments in Ruby v3, refer to {https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0 this article}.
+    #
+    # Note that +Hash+-related matchers such as {ParameterMatchers::Methods#has_value} or {ParameterMatchers::Methods#has_key} will still treat a positional +Hash+ and a set of keyword arguments the same, so misleading passing tests are still possible when they are used.
+    #
+    # This configuration option is +false+ by default in Ruby v2.7 to enable gradual adoption, but +true+ by default in Ruby >= v3.0.
+    #
+    # @param [Boolean] value +true+ to enable strict keyword argument matching.
+    #
+    # @example Loose keyword argument matching (default in Ruby v2.7)
+    #
+    #   Mocha.configure do |c|
+    #     c.strict_keyword_argument_matching = false
+    #   end
+    #
+    #   class Example
+    #     def foo(a, bar:); end
+    #   end
+    #
+    #   example = Example.new
+    #   example.expects(:foo).with('a', bar: 'b')
+    #   example.foo('a', { bar: 'b' })
+    #   # This passes the test, but would result in an ArgumentError in practice
+    #
+    # @example Strict keyword argument matching (default in Ruby >= v3.0)
+    #
+    #   Mocha.configure do |c|
+    #     c.strict_keyword_argument_matching = true
+    #   end
+    #
+    #   class Example
+    #     def foo(a, bar:); end
+    #   end
+    #
+    #   example = Example.new
+    #   example.expects(:foo).with('a', bar: 'b')
+    #   example.foo('a', { bar: 'b' })
+    #   # This now fails as expected
+    def strict_keyword_argument_matching=(value)
+      raise 'Strict keyword argument matching requires Ruby 2.7 and above.' unless Mocha::RUBY_V27_PLUS
+
+      @options[:strict_keyword_argument_matching] = value
+    end
+
+    # @private
+    def strict_keyword_argument_matching?
+      @options[:strict_keyword_argument_matching]
+    end
+
+    class << self
+      # @private
+      def reset_configuration
+        @configuration = nil
+      end
+
+      # Temporarily modify {Configuration} options.
+      #
+      # The supplied +temporary_options+ will override the current configuration for the duration of the supplied block.
+      # The configuration will be returned to its original state when the block returns.
+      #
+      # @param [Hash] temporary_options the configuration options to apply for the duration of the block.
+      # @yield block during which the configuration change will be in force.
+      #
+      # @example Temporarily prevent stubbing of non-mock object
+      #   Mocha::Configuration.override(stubbing_method_on_non_mock_object: :prevent) do
+      #     123.stubs(:to_s).returns('456')
+      #   end
+      def override(temporary_options)
+        original_configuration = configuration
+        @configuration = configuration.merge(new(temporary_options))
+        yield
+      ensure
+        @configuration = original_configuration
+      end
+
+      # @private
+      def configuration
+        @configuration ||= new
+      end
+
+      private
+
+      # @private
+      def change_config(action, new_value, &block)
+        if block_given?
+          temporarily_change_config action, new_value, &block
+        else
+          configuration.send(:"#{action}=", new_value)
+        end
+      end
+
+      # @private
+      def temporarily_change_config(action, new_value)
+        original_configuration = configuration
+        new_configuration = configuration.dup
+        new_configuration.send(:"#{action}=", new_value)
+        @configuration = new_configuration
+        yield
+      ensure
+        @configuration = original_configuration
+      end
+    end
+  end
+end

data/lib/mocha/default_name.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Mocha
+  class DefaultName
+    def initialize(mock)
+      @mock = mock
+    end
+
+    def mocha_inspect
+      address = @mock.__id__ * 2
+      address += 0x100000000 if address < 0
+      "#<Mock:0x#{format('%<address>x', address: address)}>"
+    end
+  end
+end

data/lib/mocha/default_receiver.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Mocha
+  class DefaultReceiver
+    def initialize(mock)
+      @mock = mock
+    end
+
+    def mocks
+      [@mock]
+    end
+  end
+end

data/lib/mocha/deprecation.rb

@@ -1,22 +1,27 @@
+# frozen_string_literal: true
+
+require 'mocha/backtrace_filter'
+
 module Mocha
-  
   class Deprecation
-    
+    class Logger
+      def call(message)
+        filter = BacktraceFilter.new
+        location = filter.filtered(caller)[0]
+        warn "Mocha deprecation warning at #{location}: #{message}"
+      end
+    end
+
     class << self
-      
-      attr_accessor :mode, :messages
-      
+      attr_writer :logger
+
       def warning(message)
-        @messages << message
-        $stderr.puts "Mocha deprecation warning: #{message}" unless mode == :disabled
-        $stderr.puts caller.join("\n  ") if mode == :debug
+        logger.call(message)
       end
 
+      def logger
+        @logger ||= Logger.new
+      end
     end
-  
-    self.mode = :enabled
-    self.messages = []
-    
   end
-   
-end
+end