-
-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #161 from koic/add_new_minitest_assert_predicate_r…
…efute_predicate_cops Add new `Minitest/AssertPredicate` and `Minitest/RefutePredicate` cops
- Loading branch information
Showing
8 changed files
with
435 additions
and
0 deletions.
There are no files selected for viewing
1 change: 1 addition & 0 deletions
1
changelog/new_add_new_minitest_assert_predicate_refute_predicate_cops.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* [#161](https://github.com/rubocop/rubocop-minitest/pull/161): Add new `Minitest/AssertPredicate` and `Minitest/RefutePredicate` cops. ([@koic][]) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# frozen_string_literal: true | ||
|
||
module RuboCop | ||
module Cop | ||
module Minitest | ||
# This cop enforces the test to use `assert_predicate` | ||
# instead of using `assert(obj.a_predicate_method?)`. | ||
# | ||
# @example | ||
# # bad | ||
# assert(obj.one?) | ||
# assert(obj.one?, 'message') | ||
# | ||
# # good | ||
# assert_predicate(obj, :one?) | ||
# assert_predicate(obj, :one?, 'message') | ||
# | ||
class AssertPredicate < Base | ||
include ArgumentRangeHelper | ||
include PredicateAssertionHandleable | ||
extend AutoCorrector | ||
|
||
MSG = 'Prefer using `assert_predicate(%<new_arguments>s)`.' | ||
RESTRICT_ON_SEND = %i[assert].freeze | ||
|
||
private | ||
|
||
def assertion_type | ||
'assert' | ||
end | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# frozen_string_literal: true | ||
|
||
module RuboCop | ||
module Cop | ||
module Minitest | ||
# This cop enforces the test to use `refute_predicate` | ||
# instead of using `refute(obj.a_predicate_method?)`. | ||
# | ||
# @example | ||
# # bad | ||
# refute(obj.one?) | ||
# refute(obj.one?, 'message') | ||
# | ||
# # good | ||
# refute_predicate(obj, :one?) | ||
# refute_predicate(obj, :one?, 'message') | ||
# | ||
class RefutePredicate < Base | ||
include ArgumentRangeHelper | ||
include PredicateAssertionHandleable | ||
extend AutoCorrector | ||
|
||
MSG = 'Prefer using `refute_predicate(%<new_arguments>s)`.' | ||
RESTRICT_ON_SEND = %i[refute].freeze | ||
|
||
private | ||
|
||
def assertion_type | ||
'refute' | ||
end | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
# frozen_string_literal: true | ||
|
||
module RuboCop | ||
module Cop | ||
module Minitest | ||
# Common functionality for `Minitest/AssertPredicate` and `Minitest/RefutePredicate` cops. | ||
module PredicateAssertionHandleable | ||
MSG = 'Prefer using `%<assertion_type>s_predicate(%<new_arguments>s)`.' | ||
RESTRICT_ON_SEND = %i[assert].freeze | ||
|
||
def on_send(node) | ||
return unless (arguments = peel_redundant_parentheses_from(node.arguments)) | ||
return unless arguments.first.respond_to?(:predicate_method?) && arguments.first.predicate_method? | ||
return unless arguments.first.arguments.count.zero? | ||
|
||
add_offense(node, message: offense_message(arguments)) do |corrector| | ||
autocorrect(corrector, node, arguments) | ||
end | ||
end | ||
|
||
def autocorrect(corrector, node, arguments) | ||
corrector.replace(node.loc.selector, "#{assertion_type}_predicate") | ||
|
||
new_arguments = new_arguments(arguments).join(', ') | ||
|
||
corrector.replace(first_argument_range(node), new_arguments) | ||
end | ||
|
||
private | ||
|
||
def peel_redundant_parentheses_from(arguments) | ||
return arguments unless arguments.first&.begin_type? | ||
|
||
peel_redundant_parentheses_from(arguments.first.children) | ||
end | ||
|
||
def offense_message(arguments) | ||
message_argument = arguments.last if arguments.first != arguments.last | ||
|
||
new_arguments = [ | ||
new_arguments(arguments), | ||
message_argument&.source | ||
].flatten.compact.join(', ') | ||
|
||
format(MSG, assertion_type: assertion_type, new_arguments: new_arguments) | ||
end | ||
|
||
def new_arguments(arguments) | ||
receiver = correct_receiver(arguments.first.receiver) | ||
method_name = arguments.first.method_name | ||
|
||
[receiver, ":#{method_name}"] | ||
end | ||
|
||
def correct_receiver(receiver) | ||
receiver ? receiver.source : 'self' | ||
end | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,145 @@ | ||
# frozen_string_literal: true | ||
|
||
require 'test_helper' | ||
|
||
class AssertPredicateTest < Minitest::Test | ||
def test_registers_offense_when_using_assert_with_predicate_method | ||
assert_offense(<<~RUBY) | ||
class FooTest < Minitest::Test | ||
def test_do_something | ||
assert(obj.one?) | ||
^^^^^^^^^^^^^^^^ Prefer using `assert_predicate(obj, :one?)`. | ||
end | ||
end | ||
RUBY | ||
|
||
assert_correction(<<~RUBY) | ||
class FooTest < Minitest::Test | ||
def test_do_something | ||
assert_predicate(obj, :one?) | ||
end | ||
end | ||
RUBY | ||
end | ||
|
||
def test_registers_offense_when_using_assert_with_predicate_method_and_message | ||
assert_offense(<<~RUBY) | ||
class FooTest < Minitest::Test | ||
def test_do_something | ||
assert(obj.one?, 'message') | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer using `assert_predicate(obj, :one?, 'message')`. | ||
end | ||
end | ||
RUBY | ||
|
||
assert_correction(<<~RUBY) | ||
class FooTest < Minitest::Test | ||
def test_do_something | ||
assert_predicate(obj, :one?, 'message') | ||
end | ||
end | ||
RUBY | ||
end | ||
|
||
def test_registers_offense_when_using_assert_with_predicate_method_and_heredoc_message | ||
assert_offense(<<~RUBY) | ||
class FooTest < Minitest::Test | ||
def test_do_something | ||
assert(obj.one?, <<~MESSAGE) | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer using `assert_predicate(obj, :one?, <<~MESSAGE)`. | ||
message | ||
MESSAGE | ||
end | ||
end | ||
RUBY | ||
|
||
assert_correction(<<~RUBY) | ||
class FooTest < Minitest::Test | ||
def test_do_something | ||
assert_predicate(obj, :one?, <<~MESSAGE) | ||
message | ||
MESSAGE | ||
end | ||
end | ||
RUBY | ||
end | ||
|
||
def test_registers_offense_when_using_assert_with_predicate_method_in_redundant_parentheses | ||
assert_offense(<<~RUBY) | ||
class FooTest < Minitest::Test | ||
def test_do_something | ||
assert((obj.one?)) | ||
^^^^^^^^^^^^^^^^^^ Prefer using `assert_predicate(obj, :one?)`. | ||
end | ||
end | ||
RUBY | ||
|
||
assert_correction(<<~RUBY) | ||
class FooTest < Minitest::Test | ||
def test_do_something | ||
assert_predicate(obj, :one?) | ||
end | ||
end | ||
RUBY | ||
end | ||
|
||
def test_registers_offense_when_using_assert_with_receiver_omitted_predicate_method | ||
assert_offense(<<~RUBY) | ||
class FooTest < Minitest::Test | ||
def test_do_something | ||
assert(one?) | ||
^^^^^^^^^^^^ Prefer using `assert_predicate(self, :one?)`. | ||
end | ||
end | ||
RUBY | ||
|
||
assert_correction(<<~RUBY) | ||
class FooTest < Minitest::Test | ||
def test_do_something | ||
assert_predicate(self, :one?) | ||
end | ||
end | ||
RUBY | ||
end | ||
|
||
def test_does_not_register_offense_when_using_assert_predicate_method | ||
assert_no_offenses(<<~RUBY) | ||
class FooTest < Minitest::Test | ||
def test_do_something | ||
assert_predicate(obj, :one?) | ||
end | ||
end | ||
RUBY | ||
end | ||
|
||
def test_does_not_registers_offense_when_using_assert_with_non_predicate_method | ||
assert_no_offenses(<<~RUBY) | ||
class FooTest < Minitest::Test | ||
def test_do_something | ||
assert(obj.do_something) | ||
end | ||
end | ||
RUBY | ||
end | ||
|
||
def test_does_not_registers_offense_when_using_assert_with_local_variable | ||
assert_no_offenses(<<~RUBY) | ||
class FooTest < Minitest::Test | ||
def test_do_something | ||
obj = create_obj | ||
assert(obj) | ||
end | ||
end | ||
RUBY | ||
end | ||
|
||
def test_does_not_register_offense_when_using_assert_with_predicate_method_and_arguments | ||
assert_no_offenses(<<~RUBY) | ||
class FooTest < Minitest::Test | ||
def test_do_something | ||
assert(obj.foo?(arg)) | ||
end | ||
end | ||
RUBY | ||
end | ||
end |
Oops, something went wrong.