mocha 2.8.2 → 3.0.0.pre.rc.1

data/lib/mocha/parameter_matchers/positional_or_keyword_hash.rb

@@ -1,42 +1,64 @@
+# frozen_string_literal: true
+
 require 'mocha/configuration'
 require 'mocha/deprecation'
+require 'mocha/ruby_version'
 require 'mocha/parameter_matchers/base'
 require 'mocha/parameter_matchers/has_entries'
-require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
     # @private
     class PositionalOrKeywordHash
-      include BaseMethods
+      include Base
 
-      def initialize(value, expectation)
-        @value = value
+      def initialize(expected_value, expectation, last_expected_value)
+        @expected_value = expected_value
         @expectation = expectation
+        @last_expected_value = last_expected_value
       end
 
-      def matches?(available_parameters)
-        parameter, is_last_parameter = extract_parameter(available_parameters)
-
-        return false unless HasEntries.new(@value, exact: true).matches?([parameter])
-
-        if is_last_parameter && !same_type_of_hash?(parameter, @value)
-          return false if Mocha.configuration.strict_keyword_argument_matching?
+      def matches?(actual_values)
+        actual_value, is_last_actual_value = extract_actual_value(actual_values)
 
-          deprecation_warning(parameter, @value) if Mocha::RUBY_V27_PLUS
+        if !matches_entries_exactly?(actual_value)
+          false
+        elsif is_last_actual_value
+          matches_last_actual_value?(actual_value)
+        else
+          true
         end
-
-        true
       end
 
       def mocha_inspect
-        @value.mocha_inspect
+        @expected_value.mocha_inspect
       end
 
       private
 
-      def extract_parameter(available_parameters)
-        [available_parameters.shift, available_parameters.empty?]
+      def matches_entries_exactly?(actual_value)
+        HasEntries.new(@expected_value, exact: true).matches?([actual_value])
+      end
+
+      def matches_last_actual_value?(actual_value)
+        if same_type_of_hash?(actual_value, @expected_value)
+          true
+        elsif last_expected_value_is_positional_hash? # rubocop:disable Lint/DuplicateBranch
+          true
+        elsif Mocha.configuration.strict_keyword_argument_matching?
+          false
+        else
+          deprecation_warning(actual_value, @expected_value) if Mocha::RUBY_V27_PLUS
+          true
+        end
+      end
+
+      def last_expected_value_is_positional_hash?
+        @last_expected_value && !ruby2_keywords_hash?(@expected_value)
+      end
+
+      def extract_actual_value(actual_values)
+        [actual_values.shift, actual_values.empty?]
       end
 
       def same_type_of_hash?(actual, expected)
@@ -65,7 +87,5 @@ module Mocha
         "defined at #{@expectation.definition_location}"
       end
     end
-
-    provide_deprecated_access_to(:PositionalOrKeywordHash)
   end
 end

data/lib/mocha/parameter_matchers/regexp_matches.rb

@@ -1,38 +1,35 @@
+# frozen_string_literal: true
+
 require 'mocha/parameter_matchers/base'
-require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    module Methods
-      # Matches any object that matches +regexp+.
-      #
-      # @param [Regexp] regexp regular expression to match.
-      # @return [RegexpMatches] parameter matcher.
-      #
-      # @see Expectation#with
-      #
-      # @example Actual parameter is matched by specified regular expression.
-      #   object = mock()
-      #   object.expects(:method_1).with(regexp_matches(/e/))
-      #   object.method_1('hello')
-      #   # no error raised
-      #
-      # @example Actual parameter is not matched by specified regular expression.
-      #   object = mock()
-      #   object.expects(:method_1).with(regexp_matches(/a/))
-      #   object.method_1('hello')
-      #   # error raised, because method_1 was not called with a parameter that matched the
-      #   # regular expression
-      def regexp_matches(regexp)
-        RegexpMatches.new(regexp)
-      end
+    # Matches any object that matches +regexp+.
+    #
+    # @param [Regexp] regexp regular expression to match.
+    # @return [RegexpMatches] parameter matcher.
+    #
+    # @see Expectation#with
+    #
+    # @example Actual parameter is matched by specified regular expression.
+    #   object = mock()
+    #   object.expects(:method_1).with(regexp_matches(/e/))
+    #   object.method_1('hello')
+    #   # no error raised
+    #
+    # @example Actual parameter is not matched by specified regular expression.
+    #   object = mock()
+    #   object.expects(:method_1).with(regexp_matches(/a/))
+    #   object.method_1('hello')
+    #   # error raised, because method_1 was not called with a parameter that matched the
+    #   # regular expression
+    def regexp_matches(regexp)
+      RegexpMatches.new(regexp)
     end
 
-    define_deprecated_matcher_method(:regexp_matches)
-
     # Parameter matcher which matches if specified regular expression matches actual paramter.
     class RegexpMatches
-      include BaseMethods
+      include Base
 
       # @private
       def initialize(regexp)
@@ -43,6 +40,7 @@ module Mocha
       def matches?(available_parameters)
         parameter = available_parameters.shift
         return false unless parameter.respond_to?(:=~)
+
         parameter =~ @regexp
       end
 
@@ -51,7 +49,5 @@ module Mocha
         "regexp_matches(#{@regexp.mocha_inspect})"
       end
     end
-
-    provide_deprecated_access_to(:RegexpMatches)
   end
 end

data/lib/mocha/parameter_matchers/responds_with.rb

@@ -1,66 +1,63 @@
+# frozen_string_literal: true
+
 require 'mocha/parameter_matchers/base'
 require 'mocha/parameter_matchers/all_of'
-require 'mocha/parameter_matchers/deprecations'
 require 'yaml'
 
 module Mocha
   module ParameterMatchers
-    module Methods
-      # @overload def responds_with(message, result)
-      #   Matches any object that responds to +message+ with +result+. To put it another way, it tests the quack, not the duck.
-      #   @param [Symbol] message method to invoke.
-      #   @param [Object] result expected result of sending +message+.
-      # @overload def responds_with(messages_vs_results)
-      #   Matches any object that responds to all the messages with the corresponding results as specified by +messages_vs_results+.
-      #   @param [Hash<Symbol,Object>] messages_vs_results +Hash+ of messages vs results.
-      #   @raise [ArgumentError] if +messages_vs_results+ does not contain at least one entry.
-      #
-      # @return [RespondsWith] parameter matcher.
-      #
-      # @see Expectation#with
-      #
-      # @example Actual parameter responds with "FOO" when :upcase is invoked.
-      #   object = mock()
-      #   object.expects(:method_1).with(responds_with(:upcase, "FOO"))
-      #   object.method_1("foo")
-      #   # no error raised, because "foo".upcase == "FOO"
-      #
-      # @example Actual parameter does not respond with "FOO" when :upcase is invoked.
-      #   object = mock()
-      #   object.expects(:method_1).with(responds_with(:upcase, "BAR"))
-      #   object.method_1("foo")
-      #   # error raised, because "foo".upcase != "BAR"
-      #
-      # @example Actual parameter responds with "FOO" when :upcase is invoked and "oof" when :reverse is invoked.
-      #   object = mock()
-      #   object.expects(:method_1).with(responds_with(upcase: "FOO", reverse: "oof"))
-      #   object.method_1("foo")
-      #   # no error raised, because "foo".upcase == "FOO" and "foo".reverse == "oof"
-      def responds_with(*options)
-        case options.length
-        when 0
-          raise ArgumentError, 'No arguments. Expecting at least one.'
-        when 1
-          option = options.first
-          raise ArgumentError, 'Argument is not a Hash.' unless option.is_a?(Hash)
-          raise ArgumentError, 'Argument has no entries.' if option.empty?
+    # @overload def responds_with(message, result)
+    #   Matches any object that responds to +message+ with +result+. To put it another way, it tests the quack, not the duck.
+    #   @param [Symbol] message method to invoke.
+    #   @param [Object] result expected result of sending +message+.
+    # @overload def responds_with(messages_vs_results)
+    #   Matches any object that responds to all the messages with the corresponding results as specified by +messages_vs_results+.
+    #   @param [Hash<Symbol,Object>] messages_vs_results +Hash+ of messages vs results.
+    #   @raise [ArgumentError] if +messages_vs_results+ does not contain at least one entry.
+    #
+    # @return [RespondsWith] parameter matcher.
+    #
+    # @see Expectation#with
+    #
+    # @example Actual parameter responds with "FOO" when :upcase is invoked.
+    #   object = mock()
+    #   object.expects(:method_1).with(responds_with(:upcase, "FOO"))
+    #   object.method_1("foo")
+    #   # no error raised, because "foo".upcase == "FOO"
+    #
+    # @example Actual parameter does not respond with "FOO" when :upcase is invoked.
+    #   object = mock()
+    #   object.expects(:method_1).with(responds_with(:upcase, "BAR"))
+    #   object.method_1("foo")
+    #   # error raised, because "foo".upcase != "BAR"
+    #
+    # @example Actual parameter responds with "FOO" when :upcase is invoked and "oof" when :reverse is invoked.
+    #   object = mock()
+    #   object.expects(:method_1).with(responds_with(upcase: "FOO", reverse: "oof"))
+    #   object.method_1("foo")
+    #   # no error raised, because "foo".upcase == "FOO" and "foo".reverse == "oof"
+    def responds_with(*options)
+      case options.length
+      when 0
+        raise ArgumentError, 'No arguments. Expecting at least one.'
+      when 1
+        option = options.first
+        raise ArgumentError, 'Argument is not a Hash.' unless option.is_a?(Hash)
+        raise ArgumentError, 'Argument has no entries.' if option.empty?
 
-          matchers = option.map { |message, result| RespondsWith.new(message, result) }
-          AllOf.new(*matchers)
-        when 2
-          message, result = options
-          RespondsWith.new(message, result)
-        else
-          raise ArgumentError, 'Too many arguments; use either a single argument (must be a Hash) or two arguments (a message and a result).'
-        end
+        matchers = option.map { |message, result| RespondsWith.new(message, result) }
+        AllOf.new(*matchers)
+      when 2
+        message, result = options
+        RespondsWith.new(message, result)
+      else
+        raise ArgumentError, 'Too many arguments; use either a single argument (must be a Hash) or two arguments (a message and a result).'
       end
     end
 
-    define_deprecated_matcher_method(:responds_with)
-
     # Parameter matcher which matches if actual parameter returns expected result when specified method is invoked.
     class RespondsWith
-      include BaseMethods
+      include Base
 
       # @private
       def initialize(message, result)
@@ -79,7 +76,5 @@ module Mocha
         "responds_with(#{@message.mocha_inspect}, #{@result.mocha_inspect})"
       end
     end
-
-    provide_deprecated_access_to(:RespondsWith)
   end
 end

data/lib/mocha/parameter_matchers/yaml_equivalent.rb

@@ -1,38 +1,35 @@
+# frozen_string_literal: true
+
 require 'mocha/parameter_matchers/base'
-require 'mocha/parameter_matchers/deprecations'
 require 'yaml'
 
 module Mocha
   module ParameterMatchers
-    module Methods
-      # Matches any YAML that represents the specified +object+
-      #
-      # @param [Object] object object whose YAML to compare.
-      # @return [YamlEquivalent] parameter matcher.
-      #
-      # @see Expectation#with
-      #
-      # @example Actual parameter is YAML equivalent of specified +object+.
-      #   object = mock()
-      #   object.expects(:method_1).with(yaml_equivalent(1, 2, 3))
-      #   object.method_1("--- \n- 1\n- 2\n- 3\n")
-      #   # no error raised
-      #
-      # @example Actual parameter is not YAML equivalent of specified +object+.
-      #   object = mock()
-      #   object.expects(:method_1).with(yaml_equivalent(1, 2, 3))
-      #   object.method_1("--- \n- 1\n- 2\n")
-      #   # error raised, because method_1 was not called with YAML representing the specified Array
-      def yaml_equivalent(object)
-        YamlEquivalent.new(object)
-      end
+    # Matches any YAML that represents the specified +object+
+    #
+    # @param [Object] object object whose YAML to compare.
+    # @return [YamlEquivalent] parameter matcher.
+    #
+    # @see Expectation#with
+    #
+    # @example Actual parameter is YAML equivalent of specified +object+.
+    #   object = mock()
+    #   object.expects(:method_1).with(yaml_equivalent(1, 2, 3))
+    #   object.method_1("--- \n- 1\n- 2\n- 3\n")
+    #   # no error raised
+    #
+    # @example Actual parameter is not YAML equivalent of specified +object+.
+    #   object = mock()
+    #   object.expects(:method_1).with(yaml_equivalent(1, 2, 3))
+    #   object.method_1("--- \n- 1\n- 2\n")
+    #   # error raised, because method_1 was not called with YAML representing the specified Array
+    def yaml_equivalent(object)
+      YamlEquivalent.new(object)
     end
 
-    define_deprecated_matcher_method(:yaml_equivalent)
-
     # Parameter matcher which matches if actual parameter is YAML equivalent of specified object.
     class YamlEquivalent
-      include BaseMethods
+      include Base
 
       # @private
       def initialize(object)
@@ -52,7 +49,5 @@ module Mocha
         "yaml_equivalent(#{@object.mocha_inspect})"
       end
     end
-
-    provide_deprecated_access_to(:YamlEquivalent)
   end
 end

data/lib/mocha/parameter_matchers.rb

@@ -1,12 +1,10 @@
+# frozen_string_literal: true
+
 module Mocha
-  # Matcher classes used as parameters for {Expectation#with} to restrict the parameter values which will match the expectation. Can be nested. Build matcher instances in tests using methods in {Methods}, e.g. {Methods#includes}.
-  module ParameterMatchers
-    # These methods build instances of the {ParameterMatchers} classes which are used with {Expectation#with} to restrict the parameter values. Can be nested, e.g. see {Methods#all_of} examples.
-    module Methods; end
-  end
+  # Used as parameters for {Expectation#with} to restrict the parameter values which will match the expectation. Can be nested.
+  module ParameterMatchers; end
 end
 
-require 'mocha/parameter_matchers/deprecations'
 require 'mocha/parameter_matchers/instance_methods'
 
 require 'mocha/parameter_matchers/all_of'

data/lib/mocha/parameters_matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mocha/inspect'
 require 'mocha/parameter_matchers'
 
@@ -32,7 +34,13 @@ module Mocha
     end
 
     def matchers
-      @expected_parameters.map { |p| p.to_matcher(expectation: @expectation, top_level: true) }
+      @expected_parameters.map.with_index do |parameter, index|
+        parameter.to_matcher(
+          expectation: @expectation,
+          top_level: true,
+          last: index == @expected_parameters.length - 1
+        )
+      end
     end
   end
 end

data/lib/mocha/raised_exception.rb

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

data/lib/mocha/return_values.rb

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

data/lib/mocha/ruby_version.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module Mocha
   RUBY_V27_PLUS = Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.7')
+  RUBY_V30_PLUS = Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('3.0')
   RUBY_V34_PLUS = Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('3.4')
 end

data/lib/mocha/sequence.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mocha
   # Used to constrain the order in which expectations can occur.
   #

data/lib/mocha/single_return_value.rb

@@ -1,4 +1,4 @@
-require 'mocha/is_a'
+# frozen_string_literal: true
 
 module Mocha
   class SingleReturnValue

data/lib/mocha/state_machine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mocha
   # A state machine that is used to constrain the order of invocations.
   # An invocation can be constrained to occur when a state {#is}, or {#is_not}, active.

data/lib/mocha/stubbed_method.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ruby2_keywords'
 require 'mocha/ruby_version'
 
@@ -23,6 +25,7 @@ module Mocha
       remove_new_method
       mock.unstub(method_name.to_sym)
       return if mock.any_expectations?
+
       reset_mocha
     end
 
@@ -36,6 +39,7 @@ module Mocha
 
     def hide_original_method
       return unless original_method_owner.__method_exists__?(method_name)
+
       store_original_method_visibility
       use_prepended_module_for_stub_method
     end
@@ -55,8 +59,10 @@ module Mocha
     end
 
     def matches?(other)
-      return false unless other.class == self.class
-      (stubbee.object_id == other.stubbee.object_id) && (method_name == other.method_name)
+      return false unless other.instance_of?(self.class)
+
+      (stubbee.object_id == other.stubbee.object_id) && # rubocop:disable Lint/IdentityComparison
+        (method_name == other.method_name)
     end
 
     alias_method :==, :eql?
@@ -69,6 +75,7 @@ module Mocha
 
     def retain_original_visibility(method_owner)
       return unless @original_visibility
+
       Module.instance_method(@original_visibility).bind(method_owner).call(method_name)
     end
 

data/lib/mocha/stubbing_error.rb

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

data/lib/mocha/test_unit.rb

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

data/lib/mocha/thrower.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mocha
   class Thrower
     def initialize(tag, object = nil)

data/lib/mocha/thrown_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mocha
   class ThrownObject
     def initialize(tag, value = nil)

data/lib/mocha/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mocha
-  VERSION = '2.8.2'.freeze
+  VERSION = '3.0.0-rc.1'
 end

data/lib/mocha/yield_parameters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mocha
   class YieldParameters
     def initialize

data/lib/mocha.rb

@@ -1 +1,6 @@
+# frozen_string_literal: true
+
 require 'mocha/version'
+
+module Mocha
+end

data/mocha.gemspec

@@ -2,14 +2,19 @@ lib = File.expand_path('../lib/', __FILE__)
 $LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
 require 'mocha/version'
 
+DESCRIPTION =
+  'A library for mocking and stubbing with a unified, simple and readable syntax ' \
+  'for both full & partial mocking. Built-in support for Minitest and Test::Unit. ' \
+  'Supported by many other test frameworks, e.g. RSpec.'.freeze
+
 Gem::Specification.new do |s|
   s.name = 'mocha'
   s.version = Mocha::VERSION
   s.licenses = ['MIT', 'BSD-2-Clause']
-  s.required_ruby_version = '>= 2.1'
+  s.required_ruby_version = '>= 2.2'
 
   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.'
+  s.description = DESCRIPTION
   s.email = 'mocha-developer@googlegroups.com'
 
   s.files = Dir.chdir(File.expand_path('..', __FILE__)) do
@@ -27,8 +32,9 @@ Gem::Specification.new do |s|
     'documentation_uri' => 'https://mocha.jamesmead.org/',
     'funding_uri' => 'https://github.com/sponsors/floehopper',
     'homepage_uri' => s.homepage,
-    'source_code_uri' => 'https://github.com/freerange/mocha'
+    'source_code_uri' => 'https://github.com/freerange/mocha',
+    'rubygems_mfa_required' => 'true'
   }
 
-  s.add_runtime_dependency 'ruby2_keywords', '>= 0.0.5'
+  s.add_dependency 'ruby2_keywords', '>= 0.0.5'
 end