rubocop 0.87.1

data/lib/rubocop/cop/naming/method_name.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Naming
+      # This cop makes sure that all methods use the configured style,
+      # snake_case or camelCase, for their names.
+      #
+      # This cop has `IgnoredPatterns` configuration option.
+      #
+      #   Naming/MethodName:
+      #     IgnoredPatterns:
+      #       - '\A\s*onSelectionBulkChange\s*'
+      #       - '\A\s*onSelectionCleared\s*'
+      #
+      # Method names matching patterns are always allowed.
+      #
+      # @example EnforcedStyle: snake_case (default)
+      #   # bad
+      #   def fooBar; end
+      #
+      #   # good
+      #   def foo_bar; end
+      #
+      # @example EnforcedStyle: camelCase
+      #   # bad
+      #   def foo_bar; end
+      #
+      #   # good
+      #   def fooBar; end
+      class MethodName < Base
+        include ConfigurableNaming
+        include IgnoredPattern
+        include RangeHelp
+
+        MSG = 'Use %<style>s for method names.'
+
+        def_node_matcher :sym_name, '(sym $_name)'
+        def_node_matcher :str_name, '(str $_name)'
+
+        def on_send(node)
+          return unless (attrs = node.attribute_accessor?)
+
+          attrs.last.each do |name_item|
+            name = attr_name(name_item)
+            next if !name || matches_ignored_pattern?(name)
+
+            check_name(node, name, range_position(node))
+          end
+        end
+
+        def on_def(node)
+          return if node.operator_method? ||
+                    matches_ignored_pattern?(node.method_name)
+
+          check_name(node, node.method_name, node.loc.name)
+        end
+        alias on_defs on_def
+
+        private
+
+        def attr_name(name_item)
+          sym_name(name_item) || str_name(name_item)
+        end
+
+        def range_position(node)
+          selector_end_pos = node.loc.selector.end_pos + 1
+          expr_end_pos = node.loc.expression.end_pos
+
+          range_between(selector_end_pos, expr_end_pos)
+        end
+
+        def message(style)
+          format(MSG, style: style)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/naming/method_parameter_name.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Naming
+      # This cop checks method parameter names for how descriptive they
+      # are. It is highly configurable.
+      #
+      # The `MinNameLength` config option takes an integer. It represents
+      # the minimum amount of characters the name must be. Its default is 3.
+      # The `AllowNamesEndingInNumbers` config option takes a boolean. When
+      # set to false, this cop will register offenses for names ending with
+      # numbers. Its default is false. The `AllowedNames` config option
+      # takes an array of permitted names that will never register an
+      # offense. The `ForbiddenNames` config option takes an array of
+      # restricted names that will always register an offense.
+      #
+      # @example
+      #   # bad
+      #   def bar(varOne, varTwo)
+      #     varOne + varTwo
+      #   end
+      #
+      #   # With `AllowNamesEndingInNumbers` set to false
+      #   def foo(num1, num2)
+      #     num1 * num2
+      #   end
+      #
+      #   # With `MinArgNameLength` set to number greater than 1
+      #   def baz(a, b, c)
+      #     do_stuff(a, b, c)
+      #   end
+      #
+      #   # good
+      #   def bar(thud, fred)
+      #     thud + fred
+      #   end
+      #
+      #   def foo(speed, distance)
+      #     speed * distance
+      #   end
+      #
+      #   def baz(age_a, height_b, gender_c)
+      #     do_stuff(age_a, height_b, gender_c)
+      #   end
+      class MethodParameterName < Cop
+        include UncommunicativeName
+
+        def on_def(node)
+          return unless node.arguments?
+
+          check(node, node.arguments)
+        end
+        alias on_defs on_def
+      end
+    end
+  end
+end

data/lib/rubocop/cop/naming/predicate_name.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Naming
+      # This cop makes sure that predicates are named properly.
+      #
+      # @example
+      #   # bad
+      #   def is_even(value)
+      #   end
+      #
+      #   def is_even?(value)
+      #   end
+      #
+      #   # good
+      #   def even?(value)
+      #   end
+      #
+      #   # bad
+      #   def has_value
+      #   end
+      #
+      #   def has_value?
+      #   end
+      #
+      #   # good
+      #   def value?
+      #   end
+      class PredicateName < Cop
+        include AllowedMethods
+
+        def_node_matcher :dynamic_method_define, <<~PATTERN
+          (send nil? #method_definition_macros
+            (sym $_)
+            ...)
+        PATTERN
+
+        def on_send(node)
+          dynamic_method_define(node) do |method_name|
+            predicate_prefixes.each do |prefix|
+              next if allowed_method_name?(method_name.to_s, prefix)
+
+              add_offense(
+                node,
+                location: node.first_argument.loc.expression,
+                message: message(method_name,
+                                 expected_name(method_name.to_s, prefix))
+              )
+            end
+          end
+        end
+
+        def on_def(node)
+          predicate_prefixes.each do |prefix|
+            method_name = node.method_name.to_s
+
+            next if allowed_method_name?(method_name, prefix)
+
+            add_offense(
+              node,
+              location: :name,
+              message: message(method_name, expected_name(method_name, prefix))
+            )
+          end
+        end
+        alias on_defs on_def
+
+        private
+
+        def allowed_method_name?(method_name, prefix)
+          !method_name.match?(/^#{prefix}[^0-9]/) ||
+            method_name == expected_name(method_name, prefix) ||
+            method_name.end_with?('=') ||
+            allowed_method?(method_name)
+        end
+
+        def expected_name(method_name, prefix)
+          new_name = if forbidden_prefixes.include?(prefix)
+                       method_name.sub(prefix, '')
+                     else
+                       method_name.dup
+                     end
+          new_name << '?' unless method_name.end_with?('?')
+          new_name
+        end
+
+        def message(method_name, new_name)
+          "Rename `#{method_name}` to `#{new_name}`."
+        end
+
+        def forbidden_prefixes
+          cop_config['ForbiddenPrefixes']
+        end
+
+        def predicate_prefixes
+          cop_config['NamePrefix']
+        end
+
+        def method_definition_macros(macro_name)
+          cop_config['MethodDefinitionMacros'].include?(macro_name.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/naming/rescued_exceptions_variable_name.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Naming
+      # This cop makes sure that rescued exceptions variables are named as
+      # expected.
+      #
+      # The `PreferredName` config option takes a `String`. It represents
+      # the required name of the variable. Its default is `e`.
+      #
+      # @example PreferredName: e (default)
+      #   # bad
+      #   begin
+      #     # do something
+      #   rescue MyException => exception
+      #     # do something
+      #   end
+      #
+      #   # good
+      #   begin
+      #     # do something
+      #   rescue MyException => e
+      #     # do something
+      #   end
+      #
+      #   # good
+      #   begin
+      #     # do something
+      #   rescue MyException => _e
+      #     # do something
+      #   end
+      #
+      # @example PreferredName: exception
+      #   # bad
+      #   begin
+      #     # do something
+      #   rescue MyException => e
+      #     # do something
+      #   end
+      #
+      #   # good
+      #   begin
+      #     # do something
+      #   rescue MyException => exception
+      #     # do something
+      #   end
+      #
+      #   # good
+      #   begin
+      #     # do something
+      #   rescue MyException => _exception
+      #     # do something
+      #   end
+      #
+      class RescuedExceptionsVariableName < Cop
+        MSG = 'Use `%<preferred>s` instead of `%<bad>s`.'
+
+        def on_resbody(node)
+          name = variable_name(node)
+          return unless name
+          return if preferred_name(name).to_sym == name
+
+          add_offense(node, location: offense_range(node))
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            offending_name = variable_name(node)
+            preferred_name = preferred_name(offending_name)
+            corrector.replace(offense_range(node), preferred_name)
+
+            node.body&.each_descendant(:lvar) do |var|
+              next unless var.children.first == offending_name
+
+              corrector.replace(var, preferred_name)
+            end
+          end
+        end
+
+        private
+
+        def offense_range(resbody)
+          variable = resbody.exception_variable
+          variable.loc.expression
+        end
+
+        def preferred_name(variable_name)
+          preferred_name = cop_config.fetch('PreferredName', 'e')
+          if variable_name.to_s.start_with?('_')
+            "_#{preferred_name}"
+          else
+            preferred_name
+          end
+        end
+
+        def variable_name(node)
+          asgn_node = node.exception_variable
+          return unless asgn_node
+
+          asgn_node.children.last
+        end
+
+        def message(node)
+          offending_name = variable_name(node)
+          preferred_name = preferred_name(offending_name)
+          format(MSG, preferred: preferred_name, bad: offending_name)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/naming/variable_name.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Naming
+      # This cop makes sure that all variables use the configured style,
+      # snake_case or camelCase, for their names.
+      #
+      # @example EnforcedStyle: snake_case (default)
+      #   # bad
+      #   fooBar = 1
+      #
+      #   # good
+      #   foo_bar = 1
+      #
+      # @example EnforcedStyle: camelCase
+      #   # bad
+      #   foo_bar = 1
+      #
+      #   # good
+      #   fooBar = 1
+      class VariableName < Base
+        include ConfigurableNaming
+
+        MSG = 'Use %<style>s for variable names.'
+
+        def on_lvasgn(node)
+          name, = *node
+          return unless name
+
+          check_name(node, name, node.loc.name)
+        end
+        alias on_ivasgn    on_lvasgn
+        alias on_cvasgn    on_lvasgn
+        alias on_arg       on_lvasgn
+        alias on_optarg    on_lvasgn
+        alias on_restarg   on_lvasgn
+        alias on_kwoptarg  on_lvasgn
+        alias on_kwarg     on_lvasgn
+        alias on_kwrestarg on_lvasgn
+        alias on_blockarg  on_lvasgn
+        alias on_lvar      on_lvasgn
+
+        private
+
+        def message(style)
+          format(MSG, style: style)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/naming/variable_number.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Naming
+      # This cop makes sure that all numbered variables use the
+      # configured style, snake_case, normalcase, or non_integer,
+      # for their numbering.
+      #
+      # @example EnforcedStyle: snake_case
+      #   # bad
+      #
+      #   variable1 = 1
+      #
+      #   # good
+      #
+      #   variable_1 = 1
+      #
+      # @example EnforcedStyle: normalcase (default)
+      #   # bad
+      #
+      #   variable_1 = 1
+      #
+      #   # good
+      #
+      #   variable1 = 1
+      #
+      # @example EnforcedStyle: non_integer
+      #   # bad
+      #
+      #   variable1 = 1
+      #
+      #   variable_1 = 1
+      #
+      #   # good
+      #
+      #   variableone = 1
+      #
+      #   variable_one = 1
+      class VariableNumber < Base
+        include ConfigurableNumbering
+
+        MSG = 'Use %<style>s for variable numbers.'
+
+        def on_arg(node)
+          name, = *node
+          check_name(node, name, node.loc.name)
+        end
+        alias on_lvasgn on_arg
+        alias on_ivasgn on_arg
+        alias on_cvasgn on_arg
+
+        private
+
+        def message(style)
+          format(MSG, style: style)
+        end
+      end
+    end
+  end
+end