rubocop-minitest 0.2.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc2eabe582388a8716653ef64d84833b48547f2c0e84fd666c36ab59b773abdc
-  data.tar.gz: 726cd0a1cc2f11eee03f49278408b9eda29308d74641cdc8a562f84c063e4e8c
+  metadata.gz: c3c643f7623a14a4a99f813daf392e31a491b7177504cad25760093d80e0b32e
+  data.tar.gz: b2e5de6e39a741828ae69ca48311b366747bb19aebbc85b23c96ff346f180b39
 SHA512:
-  metadata.gz: 60bec75d6fab0181c7f1ee5e664ca0a9dda0d8ba7d9a54d184a7f4573633e10fccef93719da3dead41c5919862f67aa0b66eb92f1dc933759c240e093ee93bd0
-  data.tar.gz: 28d6e3f708ce291589ff8e2b74a12792777dbc39e244309951ba21e1ffdd59ac982fed3f52af148acca2b8a96bc8f0158711c3e99f893f09d26ef74beb743d2e
+  metadata.gz: eada0f53e4b625d321342f22aa80942512fcefa2131443a7d7d1d7a6f9fafabc1f1e8659f7b7fd2cc002bf83dcec037e760def29db035ac2f1e29bb6ace5fba3
+  data.tar.gz: ca010bc26330c8c32a9a28fe12f27870affa6e554c6832b6eedede0daf4c89fd5e28ffd93bca1e152a5e3785240023db9e4d35226f3e1bcfc02f49a7cffc5c68

data/.github/FUNDING.yml

@@ -0,0 +1,7 @@
+# These are supported funding model platforms
+
+github: [bbatsov, koic]
+patreon: bbatsov
+open_collective: rubocop
+tidelift: "rubygems/rubocop"
+custom: https://www.paypal.me/bbatsov

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-08-07 15:41:02 +0900 using RuboCop version 0.74.0.
+# on 2019-12-21 01:15:41 +0900 using RuboCop version 0.78.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
@@ -10,14 +10,14 @@
 Metrics/AbcSize:
   Max: 17
 
-# Offense count: 5
+# Offense count: 19
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
   Max: 14
 
-# Offense count: 2
+# Offense count: 40
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
-Metrics/LineLength:
-  Max: 87
+Layout/LineLength:
+  Max: 90

data/CHANGELOG.md

@@ -2,6 +2,49 @@
 
 ## master (unreleased)
 
+## 0.5.1 (2019-12-25)
+
+* [#42](https://github.com/rubocop-hq/rubocop-minitest/issues/42): Fix an incorrect autocorrect for some cops of `Minitest` department when using heredoc message. ([@koic][])
+
+## 0.5.0 (2019-11-24)
+
+### New features
+
+* [#32](https://github.com/rubocop-hq/rubocop-minitest/issues/32): Add new `Minitest/AssertEmptyLiteral` cop. ([@tejasbubane][])
+
+## 0.4.1 (2019-11-10)
+
+### Bug fixes
+
+* [#39](https://github.com/rubocop-hq/rubocop-minitest/issues/39): Fix an incorrect autocorrect for `Minitest/AssertRespondTo` and `Minitest/RefuteRespondTo` when using assertion method calling `respond_to` with receiver omitted. ([@koic][])
+
+## 0.4.0 (2019-11-07)
+
+### New features
+
+* [#29](https://github.com/rubocop-hq/rubocop-minitest/pull/29): Add new `Minitest/RefuteRespondTo` cop.  ([@herwinw][])
+* [#31](https://github.com/rubocop-hq/rubocop-minitest/pull/31): Add new `Minitest/AssertEqual` cop. ([@herwinw][])
+* [#34](https://github.com/rubocop-hq/rubocop-minitest/pull/34): Add new `Minitest/AssertInstanceOf` cop. ([@abhaynikam][])
+* [#35](https://github.com/rubocop-hq/rubocop-minitest/pull/35): Add new `Minitest/RefuteInstanceOf` cop. ([@abhaynikam][])
+
+### Bug fixes
+
+* [#25](https://github.com/rubocop-hq/rubocop-minitest/issues/25): Add `Enabled: true` to `Minitest` department config to suppress `Warning: Minitest does not support Enabled parameter`. ([@koic][])
+
+## 0.3.0 (2019-10-13)
+
+### New features
+
+* [#15](https://github.com/rubocop-hq/rubocop-minitest/pull/15): Add new `Minitest/RefuteIncludes` cop. ([@abhaynikam][])
+* [#18](https://github.com/rubocop-hq/rubocop-minitest/pull/18): Add new `Minitest/RefuteFalse` cop. ([@duduribeiro][])
+* [#20](https://github.com/rubocop-hq/rubocop-minitest/pull/20): Add new `Minitest/RefuteEmpty` cop. ([@abhaynikam][])
+* [#21](https://github.com/rubocop-hq/rubocop-minitest/pull/21): Add new `Minitest/RefuteEqual` cop. ([@duduribeiro][])
+* [#27](https://github.com/rubocop-hq/rubocop-minitest/pull/27): Add new `Minitest/AssertRespondTo` cop. ([@duduribeiro][])
+
+### Bug fixes
+
+* [#19](https://github.com/rubocop-hq/rubocop-minitest/pull/19): Fix a false negative for `Minitest/AssertIncludes` when using `include` method in arguments of `assert` method. ([@abhaynikam][])
+
 ## 0.2.1 (2019-09-24)
 
 ### Bug fixes
@@ -28,3 +71,4 @@
 [@duduribeiro]: https://github.com/duduribeiro
 [@tejasbubane]: https://github.com/tejasbubane
 [@abhaynikam]: https://github.com/abhaynikam
+[@herwinw]: https://github.com/herwinw

data/Gemfile

@@ -6,7 +6,11 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 gemspec
 
+gem 'bump', require: false
 gem 'rake'
 gem 'rubocop', github: 'rubocop-hq/rubocop'
-gem 'rubocop-performance', '~> 1.4.0'
-gem 'yard', '~> 0.9'
+gem 'rubocop-performance', '~> 1.5.0'
+# Workaround for YARD 0.9.20 or lower.
+# It specifies `github` until the release that includes the following changes:
+# https://github.com/lsegal/yard/pull/1290
+gem 'yard', github: 'lsegal/yard', ref: '10a2e5b'

data/README.md

@@ -4,6 +4,7 @@
 [![CircleCI](https://circleci.com/gh/rubocop-hq/rubocop-minitest.svg?style=svg)](https://circleci.com/gh/rubocop-hq/rubocop-minitest)
 
 A [RuboCop](https://github.com/rubocop-hq/rubocop) extension focused on enforcing Minitest best practices and coding conventions.
+The library is based on the guidelines outlined in the community [Minitest Style Guide](https://minitest.rubystyle.guide).
 
 ## Installation
 
@@ -61,7 +62,7 @@ end
 
 All cops are located under
 [`lib/rubocop/cop/minitest`](lib/rubocop/cop/minitest), and contain
-examples/documentation.
+examples/documentation. The documentation is published [here](https://docs.rubocop.org/projects/minitest).
 
 In your `.rubocop.yml`, you may treat the Minitest cops just like any other
 cop. For example:

data/config/default.yml

@@ -1,33 +1,93 @@
 Minitest:
+  Enabled: true
   Include:
     - '**/test/**/*'
 
-Minitest/AssertNil:
-  Description: 'Check if your test uses `assert_nil` instead of `assert_equal(nil, something)`.'
-  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#assert-nil'
-  Enabled: true
-  VersionAdded: '0.1'
-
 Minitest/AssertEmpty:
-  Description: 'Check if your test uses `assert_empty` instead of `assert(actual.empty?)`.'
+  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'
   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
+  VersionAdded: '0.5'
+
+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'
+  Enabled: true
+  VersionAdded: '0.4'
+
 Minitest/AssertIncludes:
-  Description: 'Check if your test uses `assert_includes` instead of `assert(collection.includes?(actual))`.'
+  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'
   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'
+  Enabled: true
+  VersionAdded: '0.4'
+
+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'
+  Enabled: true
+  VersionAdded: '0.1'
+
+Minitest/AssertRespondTo:
+  Description: 'This cop enforces the test to use `assert_respond_to(object, :some_method)` over `assert(object.respond_to?(:some_method))`.'
+  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#assert-responds-to-method'
+  Enabled: true
+  VersionAdded: '0.3'
+
 Minitest/AssertTruthy:
-  Description: 'Check if your test uses `assert(actual)` instead of `assert_equal(true, actual)`.'
+  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'
   Enabled: true
   VersionAdded: '0.2'
 
+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'
+  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'
+  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'
+  Enabled: true
+  VersionAdded: '0.3'
+
+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'
+  Enabled: true
+  VersionAdded: '0.3'
+
+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'
+  Enabled: true
+  VersionAdded: '0.4'
+
 Minitest/RefuteNil:
-  Description: 'Check if your test uses `refute_nil` instead of `refute_equal(nil, something)`.'
+  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'
   Enabled: true
   VersionAdded: '0.2'
+
+Minitest/RefuteRespondTo:
+  Description: 'This cop enforces the test to use `refute_respond_to(object, :some_method)` over `refute(object.respond_to?(:some_method))`.'
+  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#refute-respond-to'
+  Enabled: true
+  VersionAdded: '0.4'

data/lib/rubocop-minitest.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'pathname'
-require 'yaml'
-
 require 'rubocop'
 
 require_relative 'rubocop/minitest'

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

@@ -3,18 +3,21 @@
 module RuboCop
   module Cop
     module Minitest
-      # Check if your test uses `assert_empty` instead of `assert(actual.empty?)`.
+      # This cop enforces the test to use `assert_empty`
+      # instead of using `assert(object.empty?)`.
       #
       # @example
       #   # bad
-      #   assert(actual.empty?)
-      #   assert(actual.empty?, 'the message')
+      #   assert(object.empty?)
+      #   assert(object.empty?, 'the message')
       #
       #   # good
-      #   assert_empty(actual)
-      #   assert_empty(actual, 'the message')
+      #   assert_empty(object)
+      #   assert_empty(object, 'the message')
       #
       class AssertEmpty < Cop
+        include ArgumentRangeHelper
+
         MSG = 'Prefer using `assert_empty(%<arguments>s)` over ' \
               '`assert(%<receiver>s)`.'
 
@@ -36,11 +39,9 @@ module RuboCop
 
         def autocorrect(node)
           lambda do |corrector|
-            assert_with_empty(node) do |_first_receiver_arg, actual, rest_receiver_arg|
-              message = rest_receiver_arg.first
-
-              replacement = [actual.source, message&.source].compact.join(', ')
-              corrector.replace(node.loc.expression, "assert_empty(#{replacement})")
+            assert_with_empty(node) do |_, actual_arg|
+              corrector.replace(node.loc.selector, 'assert_empty')
+              corrector.replace(first_argument_range(node), actual_arg.source)
             end
           end
         end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # This cop enforces the test to use `assert_empty`
+      # instead of using `assert([], object)`.
+      #
+      # @example
+      #   # bad
+      #   assert([], object)
+      #   assert({}, object)
+      #
+      #   # good
+      #   assert_empty(object)
+      #
+      class AssertEmptyLiteral < Cop
+        MSG = 'Prefer using `assert_empty(%<arguments>s)` over ' \
+              '`assert(%<literal>s, %<arguments>s)`.'
+
+        def_node_matcher :assert_with_empty_literal, <<~PATTERN
+          (send nil? :assert ${hash array} $...)
+        PATTERN
+
+        def on_send(node)
+          assert_with_empty_literal(node) do |literal, matchers|
+            args = matchers.map(&:source).join(', ')
+
+            message = format(MSG, literal: literal.source, arguments: args)
+            add_offense(node, message: message)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # This cop enforces the use of `assert_equal(expected, actual)`
+      # over `assert(expected == actual)`.
+      #
+      # @example
+      #   # bad
+      #   assert("rubocop-minitest" == actual)
+      #
+      #   # good
+      #   assert_equal("rubocop-minitest", actual)
+      #
+      class AssertEqual < Cop
+        include ArgumentRangeHelper
+
+        MSG = 'Prefer using `assert_equal(%<preferred>s)` over ' \
+              '`assert(%<over>s)`.'
+
+        def_node_matcher :assert_equal, <<~PATTERN
+          (send nil? :assert $(send $_ :== $_) $...)
+        PATTERN
+
+        def on_send(node)
+          assert_equal(node) do |first_receiver_arg, expected, actual, rest_receiver_arg|
+            message = rest_receiver_arg.first
+            preferred = [expected.source, actual.source, message&.source]
+                        .compact.join(', ')
+            over = [first_receiver_arg.source, message&.source].compact.join(', ')
+
+            offense_message = format(MSG, preferred: preferred, over: over)
+
+            add_offense(node, message: offense_message)
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            assert_equal(node) do |_, expected, actual|
+              corrector.replace(node.loc.selector, 'assert_equal')
+
+              replacement = [expected, actual].map(&:source).join(', ')
+              corrector.replace(first_argument_range(node), replacement)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,24 +3,26 @@
 module RuboCop
   module Cop
     module Minitest
-      # Check if your test uses `assert_includes`
-      # instead of `assert(collection.includes?(actual))`.
+      # This cop enforces the test to use `assert_includes`
+      # instead of using `assert(collection.include?(object))`.
       #
       # @example
       #   # bad
-      #   assert(collection.includes?(actual))
-      #   assert(collection.includes?(actual), 'the message')
+      #   assert(collection.include?(object))
+      #   assert(collection.include?(object), 'the message')
       #
       #   # good
-      #   assert_includes(collection, actual)
-      #   assert_includes(collection, actual, 'the message')
+      #   assert_includes(collection, object)
+      #   assert_includes(collection, object, 'the message')
       #
       class AssertIncludes < Cop
+        include ArgumentRangeHelper
+
         MSG = 'Prefer using `assert_includes(%<arguments>s)` over ' \
               '`assert(%<receiver>s)`.'
 
         def_node_matcher :assert_with_includes, <<~PATTERN
-          (send nil? :assert $(send $_ :includes? $_) $...)
+          (send nil? :assert $(send $_ :include? $_) $...)
         PATTERN
 
         def on_send(node)
@@ -39,12 +41,11 @@ module RuboCop
 
         def autocorrect(node)
           lambda do |corrector|
-            assert_with_includes(node) do
-              |_receiver, collection, actual, rest_receiver_arg|
+            assert_with_includes(node) do |_, collection, actual|
+              corrector.replace(node.loc.selector, 'assert_includes')
 
-              message = rest_receiver_arg.first
-              replacement = node_arguments(collection, actual, message)
-              corrector.replace(node.loc.expression, "assert_includes(#{replacement})")
+              replacement = [collection, actual].map(&:source).join(', ')
+              corrector.replace(first_argument_range(node), replacement)
             end
           end
         end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # This cop enforces the test to use `assert_instance_of(Class, object)`
+      # over `assert(object.instance_of?(Class))`.
+      #
+      # @example
+      #   # bad
+      #   assert(object.instance_of?(Class))
+      #   assert(object.instance_of?(Class), 'the message')
+      #
+      #   # good
+      #   assert_instance_of(Class, object)
+      #   assert_instance_of(Class, object, 'the message')
+      #
+      class AssertInstanceOf < Cop
+        include ArgumentRangeHelper
+
+        MSG = 'Prefer using `assert_instance_of(%<arguments>s)` over ' \
+              '`assert(%<receiver>s)`.'
+
+        def_node_matcher :assert_with_instance_of, <<~PATTERN
+          (send nil? :assert $(send $_ :instance_of? $_) $...)
+        PATTERN
+
+        def on_send(node)
+          assert_with_instance_of(node) do |first_receiver_arg, object, method, rest_args|
+            message = rest_args.first
+            arguments = node_arguments(object, method, message)
+            receiver = [first_receiver_arg.source, message&.source].compact.join(', ')
+
+            offense_message = format(MSG, arguments: arguments, receiver: receiver)
+
+            add_offense(node, message: offense_message)
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            assert_with_instance_of(node) do |_, object, method|
+              corrector.replace(node.loc.selector, 'assert_instance_of')
+
+              replacement = [method, object].map(&:source).join(', ')
+              corrector.replace(first_argument_range(node), replacement)
+            end
+          end
+        end
+
+        private
+
+        def node_arguments(object, method, message)
+          [method, object, message].compact.map(&:source).join(', ')
+        end
+      end
+    end
+  end
+end