rubocop 1.29.1 → 1.36.0

data/lib/rubocop/cop/style/sole_nested_conditional.rb

@@ -130,13 +130,7 @@ module RuboCop
         def correct_from_unless_to_if(corrector, node, is_modify_form: false)
           corrector.replace(node.loc.keyword, 'if')
 
-          condition = node.condition
-          if (condition.send_type? && condition.comparison_method? && !condition.parenthesized?) ||
-             (is_modify_form && wrap_condition?(condition))
-            corrector.wrap(node.condition, '!(', ')')
-          else
-            corrector.insert_before(node.condition, '!')
-          end
+          insert_bang(corrector, node, is_modify_form)
         end
 
         def correct_for_guard_condition_style(corrector, outer_condition, if_branch, and_operator)
@@ -144,7 +138,7 @@ module RuboCop
           corrector.insert_after(outer_condition, "#{and_operator}#{replace_condition(condition)}")
 
           range = range_between(if_branch.loc.keyword.begin_pos, condition.source_range.end_pos)
-          corrector.remove(range_with_surrounding_space(range: range, newlines: false))
+          corrector.remove(range_with_surrounding_space(range, newlines: false))
           corrector.remove(if_branch.loc.keyword)
         end
 
@@ -154,7 +148,18 @@ module RuboCop
           )
           corrector.replace(range, and_operator)
           corrector.remove(range_by_whole_lines(node.loc.end, include_final_newline: true))
-          corrector.wrap(if_branch.condition, '(', ')') if wrap_condition?(if_branch.condition)
+
+          wrap_condition(corrector, if_branch.condition)
+        end
+
+        def wrap_condition(corrector, condition)
+          # Handle `send` and `block` nodes that need to be wrapped in parens
+          # FIXME: autocorrection prevents syntax errors by wrapping the entire node in parens,
+          #        but wrapping the argument list would be a more ergonomic correction.
+          node_to_check = condition&.block_type? ? condition.send_node : condition
+          return unless wrap_condition?(node_to_check)
+
+          corrector.wrap(condition, '(', ')')
         end
 
         def correct_for_outer_condition_modify_form_style(corrector, node, if_branch)
@@ -163,13 +168,11 @@ module RuboCop
                                   "#{'!' if node.unless?}#{replace_condition(node.condition)} && ")
 
           corrector.remove(node.condition.loc.expression)
-          corrector.remove(range_with_surrounding_space(range: node.loc.keyword, newlines: false))
+          corrector.remove(range_with_surrounding_space(node.loc.keyword, newlines: false))
           corrector.replace(if_branch.loc.keyword, 'if')
         end
 
         def correct_for_comment(corrector, node, if_branch)
-          return if config.for_cop('Style/IfUnlessModifier')['Enabled']
-
           comments = processed_source.ast_with_comments[if_branch]
           comment_text = comments.map(&:text).join("\n") << "\n"
 
@@ -187,8 +190,33 @@ module RuboCop
           corrector.insert_after(condition.last_argument.source_range, ')')
         end
 
+        def insert_bang(corrector, node, is_modify_form)
+          condition = node.condition
+
+          if (condition.send_type? && condition.comparison_method? && !condition.parenthesized?) ||
+             (is_modify_form && wrap_condition?(condition))
+            corrector.wrap(node.condition, '!(', ')')
+          elsif condition.and_type?
+            insert_bang_for_and(corrector, node)
+          else
+            corrector.insert_before(condition, '!')
+          end
+        end
+
+        def insert_bang_for_and(corrector, node)
+          lhs, rhs = *node
+
+          if lhs.and_type?
+            insert_bang_for_and(corrector, lhs)
+            corrector.insert_before(rhs, '!') if rhs
+          else
+            corrector.insert_before(lhs, '!')
+            corrector.insert_before(rhs, '!')
+          end
+        end
+
         def require_parentheses?(condition)
-          condition.send_type? && !condition.arguments.empty? && !condition.parenthesized? &&
+          condition.call_type? && !condition.arguments.empty? && !condition.parenthesized? &&
             !condition.comparison_method?
         end
 
@@ -200,7 +228,7 @@ module RuboCop
 
         def wrap_condition?(node)
           node.and_type? || node.or_type? ||
-            (node.send_type? && node.arguments.any? && !node.parenthesized?)
+            (node.call_type? && node.arguments.any? && !node.parenthesized?)
         end
 
         def replace_condition(condition)

data/lib/rubocop/cop/style/static_class.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for places where classes with only class methods can be
+      # Checks for places where classes with only class methods can be
       # replaced with a module. Classes should be used only when it makes sense to create
       # instances out of them.
       #

data/lib/rubocop/cop/style/stderr_puts.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop identifies places where `$stderr.puts` can be replaced by
+      # Identifies places where `$stderr.puts` can be replaced by
       # `warn`. The latter has the advantage of easily being disabled by,
       # the `-W0` interpreter flag or setting `$VERBOSE` to `nil`.
       #

data/lib/rubocop/cop/style/string_concatenation.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for places where string concatenation
+      # Checks for places where string concatenation
       # can be replaced with string interpolation.
       #
       # The cop can autocorrect simple cases but will skip autocorrecting
@@ -76,7 +76,7 @@ module RuboCop
 
           topmost_plus_node = find_topmost_plus_node(node)
           parts = collect_parts(topmost_plus_node)
-          return unless parts[0..-2].any? { |receiver_node| offensive_for_mode?(receiver_node) }
+          return if mode == :conservative && !parts.first.str_type?
 
           register_offense(topmost_plus_node, parts)
         end
@@ -95,11 +95,6 @@ module RuboCop
           end
         end
 
-        def offensive_for_mode?(receiver_node)
-          mode = cop_config['Mode'].to_sym
-          mode == :aggressive || (mode == :conservative && receiver_node.str_type?)
-        end
-
         def line_end_concatenation?(node)
           # If the concatenation happens at the end of the line,
           # and both the receiver and argument are strings, allow
@@ -173,6 +168,10 @@ module RuboCop
         def single_quoted?(str_node)
           str_node.source.start_with?("'")
         end
+
+        def mode
+          cop_config['Mode'].to_sym
+        end
       end
     end
   end

data/lib/rubocop/cop/style/string_hash_keys.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for the use of strings as keys in hashes. The use of
+      # Checks for the use of strings as keys in hashes. The use of
       # symbols is preferred instead.
       #
       # @safety

data/lib/rubocop/cop/style/string_literals_in_interpolation.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks that quotes inside the string interpolation
+      # Checks that quotes inside the string interpolation
       # match the configured preference.
       #
       # @example EnforcedStyle: single_quotes (default)

data/lib/rubocop/cop/style/string_methods.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop enforces the use of consistent method names
+      # Enforces the use of consistent method names
       # from the String class.
       #
       # @example

data/lib/rubocop/cop/style/strip.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop identifies places where `lstrip.rstrip` can be replaced by
+      # Identifies places where `lstrip.rstrip` can be replaced by
       # `strip`.
       #
       # @example

data/lib/rubocop/cop/style/struct_inheritance.rb

@@ -3,10 +3,10 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for inheritance from Struct.new.
+      # Checks for inheritance from Struct.new.
       #
       # @safety
-      #   Auto-correction is unsafe because it will change the inheritance
+      #   Autocorrection is unsafe because it will change the inheritance
       #   tree (e.g. return value of `Module#ancestors`) of the constant.
       #
       # @example
@@ -34,7 +34,7 @@ module RuboCop
           return unless struct_constructor?(node.parent_class)
 
           add_offense(node.parent_class.source_range) do |corrector|
-            corrector.remove(range_with_surrounding_space(range: node.loc.keyword, newlines: false))
+            corrector.remove(range_with_surrounding_space(node.loc.keyword, newlines: false))
             corrector.replace(node.loc.operator, '=')
 
             correct_parent(node.parent_class, corrector)
@@ -51,7 +51,7 @@ module RuboCop
 
         def correct_parent(parent, corrector)
           if parent.block_type?
-            corrector.remove(range_with_surrounding_space(range: parent.loc.end, newlines: false))
+            corrector.remove(range_with_surrounding_space(parent.loc.end, newlines: false))
           elsif (class_node = parent.parent).body.nil?
             corrector.remove(range_for_empty_class_body(class_node, parent))
           else

data/lib/rubocop/cop/style/swap_values.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop enforces the use of shorthand-style swapping of 2 variables.
+      # Enforces the use of shorthand-style swapping of 2 variables.
       #
       # @safety
       #   Autocorrection is unsafe, because the temporary variable used to
@@ -22,7 +22,7 @@ module RuboCop
         include RangeHelp
         extend AutoCorrector
 
-        MSG = 'Replace this and assignments at lines %<x_line>d '\
+        MSG = 'Replace this and assignments at lines %<x_line>d ' \
               'and %<y_line>d with `%<replacement>s`.'
 
         SIMPLE_ASSIGNMENT_TYPES = %i[lvasgn ivasgn cvasgn gvasgn casgn].to_set.freeze

data/lib/rubocop/cop/style/symbol_array.rb

@@ -3,11 +3,12 @@
 module RuboCop
   module Cop
     module Style
-      # This cop can check for array literals made up of symbols that are not
+      # Checks for array literals made up of symbols that are not
       # using the %i() syntax.
       #
       # Alternatively, it checks for symbol arrays using the %i() syntax on
-      # projects which do not want to use that syntax.
+      # projects which do not want to use that syntax, perhaps because they
+      # support a version of Ruby lower than 2.0.
       #
       # Configuration option: MinSize
       # If set, arrays with fewer elements than this value will not trigger the
@@ -33,9 +34,12 @@ module RuboCop
         include ConfigurableEnforcedStyle
         include PercentArray
         extend AutoCorrector
+        extend TargetRubyVersion
+
+        minimum_target_ruby_version 2.0
 
         PERCENT_MSG = 'Use `%i` or `%I` for an array of symbols.'
-        ARRAY_MSG = 'Use `%<prefer>s` for an array of symbols.'
+        ARRAY_MSG = 'Use %<prefer>s for an array of symbols.'
 
         class << self
           attr_accessor :largest_brackets
@@ -65,13 +69,12 @@ module RuboCop
             if c.dsym_type?
               string_literal = to_string_literal(c.source)
 
-              ":#{trim_string_interporation_escape_character(string_literal)}"
+              ":#{trim_string_interpolation_escape_character(string_literal)}"
             else
               to_symbol_literal(c.value.to_s)
             end
           end
-
-          "[#{syms.join(', ')}]"
+          build_bracketed_array_with_appropriate_whitespace(elements: syms, node: node)
         end
 
         def to_symbol_literal(string)

data/lib/rubocop/cop/style/symbol_literal.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks symbol literal syntax.
+      # Checks symbol literal syntax.
       #
       # @example
       #

data/lib/rubocop/cop/style/symbol_proc.rb

@@ -7,12 +7,15 @@ module RuboCop
       #
       # If you prefer a style that allows block for method with arguments,
       # please set `true` to `AllowMethodsWithArguments`.
+      # respond_to , and `define_method?` methods are allowed by default.
+      # These are customizable with `AllowedMethods` option.
       #
       # @safety
-      #   This cop is unsafe because `proc`s and blocks work differently
-      #   when additional arguments are passed in. A block will silently
-      #   ignore additional arguments, but a `proc` will raise
-      #   an `ArgumentError`.
+      #   This cop is unsafe because there is a difference that a `Proc`
+      #   generated from `Symbol#to_proc` behaves as a lambda, while
+      #   a `Proc` generated from a block does not.
+      #   For example, a lambda will raise an `ArgumentError` if the
+      #   number of arguments is wrong, but a non-lambda `Proc` will not.
       #
       #   For example:
       #
@@ -68,10 +71,26 @@ module RuboCop
       #     s.upcase # some comment
       #     # some comment
       #   end
+      #
+      # @example AllowedMethods: [respond_to, define_method] (default)
+      #   # good
+      #   respond_to { |foo| foo.bar }
+      #   define_method(:foo) { |foo| foo.bar }
+      #
+      #
+      # @example AllowedPatterns: [] (default)
+      #   # bad
+      #   something.map { |s| s.upcase }
+      #
+      # @example AllowedPatterns: [/map/] (default)
+      #   # good
+      #   something.map { |s| s.upcase }
+      #
       class SymbolProc < Base
         include CommentsHelp
         include RangeHelp
-        include IgnoredMethods
+        include AllowedMethods
+        include AllowedPattern
         extend AutoCorrector
 
         MSG = 'Pass `&:%<method>s` as an argument to `%<block_method>s` instead of a block.'
@@ -81,7 +100,7 @@ module RuboCop
         def_node_matcher :proc_node?, '(send (const {nil? cbase} :Proc) :new)'
 
         # @!method symbol_proc_receiver?(node)
-        def_node_matcher :symbol_proc_receiver?, '{(send ...) (super ...) zsuper}'
+        def_node_matcher :symbol_proc_receiver?, '{(call ...) (super ...) zsuper}'
 
         # @!method symbol_proc?(node)
         def_node_matcher :symbol_proc?, <<~PATTERN
@@ -95,23 +114,25 @@ module RuboCop
           [Layout::SpaceBeforeBlockBraces]
         end
 
-        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         def on_block(node)
           symbol_proc?(node) do |dispatch_node, arguments_node, method_name|
             # TODO: Rails-specific handling that we should probably make
             # configurable - https://github.com/rubocop/rubocop/issues/1485
-            # we should ignore lambdas & procs
+            # we should allow lambdas & procs
             return if proc_node?(dispatch_node)
+            return if unsafe_hash_usage?(dispatch_node)
+            return if unsafe_array_usage?(dispatch_node)
             return if %i[lambda proc].include?(dispatch_node.method_name)
-            return if ignored_method?(dispatch_node.method_name)
-            return if allow_if_method_has_argument?(node)
+            return if allowed_method_name?(dispatch_node.method_name)
+            return if allow_if_method_has_argument?(node.send_node)
             return if node.block_type? && destructuring_block_argument?(arguments_node)
             return if allow_comments? && contains_comments?(node)
 
             register_offense(node, method_name, dispatch_node.method_name)
           end
         end
-        # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         alias on_numblock on_block
 
         def destructuring_block_argument?(argument_node)
@@ -120,6 +141,19 @@ module RuboCop
 
         private
 
+        # See: https://github.com/rubocop/rubocop/issues/10864
+        def unsafe_hash_usage?(node)
+          node.receiver&.hash_type? && %i[reject select].include?(node.method_name)
+        end
+
+        def unsafe_array_usage?(node)
+          node.receiver&.array_type? && %i[min max].include?(node.method_name)
+        end
+
+        def allowed_method_name?(name)
+          allowed_method?(name) || matches_allowed_pattern?(name)
+        end
+
         def register_offense(node, method_name, block_method_name)
           block_start = node.loc.begin.begin_pos
           block_end = node.loc.end.end_pos
@@ -152,7 +186,7 @@ module RuboCop
 
         def block_range_with_space(node)
           block_range = range_between(begin_pos_for_replacement(node), node.loc.end.end_pos)
-          range_with_surrounding_space(range: block_range, side: :left)
+          range_with_surrounding_space(block_range, side: :left)
         end
 
         def begin_pos_for_replacement(node)
@@ -165,8 +199,8 @@ module RuboCop
           end
         end
 
-        def allow_if_method_has_argument?(node)
-          !!cop_config.fetch('AllowMethodsWithArguments', false) && !node.arguments.count.zero?
+        def allow_if_method_has_argument?(send_node)
+          !!cop_config.fetch('AllowMethodsWithArguments', false) && !send_node.arguments.count.zero?
         end
 
         def allow_comments?

data/lib/rubocop/cop/style/ternary_parentheses.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for the presence of parentheses around ternary
+      # Checks for the presence of parentheses around ternary
       # conditions. It is configurable to enforce inclusion or omission of
       # parentheses using `EnforcedStyle`. Omission is only enforced when
       # removing the parentheses won't cause a different behavior.
@@ -71,7 +71,7 @@ module RuboCop
 
           return if only_closing_parenthesis_is_last_line?(condition)
           return if condition_as_parenthesized_one_line_pattern_matching?(condition)
-          return unless node.ternary? && !infinite_loop? && offense?(node)
+          return unless node.ternary? && offense?(node)
 
           message = message(node)
 
@@ -166,22 +166,10 @@ module RuboCop
           style == :require_parentheses_when_complex
         end
 
-        def redundant_parentheses_enabled?
-          @config.for_cop('Style/RedundantParentheses').fetch('Enabled')
-        end
-
         def parenthesized?(node)
           node.begin_type?
         end
 
-        # When this cop is configured to enforce parentheses and the
-        # `RedundantParentheses` cop is enabled, it will cause an infinite loop
-        # as they compete to add and remove the parentheses respectively.
-        def infinite_loop?
-          (require_parentheses? || require_parentheses_when_complex?) &&
-            redundant_parentheses_enabled?
-        end
-
         def unsafe_autocorrect?(condition)
           condition.children.any? do |child|
             unparenthesized_method_call?(child) || below_ternary_precedence?(child)

data/lib/rubocop/cop/style/top_level_method_definition.rb

@@ -63,6 +63,8 @@ module RuboCop
           add_offense(node)
         end
 
+        alias on_numblock on_block
+
         private
 
         def top_level_method_definition?(node)
@@ -75,7 +77,7 @@ module RuboCop
 
         # @!method define_method_block?(node)
         def_node_matcher :define_method_block?, <<~PATTERN
-          (block (send _ {:define_method} _) ...)
+          ({block numblock} (send _ {:define_method} _) ...)
         PATTERN
       end
     end

data/lib/rubocop/cop/style/trailing_body_on_class.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for trailing code after the class definition.
+      # Checks for trailing code after the class definition.
       #
       # @example
       #   # bad

data/lib/rubocop/cop/style/trailing_body_on_method_definition.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for trailing code after the method definition.
+      # Checks for trailing code after the method definition.
       #
       # NOTE: It always accepts endless method definitions that are basically on the same line.
       #

data/lib/rubocop/cop/style/trailing_body_on_module.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for trailing code after the module definition.
+      # Checks for trailing code after the module definition.
       #
       # @example
       #   # bad

data/lib/rubocop/cop/style/trailing_comma_in_arguments.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for trailing comma in argument lists.
+      # Checks for trailing comma in argument lists.
       # The supported styles are:
       #
       # * `consistent_comma`: Requires a comma after the last argument,

data/lib/rubocop/cop/style/trailing_comma_in_array_literal.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for trailing comma in array literals.
+      # Checks for trailing comma in array literals.
       # The configuration options are:
       #
       # * `consistent_comma`: Requires a comma after the

data/lib/rubocop/cop/style/trailing_comma_in_block_args.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks whether trailing commas in block arguments are
+      # Checks whether trailing commas in block arguments are
       # required. Blocks with only one argument and a trailing comma require
       # that comma to be present. Blocks with more than one argument never
       # require a trailing comma.
@@ -64,7 +64,7 @@ module RuboCop
 
         MSG = 'Useless trailing comma present in block arguments.'
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           # lambda literal (`->`) never has block arguments.
           return if node.send_node.lambda_literal?
           return unless useless_trailing_comma?(node)

data/lib/rubocop/cop/style/trailing_comma_in_hash_literal.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for trailing comma in hash literals.
+      # Checks for trailing comma in hash literals.
       # The configuration options are:
       #
       # * `consistent_comma`: Requires a comma after the

data/lib/rubocop/cop/style/trailing_method_end_statement.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for trailing code after the method definition.
+      # Checks for trailing code after the method definition.
       #
       # @example
       #   # bad

data/lib/rubocop/cop/style/trailing_underscore_variable.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for extra underscores in variable assignment.
+      # Checks for extra underscores in variable assignment.
       #
       # @example
       #   # bad

data/lib/rubocop/cop/style/trivial_accessors.rb

@@ -3,8 +3,11 @@
 module RuboCop
   module Cop
     module Style
-      # This cop looks for trivial reader/writer methods, that could
+      # Looks for trivial reader/writer methods, that could
       # have been created with the attr_* family of functions automatically.
+      # `to_ary`, `to_a`, `to_c`, `to_enum`, `to_h`, `to_hash`, `to_i`, `to_int`, `to_io`,
+      # `to_open`, `to_path`, `to_proc`, `to_r`, `to_regexp`, `to_str`, `to_s`, and `to_sym` methods
+      # are allowed by default. These are customizable with `AllowedMethods` option.
       #
       # @example
       #   # bad

data/lib/rubocop/cop/style/unless_else.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop looks for `unless` expressions with `else` clauses.
+      # Looks for `unless` expressions with `else` clauses.
       #
       # @example
       #   # bad

data/lib/rubocop/cop/style/unless_logical_operators.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for the use of logical operators in an `unless` condition.
+      # Checks for the use of logical operators in an `unless` condition.
       # It discourages such code, as the condition becomes more difficult
       # to read and understand.
       #

data/lib/rubocop/cop/style/unpack_first.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for accessing the first element of `String#unpack`
+      # Checks for accessing the first element of `String#unpack`
       # which can be replaced with the shorter method `unpack1`.
       #
       # @example
@@ -19,8 +19,11 @@ module RuboCop
       #
       class UnpackFirst < Base
         extend AutoCorrector
+        extend TargetRubyVersion
 
-        MSG = 'Use `%<receiver>s.unpack1(%<format>s)` instead of '\
+        minimum_target_ruby_version 2.4
+
+        MSG = 'Use `%<receiver>s.unpack1(%<format>s)` instead of ' \
               '`%<receiver>s.unpack(%<format>s)%<method>s`.'
         RESTRICT_ON_SEND = %i[first [] slice at].freeze
 

data/lib/rubocop/cop/style/variable_interpolation.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for variable interpolation (like "#@ivar").
+      # Checks for variable interpolation (like "#@ivar").
       #
       # @example
       #   # bad