Reduce surface & size of Cardinality

.circleci/config.yml

@@ -1,5 +1,13 @@
 version: 2.1
 
+commands:
+  run-fail-fast:
+    description: "Execute command and fail on any warning in output"
+    parameters:
+      command:
+        type: string
+    steps:
+      - run: << parameters.command >> 2>&1 | tee >(grep -q "warning:" && exit 1)
 jobs:
   build:
     parameters:
@@ -9,58 +17,65 @@ jobs:
         type: string
     docker:
       - image: << parameters.docker-image >>
-    environment:
-      MOCHA_OPTIONS=debug
     steps:
       - checkout
       - run: ruby --version
       - when:
           condition:
-            equal: [ "jruby:latest", << parameters.docker-image >>]
+            equal: ["jruby:latest", << parameters.docker-image >>]
           steps:
             - run: apt-get update
             - run: apt-get install -y git
       - run: gem --version
       - run: bundle --version
       - run: bundle install --gemfile=<< parameters.gemfile >>
+      - unless:
+          condition:
+            equal: ["ruby:2.2", << parameters.docker-image >>]
+          steps:
+            - run: echo 'export RUBYOPT="--enable-frozen-string-literal"' >> "$BASH_ENV"
       - when:
           condition:
-            equal: [ "Gemfile", << parameters.gemfile >>]
+            equal: ["Gemfile", << parameters.gemfile >>]
           steps:
-            - run: bundle exec rake test
+            - run-fail-fast:
+                command: bundle exec rake test
       - when:
           condition:
             matches:
               pattern: ".*minitest.*"
               value: << parameters.gemfile >>
           steps:
-            - run: MOCHA_RUN_INTEGRATION_TESTS=minitest bundle exec --gemfile=<< parameters.gemfile >> rake test
+            - run-fail-fast:
+                command: MOCHA_RUN_INTEGRATION_TESTS=minitest bundle exec --gemfile=<< parameters.gemfile >> rake test
       - when:
           condition:
             matches:
               pattern: ".*test-unit.*"
               value: << parameters.gemfile >>
           steps:
-            - run: MOCHA_RUN_INTEGRATION_TESTS=test-unit bundle exec --gemfile=<< parameters.gemfile >> rake test
+            - run-fail-fast:
+                command: MOCHA_RUN_INTEGRATION_TESTS=test-unit bundle exec --gemfile=<< parameters.gemfile >> rake test
       - when:
           condition:
             and:
-              - equal: [ "ruby:latest", << parameters.docker-image >> ]
-              - equal: [ "Gemfile", << parameters.gemfile >>]
+              - equal: ["ruby:latest", << parameters.docker-image >>]
+              - equal: ["Gemfile", << parameters.gemfile >>]
           steps:
-            - run: bundle exec rake test:performance
+            - run-fail-fast:
+                command: bundle exec rake test:performance
             - run: MOCHA_GENERATE_DOCS=1 bundle install --gemfile=<< parameters.gemfile >>
-            - run: MOCHA_GENERATE_DOCS=1 rake yardoc
+            - run: RUBYOPT=--disable-frozen-string-literal MOCHA_GENERATE_DOCS=1 rake docs docs:coverage
   lint:
     docker:
-      - image: ruby:2.6
+      - image: ruby:3.3
     steps:
       - checkout
       - run: ruby --version
       - run: gem --version
       - run: bundle --version
-      - run: bundle install --gemfile=Gemfile
-      - run: bundle exec rake lint
+      - run: bundle install --gemfile=gemfiles/Gemfile.rubocop
+      - run: bundle exec --gemfile=gemfiles/Gemfile.rubocop rake lint
 
 workflows:
   build-all:
@@ -70,7 +85,6 @@ workflows:
           matrix:
             parameters:
               docker-image:
-                - ruby:2.1
                 - ruby:2.2
                 - ruby:2.3
                 - ruby:2.4
@@ -81,7 +95,7 @@ workflows:
                 - ruby:3.1
                 - ruby:3.2
                 - ruby:3.3
-                - ruby:3.4.0-preview2
+                - ruby:3.4
                 - ruby:latest
                 - jruby:latest
               gemfile:

.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,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"

.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

.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
 -

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

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
 

RELEASE.md

@@ -1,5 +1,42 @@
 # Release Notes
 
+## 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.7.1
 
 ### External changes