rubocop 1.9.1 → 1.22.3

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

@@ -44,14 +44,15 @@ module RuboCop
         extend AutoCorrector
 
         MSG = 'Avoid comparing a variable with multiple items ' \
-          'in a conditional, use `Array#include?` instead.'
+              'in a conditional, use `Array#include?` instead.'
 
         def on_new_investigation
-          @compared_elements = []
-          @allowed_method_comparison = false
+          @last_comparison = nil
         end
 
         def on_or(node)
+          reset_comparison if switch_comparison?(node)
+
           root_of_or_node = root_of_or_node(node)
 
           return unless node == root_of_or_node
@@ -64,14 +65,21 @@ module RuboCop
 
             corrector.replace(node, prefer_method)
           end
+
+          @last_comparison = node
         end
 
         private
 
+        # @!method simple_double_comparison?(node)
         def_node_matcher :simple_double_comparison?, '(send $lvar :== $lvar)'
+
+        # @!method simple_comparison_lhs?(node)
         def_node_matcher :simple_comparison_lhs?, <<~PATTERN
           (send $lvar :== $_)
         PATTERN
+
+        # @!method simple_comparison_rhs?(node)
         def_node_matcher :simple_comparison_rhs?, <<~PATTERN
           (send $_ :== $lvar)
         PATTERN
@@ -84,9 +92,7 @@ module RuboCop
 
         def variables_in_node(node)
           if node.or_type?
-            node.node_parts
-                .flat_map { |node_part| variables_in_node(node_part) }
-                .uniq
+            node.node_parts.flat_map { |node_part| variables_in_node(node_part) }.uniq
           else
             variables_in_simple_node(node)
           end
@@ -131,6 +137,17 @@ module RuboCop
           end
         end
 
+        def switch_comparison?(node)
+          return true if @last_comparison.nil?
+
+          @last_comparison.descendants.none?(node)
+        end
+
+        def reset_comparison
+          @compared_elements = []
+          @allowed_method_comparison = false
+        end
+
         def allow_method_comparison?
           cop_config.fetch('AllowMethodComparison', true)
         end

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

@@ -14,8 +14,25 @@ module RuboCop
       # positives. Luckily, there is no harm in freezing an already
       # frozen object.
       #
+      # From Ruby 3.0, this cop honours the magic comment
+      # 'shareable_constant_value'. When this magic comment is set to any
+      # acceptable value other than none, it will suppress the offenses
+      # raised by this cop. It enforces frozen state.
+      #
       # NOTE: Regexp and Range literals are frozen objects since Ruby 3.0.
       #
+      # NOTE: From Ruby 3.0, interpolated strings are not frozen when
+      # `# frozen-string-literal: true` is used, so this cop enforces explicit
+      # freezing for such strings.
+      #
+      # NOTE: From Ruby 3.0, this cop allows explicit freezing of constants when
+      # the `shareable_constant_value` directive is used.
+      #
+      # @safety
+      #   This cop's autocorrection is unsafe since any mutations on objects that
+      #   are made frozen will change from being accepted to raising `FrozenError`,
+      #   and will need to be manually refactored.
+      #
       # @example EnforcedStyle: literals (default)
       #   # bad
       #   CONST = [1, 2, 3]
@@ -52,7 +69,55 @@ module RuboCop
       #       puts 1
       #     end
       #   end.freeze
+      #
+      # @example
+      #   # Magic comment - shareable_constant_value: literal
+      #
+      #   # bad
+      #   CONST = [1, 2, 3]
+      #
+      #   # good
+      #   # shareable_constant_value: literal
+      #   CONST = [1, 2, 3]
+      #
       class MutableConstant < Base
+        # Handles magic comment shareable_constant_value with O(n ^ 2) complexity
+        # n - number of lines in the source
+        # Iterates over all lines before a CONSTANT
+        # until it reaches shareable_constant_value
+        module ShareableConstantValue
+          module_function
+
+          def recent_shareable_value?(node)
+            shareable_constant_comment = magic_comment_in_scope node
+            return false if shareable_constant_comment.nil?
+
+            shareable_constant_value = MagicComment.parse(shareable_constant_comment)
+                                                   .shareable_constant_value
+            shareable_constant_value_enabled? shareable_constant_value
+          end
+
+          # Identifies the most recent magic comment with valid shareable constant values
+          # that's in scope for this node
+          def magic_comment_in_scope(node)
+            processed_source_till_node(node).reverse_each.find do |line|
+              MagicComment.parse(line).valid_shareable_constant_value?
+            end
+          end
+
+          private
+
+          def processed_source_till_node(node)
+            processed_source.lines[0..(node.last_line - 1)]
+          end
+
+          def shareable_constant_value_enabled?(value)
+            %w[literal experimental_everything experimental_copy].include? value
+          end
+        end
+        private_constant :ShareableConstantValue
+
+        include ShareableConstantValue
         include FrozenStringLiteral
         include ConfigurableEnforcedStyle
         extend AutoCorrector
@@ -61,13 +126,12 @@ module RuboCop
 
         def on_casgn(node)
           _scope, _const_name, value = *node
-          on_assignment(value)
-        end
+          if value.nil? # This is only the case for `CONST += ...` or similarg66
+            parent = node.parent
+            return unless parent.or_asgn_type? # We only care about `CONST ||= ...`
 
-        def on_or_asgn(node)
-          lhs, value = *node
-
-          return unless lhs&.casgn_type?
+            value = parent.children.last
+          end
 
           on_assignment(value)
         end
@@ -86,24 +150,20 @@ module RuboCop
           return if immutable_literal?(value)
           return if operation_produces_immutable_object?(value)
           return if frozen_string_literal?(value)
+          return if shareable_constant_value?(value)
 
-          add_offense(value) do |corrector|
-            autocorrect(corrector, value)
-          end
+          add_offense(value) { |corrector| autocorrect(corrector, value) }
         end
 
         def check(value)
           range_enclosed_in_parentheses = range_enclosed_in_parentheses?(value)
-
           return unless mutable_literal?(value) ||
-                        target_ruby_version <= 2.7 && range_enclosed_in_parentheses
+                        (target_ruby_version <= 2.7 && range_enclosed_in_parentheses)
 
-          return if FROZEN_STRING_LITERAL_TYPES.include?(value.type) &&
-                    frozen_string_literals_enabled?
+          return if frozen_string_literal?(value)
+          return if shareable_constant_value?(value)
 
-          add_offense(value) do |corrector|
-            autocorrect(corrector, value)
-          end
+          add_offense(value) { |corrector| autocorrect(corrector, value) }
         end
 
         def autocorrect(corrector, node)
@@ -122,19 +182,19 @@ module RuboCop
         end
 
         def mutable_literal?(value)
-          return false if value.nil?
           return false if frozen_regexp_or_range_literals?(value)
 
           value.mutable_literal?
         end
 
         def immutable_literal?(node)
-          node.nil? || frozen_regexp_or_range_literals?(node) || node.immutable_literal?
+          frozen_regexp_or_range_literals?(node) || node.immutable_literal?
         end
 
-        def frozen_string_literal?(node)
-          FROZEN_STRING_LITERAL_TYPES.include?(node.type) &&
-            frozen_string_literals_enabled?
+        def shareable_constant_value?(node)
+          return false if target_ruby_version < 3.0
+
+          recent_shareable_value? node
         end
 
         def frozen_regexp_or_range_literals?(node)
@@ -142,8 +202,7 @@ module RuboCop
         end
 
         def requires_parentheses?(node)
-          node.range_type? ||
-            (node.send_type? && node.loc.dot.nil?)
+          node.range_type? || (node.send_type? && node.loc.dot.nil?)
         end
 
         def correct_splat_expansion(corrector, expr, splat_value)
@@ -154,12 +213,14 @@ module RuboCop
           end
         end
 
+        # @!method splat_value(node)
         def_node_matcher :splat_value, <<~PATTERN
           (array (splat $_))
         PATTERN
 
         # Some of these patterns may not actually return an immutable object,
         # but we want to consider them immutable for this cop.
+        # @!method operation_produces_immutable_object?(node)
         def_node_matcher :operation_produces_immutable_object?, <<~PATTERN
           {
             (const _ _)
@@ -176,6 +237,7 @@ module RuboCop
           }
         PATTERN
 
+        # @!method range_enclosed_in_parentheses?(node)
         def_node_matcher :range_enclosed_in_parentheses?, <<~PATTERN
           (begin ({irange erange} _ _))
         PATTERN

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

@@ -90,8 +90,7 @@ module RuboCop
         end
 
         def correct_style?(node)
-          style == :prefix && node.modifier_form? ||
-            style == :postfix && !node.modifier_form?
+          (style == :prefix && node.modifier_form?) || (style == :postfix && !node.modifier_form?)
         end
       end
     end

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

@@ -35,6 +35,7 @@ module RuboCop
 
         NEGATED_EQUALITY_METHODS = %i[!= !~].freeze
 
+        # @!method double_negation?(node)
         def_node_matcher :double_negation?, '(send (send _ :!) :!)'
 
         def self.autocorrect_incompatible_with
@@ -96,8 +97,29 @@ module RuboCop
           if node.if_branch.nil?
             corrector.remove(range_by_whole_lines(node.loc.else, include_final_newline: true))
           else
-            corrector.replace(node.if_branch, node.else_branch.source)
-            corrector.replace(node.else_branch, node.if_branch.source)
+            if_range = if_range(node)
+            else_range = else_range(node)
+
+            corrector.replace(if_range, else_range.source)
+            corrector.replace(else_range, if_range.source)
+          end
+        end
+
+        # Collect the entire if branch, including whitespace and comments
+        def if_range(node)
+          if node.ternary?
+            node.if_branch
+          else
+            range_between(node.condition.loc.expression.end_pos, node.loc.else.begin_pos)
+          end
+        end
+
+        # Collect the entire else branch, including whitespace and comments
+        def else_range(node)
+          if node.ternary?
+            node.else_branch
+          else
+            range_between(node.loc.else.end_pos, node.loc.end.begin_pos)
           end
         end
       end

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

@@ -80,8 +80,7 @@ module RuboCop
         end
 
         def correct_style?(node)
-          style == :prefix && node.modifier_form? ||
-            style == :postfix && !node.modifier_form?
+          (style == :prefix && node.modifier_form?) || (style == :postfix && !node.modifier_form?)
         end
       end
     end

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

@@ -31,9 +31,7 @@ module RuboCop
           return if part_of_ignored_node?(node)
           return unless modifier?(node) && modifier?(node.parent)
 
-          add_offense(node.loc.keyword) do |corrector|
-            autocorrect(corrector, node)
-          end
+          add_offense(node.loc.keyword) { |corrector| autocorrect(corrector, node) }
           ignore_node(node)
         end
 
@@ -66,8 +64,7 @@ module RuboCop
 
         def left_hand_operand(node, operator)
           expr = node.condition.source
-          expr = "(#{expr})" if node.condition.or_type? &&
-                                operator == '&&'
+          expr = "(#{expr})" if node.condition.or_type? && operator == '&&'
           expr
         end
 
@@ -95,8 +92,7 @@ module RuboCop
         end
 
         def requires_parens?(node)
-          node.or_type? ||
-            !(RuboCop::AST::Node::COMPARISON_OPERATORS & node.children).empty?
+          node.or_type? || !(RuboCop::AST::Node::COMPARISON_OPERATORS & node.children).empty?
         end
       end
     end

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

@@ -18,8 +18,7 @@ module RuboCop
       class NestedTernaryOperator < Base
         extend AutoCorrector
 
-        MSG = 'Ternary operators must not be nested. Prefer `if` or `else` ' \
-              'constructs instead.'
+        MSG = 'Ternary operators must not be nested. Prefer `if` or `else` constructs instead.'
 
         def on_if(node)
           return unless node.ternary?
@@ -51,7 +50,7 @@ module RuboCop
         def remove_parentheses(source)
           return source unless source.start_with?('(')
 
-          source.gsub(/\A\(/, '').gsub(/\)\z/, '')
+          source.delete_prefix('(').delete_suffix(')')
         end
       end
     end

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

@@ -66,8 +66,7 @@ module RuboCop
         end
 
         def on_block(node)
-          return unless node.send_node.send_type? &&
-                        node.send_node.enumerator_method?
+          return unless node.send_node.send_type? && node.send_node.enumerator_method?
 
           check(node)
         end
@@ -180,8 +179,7 @@ module RuboCop
           source_buffer = node.source_range.source_buffer
           end_pos = node.loc.end.end_pos
           begin_pos = node.loc.end.begin_pos - node.loc.end.column
-          begin_pos -= 1 if end_followed_by_whitespace_only?(source_buffer,
-                                                             end_pos)
+          begin_pos -= 1 if end_followed_by_whitespace_only?(source_buffer, end_pos)
 
           range_between(begin_pos, end_pos)
         end
@@ -207,9 +205,7 @@ module RuboCop
 
           target_indent = range.source_line =~ /\S/
           delta = actual_indent(lines, buffer) - target_indent
-          lines.each do |lineno|
-            reindent_line(corrector, lineno, delta, buffer)
-          end
+          lines.each { |lineno| reindent_line(corrector, lineno, delta, buffer) }
         end
 
         def actual_indent(lines, buffer)
@@ -230,8 +226,7 @@ module RuboCop
           if adjustment.positive?
             corrector.remove_leading(buffer.line_range(lineno), adjustment)
           elsif adjustment.negative?
-            corrector.insert_before(buffer.line_range(lineno),
-                                    ' ' * -adjustment)
+            corrector.insert_before(buffer.line_range(lineno), ' ' * -adjustment)
           end
         end
       end

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

@@ -37,7 +37,10 @@ module RuboCop
 
         RESTRICT_ON_SEND = %i[== === nil?].freeze
 
+        # @!method nil_comparison?(node)
         def_node_matcher :nil_comparison?, '(send _ {:== :===} nil)'
+
+        # @!method nil_check?(node)
         def_node_matcher :nil_check?, '(send _ :nil?)'
 
         def on_send(node)

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

@@ -3,8 +3,8 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for lambdas that always return nil, which can be replaced
-      # with an empty lambda instead.
+      # This cop checks for lambdas and procs that always return nil,
+      # which can be replaced with an empty lambda or proc instead.
       #
       # @example
       #   # bad
@@ -14,6 +14,12 @@ module RuboCop
       #     next nil
       #   end
       #
+      #   proc { nil }
+      #
+      #   Proc.new do
+      #     break nil
+      #   end
+      #
       #   # good
       #   -> {}
       #
@@ -22,30 +28,42 @@ module RuboCop
       #
       #   -> (x) { nil if x }
       #
+      #   proc {}
+      #
+      #   Proc.new { nil if x }
+      #
       class NilLambda < Base
         extend AutoCorrector
         include RangeHelp
 
-        MSG = 'Use an empty lambda instead of always returning nil.'
+        MSG = 'Use an empty %<type>s instead of always returning nil.'
 
+        # @!method nil_return?(node)
         def_node_matcher :nil_return?, <<~PATTERN
           { ({return next break} nil) (nil) }
         PATTERN
 
         def on_block(node)
-          return unless node.lambda?
+          return unless node.lambda? || node.proc?
           return unless nil_return?(node.body)
 
-          add_offense(node) do |corrector|
-            range = if node.single_line?
-                      range_with_surrounding_space(range: node.body.loc.expression)
-                    else
-                      range_by_whole_lines(node.body.loc.expression, include_final_newline: true)
-                    end
-
-            corrector.remove(range)
+          message = format(MSG, type: node.lambda? ? 'lambda' : 'proc')
+          add_offense(node, message: message) do |corrector|
+            autocorrect(corrector, node)
           end
         end
+
+        private
+
+        def autocorrect(corrector, node)
+          range = if node.single_line?
+                    range_with_surrounding_space(range: node.body.loc.expression)
+                  else
+                    range_by_whole_lines(node.body.loc.expression, include_final_newline: true)
+                  end
+
+          corrector.remove(range)
+        end
       end
     end
   end

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

@@ -49,20 +49,25 @@ module RuboCop
 
         RESTRICT_ON_SEND = %i[!= nil? !].freeze
 
+        # @!method not_equal_to_nil?(node)
         def_node_matcher :not_equal_to_nil?, '(send _ :!= nil)'
+
+        # @!method unless_check?(node)
         def_node_matcher :unless_check?, '(if (send _ :nil?) ...)'
+
+        # @!method nil_check?(node)
         def_node_matcher :nil_check?, '(send _ :nil?)'
+
+        # @!method not_and_nil_check?(node)
         def_node_matcher :not_and_nil_check?, '(send (send _ :nil?) :!)'
 
         def on_send(node)
           return if ignored_node?(node) ||
-                    !include_semantic_changes? && nil_comparison_style == 'comparison'
+                    (!include_semantic_changes? && nil_comparison_style == 'comparison')
           return unless register_offense?(node)
 
           message = message(node)
-          add_offense(node, message: message) do |corrector|
-            autocorrect(corrector, node)
-          end
+          add_offense(node, message: message) { |corrector| autocorrect(corrector, node) }
         end
 
         def on_def(node)
@@ -82,7 +87,7 @@ module RuboCop
 
         def register_offense?(node)
           not_equal_to_nil?(node) ||
-            include_semantic_changes? && (not_and_nil_check?(node) || unless_and_nil_check?(node))
+            (include_semantic_changes? && (not_and_nil_check?(node) || unless_and_nil_check?(node)))
         end
 
         def autocorrect(corrector, node)
@@ -99,8 +104,7 @@ module RuboCop
         def unless_and_nil_check?(send_node)
           parent = send_node.parent
 
-          nil_check?(send_node) && unless_check?(parent) && !parent.ternary? &&
-            parent.unless?
+          nil_check?(send_node) && unless_check?(parent) && !parent.ternary? && parent.unless?
         end
 
         def message(node)

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

@@ -53,8 +53,8 @@ module RuboCop
 
         def requires_parens?(child)
           child.and_type? || child.or_type? ||
-            child.send_type? && child.binary_operation? ||
-            child.if_type? && child.ternary?
+            (child.send_type? && child.binary_operation?) ||
+            (child.if_type? && child.ternary?)
         end
 
         def correct_opposite_method(corrector, range, child)

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for numbered parameters.
+      #
+      # It can either restrict the use of numbered parameters to
+      # single-lined blocks, or disallow completely numbered parameters.
+      #
+      # @example EnforcedStyle: allow_single_line (default)
+      #   # bad
+      #   collection.each do
+      #     puts _1
+      #   end
+      #
+      #   # good
+      #   collection.each { puts _1 }
+      #
+      # @example EnforcedStyle: disallow
+      #   # bad
+      #   collection.each { puts _1 }
+      #
+      #   # good
+      #   collection.each { |item| puts item }
+      #
+      class NumberedParameters < Base
+        include ConfigurableEnforcedStyle
+        extend TargetRubyVersion
+
+        MSG_DISALLOW = 'Avoid using numbered parameters.'
+        MSG_MULTI_LINE = 'Avoid using numbered parameters for multi-line blocks.'
+
+        minimum_target_ruby_version 2.7
+
+        def on_numblock(node)
+          if style == :disallow
+            add_offense(node, message: MSG_DISALLOW)
+          elsif node.multiline?
+            add_offense(node, message: MSG_MULTI_LINE)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop detects use of an excessive amount of numbered parameters in a
+      # single block. Having too many numbered parameters can make code too
+      # cryptic and hard to read.
+      #
+      # The cop defaults to registering an offense if there is more than 1 numbered
+      # parameter but this maximum can be configured by setting `Max`.
+      #
+      # @example Max: 1 (default)
+      #   # bad
+      #   foo { _1.call(_2, _3, _4) }
+      #
+      #   # good
+      #   foo { do_something(_1) }
+      class NumberedParametersLimit < Base
+        extend TargetRubyVersion
+        extend ExcludeLimit
+
+        DEFAULT_MAX_VALUE = 1
+
+        minimum_target_ruby_version 2.7
+        exclude_limit 'Max'
+
+        MSG = 'Avoid using more than %<max>i numbered %<parameter>s; %<count>i detected.'
+
+        def on_numblock(node)
+          _send_node, param_count, * = *node
+          return if param_count <= max_count
+
+          parameter = max_count > 1 ? 'parameters' : 'parameter'
+          message = format(MSG, max: max_count, parameter: parameter, count: param_count)
+          add_offense(node, message: message) { self.max = param_count }
+        end
+
+        private
+
+        def max_count
+          max = cop_config.fetch('Max', DEFAULT_MAX_VALUE)
+
+          # Ruby does not allow more than 9 numbered parameters
+          [max, 9].min
+        end
+      end
+    end
+  end
+end