rubocop 0.76.0 → 0.77.0

data/lib/rubocop/config_validator.rb

@@ -127,9 +127,7 @@ module RuboCop
       valid_cop_names.each do |name|
         validate_section_presence(name)
         each_invalid_parameter(name) do |param, supported_params|
-          # FIXME: Remove .to_s, which works around a JRuby bug:
-          #   https://github.com/jruby/jruby/issues/5935
-          warn Rainbow(<<~MESSAGE).yellow.to_s
+          warn Rainbow(<<~MESSAGE).yellow
             Warning: #{name} does not support #{param} parameter.
 
             Supported parameters are:

data/lib/rubocop/cop/bundler/gem_comment.rb

@@ -24,7 +24,7 @@ module RuboCop
 
         def on_send(node)
           return unless gem_declaration?(node)
-          return if whitelisted_gem?(node)
+          return if ignored_gem?(node)
           return if commented?(node)
 
           add_offense(node)
@@ -54,9 +54,9 @@ module RuboCop
             comment_line?(node2.loc.expression.source)
         end
 
-        def whitelisted_gem?(node)
-          whitelist = Array(cop_config['Whitelist'])
-          whitelist.include?(node.first_argument.value)
+        def ignored_gem?(node)
+          ignored_gems = Array(cop_config['IgnoredGems'])
+          ignored_gems.include?(node.first_argument.value)
         end
       end
     end

data/lib/rubocop/cop/cop.rb

@@ -217,6 +217,25 @@ module RuboCop
         !relevant_file?(file)
       end
 
+      # This method should be overriden when a cop's behavior depends
+      # on state that lives outside of these locations:
+      #
+      #   (1) the file under inspection
+      #   (2) the cop's source code
+      #   (3) the config (eg a .rubocop.yml file)
+      #
+      # For example, some cops may want to look at other parts of
+      # the codebase being inspected to find violations. A cop may
+      # use the presence or absence of file `foo.rb` to determine
+      # whether a certain violation exists in `bar.rb`.
+      #
+      # Overriding this method allows the cop to indicate to RuboCop's
+      # ResultCache system when those external dependencies change,
+      # ie when the ResultCache should be invalidated.
+      def external_dependency_checksum
+        nil
+      end
+
       private
 
       def find_message(node, message)

data/lib/rubocop/cop/correctors/space_corrector.rb

@@ -12,12 +12,11 @@ module RuboCop
         def empty_corrections(processed_source, corrector, empty_config,
                               left_token, right_token)
           @processed_source = processed_source
+          range = range_between(left_token.end_pos, right_token.begin_pos)
           if offending_empty_space?(empty_config, left_token, right_token)
-            range = side_space_range(range: left_token.pos, side: :right)
             corrector.remove(range)
             corrector.insert_after(left_token.pos, ' ')
           elsif offending_empty_no_space?(empty_config, left_token, right_token)
-            range = side_space_range(range: left_token.pos, side: :right)
             corrector.remove(range)
           end
         end

data/lib/rubocop/cop/internal_affairs.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'internal_affairs/method_name_equal'
 require_relative 'internal_affairs/node_destructuring'
 require_relative 'internal_affairs/node_type_predicate'
 require_relative 'internal_affairs/offense_location_keyword'

data/lib/rubocop/cop/internal_affairs/method_name_equal.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InternalAffairs
+      # Checks that method names are checked using `method?` method.
+      #
+      # @example
+      #   # bad
+      #   node.method_name == :do_something
+      #
+      #   # good
+      #   node.method?(:do_something)
+      #
+      class MethodNameEqual < Cop
+        include RangeHelp
+
+        MSG = 'Use `method?(%<method_name>s)` instead of ' \
+              '`method_name == %<method_name>s`.'
+
+        def_node_matcher :method_name?, <<~PATTERN
+          (send
+            $(send
+              (...) :method_name) :==
+            $...)
+        PATTERN
+
+        def on_send(node)
+          method_name?(node) do |method_name_node, method_name_arg|
+            message = format(MSG, method_name: method_name_arg.first.source)
+
+            range = range(method_name_node, node)
+
+            add_offense(node, location: range, message: message)
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            method_name?(node) do |method_name_node, method_name_arg|
+              corrector.replace(
+                range(method_name_node, node),
+                "method?(#{method_name_arg.first.source})"
+              )
+            end
+          end
+        end
+
+        private
+
+        def range(method_name_node, node)
+          range_between(
+            method_name_node.loc.selector.begin_pos, node.source_range.end_pos
+          )
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/layout/{align_arguments.rb → argument_alignment.rb}

@@ -37,7 +37,7 @@ module RuboCop
       #
       #   foo :bar,
       #       :baz
-      class AlignArguments < Cop
+      class ArgumentAlignment < Cop
         include Alignment
 
         ALIGN_PARAMS_MSG = 'Align the arguments of a method call if ' \

data/lib/rubocop/cop/layout/{align_array.rb → array_alignment.rb}

@@ -20,7 +20,7 @@ module RuboCop
       #   a = ['run',
       #        'forrest',
       #        'run']
-      class AlignArray < Cop
+      class ArrayAlignment < Cop
         include Alignment
 
         MSG = 'Align the elements of an array literal if they span more ' \

data/lib/rubocop/cop/layout/{indent_assignment.rb → assignment_indentation.rb}

@@ -21,7 +21,7 @@ module RuboCop
       #
       # The indentation of the remaining lines can be corrected with
       # other cops such as `IndentationConsistency` and `EndAlignment`.
-      class IndentAssignment < Cop
+      class AssignmentIndentation < Cop
         include CheckAssignment
         include Alignment
 

data/lib/rubocop/cop/layout/extra_spacing.rb

@@ -114,7 +114,7 @@ module RuboCop
 
         # Returns an array of ranges that should not be reported. It's the
         # extra spaces between the keys and values in a multiline hash,
-        # since those are handled by the Style/AlignHash cop.
+        # since those are handled by the Layout/HashAlignment cop.
         def ignored_ranges(ast)
           return [] unless ast
 

data/lib/rubocop/cop/layout/{indent_first_argument.rb → first_argument_indentation.rb}

@@ -5,11 +5,11 @@ module RuboCop
     # rubocop:disable Metrics/LineLength
     module Layout
       # This cop checks the indentation of the first argument in a method call.
-      # Arguments after the first one are checked by Layout/AlignArguments,
+      # Arguments after the first one are checked by Layout/ArgumentAlignment,
       # not by this cop.
       #
       # For indenting the first parameter of method *definitions*, check out
-      # Layout/IndentFirstParameter.
+      # Layout/FirstParameterIndentation.
       #
       # @example
       #
@@ -142,7 +142,7 @@ module RuboCop
       #     nested_first_param),
       #   second_param
       #
-      class IndentFirstArgument < Cop
+      class FirstArgumentIndentation < Cop
         # rubocop:enable Metrics/LineLength
         include Alignment
         include ConfigurableEnforcedStyle

data/lib/rubocop/cop/layout/{indent_first_array_element.rb → first_array_element_indentation.rb}

@@ -5,7 +5,7 @@ module RuboCop
     module Layout
       # This cop checks the indentation of the first element in an array literal
       # where the opening bracket and the first element are on separate lines.
-      # The other elements' indentations are handled by the AlignArray cop.
+      # The other elements' indentations are handled by the ArrayAlignment cop.
       #
       # By default, array literals that are arguments in a method call with
       # parentheses, and where the opening square bracket of the array is on the
@@ -22,7 +22,7 @@ module RuboCop
       # @example EnforcedStyle: special_inside_parentheses (default)
       #   # The `special_inside_parentheses` style enforces that the first
       #   # element in an array literal where the opening bracket and first
-      #   # element are on seprate lines is indented one step (two spaces) more
+      #   # element are on separate lines is indented one step (two spaces) more
       #   # than the position inside the opening parenthesis.
       #
       #   #bad
@@ -44,7 +44,7 @@ module RuboCop
       # @example EnforcedStyle: consistent
       #   # The `consistent` style enforces that the first element in an array
       #   # literal where the opening bracket and the first element are on
-      #   # seprate lines is indented the same as an array literal which is not
+      #   # separate lines is indented the same as an array literal which is not
       #   # defined inside a method call.
       #
       #   #bad
@@ -79,7 +79,7 @@ module RuboCop
       #   and_now_for_something = [
       #                             :completely_different
       #                           ]
-      class IndentFirstArrayElement < Cop
+      class FirstArrayElementIndentation < Cop
         include Alignment
         include ConfigurableEnforcedStyle
         include MultilineElementIndentation

data/lib/rubocop/cop/layout/{indent_first_hash_element.rb → first_hash_element_indentation.rb}

@@ -5,7 +5,7 @@ module RuboCop
     module Layout
       # This cop checks the indentation of the first key in a hash literal
       # where the opening brace and the first key are on separate lines. The
-      # other keys' indentations are handled by the AlignHash cop.
+      # other keys' indentations are handled by the HashAlignment cop.
       #
       # By default, Hash literals that are arguments in a method call with
       # parentheses, and where the opening curly brace of the hash is on the
@@ -77,7 +77,7 @@ module RuboCop
       #   and_now_for_something = {
       #                             completely: :different
       #                           }
-      class IndentFirstHashElement < Cop
+      class FirstHashElementIndentation < Cop
         include Alignment
         include ConfigurableEnforcedStyle
         include MultilineElementIndentation
@@ -149,7 +149,7 @@ module RuboCop
         def separator_style?(first_pair)
           separator = first_pair.loc.operator
           key = "Enforced#{separator.is?(':') ? 'Colon' : 'HashRocket'}Style"
-          config.for_cop('Layout/AlignHash')[key] == 'separator'
+          config.for_cop('Layout/HashAlignment')[key] == 'separator'
         end
 
         def check_based_on_longest_key(hash_node, left_brace, left_parenthesis)

data/lib/rubocop/cop/layout/{indent_first_parameter.rb → first_parameter_indentation.rb}

@@ -5,10 +5,10 @@ module RuboCop
     module Layout
       # This cop checks the indentation of the first parameter in a method
       # definition. Parameters after the first one are checked by
-      # Layout/AlignParameters, not by this cop.
+      # Layout/ParameterAlignment, not by this cop.
       #
       # For indenting the first argument of method *calls*, check out
-      # Layout/IndentFirstArgument, which supports options related to
+      # Layout/FirstArgumentIndentation, which supports options related to
       # nesting that are irrelevant for method *definitions*.
       #
       # @example
@@ -41,7 +41,7 @@ module RuboCop
       #   second_param)
       #     123
       #   end
-      class IndentFirstParameter < Cop
+      class FirstParameterIndentation < Cop
         include Alignment
         include ConfigurableEnforcedStyle
         include MultilineElementIndentation

data/lib/rubocop/cop/layout/{align_hash.rb → hash_alignment.rb}

@@ -175,8 +175,8 @@ module RuboCop
       #   do_something({foo: 1,
       #     bar: 2})
       #
-      class AlignHash < Cop
-        include HashAlignment
+      class HashAlignment < Cop
+        include HashAlignmentStyles
         include RangeHelp
 
         MSG = 'Align the elements of a hash literal if they span more than ' \

data/lib/rubocop/cop/layout/{indent_heredoc.rb → heredoc_indentation.rb}

@@ -49,7 +49,7 @@ module RuboCop
       #     something
       #   RUBY
       #
-      class IndentHeredoc < Cop
+      class HeredocIndentation < Cop
         include Heredoc
         include ConfigurableEnforcedStyle
 

data/lib/rubocop/cop/layout/{leading_blank_lines.rb → leading_empty_lines.rb}

@@ -27,7 +27,7 @@ module RuboCop
       #   # good
       #   # (start of file)
       #   # a comment
-      class LeadingBlankLines < Cop
+      class LeadingEmptyLines < Cop
         MSG = 'Unnecessary blank line at the beginning of the source.'
 
         def investigate(processed_source)

data/lib/rubocop/cop/layout/multiline_method_argument_line_breaks.rb

@@ -26,7 +26,7 @@ module RuboCop
           'on a separate line.'
 
         def on_send(node)
-          return if node.method_name == :[]=
+          return if node.method?(:[]=)
 
           args = node.arguments
 

data/lib/rubocop/cop/layout/{align_parameters.rb → parameter_alignment.rb}

@@ -68,7 +68,7 @@ module RuboCop
       #        baz)
       #     123
       #   end
-      class AlignParameters < Cop
+      class ParameterAlignment < Cop
         include Alignment
 
         ALIGN_PARAMS_MSG = 'Align the parameters of a method definition if ' \

data/lib/rubocop/cop/layout/space_around_keyword.rb

@@ -30,10 +30,12 @@ module RuboCop
 
         DO = 'do'
         SAFE_NAVIGATION = '&.'
+        NAMESPACE_OPERATOR = '::'
         ACCEPT_LEFT_PAREN =
           %w[break defined? next not rescue return super yield].freeze
         ACCEPT_LEFT_SQUARE_BRACKET =
           %w[super yield].freeze
+        ACCEPT_NAMESPACE_OPERATOR = 'super'
 
         def on_and(node)
           check(node, [:operator].freeze) if node.keyword?
@@ -193,6 +195,8 @@ module RuboCop
 
           return false if accepted_opening_delimiter?(range, char)
           return false if safe_navigation_call?(range, pos)
+          return false if accept_namespace_operator?(range) &&
+                          namespace_operator?(range, pos)
 
           char !~ /[\s;,#\\\)\}\]\.]/
         end
@@ -212,10 +216,18 @@ module RuboCop
           ACCEPT_LEFT_SQUARE_BRACKET.include?(range.source)
         end
 
+        def accept_namespace_operator?(range)
+          ACCEPT_NAMESPACE_OPERATOR == range.source
+        end
+
         def safe_navigation_call?(range, pos)
           range.source_buffer.source[pos, 2].start_with?(SAFE_NAVIGATION)
         end
 
+        def namespace_operator?(range, pos)
+          range.source_buffer.source[pos, 2].start_with?(NAMESPACE_OPERATOR)
+        end
+
         def preceded_by_operator?(node, _range)
           # regular dotted method calls bind more tightly than operators
           # so we need to climb up the AST past them

data/lib/rubocop/cop/layout/space_around_operators.rb

@@ -169,7 +169,7 @@ module RuboCop
         end
 
         def align_hash_cop_config
-          config.for_cop('Layout/AlignHash')
+          config.for_cop('Layout/HashAlignment')
         end
 
         def hash_table_style?

data/lib/rubocop/cop/layout/{trailing_blank_lines.rb → trailing_empty_lines.rb}

@@ -37,7 +37,7 @@ module RuboCop
       #   class Foo; end
       #   # EOF
       #
-      class TrailingBlankLines < Cop
+      class TrailingEmptyLines < Cop
         include ConfigurableEnforcedStyle
         include RangeHelp
 

data/lib/rubocop/cop/lint/disjunctive_assignment_in_constructor.rb

@@ -33,7 +33,7 @@ module RuboCop
 
         # @param [DefNode] node a constructor definition
         def check(node)
-          return unless node.method_name == :initialize
+          return unless node.method?(:initialize)
 
           check_body(node.body)
         end

data/lib/rubocop/cop/lint/{duplicated_key.rb → duplicate_hash_key.rb}

@@ -18,7 +18,7 @@ module RuboCop
       #   # good
       #
       #   hash = { food: 'apple', other_food: 'orange' }
-      class DuplicatedKey < Cop
+      class DuplicateHashKey < Cop
         include Duplication
 
         MSG = 'Duplicated key in hash literal.'

data/lib/rubocop/cop/lint/ineffective_access_modifier.rb

@@ -117,7 +117,7 @@ module RuboCop
         end
 
         def correct_visibility?(node, modifier, ignored_methods)
-          return true if modifier.nil? || modifier.method_name == :public
+          return true if modifier.nil? || modifier.method?(:public)
 
           ignored_methods.include?(node.method_name)
         end

data/lib/rubocop/cop/lint/{multiple_compare.rb → multiple_comparison.rb}

@@ -21,7 +21,7 @@ module RuboCop
       #
       #   x < y && y < z
       #   10 <= x && x <= 20
-      class MultipleCompare < Cop
+      class MultipleComparison < Cop
         MSG = 'Use the `&&` operator to compare multiple values.'
 
         def_node_matcher :multiple_compare?, <<~PATTERN

data/lib/rubocop/cop/lint/redundant_splat_expansion.rb

@@ -146,7 +146,7 @@ module RuboCop
           grandparent = node.parent.parent
 
           parent.when_type? || parent.send_type? || part_of_an_array?(node) ||
-            (grandparent&.resbody_type?)
+            grandparent&.resbody_type?
         end
 
         def remove_brackets(array)