rubocop-minitest 0.15.1 → 0.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95de9dbe9caf21c7034e137bdaf33e41000e9d418c70e889e3b108ae8aaff2bb
-  data.tar.gz: c58e39ff5277a4c511ba8c34a4378155efb185375edcba187f4c1eae8b44efbd
+  metadata.gz: 06bac8581123850a3beb2e5f9e740279d6ef05889119afd4418d1d079b357b6e
+  data.tar.gz: e0257e30d0b413979b7ce990beae6fc685e3f12161f97ed3fc8391dd023544b2
 SHA512:
-  metadata.gz: 43a96338e7c17fab54a4e50d3f7cea66d52f18633f78f016987dc681e6aae197ec9899044dd310c7c0fe09859b7f861fa65bd4997112df1527ebc184f15f903d
-  data.tar.gz: 772dc16b3f51fd39c67618a49797f020765eafa6d18a6d74970950fc148ef774ef37c3771c055ff4921139ad7a7de1bb84615f6ba256933ff07008a9d624a7da
+  metadata.gz: a358ed867fb7a16f3430835a11560c1159940c67b66627db9116d4cf6c45efd2519701f93c8333ed722d1c296bd527ea7b52c970ba472056b7170f363d95ae05
+  data.tar.gz: a22c800e537e5461cb7446d88e60e3a73f7ac63119c72d4acc32d72707670550b16cb7e1f015668d35dcca7a746f947f93df2a4ee6db571ad23f0f0c17766475

data/.circleci/config.yml

@@ -30,9 +30,6 @@ jobs:
       - run:
           name: Check documentation syntax
           command: bundle exec rake documentation_syntax_check
-      - run:
-          name: Build documentation and verify that doc files are in sync
-          command: bundle exec rake verify_cops_documentation
 
 workflows:
   build:
@@ -40,19 +37,22 @@ workflows:
       - documentation-checks
       - rake_default:
           name: Ruby 2.5
-          image: circleci/ruby:2.5
+          image: cimg/ruby:2.5
       - rake_default:
           name: Ruby 2.6
-          image: circleci/ruby:2.6
+          image: cimg/ruby:2.6
       - rake_default:
           name: Ruby 2.7
-          image: circleci/ruby:2.7
+          image: cimg/ruby:2.7
       - rake_default:
           name: Ruby 3.0
-          image: circleci/ruby:3.0
+          image: cimg/ruby:3.0
+      - rake_default:
+          name: Ruby 3.1
+          image: cimg/ruby:3.1
       - rake_default:
           name: Ruby HEAD
           image: rubocophq/circleci-ruby-snapshot:latest # Nightly snapshot build
       - rake_default:
-          name: JRuby 9.2
-          image: circleci/jruby:9.2
+          name: JRuby 9.3
+          image: circleci/jruby:9.3

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -5,14 +5,13 @@ The more detailed you are, the better.**
 
 Before submitting the PR make sure the following are checked:
 
+* [ ] The PR relates to *only* one subject with a clear title and description in grammatically correct, complete sentences.
 * [ ] Wrote [good commit messages][1].
 * [ ] Commit message starts with `[Fix #issue-number]` (if the related issue exists).
 * [ ] Feature branch is up-to-date with `master` (if not - rebase it).
 * [ ] Squashed related commits together.
 * [ ] Added tests.
-* [ ] Added an entry to the [Changelog](https://github.com/rubocop-hq/rubocop-minitest/blob/master/CHANGELOG.md) if the new code introduces user-observable changes. See [changelog entry format](https://github.com/rubocop-hq/rubocop-minitest/blob/master/CONTRIBUTING.md#changelog-entry-format).
-* [ ] The PR relates to *only* one subject with a clear title
-  and description in grammatically correct, complete sentences.
-* [ ] Run `bundle exec rake default`. It executes all tests and RuboCop for itself, and generates the documentation.
+* [ ] Ran `bundle exec rake default`. It executes all tests and runs RuboCop on its own code.
+* [ ] Added an entry (file) to the [changelog folder](https://github.com/rubocop/rubocop-minitest/blob/master/changelog/) named `{change_type}_{change_description}.md` if the new code introduces user-observable changes. See [changelog entry format](https://github.com/rubocop/rubocop/blob/master/CONTRIBUTING.md#changelog-entry-format) for details.
 
 [1]: https://chris.beams.io/posts/git-commit/

data/.github/workflows/spell_checking.yml

@@ -0,0 +1,33 @@
+name: Spell Checking
+
+on: [pull_request]
+
+jobs:
+  codespell:
+    name: Check spelling of all files with codespell
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.8]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install codespell
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+      - name: Check spelling with codespell
+        run: codespell --ignore-words=codespell.txt || exit 1
+  misspell:
+    name: Check spelling of all files in commit with misspell
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install
+        run: wget -O - -q https://git.io/misspell | sh -s -- -b .
+      - name: Misspell
+        run: git ls-files --empty-directory | xargs ./misspell -error

data/.rubocop.yml

@@ -42,6 +42,7 @@ Style/FormatStringToken:
 Metrics/ClassLength:
   Exclude:
     - test/**/*
+    - tasks/changelog.rb
 
 Layout/EndOfLine:
   EnforcedStyle: lf
@@ -79,14 +80,12 @@ Lint/UselessAccessModifier:
     - 'def_matcher'
     - 'def_node_matcher'
 
-Lint/BooleanSymbol:
-  Enabled: false
-
 Metrics/BlockLength:
   Exclude:
     - 'Rakefile'
     - '**/*.rake'
     - 'test/**/*.rb'
+    - 'rubocop-minitest.gemspec'
 
 Naming/FileName:
   Exclude:

data/.rubocop_todo.yml

@@ -10,6 +10,8 @@
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
 Metrics/MethodLength:
   Max: 14
+  Exclude:
+    - 'test/rubocop/cop/minitest/global_expectations_test.rb'
 
 # Offense count: 1
 Style/DocumentDynamicEvalDefinition:

data/.yardopts

@@ -0,0 +1,3 @@
+--markup markdown
+--hide-void-return
+--tag safety:"Cop Safety Information"

data/CHANGELOG.md

@@ -2,6 +2,35 @@
 
 ## master (unreleased)
 
+## 0.17.1 (2022-01-30)
+
+### Changes
+
+* [#158](https://github.com/rubocop/rubocop-minitest/pull/158): Make `Minitest/UnreachableAssertion` aware of `assert` and `refute` prefix methods. ([@koic][])
+
+## 0.17.0 (2021-11-23)
+
+### New features
+
+* [#155](https://github.com/rubocop/rubocop-minitest/issues/155): Provide `assert_offense`, `assert_correction`, and `assert_no_offenses` testing APIs for custom Minitest cop development. ([@koic][])
+
+## 0.16.0 (2021-11-14)
+
+### New features
+
+* [#147](https://github.com/rubocop/rubocop-minitest/issues/147): Add `EnforcedStyle` config parameter for `Minitest/GlobalExpectations`. ([@gi][])
+
+### Bug fixes
+
+* [#142](https://github.com/rubocop/rubocop-minitest/issues/142): Fix `Minitest/GlobalExpectations` autocorrect when receiver is lambda. ([@gi][])
+* [#150](https://github.com/rubocop/rubocop-minitest/issues/150): Fix a false positive for `Minitest/AssertEmpty` and `RefuteEmpty` cops when using `empty` method with any arguments. ([@koic][])
+
+## 0.15.2 (2021-10-11)
+
+### Bug fixes
+
+* [#145](https://github.com/rubocop/rubocop-minitest/pull/145): Mark `Minitest/AssertEmptyLiteral` as safe auto-correction. ([@koic][])
+
 ## 0.15.1 (2021-09-26)
 
 ### Bug fixes
@@ -240,3 +269,4 @@
 [@tsmmark]: https://github.com/tsmmark
 [@cstyles]: https://github.com/cstyles
 [@ghiculescu]: https://github.com/ghiculescu
+[@gi]: https://github.com/gi

data/CONTRIBUTING.md

@@ -33,7 +33,7 @@ $ rubocop -V
 * If your change has a corresponding open GitHub issue, prefix the commit message with `[Fix #github-issue-number]`.
 * Make sure to add tests for it. This is important so I don't break it
   in a future version unintentionally.
-* Add an entry to the [Changelog](CHANGELOG.md) accordingly. See [changelog entry format](#changelog-entry-format).
+* Add an entry to the [Changelog](CHANGELOG.md) by creating a file `changelog/{type}_{some_description}.md`. See [changelog entry format](#changelog-entry-format) for details.
 * Please try not to mess with the Rakefile, version, or history. If
   you want to have your own version, or is otherwise necessary, that
   is fine, but please isolate to its own commit so I can cherry-pick
@@ -53,12 +53,13 @@ Here are a few examples:
 * New cop `ElseLayout` checks for odd arrangement of code in the `else` branch of a conditional expression. ([@bbatsov][])
 ```
 
+* Create one file `changelog/{type}_{some_description}.md`, where `type` is `new` (New feature), `fix` or `change`, and `some_description` is unique to avoid conflicts. Task `changelog:fix` (or `:new` or `:change`) can help you.
 * Mark it up in [Markdown syntax][6].
 * The entry line should start with `* ` (an asterisk and a space).
 * If the change has a related GitHub issue (e.g. a bug fix for a reported issue), put a link to the issue as `[#123](https://github.com/rubocop/rubocop-minitest/issues/123): `.
 * Describe the brief of the change. The sentence should end with a punctuation.
 * At the end of the entry, add an implicit link to your GitHub user page as `([@username][])`.
-* If this is your first contribution to RuboCop project, add a link definition for the implicit link to the bottom of the changelog as `[@username]: https://github.com/username`.
+* Alternatively, you may modify the CHANGELOG file directly, but this may result in conflicts later on. Also, if this is your first contribution to RuboCop Minitest project, add a link definition for the implicit link to the bottom of the changelog as `[@username]: https://github.com/username`.
 
 [1]: https://github.com/rubocop/rubocop-minitest/issues
 [2]: https://www.gun.io/blog/how-to-github-fork-branch-and-pull-request

data/Gemfile

@@ -9,5 +9,8 @@ gemspec
 gem 'bump', require: false
 gem 'rake'
 gem 'rubocop', github: 'rubocop/rubocop'
-gem 'rubocop-performance', '~> 1.11.0'
+gem 'rubocop-performance', '~> 1.12.0'
 gem 'yard', '~> 0.9'
+
+local_gemfile = File.expand_path('Gemfile.local', __dir__)
+eval_gemfile local_gemfile if File.exist?(local_gemfile)

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019-2021 Bozhidar Batsov, Jonas Arvidsson, Koichi ITO
+Copyright (c) 2019-2022 Bozhidar Batsov, Jonas Arvidsson, Koichi ITO
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Rakefile

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+task release: 'changelog:check_clean' # Before task is required
+
 require 'bundler'
 require 'bundler/gem_tasks'
 
@@ -28,7 +30,6 @@ RuboCop::RakeTask.new(:internal_investigation)
 
 task default: %i[
   documentation_syntax_check
-  generate_cops_documentation
   test
   internal_investigation
 ]
@@ -42,15 +43,12 @@ task :new_cop, [:cop] do |_task, args|
     exit!
   end
 
-  github_user = `git config github.user`.chop
-  github_user = 'your_id' if github_user.empty?
-
-  generator = RuboCop::Cop::Generator.new(cop_name, github_user)
+  generator = RuboCop::Cop::Generator.new(cop_name)
 
   generator.write_source
   generator.write_test
   generator.inject_require(root_file_path: 'lib/rubocop/cop/minitest_cops.rb')
-  generator.inject_config(config_file_path: 'config/default.yml', version_added: bump_minor_version)
+  generator.inject_config(config_file_path: 'config/default.yml')
 
   puts generator.todo
 end

data/config/default.yml

@@ -11,9 +11,8 @@ Minitest/AssertEmpty:
   VersionAdded: '0.2'
 
 Minitest/AssertEmptyLiteral:
-  Description: 'This cop enforces the test to use `assert_empty` instead of using `assert([], object)` or `assert({}, object)`.'
+  Description: 'This cop enforces the test to use `assert_empty` instead of using `assert_equal([], object)`.'
   Enabled: true
-  SafeAutoCorrect: false
   VersionAdded: '0.5'
   VersionChanged: '0.11'
 
@@ -104,7 +103,19 @@ Minitest/GlobalExpectations:
   Description: 'This cop checks for deprecated global expectations.'
   StyleGuide: 'https://minitest.rubystyle.guide#global-expectations'
   Enabled: true
+  EnforcedStyle: any
+  Include:
+    - '**/test/**/*'
+    - '**/*_test.rb'
+    - '**/spec/**/*'
+    - '**/*_spec.rb'
+  SupportedStyles:
+    - _
+    - any
+    - expect
+    - value
   VersionAdded: '0.7'
+  VersionChanged: '0.16'
 
 Minitest/LiteralAsActualArgument:
   Description: 'This cop enforces correct order of `expected` and `actual` arguments for `assert_equal`.'

data/docs/antora.yml

@@ -2,6 +2,6 @@ name: rubocop-minitest
 title: RuboCop Minitest
 # We always provide version without patch here (e.g. 1.1),
 # as patch versions should not appear in the docs.
-version: '0.15'
+version: '0.17'
 nav:
 - modules/ROOT/nav.adoc

data/docs/modules/ROOT/pages/cops_minitest.adoc

@@ -39,13 +39,13 @@ assert_empty(object, 'message')
 
 | Enabled
 | Yes
-| Yes (Unsafe)
+| Yes
 | 0.5
 | 0.11
 |===
 
 This cop enforces the test to use `assert_empty`
-instead of using `assert_equal([], object)`.
+instead of using `assert_equal([], object)` or `assert_equal({}, object)`.
 
 === Examples
 
@@ -458,7 +458,9 @@ assert(actual, 'message')
 This cop tries to detect when a user accidentally used
 `assert` when they meant to use `assert_equal`.
 
-It is marked as unsafe because it is not possible to determine
+=== Safety
+
+This cop is unsafe because it is not possible to determine
 whether the second argument of `assert` is a message or not.
 
 === Examples
@@ -517,7 +519,7 @@ end
 | Yes
 | Yes
 | 0.7
-| -
+| 0.16
 |===
 
 This cop checks for deprecated global expectations
@@ -525,6 +527,54 @@ and autocorrects them to use expect format.
 
 === Examples
 
+==== EnforcedStyle: _
+
+[source,ruby]
+----
+# bad
+musts.must_equal expected_musts
+wonts.wont_match expected_wonts
+musts.must_raise TypeError
+
+expect(musts).must_equal expected_musts
+expect(wonts).wont_match expected_wonts
+expect { musts }.must_raise TypeError
+
+value(musts).must_equal expected_musts
+value(wonts).wont_match expected_wonts
+value { musts }.must_raise TypeError
+
+# good
+_(musts).must_equal expected_musts
+_(wonts).wont_match expected_wonts
+_ { musts }.must_raise TypeError
+----
+
+==== EnforcedStyle: any (default)
+
+[source,ruby]
+----
+# bad
+musts.must_equal expected_musts
+wonts.wont_match expected_wonts
+musts.must_raise TypeError
+
+# good
+_(musts).must_equal expected_musts
+_(wonts).wont_match expected_wonts
+_ { musts }.must_raise TypeError
+
+expect(musts).must_equal expected_musts
+expect(wonts).wont_match expected_wonts
+expect { musts }.must_raise TypeError
+
+value(musts).must_equal expected_musts
+value(wonts).wont_match expected_wonts
+value { musts }.must_raise TypeError
+----
+
+==== EnforcedStyle: expect
+
 [source,ruby]
 ----
 # bad
@@ -532,12 +582,57 @@ musts.must_equal expected_musts
 wonts.wont_match expected_wonts
 musts.must_raise TypeError
 
+_(musts).must_equal expected_musts
+_(wonts).wont_match expected_wonts
+_ { musts }.must_raise TypeError
+
+value(musts).must_equal expected_musts
+value(wonts).wont_match expected_wonts
+value { musts }.must_raise TypeError
+
 # good
+expect(musts).must_equal expected_musts
+expect(wonts).wont_match expected_wonts
+expect { musts }.must_raise TypeError
+----
+
+==== EnforcedStyle: value
+
+[source,ruby]
+----
+# bad
+musts.must_equal expected_musts
+wonts.wont_match expected_wonts
+musts.must_raise TypeError
+
 _(musts).must_equal expected_musts
 _(wonts).wont_match expected_wonts
 _ { musts }.must_raise TypeError
+
+expect(musts).must_equal expected_musts
+expect(wonts).wont_match expected_wonts
+expect { musts }.must_raise TypeError
+
+# good
+value(musts).must_equal expected_musts
+value(wonts).wont_match expected_wonts
+value { musts }.must_raise TypeError
 ----
 
+=== Configurable attributes
+
+|===
+| Name | Default value | Configurable values
+
+| EnforcedStyle
+| `any`
+| `_`, `any`, `expect`, `value`
+
+| Include
+| `+**/test/**/*+`, `+**/*_test.rb+`, `+**/spec/**/*+`, `+**/*_spec.rb+`
+| Array
+|===
+
 === References
 
 * https://minitest.rubystyle.guide#global-expectations

data/docs/modules/ROOT/pages/installation.adoc

@@ -11,5 +11,5 @@ or if you use bundler put this in your `Gemfile`
 
 [source,ruby]
 ----
-gem 'rubocop-minitest'
+gem 'rubocop-minitest', require: false
 ----

data/lib/rubocop/cop/minitest/assert_empty.rb

@@ -19,6 +19,18 @@ module RuboCop
         extend MinitestCopRule
 
         define_rule :assert, target_method: :empty?
+
+        remove_method :on_send
+        def on_send(node)
+          return unless node.method?(:assert)
+          return unless (arguments = peel_redundant_parentheses_from(node.arguments))
+          return unless arguments.first.respond_to?(:method?) && arguments.first.method?(:empty?)
+          return unless arguments.first.arguments.empty?
+
+          add_offense(node, message: offense_message(arguments)) do |corrector|
+            autocorrect(corrector, node, arguments)
+          end
+        end
       end
     end
   end

data/lib/rubocop/cop/minitest/assert_empty_literal.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     module Minitest
       # This cop enforces the test to use `assert_empty`
-      # instead of using `assert_equal([], object)`.
+      # instead of using `assert_equal([], object)` or `assert_equal({}, object)`.
       #
       # @example
       #   # bad

data/lib/rubocop/cop/minitest/assert_with_expected_argument.rb

@@ -6,8 +6,9 @@ module RuboCop
       # This cop tries to detect when a user accidentally used
       # `assert` when they meant to use `assert_equal`.
       #
-      # It is marked as unsafe because it is not possible to determine
-      # whether the second argument of `assert` is a message or not.
+      # @safety
+      #   This cop is unsafe because it is not possible to determine
+      #   whether the second argument of `assert` is a message or not.
       #
       # @example
       #   # bad

data/lib/rubocop/cop/minitest/assertion_in_lifecycle_hook.rb

@@ -30,7 +30,7 @@ module RuboCop
 
           lifecycle_hooks(class_node).each do |hook_node|
             hook_node.each_descendant(:send) do |node|
-              if assertion?(node)
+              if assertion_method?(node)
                 message = format(MSG, assertion: node.method_name, hook: hook_node.method_name)
                 add_offense(node, message: message)
               end