mocha 2.0.0.alpha → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69781697a086ec84aecb54fa1f63dff7842796caa275af3f01e82695e7187b0d
-  data.tar.gz: f0aa6493ffccdeeb7f48b0aa8a329ba57612c4c01470642b0df8f23392857534
+  metadata.gz: 4f52376e6c8b1042085cca75e7d22e0241452dca80e73de22510f39a83041030
+  data.tar.gz: aa4584255d27f58ee1e9c18935921e352044ac8c2cc91d97221d280e21c54b29
 SHA512:
-  metadata.gz: ddc7f9eab0a9506cc0e5a69ffc0bbc359d68c4e19f2c2cd207554d2b264854f77a38bed9fa7df6f0ac110b25cf26aaa9315ec092d709a0d2cdc8ec610c3cc2fc
-  data.tar.gz: 7b20ce12545006706f32ff11863802dd31fe4c766925e7ca2bd63828f8dc78e98cb692d9bf5558e6ea6f401929be236c52183bc42ecfff05a752c002d9414c2c
+  metadata.gz: d23cc4f2cb0ffcf1464103c1bca607d8a2fac7fef3592dc4637d25ed72dbfd91f5d7234c9f4df23f1c27248829b6638013396e780212f41d9a44236b7a95bd16
+  data.tar.gz: efbcf261aab3292625c56f9f8cab796a19b4dc1ac474a64041ee1a6a92e72c4941b1ce0a0299322e682607d8e8c92598da7ffe853de1257cd92f49027b0891d4

data/.rubocop.yml

@@ -48,6 +48,10 @@ Style/WhileUntilModifier:
 Style/AccessModifierDeclarations:
   Enabled: false
 
+# This is useful when using `ExecutionPoint.current` to make tests more robust
+Style/Semicolon:
+  Enabled: false
+
 # Enabling this cop results in an "Infinite loop detected" exception
 Layout/AccessModifierIndentation:
   Enabled: false

data/README.md

@@ -302,6 +302,12 @@ See the [documentation](https://mocha.jamesmead.org/Mocha/Configuration.html) fo
 Only the following values are currently recognized and have an effect:
 * `debug`: Enables a debug mode which will output backtraces for each deprecation warning. This is useful for finding where in the test suite the deprecated calls are.
 
+### Semantic versioning
+
+* Every effort is made to comply with [semantic versioning](https://semver.org/).
+* However, this only applies to the behaviour documented in the public API.
+* The documented public API does *not* include the content or format of messsages displayed to the user, e.g. assertion failure messages.
+
 ### Useful Links
 
 * [Official Documentation](https://mocha.jamesmead.org)

data/RELEASE.md

@@ -1,6 +1,6 @@
 # Release Notes
 
-## 2.0.0.alpha
+## 2.0.0
 
 ### External changes
 
@@ -19,6 +19,8 @@ from the Ruby v1.8 standard library are no longer supported (#540,969f4845)
 * Expand `Expectation#with` docs re keyword arguments (fed6808d)
 * Improve docs for `strict_keyword_argument_matching` (8d8f881d)
 * Remove deprecated Rails plugin `init.rb` file (1c617175)
+* Improve strict keyword argument matching deprecation warning by including the source location of the stub definition (77c0d4cc)
+* Add README section re semantic versioning (00758246)
 
 ### Internal changes
 
@@ -31,6 +33,18 @@ from the Ruby v1.8 standard library are no longer supported (#540,969f4845)
 * More consistent Test::Unit & Minitest integration (27dd3817)
 * Remove redundant `require` statements (d82218a8,fa17b114)
 * Add missing `require` statement (73493761)
+* Disable Style/Semicolon cop globally (8cd0b705)
+
+## 1.16.0
+
+### External changes
+
+* Default `Configuration#reinstate_undocumented_behaviour_from_v1_9=` to `false` (6fcaf947)
+* Deprecate `Configuration#reinstate_undocumented_behaviour_from_v1_9=` (a797c5fd)
+
+### Internal changes
+
+* Remove redundant deprecation disabling in MockTest (dc8ca969)
 
 ## 1.15.0
 

data/lib/mocha/configuration.rb

@@ -252,11 +252,11 @@ module Mocha
 
     # 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 false negatives 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. This is because {#strict_keyword_argument_matching=} will default to +true+ in the future.
+    # 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. This is because {#strict_keyword_argument_matching=} will default to +true+ in the future.
     #
     # 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#has_value} or {ParameterMatchers#has_key} will still treat a positional +Hash+ and a set of keyword arguments the same, so false negatives are still possible when they are used.
+    # Note that +Hash+-related matchers such as {ParameterMatchers#has_value} or {ParameterMatchers#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 to enable gradual adoption, but will be +true+ by default in the future.
     #

data/lib/mocha/expectation.rb

@@ -12,6 +12,7 @@ require 'mocha/change_state_side_effect'
 require 'mocha/cardinality'
 require 'mocha/configuration'
 require 'mocha/block_matcher'
+require 'mocha/backtrace_filter'
 
 module Mocha
   # Methods on expectations returned from {Mock#expects}, {Mock#stubs}, {ObjectMethods#expects} and {ObjectMethods#stubs}.
@@ -266,7 +267,7 @@ module Mocha
     #   object.expected_method(17)
     #   # => verify fails
     def with(*expected_parameters_or_matchers, &matching_block)
-      @parameters_matcher = ParametersMatcher.new(expected_parameters_or_matchers, &matching_block)
+      @parameters_matcher = ParametersMatcher.new(expected_parameters_or_matchers, self, &matching_block)
       self
     end
     ruby2_keywords(:with)
@@ -692,5 +693,11 @@ module Mocha
       signature << " #{@block_matcher.mocha_inspect}" if @block_matcher.mocha_inspect
       signature
     end
+
+    # @private
+    def definition_location
+      filter = BacktraceFilter.new
+      filter.filtered(backtrace)[0]
+    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/instance_methods.rb

@@ -6,7 +6,7 @@ module Mocha
     # @private
     module InstanceMethods
       # @private
-      def to_matcher
+      def to_matcher(_expectation = nil)
         Mocha::ParameterMatchers::Equals.new(self)
       end
     end
@@ -21,7 +21,7 @@ end
 # @private
 class Hash
   # @private
-  def to_matcher
-    Mocha::ParameterMatchers::PositionalOrKeywordHash.new(self)
+  def to_matcher(expectation = nil)
+    Mocha::ParameterMatchers::PositionalOrKeywordHash.new(self, expectation)
   end
 end

data/lib/mocha/parameter_matchers/positional_or_keyword_hash.rb

@@ -6,8 +6,9 @@ module Mocha
   module ParameterMatchers
     # @private
     class PositionalOrKeywordHash < Base
-      def initialize(value)
+      def initialize(value, expectation)
         @value = value
+        @expectation = expectation
       end
 
       def matches?(available_parameters)
@@ -38,10 +39,11 @@ module Mocha
       end
 
       def deprecation_warning(actual, expected)
-        details = "Expected #{hash_type(expected)} (#{expected.mocha_inspect}), but received #{hash_type(actual)} (#{actual.mocha_inspect})."
+        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([details, sentence1, sentence2].join(' '))
+        Deprecation.warning([details1, details2, sentence1, sentence2].join(' '))
       end
 
       def hash_type(hash)
@@ -51,6 +53,12 @@ module Mocha
       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
 
@@ -27,7 +28,7 @@ module Mocha
     end
 
     def matchers
-      @expected_parameters.map(&:to_matcher)
+      @expected_parameters.map { |p| p.to_matcher(@expectation) }
     end
   end
 end

data/lib/mocha/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mocha
 version: !ruby/object:Gem::Version
-  version: 2.0.0.alpha
+  version: 2.0.0
 platform: ruby
 authors:
 - James Mead
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-17 00:00:00.000000000 Z
+date: 2022-11-01 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.
@@ -132,9 +132,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.3
 signing_key: