rubocop 1.57.1 → 1.81.6

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

@@ -43,22 +43,26 @@ module RuboCop
         # @!method nil_check?(node)
         def_node_matcher :nil_check?, '(send _ :nil?)'
 
+        # rubocop:disable Metrics/AbcSize
         def on_send(node)
+          return unless node.receiver
+
           style_check?(node) do
             add_offense(node.loc.selector) do |corrector|
-              new_code = if prefer_comparison?
-                           node.source.sub('.nil?', ' == nil')
-                         else
-                           node.source.sub(/\s*={2,3}\s*nil/, '.nil?')
-                         end
-
-              corrector.replace(node, new_code)
+              if prefer_comparison?
+                range = node.loc.dot.join(node.loc.selector.end)
+                corrector.replace(range, ' == nil')
+              else
+                range = node.receiver.source_range.end.join(node.source_range.end)
+                corrector.replace(range, '.nil?')
+              end
 
               parent = node.parent
               corrector.wrap(node, '(', ')') if parent.respond_to?(:method?) && parent.method?(:!)
             end
           end
         end
+        # rubocop:enable Metrics/AbcSize
 
         private
 

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

@@ -52,7 +52,7 @@ module RuboCop
         end
 
         def requires_parens?(child)
-          child.and_type? || child.or_type? ||
+          child.operator_keyword? ||
             (child.send_type? && child.binary_operation?) ||
             (child.if_type? && child.ternary?)
         end

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

@@ -62,7 +62,7 @@ module RuboCop
         private
 
         def message(node)
-          self.class.const_get("#{literal_type(node).upcase}_MSG")
+          self.class.const_get(:"#{literal_type(node).upcase}_MSG")
         end
 
         def literal_type(node)

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

@@ -8,8 +8,8 @@ module RuboCop
       # These can be replaced by their respective predicate methods.
       # This cop can also be configured to do the reverse.
       #
-      # This cop can be customized allowed methods with `AllowedMethods`.
-      # By default, there are no methods to allowed.
+      # This cop's allowed methods can be customized with `AllowedMethods`.
+      # By default, there are no allowed methods.
       #
       # This cop disregards `#nonzero?` as its value is truthy or falsey,
       # but not `true` and `false`, and thus not always interchangeable with
@@ -118,12 +118,14 @@ module RuboCop
 
           return unless numeric && operator && replacement_supported?(operator)
 
-          [numeric, replacement(numeric, operator)]
+          [numeric, replacement(node, numeric, operator)]
         end
 
-        def replacement(numeric, operation)
+        def replacement(node, numeric, operation)
           if style == :predicate
             [parenthesized_source(numeric), REPLACEMENTS.invert[operation.to_s]].join('.')
+          elsif negated?(node)
+            "(#{numeric.source} #{REPLACEMENTS[operation.to_s]} 0)"
           else
             [numeric.source, REPLACEMENTS[operation.to_s], 0].join(' ')
           end
@@ -157,6 +159,12 @@ module RuboCop
           end
         end
 
+        def negated?(node)
+          return false unless (parent = node.parent)
+
+          parent.send_type? && parent.method?(:!)
+        end
+
         # @!method predicate(node)
         def_node_matcher :predicate, <<~PATTERN
           (send $(...) ${:zero? :positive? :negative?})

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

@@ -30,39 +30,41 @@ module RuboCop
         minimum_target_ruby_version 2.6
 
         MSG = 'Prefer `%<prefer>s` over `%<current>s`.'
+        RESTRICT_ON_SEND = %i[then yield_self].freeze
 
         def on_block(node)
+          return unless RESTRICT_ON_SEND.include?(node.method_name)
+
           check_method_node(node.send_node)
         end
-
         alias on_numblock on_block
+        alias on_itblock on_block
 
         def on_send(node)
           return unless node.arguments.one? && node.first_argument.block_pass_type?
 
           check_method_node(node)
         end
+        alias on_csend on_send
 
         private
 
         def check_method_node(node)
-          return unless preferred_method(node)
+          if preferred_method?(node)
+            correct_style_detected
+          else
+            opposite_style_detected
+            message = message(node)
+            add_offense(node.loc.selector, message: message) do |corrector|
+              prefer = style == :then && node.receiver.nil? ? 'self.then' : style
 
-          message = message(node)
-          add_offense(node.loc.selector, message: message) do |corrector|
-            corrector.replace(node.loc.selector, style.to_s)
+              corrector.replace(node.loc.selector, prefer)
+            end
           end
         end
 
-        def preferred_method(node)
-          case style
-          when :then
-            node.method?(:yield_self)
-          when :yield_self
-            node.method?(:then)
-          else
-            false
-          end
+        def preferred_method?(node)
+          node.method?(style)
         end
 
         def message(node)

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

@@ -4,8 +4,8 @@ module RuboCop
   module Cop
     module Style
       # Checks for uses of if/then/else/end constructs on a single line.
-      # AlwaysCorrectToMultiline config option can be set to true to auto-convert all offenses to
-      # multi-line constructs. When AlwaysCorrectToMultiline is false (default case) the
+      # `AlwaysCorrectToMultiline` config option can be set to true to autocorrect all offenses to
+      # multi-line constructs. When `AlwaysCorrectToMultiline` is false (default case) the
       # autocorrect will first try converting them to ternary operators.
       #
       # @example
@@ -30,34 +30,65 @@ module RuboCop
       #   else
       #     baz
       #   end
+      #
+      # @example AlwaysCorrectToMultiline: false (default)
+      #   # bad
+      #   if cond then run else dont end
+      #
+      #   # good
+      #   cond ? run : dont
+      #
+      # @example AlwaysCorrectToMultiline: true
+      #   # bad
+      #   if cond then run else dont end
+      #
+      #   # good
+      #   if cond
+      #     run
+      #   else
+      #     dont
+      #   end
+      #
       class OneLineConditional < Base
         include Alignment
         include ConfigurableEnforcedStyle
         include OnNormalIfUnless
         extend AutoCorrector
 
-        MSG = 'Favor the ternary operator (`?:`) or multi-line constructs ' \
-              'over single-line `%<keyword>s/then/else/end` constructs.'
+        MSG_SUFFIX = 'over single-line `%<keyword>s/then/else/end` constructs.'
+        MSG_TERNARY = "Favor the ternary operator (`?:`) #{MSG_SUFFIX}"
+        MSG_MULTILINE = "Favor multi-line `%<keyword>s` #{MSG_SUFFIX}"
 
         def on_normal_if_unless(node)
           return unless node.single_line?
           return unless node.else_branch
-          return if node.elsif?
+          return if node.elsif? || node.if_branch&.begin_type?
+
+          multiline = multiline?(node)
+
+          add_offense(node, message: message(node, multiline)) do |corrector|
+            next if part_of_ignored_node?(node)
+
+            autocorrect(corrector, node, multiline)
 
-          message = message(node)
-          add_offense(node, message: message) do |corrector|
-            autocorrect(corrector, node)
+            ignore_node(node)
           end
         end
 
         private
 
-        def message(node)
-          format(MSG, keyword: node.keyword)
+        def multiline?(node)
+          always_multiline? || cannot_replace_to_ternary?(node)
         end
 
-        def autocorrect(corrector, node)
-          if always_multiline? || cannot_replace_to_ternary?(node)
+        def message(node, multiline)
+          template = multiline ? MSG_MULTILINE : MSG_TERNARY
+
+          format(template, keyword: node.keyword)
+        end
+
+        def autocorrect(corrector, node, multiline)
+          if multiline
             IfThenCorrector.new(node, indentation: configured_indentation_width).call(corrector)
           else
             corrector.replace(node, ternary_correction(node))
@@ -75,15 +106,17 @@ module RuboCop
         end
 
         def always_multiline?
-          @config.for_cop('Style/OneLineConditional')['AlwaysCorrectToMultiline']
+          cop_config['AlwaysCorrectToMultiline']
         end
 
         def cannot_replace_to_ternary?(node)
-          node.elsif_conditional?
+          return true if node.elsif_conditional?
+
+          node.else_branch.begin_type? && node.else_branch.children.compact.count >= 2
         end
 
         def ternary_replacement(node)
-          condition, if_branch, else_branch = *node
+          condition, if_branch, else_branch = *node # rubocop:disable InternalAffairs/NodeDestructuring
 
           "#{expr_replacement(condition)} ? " \
             "#{expr_replacement(if_branch)} : " \

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

@@ -3,15 +3,15 @@
 module RuboCop
   module Cop
     module Style
-      # Flags uses of OpenStruct, as it is now officially discouraged
+      # Flags uses of `OpenStruct`, as it is now officially discouraged
       # to be used for performance, version compatibility, and potential security issues.
       #
       # @safety
-      #
       #   Note that this cop may flag false positives; for instance, the following legal
       #   use of a hand-rolled `OpenStruct` type would be considered an offense:
       #
-      #   ```
+      #   [source,ruby]
+      #   -----
       #   module MyNamespace
       #     class OpenStruct # not the OpenStruct we're looking for
       #     end
@@ -20,7 +20,7 @@ module RuboCop
       #       OpenStruct.new # resolves to MyNamespace::OpenStruct
       #     end
       #   end
-      #   ```
+      #   -----
       #
       # @example
       #
@@ -61,7 +61,7 @@ module RuboCop
         def custom_class_or_module_definition?(node)
           parent = node.parent
 
-          (parent.class_type? || parent.module_type?) && node.left_siblings.empty?
+          parent.type?(:class, :module) && node.left_siblings.empty?
         end
       end
     end

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

@@ -4,8 +4,8 @@ module RuboCop
   module Cop
     module Style
       # Checks for redundant dot before operator method call.
-      # The target operator methods are `|`, `^`, `&`, `<=>`, `==`, `===`, `=~`, `>`, `>=`, `<`,
-      # `<=`, `<<`, `>>`, `+`, `-`, `*`, `/`, `%`, `**`, `~`, `!`, `!=`, and `!~`.
+      # The target operator methods are `|`, `^`, `&`, ``<=>``, `==`, `===`, `=~`, `>`, `>=`, `<`,
+      # ``<=``, `<<`, `>>`, `+`, `-`, `*`, `/`, `%`, `**`, `~`, `!`, `!=`, and `!~`.
       #
       # @example
       #
@@ -22,21 +22,25 @@ module RuboCop
 
         MSG = 'Redundant dot detected.'
         RESTRICT_ON_SEND = %i[| ^ & <=> == === =~ > >= < <= << >> + - * / % ** ~ ! != !~].freeze
+        INVALID_SYNTAX_ARG_TYPES = %i[
+          splat kwsplat forwarded_args forwarded_restarg forwarded_kwrestarg block_pass
+        ].freeze
 
         # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
         def on_send(node)
           return unless (dot = node.loc.dot)
           return if node.receiver.const_type? || !node.arguments.one?
 
-          _lhs, _op, rhs = *node
-          return if !rhs || method_call_with_parenthesized_arg?(rhs) || anonymous_forwarding?(rhs)
+          return unless (rhs = node.first_argument)
+          return if method_call_with_parenthesized_arg?(rhs)
+          return if invalid_syntax_argument?(rhs)
 
           add_offense(dot) do |corrector|
             wrap_in_parentheses_if_chained(corrector, node)
             corrector.replace(dot, ' ')
 
             selector = node.loc.selector
-            corrector.insert_after(selector, ' ') if selector.end_pos == rhs.source_range.begin_pos
+            corrector.insert_after(selector, ' ') if insert_space_after?(node)
           end
         end
         # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
@@ -50,11 +54,10 @@ module RuboCop
           argument.children.first && argument.parent.parenthesized?
         end
 
-        def anonymous_forwarding?(argument)
-          return true if argument.forwarded_args_type? || argument.forwarded_restarg_type?
-          return true if argument.hash_type? && argument.children.first&.forwarded_kwrestarg_type?
+        def invalid_syntax_argument?(argument)
+          type = argument.hash_type? ? argument.children.first&.type : argument.type
 
-          argument.block_pass_type? && argument.source == '&'
+          INVALID_SYNTAX_ARG_TYPES.include?(type)
         end
 
         def wrap_in_parentheses_if_chained(corrector, node)
@@ -67,6 +70,21 @@ module RuboCop
           corrector.insert_after(operator, ' ')
           corrector.wrap(node, '(', ')')
         end
+
+        def insert_space_after?(node)
+          rhs = node.first_argument
+          selector = node.loc.selector
+
+          return true if selector.end_pos == rhs.source_range.begin_pos
+          return false if node.parent&.call_type? # if chained, a space is already added
+
+          # For `/` operations, if the RHS starts with a `(` without space,
+          # add one to avoid a syntax error.
+          range = selector.end.join(rhs.source_range.begin)
+          return true if node.method?(:/) && range.source == '('
+
+          false
+        end
       end
     end
   end

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

@@ -78,18 +78,15 @@ module RuboCop
         end
 
         def take_variable_and_default_from_ternary(node)
-          variable, if_statement = *node
-          [variable, if_statement.else_branch]
+          [node.name, node.expression.else_branch]
         end
 
         def take_variable_and_default_from_unless(node)
           if node.if_branch
-            variable, default = *node.if_branch
+            [node.if_branch.name, node.if_branch.expression]
           else
-            variable, default = *node.else_branch
+            [node.else_branch.name, node.else_branch.expression]
           end
-
-          [variable, default]
         end
       end
     end

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'tsort'
-
 module RuboCop
   module Cop
     module Style
@@ -28,28 +26,28 @@ module RuboCop
 
         MSG = 'Do not use parallel assignment.'
 
-        def on_masgn(node)
-          lhs, rhs = *node
-          lhs_elements = *lhs
+        def on_masgn(node) # rubocop:disable Metrics/AbcSize
+          return if part_of_ignored_node?(node)
+
+          rhs = node.rhs
           rhs = rhs.body if rhs.rescue_type?
           rhs_elements = Array(rhs).compact # edge case for one constant
 
-          return if allowed_lhs?(lhs) || allowed_rhs?(rhs) ||
-                    allowed_masign?(lhs_elements, rhs_elements)
+          return if allowed_lhs?(node.assignments) || allowed_rhs?(rhs) ||
+                    allowed_masign?(node.assignments, rhs_elements)
 
           range = node.source_range.begin.join(rhs.source_range.end)
 
           add_offense(range) do |corrector|
-            autocorrect(corrector, node, lhs, rhs)
+            autocorrect(corrector, node, rhs)
           end
+          ignore_node(node)
         end
 
         private
 
-        def autocorrect(corrector, node, lhs, rhs)
-          left_elements = *lhs
-          right_elements = Array(rhs).compact
-          order = find_valid_order(left_elements, right_elements)
+        def autocorrect(corrector, node, rhs)
+          order = find_valid_order(node.assignments, Array(rhs).compact)
           correction = assignment_corrector(node, rhs, order)
 
           corrector.replace(correction.correction_range, correction.correction)
@@ -61,9 +59,7 @@ module RuboCop
                               add_self_to_getters(rhs_elements))
         end
 
-        def allowed_lhs?(node)
-          elements = *node
-
+        def allowed_lhs?(elements)
           # Account for edge cases using one variable with a comma
           # E.g.: `foo, = *bar`
           elements.one? || elements.any?(&:splat_type?)
@@ -74,11 +70,7 @@ module RuboCop
           elements = Array(node).compact
 
           # Account for edge case of `Constant::CONSTANT`
-          !node.array_type? || return_of_method_call?(node) || elements.any?(&:splat_type?)
-        end
-
-        def return_of_method_call?(node)
-          node.block_type? || node.send_type?
+          !node.array_type? || elements.any?(&:splat_type?)
         end
 
         def assignment_corrector(node, rhs, order)
@@ -100,15 +92,9 @@ module RuboCop
         def find_valid_order(left_elements, right_elements)
           # arrange left_elements in an order such that no corresponding right
           # element refers to a left element earlier in the sequence
-          # this can be done using an algorithm called a "topological sort"
-          # fortunately for us, Ruby's stdlib contains an implementation
           assignments = left_elements.zip(right_elements)
 
-          begin
-            AssignmentSorter.new(assignments).tsort
-          rescue TSort::Cyclic
-            nil
-          end
+          AssignmentSorter.new(assignments).tsort
         end
 
         # Converts (send nil :something) nodes to (send (:self) :something).
@@ -123,10 +109,9 @@ module RuboCop
         # @!method implicit_self_getter?(node)
         def_node_matcher :implicit_self_getter?, '(send nil? $_)'
 
-        # Helper class necessitated by silly design of TSort prior to Ruby 2.1
-        # Newer versions have a better API, but that doesn't help us
+        # Topologically sorts the assignments with Kahn's algorithm.
+        # https://en.wikipedia.org/wiki/Topological_sorting#Kahn's_algorithm
         class AssignmentSorter
-          include TSort
           extend RuboCop::NodePattern::Macros
 
           # @!method var_name(node)
@@ -142,21 +127,39 @@ module RuboCop
             @assignments = assignments
           end
 
-          def tsort_each_node(&block)
-            @assignments.each(&block)
+          def tsort
+            dependencies = @assignments.to_h do |assignment|
+              [assignment, dependencies_for_assignment(assignment)]
+            end
+            result = []
+
+            while (matched_node, = dependencies.find { |_node, edges| edges.empty? })
+              dependencies.delete(matched_node)
+              result.push(matched_node)
+
+              dependencies.each do |node, edges|
+                dependencies[node].delete(matched_node) if edges.include?(matched_node)
+              end
+            end
+            # Cyclic dependency
+            return nil if dependencies.any?
+
+            result
           end
 
-          def tsort_each_child(assignment)
-            # yield all the assignments which must come after `assignment`
-            # (due to dependencies on the previous value of the assigned var)
+          # Returns all the assignments which must come after `assignment`
+          # (due to dependencies on the previous value of the assigned var)
+          def dependencies_for_assignment(assignment)
             my_lhs, _my_rhs = *assignment
 
-            @assignments.each do |other|
-              _other_lhs, other_rhs = *other
+            @assignments.filter_map do |other|
+              # Exclude self, there are no dependencies in cases such as `a, b = a, b`.
+              next if other == assignment
 
+              _other_lhs, other_rhs = *other
               next unless dependency?(my_lhs, other_rhs)
 
-              yield other
+              other
             end
           end
 
@@ -211,15 +214,16 @@ module RuboCop
           protected
 
           def assignment
-            @new_elements.map { |lhs, rhs| "#{lhs.source} = #{source(rhs)}" }
+            @new_elements.map { |lhs, rhs| "#{lhs.source} = #{source(rhs, rhs.loc)}" }
           end
 
           private
 
-          def source(node)
-            if node.str_type? && node.loc.begin.nil?
+          def source(node, loc)
+            # __FILE__ is treated as a StrNode but has no begin
+            if node.str_type? && loc.respond_to?(:begin) && loc.begin.nil?
               "'#{node.source}'"
-            elsif node.sym_type? && node.loc.begin.nil?
+            elsif node.sym_type? && loc.begin.nil?
               ":#{node.source}"
             else
               node.source
@@ -289,9 +293,7 @@ module RuboCop
           private
 
           def modifier_range(node)
-            Parser::Source::Range.new(node.source_range.source_buffer,
-                                      node.loc.keyword.begin_pos,
-                                      node.source_range.end_pos)
+            node.loc.keyword.join(node.source_range.end)
           end
         end
       end

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

@@ -81,6 +81,7 @@ module RuboCop
           cond = node.condition
 
           control_op_condition(cond) do |first_child, rest_children|
+            return if require_parentheses?(node, first_child)
             return if semicolon_separated_expressions?(first_child, rest_children)
             return if modifier_op?(first_child)
             return if parens_allowed?(cond)
@@ -92,6 +93,13 @@ module RuboCop
           end
         end
 
+        def require_parentheses?(node, condition_body)
+          return false unless node.type?(:while, :until)
+          return false unless condition_body.any_block_type?
+
+          condition_body.send_node.block_literal? && condition_body.keywords?
+        end
+
         def semicolon_separated_expressions?(first_exp, rest_exps)
           return false unless (second_exp = rest_exps.first)
 

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

@@ -99,7 +99,7 @@ module RuboCop
         def string_source(node)
           if node.is_a?(String)
             node.scrub
-          elsif node.respond_to?(:type) && (node.str_type? || node.sym_type?)
+          elsif node.respond_to?(:type) && node.type?(:str, :sym)
             node.source
           end
         end

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

@@ -45,7 +45,7 @@ module RuboCop
           # Report offense only if changing case doesn't change semantics,
           # i.e., if the string would become dynamic or has special characters.
           ast = parse(corrected(node.source)).ast
-          return if node.children != ast.children
+          return if node.children != ast&.children
 
           add_offense(node.loc.begin) do |corrector|
             corrector.replace(node, corrected(node.source))

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

@@ -19,8 +19,7 @@ module RuboCop
         MSG = 'Use `proc` instead of `Proc.new`.'
 
         # @!method proc_new?(node)
-        def_node_matcher :proc_new?,
-                         '({block numblock} $(send (const {nil? cbase} :Proc) :new) ...)'
+        def_node_matcher :proc_new?, '(any_block $(send (const {nil? cbase} :Proc) :new) ...)'
 
         def on_block(node)
           proc_new?(node) do |block_method|
@@ -31,6 +30,7 @@ module RuboCop
         end
 
         alias on_numblock on_block
+        alias on_itblock on_block
       end
     end
   end

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

@@ -9,7 +9,7 @@ module RuboCop
       #
       # String interpolation is always kept in double quotes.
       #
-      # Note: `Lint/SymbolConversion` can be used in parallel to ensure that symbols
+      # NOTE: `Lint/SymbolConversion` can be used in parallel to ensure that symbols
       # are not quoted that don't need to be. This cop is for configuring the quoting
       # style to use for symbols that require quotes.
       #
@@ -98,9 +98,7 @@ module RuboCop
 
         def style
           return super unless super == :same_as_string_literals
-
-          string_literals_config = config.for_cop('Style/StringLiterals')
-          return :single_quotes unless string_literals_config['Enabled']
+          return :single_quotes unless config.cop_enabled?('Style/StringLiterals')
 
           string_literals_config['EnforcedStyle'].to_sym
         end