mocha 2.8.0 → 3.0.0.pre.rc.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f100e1c21f105d22752ae4ffc7740ba8fb351559679d3972ae5eea253725e082
-  data.tar.gz: 31729a24bdde2da814bbf7d995fb77fc4c08dd7c98775bdb85d6d36fead87a35
+  metadata.gz: 89867d8324e0ff09c1b10c13bb46ecbc68215098b8abd916d5be2ebe165d91fe
+  data.tar.gz: 835f460adaa854163671e2a2222f68e8674edb1eb80d714f8e7e58ce26705391
 SHA512:
-  metadata.gz: 57b38d4f7b71f41156ea6dd278416864caed11866f1137a5605491000d3603b8793200d6275962b77ed71aaf09707333b88301451b809e9774e3180d594451cf
-  data.tar.gz: 672e486d410a534ecf3eae8613294dfeb894c3fc8d324ae4414328e56ccd31ab9ebb46f13105b95cb3c1b0f35e5cd89eb6eeb5dee7493fbefe200dc03b251f0d
+  metadata.gz: 4ead2dc30052a85e96ad27728852ee61c120b40229c376508595a09eeee10c863fae71644c4abe917d2a2ae400690d67fd32774a2c4dc6d79fbacc443171d55a
+  data.tar.gz: 3cc439692bc5163961fc2cd44aee804634fdb903d01b245e1101c99818f92cb760c51d3a0dd0a8927bc7c29ccf1c0c202bda4cbd70a058c1c21c1a5beb341edb

data/.rubocop.yml

@@ -1,7 +1,22 @@
+plugins:
+  - rubocop-rake
+
 inherit_from: .rubocop_todo.yml
 
+inherit_mode:
+  merge:
+    - Include
+
 AllCops:
-  TargetRubyVersion: 2.2 # closest to required_ruby_version of '>= 2.1'
+  TargetRubyVersion: 2.2
+
+  Include:
+    - "**/Gemfile.*"
+
+  Exclude:
+    - "**/Gemfile*.lock"
+
+  NewCops: enable
 
 # Even the reference in the documentation suggests that you should prefer
 # `alias_method` vs `alias`, so I don't understand why that isn't the default.
@@ -50,9 +65,28 @@ Layout/AccessModifierIndentation:
   Enabled: false
 
 # Allow long comment lines, e.g. YARD documentation
-Metrics/LineLength:
-  IgnoredPatterns: ['\A\s*#']
+Layout/LineLength:
+  AllowedPatterns: ['\A\s*#']
 
 # It's not possible to set TargetRubyVersion to Ruby < v2.2
 Gemspec/RequiredRubyVersion:
   Enabled: false
+
+# This cop is useful for required environment variables, but not for optional ones
+Style/FetchEnvVar:
+  AllowedVars:
+    - MOCHA_RUN_INTEGRATION_TESTS
+
+Naming/FileName:
+  ExpectMatchingDefinition: true
+  Exclude:
+    - lib/mocha/version.rb
+    - lib/mocha/minitest.rb
+    - lib/mocha/test_unit.rb
+    - lib/mocha/ruby_version.rb
+    - lib/mocha/macos_version.rb
+    - test/test_helper.rb
+
+Metrics/BlockLength:
+  Exclude:
+    - "Rakefile"

data/.rubocop_todo.yml

@@ -1,27 +1,39 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-11-16 18:15:36 +0000 using RuboCop version 0.58.2.
+# on 2025-01-03 14:37:32 UTC using RuboCop version 1.69.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 57
+# Offense count: 34
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 26
+  Max: 27
 
-# Offense count: 23
-# Configuration parameters: CountComments.
+# Offense count: 28
+# Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 366
+  Max: 381
 
-# Offense count: 172
-# Configuration parameters: CountComments.
+# Offense count: 2
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+# Offense count: 200
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 31
+  Max: 27
+
+# Offense count: 3
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/PerceivedComplexity:
+  Max: 10
 
-# Offense count: 545
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# Offense count: 68
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https
-Metrics/LineLength:
-  Max: 180
+Layout/LineLength:
+  Max: 173

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

@@ -2,34 +2,15 @@ source 'https://rubygems.org'
 
 gemspec
 
-# rubocop:disable Bundler/DuplicatedGem
-if RUBY_VERSION < '2.2'
-  gem 'rake', '~> 12.3.3'
-else
+group :development do
+  gem 'benchmark'
+  gem 'introspection', '~> 0.0.1'
+  gem 'minitest'
   gem 'rake'
-end
-# rubocop:enable Bundler/DuplicatedGem
-
-gem 'introspection', '~> 0.0.1'
-
-# Avoid breaking change in psych v4 (https://bugs.ruby-lang.org/issues/17866)
-if RUBY_VERSION >= '3.1.0'
-  gem 'psych', '< 4'
-end
 
-if RUBY_VERSION >= '2.2.0'
-  # No test libraries in standard library
-  gem 'minitest'
-end
-if RUBY_VERSION >= '2.2.0'
-  gem 'jaro_winkler', '>= 1.5.5'
-  gem 'rubocop', '> 0.56', '<= 0.58.2'
-end
-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 'redcarpet'
-  gem 'yard'
+  if ENV['MOCHA_GENERATE_DOCS']
+    gem 'rdoc'
+    gem 'redcarpet'
+    gem 'yard'
+  end
 end

data/README.md

@@ -292,10 +292,9 @@ If you want, Mocha can generate a warning or raise an exception when:
 
 See the [documentation](https://mocha.jamesmead.org/Mocha/Configuration.html) for `Mocha::Configuration` for further details.
 
-##### MOCHA_OPTIONS
-`MOCHA_OPTIONS` is an environment variable whose value can be set to a comma-separated list, so that we can specify multiple options e.g. `MOCHA_OPTIONS=debug,use_test_unit_gem`.
-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.
+### Debugging
+
+Mocha provides some extra output to help with debugging when the standard Ruby debug option (`-d`) is set.
 
 ### Semantic versioning
 

data/RELEASE.md

@@ -1,5 +1,69 @@
 # 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
+
+* Improvements to docs for cardinality-related methods (#700)
+* Drop support for Ruby v2.1 (#628 & #695)
+* Improve gemspec description (#692 & #696)
+* Remove docs for `use_test_unit_gem` option (eaf03493)
+* Correct docs for `MOCHA_OPTIONS` "debug" value (69ef41c0)
+* Use built-in Ruby debug option vs custom module (#714 & #715)
+* Enable strict keyword argument matching by default in Ruby >= v3 (#697 & #718)
+* Use Ruby v1.9 Hash syntax in `Hash#mocha_inspect` used in failure messages (#651 & #719)
+* Improve `#mocha_inspect` for empty keyword argument `Hash` (#588 & #720) - thanks to @herwinw for reporting
+* Improve error if `Mockery.teardown` called before `Mockery.setup` (#611, #646 & #721) - thanks to @riniculous for reporting
+* Freeze string literals (#722)
+* Remove support for running tests with Minitest < v5 (#727)
+* Allow keyword arguments to match an expectation expecting *only* positional arguments (#593 & #732) - thanks to @seandilda
+for reporting
+
+### Internal changes
+
+* Add `Expectation#thrice` (#701) - thanks to @andrewn617
+* Add `base64` to Gemfile for Ruby >= v3.3.0 to avoid warning (8c49314c & a76330d6)
+* Include custom Gemfiles in Rubocop linting (04063f0d)
+* Use ruby:3.4.0-rc1 vs ruby:3.4.0-preview2 in CI in preparation for the Ruby v3.4 release (b2127407)
+* Add `ostruct` to Gemfile for Ruby >= v3.4.0 to avoid warning (2b05e09e)
+* Add Ruby v3.4 to CI build matrix (#708)
+* Fix Ruby v3.4 warnings in ObjectInspectTest (#709 & #710)
+* Rubocop-related improvements (#702 & #705)
+* Consistently use development group in Gemfiles (#706 & #716)
+* Add missing requires for 'mocha/ruby_version' (7f99db69)
+* Convert `ParameterMatchers::Base` class -> module (#712 & #723)
+* Enable `ExpectMatchingDefinition` option on `Naming/FileName` cop (#726)
+* Remove duplicate `DefaultReceiverTest` (39d99954)
+* 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.

data/Rakefile

@@ -6,9 +6,10 @@ require 'bundler/setup'
 
 require 'rake/testtask'
 begin
-  # Only available with default Gemfile and in Ruby >= v2.2
+  # Only available with `gemfiles/Gemfile.rubocop`
   require 'rubocop/rake_task'
-rescue LoadError # rubocop:disable Lint/HandleExceptions
+rescue LoadError
+  warn "Unable to load 'rubocop/rake_task', but continuing anyway" if $DEBUG
 end
 
 desc 'Run all linters and tests'
@@ -24,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'
@@ -81,6 +82,7 @@ namespace 'test' do # rubocop:disable Metrics/BlockLength
   end
 end
 
+desc 'Run linters'
 task 'lint' do
   if defined?(RuboCop::RakeTask)
     RuboCop::RakeTask.new
@@ -90,7 +92,6 @@ task 'lint' do
   end
 end
 
-# rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
 def benchmark_test_case(klass, iterations)
   require 'benchmark'
   require 'mocha/detection/minitest'
@@ -119,32 +120,52 @@ def benchmark_test_case(klass, iterations)
     Benchmark.realtime { iterations.times { Test::Unit::UI::Console::TestRunner.run(klass, @silent_option) } }
   end
 end
-# rubocop:enable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
-
 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
 
-  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
 
-  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/gemfiles/Gemfile.minitest.latest

@@ -1,8 +1,8 @@
 source 'https://rubygems.org'
 
-gemspec :path=>"../"
+gemspec path: '../'
 
 group :development do
-  gem "rake"
-  gem "minitest"
+  gem 'rake'
+  gem 'minitest'
 end

data/gemfiles/Gemfile.rubocop

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+group :development do
+  gem 'rake'
+  gem 'rubocop'
+  gem 'rubocop-rake'
+end

data/gemfiles/Gemfile.test-unit.latest

@@ -1,8 +1,8 @@
 source 'https://rubygems.org'
 
-gemspec :path=>"../"
+gemspec path: '../'
 
 group :development do
-  gem "rake"
-  gem "test-unit"
+  gem 'rake'
+  gem 'test-unit'
 end

data/lib/mocha/any_instance_method.rb

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 require 'mocha/stubbed_method'
 
 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/any_instance_receiver.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Mocha
+  class AnyInstanceReceiver
+    def initialize(klass)
+      @klass = klass
+    end
+
+    def mocks
+      klass = @klass
+      mocks = []
+      while klass
+        mocha = klass.any_instance.mocha(instantiate: false)
+        mocks << mocha if mocha
+        klass = klass.superclass
+      end
+      mocks
+    end
+  end
+end

data/lib/mocha/api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mocha/ruby_version'
 require 'mocha/parameter_matchers'
 require 'mocha/hooks'
@@ -37,8 +39,8 @@ module Mocha
 
     # @private
     def self.included(_mod)
-      Object.send(:include, Mocha::ObjectMethods)
-      Class.send(:include, Mocha::ClassMethods)
+      Object.include Mocha::ObjectMethods
+      Class.include Mocha::ClassMethods
     end
 
     # @private

data/lib/mocha/argument_iterator.rb

@@ -1,16 +1,16 @@
+# frozen_string_literal: true
+
 module Mocha
   class ArgumentIterator
     def initialize(argument)
       @argument = argument
     end
 
-    def each
+    def each(&block)
       if @argument.is_a?(Hash)
-        @argument.each do |method_name, return_value|
-          yield method_name, return_value
-        end
+        @argument.each(&block)
       else
-        yield @argument
+        block.call(@argument)
       end
     end
   end

data/lib/mocha/backtrace_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mocha
   class BacktraceFilter
     LIB_DIRECTORY = File.expand_path(File.join(File.dirname(__FILE__), '..')) + File::SEPARATOR

data/lib/mocha/{block_matcher.rb → block_matchers.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mocha
   module BlockMatchers
     class OptionalBlock

data/lib/mocha/cardinality.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mocha
   class Cardinality
     INFINITY = 1 / 0.0
@@ -58,7 +60,6 @@ module Mocha
       @invocations.any? || maximum.zero?
     end
 
-    # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
     def anticipated_times
       if allowed_any_number_of_times?
         'allowed any number of times'
@@ -74,7 +75,6 @@ module Mocha
         "expected between #{required} and #{count(maximum)}"
       end
     end
-    # rubocop:enable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
 
     def invoked_times
       "invoked #{count(@invocations.size)}"

data/lib/mocha/central.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mocha
   class Central
     class Null < self
@@ -23,12 +25,14 @@ module Mocha
 
     def stub(method)
       return if stubba_methods.detect { |m| m.matches?(method) }
+
       method.stub
       stubba_methods.push(method)
     end
 
     def unstub(method)
       return unless (existing = stubba_methods.detect { |m| m.matches?(method) })
+
       existing.unstub
       stubba_methods.delete(existing)
     end

data/lib/mocha/change_state_side_effect.rb

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

data/lib/mocha/class_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mocha/mockery'
 require 'mocha/any_instance_method'
 
@@ -10,7 +12,7 @@ module Mocha
         @stubba_object = klass
       end
 
-      def mocha(instantiate = true)
+      def mocha(instantiate: true)
         if instantiate
           @mocha ||= Mocha::Mockery.instance.mock_impersonating_any_instance_of(@stubba_object)
         else
@@ -26,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
@@ -46,17 +48,20 @@ module Mocha
       if frozen?
         raise StubbingError.new("can't stub method on frozen object: #{mocha_inspect}.any_instance", caller)
       end
+
       @any_instance ||= AnyInstance.new(self)
     end
 
     # @private
-    # rubocop:disable Metrics/CyclomaticComplexity
-    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)
+    def __method_visibility__(method, include_public_methods: true)
+      if include_public_methods && public_method_defined?(method)
+        :public
+      elsif protected_method_defined?(method)
+        :protected
+      else
+        private_method_defined?(method) ? :private : nil
+      end
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
     alias_method :__method_exists__?, :__method_visibility__
   end
 end