mocha 2.8.2 → 3.0.0.pre.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9b6824de22258fd93ce5b15925529aa65d031f13c6498c5816ef922e55177ac
-  data.tar.gz: 8b9b87a21403c0b478dd1d8827401684d13b43c761acb3d3ade545bb620c851a
+  metadata.gz: e64d5427fb1829eee6958310ca322357d6fc0a8fa0d7856ea6b616edbf326c45
+  data.tar.gz: 052c4fc645bb95c2f09f9d66e1ef6a9025aea478b90accd1fc932de0151f684b
 SHA512:
-  metadata.gz: 5162913f48075d311d6630d69ed3e1aa1d9bdcf1e260b88dd7e1e0ddffdca4c2a26c544cb38b5bad0750d3c44df50dc23cdad00e2915fb7e3c298dd645c1a9be
-  data.tar.gz: 6c914b616fef69f33643a50d86f2593e495ede30a2887122df2d84dbfc1ae4d9bfcd4bdc073821d57dbe92e174f6907e7c59e68ea9eb948e33b278c561251ca0
+  metadata.gz: efd275f6eb30e58383bc67037953e8f02ffa0d0d9ca920ec492267184fe6f3ac8a4765b074d39d8d3b1de38d1e11a374262e3e4a4a3b3e7ee7877f8aba0529b0
+  data.tar.gz: 22b0a2331dc25358032dd83823de41c884a752eb69e80b21befc1d79f931cee4dcc13cf5d40f04bddc3e9ef894b1d2168b90daf3fc89935ed0cd85b41e1b3611

data/.rubocop.yml

@@ -1,7 +1,22 @@
+require:
+  - 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,58 @@ 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
+
+# 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:
+    - MOCHA_RUN_INTEGRATION_TESTS
+
+Naming/FileName:
+  ExpectMatchingDefinition: true
+  CheckDefinitionPathHierarchyRoots:
+    - test/unit
+    - test/acceptance
+  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

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/Gemfile

@@ -2,34 +2,18 @@ source 'https://rubygems.org'
 
 gemspec
 
-# rubocop:disable Bundler/DuplicatedGem
-if RUBY_VERSION < '2.2'
-  gem 'rake', '~> 12.3.3'
-else
+group :development do
+  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_ENGINE == 'jruby'
+    # Workaround for https://github.com/jruby/jruby/issues/8488
+    gem 'jar-dependencies', '~> 0.4.1'
+  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 '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,36 +1,41 @@
 # Release Notes
 
-## 2.8.2
+## 3.0.0-rc.1
 
 ### External changes
 
-* Improve source location of deprecation warning for `ParameterMatchers` matcher classes (c5171488)
-
-## 2.8.1
-
-### External changes
-
-* Restore unqualified access to `ParameterMatchers` matcher classes, but deprecate such access (5231a4f7)
-* Restore unqualified access to `ParameterMatchers::BaseMethods`, but deprecate such access (8a898567)
-
-## 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)
+* 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
 
-* Move `ParameterMatchers#parse_option` -> `HasEntry.parse_option` (9e2a6f66)
-
-**WARNING: This release accidentally removed access to ParameterMatchers classes**
-* Fully-qualified access from within a test/spec class still works, e.g. `Mocha::ParameterMatchers::HasKey`, but unqualified access does not work, e.g. `HasKey`.
-* The mistake has been fixed in v2.8.1 where unqualified access is restored but deprecated. Unqualified access will be removed in v3.
+* 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.7.1
 

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'
@@ -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,8 +120,6 @@ 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'
 
@@ -134,10 +133,12 @@ if ENV['MOCHA_GENERATE_DOCS']
     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 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`

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,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mocha/stubbed_method'
 
 module Mocha

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'
@@ -32,13 +34,13 @@ module Mocha
   #   sheep.chew
   #   sheep.foo # => raises NoMethodError exception
   module API
-    include ParameterMatchers::Methods
+    include ParameterMatchers
     include Hooks
 
     # @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
@@ -46,17 +48,16 @@ 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)
+    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)
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
     alias_method :__method_exists__?, :__method_visibility__
   end
 end