mocha 1.15.0 → 2.0.0.alpha.1

data/lib/mocha/integration/test_unit.rb

@@ -1,47 +1,26 @@
 require 'mocha/debug'
-
 require 'mocha/detection/test_unit'
-
-require 'mocha/integration/test_unit/nothing'
-require 'mocha/integration/test_unit/ruby_version_186_and_above'
-require 'mocha/integration/test_unit/gem_version_200'
-require 'mocha/integration/test_unit/gem_version_201_to_202'
-require 'mocha/integration/test_unit/gem_version_203_to_220'
-require 'mocha/integration/test_unit/gem_version_230_to_250'
 require 'mocha/integration/test_unit/adapter'
 
-require 'mocha/deprecation'
-
 module Mocha
   module Integration
     module TestUnit
       def self.activate
-        return false unless Detection::TestUnit.testcase
-        test_unit_version = Gem::Version.new(Detection::TestUnit.version)
-        ruby_version = Gem::Version.new(RUBY_VERSION.dup)
+        target = Detection::TestUnit.testcase
+        return false unless target
 
-        Debug.puts "Detected Ruby version: #{ruby_version}"
+        test_unit_version = Gem::Version.new(Detection::TestUnit.version)
         Debug.puts "Detected Test::Unit version: #{test_unit_version}"
 
-        integration_module = [
-          TestUnit::Adapter,
-          TestUnit::GemVersion230To250,
-          TestUnit::GemVersion203To220,
-          TestUnit::GemVersion201To202,
-          TestUnit::GemVersion200,
-          TestUnit::RubyVersion186AndAbove,
-          TestUnit::Nothing
-        ].detect { |m| m.applicable_to?(test_unit_version, ruby_version) }
+        unless TestUnit::Adapter.applicable_to?(test_unit_version)
+          raise 'Versions of test-unit earlier than v2.5.1 are not supported.'
+        end
 
-        unless ::Test::Unit::TestCase < integration_module
-          unless integration_module == TestUnit::Adapter
-            Deprecation.warning(
-              'Versions of test-unit earlier than v2.5.1 will not be supported in future versions of Mocha.'
-            )
-          end
-          Debug.puts "Applying #{integration_module.description}"
-          ::Test::Unit::TestCase.send(:include, integration_module)
+        unless target < TestUnit::Adapter
+          Debug.puts "Applying #{TestUnit::Adapter.description}"
+          target.send(:include, TestUnit::Adapter)
         end
+
         true
       end
     end

data/lib/mocha/invocation.rb

@@ -3,8 +3,6 @@ require 'mocha/raised_exception'
 require 'mocha/return_values'
 require 'mocha/thrown_object'
 require 'mocha/yield_parameters'
-require 'mocha/configuration'
-require 'mocha/deprecation'
 
 module Mocha
   class Invocation
@@ -22,18 +20,8 @@ module Mocha
     def call(yield_parameters = YieldParameters.new, return_values = ReturnValues.new)
       yield_parameters.next_invocation.each do |yield_args|
         @yields << ParametersMatcher.new(yield_args)
-        if @block
-          @block.call(*yield_args)
-        else
-          raise LocalJumpError unless Mocha.configuration.reinstate_undocumented_behaviour_from_v1_9?
-          yield_args_description = ParametersMatcher.new(yield_args).mocha_inspect
-          Deprecation.warning(
-            "Stubbed method was instructed to yield #{yield_args_description}, but no block was given by invocation: #{call_description}.",
-            ' This will raise a LocalJumpError in the future.',
-            ' Use Expectation#with_block_given to constrain this expectation to match invocations supplying a block.',
-            ' And, if necessary, add another expectation to match invocations not supplying a block.'
-          )
-        end
+        raise LocalJumpError unless @block
+        @block.call(*yield_args)
       end
       return_values.next(self)
     end
@@ -79,7 +67,6 @@ module Mocha
     def argument_description
       signature = arguments.mocha_inspect
       signature = signature.gsub(/^\[|\]$/, '')
-      signature = signature.gsub(/^\{|\}$/, '') if arguments.length == 1
       "(#{signature})"
     end
   end

data/lib/mocha/minitest.rb

@@ -1,9 +1,6 @@
 require 'mocha/ruby_version'
 require 'mocha/integration/mini_test'
-require 'mocha/deprecation'
 
 unless Mocha::Integration::MiniTest.activate
-  Mocha::Deprecation.warning(
-    "MiniTest must be loaded *before* `require 'mocha/minitest'`."
-  )
+  raise "MiniTest must be loaded *before* `require 'mocha/minitest'`."
 end

data/lib/mocha/mock.rb

@@ -1,3 +1,4 @@
+require 'ruby2_keywords'
 require 'mocha/expectation'
 require 'mocha/expectation_list'
 require 'mocha/invocation'
@@ -308,9 +309,12 @@ module Mocha
     end
 
     # @private
-    def method_missing(symbol, *arguments, &block) # rubocop:disable Style/MethodMissingSuper
+    # rubocop:disable Style/MethodMissingSuper
+    def method_missing(symbol, *arguments, &block)
       handle_method_call(symbol, arguments, block)
     end
+    ruby2_keywords(:method_missing)
+    # rubocop:enable Style/MethodMissingSuper
 
     # @private
     def handle_method_call(symbol, arguments, block)
@@ -383,14 +387,14 @@ module Mocha
     end
 
     def check_expiry
-      if @expired # rubocop:disable Style/GuardClause
-        Deprecation.warning(
-          "#{mocha_inspect} was instantiated in one test but it is receiving invocations within another test.",
-          ' This can lead to unintended interactions between tests and hence unexpected test failures.',
-          ' Ensure that every test correctly cleans up any state that it introduces.',
-          ' A Mocha::StubbingError will be raised in this scenario in the future.'
-        )
-      end
+      return unless @expired
+
+      sentences = [
+        "#{mocha_inspect} was instantiated in one test but it is receiving invocations within another test.",
+        'This can lead to unintended interactions between tests and hence unexpected test failures.',
+        'Ensure that every test correctly cleans up any state that it introduces.'
+      ]
+      raise StubbingError.new(sentences.join(' '), caller)
     end
   end
 end

data/lib/mocha/parameter_matchers/base.rb

@@ -3,7 +3,7 @@ module Mocha
     # @abstract Subclass and implement +#matches?+ and +#mocha_inspect+ to define a custom matcher. Also add a suitably named instance method to {ParameterMatchers} to build an instance of the new matcher c.f. {#equals}.
     class Base
       # @private
-      def to_matcher
+      def to_matcher(_expectation = nil)
         self
       end
 

data/lib/mocha/parameter_matchers/equivalent_uri.rb

@@ -1,4 +1,3 @@
-require 'mocha/deprecation'
 require 'mocha/parameter_matchers/base'
 require 'uri'
 require 'cgi'

data/lib/mocha/parameter_matchers/instance_methods.rb

@@ -1,11 +1,12 @@
 require 'mocha/parameter_matchers/equals'
+require 'mocha/parameter_matchers/positional_or_keyword_hash'
 
 module Mocha
   module ParameterMatchers
     # @private
     module InstanceMethods
       # @private
-      def to_matcher
+      def to_matcher(_expectation = nil)
         Mocha::ParameterMatchers::Equals.new(self)
       end
     end
@@ -16,3 +17,11 @@ end
 class Object
   include Mocha::ParameterMatchers::InstanceMethods
 end
+
+# @private
+class Hash
+  # @private
+  def to_matcher(expectation = nil)
+    Mocha::ParameterMatchers::PositionalOrKeywordHash.new(self, expectation)
+  end
+end

data/lib/mocha/parameter_matchers/positional_or_keyword_hash.rb

@@ -0,0 +1,64 @@
+require 'mocha/configuration'
+require 'mocha/deprecation'
+require 'mocha/parameter_matchers/base'
+
+module Mocha
+  module ParameterMatchers
+    # @private
+    class PositionalOrKeywordHash < Base
+      def initialize(value, expectation)
+        @value = value
+        @expectation = expectation
+      end
+
+      def matches?(available_parameters)
+        parameter, is_last_parameter = extract_parameter(available_parameters)
+        return false unless parameter == @value
+
+        if is_last_parameter && !same_type_of_hash?(parameter, @value)
+          return false if Mocha.configuration.strict_keyword_argument_matching?
+
+          deprecation_warning(parameter, @value) if Mocha::RUBY_V27_PLUS
+        end
+
+        true
+      end
+
+      def mocha_inspect
+        @value.mocha_inspect
+      end
+
+      private
+
+      def extract_parameter(available_parameters)
+        [available_parameters.shift, available_parameters.empty?]
+      end
+
+      def same_type_of_hash?(actual, expected)
+        ruby2_keywords_hash?(actual) == ruby2_keywords_hash?(expected)
+      end
+
+      def deprecation_warning(actual, expected)
+        details1 = "Expectation #{expectation_definition} expected #{hash_type(expected)} (#{expected.mocha_inspect}),".squeeze(' ')
+        details2 = "but received #{hash_type(actual)} (#{actual.mocha_inspect})."
+        sentence1 = 'These will stop matching when strict keyword argument matching is enabled.'
+        sentence2 = 'See the documentation for Mocha::Configuration#strict_keyword_argument_matching=.'
+        Deprecation.warning([details1, details2, sentence1, sentence2].join(' '))
+      end
+
+      def hash_type(hash)
+        ruby2_keywords_hash?(hash) ? 'keyword arguments' : 'positional hash'
+      end
+
+      def ruby2_keywords_hash?(hash)
+        hash.is_a?(Hash) && ::Hash.ruby2_keywords_hash?(hash)
+      end
+
+      def expectation_definition
+        return nil unless @expectation
+
+        "defined at #{@expectation.definition_location}"
+      end
+    end
+  end
+end

data/lib/mocha/parameters_matcher.rb

@@ -3,8 +3,9 @@ require 'mocha/parameter_matchers'
 
 module Mocha
   class ParametersMatcher
-    def initialize(expected_parameters = [ParameterMatchers::AnyParameters.new], &matching_block)
+    def initialize(expected_parameters = [ParameterMatchers::AnyParameters.new], expectation = nil, &matching_block)
       @expected_parameters = expected_parameters
+      @expectation = expectation
       @matching_block = matching_block
     end
 
@@ -23,12 +24,11 @@ module Mocha
     def mocha_inspect
       signature = matchers.mocha_inspect
       signature = signature.gsub(/^\[|\]$/, '')
-      signature = signature.gsub(/^\{|\}$/, '') if matchers.length == 1
       "(#{signature})"
     end
 
     def matchers
-      @expected_parameters.map(&:to_matcher)
+      @expected_parameters.map { |p| p.to_matcher(@expectation) }
     end
   end
 end

data/lib/mocha/ruby_version.rb

@@ -1,11 +1,3 @@
-require 'mocha/deprecation'
-
 module Mocha
-  RUBY_V2_PLUS = Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2')
-
-  unless RUBY_V2_PLUS
-    Mocha::Deprecation.warning(
-      'Versions of Ruby earlier than v2.0 will not be supported in future versions of Mocha.'
-    )
-  end
+  RUBY_V27_PLUS = Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.7')
 end

data/lib/mocha/stubbed_method.rb

@@ -1,3 +1,4 @@
+require 'ruby2_keywords'
 require 'mocha/ruby_version'
 
 module Mocha
@@ -20,7 +21,6 @@ module Mocha
 
     def unstub
       remove_new_method
-      restore_original_method
       mock.unstub(method_name.to_sym)
       return if mock.any_expectations?
       reset_mocha
@@ -37,20 +37,7 @@ module Mocha
     def hide_original_method
       return unless original_method_owner.__method_exists__?(method_name)
       store_original_method_visibility
-      if use_prepended_module_for_stub_method?
-        use_prepended_module_for_stub_method
-      else
-        begin
-          store_original_method
-        # rubocop:disable Lint/HandleExceptions
-        rescue NameError
-          # deal with nasties like ActiveRecord::Associations::AssociationProxy
-        end
-        # rubocop:enable Lint/HandleExceptions
-        if stub_method_overwrites_original_method?
-          remove_original_method_from_stubbee
-        end
-      end
+      use_prepended_module_for_stub_method
     end
 
     def define_new_method
@@ -59,6 +46,7 @@ module Mocha
       stub_method_owner.send(:define_method, method_name) do |*args, &block|
         self_in_scope.mock.handle_method_call(method_name_in_scope, args, block)
       end
+      stub_method_owner.send(:ruby2_keywords, method_name)
       retain_original_visibility(stub_method_owner)
     end
 
@@ -66,18 +54,6 @@ module Mocha
       stub_method_owner.send(:remove_method, method_name)
     end
 
-    def store_original_method
-      @original_method = stubbee_method(method_name)
-    end
-
-    def restore_original_method
-      return if use_prepended_module_for_stub_method?
-      if stub_method_overwrites_original_method?
-        original_method_owner.send(:define_method, method_name, @original_method)
-      end
-      retain_original_visibility(original_method_owner)
-    end
-
     def matches?(other)
       return false unless other.class == self.class
       (stubbee.object_id == other.stubbee.object_id) && (method_name == other.method_name)
@@ -100,18 +76,6 @@ module Mocha
       @original_visibility = original_method_owner.__method_visibility__(method_name)
     end
 
-    def stub_method_overwrites_original_method?
-      @original_method && @original_method.owner == original_method_owner
-    end
-
-    def remove_original_method_from_stubbee
-      original_method_owner.send(:remove_method, method_name)
-    end
-
-    def use_prepended_module_for_stub_method?
-      RUBY_V2_PLUS
-    end
-
     def use_prepended_module_for_stub_method
       @stub_method_owner = PrependedModule.new
       original_method_owner.__send__ :prepend, @stub_method_owner

data/lib/mocha/test_unit.rb

@@ -1,9 +1,6 @@
 require 'mocha/ruby_version'
 require 'mocha/integration/test_unit'
-require 'mocha/deprecation'
 
 unless Mocha::Integration::TestUnit.activate
-  Mocha::Deprecation.warning(
-    "Test::Unit must be loaded *before* `require 'mocha/test_unit'`."
-  )
+  raise "Test::Unit must be loaded *before* `require 'mocha/test_unit'`."
 end

data/lib/mocha/version.rb

@@ -1,3 +1,3 @@
 module Mocha
-  VERSION = '1.15.0'.freeze
+  VERSION = '2.0.0.alpha.1'.freeze
 end

data/mocha.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.name = 'mocha'
   s.version = Mocha::VERSION
   s.licenses = ['MIT', 'BSD-2-Clause']
-  s.required_ruby_version = '>= 1.9'
+  s.required_ruby_version = '>= 2.0'
 
   s.authors = ['James Mead']
   s.description = 'Mocking and stubbing library with JMock/SchMock syntax, which allows mocking and stubbing of methods on real (non-mock) classes.'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mocha
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 2.0.0.alpha.1
 platform: ruby
 authors:
 - James Mead
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-21 00:00:00.000000000 Z
+date: 2022-10-18 00:00:00.000000000 Z
 dependencies: []
 description: Mocking and stubbing library with JMock/SchMock syntax, which allows
   mocking and stubbing of methods on real (non-mock) classes.
@@ -31,7 +31,6 @@ files:
 - Rakefile
 - gemfiles/Gemfile.minitest.latest
 - gemfiles/Gemfile.test-unit.latest
-- init.rb
 - lib/mocha.rb
 - lib/mocha/any_instance_method.rb
 - lib/mocha/api.rb
@@ -57,30 +56,13 @@ files:
 - lib/mocha/in_state_ordering_constraint.rb
 - lib/mocha/inspect.rb
 - lib/mocha/instance_method.rb
-- lib/mocha/integration.rb
 - lib/mocha/integration/assertion_counter.rb
 - lib/mocha/integration/mini_test.rb
 - lib/mocha/integration/mini_test/adapter.rb
 - lib/mocha/integration/mini_test/exception_translation.rb
-- lib/mocha/integration/mini_test/nothing.rb
-- lib/mocha/integration/mini_test/version_13.rb
-- lib/mocha/integration/mini_test/version_140.rb
-- lib/mocha/integration/mini_test/version_141.rb
-- lib/mocha/integration/mini_test/version_142_to_172.rb
-- lib/mocha/integration/mini_test/version_200.rb
-- lib/mocha/integration/mini_test/version_201_to_222.rb
-- lib/mocha/integration/mini_test/version_2110_to_2111.rb
-- lib/mocha/integration/mini_test/version_2112_to_320.rb
-- lib/mocha/integration/mini_test/version_230_to_2101.rb
 - lib/mocha/integration/monkey_patcher.rb
 - lib/mocha/integration/test_unit.rb
 - lib/mocha/integration/test_unit/adapter.rb
-- lib/mocha/integration/test_unit/gem_version_200.rb
-- lib/mocha/integration/test_unit/gem_version_201_to_202.rb
-- lib/mocha/integration/test_unit/gem_version_203_to_220.rb
-- lib/mocha/integration/test_unit/gem_version_230_to_250.rb
-- lib/mocha/integration/test_unit/nothing.rb
-- lib/mocha/integration/test_unit/ruby_version_186_and_above.rb
 - lib/mocha/invocation.rb
 - lib/mocha/is_a.rb
 - lib/mocha/logger.rb
@@ -112,6 +94,7 @@ files:
 - lib/mocha/parameter_matchers/kind_of.rb
 - lib/mocha/parameter_matchers/not.rb
 - lib/mocha/parameter_matchers/optionally.rb
+- lib/mocha/parameter_matchers/positional_or_keyword_hash.rb
 - lib/mocha/parameter_matchers/regexp_matches.rb
 - lib/mocha/parameter_matchers/responds_with.rb
 - lib/mocha/parameter_matchers/yaml_equivalent.rb
@@ -121,7 +104,6 @@ files:
 - lib/mocha/return_values.rb
 - lib/mocha/ruby_version.rb
 - lib/mocha/sequence.rb
-- lib/mocha/setup.rb
 - lib/mocha/single_return_value.rb
 - lib/mocha/state_machine.rb
 - lib/mocha/stubbed_method.rb
@@ -139,7 +121,7 @@ licenses:
 - MIT
 - BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -147,15 +129,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Mocking and stubbing library
 test_files: []

data/init.rb

@@ -1 +0,0 @@
-warn 'Mocha deprecation warning: The old-style Rails plugin will not be supported in future versions of Mocha.'

data/lib/mocha/integration/mini_test/nothing.rb

@@ -1,19 +0,0 @@
-module Mocha
-  module Integration
-    module MiniTest
-      module Nothing
-        def self.applicable_to?(_test_unit_version, _ruby_version = nil)
-          true
-        end
-
-        def self.description
-          'nothing (no MiniTest integration available)'
-        end
-
-        def self.included(_mod)
-          raise 'No MiniTest integration available'
-        end
-      end
-    end
-  end
-end

data/lib/mocha/integration/mini_test/version_13.rb

@@ -1,54 +0,0 @@
-require 'mocha/integration/assertion_counter'
-require 'mocha/integration/monkey_patcher'
-require 'mocha/integration/mini_test/exception_translation'
-
-module Mocha
-  module Integration
-    module MiniTest
-      module Version13
-        def self.applicable_to?(mini_test_version)
-          Gem::Requirement.new('>= 1.3.0', '<= 1.3.1').satisfied_by?(mini_test_version)
-        end
-
-        def self.description
-          'monkey patch for MiniTest gem v1.3'
-        end
-
-        def self.included(mod)
-          MonkeyPatcher.apply(mod, RunMethodPatch)
-        end
-
-        module RunMethodPatch
-          # rubocop:disable all
-          def run runner
-            assertion_counter = AssertionCounter.new(self)
-            result = '.'
-            begin
-              begin
-                @passed = nil
-                mocha_setup
-                self.setup
-                self.__send__ self.name
-                mocha_verify(assertion_counter)
-                @passed = true
-              rescue Exception => e
-                @passed = false
-                result = runner.puke(self.class, self.name, Mocha::Integration::MiniTest.translate(e))
-              ensure
-                begin
-                  self.teardown
-                rescue Exception => e
-                  result = runner.puke(self.class, self.name, Mocha::Integration::MiniTest.translate(e))
-                end
-              end
-            ensure
-              mocha_teardown
-            end
-            result
-          end
-          # rubocop:enable all
-        end
-      end
-    end
-  end
-end

data/lib/mocha/integration/mini_test/version_140.rb

@@ -1,54 +0,0 @@
-require 'mocha/integration/assertion_counter'
-require 'mocha/integration/monkey_patcher'
-require 'mocha/integration/mini_test/exception_translation'
-
-module Mocha
-  module Integration
-    module MiniTest
-      module Version140
-        def self.applicable_to?(mini_test_version)
-          Gem::Requirement.new('1.4.0').satisfied_by?(mini_test_version)
-        end
-
-        def self.description
-          'monkey patch for MiniTest gem v1.4.0'
-        end
-
-        def self.included(mod)
-          MonkeyPatcher.apply(mod, RunMethodPatch)
-        end
-
-        module RunMethodPatch
-          # rubocop:disable all
-          def run runner
-            assertion_counter = AssertionCounter.new(self)
-            result = '.'
-            begin
-              begin
-                @passed = nil
-                mocha_setup
-                self.setup
-                self.__send__ self.__name__
-                mocha_verify(assertion_counter)
-                @passed = true
-              rescue Exception => e
-                @passed = false
-                result = runner.puke(self.class, self.__name__, Mocha::Integration::MiniTest.translate(e))
-              ensure
-                begin
-                  self.teardown
-                rescue Exception => e
-                  result = runner.puke(self.class, self.__name__, Mocha::Integration::MiniTest.translate(e))
-                end
-              end
-            ensure
-              mocha_teardown
-            end
-            result
-          end
-          # rubocop:enable all
-        end
-      end
-    end
-  end
-end