rubocop-minitest 0.8.1 → 0.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7583581a57a2d02e2794742beda02c84256b1b61e1139095e28d7f95832afa26
-  data.tar.gz: 724e5254b30b3862ecf1101ca7d33dacb67880abd4d1d84f6dff9b4ab21d433c
+  metadata.gz: 578c35f660ca4c19f2a5d9864cb79eb0092923999c6d4e36ced55680ea7c0789
+  data.tar.gz: 1ba667604ca929938ac8a13754728eb879bb7e6fe09d48475779bc8a2c05c2b0
 SHA512:
-  metadata.gz: 3095ba19f3e22c2d8219d1ef6fc87de197d9c27f74e2d62e4ee2336c3bbe47642606a5c406fa4f8f14134fe160cbde7b31e975f982cbddf1dd02c6706c409adc
-  data.tar.gz: f1d4837b08291f388ea6ec949949d186f59da810ebb05014c6c6375977fe2bcaa545759cd04a1d19d4e48446a5261a31ddd7a8f3ab41fea9fd3586c3cdb8810e
+  metadata.gz: 1328f2b45769ce5020394625744839ab2658442c0c1e14dc07a98bd26826064c623b5ba0106b93a2ba40a4b6052110b84233d3ea9ff71c5334fd790bdc107965
+  data.tar.gz: 8d815f7813ce9dd261ad72dbf39a741456a504a04d1dd01f986ad96ad3da26d1c095541ac0a8b6eeaadb4945a02321664bdf9e70e02c028a4dfbe70c354d40db

data/.circleci/config.yml

@@ -20,12 +20,24 @@ jobs:
       - run: bundle install
       - run: bundle exec rake
 
+  # Miscellaneous tasks
+  documentation-checks:
+    docker:
+      - image: circleci/ruby
+    steps:
+      - checkout
+      - run: bundle install
+      - 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:
     jobs:
-      - rake_default:
-          name: Ruby 2.3
-          image: circleci/ruby:2.3
+      - documentation-checks
       - rake_default:
           name: Ruby 2.4
           image: circleci/ruby:2.4
@@ -38,6 +50,9 @@ workflows:
       - rake_default:
           name: Ruby 2.7
           image: circleci/ruby:2.7
+      - rake_default:
+          name: Ruby 3.0
+          image: circleci/ruby:3.0
       - rake_default:
           name: Ruby HEAD
           image: rubocophq/circleci-ruby-snapshot:latest # Nightly snapshot build

data/.rubocop.yml

@@ -8,7 +8,9 @@ require:
   - rubocop-minitest
 
 AllCops:
-  TargetRubyVersion: 2.3
+  NewCops: enable
+  TargetRubyVersion: 2.4
+  SuggestExtensions: false
 
 Naming/PredicateName:
   # Method define macros for dynamically generated method.
@@ -47,9 +49,6 @@ Layout/ClassStructure:
       - protected_methods
       - private_methods
 
-Layout/LineLength:
-  Max: 120
-
 # Trailing white space is meaningful in code examples
 Layout/TrailingWhitespace:
   AllowInHeredoc: true

data/.rubocop_todo.yml

@@ -1,16 +1,17 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-12-21 01:15:41 +0900 using RuboCop version 0.78.0.
+# on 2020-10-29 02:01:16 UTC using RuboCop version 1.0.0.
 # 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: 2
-Metrics/AbcSize:
-  Max: 17
-
-# Offense count: 19
-# Configuration parameters: CountComments, ExcludedMethods.
+# Offense count: 22
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
 Metrics/MethodLength:
   Max: 14
+
+# Offense count: 1
+Style/DocumentDynamicEvalDefinition:
+  Exclude:
+    - 'lib/rubocop/cop/mixin/minitest_cop_rule.rb'

data/CHANGELOG.md

@@ -2,6 +2,55 @@
 
 ## master (unreleased)
 
+## 0.10.3 (2021-01-12)
+
+### Bug fixes
+
+* [#115](https://github.com/rubocop-hq/rubocop-minitest/issues/115): Fix a false positive for `Minitest/TestMethodName` for when defining test method has an argument, and test method without assertion methods. ([@koic][])
+
+## 0.10.2 (2020-12-27)
+
+### Bug fixes
+
+* [#113](https://github.com/rubocop-hq/rubocop-minitest/issues/113): Fix an error for `Minitest/AssertEqual` and some cops when using `assert` with block argument. ([@koic][])
+
+## 0.10.1 (2020-07-25)
+
+### Bug fixes
+
+* [#106](https://github.com/rubocop-hq/rubocop-minitest/issues/106): Fix an error for `Minitest/AssertOutput` when using gvar at top level. ([@koic][])
+
+## 0.10.0 (2020-07-12)
+
+### New features
+
+* [#92](https://github.com/rubocop-hq/rubocop-minitest/pull/92): Add new `Minitest/LiteralAsActualArgument` cop. ([@fatkodima][], [@tsmmark][])
+* [#95](https://github.com/rubocop-hq/rubocop-minitest/pull/95): Add new `Minitest/AssertionInLifecycleHook` cop. ([@fatkodima][])
+* [#91](https://github.com/rubocop-hq/rubocop-minitest/pull/91): Add new `Minitest/AssertInDelta` and `Minitest/RefuteInDelta` cops. ([@fatkodima][])
+* [#89](https://github.com/rubocop-hq/rubocop-minitest/pull/89): Add new `Minitest/TestMethodName` cop. ([@fatkodima][])
+* [#83](https://github.com/rubocop-hq/rubocop-minitest/pull/83): New cops `AssertPathExists` and `RefutePathExists` check for use of `assert_path_exists`/`refute_path_exists` instead of `assert(File.exist?(path))`/`refute(File.exist?(path))`. ([@fatkodima][])
+* [#88](https://github.com/rubocop-hq/rubocop-minitest/pull/88): Add new `Minitest/MultipleAssertions` cop. ([@fatkodima][])
+* [#87](https://github.com/rubocop-hq/rubocop-minitest/pull/87): Add new `Minitest/AssertSilent` cop. ([@fatkodima][])
+* [#96](https://github.com/rubocop-hq/rubocop-minitest/pull/96): Add new `Minitest/UnspecifiedException` cop. ([@fatkodima][])
+* [#98](https://github.com/rubocop-hq/rubocop-minitest/pull/98): Add new `Minitest/AssertOutput` cop. ([@fatkodima][])
+* [#84](https://github.com/rubocop-hq/rubocop-minitest/pull/84): New cops `AssertKindOf` and `RefuteKindOf` check for use of `assert_kind_of`/`refute_kind_of` instead of `assert(foo.kind_of?(Class))`/`refute(foo.kind_of?(Class))`. ([@fatkodima][])
+* [#85](https://github.com/rubocop-hq/rubocop-minitest/pull/85): Add autocorrect to `Rails/AssertEmptyLiteral` cop. ([@fatkodima][])
+
+### Changes
+
+* [#104](https://github.com/rubocop-hq/rubocop-minitest/pull/104): Require RuboCop 0.87 or higher. ([@koic][])
+
+## 0.9.0 (2020-04-13)
+
+### Bug fixes
+
+* [#75](https://github.com/rubocop-hq/rubocop-minitest/issues/75): Fix a false negative for `Minitest/GlobalExpectations` when using global expectation methods with no arguments. ([@koic][])
+
+### Changes
+
+* [#73](https://github.com/rubocop-hq/rubocop-minitest/issues/73): The Minitest department works on file names end with `_test.rb` by default. ([@koic][])
+* [#77](https://github.com/rubocop-hq/rubocop-minitest/pull/77): **(BREAKING)** Drop support for Ruby 2.3. ([@koic][])
+
 ## 0.8.1 (2020-04-06)
 
 ### Bug fixes
@@ -126,3 +175,5 @@
 [@herwinw]: https://github.com/herwinw
 [@fsateler]: https://github.com/fsateler
 [@andrykonchin]: https://github.com/andrykonchin
+[@fatkodima]: https://github.com/fatkodima
+[@tsmmark]: https://github.com/tsmmark

data/Gemfile

@@ -9,5 +9,5 @@ gemspec
 gem 'bump', require: false
 gem 'rake'
 gem 'rubocop', github: 'rubocop-hq/rubocop'
-gem 'rubocop-performance', '~> 1.5.0'
+gem 'rubocop-performance', '~> 1.9.0'
 gem 'yard', '~> 0.9'

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019-2020 Bozhidar Batsov, Jonas Arvidsson, Koichi ITO
+Copyright (c) 2019-2021 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/README.md

@@ -62,7 +62,7 @@ end
 
 All cops are located under
 [`lib/rubocop/cop/minitest`](lib/rubocop/cop/minitest), and contain
-examples/documentation. The documentation is published [here](https://docs.rubocop.org/projects/minitest).
+examples/documentation. The documentation is published [here](https://docs.rubocop.org/rubocop-minitest/).
 
 In your `.rubocop.yml`, you may treat the Minitest cops just like any other
 cop. For example:
@@ -75,7 +75,23 @@ Minitest/AssertNil:
 
 ## Documentation
 
-You can read a lot more about RuboCop Minitest in its [official docs](https://docs.rubocop.org/projects/minitest/).
+You can read a lot more about RuboCop Minitest in its [official docs](https://docs.rubocop.org/rubocop-minitest/).
+
+## Readme Badge
+
+If you use RuboCop Minitest in your project, you can include one of these badges in your readme to let people know that your code is written following the community Minitest Style Guide.
+
+[![Minitest Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop-hq/rubocop-minitest)
+
+[![Minitest Style Guide](https://img.shields.io/badge/code_style-community-brightgreen.svg)](https://minitest.rubystyle.guide)
+
+Here are the Markdown snippets for the two badges:
+
+``` markdown
+[![Minitest Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop-hq/rubocop-minitest)
+
+[![Minitest Style Guide](https://img.shields.io/badge/code_style-community-brightgreen.svg)](https://minitest.rubystyle.guide)
+```
 
 ## Contributing
 

data/Rakefile

@@ -15,6 +15,7 @@ end
 
 require 'rubocop/rake_task'
 require 'rake/testtask'
+require_relative 'lib/rubocop/cop/generator'
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
@@ -36,3 +37,31 @@ task default: %i[
   test
   internal_investigation
 ]
+
+desc 'Generate a new cop template'
+task :new_cop, [:cop] do |_task, args|
+  require 'rubocop'
+
+  cop_name = args.fetch(:cop) do
+    warn 'usage: bundle exec rake new_cop[Department/Name]'
+    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.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)
+
+  puts generator.todo
+end
+
+def bump_minor_version
+  major, minor, _patch = RuboCop::Minitest::VERSION.split('.')
+
+  "#{major}.#{minor.succ}"
+end

data/config/default.yml

@@ -2,109 +2,189 @@ Minitest:
   Enabled: true
   Include:
     - '**/test/**/*'
+    - '**/*_test.rb'
 
 Minitest/AssertEmpty:
   Description: 'This cop enforces the test to use `assert_empty` instead of using `assert(object.empty?)`.'
-  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#assert-empty'
+  StyleGuide: 'https://minitest.rubystyle.guide#assert-empty'
   Enabled: true
   VersionAdded: '0.2'
 
 Minitest/AssertEmptyLiteral:
   Description: 'This cop enforces the test to use `assert_empty` instead of using `assert([], object)` or `assert({}, object)`.'
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '0.5'
+  VersionChanged: '0.10'
 
 Minitest/AssertEqual:
   Description: 'This cop enforces the test to use `assert_equal` instead of using `assert(expected == actual)`.'
-  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#assert-equal-arguments-order'
+  StyleGuide: 'https://minitest.rubystyle.guide#assert-equal-arguments-order'
   Enabled: true
   VersionAdded: '0.4'
 
+Minitest/AssertInDelta:
+  Description: 'This cop enforces the test to use `assert_in_delta` instead of using `assert_equal` to compare floats.'
+  StyleGuide: 'https://minitest.rubystyle.guide/#assert-in-delta'
+  Enabled: 'pending'
+  VersionAdded: '0.10'
+
+Minitest/AssertionInLifecycleHook:
+  Description: 'This cop checks for usage of assertions in lifecycle hooks.'
+  Enabled: 'pending'
+  VersionAdded: '0.10'
+
 Minitest/AssertMatch:
   Description: 'This cop enforces the test to use `assert_match` instead of using `assert(matcher.match(object))`.'
-  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#assert-match'
+  StyleGuide: 'https://minitest.rubystyle.guide#assert-match'
   Enabled: true
   VersionAdded: '0.6'
 
 Minitest/AssertIncludes:
   Description: 'This cop enforces the test to use `assert_includes` instead of using `assert(collection.include?(object))`.'
-  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#assert-includes'
+  StyleGuide: 'https://minitest.rubystyle.guide#assert-includes'
   Enabled: true
   VersionAdded: '0.2'
 
 Minitest/AssertInstanceOf:
   Description: 'This cop enforces the test to use `assert_instance_of(Class, object)` over `assert(object.instance_of?(Class))`'
-  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#assert-instance-of'
+  StyleGuide: 'https://minitest.rubystyle.guide#assert-instance-of'
   Enabled: true
   VersionAdded: '0.4'
 
+Minitest/AssertKindOf:
+  Description: 'This cop enforces the test to use `assert_kind_of(Class, object)` over `assert(object.kind_of?(Class))`'
+  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#assert-kind-of'
+  Enabled: 'pending'
+  VersionAdded: '0.10'
+
 Minitest/AssertNil:
   Description: 'This cop enforces the test to use `assert_nil` instead of using `assert_equal(nil, something)`.'
-  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#assert-nil'
+  StyleGuide: 'https://minitest.rubystyle.guide#assert-nil'
   Enabled: true
   VersionAdded: '0.1'
 
+Minitest/AssertOutput:
+  Description: 'This cop checks for opportunities to use `assert_output`.'
+  StyleGuide: 'https://minitest.rubystyle.guide/#assert-output'
+  Enabled: 'pending'
+  VersionAdded: '0.10'
+
+Minitest/AssertPathExists:
+  Description: 'This cop enforces the test to use `assert_path_exists` instead of using `assert(File.exist?(path))`.'
+  StyleGuide: 'https://minitest.rubystyle.guide/#assert-path-exists'
+  Enabled: 'pending'
+  VersionAdded: '0.10'
+
 Minitest/AssertRespondTo:
   Description: 'This cop enforces the test to use `assert_respond_to(object, :do_something)` over `assert(object.respond_to?(:do_something))`.'
-  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#assert-responds-to-method'
+  StyleGuide: 'https://minitest.rubystyle.guide#assert-responds-to-method'
   Enabled: true
   VersionAdded: '0.3'
 
+Minitest/AssertSilent:
+  Description: "This cop enforces the test to use `assert_silent { ... }` instead of using `assert_output('', '') { ... }`."
+  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#assert-silent'
+  Enabled: 'pending'
+  VersionAdded: '0.10'
+
 Minitest/AssertTruthy:
   Description: 'This cop enforces the test to use `assert(actual)` instead of using `assert_equal(true, actual)`.'
-  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#assert-truthy'
+  StyleGuide: 'https://minitest.rubystyle.guide#assert-truthy'
   Enabled: true
   VersionAdded: '0.2'
 
 Minitest/GlobalExpectations:
   Description: 'This cop checks for deprecated global expectations.'
+  StyleGuide: 'https://minitest.rubystyle.guide#global-expectations'
   Enabled: true
   VersionAdded: '0.7'
 
+Minitest/LiteralAsActualArgument:
+  Description: 'This cop enforces correct order of `expected` and `actual` arguments for `assert_equal`.'
+  StyleGuide: 'https://minitest.rubystyle.guide/#assert-equal-arguments-order'
+  Enabled: 'pending'
+  VersionAdded: '0.10'
+
+Minitest/MultipleAssertions:
+  Description: 'This cop checks if test cases contain too many assertion calls.'
+  Enabled: 'pending'
+  VersionAdded: '0.10'
+  Max: 3
+
 Minitest/RefuteEmpty:
   Description: 'This cop enforces to use `refute_empty` instead of using `refute(object.empty?)`.'
-  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#refute-empty'
+  StyleGuide: 'https://minitest.rubystyle.guide#refute-empty'
   Enabled: true
   VersionAdded: '0.3'
 
 Minitest/RefuteEqual:
   Description: 'Check if your test uses `refute_equal` instead of `assert(expected != object)` or `assert(! expected == object))`.'
-  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#refute-equal'
+  StyleGuide: 'https://minitest.rubystyle.guide#refute-equal'
   Enabled: true
   VersionAdded: '0.3'
 
 Minitest/RefuteFalse:
   Description: 'Check if your test uses `refute(actual)` instead of `assert_equal(false, actual)`.'
-  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#refute-false'
+  StyleGuide: 'https://minitest.rubystyle.guide#refute-false'
   Enabled: true
   VersionAdded: '0.3'
 
+Minitest/RefuteInDelta:
+  Description: 'This cop enforces the test to use `refute_in_delta` instead of using `refute_equal` to compare floats.'
+  StyleGuide: 'https://minitest.rubystyle.guide/#refute-in-delta'
+  Enabled: 'pending'
+  VersionAdded: '0.10'
+
 Minitest/RefuteIncludes:
   Description: 'This cop enforces the test to use `refute_includes` instead of using `refute(collection.include?(object))`.'
-  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#refute-includes'
+  StyleGuide: 'https://minitest.rubystyle.guide#refute-includes'
   Enabled: true
   VersionAdded: '0.3'
 
 Minitest/RefuteMatch:
   Description: 'This cop enforces the test to use `refute_match` instead of using `refute(matcher.match(object))`.'
-  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#refute-match'
+  StyleGuide: 'https://minitest.rubystyle.guide#refute-match'
   Enabled: true
   VersionAdded: '0.6'
 
 Minitest/RefuteInstanceOf:
   Description: 'This cop enforces the test to use `refute_instance_of(Class, object)` over `refute(object.instance_of?(Class))`.'
-  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#refute-instance-of'
+  StyleGuide: 'https://minitest.rubystyle.guide#refute-instance-of'
   Enabled: true
   VersionAdded: '0.4'
 
+Minitest/RefuteKindOf:
+  Description: 'This cop enforces the test to use `refute_kind_of(Class, object)` over `refute(object.kind_of?(Class))`.'
+  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#refute-kind-of'
+  Enabled: 'pending'
+  VersionAdded: '0.10'
+
 Minitest/RefuteNil:
   Description: 'This cop enforces the test to use `refute_nil` instead of using `refute_equal(nil, something)`.'
-  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#refute-nil'
+  StyleGuide: 'https://minitest.rubystyle.guide#refute-nil'
   Enabled: true
   VersionAdded: '0.2'
 
+Minitest/RefutePathExists:
+  Description: 'This cop enforces the test to use `refute_path_exists` instead of using `refute(File.exist?(path))`.'
+  StyleGuide: 'https://minitest.rubystyle.guide/#refute-path-exists'
+  Enabled: 'pending'
+  VersionAdded: '0.10'
+
 Minitest/RefuteRespondTo:
   Description: 'This cop enforces the test to use `refute_respond_to(object, :do_something)` over `refute(object.respond_to?(:do_something))`.'
-  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#refute-respond-to'
+  StyleGuide: 'https://minitest.rubystyle.guide#refute-respond-to'
   Enabled: true
   VersionAdded: '0.4'
+
+Minitest/TestMethodName:
+  Description: 'This cop enforces that test method names start with `test_` prefix.'
+  Enabled: 'pending'
+  VersionAdded: '0.10'
+
+Minitest/UnspecifiedException:
+  Description: 'This cop checks for a specified error in `assert_raises`.'
+  StyleGuide: 'https://minitest.rubystyle.guide#unspecified-exception'
+  Enabled: 'pending'
+  VersionAdded: '0.10'