Use redundant instead of unneeded

rubocop · Sep 14, 2017 · 712bce3 · 712bce3
1 parent 44fa554
commit 712bce3
Show file tree

Hide file tree

Showing 7 changed files with 47 additions and 47 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -30,7 +30,7 @@
 * [#4694](https://github.com/bbatsov/rubocop/pull/4694): Add new `Lint/UriRegexp` cop. ([@koic][])
 * Add new `Style/MinMax` cop. ([@drenmi][])
 * [#4720](https://github.com/bbatsov/rubocop/pull/4720): Add new `Bundler/InsecureProtocolSource` cop. ([@koic][])
-* [#4708](https://github.com/bbatsov/rubocop/pull/4708): Add new `Lint/UnneededWithIndex` cop`. ([@koic][])
+* [#4708](https://github.com/bbatsov/rubocop/pull/4708): Add new `Lint/RedundantWithIndex` cop`. ([@koic][])
 
 ### Bug fixes
 

diff --git a/config/enabled.yml b/config/enabled.yml
@@ -1327,6 +1327,10 @@ Lint/RandOne:
                  and most likely a mistake.
   Enabled: true
 
+Lint/RedundantWithIndex:
+  Description: 'Checks for redundant `with_index`.'
+  Enabled: true
+
 Lint/RequireParentheses:
   Description: >-
                  Use parentheses in the method call to avoid confusion
@@ -1391,10 +1395,6 @@ Lint/UnneededDisable:
                  It must be explicitly disabled.
   Enabled: true
 
-Lint/UnneededWithIndex:
-  Description: 'Checks for unneeded `with_index`.'
-  Enabled: true
-
 Lint/UnneededSplatExpansion:
   Description: 'Checks for splat unnecessarily being called on literals'
   Enabled: true

diff --git a/lib/rubocop.rb b/lib/rubocop.rb
@@ -252,6 +252,7 @@
 require 'rubocop/cop/lint/percent_string_array'
 require 'rubocop/cop/lint/percent_symbol_array'
 require 'rubocop/cop/lint/rand_one'
+require 'rubocop/cop/lint/redundant_with_index'
 require 'rubocop/cop/lint/require_parentheses'
 require 'rubocop/cop/lint/rescue_exception'
 require 'rubocop/cop/lint/rescue_type'
@@ -266,7 +267,6 @@
 require 'rubocop/cop/lint/underscore_prefixed_variable_name'
 require 'rubocop/cop/lint/unified_integer'
 require 'rubocop/cop/lint/unneeded_disable'
-require 'rubocop/cop/lint/unneeded_with_index'
 require 'rubocop/cop/lint/unneeded_splat_expansion'
 require 'rubocop/cop/lint/unreachable_code'
 require 'rubocop/cop/lint/unused_block_argument'

diff --git a/lib/rubocop/cop/lint/unneeded_with_index.rb → lib/rubocop/cop/lint/redundant_with_index.rb b/lib/rubocop/cop/lint/unneeded_with_index.rb → lib/rubocop/cop/lint/redundant_with_index.rb
@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for unneeded `with_index`.
+      # This cop checks for redundant `with_index`.
       #
       # @example
       #   # bad
@@ -26,11 +26,11 @@ module Lint
       #     v
       #   end
       #
-      class UnneededWithIndex < Cop
+      class RedundantWithIndex < Cop
         MSG_EACH_WITH_INDEX = 'Use `each` instead of `each_with_index`.'.freeze
-        MSG_WITH_INDEX = 'Remove unneeded `with_index`.'.freeze
+        MSG_WITH_INDEX = 'Remove redundant `with_index`.'.freeze
 
-        def_node_matcher :unneeded_with_index?, <<-PATTERN
+        def_node_matcher :redundant_with_index?, <<-PATTERN
           (block
             $(send
               _ {:each_with_index :with_index})
@@ -40,14 +40,14 @@ class UnneededWithIndex < Cop
         PATTERN
 
         def on_block(node)
-          unneeded_with_index?(node) do |send|
+          redundant_with_index?(node) do |send|
             add_offense(node, with_index_range(send))
           end
         end
 
         def autocorrect(node)
           lambda do |corrector|
-            unneeded_with_index?(node) do |send|
+            redundant_with_index?(node) do |send|
               if send.method_name == :each_with_index
                 corrector.replace(send.loc.selector, 'each')
               else

diff --git a/manual/cops.md b/manual/cops.md
@@ -209,6 +209,7 @@ In the following section you find all available cops:
 * [Lint/PercentStringArray](cops_lint.md#lintpercentstringarray)
 * [Lint/PercentSymbolArray](cops_lint.md#lintpercentsymbolarray)
 * [Lint/RandOne](cops_lint.md#lintrandone)
+* [Lint/RedundantWithIndex](cops_lint.md#lintredundantwithindex)
 * [Lint/RequireParentheses](cops_lint.md#lintrequireparentheses)
 * [Lint/RescueException](cops_lint.md#lintrescueexception)
 * [Lint/RescueType](cops_lint.md#lintrescuetype)
@@ -224,7 +225,6 @@ In the following section you find all available cops:
 * [Lint/UnifiedInteger](cops_lint.md#lintunifiedinteger)
 * [Lint/UnneededDisable](cops_lint.md#lintunneededdisable)
 * [Lint/UnneededSplatExpansion](cops_lint.md#lintunneededsplatexpansion)
-* [Lint/UnneededWithIndex](cops_lint.md#lintunneededwithindex)
 * [Lint/UnreachableCode](cops_lint.md#lintunreachablecode)
 * [Lint/UnusedBlockArgument](cops_lint.md#lintunusedblockargument)
 * [Lint/UnusedMethodArgument](cops_lint.md#lintunusedmethodargument)

diff --git a/manual/cops_lint.md b/manual/cops_lint.md
@@ -1431,6 +1431,38 @@ rand(-1.0)
 0 # just use 0 instead
 ```
 
+## Lint/RedundantWithIndex
+
+Enabled by default | Supports autocorrection
+--- | ---
+Enabled | Yes
+
+This cop checks for redundant `with_index`.
+
+### Example
+
+```ruby
+# bad
+ary.each_with_index do |v|
+  v
+end
+
+# good
+ary.each do |v|
+  v
+end
+
+# bad
+ary.each.with_index do |v|
+  v
+end
+
+# good
+ary.each do |v|
+  v
+end
+```
+
 ## Lint/RequireParentheses
 
 Enabled by default | Supports autocorrection
@@ -1875,38 +1907,6 @@ else
 end
 ```
 
-## Lint/UnneededWithIndex
-
-Enabled by default | Supports autocorrection
---- | ---
-Enabled | Yes
-
-This cop checks for unneeded `with_index`.
-
-### Example
-
-```ruby
-# bad
-ary.each_with_index do |v|
-  v
-end
-
-# good
-ary.each do |v|
-  v
-end
-
-# bad
-ary.each.with_index do |v|
-  v
-end
-
-# good
-ary.each do |v|
-  v
-end
-```
-
 ## Lint/UnreachableCode
 
 Enabled by default | Supports autocorrection

diff --git a/...ocop/cop/lint/unneeded_with_index_spec.rb → ...cop/cop/lint/redundant_with_index_spec.rb b/...ocop/cop/lint/unneeded_with_index_spec.rb → ...cop/cop/lint/redundant_with_index_spec.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe RuboCop::Cop::Lint::UnneededWithIndex do
+describe RuboCop::Cop::Lint::RedundantWithIndex do
   let(:config) { RuboCop::Config.new }
   subject(:cop) { described_class.new(config) }
 
@@ -14,7 +14,7 @@
   it 'registers an offense when using `ary.each.with_index { |v| v }`' do
     expect_offense(<<-RUBY.strip_indent)
       ary.each.with_index { |v| v }
-               ^^^^^^^^^^ Remove unneeded `with_index`.
+               ^^^^^^^^^^ Remove redundant `with_index`.
     RUBY
   end