mocha 2.7.1 → 3.0.0.pre.rc.1

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,21 +1,27 @@
+# frozen_string_literal: true
+
 require 'mocha/backtrace_filter'
 
 module Mocha
   class Deprecation
-    class << self
-      attr_accessor :mode, :messages
-
-      def warning(*messages)
-        message = messages.join
-        @messages << message
-        return if mode == :disabled
+    class Logger
+      def warning(message)
         filter = BacktraceFilter.new
         location = filter.filtered(caller)[0]
         warn "Mocha deprecation warning at #{location}: #{message}"
       end
     end
 
-    self.mode = :enabled
-    self.messages = []
+    class << self
+      attr_writer :logger
+
+      def warning(message)
+        logger.call(message)
+      end
+
+      def logger
+        @logger || Logger.new
+      end
+    end
   end
 end

data/lib/mocha/detection/minitest.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mocha
   module Detection
     module Minitest

data/lib/mocha/detection/test_unit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mocha
   module Detection
     module TestUnit
@@ -14,7 +16,8 @@ module Mocha
         if testcase
           begin
             require 'test/unit/version'
-          rescue LoadError # rubocop:disable Lint/HandleExceptions
+          rescue LoadError
+            warn "Unable to load 'test/unit/version', but continuing anyway" if $DEBUG
           end
           if defined?(::Test::Unit::VERSION)
             version = ::Test::Unit::VERSION

data/lib/mocha/error_with_filtered_backtrace.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mocha/backtrace_filter'
 
 module Mocha

data/lib/mocha/exception_raiser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mocha
   class ExceptionRaiser
     def initialize(exception, message)
@@ -9,6 +11,7 @@ module Mocha
       invocation.raised(@exception)
       raise @exception, @exception.to_s if @exception.is_a?(Module) && (@exception < Interrupt)
       raise @exception, @message if @message
+
       raise @exception
     end
   end

data/lib/mocha/expectation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ruby2_keywords'
 require 'mocha/method_matcher'
 require 'mocha/parameters_matcher'
@@ -6,23 +8,22 @@ require 'mocha/return_values'
 require 'mocha/exception_raiser'
 require 'mocha/thrower'
 require 'mocha/yield_parameters'
-require 'mocha/is_a'
 require 'mocha/in_state_ordering_constraint'
 require 'mocha/change_state_side_effect'
 require 'mocha/cardinality'
 require 'mocha/configuration'
-require 'mocha/block_matcher'
+require 'mocha/block_matchers'
 require 'mocha/backtrace_filter'
 
 module Mocha
   # Methods on expectations returned from {Mock#expects}, {Mock#stubs}, {ObjectMethods#expects} and {ObjectMethods#stubs}.
   class Expectation
-    # Modifies expectation so that the number of calls to the expected method must be within a specific +range+.
+    # Modifies expectation so that the number of invocations of the expected method must be within a specified range or exactly equal to a specified number.
     #
-    # @param [Range,Integer] range specifies the allowable range in the number of expected invocations.
+    # @param [Range,Integer] range_or_number specifies the allowable range for the number of expected invocations or the specified number of expected invocations.
     # @return [Expectation] the same expectation, thereby allowing invocations of other {Expectation} methods to be chained.
     #
-    # @example Specifying a specific number of expected invocations.
+    # @example Specifying an exact number of expected invocations.
     #   object = mock()
     #   object.expects(:expected_method).times(3)
     #   3.times { object.expected_method }
@@ -33,7 +34,7 @@ module Mocha
     #   2.times { object.expected_method }
     #   # => verify fails
     #
-    # @example Specifying a range in the number of expected invocations.
+    # @example Specifying a range for the number of expected invocations.
     #   object = mock()
     #   object.expects(:expected_method).times(2..4)
     #   3.times { object.expected_method }
@@ -43,12 +44,41 @@ module Mocha
     #   object.expects(:expected_method).times(2..4)
     #   object.expected_method
     #   # => verify fails
-    def times(range)
-      @cardinality.times(range)
+    def times(range_or_number)
+      @cardinality.times(range_or_number)
+      self
+    end
+
+    # Modifies expectation so that the expected method must be called exactly three times. This is equivalent to calling {#times} with an argument of +3+.
+    #
+    # @return [Expectation] the same expectation, thereby allowing invocations of other {Expectation} methods to be chained.
+    #
+    # @example Expected method must be invoked exactly three times.
+    #   object = mock()
+    #   object.expects(:expected_method).thrice
+    #   object.expected_method
+    #   object.expected_method
+    #   object.expected_method
+    #   # => verify succeeds
+    #
+    #   object = mock()
+    #   object.expects(:expected_method).thrice
+    #   object.expected_method
+    #   object.expected_method
+    #   object.expected_method
+    #   object.expected_method # => unexpected invocation
+    #
+    #   object = mock()
+    #   object.expects(:expected_method).thrice
+    #   object.expected_method
+    #   object.expected_method
+    #   # => verify fails
+    def thrice
+      @cardinality.exactly(3)
       self
     end
 
-    # Modifies expectation so that the expected method must be called exactly twice.
+    # Modifies expectation so that the expected method must be called exactly twice. This is equivalent to calling {#times} with an argument of +2+.
     #
     # @return [Expectation] the same expectation, thereby allowing invocations of other {Expectation} methods to be chained.
     #
@@ -74,7 +104,7 @@ module Mocha
       self
     end
 
-    # Modifies expectation so that the expected method must be called exactly once.
+    # Modifies expectation so that the expected method must be called exactly once. This is equivalent to calling {#times} with an argument of +1+.
     #
     # Note that this is the default behaviour for an expectation, but you may wish to use it for clarity/emphasis.
     #
@@ -136,7 +166,7 @@ module Mocha
       self
     end
 
-    # Modifies expectation so that the expected method must be called at least once.
+    # Modifies expectation so that the expected method must be called at least once. This is equivalent to calling {#at_least} with an argument of +1+.
     #
     # @return [Expectation] the same expectation, thereby allowing invocations of other {Expectation} methods to be chained.
     #
@@ -172,7 +202,7 @@ module Mocha
       self
     end
 
-    # Modifies expectation so that the expected method must be called at most once.
+    # Modifies expectation so that the expected method must be called at most once. This is equivalent to calling {#at_most} with an argument of +1+.
     #
     # @return [Expectation] the same expectation, thereby allowing invocations of other {Expectation} methods to be chained.
     #
@@ -200,9 +230,9 @@ module Mocha
     #
     # Positional arguments were separated from keyword arguments in Ruby v3 (see {https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0 this article}). In relation to this a new configuration option ({Configuration#strict_keyword_argument_matching=}) is available in Ruby >= 2.7.
     #
-    # When {Configuration#strict_keyword_argument_matching=} is set to +false+ (which is currently the default), a positional +Hash+ and a set of keyword arguments passed to {#with} are treated the same for the purposes of parameter matching. However, a deprecation warning will be displayed if a positional +Hash+ matches a set of keyword arguments or vice versa. This is because {Configuration#strict_keyword_argument_matching=} will default to +true+ in the future.
+    # When {Configuration#strict_keyword_argument_matching=} is set to +false+ (which is the default in Ruby v2.7), a positional +Hash+ and a set of keyword arguments passed to {#with} are treated the same for the purposes of parameter matching. However, a deprecation warning will be displayed if a positional +Hash+ matches a set of keyword arguments or vice versa.
     #
-    # When {Configuration#strict_keyword_argument_matching=} is set to +true+, an actual positional +Hash+ will not match an expected set of keyword arguments; and vice versa, an actual set of keyword arguments will not match an expected positional +Hash+, i.e. the parameter matching is stricter.
+    # When {Configuration#strict_keyword_argument_matching=} is set to +true+ (which is the default in Ruby >= v3.0), an actual positional +Hash+ will not match an expected set of keyword arguments; and vice versa, an actual set of keyword arguments will not match an expected positional +Hash+, i.e. the parameter matching is stricter.
     #
     # @see ParameterMatchers
     # @see Configuration#strict_keyword_argument_matching=
@@ -235,7 +265,11 @@ module Mocha
     #   object.expected_method(['string1'], 'any-old-value')
     #   # => verify fails
     #
-    # @example Loose keyword argument matching (default)
+    # @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
@@ -246,7 +280,7 @@ module Mocha
     #   example.foo('a', { bar: 'b' })
     #   # This passes the test, but would result in an ArgumentError in practice
     #
-    # @example Strict keyword argument matching
+    # @example Strict keyword argument matching (default in Ruby >= 3.0).
     #
     #   Mocha.configure do |c|
     #     c.strict_keyword_argument_matching = true
@@ -711,19 +745,19 @@ module Mocha
 
     # @private
     def mocha_inspect
-      message = "#{@cardinality.anticipated_times}, #{@cardinality.invoked_times}: #{method_signature}"
-      message << "; #{@ordering_constraints.map(&:mocha_inspect).join('; ')}" unless @ordering_constraints.empty?
+      strings = ["#{@cardinality.anticipated_times}, #{@cardinality.invoked_times}: #{method_signature}"]
+      strings << "; #{@ordering_constraints.map(&:mocha_inspect).join('; ')}" unless @ordering_constraints.empty?
       if Mocha.configuration.display_matching_invocations_on_failure?
-        message << @cardinality.actual_invocations
+        strings << @cardinality.actual_invocations
       end
-      message
+      strings.join
     end
 
     # @private
     def method_signature
-      signature = "#{@mock.mocha_inspect}.#{@method_matcher.mocha_inspect}#{@parameters_matcher.mocha_inspect}"
-      signature << " #{@block_matcher.mocha_inspect}" if @block_matcher.mocha_inspect
-      signature
+      strings = ["#{@mock.mocha_inspect}.#{@method_matcher.mocha_inspect}#{@parameters_matcher.mocha_inspect}"]
+      strings << " #{@block_matcher.mocha_inspect}" if @block_matcher.mocha_inspect
+      strings.join
     end
 
     # @private

data/lib/mocha/expectation_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mocha
   # Default exception class raised when an unexpected invocation or an unsatisfied expectation occurs.
   #

data/lib/mocha/expectation_error_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mocha/backtrace_filter'
 require 'mocha/expectation_error'
 

data/lib/mocha/expectation_list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mocha
   class ExpectationList
     def initialize(expectations = [])

data/lib/mocha/hooks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mocha/mockery'
 
 module Mocha

data/lib/mocha/impersonating_any_instance_name.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Mocha
+  class ImpersonatingAnyInstanceName
+    def initialize(klass)
+      @klass = klass
+    end
+
+    def mocha_inspect
+      "#<AnyInstance:#{@klass.mocha_inspect}>"
+    end
+  end
+end

data/lib/mocha/impersonating_name.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Mocha
+  class ImpersonatingName
+    def initialize(object)
+      @object = object
+    end
+
+    def mocha_inspect
+      @object.mocha_inspect
+    end
+  end
+end

data/lib/mocha/in_state_ordering_constraint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mocha
   class InStateOrderingConstraint
     def initialize(state_predicate)

data/lib/mocha/inspect.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'date'
 
 module Mocha
@@ -11,7 +13,7 @@ module Mocha
     end
 
     module ArrayMethods
-      def mocha_inspect(wrapped = true)
+      def mocha_inspect(wrapped: true)
         unwrapped = collect(&:mocha_inspect).join(', ')
         wrapped ? "[#{unwrapped}]" : unwrapped
       end
@@ -19,17 +21,18 @@ module Mocha
 
     module HashMethods
       def mocha_inspect
+        unwrapped = collect do |key, value|
+          case key
+          when Symbol
+            "#{key}: #{value.mocha_inspect}"
+          else
+            "#{key.mocha_inspect} => #{value.mocha_inspect}"
+          end
+        end.join(', ')
+
         if Hash.ruby2_keywords_hash?(self)
-          collect do |key, value|
-            case key
-            when Symbol
-              "#{key}: #{value.mocha_inspect}"
-            else
-              "#{key.mocha_inspect} => #{value.mocha_inspect}"
-            end
-          end.join(', ')
+          empty? ? '**{}' : unwrapped
         else
-          unwrapped = collect { |key, value| "#{key.mocha_inspect} => #{value.mocha_inspect}" }.join(', ')
           "{#{unwrapped}}"
         end
       end

data/lib/mocha/instance_method.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mocha/stubbed_method'
 
 module Mocha

data/lib/mocha/integration/assertion_counter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mocha
   module Integration
     class AssertionCounter

data/lib/mocha/integration/minitest/adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mocha/api'
 require 'mocha/integration/assertion_counter'
 require 'mocha/expectation_error_factory'
@@ -35,6 +37,7 @@ module Mocha
         # @private
         def before_teardown
           return unless passed?
+
           assertion_counter = Integration::AssertionCounter.new(self)
           mocha_verify(assertion_counter)
         ensure

data/lib/mocha/integration/minitest.rb

@@ -1,4 +1,5 @@
-require 'mocha/debug'
+# frozen_string_literal: true
+
 require 'mocha/detection/minitest'
 require 'mocha/integration/minitest/adapter'
 
@@ -10,14 +11,14 @@ module Mocha
         return false unless target
 
         minitest_version = Gem::Version.new(Detection::Minitest.version)
-        Debug.puts "Detected Minitest version: #{minitest_version}"
+        warn "Detected Minitest version: #{minitest_version}" if $DEBUG
 
         unless Minitest::Adapter.applicable_to?(minitest_version)
           raise 'Versions of minitest earlier than v3.3.0 are not supported.'
         end
 
         unless target < Minitest::Adapter
-          Debug.puts "Applying #{Minitest::Adapter.description}"
+          warn "Applying #{Minitest::Adapter.description}" if $DEBUG
           target.send(:include, Minitest::Adapter)
         end
 

data/lib/mocha/integration/monkey_patcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mocha/api'
 
 module Mocha
@@ -5,12 +7,12 @@ module Mocha
     module MonkeyPatcher
       def self.apply(mod, run_method_patch)
         if mod < Mocha::API
-          Debug.puts "Mocha::API already included in #{mod}"
+          warn "Mocha::API already included in #{mod}" if $DEBUG
         else
           mod.send(:include, Mocha::API)
         end
         if mod.method_defined?(:run_before_mocha)
-          Debug.puts "#{mod}#run_before_mocha method already defined"
+          warn "#{mod}#run_before_mocha method already defined" if $DEBUG
         elsif mod.method_defined?(:run)
           mod.send(:alias_method, :run_before_mocha, :run)
           mod.send(:remove_method, :run)

data/lib/mocha/integration/test_unit/adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mocha/api'
 require 'mocha/integration/assertion_counter'
 require 'mocha/expectation_error'
@@ -45,6 +47,7 @@ module Mocha
         # @private
         def handle_mocha_expectation_error(exception)
           return false unless exception.is_a?(Mocha::ExpectationError)
+
           problem_occurred
           add_failure(exception.message, exception.backtrace)
           true

data/lib/mocha/integration/test_unit.rb

@@ -1,4 +1,5 @@
-require 'mocha/debug'
+# frozen_string_literal: true
+
 require 'mocha/detection/test_unit'
 require 'mocha/integration/test_unit/adapter'
 
@@ -10,14 +11,14 @@ module Mocha
         return false unless target
 
         test_unit_version = Gem::Version.new(Detection::TestUnit.version)
-        Debug.puts "Detected Test::Unit version: #{test_unit_version}"
+        warn "Detected Test::Unit version: #{test_unit_version}" if $DEBUG
 
         unless TestUnit::Adapter.applicable_to?(test_unit_version)
           raise 'Versions of test-unit earlier than v2.5.1 are not supported.'
         end
 
         unless target < TestUnit::Adapter
-          Debug.puts "Applying #{TestUnit::Adapter.description}"
+          warn "Applying #{TestUnit::Adapter.description}" if $DEBUG
           target.send(:include, TestUnit::Adapter)
         end
 

data/lib/mocha/invocation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mocha/parameters_matcher'
 require 'mocha/raised_exception'
 require 'mocha/return_values'
@@ -21,6 +23,7 @@ module Mocha
       yield_parameters.next_invocation.each do |yield_args|
         @yields << ParametersMatcher.new(yield_args)
         raise LocalJumpError unless @block
+
         @block.call(*yield_args)
       end
       return_values.next(self)
@@ -43,9 +46,9 @@ module Mocha
     end
 
     def call_description
-      description = "#{@mock.mocha_inspect}.#{@method_name}#{argument_description}"
-      description << ' { ... }' unless @block.nil?
-      description
+      strings = ["#{@mock.mocha_inspect}.#{@method_name}#{argument_description}"]
+      strings << ' { ... }' unless @block.nil?
+      strings.join
     end
 
     def short_call_description
@@ -53,9 +56,9 @@ module Mocha
     end
 
     def result_description
-      desc = "# => #{@result.mocha_inspect}"
-      desc << " after yielding #{@yields.map(&:mocha_inspect).join(', then ')}" if @yields.any?
-      desc
+      strings = ["# => #{@result.mocha_inspect}"]
+      strings << " after yielding #{@yields.map(&:mocha_inspect).join(', then ')}" if @yields.any?
+      strings.join
     end
 
     def full_description

data/lib/mocha/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mocha
   class Logger
     def initialize(io)

data/lib/mocha/macos_version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mocha
   MACOS = /darwin/.match(RUBY_PLATFORM)
   MACOS_VERSION = MACOS && /darwin(\d+)/.match(RUBY_PLATFORM)[1].to_i

data/lib/mocha/method_matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mocha
   class MethodMatcher
     attr_reader :expected_method_name

data/lib/mocha/minitest.rb

@@ -1,4 +1,5 @@
-require 'mocha/ruby_version'
+# frozen_string_literal: true
+
 require 'mocha/integration/minitest'
 
 unless Mocha::Integration::Minitest.activate

data/lib/mocha/mock.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'ruby2_keywords'
 require 'mocha/expectation'
 require 'mocha/expectation_list'
 require 'mocha/invocation'
-require 'mocha/names'
-require 'mocha/receivers'
+require 'mocha/default_name'
+require 'mocha/default_receiver'
 require 'mocha/method_matcher'
 require 'mocha/parameters_matcher'
 require 'mocha/argument_iterator'
@@ -114,8 +116,7 @@ module Mocha
     def expects(method_name_or_hash, backtrace = nil)
       expectation = nil
       iterator = ArgumentIterator.new(method_name_or_hash)
-      iterator.each do |*args|
-        method_name = args.shift
+      iterator.each do |method_name, *args|
         ensure_method_not_already_defined(method_name)
         expectation = Expectation.new(self, method_name, backtrace)
         expectation.in_sequence(@mockery.sequences.last) if @mockery.sequences.any?
@@ -153,8 +154,7 @@ module Mocha
     def stubs(method_name_or_hash, backtrace = nil)
       expectation = nil
       iterator = ArgumentIterator.new(method_name_or_hash)
-      iterator.each do |*args|
-        method_name = args.shift
+      iterator.each do |method_name, *args|
         ensure_method_not_already_defined(method_name)
         expectation = Expectation.new(self, method_name, backtrace)
         expectation.at_least(0)
@@ -315,13 +315,13 @@ module Mocha
     end
 
     # @private
-    def method_missing(symbol, *arguments, &block) # rubocop:disable Style/MethodMissingSuper
+    def method_missing(symbol, *arguments, &block)
       handle_method_call(symbol, arguments, block)
     end
     ruby2_keywords(:method_missing)
 
     # @private
-    def handle_method_call(symbol, arguments, block) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    def handle_method_call(symbol, arguments, block)
       check_expiry
       check_responder_responds_to(symbol)
       invocation = Invocation.new(self, symbol, arguments, block)

data/lib/mocha/mockery.rb

@@ -1,7 +1,12 @@
+# frozen_string_literal: true
+
 require 'mocha/central'
 require 'mocha/mock'
-require 'mocha/names'
-require 'mocha/receivers'
+require 'mocha/name'
+require 'mocha/impersonating_name'
+require 'mocha/impersonating_any_instance_name'
+require 'mocha/object_receiver'
+require 'mocha/any_instance_receiver'
 require 'mocha/state_machine'
 require 'mocha/logger'
 require 'mocha/configuration'
@@ -49,9 +54,13 @@ module Mocha
       end
 
       def teardown(origin = nil)
+        if @instances.nil?
+          raise NotInitializedError, 'Mocha::Mockery.teardown called before Mocha::Mockery.setup'
+        end
+
         instance.teardown(origin)
       ensure
-        @instances.pop
+        @instances.pop unless @instances.nil?
       end
     end
 
@@ -124,12 +133,11 @@ module Mocha
     def on_stubbing(object, method)
       signature_proc = lambda { "#{object.mocha_inspect}.#{method}" }
       check(:stubbing_non_existent_method, 'non-existent method', signature_proc) do
-        !(object.stubba_class.__method_exists__?(method, true) || object.respond_to?(method))
+        !(object.stubba_class.__method_exists__?(method) || object.respond_to?(method))
       end
       check(:stubbing_non_public_method, 'non-public method', signature_proc) do
-        object.stubba_class.__method_exists__?(method, false)
+        object.stubba_class.__method_exists__?(method, include_public_methods: false)
       end
-      check(:stubbing_method_on_nil, 'method on nil', signature_proc) { object.nil? }
       check(:stubbing_method_on_non_mock_object, 'method on non-mock object', signature_proc)
     end
 
@@ -144,9 +152,11 @@ module Mocha
     def check(action, description, signature_proc, backtrace = caller)
       treatment = Mocha.configuration.send(action)
       return if (treatment == :allow) || (block_given? && !yield)
+
       method_signature = signature_proc.call
       message = "stubbing #{description}: #{method_signature}"
       raise StubbingError.new(message, backtrace) if treatment == :prevent
+
       logger.warn(message) if treatment == :warn
     end