mocha 3.0.0.pre.rc.1 → 3.0.0.pre.rc.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e64d5427fb1829eee6958310ca322357d6fc0a8fa0d7856ea6b616edbf326c45
-  data.tar.gz: 052c4fc645bb95c2f09f9d66e1ef6a9025aea478b90accd1fc932de0151f684b
+  metadata.gz: 89867d8324e0ff09c1b10c13bb46ecbc68215098b8abd916d5be2ebe165d91fe
+  data.tar.gz: 835f460adaa854163671e2a2222f68e8674edb1eb80d714f8e7e58ce26705391
 SHA512:
-  metadata.gz: efd275f6eb30e58383bc67037953e8f02ffa0d0d9ca920ec492267184fe6f3ac8a4765b074d39d8d3b1de38d1e11a374262e3e4a4a3b3e7ee7877f8aba0529b0
-  data.tar.gz: 22b0a2331dc25358032dd83823de41c884a752eb69e80b21befc1d79f931cee4dcc13cf5d40f04bddc3e9ef894b1d2168b90daf3fc89935ed0cd85b41e1b3611
+  metadata.gz: 4ead2dc30052a85e96ad27728852ee61c120b40229c376508595a09eeee10c863fae71644c4abe917d2a2ae400690d67fd32774a2c4dc6d79fbacc443171d55a
+  data.tar.gz: 3cc439692bc5163961fc2cd44aee804634fdb903d01b245e1101c99818f92cb760c51d3a0dd0a8927bc7c29ccf1c0c202bda4cbd70a058c1c21c1a5beb341edb

data/.rubocop.yml

@@ -1,4 +1,4 @@
-require:
+plugins:
   - rubocop-rake
 
 inherit_from: .rubocop_todo.yml
@@ -11,10 +11,10 @@ AllCops:
   TargetRubyVersion: 2.2
 
   Include:
-    - '**/Gemfile.*'
+    - "**/Gemfile.*"
 
   Exclude:
-    - '**/Gemfile*.lock'
+    - "**/Gemfile*.lock"
 
   NewCops: enable
 
@@ -72,37 +72,6 @@ Layout/LineLength:
 Gemspec/RequiredRubyVersion:
   Enabled: false
 
-# It can be useful to violate this cop in tests in order to be more explicit
-Lint/UselessTimes:
-  Exclude:
-    - 'test/**/*.rb'
-
-# It can be useful to violate this cop in tests
-Lint/EmptyClass:
-  Exclude:
-    - 'test/**/*.rb'
-
-# It can be useful to violate this cop in tests when testing methods that accept a block
-Lint/EmptyBlock:
-  Exclude:
-    - 'test/**/*.rb'
-
-# There are a mix of styles in the tests and so I don't think it's worth enforcing for now
-Naming/VariableNumber:
-  Exclude:
-    - 'test/**/*.rb'
-
-# These methods from Ruby core are legitimately overridden in the tests
-Style/OptionalBooleanParameter:
-  AllowedMethods:
-    - respond_to?
-    - public_methods
-    - protected_methods
-    - private_methods
-    - public_instance_methods
-    - protected_instance_methods
-    - private_instance_methods
-
 # This cop is useful for required environment variables, but not for optional ones
 Style/FetchEnvVar:
   AllowedVars:
@@ -110,9 +79,6 @@ Style/FetchEnvVar:
 
 Naming/FileName:
   ExpectMatchingDefinition: true
-  CheckDefinitionPathHierarchyRoots:
-    - test/unit
-    - test/acceptance
   Exclude:
     - lib/mocha/version.rb
     - lib/mocha/minitest.rb
@@ -120,3 +86,7 @@ Naming/FileName:
     - lib/mocha/ruby_version.rb
     - lib/mocha/macos_version.rb
     - test/test_helper.rb
+
+Metrics/BlockLength:
+  Exclude:
+    - "Rakefile"

data/.yardopts

@@ -1,5 +1,6 @@
 --output-dir docs
 --no-private
+lib/mocha.rb
 lib/mocha/api.rb
 lib/mocha/hooks.rb
 lib/mocha/mock.rb
@@ -15,6 +16,7 @@ lib/mocha/expectation_error_factory.rb
 lib/mocha/expectation_error.rb
 lib/mocha/stubbing_error.rb
 lib/mocha/unexpected_invocation.rb
+lib/mocha/integration.rb
 lib/mocha/integration/test_unit/adapter.rb
 lib/mocha/integration/minitest/adapter.rb
 -

data/Gemfile

@@ -3,16 +3,13 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
+  gem 'benchmark'
   gem 'introspection', '~> 0.0.1'
   gem 'minitest'
   gem 'rake'
 
-  if RUBY_ENGINE == 'jruby'
-    # Workaround for https://github.com/jruby/jruby/issues/8488
-    gem 'jar-dependencies', '~> 0.4.1'
-  end
-
   if ENV['MOCHA_GENERATE_DOCS']
+    gem 'rdoc'
     gem 'redcarpet'
     gem 'yard'
   end

data/RELEASE.md

@@ -1,5 +1,32 @@
 # Release Notes
 
+## 3.0.0-rc.2
+
+### External changes
+
+* Fix compatibility with Ruby 3.5 (#755) - thanks to @Earlopain
+* Add missing quotes to docs for `Mocha::ParameterMatchers::Methods#equivalent_uri` (#757) - thanks to @bensherman
+* Increment assertion count on never expected invocation (#763 & #764)
+* Remove deprecated `ParameterMatchers::Base` class; include `ParameterMatchers::BaseMethods` module instead (415ae768)
+* Remove deprecated `ParameterMatcher` methods now available in `ParameterMatcher::Methods` (8de49979)
+* Removed deprecated access to `ParameterMatcher` classes (6ea9e3f5)
+
+### Internal changes
+
+* Remove workaround for JRuby jar-dependencies issue (#737)
+* Add benchmark to `Gemfile` to fix warning (#733 & #740) - thanks to @nitishr
+* Add documentation coverage check (#707, #743 & #745) - thanks to @nitishr
+* Fix `Lint/LiteralAsCondition` violation (#746) - thanks to @nitishr
+* Fix rdoc-related warning when running doc rake task (#741 & #747)
+* Fail fast in CI builds on any Ruby warnings (#729 & #741) - thanks to @nitishr
+* Add `ObjectMethods#stubba_respond_to?` and use instead of `Object#respond_to?` (#713, #742 & #750) - thanks to @nitishr
+* Rename `#stubbee` -> `#stubba_object` and `#mock_owner` -> `#stubbee` (#463 & #751) - thanks to @nitishr
+* Fix `enable-frozen-string-literal` in CI build (#752) - thanks to @nitishr
+* Various rubocop fixed (#754 & #756)
+* Fix `Layout/EmptyLinesAfterModuleInclusion` violations (3f683220)
+* Auto-correct `Style/RedundantParentheses` violations (0277a592)
+* Automatically retry failed CI builds (9bbdbc66)
+
 ## 3.0.0-rc.1
 
 ### External changes
@@ -37,6 +64,21 @@ for reporting
 * Improvements to keyword argument matching tests (#730)
 * Improvements to keyword argument matcher unit test (#731)
 
+## 2.8.0
+
+Many thanks to @etiennebarrie for his help in testing v3.0.0 release candidates which led to many of these changes.
+
+### External changes
+
+* Extract `ParameterMatchers::BaseMethods` module and deprecate inheriting from `ParameterMatchers::Base` class (0ddfbe4b)
+* Move matcher builder methods into `ParameterMatchers::Methods` module and only include that module into `API` (2de41423)
+* Provide deprecated access to matcher builder methods when including `ParameterMatchers` module (299488e1)
+* Provide deprecated access to matcher classes, e.g. `ParameterMatchers::Equals`, from within tests/specs (dcced1b4)
+
+### Internal changes
+
+* Move `ParameterMatchers#parse_option` -> `HasEntry.parse_option` (9e2a6f66)
+
 ## 2.7.1
 
 ### External changes

data/Rakefile

@@ -25,7 +25,7 @@ task 'test' do
   end
 end
 
-namespace 'test' do # rubocop:disable Metrics/BlockLength
+namespace 'test' do
   desc 'Run unit tests'
   Rake::TestTask.new('units') do |t|
     t.libs << 'test'
@@ -123,29 +123,49 @@ end
 if ENV['MOCHA_GENERATE_DOCS']
   require 'yard'
 
-  desc 'Remove generated documentation'
-  task 'clobber_yardoc' do
-    `rm -rf ./docs`
-  end
+  namespace :docs do
+    desc 'Remove generated documentation'
+    task :clobber do
+      `rm -rf ./docs`
+    end
 
-  desc 'Generate documentation'
-  YARD::Rake::YardocTask.new('yardoc') do |task|
-    task.options = ['--title', "Mocha #{Mocha::VERSION}", '--fail-on-warning']
-  end
+    desc 'Generate documentation'
+    YARD::Rake::YardocTask.new(:generate) do |task|
+      task.options = ['--title', "Mocha #{Mocha::VERSION}", '--fail-on-warning']
+    end
 
-  desc 'Ensure custom domain remains in place for docs on GitHub Pages'
-  task 'checkout_docs_cname' do
-    `git checkout docs/CNAME`
-  end
+    desc 'Ensure custom domain remains in place for docs on GitHub Pages'
+    task :ensure_cname do
+      `git checkout docs/CNAME`
+    end
 
-  desc 'Ensure custom JavaScript files remain in place for docs on GitHub Pages'
-  task 'checkout_docs_js' do
-    `git checkout docs/js/app.js`
-    `git checkout docs/js/jquery.js`
+    desc 'Ensure custom JavaScript files remain in place for docs on GitHub Pages'
+    task :ensure_js do
+      `git checkout docs/js/app.js`
+      `git checkout docs/js/jquery.js`
+    end
+
+    desc 'Check documentation coverage'
+    task :coverage do
+      stats_output = `yard stats --list-undoc`
+      puts stats_output
+
+      match = stats_output.match(/(?<coverage_percentage>\d+\.\d+)% documented/);
+      abort 'Error: Could not determine documentation coverage.' unless match
+
+      coverage_percentage = match[:coverage_percentage].to_f
+      minimum_percentage = 100.0
+
+      if coverage_percentage < minimum_percentage
+        abort "Documentation coverage is #{coverage_percentage}%, which is below the required #{minimum_percentage}%."
+      else
+        puts "Documentation coverage is #{coverage_percentage}%, which is at or above the required #{minimum_percentage}%."
+      end
+    end
   end
 
-  desc 'Generate documentation'
-  task 'generate_docs' => %w[clobber_yardoc yardoc checkout_docs_cname checkout_docs_js]
+  desc 'Prepare documentation for publication on GitHub Pages'
+  task 'docs' => %w[docs:clobber docs:generate docs:ensure_cname docs:ensure_js]
 end
 
 task 'release' => ['default', 'rubygems:release']

data/lib/mocha/any_instance_method.rb

@@ -6,16 +6,16 @@ module Mocha
   class AnyInstanceMethod < StubbedMethod
     private
 
-    def mock_owner
-      stubbee.any_instance
+    def stubbee
+      stubba_object.any_instance
     end
 
     def stubbee_method(method_name)
-      stubbee.instance_method(method_name)
+      stubba_object.instance_method(method_name)
     end
 
     def original_method_owner
-      stubbee
+      stubba_object
     end
   end
 end

data/lib/mocha/api.rb

@@ -34,7 +34,7 @@ module Mocha
   #   sheep.chew
   #   sheep.foo # => raises NoMethodError exception
   module API
-    include ParameterMatchers
+    include ParameterMatchers::Methods
     include Hooks
 
     # @private

data/lib/mocha/class_methods.rb

@@ -28,8 +28,8 @@ module Mocha
         @stubba_object
       end
 
-      def respond_to?(symbol, include_all = false)
-        @stubba_object.allocate.respond_to?(symbol.to_sym, include_all)
+      def stubba_respond_to?(symbol)
+        @stubba_object.allocate.respond_to?(symbol.to_sym)
       end
 
       attr_reader :stubba_object
@@ -54,9 +54,13 @@ module Mocha
 
     # @private
     def __method_visibility__(method, include_public_methods: true)
-      (include_public_methods && public_method_defined?(method) && :public) ||
-        (protected_method_defined?(method) && :protected) ||
-        (private_method_defined?(method) && :private)
+      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

data/lib/mocha/configuration.rb

@@ -235,7 +235,7 @@ module Mocha
     #
     # 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 misleading passing tests are still possible when they are used.
+    # 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.
     #

data/lib/mocha/deprecation.rb

@@ -20,7 +20,7 @@ module Mocha
       end
 
       def logger
-        @logger || Logger.new
+        @logger ||= Logger.new
       end
     end
   end

data/lib/mocha/expectation.rb

@@ -221,7 +221,7 @@ module Mocha
 
     # Modifies expectation so that the expected method must be called with +expected_parameters_or_matchers+.
     #
-    # May be used with Ruby literals or variables for exact matching or with parameter matchers for less-specific matching, e.g. {ParameterMatchers#includes}, {ParameterMatchers#has_key}, etc. See {ParameterMatchers} for a list of all available parameter matchers.
+    # May be used with Ruby literals or variables for exact matching or with parameter matchers for less-specific matching, e.g. {ParameterMatchers::Methods#includes}, {ParameterMatchers::Methods#has_key}, etc. See {ParameterMatchers} for a list of all available parameter matchers.
     #
     # Alternatively a block argument can be passed to {#with} to implement custom parameter matching. The block receives the +*actual_parameters+ as its arguments and should return +true+ if they are acceptable or +false+ otherwise. See the example below where a method is expected to be called with a value divisible by 4.
     # The block argument takes precedence over +expected_parameters_or_matchers+. The block may be called multiple times per invocation of the expected method and so it should be idempotent.
@@ -237,7 +237,7 @@ module Mocha
     # @see ParameterMatchers
     # @see Configuration#strict_keyword_argument_matching=
     #
-    # @param [Array<Object,ParameterMatchers::Base>] expected_parameters_or_matchers expected parameter values or parameter matchers.
+    # @param [Array<Object,ParameterMatchers::BaseMethods>] expected_parameters_or_matchers expected parameter values or parameter matchers.
     # @yield optional block specifying custom matching.
     # @yieldparam [Array<Object>] actual_parameters parameters with which expected method was invoked.
     # @yieldreturn [Boolean] +true+ if +actual_parameters+ are acceptable; +false+ otherwise.

data/lib/mocha/expectation_list.rb

@@ -31,7 +31,7 @@ module Mocha
       matching_expectations(invocation).detect(&:invocations_never_allowed?)
     end
 
-    def verified?(assertion_counter = nil)
+    def verified?(assertion_counter)
       @expectations.all? { |expectation| expectation.verified?(assertion_counter) }
     end
 

data/lib/mocha/hooks.rb

@@ -21,8 +21,8 @@ module Mocha
     # Prepares Mocha before a test (only for use by authors of test libraries).
     #
     # This method should be called before each individual test starts (including before any "setup" code).
-    def mocha_setup
-      Mockery.setup
+    def mocha_setup(assertion_counter)
+      Mockery.setup(assertion_counter)
     end
 
     # Verifies that all mock expectations have been met (only for use by authors of test libraries).
@@ -30,8 +30,8 @@ module Mocha
     # This is equivalent to a series of "assertions".
     #
     # This method should be called at the end of each individual test, before it has been determined whether or not the test has passed.
-    def mocha_verify(assertion_counter = nil)
-      Mockery.verify(assertion_counter)
+    def mocha_verify
+      Mockery.verify
     end
 
     # Resets Mocha after a test (only for use by authors of test libraries).

data/lib/mocha/ignoring_warning.rb

@@ -0,0 +1,20 @@
+module Mocha
+  # @private
+  module IgnoringWarning
+    def ignoring_warning(pattern, if_: true)
+      return yield unless if_
+
+      begin
+        original_warn = Warning.method(:warn)
+        Warning.singleton_class.define_method(:warn) do |message|
+          original_warn.call(message) unless message =~ pattern
+        end
+
+        yield
+      ensure
+        Warning.singleton_class.undef_method(:warn)
+        Warning.singleton_class.define_method(:warn, original_warn)
+      end
+    end
+  end
+end

data/lib/mocha/instance_method.rb

@@ -6,16 +6,16 @@ module Mocha
   class InstanceMethod < StubbedMethod
     private
 
-    def mock_owner
-      stubbee
+    def stubbee
+      stubba_object
     end
 
     def stubbee_method(method_name)
-      stubbee._method(method_name)
+      stubba_object._method(method_name)
     end
 
     def original_method_owner
-      stubbee.singleton_class
+      stubba_object.singleton_class
     end
   end
 end

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

@@ -6,6 +6,7 @@ require 'mocha/expectation_error_factory'
 
 module Mocha
   module Integration
+    # Contains {Adapter} that integrates Mocha into recent versions of Minitest.
     module Minitest
       # Integrates Mocha into recent versions of Minitest.
       #
@@ -30,7 +31,8 @@ module Mocha
 
         # @private
         def before_setup
-          mocha_setup
+          assertion_counter = Integration::AssertionCounter.new(self)
+          mocha_setup(assertion_counter)
           super
         end
 
@@ -38,8 +40,7 @@ module Mocha
         def before_teardown
           return unless passed?
 
-          assertion_counter = Integration::AssertionCounter.new(self)
-          mocha_verify(assertion_counter)
+          mocha_verify
         ensure
           super
         end

data/lib/mocha/integration/minitest.rb

@@ -6,7 +6,7 @@ require 'mocha/integration/minitest/adapter'
 module Mocha
   module Integration
     module Minitest
-      def self.activate
+      def self.activate # rubocop:disable Naming/PredicateMethod
         target = Detection::Minitest.testcase
         return false unless target
 

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

@@ -6,6 +6,7 @@ require 'mocha/expectation_error'
 
 module Mocha
   module Integration
+    # Contains {Adapter} that integrates Mocha into recent versions of Test::Unit.
     module TestUnit
       # Integrates Mocha into recent versions of Test::Unit.
       #
@@ -25,13 +26,15 @@ module Mocha
 
         # @private
         def self.included(mod)
-          mod.setup :mocha_setup, before: :prepend
+          mod.setup before: :prepend do
+            assertion_counter = Integration::AssertionCounter.new(self)
+            mocha_setup(assertion_counter)
+          end
 
           mod.exception_handler(:handle_mocha_expectation_error)
 
           mod.cleanup after: :append do
-            assertion_counter = Integration::AssertionCounter.new(self)
-            mocha_verify(assertion_counter)
+            mocha_verify
           end
 
           mod.teardown :mocha_teardown, after: :append
@@ -45,7 +48,7 @@ module Mocha
         end
 
         # @private
-        def handle_mocha_expectation_error(exception)
+        def handle_mocha_expectation_error(exception) # rubocop:disable Naming/PredicateMethod
           return false unless exception.is_a?(Mocha::ExpectationError)
 
           problem_occurred

data/lib/mocha/integration/test_unit.rb

@@ -6,7 +6,7 @@ require 'mocha/integration/test_unit/adapter'
 module Mocha
   module Integration
     module TestUnit
-      def self.activate
+      def self.activate # rubocop:disable Naming/PredicateMethod
         target = Detection::TestUnit.testcase
         return false unless target
 

data/lib/mocha/integration.rb

@@ -0,0 +1,5 @@
+module Mocha
+  # Contains adapters that provide built-in support for +Minitest+ and +Test::Unit+.
+  module Integration
+  end
+end

data/lib/mocha/mock.rb

@@ -276,8 +276,9 @@ module Mocha
     end
 
     # @private
-    def initialize(mockery, name = nil, receiver = nil)
+    def initialize(mockery, assertion_counter, name = nil, receiver = nil)
       @mockery = mockery
+      @assertion_counter = assertion_counter
       @name = name || DefaultName.new(self)
       @receiver = receiver || DefaultReceiver.new(self)
       @expectations = ExpectationList.new
@@ -355,8 +356,8 @@ module Mocha
     end
 
     # @private
-    def __verified__?(assertion_counter = nil)
-      @expectations.verified?(assertion_counter)
+    def __verified__?
+      @expectations.verified?(@assertion_counter)
     end
 
     # @private
@@ -389,7 +390,10 @@ module Mocha
     def raise_unexpected_invocation_error(invocation, matching_expectation)
       if @unexpected_invocation.nil?
         @unexpected_invocation = invocation
-        matching_expectation.invoke(invocation) if matching_expectation
+        if matching_expectation
+          matching_expectation.invoke(invocation)
+          @assertion_counter.increment
+        end
         call_description = @unexpected_invocation.call_description
         if matching_expectation && !matching_expectation.in_correct_order?
           call_description += ' invoked out of order'

data/lib/mocha/mockery.rb

@@ -17,6 +17,10 @@ require 'mocha/expectation_error_factory'
 module Mocha
   class Mockery
     class Null < self
+      def self.build
+        new(nil)
+      end
+
       def add_mock(*)
         raise_not_initialized_error
       end
@@ -39,18 +43,18 @@ module Mocha
 
     class << self
       def instance
-        @instances.last || Null.new
+        @instances.last || Null.build
       end
 
-      def setup
+      def setup(assertion_counter)
         @instances ||= []
-        mockery = new
+        mockery = new(assertion_counter)
         mockery.logger = instance.logger unless @instances.empty?
         @instances.push(mockery)
       end
 
-      def verify(*args)
-        instance.verify(*args)
+      def verify
+        instance.verify
       end
 
       def teardown(origin = nil)
@@ -64,28 +68,32 @@ module Mocha
       end
     end
 
+    def initialize(assertion_counter)
+      @assertion_counter = assertion_counter
+    end
+
     def named_mock(name)
-      add_mock(Mock.new(self, Name.new(name)))
+      add_mock(Mock.new(self, @assertion_counter, Name.new(name)))
     end
 
     def unnamed_mock
-      add_mock(Mock.new(self))
+      add_mock(Mock.new(self, @assertion_counter))
     end
 
     def mock_impersonating(object)
-      add_mock(Mock.new(self, ImpersonatingName.new(object), ObjectReceiver.new(object)))
+      add_mock(Mock.new(self, @assertion_counter, ImpersonatingName.new(object), ObjectReceiver.new(object)))
     end
 
     def mock_impersonating_any_instance_of(klass)
-      add_mock(Mock.new(self, ImpersonatingAnyInstanceName.new(klass), AnyInstanceReceiver.new(klass)))
+      add_mock(Mock.new(self, @assertion_counter, ImpersonatingAnyInstanceName.new(klass), AnyInstanceReceiver.new(klass)))
     end
 
     def new_state_machine(name)
       add_state_machine(StateMachine.new(name))
     end
 
-    def verify(assertion_counter = nil)
-      unless mocks.all? { |mock| mock.__verified__?(assertion_counter) }
+    def verify
+      unless mocks.all?(&:__verified__?)
         message = "not all expectations were satisfied\n#{mocha_inspect}"
         backtrace = if unsatisfied_expectations.empty?
                       caller
@@ -133,7 +141,7 @@ 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) || object.respond_to?(method))
+        !(object.stubba_class.__method_exists__?(method) || object.stubba_respond_to?(method))
       end
       check(:stubbing_non_public_method, 'non-public method', signature_proc) do
         object.stubba_class.__method_exists__?(method, include_public_methods: false)