rubocop 1.26.0 → 1.36.0

data/lib/rubocop/cop/mixin/percent_array.rb

@@ -44,13 +44,26 @@ module RuboCop
         no_acceptable_style! if brackets_required
 
         bracketed_array = build_bracketed_array(node)
-        message = format(self.class::ARRAY_MSG, prefer: bracketed_array)
+        message = build_message_for_bracketed_array(bracketed_array)
 
         add_offense(node, message: message) do |corrector|
           corrector.replace(node, bracketed_array)
         end
       end
 
+      # @param [String] preferred_array_code
+      # @return [String]
+      def build_message_for_bracketed_array(preferred_array_code)
+        format(
+          self.class::ARRAY_MSG,
+          prefer: if preferred_array_code.include?("\n")
+                    'an array literal `[...]`'
+                  else
+                    "`#{preferred_array_code}`"
+                  end
+        )
+      end
+
       def check_bracketed_array(node, literal_prefix)
         return if allowed_bracket_array?(node)
 
@@ -63,6 +76,52 @@ module RuboCop
           percent_literal_corrector.correct(corrector, node, literal_prefix)
         end
       end
+
+      # @param [RuboCop::AST::ArrayNode] node
+      # @param [Array<String>] elements
+      # @return [String]
+      def build_bracketed_array_with_appropriate_whitespace(elements:, node:)
+        [
+          '[',
+          whitespace_leading(node),
+          elements.join(",#{whitespace_between(node)}"),
+          whitespace_trailing(node),
+          ']'
+        ].join
+      end
+
+      # Provides whitespace between elements for building a bracketed array.
+      #   %w[  a   b   c    ]
+      #         ^^^
+      # @param [RuboCop::AST::ArrayNode] node
+      # @return [String]
+      def whitespace_between(node)
+        if node.children.length >= 2
+          node.source[
+            node.children[0].loc.expression.end_pos...node.children[1].loc.expression.begin_pos
+          ]
+        else
+          ' '
+        end
+      end
+
+      # Provides leading whitespace for building a bracketed array.
+      #   %w[  a   b   c    ]
+      #      ^^
+      # @param [RuboCop::AST::ArrayNode] node
+      # @return [String]
+      def whitespace_leading(node)
+        node.source[node.loc.begin.end_pos...node.children[0].loc.expression.begin_pos]
+      end
+
+      # Provides trailing whitespace for building a bracketed array.
+      #   %w[  a   b   c    ]
+      #                 ^^^^
+      # @param [RuboCop::AST::ArrayNode] node
+      # @return [String]
+      def whitespace_trailing(node)
+        node.source[node.children[-1].loc.expression.end_pos...node.loc.end.begin_pos]
+      end
     end
   end
 end

data/lib/rubocop/cop/mixin/preferred_delimiters.rb

@@ -33,9 +33,9 @@ module RuboCop
             ensure_valid_preferred_delimiters
 
             if preferred_delimiters_config.key?('default')
-              PERCENT_LITERAL_TYPES.map do |type|
+              PERCENT_LITERAL_TYPES.to_h do |type|
                 [type, preferred_delimiters_config[type] || preferred_delimiters_config['default']]
-              end.to_h
+              end
             else
               preferred_delimiters_config
             end

data/lib/rubocop/cop/mixin/range_help.rb

@@ -51,10 +51,14 @@ module RuboCop
         Parser::Source::Range.new(buffer, begin_pos, end_pos)
       end
 
-      def range_with_surrounding_space(range:, side: :both,
-                                       newlines: true, whitespace: false,
-                                       continuations: false)
-        buffer = @processed_source.buffer
+      NOT_GIVEN = Module.new
+      def range_with_surrounding_space(range_positional = NOT_GIVEN, # rubocop:disable Metrics/ParameterLists
+                                       range: NOT_GIVEN, side: :both, newlines: true,
+                                       whitespace: false, continuations: false,
+                                       buffer: @processed_source.buffer)
+
+        range = range_positional unless range_positional == NOT_GIVEN
+
         src = buffer.source
 
         go_left, go_right = directions(side)
@@ -66,9 +70,8 @@ module RuboCop
         Parser::Source::Range.new(buffer, begin_pos, end_pos)
       end
 
-      def range_by_whole_lines(range, include_final_newline: false)
-        buffer = @processed_source.buffer
-
+      def range_by_whole_lines(range, include_final_newline: false,
+                               buffer: @processed_source.buffer)
         last_line = buffer.source_line(range.last_line)
         end_offset = last_line.length - range.last_column
         end_offset += 1 if include_final_newline

data/lib/rubocop/cop/mixin/statement_modifier.rb

@@ -63,7 +63,7 @@ module RuboCop
 
       def code_after(node)
         end_element = node.loc.end
-        code = end_element.source_line[end_element.last_column..-1]
+        code = end_element.source_line[end_element.last_column..]
         code unless code.empty?
       end
 

data/lib/rubocop/cop/mixin/string_help.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     # Classes that include this module just implement functions to determine
-    # what is an offense and how to do auto-correction. They get help with
+    # what is an offense and how to do autocorrection. They get help with
     # adding offenses for the faulty string nodes, and with filtering out
     # nodes.
     module StringHelp

data/lib/rubocop/cop/mixin/surrounding_space.rb

@@ -44,7 +44,8 @@ module RuboCop
         if extra_space?(left_token, :left) && !start_ok
           space_offense(node, left_token, :right, message, NO_SPACE_COMMAND)
         end
-        return if !extra_space?(right_token, :right) || end_ok
+        return if (!extra_space?(right_token, :right) || end_ok) ||
+                  (autocorrect_with_disable_uncorrectable? && !start_ok)
 
         space_offense(node, right_token, :left, message, NO_SPACE_COMMAND)
       end
@@ -58,7 +59,8 @@ module RuboCop
         unless extra_space?(left_token, :left) || start_ok
           space_offense(node, left_token, :none, message, SPACE_COMMAND)
         end
-        return if extra_space?(right_token, :right) || end_ok
+        return if (extra_space?(right_token, :right) || end_ok) ||
+                  (autocorrect_with_disable_uncorrectable? && !start_ok)
 
         space_offense(node, right_token, :none, message, SPACE_COMMAND)
       end

data/lib/rubocop/cop/mixin/trailing_comma.rb

@@ -159,7 +159,7 @@ module RuboCop
       def autocorrect_range(item)
         expr = item.source_range
         ix = expr.source.rindex("\n") || 0
-        ix += expr.source[ix..-1] =~ /\S/
+        ix += expr.source[ix..] =~ /\S/
 
         range_between(expr.begin_pos + ix, expr.end_pos)
       end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Naming
-      # This cop makes sure that accessor methods are named properly. Applies
+      # Makes sure that accessor methods are named properly. Applies
       # to both instance and class methods.
       #
       # NOTE: Offenses are only registered for methods with the expected
@@ -63,7 +63,9 @@ module RuboCop
         end
 
         def bad_writer_name?(node)
-          node.method_name.to_s.start_with?('set_') && node.arguments.one?
+          node.method_name.to_s.start_with?('set_') &&
+            node.arguments.one? &&
+            node.first_argument.arg_type?
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Naming
-      # This cop checks for non-ascii characters in identifier and constant names.
+      # Checks for non-ascii characters in identifier and constant names.
       # Identifiers are always checked and whether constants are checked
       # can be controlled using AsciiConstants config.
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Naming
-      # This cop makes sure that certain binary operator methods have their
+      # Makes sure that certain binary operator methods have their
       # sole  parameter named `other`.
       #
       # @example

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

@@ -9,9 +9,9 @@ module RuboCop
       # by `do_something(&)`.
       #
       # It also supports the opposite style by alternative `explicit` option.
-      # You can specify the block variable name for auto-correction with `BlockForwardingName`.
+      # You can specify the block variable name for autocorrection with `BlockForwardingName`.
       # The default variable name is `block`. If the name is already in use, it will not be
-      # auto-corrected.
+      # autocorrected.
       #
       # @example EnforcedStyle: anonymous (default)
       #
@@ -70,7 +70,7 @@ module RuboCop
           if style == :anonymous
             !explicit_block_argument?(last_argument) ||
               use_kwarg_in_method_definition?(node) ||
-              use_block_argument_as_local_variable?(node, last_argument.source[1..-1])
+              use_block_argument_as_local_variable?(node, last_argument.source[1..])
           else
             !anonymous_block_argument?(last_argument)
           end
@@ -107,7 +107,7 @@ module RuboCop
         def use_block_argument_as_local_variable?(node, last_argument)
           return if node.body.nil?
 
-          node.body.each_descendant(:lvar).any? do |lvar|
+          node.body.each_descendant(:lvar, :lvasgn).any? do |lvar|
             !lvar.parent.block_pass_type? && lvar.source == last_argument
           end
         end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Naming
-      # This cop checks block parameter names for how descriptive they
+      # Checks block parameter names for how descriptive they
       # are. It is highly configurable.
       #
       # The `MinNameLength` config option takes an integer. It represents
@@ -38,7 +38,7 @@ module RuboCop
       class BlockParameterName < Base
         include UncommunicativeName
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless node.arguments?
 
           check(node, node.arguments)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Naming
-      # This cop checks for class and module names with
+      # Checks for class and module names with
       # an underscore in them.
       #
       # `AllowedNames` config takes an array of permitted names.

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Naming
-      # This cop checks whether constant names are written using
+      # Checks whether constant names are written using
       # SCREAMING_SNAKE_CASE.
       #
       # To avoid false positives, it ignores cases in which we cannot know
@@ -72,10 +72,10 @@ module RuboCop
         PATTERN
 
         def allowed_conditional_expression_on_rhs?(node)
-          node&.if_type? && contains_contant?(node)
+          node&.if_type? && contains_constant?(node)
         end
 
-        def contains_contant?(node)
+        def contains_constant?(node)
           node.branches.any?(&:const_type?)
         end
       end

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

@@ -5,7 +5,7 @@ require 'pathname'
 module RuboCop
   module Cop
     module Naming
-      # This cop makes sure that Ruby source files have snake_case
+      # Makes sure that Ruby source files have snake_case
       # names. Ruby scripts (i.e. source files with a shebang in the
       # first line) are ignored.
       #
@@ -233,7 +233,7 @@ module RuboCop
           if start_index.nil?
             [to_module_name(components.last)]
           else
-            components[start_index..-1].map { |c| to_module_name(c) }
+            components[start_index..].map { |c| to_module_name(c) }
           end
         end
 

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Naming
-      # This cop checks that your heredocs are using the configured case.
+      # Checks that your heredocs are using the configured case.
       # By default it is configured to enforce uppercase heredocs.
       #
       # @example EnforcedStyle: uppercase (default)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Naming
-      # This cop checks that your heredocs are using meaningful delimiters.
+      # Checks that your heredocs are using meaningful delimiters.
       # By default it disallows `END` and `EO*`, and can be configured through
       # forbidden listing additional delimiters.
       #

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

@@ -214,13 +214,14 @@ module RuboCop
         end
 
         def mask_input(str)
-          return str if @allowed_regex.nil?
-
           safe_str = if str.valid_encoding?
                        str
                      else
                        str.encode('UTF-8', invalid: :replace, undef: :replace)
                      end
+
+          return safe_str if @allowed_regex.nil?
+
           safe_str.gsub(@allowed_regex) { |match| '*' * match.size }
         end
 

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Naming
-      # This cop checks for memoized methods whose instance variable name
+      # Checks for memoized methods whose instance variable name
       # does not match the method name. Applies to both regular methods
       # (defined with `def`) and dynamic methods (defined with
       # `define_method` or `define_singleton_method`).

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

@@ -3,13 +3,13 @@
 module RuboCop
   module Cop
     module Naming
-      # This cop makes sure that all methods use the configured style,
+      # Makes sure that all methods use the configured style,
       # snake_case or camelCase, for their names.
       #
-      # This cop has `IgnoredPatterns` configuration option.
+      # This cop has `AllowedPatterns` configuration option.
       #
       #   Naming/MethodName:
-      #     IgnoredPatterns:
+      #     AllowedPatterns:
       #       - '\A\s*onSelectionBulkChange\s*'
       #       - '\A\s*onSelectionCleared\s*'
       #
@@ -30,7 +30,7 @@ module RuboCop
       #   def fooBar; end
       class MethodName < Base
         include ConfigurableNaming
-        include IgnoredPattern
+        include AllowedPattern
         include RangeHelp
 
         MSG = 'Use %<style>s for method names.'
@@ -46,14 +46,14 @@ module RuboCop
 
           attrs.last.each do |name_item|
             name = attr_name(name_item)
-            next if !name || matches_ignored_pattern?(name)
+            next if !name || matches_allowed_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)
+          return if node.operator_method? || matches_allowed_pattern?(node.method_name)
 
           check_name(node, node.method_name, node.loc.name)
         end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Naming
-      # This cop checks method parameter names for how descriptive they
+      # Checks method parameter names for how descriptive they
       # are. It is highly configurable.
       #
       # The `MinNameLength` config option takes an integer. It represents

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

@@ -3,7 +3,30 @@
 module RuboCop
   module Cop
     module Naming
-      # This cop makes sure that predicates are named properly.
+      # Checks that predicate methods names end with a question mark and
+      # do not start with a forbidden prefix.
+      #
+      # A method is determined to be a predicate method if its name starts
+      # with one of the prefixes defined in the `NamePrefix` configuration.
+      # You can change what prefixes are considered by changing this option.
+      # Any method name that starts with one of these prefixes is required by
+      # the cop to end with a `?`. Other methods can be allowed by adding to
+      # the `AllowedMethods` configuration.
+      #
+      # NOTE: The `is_a?` method is allowed by default.
+      #
+      # If `ForbiddenPrefixes` is set, methods that start with the configured
+      # prefixes will not be allowed and will be removed by autocorrection.
+      #
+      # In other words, if `ForbiddenPrefixes` is empty, a method named `is_foo`
+      # will register an offense only due to the lack of question mark (and will be
+      # autocorrected to `is_foo?`). If `ForbiddenPrefixes` contains `is_`,
+      # `is_foo` will register an offense both because the ? is missing and because of
+      # the `is_` prefix, and will be corrected to `foo?`.
+      #
+      # NOTE: `ForbiddenPrefixes` is only applied to prefixes in `NamePrefix`;
+      # a prefix in the former but not the latter will not be considered by
+      # this cop.
       #
       # @example
       #   # bad
@@ -27,6 +50,12 @@ module RuboCop
       #   # good
       #   def value?
       #   end
+      #
+      # @example AllowedMethods: ['is_a?'] (default)
+      #   # good
+      #   def is_a?(value)
+      #   end
+      #
       class PredicateName < Base
         include AllowedMethods
 
@@ -70,7 +99,7 @@ module RuboCop
           !(method_name.start_with?(prefix) && # cheap check to avoid allocating Regexp
               method_name.match?(/^#{prefix}[^0-9]/)) ||
             method_name == expected_name(method_name, prefix) ||
-            method_name.end_with?('=') ||
+            method_name.end_with?('=') || # rubocop:todo InternalAffairs/MethodNameEndWith
             allowed_method?(method_name)
         end
 
@@ -80,7 +109,7 @@ module RuboCop
                      else
                        method_name.dup
                      end
-          new_name << '?' unless method_name.end_with?('?')
+          new_name << '?' unless method_name.end_with?('?') # rubocop:todo InternalAffairs/MethodNameEndWith
           new_name
         end
 

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Naming
-      # This cop makes sure that rescued exceptions variables are named as
+      # Makes sure that rescued exceptions variables are named as
       # expected.
       #
       # The `PreferredName` config option takes a `String`. It represents

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Naming
-      # This cop makes sure that all variables use the configured style,
+      # Makes sure that all variables use the configured style,
       # snake_case or camelCase, for their names.
       #
       # @example EnforcedStyle: snake_case (default)
@@ -19,12 +19,21 @@ module RuboCop
       #
       #   # good
       #   fooBar = 1
+      #
+      # @example AllowedPatterns: ['_v\d+\z']
+      #   # good
+      #   :release_v1
       class VariableName < Base
         include AllowedIdentifiers
         include ConfigurableNaming
+        include AllowedPattern
 
         MSG = 'Use %<style>s for variable names.'
 
+        def valid_name?(node, name, given_style = style)
+          super || matches_allowed_pattern?(name)
+        end
+
         def on_lvasgn(node)
           name, = *node
           return unless name

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Naming
-      # This cop makes sure that all numbered variables use the
+      # Makes sure that all numbered variables use the
       # configured style, snake_case, normalcase, or non_integer,
       # for their numbering.
       #
@@ -11,23 +11,6 @@ module RuboCop
       # can be used to specify whether method names and symbols should be checked.
       # Both are enabled by default.
       #
-      # @example EnforcedStyle: snake_case
-      #   # bad
-      #   :some_sym1
-      #   variable1 = 1
-      #
-      #   def some_method1; end
-      #
-      #   def some_method_1(arg1); end
-      #
-      #   # good
-      #   :some_sym_1
-      #   variable_1 = 1
-      #
-      #   def some_method_1; end
-      #
-      #   def some_method_1(arg_1); end
-      #
       # @example EnforcedStyle: normalcase (default)
       #   # bad
       #   :some_sym_1
@@ -45,6 +28,23 @@ module RuboCop
       #
       #   def some_method1(arg1); end
       #
+      # @example EnforcedStyle: snake_case
+      #   # bad
+      #   :some_sym1
+      #   variable1 = 1
+      #
+      #   def some_method1; end
+      #
+      #   def some_method_1(arg1); end
+      #
+      #   # good
+      #   :some_sym_1
+      #   variable_1 = 1
+      #
+      #   def some_method_1; end
+      #
+      #   def some_method_1(arg_1); end
+      #
       # @example EnforcedStyle: non_integer
       #   # bad
       #   :some_sym1
@@ -96,12 +96,21 @@ module RuboCop
       #   # good
       #   expect(Open3).to receive(:capture3)
       #
+      # @example AllowedPatterns: ['_v\d+\z']
+      #   # good
+      #   :some_sym_v1
+      #
       class VariableNumber < Base
         include AllowedIdentifiers
         include ConfigurableNumbering
+        include AllowedPattern
 
         MSG = 'Use %<style>s for %<identifier_type>s numbers.'
 
+        def valid_name?(node, name, given_style = style)
+          super || matches_allowed_pattern?(name)
+        end
+
         def on_arg(node)
           @node = node
           name, = *node
@@ -112,6 +121,7 @@ module RuboCop
         alias on_lvasgn on_arg
         alias on_ivasgn on_arg
         alias on_cvasgn on_arg
+        alias on_gvasgn on_arg
 
         def on_def(node)
           @node = node

data/lib/rubocop/cop/offense.rb

@@ -217,7 +217,7 @@ module RuboCop
       alias eql? ==
 
       def hash
-        COMPARISON_ATTRIBUTES.reduce(0) { |hash, attribute| hash ^ public_send(attribute).hash }
+        COMPARISON_ATTRIBUTES.map { |attribute| public_send(attribute) }.hash
       end
 
       # @api public