rubocop-minitest 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee9ffa711b1d8af3e0efded458b42333d3c297e9b2f65ec9dc311e5577398552
-  data.tar.gz: 801b3f7a5100a60528f8643ece061ad2dab145f0d52335a9cd7070190a03f2ff
+  metadata.gz: c5d715a17205c012bd5da344d7a8cd6438334554ee22cb509731756c0be17cb3
+  data.tar.gz: f833ffb2d8c3b23e8c7e49b9fc756193e9db5f83668423975201e8a8d52df433
 SHA512:
-  metadata.gz: c9568032ba4258bd449864b1cc982d5e1f85b44e862e360b3ad9dcaa3b96ec9c497c51901632015d45b184611cbe4c376fe7786b77ded3197baa0b44e26c4a28
-  data.tar.gz: 810285b00445e4c90e576f5875d01f151a8d031ac6da3595087e1e6df958464e7d8add79a230a9dd2086c5fd030f5e99153b9011b868eadd4a9fd19c0ed87993
+  metadata.gz: 94c2bca0cb05ac331ed6fd20fb2f0d12ef8ebe8866d2b9201ec5a0ef1194a0b4550d3fe4940e976d303dfef643e6258ac8c3f3b9e44b24086b1466f314385fdc
+  data.tar.gz: 377e96496bf87ba7ab7d49bffd9abf7b355ff43a2259af03be88bbb214fe389b85c89e1d0f1851f2eee88530bd5bad8cc4b2c252d3c4269f2ccbd686e4b32c05

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## master (unreleased)
 
+## 0.2.0 (2019-09-21)
+
+### New features
+
+* [#11](https://github.com/rubocop-hq/rubocop-minitest/pull/11): Add new `Minitest/RefuteNil` cop. ([@tejasbubane ][])
+* [#8](https://github.com/rubocop-hq/rubocop-minitest/pull/8): Add new `Minitest/AssertTruthy` cop. ([@abhaynikam ][])
+* [#9](https://github.com/rubocop-hq/rubocop-minitest/pull/9): Add new `Minitest/AssertIncludes` cop. ([@abhaynikam ][])
+* [#10](https://github.com/rubocop-hq/rubocop-minitest/pull/10): Add new `Minitest/AssertEmpty` cop. ([@abhaynikam ][])
+
 ## 0.1.0 (2019-09-01)
 
 ### New features
@@ -9,3 +18,5 @@
 
 [@koic]: https://github.com/koic
 [@duduribeiro]: https://github.com/duduribeiro
+[@tejasbubane]: https://github.com/tejasbubane
+[@abhaynikam]: https://github.com/abhaynikam

data/README.md

@@ -1,5 +1,8 @@
 # RuboCop Minitest
 
+[![Gem Version](https://badge.fury.io/rb/rubocop-minitest.svg)](https://badge.fury.io/rb/rubocop-minitest)
+[![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.
 
 ## Installation

data/config/default.yml

@@ -7,3 +7,27 @@ Minitest/AssertNil:
   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?)`.'
+  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#assert-empty'
+  Enabled: true
+  VersionAdded: '0.2'
+
+Minitest/AssertIncludes:
+  Description: 'Check if your test uses `assert_includes` instead of `assert(collection.includes?(actual))`.'
+  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#assert-includes'
+  Enabled: true
+  VersionAdded: '0.2'
+
+Minitest/AssertTruthy:
+  Description: 'Check if your test uses `assert(actual)` instead of `assert_equal(true, actual)`.'
+  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#assert-truthy'
+  Enabled: true
+  VersionAdded: '0.2'
+
+Minitest/RefuteNil:
+  Description: 'Check if your test uses `refute_nil` instead of `refute_equal(nil, something)`.'
+  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#refute-nil'
+  Enabled: true
+  VersionAdded: '0.2'

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # Check if your test uses `assert_empty` instead of `assert(actual.empty?)`.
+      #
+      # @example
+      #   # bad
+      #   assert(actual.empty?)
+      #   assert(actual.empty?, 'the message')
+      #
+      #   # good
+      #   assert_empty(actual)
+      #   assert_empty(actual, 'the message')
+      #
+      class AssertEmpty < Cop
+        MSG = 'Prefer using `assert_empty(%<arguments>s)` over ' \
+              '`assert(%<receiver>s)`.'
+
+        def_node_matcher :assert_with_empty, <<~PATTERN
+          (send nil? :assert $(send $_ :empty?) $...)
+        PATTERN
+
+        def on_send(node)
+          assert_with_empty(node) do |first_receiver_arg, actual, rest_receiver_arg|
+            message = rest_receiver_arg.first
+
+            arguments = [actual.source, message&.source].compact.join(', ')
+            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_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})")
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # Check if your test uses `assert_includes`
+      # instead of `assert(collection.includes?(actual))`.
+      #
+      # @example
+      #   # bad
+      #   assert(collection.includes?(actual))
+      #   assert(collection.includes?(actual), 'the message')
+      #
+      #   # good
+      #   assert_includes(collection, actual)
+      #   assert_includes(collection, actual, 'the message')
+      #
+      class AssertIncludes < Cop
+        MSG = 'Prefer using `assert_includes(%<arguments>s)` over ' \
+              '`assert(%<receiver>s)`.'
+
+        def_node_matcher :assert_with_includes, <<~PATTERN
+          (send nil? :assert $(send $_ :includes? $_) $...)
+        PATTERN
+
+        def on_send(node)
+          assert_with_includes(node) do
+            |first_receiver_arg, collection, actual, rest_receiver_arg|
+
+            message = rest_receiver_arg.first
+            arguments = node_arguments(collection, actual, 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_includes(node) do
+              |_receiver, collection, actual, rest_receiver_arg|
+
+              message = rest_receiver_arg.first
+              replacement = node_arguments(collection, actual, message)
+              corrector.replace(node.loc.expression, "assert_includes(#{replacement})")
+            end
+          end
+        end
+
+        private
+
+        def node_arguments(collection, actual, message)
+          [collection.source, actual.source, message&.source].compact.join(', ')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # Check if your test uses `assert(actual)`
+      # instead of `assert_equal(true, actual)`.
+      #
+      # @example
+      #   # bad
+      #   assert_equal(true, actual)
+      #   assert_equal(true, actual, 'the message')
+      #
+      #   # good
+      #   assert(actual)
+      #   assert(actual, 'the message')
+      #
+      class AssertTruthy < Cop
+        MSG = 'Prefer using `assert(%<arguments>s)` over ' \
+              '`assert_equal(true, %<arguments>s)`.'
+
+        def_node_matcher :assert_equal_with_truthy, <<~PATTERN
+          (send nil? :assert_equal true $_ $...)
+        PATTERN
+
+        def on_send(node)
+          assert_equal_with_truthy(node) do |actual, rest_receiver_arg|
+            message = rest_receiver_arg.first
+
+            arguments = [actual.source, message&.source].compact.join(', ')
+
+            add_offense(node, message: format(MSG, arguments: arguments))
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            arguments = node.arguments.reject(&:true_type?)
+            replacement = arguments.map(&:source).join(', ')
+            corrector.replace(node.loc.expression, "assert(#{replacement})")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # Check if your test uses `refute_nil` instead of `refute_equal(nil, something)`.
+      #
+      # @example
+      #   # bad
+      #   refute_equal(nil, actual)
+      #   refute_equal(nil, actual, 'the message')
+      #
+      #   # good
+      #   refute_nil(actual)
+      #   refute_nil(actual, 'the message')
+      #
+      class RefuteNil < Cop
+        MSG = 'Prefer using `refute_nil(%<arguments>s)` over ' \
+              '`refute_equal(nil, %<arguments>s)`.'
+
+        def_node_matcher :refute_equal_with_nil, <<~PATTERN
+          (send nil? :refute_equal nil $_ $...)
+        PATTERN
+
+        def on_send(node)
+          refute_equal_with_nil(node) do |actual, message|
+            message = message.first
+
+            arguments = [actual.source, message&.source].compact.join(', ')
+
+            add_offense(node, message: format(MSG, arguments: arguments))
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            arguments = node.arguments.reject(&:nil_type?)
+            replacement = arguments.map(&:source).join(', ')
+            corrector.replace(node.loc.expression, "refute_nil(#{replacement})")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/minitest_cops.rb

@@ -1,3 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'minitest/assert_empty'
 require_relative 'minitest/assert_nil'
+require_relative 'minitest/assert_includes'
+require_relative 'minitest/assert_truthy'
+require_relative 'minitest/refute_nil'

data/lib/rubocop/minitest/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Minitest
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/manual/cops.md

@@ -1,6 +1,10 @@
 <!-- START_COP_LIST -->
 #### Department [Minitest](cops_minitest.md)
 
+* [Minitest/AssertEmpty](cops_minitest.md#minitestassertempty)
+* [Minitest/AssertIncludes](cops_minitest.md#minitestassertincludes)
 * [Minitest/AssertNil](cops_minitest.md#minitestassertnil)
+* [Minitest/AssertTruthy](cops_minitest.md#minitestasserttruthy)
+* [Minitest/RefuteNil](cops_minitest.md#minitestrefutenil)
 
-<!-- END_COP_LIST -->
+<!-- END_COP_LIST -->

data/manual/cops_minitest.md

@@ -1,5 +1,54 @@
 # Minitest
 
+## Minitest/AssertEmpty
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | Yes  | 0.2 | -
+
+Check if your test uses `assert_empty` instead of `assert(actual.empty?)`.
+
+### Examples
+
+```ruby
+# bad
+assert(actual.empty?)
+assert(actual.empty?, 'the message')
+
+# good
+assert_empty(actual)
+assert_empty(actual, 'the message')
+```
+
+### References
+
+* [https://github.com/rubocop-hq/minitest-style-guide#assert-empty](https://github.com/rubocop-hq/minitest-style-guide#assert-empty)
+
+## Minitest/AssertIncludes
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | Yes  | 0.2 | -
+
+Check if your test uses `assert_includes`
+instead of `assert(collection.includes?(actual))`.
+
+### Examples
+
+```ruby
+# bad
+assert(collection.includes?(actual))
+assert(collection.includes?(actual), 'the message')
+
+# good
+assert_includes(collection, actual)
+assert_includes(collection, actual, 'the message')
+```
+
+### References
+
+* [https://github.com/rubocop-hq/minitest-style-guide#assert-includes](https://github.com/rubocop-hq/minitest-style-guide#assert-includes)
+
 ## Minitest/AssertNil
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
@@ -23,3 +72,52 @@ assert_nil(actual, 'the message')
 ### References
 
 * [https://github.com/rubocop-hq/minitest-style-guide#assert-nil](https://github.com/rubocop-hq/minitest-style-guide#assert-nil)
+
+## Minitest/AssertTruthy
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | Yes  | 0.2 | -
+
+Check if your test uses `assert(actual)`
+instead of `assert_equal(true, actual)`.
+
+### Examples
+
+```ruby
+# bad
+assert_equal(true, actual)
+assert_equal(true, actual, 'the message')
+
+# good
+assert(actual)
+assert(actual, 'the message')
+```
+
+### References
+
+* [https://github.com/rubocop-hq/minitest-style-guide#assert-truthy](https://github.com/rubocop-hq/minitest-style-guide#assert-truthy)
+
+## Minitest/RefuteNil
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | Yes  | 0.2 | -
+
+Check if your test uses `refute_nil` instead of `refute_equal(nil, something)`.
+
+### Examples
+
+```ruby
+# bad
+refute_equal(nil, actual)
+refute_equal(nil, actual, 'the message')
+
+# good
+refute_nil(actual)
+refute_nil(actual, 'the message')
+```
+
+### References
+
+* [https://github.com/rubocop-hq/minitest-style-guide#refute-nil](https://github.com/rubocop-hq/minitest-style-guide#refute-nil)

data/mkdocs.yml

@@ -0,0 +1,13 @@
+site_name: "A RuboCop extension focused on enforcing Minitest best practices and coding conventions."
+repo_url: https://github.com/rubocop-hq/rubocop-minitest
+edit_uri: edit/master/manual/
+copyright: "Copyright © 2019 Bozhidar Batsov, Jonas Arvidsson, Koichi ITO, and RuboCop contributors"
+docs_dir: manual
+pages:
+- Home: index.md
+- Installation: installation.md
+- Usage: usage.md
+- Cops: cops.md
+- Cops Documentation:
+    - Minitest Cops: cops_minitest.md
+theme: readthedocs

data/readthedocs.yml

@@ -0,0 +1,5 @@
+build:
+    image: stable
+
+formats:
+    - htmlzip

data/rubocop-minitest.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.3.0'
   spec.metadata = {
-    'homepage_uri' => 'https://github.com/rubocop-hq/rubocop-minitest',
+    'homepage_uri' => 'https://docs.rubocop.org/projects/minitest',
     'changelog_uri' => 'https://github.com/rubocop-hq/rubocop-minitest/blob/master/CHANGELOG.md',
     'source_code_uri' => 'https://github.com/rubocop-hq/rubocop-minitest',
-    'documentation_uri' => 'https://github.com/rubocop-hq/rubocop-minitest/manual',
+    'documentation_uri' => 'https://docs.rubocop.org/projects/minitest',
     'bug_tracker_uri' => 'https://github.com/rubocop-hq/rubocop-minitest/issues'
   }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-minitest
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-31 00:00:00.000000000 Z
+date: 2019-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -65,7 +65,11 @@ files:
 - bin/setup
 - config/default.yml
 - lib/rubocop-minitest.rb
+- lib/rubocop/cop/minitest/assert_empty.rb
+- lib/rubocop/cop/minitest/assert_includes.rb
 - lib/rubocop/cop/minitest/assert_nil.rb
+- lib/rubocop/cop/minitest/assert_truthy.rb
+- lib/rubocop/cop/minitest/refute_nil.rb
 - lib/rubocop/cop/minitest_cops.rb
 - lib/rubocop/minitest.rb
 - lib/rubocop/minitest/inject.rb
@@ -75,16 +79,18 @@ files:
 - manual/index.md
 - manual/installation.md
 - manual/usage.md
+- mkdocs.yml
+- readthedocs.yml
 - rubocop-minitest.gemspec
 - tasks/cops_documentation.rake
 homepage: 
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/rubocop-hq/rubocop-minitest
+  homepage_uri: https://docs.rubocop.org/projects/minitest
   changelog_uri: https://github.com/rubocop-hq/rubocop-minitest/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/rubocop-hq/rubocop-minitest
-  documentation_uri: https://github.com/rubocop-hq/rubocop-minitest/manual
+  documentation_uri: https://docs.rubocop.org/projects/minitest
   bug_tracker_uri: https://github.com/rubocop-hq/rubocop-minitest/issues
 post_install_message: 
 rdoc_options: []
@@ -101,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Automatic Minitest code style checking tool.