[rubocop#3666] Add AllowNamesEndingInNumbers & enable by default

.rubocop.yml

@@ -20,32 +20,6 @@ Naming/PredicateName:
     - def_node_matcher
     - def_node_search
 
-Naming/UncommunicativeBlockParamName:
-  AllowedNames:
-    - 'child_node1'
-    - 'child_node2'
-    - 'expression1'
-    - 'expression2'
-    - 'node1'
-    - 'node2'
-    - 'operator1'
-    - 'operator2'
-    - 'range1'
-    - 'range2'
-    - 'token1'
-    - 'token2'
-    - 'var1'
-    - 'var2'
-
-Naming/UncommunicativeMethodArgName:
-  AllowedNames:
-    - 'node1'
-    - 'node2'
-    - 'range1'
-    - 'range2'
-    - 'token1'
-    - 'token2'
-
 Style/FrozenStringLiteralComment:
   EnforcedStyle: always
 

config/default.yml

@@ -684,13 +684,17 @@ Naming/PredicateName:
 
 Naming/UncommunicativeBlockParamName:
   # Parameter names may be equal to or greater than this value
-  MinParamNameLength: 1
-  AllowedNames:
+  MinNameLength: 1
+  AllowNamesEndingInNumbers: true
+  # Whitelisted names that will not register an offense
+  AllowedNames: []
 
 Naming/UncommunicativeMethodArgName:
   # Argrument names may be equal to or greater than this value
-  MinArgNameLength: 3
-  AllowedNames:
+  MinNameLength: 3
+  AllowNamesEndingInNumbers: true
+  # Whitelisted names that will not register an offense
+  AllowedNames: []
 
 Naming/VariableName:
   EnforcedStyle: snake_case

lib/rubocop/cop/mixin/uncommunicative_name.rb

@@ -9,17 +9,24 @@ module UncommunicativeName
       LENGTH_MSG = '%<name_type>s must be longer than %<min>s ' \
                    'characters.'.freeze
 
-      def check(node, args, min:)
+      def check(node, args)
         args.each do |arg|
-          source = arg.children.first.to_s
-          next if allowed_names.include?(source)
-          range = arg_range(arg, source.size)
-          case_offense(node, range) if uppercase?(source)
-          num_offense(node, range) if ends_with_num?(source)
-          length_offense(node, range, min) unless long_enough?(source, min)
+          name = arg.children.first.to_s
+          next if allowed_names.include?(name)
+          range = arg_range(arg, name.size)
+          issue_offenses(node, range, name)
         end
       end
 
+      private
+
+      def issue_offenses(node, range, name)
+        case_offense(node, range) if uppercase?(name)
+        length_offense(node, range) unless long_enough?(name)
+        return if allow_nums
+        num_offense(node, range) if ends_with_num?(name)
+      end
+
       def case_offense(node, range)
         add_offense(node, location: range,
                           message: format(CASE_MSG, name_type: name_type(node)))
@@ -47,15 +54,15 @@ def ends_with_num?(name)
         name[-1] =~ /\d/
       end
 
-      def length_offense(node, range, min)
+      def length_offense(node, range)
         add_offense(node, location: range,
                           message: format(LENGTH_MSG,
                                           name_type: name_type(node).capitalize,
-                                          min: min))
+                                          min: min_length))
       end
 
-      def long_enough?(name, min)
-        name.size >= min
+      def long_enough?(name)
+        name.size >= min_length
       end
 
       def arg_range(arg, length)
@@ -66,7 +73,15 @@ def arg_range(arg, length)
       end
 
       def allowed_names
-        cop_config['AllowedNames'] || []
+        cop_config['AllowedNames']
+      end
+
+      def allow_nums
+        cop_config['AllowNamesEndingInNumbers']
+      end
+
+      def min_length
+        cop_config['MinNameLength']
       end
     end
   end

lib/rubocop/cop/naming/uncommunicative_block_param_name.rb

@@ -30,13 +30,7 @@ class UncommunicativeBlockParamName < Cop
 
         def on_block(node)
           return unless node.arguments?
-          check(node, node.arguments, min: min_length)
-        end
-
-        private
-
-        def min_length
-          cop_config['MinParamNameLength']
+          check(node, node.arguments)
         end
       end
     end

lib/rubocop/cop/naming/uncommunicative_method_arg_name.rb

@@ -37,15 +37,9 @@ class UncommunicativeMethodArgName < Cop
 
         def on_def(node)
           return unless node.arguments?
-          check(node, node.arguments, min: min_length)
+          check(node, node.arguments)
         end
         alias on_defs on_def
-
-        private
-
-        def min_length
-          cop_config['MinArgNameLength']
-        end
       end
     end
   end

manual/cops_naming.md

@@ -399,8 +399,9 @@ baz { |age, height, gender| do_stuff(age, height, gender) }
 
 Name | Default value | Configurable values
 --- | --- | ---
-MinParamNameLength | `1` | Integer
-AllowedNames | `<none>` | 
+MinNameLength | `1` | Integer
+AllowNamesEndingInNumbers | `true` | Boolean
+AllowedNames | `[]` | Array
 
 ## Naming/UncommunicativeMethodArgName
 
@@ -446,8 +447,9 @@ end
 
 Name | Default value | Configurable values
 --- | --- | ---
-MinArgNameLength | `3` | Integer
-AllowedNames | `<none>` | 
+MinNameLength | `3` | Integer
+AllowNamesEndingInNumbers | `true` | Boolean
+AllowedNames | `[]` | Array
 
 ## Naming/VariableName
 

spec/rubocop/cli_spec.rb

@@ -1516,12 +1516,11 @@ def method(foo, bar, qux, fred, arg5, f) end #{'#' * 45}
         expect($stdout.string).to eq(<<-RESULT.strip_indent)
             == example/example1.rb ==
             C:  1: 11: Metrics/ParameterLists: Avoid parameter lists longer than 5 parameters. [6/5]
-            C:  1: 33: Naming/UncommunicativeMethodArgName: Do not end method argument with a number.
             C:  1: 39: Naming/UncommunicativeMethodArgName: Method argument must be longer than 3 characters.
             C:  1: 46: Style/CommentedKeyword: Do not place comments on the same line as the def keyword.
             E:  1: 81: Metrics/LineLength: Line is too long. [90/80]
 
-            1 file inspected, 5 offenses detected
+            1 file inspected, 4 offenses detected
         RESULT
         expect($stderr.string).to eq('')
       end

spec/rubocop/cop/naming/uncommunicative_block_param_name_spec.rb

@@ -3,7 +3,12 @@
 RSpec.describe RuboCop::Cop::Naming::UncommunicativeBlockParamName, :config do
   subject(:cop) { described_class.new(config) }
 
-  let(:cop_config) { { 'MinParamNameLength' => 2 } }
+  let(:cop_config) do
+    {
+      'MinNameLength' => 2,
+      'AllowNamesEndingInNumbers' => false
+    }
+  end
 
   it 'does not register for block without parameters' do
     expect_no_offenses(<<-RUBY.strip_indent)
@@ -65,7 +70,8 @@
   context 'with AllowedNames' do
     let(:cop_config) do
       {
-        'AllowedNames' => %w[foo1 foo2]
+        'AllowedNames' => %w[foo1 foo2],
+        'AllowNamesEndingInNumbers' => false
       }
     end
 
@@ -82,4 +88,18 @@
       RUBY
     end
   end
+
+  context 'with AllowNamesEndingInNumbers' do
+    let(:cop_config) do
+      {
+        'AllowNamesEndingInNumbers' => true
+      }
+    end
+
+    it 'accept params that end in numbers' do
+      expect_no_offenses(<<-RUBY.strip_indent)
+        something { |foo1, bar2, qux3| do_that_stuff }
+      RUBY
+    end
+  end
 end

spec/rubocop/cop/naming/uncommunicative_method_arg_name_spec.rb

@@ -3,7 +3,12 @@
 RSpec.describe RuboCop::Cop::Naming::UncommunicativeMethodArgName, :config do
   subject(:cop) { described_class.new(config) }
 
-  let(:cop_config) { { 'MinParamNameLength' => 3 } }
+  let(:cop_config) do
+    {
+      'MinNameLength' => 3,
+      'AllowNamesEndingInNumbers' => false
+    }
+  end
 
   it 'does not register for method without arguments' do
     expect_no_offenses(<<-RUBY.strip_indent)
@@ -116,7 +121,8 @@ def self.something(y, num1, oFo)
   context 'with AllowedNames' do
     let(:cop_config) do
       {
-        'AllowedNames' => %w[foo1 foo2]
+        'AllowedNames' => %w[foo1 foo2],
+        'AllowNamesEndingInNumbers' => false
       }
     end
 
@@ -137,4 +143,20 @@ def quux(bar, bar1)
       RUBY
     end
   end
+
+  context 'with AllowNamesEndingInNumbers' do
+    let(:cop_config) do
+      {
+        'AllowNamesEndingInNumbers' => true
+      }
+    end
+
+    it 'accept arguments that end in numbers' do
+      expect_no_offenses(<<-RUBY.strip_indent)
+        def something(foo1, bar2, qux3)
+          do_stuff
+        end
+      RUBY
+    end
+  end
 end