rubocop 1.25.1 → 1.27.0

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

@@ -37,8 +37,7 @@ module RuboCop
 
         def requires_interpolation?(node)
           node.child_nodes.any? do |string|
-            string.dstr_type? ||
-              double_quotes_required?(string.source)
+            string.dstr_type? || double_quotes_required?(string.source)
           end
         end
       end

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

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for `initialize` methods that are redundant.
+      #
+      # An initializer is redundant if it does not do anything, or if it only
+      # calls `super` with the same arguments given to it. If the initializer takes
+      # an argument that accepts multiple values (`restarg`, `kwrestarg`, etc.) it
+      # will not register an offense, because it allows the initializer to take a different
+      # number of arguments as its superclass potentially does.
+      #
+      # NOTE: If an initializer argument has a default value, RuboCop assumes it
+      # to *not* be redundant.
+      #
+      # NOTE: Empty initializers are registered as offenses, but it is possible
+      # to purposely create an empty `initialize` method to override a superclass's
+      # initializer.
+      #
+      # @example
+      #   # bad
+      #   def initialize
+      #   end
+      #
+      #   # bad
+      #   def initialize
+      #     super
+      #   end
+      #
+      #   # bad
+      #   def initialize(a, b)
+      #     super
+      #   end
+      #
+      #   # bad
+      #   def initialize(a, b)
+      #     super(a, b)
+      #   end
+      #
+      #   # good
+      #   def initialize
+      #     do_something
+      #   end
+      #
+      #   # good
+      #   def initialize
+      #     do_something
+      #     super
+      #   end
+      #
+      #   # good (different number of parameters)
+      #   def initialize(a, b)
+      #     super(a)
+      #   end
+      #
+      #   # good (default value)
+      #   def initialize(a, b = 5)
+      #     super
+      #   end
+      #
+      #   # good (default value)
+      #   def initialize(a, b: 5)
+      #     super
+      #   end
+      #
+      #   # good (changes the parameter requirements)
+      #   def initialize(*)
+      #   end
+      #
+      #   # good (changes the parameter requirements)
+      #   def initialize(**)
+      #   end
+      #
+      #   # good (changes the parameter requirements)
+      #   def initialize(...)
+      #   end
+      #
+      class RedundantInitialize < Base
+        MSG = 'Remove unnecessary `initialize` method.'
+        MSG_EMPTY = 'Remove unnecessary empty `initialize` method.'
+
+        # @!method initialize_forwards?(node)
+        def_node_matcher :initialize_forwards?, <<~PATTERN
+          (def _ (args $arg*) $({super zsuper} ...))
+        PATTERN
+
+        def on_def(node)
+          return unless node.method?(:initialize)
+          return if forwards?(node)
+
+          if node.body.nil?
+            add_offense(node, message: MSG_EMPTY)
+          else
+            return if node.body.begin_type?
+
+            if (args, super_node = initialize_forwards?(node))
+              return unless same_args?(super_node, args)
+
+              add_offense(node)
+            end
+          end
+        end
+
+        private
+
+        def forwards?(node)
+          node.arguments.each_child_node(:restarg, :kwrestarg, :forward_args, :forward_arg).any?
+        end
+
+        def same_args?(super_node, args)
+          return true if super_node.zsuper_type?
+
+          args.map(&:name) == super_node.arguments.map { |a| a.children[0] }
+        end
+      end
+    end
+  end
+end

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

@@ -7,8 +7,7 @@ module RuboCop
       # check for the variable whose method is being called to
       # safe navigation (`&.`). If there is a method chain, all of the methods
       # in the chain need to be checked for safety, and all of the methods will
-      # need to be changed to use safe navigation. We have limited the cop to
-      # not register an offense for method chains that exceed 2 methods.
+      # need to be changed to use safe navigation.
       #
       # The default for `ConvertCodeThatCanStartToReturnNil` is `false`.
       # When configured to `true`, this will
@@ -18,6 +17,10 @@ module RuboCop
       # `foo&.bar` can start returning `nil` as well as what the method
       # returns.
       #
+      # The default for `MaxChainLength` is `2`
+      # We have limited the cop to not register an offense for method chains
+      # that exceed this option is set.
+      #
       # @safety
       #   Autocorrection is unsafe because if a value is `false`, the resulting
       #   code will have different behaviour or raise an error.
@@ -116,9 +119,7 @@ module RuboCop
           checked_variable, receiver, method_chain, method = extract_parts(node)
           return unless receiver == checked_variable
           return if use_var_only_in_unless_modifier?(node, checked_variable)
-          # method is already a method call so this is actually checking for a
-          # chain greater than 2
-          return if chain_size(method_chain, method) > 1
+          return if chain_length(method_chain, method) > max_chain_length
           return if unsafe_method_used?(method_chain, method)
           return if method_chain.method?(:empty?)
 
@@ -225,8 +226,8 @@ module RuboCop
           find_matching_receiver_invocation(receiver, checked_variable)
         end
 
-        def chain_size(method_chain, method)
-          method.each_ancestor(:send).inject(0) do |total, ancestor|
+        def chain_length(method_chain, method)
+          method.each_ancestor(:send).inject(1) do |total, ancestor|
             break total + 1 if ancestor == method_chain
 
             total + 1
@@ -281,6 +282,10 @@ module RuboCop
             break if ancestor == method_chain
           end
         end
+
+        def max_chain_length
+          cop_config.fetch('MaxChainLength', 2)
+        end
       end
     end
   end

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

@@ -69,6 +69,11 @@ module RuboCop
           }
         PATTERN
 
+        # @!method env_const?(node)
+        def_node_matcher :env_const?, <<~PATTERN
+          (const {nil? cbase} :ENV)
+        PATTERN
+
         # @!method calls_lvar?(node, name)
         def_node_matcher :calls_lvar?, <<~PATTERN
           {
@@ -94,7 +99,7 @@ module RuboCop
         def receiver_allowed?(node)
           return false unless node
 
-          node.hash_type? || creates_hash?(node)
+          node.hash_type? || creates_hash?(node) || env_const?(node)
         end
 
         def register_offense(node, block_node, regexp)

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

@@ -15,6 +15,11 @@ module RuboCop
       #     end
       #   end
       #
+      #   # bad
+      #   if condition_b
+      #     do_something
+      #   end if condition_a
+      #
       #   # good
       #   if condition_a && condition_b
       #     do_something
@@ -26,12 +31,21 @@ module RuboCop
       #     do_something if condition_b
       #   end
       #
+      #   # bad
+      #   if condition_b
+      #     do_something
+      #   end if condition_a
+      #
       # @example AllowModifier: true
       #   # good
       #   if condition_a
       #     do_something if condition_b
       #   end
       #
+      #   # good
+      #   if condition_b
+      #     do_something
+      #   end if condition_a
       class SoleNestedConditional < Base
         include RangeHelp
         extend AutoCorrector
@@ -47,7 +61,7 @@ module RuboCop
 
           if_branch = node.if_branch
           return if use_variable_assignment_in_condition?(node.condition, if_branch)
-          return unless offending_branch?(if_branch)
+          return unless offending_branch?(node, if_branch)
 
           message = format(MSG, conditional_type: node.keyword)
           add_offense(if_branch.loc.keyword, message: message) do |corrector|
@@ -72,13 +86,13 @@ module RuboCop
           end
         end
 
-        def offending_branch?(branch)
+        def offending_branch?(node, branch)
           return false unless branch
 
           branch.if_type? &&
             !branch.else? &&
             !branch.ternary? &&
-            !(branch.modifier_form? && allow_modifier?)
+            !((node.modifier_form? || branch.modifier_form?) && allow_modifier?)
         end
 
         def autocorrect(corrector, node, if_branch)
@@ -86,6 +100,14 @@ module RuboCop
             corrector.wrap(node.condition, '(', ')')
           end
 
+          if outer_condition_modify_form?(node, if_branch)
+            autocorrect_outer_condition_modify_form(corrector, node, if_branch)
+          else
+            autocorrect_outer_condition_basic(corrector, node, if_branch)
+          end
+        end
+
+        def autocorrect_outer_condition_basic(corrector, node, if_branch)
           correct_from_unless_to_if(corrector, node) if node.unless?
 
           and_operator = if_branch.unless? ? ' && !' : ' && '
@@ -97,11 +119,17 @@ module RuboCop
           end
         end
 
-        def correct_from_unless_to_if(corrector, node)
+        def autocorrect_outer_condition_modify_form(corrector, node, if_branch)
+          correct_from_unless_to_if(corrector, if_branch, is_modify_form: true) if if_branch.unless?
+          correct_for_outer_condition_modify_form_style(corrector, node, if_branch)
+        end
+
+        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?
+          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, '!')
@@ -113,7 +141,7 @@ module RuboCop
           correct_outer_condition(corrector, outer_condition)
 
           condition = if_branch.condition
-          corrector.insert_after(outer_condition, replacement_condition(and_operator, condition))
+          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))
@@ -129,6 +157,16 @@ module RuboCop
           corrector.wrap(if_branch.condition, '(', ')') if wrap_condition?(if_branch.condition)
         end
 
+        def correct_for_outer_condition_modify_form_style(corrector, node, if_branch)
+          condition = if_branch.condition
+          corrector.insert_before(condition,
+                                  "#{'!' 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.replace(if_branch.loc.keyword, 'if')
+        end
+
         def correct_for_comment(corrector, node, if_branch)
           return if config.for_cop('Style/IfUnlessModifier')['Enabled']
 
@@ -165,17 +203,17 @@ module RuboCop
             (node.send_type? && node.arguments.any? && !node.parenthesized?)
         end
 
-        def replacement_condition(and_operator, condition)
-          if wrap_condition?(condition)
-            "#{and_operator}(#{condition.source})"
-          else
-            "#{and_operator}#{condition.source}"
-          end
+        def replace_condition(condition)
+          wrap_condition?(condition) ? "(#{condition.source})" : condition.source
         end
 
         def allow_modifier?
           cop_config['AllowModifier']
         end
+
+        def outer_condition_modify_form?(node, if_branch)
+          node.condition.loc.expression.begin_pos > if_branch.condition.loc.expression.begin_pos
+        end
       end
     end
   end

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

@@ -134,7 +134,13 @@ module RuboCop
         end
 
         def uncorrectable?(part)
-          part.multiline? || (part.str_type? && part.heredoc?) || part.each_descendant(:block).any?
+          part.multiline? || heredoc?(part) || part.each_descendant(:block).any?
+        end
+
+        def heredoc?(node)
+          return false unless node.str_type? || node.dstr_type?
+
+          node.heredoc?
         end
 
         def corrected_ancestor?(node)

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

@@ -184,8 +184,7 @@ module RuboCop
 
         def unsafe_autocorrect?(condition)
           condition.children.any? do |child|
-            unparenthesized_method_call?(child) ||
-              below_ternary_precedence?(child)
+            unparenthesized_method_call?(child) || below_ternary_precedence?(child)
           end
         end
 

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

@@ -10,7 +10,7 @@ module RuboCop
       # last item of all non-empty, multiline array literals.
       # * `comma`: Requires a comma after last item in an array,
       # but only when each item is on its own line.
-      # * `no_comma`: Does not requires a comma after the
+      # * `no_comma`: Does not require a comma after the
       # last item in an array
       #
       # @example EnforcedStyleForMultiline: consistent_comma

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

@@ -10,7 +10,7 @@ module RuboCop
       # last item of all non-empty, multiline hash literals.
       # * `comma`: Requires a comma after the last item in a hash,
       # but only when each item is on its own line.
-      # * `no_comma`: Does not requires a comma after the
+      # * `no_comma`: Does not require a comma after the
       # last item in a hash
       #
       # @example EnforcedStyleForMultiline: consistent_comma

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

@@ -42,10 +42,7 @@ module RuboCop
           return if node.endless? || !trailing_end?(node)
 
           add_offense(node.loc.end) do |corrector|
-            corrector.insert_before(
-              node.loc.end,
-              "\n#{' ' * node.loc.keyword.column}"
-            )
+            corrector.insert_before(node.loc.end, "\n#{' ' * node.loc.keyword.column}")
           end
         end
 

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

@@ -32,10 +32,14 @@ module RuboCop
             body_range = range_between_condition_and_else(node, node.condition)
             else_range = range_between_else_and_end(node)
 
+            next if part_of_ignored_node?(node)
+
             corrector.replace(node.loc.keyword, 'if')
             corrector.replace(body_range, else_range.source)
             corrector.replace(else_range, body_range.source)
           end
+
+          ignore_node(node)
         end
 
         def range_between_condition_and_else(node, condition)

data/lib/rubocop/cop/variable_force.rb

@@ -186,11 +186,7 @@ module RuboCop
       end
 
       def regexp_captured_names(node)
-        regexp_string = node.children.select(&:str_type?).map do |child|
-          child.children.first
-        end.join || ''
-
-        regexp = Regexp.new(regexp_string)
+        regexp = node.to_regexp
 
         regexp.named_captures.keys
       end

data/lib/rubocop/cops_documentation_generator.rb

@@ -191,8 +191,8 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
 
   def wrap_backtick(value)
     if value.is_a?(String)
-      # Use `+` to prevent text like `**/*.gemspec` from being bold.
-      value.start_with?('*') ? "`+#{value}+`" : "`#{value}`"
+      # Use `+` to prevent text like `**/*.gemspec`, `spec/**/*` from being bold.
+      value.include?('*') ? "`+#{value}+`" : "`#{value}`"
     else
       "`#{value}`"
     end

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -124,9 +124,9 @@ module RuboCop
         default_cfg = default_config(cop_name)
 
         if supports_safe_auto_correct?(cop_class, default_cfg)
-          output_buffer.puts '# Cop supports --auto-correct.'
+          output_buffer.puts '# This cop supports safe auto-correction (--auto-correct).'
         elsif supports_unsafe_autocorrect?(cop_class, default_cfg)
-          output_buffer.puts '# Cop supports --auto-correct-all.'
+          output_buffer.puts '# This cop supports unsafe auto-correction (--auto-correct-all).'
         end
 
         return unless default_cfg

data/lib/rubocop/formatter/offense_count_formatter.rb

@@ -17,6 +17,7 @@ module RuboCop
       def started(target_files)
         super
         @offense_counts = Hash.new(0)
+        @style_guide_links = {}
 
         return unless output.tty?
 
@@ -37,6 +38,9 @@ module RuboCop
 
       def file_finished(_file, offenses)
         offenses.each { |o| @offense_counts[o.cop_name] += 1 }
+        if options[:display_style_guide]
+          offenses.each { |o| @style_guide_links[o.cop_name] ||= o.message[/ \(http\S+\)\Z/] }
+        end
         @progressbar.increment if instance_variable_defined?(:@progressbar)
       end
 
@@ -52,8 +56,8 @@ module RuboCop
         output.puts
 
         per_cop_counts.each do |cop_name, count|
-          output.puts "#{count.to_s.ljust(total_count.to_s.length + 2)}" \
-                      "#{cop_name}\n"
+          output.puts "#{count.to_s.ljust(total_count.to_s.length + 2)}#{cop_name}" \
+                      "#{@style_guide_links[cop_name]}\n"
         end
         output.puts '--'
         output.puts "#{total_count}  Total"

data/lib/rubocop/formatter/worst_offenders_formatter.rb

@@ -40,8 +40,7 @@ module RuboCop
         output.puts
 
         per_file_counts.each do |file_name, count|
-          output.puts "#{count.to_s.ljust(total_count.to_s.length + 2)}" \
-                      "#{file_name}\n"
+          output.puts "#{count.to_s.ljust(total_count.to_s.length + 2)}#{file_name}\n"
         end
         output.puts '--'
         output.puts "#{total_count}  Total"

data/lib/rubocop/options.rb

@@ -467,8 +467,14 @@ module RuboCop
                                          'This option applies to the previously',
                                          'specified --format, or the default format',
                                          'if no format is specified.'],
-      fail_level:                       ['Minimum severity (A/I/R/C/W/E/F) for exit',
-                                         'with error code.'],
+      fail_level:                       ['Minimum severity for exit with error code.',
+                                         '  [A] autocorrect',
+                                         '  [I] info',
+                                         '  [R] refactor',
+                                         '  [C] convention',
+                                         '  [W] warning',
+                                         '  [E] error',
+                                         '  [F] fatal'],
       display_time:                     'Display elapsed time in seconds.',
       display_only_failed:              ['Only output offense messages. Omit passing',
                                          'cops. Only valid for --format junit.'],

data/lib/rubocop/result_cache.rb

@@ -73,7 +73,15 @@ module RuboCop
                  # access.
                  File.join(ENV['XDG_CACHE_HOME'], Process.uid.to_s)
                else
-                 File.join(ENV['HOME'], '.cache')
+                 # On FreeBSD, the /home path is a symbolic link to /usr/home
+                 # and the $HOME environment variable returns the /home path.
+                 #
+                 # As $HOME is a built-in environment variable, FreeBSD users
+                 # always get a warning message.
+                 #
+                 # To avoid raising warn log messages on FreeBSD, we retrieve
+                 # the real path of the home folder.
+                 File.join(File.realpath(ENV['HOME']), '.cache')
                end
       File.join(root, 'rubocop_cache')
     end

data/lib/rubocop/rspec/shared_contexts.rb

@@ -135,3 +135,7 @@ end
 RSpec.shared_context 'ruby 3.1', :ruby31 do
   let(:ruby_version) { 3.1 }
 end
+
+RSpec.shared_context 'ruby 3.2', :ruby32 do
+  let(:ruby_version) { 3.2 }
+end

data/lib/rubocop/runner.rb

@@ -8,7 +8,7 @@ module RuboCop
   class Runner # rubocop:disable Metrics/ClassLength
     # An exception indicating that the inspection loop got stuck correcting
     # offenses back and forth.
-    class InfiniteCorrectionLoop < RuntimeError
+    class InfiniteCorrectionLoop < StandardError
       attr_reader :offenses
 
       def initialize(path, offenses_by_iteration, loop_start: -1)

data/lib/rubocop/target_ruby.rb

@@ -4,7 +4,7 @@ module RuboCop
   # The kind of Ruby that code inspected by RuboCop is written in.
   # @api private
   class TargetRuby
-    KNOWN_RUBIES = [2.5, 2.6, 2.7, 3.0, 3.1].freeze
+    KNOWN_RUBIES = [2.5, 2.6, 2.7, 3.0, 3.1, 3.2].freeze
     DEFAULT_VERSION = KNOWN_RUBIES.first
 
     OBSOLETE_RUBIES = {

data/lib/rubocop/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '1.25.1'
+    STRING = '1.27.0'
 
     MSG = '%<version>s (using Parser %<parser_version>s, '\
           'rubocop-ast %<rubocop_ast_version>s, ' \

data/lib/rubocop.rb

@@ -348,6 +348,7 @@ require_relative 'rubocop/cop/lint/redundant_splat_expansion'
 require_relative 'rubocop/cop/lint/redundant_string_coercion'
 require_relative 'rubocop/cop/lint/redundant_with_index'
 require_relative 'rubocop/cop/lint/redundant_with_object'
+require_relative 'rubocop/cop/lint/refinement_import_methods'
 require_relative 'rubocop/cop/lint/regexp_as_condition'
 require_relative 'rubocop/cop/lint/require_parentheses'
 require_relative 'rubocop/cop/lint/require_relative_self_path'
@@ -527,6 +528,7 @@ require_relative 'rubocop/cop/style/open_struct_use'
 require_relative 'rubocop/cop/style/redundant_assignment'
 require_relative 'rubocop/cop/style/redundant_fetch_block'
 require_relative 'rubocop/cop/style/redundant_file_extension_in_require'
+require_relative 'rubocop/cop/style/redundant_initialize'
 require_relative 'rubocop/cop/style/redundant_self_assignment'
 require_relative 'rubocop/cop/style/redundant_self_assignment_branch'
 require_relative 'rubocop/cop/style/sole_nested_conditional'
@@ -552,6 +554,7 @@ require_relative 'rubocop/cop/style/negated_if'
 require_relative 'rubocop/cop/style/negated_if_else_condition'
 require_relative 'rubocop/cop/style/negated_unless'
 require_relative 'rubocop/cop/style/negated_while'
+require_relative 'rubocop/cop/style/nested_file_dirname'
 require_relative 'rubocop/cop/style/nested_modifier'
 require_relative 'rubocop/cop/style/nested_parenthesized_calls'
 require_relative 'rubocop/cop/style/nested_ternary_operator'