rubocop 1.39.0 → 1.44.1

data/lib/rubocop/cop/registry.rb

@@ -19,6 +19,33 @@ module RuboCop
     class Registry
       include Enumerable
 
+      def self.all
+        global.without_department(:Test).cops
+      end
+
+      def self.qualified_cop_name(name, origin)
+        global.qualified_cop_name(name, origin)
+      end
+
+      # Changes momentarily the global registry
+      # Intended for testing purposes
+      def self.with_temporary_global(temp_global = global.dup)
+        previous = @global
+        @global = temp_global
+        yield
+      ensure
+        @global = previous
+      end
+
+      def self.reset!
+        @global = new
+      end
+
+      def self.qualified_cop?(name)
+        badge = Badge.parse(name)
+        global.qualify_badge(badge).first == badge
+      end
+
       attr_reader :options
 
       def initialize(cops = [], options = {})
@@ -28,6 +55,9 @@ module RuboCop
 
         @enrollment_queue = cops
         @options = options
+
+        @enabled_cache = {}.compare_by_identity
+        @disabled_cache = {}.compare_by_identity
       end
 
       def enlist(cop)
@@ -61,7 +91,7 @@ module RuboCop
 
       # @return [Boolean] Checks if given name is department
       def department?(name)
-        departments.include? name.to_sym
+        departments.include?(name.to_sym)
       end
 
       def contains_cop_matching?(names)
@@ -72,27 +102,27 @@ module RuboCop
       #
       # @example gives back a correctly qualified cop name
       #
-      #   cops = RuboCop::Cop::Cop.all
-      #   cops.
-      #     qualified_cop_name('Layout/EndOfLine') # => 'Layout/EndOfLine'
+      #   registry = RuboCop::Cop::Registry
+      #   registry.qualified_cop_name('Layout/EndOfLine', '') # => 'Layout/EndOfLine'
       #
       # @example fixes incorrect namespaces
       #
-      #   cops = RuboCop::Cop::Cop.all
-      #   cops.qualified_cop_name('Lint/EndOfLine') # => 'Layout/EndOfLine'
+      #   registry = RuboCop::Cop::Registry
+      #   registry.qualified_cop_name('Lint/EndOfLine', '') # => 'Layout/EndOfLine'
       #
       # @example namespaces bare cop identifiers
       #
-      #   cops = RuboCop::Cop::Cop.all
-      #   cops.qualified_cop_name('EndOfLine') # => 'Layout/EndOfLine'
+      #   registry = RuboCop::Cop::Registry
+      #   registry.qualified_cop_name('EndOfLine', '') # => 'Layout/EndOfLine'
       #
       # @example passes back unrecognized cop names
       #
-      #   cops = RuboCop::Cop::Cop.all
-      #   cops.qualified_cop_name('NotACop') # => 'NotACop'
+      #   registry = RuboCop::Cop::Registry
+      #   registry.qualified_cop_name('NotACop', '') # => 'NotACop'
       #
       # @param name [String] Cop name extracted from config
       # @param path [String, nil] Path of file that `name` was extracted from
+      # @param warn [Boolean] Print a warning if no department given for `name`
       #
       # @raise [AmbiguousCopName]
       #   if a bare identifier with two possible namespaces is provided
@@ -133,6 +163,13 @@ module RuboCop
           'RedundantCopDisableDirective'
       end
 
+      def qualify_badge(badge)
+        clear_enrollment_queue
+        @departments
+          .map { |department, _| badge.with_department(department) }
+          .select { |potential_badge| registered?(potential_badge) }
+      end
+
       # @return [Hash{String => Array<Class>}]
       def to_h
         clear_enrollment_queue
@@ -150,15 +187,15 @@ module RuboCop
       end
 
       def enabled(config)
-        select { |cop| enabled?(cop, config) }
+        @enabled_cache[config] ||= select { |cop| enabled?(cop, config) }
       end
 
       def disabled(config)
-        reject { |cop| enabled?(cop, config) }
+        @disabled_cache[config] ||= reject { |cop| enabled?(cop, config) }
       end
 
       def enabled?(cop, config)
-        return true if options.fetch(:only, []).include?(cop.cop_name)
+        return true if options[:only]&.include?(cop.cop_name)
 
         cfg = config.for_cop(cop)
 
@@ -182,8 +219,12 @@ module RuboCop
         cops.map(&:cop_name)
       end
 
+      def cops_for_department(department)
+        cops.select { |cop| cop.department == department.to_sym }
+      end
+
       def names_for_department(department)
-        cops.select { |cop| cop.department == department.to_sym }.map(&:cop_name)
+        cops_for_department(department).map(&:cop_name)
       end
 
       def ==(other)
@@ -211,6 +252,14 @@ module RuboCop
         to_h[cop_name].first
       end
 
+      # When a cop name is given returns a single-element array with the cop class.
+      # When a department name is given returns an array with all the cop classes
+      # for that department.
+      def find_cops_by_directive(directive)
+        cop = find_by_cop_name(directive)
+        cop ? [cop] : cops_for_department(directive)
+      end
+
       def freeze
         clear_enrollment_queue
         unqualified_cop_names # build cache
@@ -223,28 +272,6 @@ module RuboCop
         attr_reader :global
       end
 
-      def self.all
-        global.without_department(:Test).cops
-      end
-
-      def self.qualified_cop_name(name, origin)
-        global.qualified_cop_name(name, origin)
-      end
-
-      # Changes momentarily the global registry
-      # Intended for testing purposes
-      def self.with_temporary_global(temp_global = global.dup)
-        previous = @global
-        @global = temp_global
-        yield
-      ensure
-        @global = previous
-      end
-
-      def self.reset!
-        @global = new
-      end
-
       private
 
       def initialize_copy(reg)
@@ -267,13 +294,6 @@ module RuboCop
         self.class.new(cops)
       end
 
-      def qualify_badge(badge)
-        clear_enrollment_queue
-        @departments
-          .map { |department, _| badge.with_department(department) }
-          .select { |potential_badge| registered?(potential_badge) }
-      end
-
       def resolve_badge(given_badge, real_badge, source_path)
         unless given_badge.match?(real_badge)
           path = PathUtil.smart_path(source_path)

data/lib/rubocop/cop/security/compound_hash.rb

@@ -9,7 +9,8 @@ module RuboCop
       # Manually combining hashes is error prone and hard to follow, especially
       # when there are many values. Poor implementations may also introduce
       # performance or security concerns if they are prone to collisions.
-      # Delegating to `Array#hash` is clearer, faster, and safer.
+      # Delegating to `Array#hash` is clearer and safer, although it might be slower
+      # depending on the use case.
       #
       # @safety
       #   This cop may be unsafe if the application logic depends on the hash

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

@@ -115,9 +115,7 @@ module RuboCop
             def_node = find_corresponding_def_node(node)
             return unless def_node
 
-            remove_node(corrector, def_node)
-            remove_node(corrector, node)
-            insert_def(corrector, node, def_node.source)
+            replace_def(corrector, node, def_node)
           when :inline
             remove_node(corrector, node)
             select_grouped_def_nodes(node).each do |grouped_def_node|
@@ -173,7 +171,9 @@ module RuboCop
         end
 
         def find_argument_less_modifier_node(node)
-          node.parent.each_child_node(:send).find do |child|
+          return unless (parent = node.parent)
+
+          parent.each_child_node(:send).find do |child|
             child.method?(node.method_name) && child.arguments.empty?
           end
         end
@@ -184,17 +184,21 @@ module RuboCop
           end.select(&:def_type?)
         end
 
-        def insert_def(corrector, node, source)
-          source = [*processed_source.ast_with_comments[node].map(&:text), source].join("\n")
+        def replace_def(corrector, node, def_node)
+          source = def_source(node, def_node)
           argument_less_modifier_node = find_argument_less_modifier_node(node)
           if argument_less_modifier_node
             corrector.insert_after(argument_less_modifier_node, "\n\n#{source}")
+          elsif (ancestor = node.each_ancestor(:block, :class, :module).first)
+
+            corrector.insert_before(ancestor.loc.end, "#{node.method_name}\n\n#{source}\n")
           else
-            corrector.insert_before(
-              node.each_ancestor(:block, :class, :module).first.location.end,
-              "#{node.method_name}\n\n#{source}\n"
-            )
+            corrector.replace(node, "#{node.method_name}\n\n#{source}")
+            return
           end
+
+          remove_node(corrector, def_node)
+          remove_node(corrector, node)
         end
 
         def insert_inline_modifier(corrector, node, modifier_name)
@@ -204,6 +208,10 @@ module RuboCop
         def remove_node(corrector, node)
           corrector.remove(range_with_comments_and_lines(node))
         end
+
+        def def_source(node, def_node)
+          [*processed_source.ast_with_comments[node].map(&:text), def_node.source].join("\n")
+        end
       end
     end
   end

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

@@ -7,6 +7,11 @@ module RuboCop
       # depending on configuration.
       # It also flags uses of `alias :symbol` rather than `alias bareword`.
       #
+      # However, it will always enforce `method_alias` when used `alias`
+      # in an instance method definition and in a singleton method definition.
+      # If used in a block, always enforce `alias_method`
+      # unless it is an `instance_eval` block.
+      #
       # @example EnforcedStyle: prefer_alias (default)
       #   # bad
       #   alias_method :bar, :foo
@@ -22,6 +27,7 @@ module RuboCop
       #
       #   # good
       #   alias_method :bar, :foo
+      #
       class Alias < Base
         include ConfigurableEnforcedStyle
         extend AutoCorrector
@@ -71,7 +77,9 @@ module RuboCop
         end
 
         def alias_method_possible?(node)
-          scope_type(node) != :instance_eval && node.children.none?(&:gvar_type?)
+          scope_type(node) != :instance_eval &&
+            node.children.none?(&:gvar_type?) &&
+            node&.parent&.type != :def
         end
 
         def add_offense_for_args(node, &block)

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

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # In Ruby 3.1, `Array#intersect?` has been added.
+      #
+      # This cop identifies places where `(array1 & array2).any?`
+      # can be replaced by `array1.intersect?(array2)`.
+      #
+      # The `array1.intersect?(array2)` method is faster than
+      # `(array1 & array2).any?` and is more readable.
+      #
+      # @safety
+      #   This cop cannot guarantee that array1 and array2 are
+      #   actually arrays while method `intersect?` is for arrays only.
+      #
+      # @example
+      #   # bad
+      #   (array1 & array2).any?
+      #   (array1 & array2).empty?
+      #
+      #   # good
+      #   array1.intersect?(array2)
+      #   !array1.intersect?(array2)
+      #
+      # @example AllCops:ActiveSupportExtensionsEnabled: false (default)
+      #   # good
+      #   (array1 & array2).present?
+      #   (array1 & array2).blank?
+      #
+      # @example AllCops:ActiveSupportExtensionsEnabled: true
+      #   # bad
+      #   (array1 & array2).present?
+      #   (array1 & array2).blank?
+      #
+      #   # good
+      #   array1.intersect?(array2)
+      #   !array1.intersect?(array2)
+      class ArrayIntersect < Base
+        extend AutoCorrector
+        extend TargetRubyVersion
+
+        minimum_target_ruby_version 3.1
+
+        # @!method regular_bad_intersection_check?(node)
+        def_node_matcher :regular_bad_intersection_check?, <<~PATTERN
+          (send
+            (begin
+              (send $(...) :& $(...))
+            ) ${:any? :empty?}
+          )
+        PATTERN
+
+        # @!method active_support_bad_intersection_check?(node)
+        def_node_matcher :active_support_bad_intersection_check?, <<~PATTERN
+          (send
+            (begin
+              (send $(...) :& $(...))
+            ) ${:present? :any? :blank? :empty?}
+          )
+        PATTERN
+
+        MSG = 'Use `%<negated>s%<receiver>s.intersect?(%<argument>s)` ' \
+              'instead of `(%<receiver>s & %<argument>s).%<method_name>s`.'
+        STRAIGHT_METHODS = %i[present? any?].freeze
+        NEGATED_METHODS = %i[blank? empty?].freeze
+        RESTRICT_ON_SEND = (STRAIGHT_METHODS + NEGATED_METHODS).freeze
+
+        def on_send(node)
+          return unless (receiver, argument, method_name = bad_intersection_check?(node))
+
+          message = message(receiver.source, argument.source, method_name)
+
+          add_offense(node, message: message) do |corrector|
+            if straight?(method_name)
+              corrector.replace(node, "#{receiver.source}.intersect?(#{argument.source})")
+            else
+              corrector.replace(node, "!#{receiver.source}.intersect?(#{argument.source})")
+            end
+          end
+        end
+
+        private
+
+        def bad_intersection_check?(node)
+          if active_support_extensions_enabled?
+            active_support_bad_intersection_check?(node)
+          else
+            regular_bad_intersection_check?(node)
+          end
+        end
+
+        def straight?(method_name)
+          STRAIGHT_METHODS.include?(method_name.to_sym)
+        end
+
+        def message(receiver, argument, method_name)
+          negated = straight?(method_name) ? '' : '!'
+          format(
+            MSG,
+            negated: negated,
+            receiver: receiver,
+            argument: argument,
+            method_name: method_name
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -32,7 +32,7 @@ module RuboCop
               eq_begin, eq_end, contents = parts(comment)
 
               corrector.remove(eq_begin)
-              unless contents.length.zero?
+              unless contents.empty?
                 corrector.replace(
                   contents,
                   contents.source.gsub(/\A/, '# ').gsub(/\n\n/, "\n#\n").gsub(/\n(?=[^#])/, "\n# ")

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

@@ -299,8 +299,8 @@ module RuboCop
 
         def move_comment_before_block(corrector, comment, block_node, closing_brace)
           range = block_node.chained? ? end_of_chain(block_node.parent).source_range : closing_brace
-          comment_range = range_between(range.end_pos, comment.loc.expression.end_pos)
-          corrector.remove(range_with_surrounding_space(comment_range, side: :right))
+          corrector.remove(range_with_surrounding_space(comment.loc.expression, side: :right))
+          remove_trailing_whitespace(corrector, range, comment)
           corrector.insert_after(range, "\n")
 
           corrector.insert_before(block_node, "#{comment.text}\n")
@@ -313,6 +313,12 @@ module RuboCop
           end_of_chain(node.parent)
         end
 
+        def remove_trailing_whitespace(corrector, range, comment)
+          range_of_trailing = range.end.join(comment.loc.expression.begin)
+
+          corrector.remove(range_of_trailing) if range_of_trailing.source.match?(/\A\s+\z/)
+        end
+
         def with_block?(node)
           node.respond_to?(:block_node) && node.block_node
         end

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

@@ -31,6 +31,7 @@ module RuboCop
       #
       # The compact style is only forced for classes/modules with one child.
       class ClassAndModuleChildren < Base
+        include Alignment
         include ConfigurableEnforcedStyle
         include RangeHelp
         extend AutoCorrector
@@ -59,7 +60,7 @@ module RuboCop
         end
 
         def nest_definition(corrector, node)
-          padding = ((' ' * indent_width) + leading_spaces(node)).to_s
+          padding = indentation(node) + leading_spaces(node)
           padding_for_trailing_end = padding.sub(' ' * node.loc.end.column, '')
 
           replace_namespace_keyword(corrector, node)
@@ -124,10 +125,6 @@ module RuboCop
           corrector.remove(range)
         end
 
-        def configured_indentation_width
-          config.for_badge(Layout::IndentationWidth.badge).fetch('Width', 2)
-        end
-
         def unindent(corrector, node)
           return if node.body.children.last.nil?
 
@@ -141,10 +138,6 @@ module RuboCop
           node.source_range.source_line[/\A\s*/]
         end
 
-        def indent_width
-          @config.for_cop('Layout/IndentationWidth')['Width'] || 2
-        end
-
         def check_style(node, body)
           return if node.identifier.children[0]&.cbase_type?
 

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

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Enforces the use of `Comparable#clamp` instead of comparison by minimum and maximum.
+      #
+      # This cop supports autocorrection for `if/elsif/else` bad style only.
+      # Because `ArgumentError` occurs if the minimum and maximum of `clamp` arguments are reversed.
+      # When these are variables, it is not possible to determine which is the minimum and maximum:
+      #
+      # [source,ruby]
+      # ----
+      # [1, [2, 3].max].min # => 1
+      # 1.clamp(3, 1)       # => min argument must be smaller than max argument (ArgumentError)
+      # ----
+      #
+      # @example
+      #
+      #   # bad
+      #   [[x, low].max, high].min
+      #
+      #   # bad
+      #   if x < low
+      #     low
+      #   elsif high < x
+      #     high
+      #   else
+      #     x
+      #   end
+      #
+      #   # good
+      #   x.clamp(low, high)
+      #
+      class ComparableClamp < Base
+        include Alignment
+        extend AutoCorrector
+        extend TargetRubyVersion
+
+        minimum_target_ruby_version 2.4
+
+        MSG = 'Use `%<prefer>s` instead of `if/elsif/else`.'
+        MSG_MIN_MAX = 'Use `Comparable#clamp` instead.'
+        RESTRICT_ON_SEND = %i[min max].freeze
+
+        # @!method if_elsif_else_condition?(node)
+        def_node_matcher :if_elsif_else_condition?, <<~PATTERN
+          {
+            (if (send _x :< _min) _min (if (send _max :< _x) _max _x))
+            (if (send _min :> _x) _min (if (send _max :< _x) _max _x))
+            (if (send _x :< _min) _min (if (send _x :> _max) _max _x))
+            (if (send _min :> _x) _min (if (send _x :> _max) _max _x))
+            (if (send _max :< _x) _max (if (send _x :< _min) _min _x))
+            (if (send _x :> _max) _max (if (send _x :< _min) _min _x))
+            (if (send _max :< _x) _max (if (send _min :> _x) _min _x))
+            (if (send _x :> _max) _max (if (send _min :> _x) _min _x))
+          }
+        PATTERN
+
+        # @!method array_min_max?(node)
+        def_node_matcher :array_min_max?, <<~PATTERN
+          {
+            (send
+              (array
+                (send (array _ _) :max) _) :min)
+            (send
+              (array
+                _ (send (array _ _) :max)) :min)
+            (send
+              (array
+                (send (array _ _) :min) _) :max)
+            (send
+              (array
+                _ (send (array _ _) :min)) :max)
+          }
+        PATTERN
+
+        def on_if(node)
+          return unless if_elsif_else_condition?(node)
+
+          if_body, elsif_body, else_body = *node.branches
+
+          else_body_source = else_body.source
+
+          if min_condition?(node.condition, else_body_source)
+            min = if_body.source
+            max = elsif_body.source
+          else
+            min = elsif_body.source
+            max = if_body.source
+          end
+
+          prefer = "#{else_body_source}.clamp(#{min}, #{max})"
+
+          add_offense(node, message: format(MSG, prefer: prefer)) do |corrector|
+            autocorrect(corrector, node, prefer)
+          end
+        end
+
+        def on_send(node)
+          return unless array_min_max?(node)
+
+          add_offense(node, message: MSG_MIN_MAX)
+        end
+
+        private
+
+        def autocorrect(corrector, node, prefer)
+          if node.elsif?
+            corrector.insert_before(node, "else\n")
+            corrector.replace(node, "#{indentation(node)}#{prefer}")
+          else
+            corrector.replace(node, prefer)
+          end
+        end
+
+        def min_condition?(if_condition, else_body)
+          lhs, op, rhs = *if_condition
+
+          (lhs.source == else_body && op == :<) || (rhs.source == else_body && op == :>)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Enforces the use of `Array#push(item)` instead of `Array#concat([item])`
+      # to avoid redundant array literals.
+      #
+      # @safety
+      #   This cop is unsafe, as it can produce false positives if the receiver
+      #   is not an `Array` object.
+      #
+      # @example
+      #
+      #   # bad
+      #   list.concat([foo])
+      #   list.concat([bar, baz])
+      #   list.concat([qux, quux], [corge])
+      #
+      #   # good
+      #   list.push(foo)
+      #   list.push(bar, baz)
+      #   list.push(qux, quux, corge)
+      #
+      class ConcatArrayLiterals < Base
+        extend AutoCorrector
+
+        MSG = 'Use `%<prefer>s` instead of `%<current>s`.'
+        MSG_FOR_PERCENT_LITERALS =
+          'Use `push` with elements as arguments without array brackets instead of `%<current>s`.'
+        RESTRICT_ON_SEND = %i[concat].freeze
+
+        # rubocop:disable Metrics
+        def on_send(node)
+          return if node.arguments.empty?
+          return unless node.arguments.all?(&:array_type?)
+
+          offense = offense_range(node)
+          current = offense.source
+
+          if node.arguments.any?(&:percent_literal?)
+            if percent_literals_includes_only_basic_literals?(node)
+              prefer = preferred_method(node)
+              message = format(MSG, prefer: prefer, current: current)
+            else
+              message = format(MSG_FOR_PERCENT_LITERALS, current: current)
+            end
+          else
+            prefer = preferred_method(node)
+            message = format(MSG, prefer: prefer, current: current)
+          end
+
+          add_offense(offense, message: message) do |corrector|
+            corrector.replace(offense, prefer)
+          end
+        end
+        # rubocop:enable Metrics
+
+        private
+
+        def offense_range(node)
+          node.loc.selector.join(node.source_range.end)
+        end
+
+        def preferred_method(node)
+          new_arguments =
+            node.arguments.map do |arg|
+              if arg.percent_literal?
+                arg.children.map(&:value).map(&:inspect)
+              else
+                arg.children.map(&:source)
+              end
+            end.join(', ')
+
+          "push(#{new_arguments})"
+        end
+
+        def percent_literals_includes_only_basic_literals?(node)
+          node.arguments.select(&:percent_literal?).all? do |arg|
+            arg.children.all? { |child| child.str_type? || child.sym_type? }
+          end
+        end
+      end
+    end
+  end
+end