rubocop 1.12.1 → 1.16.1

data/lib/rubocop/cop/mixin/alignment.rb

@@ -12,8 +12,7 @@ module RuboCop
       attr_reader :column_delta
 
       def configured_indentation_width
-        cop_config['IndentationWidth'] ||
-          config.for_cop('Layout/IndentationWidth')['Width']
+        cop_config['IndentationWidth'] || config.for_cop('Layout/IndentationWidth')['Width']
       end
 
       def indentation(node)
@@ -46,8 +45,7 @@ module RuboCop
       def each_bad_alignment(items, base_column)
         prev_line = -1
         items.each do |current|
-          if current.loc.line > prev_line &&
-             begins_its_line?(current.source_range)
+          if current.loc.line > prev_line && begins_its_line?(current.source_range)
             @column_delta = base_column - display_column(current.source_range)
 
             yield current if @column_delta.nonzero?

data/lib/rubocop/cop/mixin/check_line_breakable.rb

@@ -70,17 +70,33 @@ module RuboCop
       def extract_first_element_over_column_limit(node, elements, max)
         line = node.first_line
 
-        # If the first argument is a hash pair but the method is not parenthesized,
-        # the argument cannot be moved to another line because it cause a syntax error.
-        elements.shift if node.send_type? && !node.parenthesized? && elements.first.pair_type?
+        # If a `send` node is not parenthesized, don't move the first element, because it
+        # can result in changed behavior or a syntax error.
+        elements = elements.drop(1) if node.send_type? && !node.parenthesized?
 
         i = 0
         i += 1 while within_column_limit?(elements[i], max, line)
+        i = shift_elements_for_heredoc_arg(node, elements, i)
+
+        return if i.nil?
         return elements.first if i.zero?
 
         elements[i - 1]
       end
 
+      # @api private
+      # If a send node contains a heredoc argument, splitting cannot happen
+      # after the heredoc or else it will cause a syntax error.
+      def shift_elements_for_heredoc_arg(node, elements, index)
+        return index unless node.send_type?
+
+        heredoc_index = elements.index { |arg| (arg.str_type? || arg.dstr_type?) && arg.heredoc? }
+        return index unless heredoc_index
+        return nil if heredoc_index.zero?
+
+        heredoc_index >= index ? index : heredoc_index + 1
+      end
+
       # @api private
       def within_column_limit?(element, max, line)
         element && element.loc.column <= max && element.loc.line == line

data/lib/rubocop/cop/mixin/code_length.rb

@@ -38,9 +38,7 @@ module RuboCop
 
         location = node.casgn_type? ? node.loc.name : node.loc.expression
 
-        add_offense(location, message: message(length, max_length)) do
-          self.max = length
-        end
+        add_offense(location, message: message(length, max_length)) { self.max = length }
       end
 
       # Returns true for lines that shall not be included in the count.

data/lib/rubocop/cop/mixin/configurable_enforced_style.rb

@@ -75,9 +75,9 @@ module RuboCop
 
       def alternative_style
         if supported_styles.size != 2
-          raise 'alternative_style can only be used when there are exactly ' \
-               '2 SupportedStyles'
+          raise 'alternative_style can only be used when there are exactly 2 SupportedStyles'
         end
+
         alternative_styles.first
       end
 

data/lib/rubocop/cop/mixin/configurable_formatting.rb

@@ -10,9 +10,7 @@ module RuboCop
         if valid_name?(node, name)
           correct_style_detected
         else
-          add_offense(name_range, message: message(style)) do
-            report_opposing_styles(node, name)
-          end
+          add_offense(name_range, message: message(style)) { report_opposing_styles(node, name) }
         end
       end
 
@@ -23,8 +21,7 @@ module RuboCop
       end
 
       def valid_name?(node, name, given_style = style)
-        name.match?(self.class::FORMATS.fetch(given_style)) ||
-          class_emitter_method?(node, name)
+        name.match?(self.class::FORMATS.fetch(given_style)) || class_emitter_method?(node, name)
       end
 
       # A class emitter method is a singleton method in a class/module, where
@@ -36,9 +33,7 @@ module RuboCop
         # `def self.extended`, etc.
         node = node.parent while node.parent.defs_type?
 
-        node.parent.each_child_node(:class).any? do |c|
-          c.loc.name.is?(name.to_s)
-        end
+        node.parent.each_child_node(:class).any? { |c| c.loc.name.is?(name.to_s) }
       end
     end
   end

data/lib/rubocop/cop/mixin/def_node.rb

@@ -11,14 +11,11 @@ module RuboCop
       private
 
       def non_public?(node)
-        non_public_modifier?(node.parent) ||
-          preceding_non_public_modifier?(node)
+        non_public_modifier?(node.parent) || preceding_non_public_modifier?(node)
       end
 
       def preceding_non_public_modifier?(node)
-        stripped_source_upto(node.first_line).any? do |line|
-          NON_PUBLIC_MODIFIERS.include?(line)
-        end
+        stripped_source_upto(node.first_line).any? { |line| NON_PUBLIC_MODIFIERS.include?(line) }
       end
 
       def stripped_source_upto(index)

data/lib/rubocop/cop/mixin/documentation_comment.rb

@@ -24,8 +24,7 @@ module RuboCop
       # The args node1 & node2 may represent a RuboCop::AST::Node
       # or a Parser::Source::Comment. Both respond to #loc.
       def preceding_comment?(node1, node2)
-        node1 && node2 && precede?(node2, node1) &&
-          comment_line?(node2.loc.expression.source)
+        node1 && node2 && precede?(node2, node1) && comment_line?(node2.loc.expression.source)
       end
 
       # The args node1 & node2 may represent a RuboCop::AST::Node
@@ -35,9 +34,7 @@ module RuboCop
       end
 
       def preceding_lines(node)
-        processed_source.ast_with_comments[node].select do |line|
-          line.loc.line < node.loc.line
-        end
+        processed_source.ast_with_comments[node].select { |line| line.loc.line < node.loc.line }
       end
 
       def interpreter_directive_comment?(comment)

data/lib/rubocop/cop/mixin/empty_lines_around_body.rb

@@ -10,11 +10,9 @@ module RuboCop
         include ConfigurableEnforcedStyle
         include RangeHelp
 
-        MSG_EXTRA = 'Extra empty line detected at %<kind>s body ' \
-                    '%<location>s.'
+        MSG_EXTRA = 'Extra empty line detected at %<kind>s body %<location>s.'
         MSG_MISSING = 'Empty line missing at %<kind>s body %<location>s.'
-        MSG_DEFERRED = 'Empty line missing before first %<type>s ' \
-                       'definition'
+        MSG_DEFERRED = 'Empty line missing before first %<type>s definition'
 
         private
 
@@ -93,9 +91,7 @@ module RuboCop
           when :no_empty_lines
             check_line(style, line_no, message(MSG_EXTRA, desc), &:empty?)
           when :empty_lines
-            check_line(style, line_no, message(MSG_MISSING, desc)) do |line|
-              !line.empty?
-            end
+            check_line(style, line_no, message(MSG_MISSING, desc)) { |line| !line.empty? }
           end
         end
 

data/lib/rubocop/cop/mixin/empty_parameter.rb

@@ -17,9 +17,7 @@ module RuboCop
         empty_arguments?(node) do |args|
           return if args.empty_and_without_delimiters?
 
-          add_offense(args) do |corrector|
-            autocorrect(corrector, args)
-          end
+          add_offense(args) { |corrector| autocorrect(corrector, args) }
         end
       end
     end

data/lib/rubocop/cop/mixin/end_keyword_alignment.rb

@@ -55,9 +55,7 @@ module RuboCop
                           source: align_with.source,
                           align_line: align_with.line,
                           align_col: align_with.column)
-        add_offense(end_loc, message: msg) do |corrector|
-          autocorrect(corrector, node)
-        end
+        add_offense(end_loc, message: msg) { |corrector| autocorrect(corrector, node) }
       end
 
       def accept_end_kw_alignment?(end_loc)

data/lib/rubocop/cop/mixin/enforce_superclass.rb

@@ -27,15 +27,11 @@ module RuboCop
       end
 
       def on_class(node)
-        class_definition(node) do
-          add_offense(node.children[1])
-        end
+        class_definition(node) { add_offense(node.children[1]) }
       end
 
       def on_send(node)
-        class_new_definition(node) do
-          add_offense(node.children.last)
-        end
+        class_new_definition(node) { add_offense(node.children.last) }
       end
     end
   end

data/lib/rubocop/cop/mixin/first_element_line_break.rb

@@ -31,9 +31,7 @@ module RuboCop
         max = last_by_line(children)
         return if line == max.last_line
 
-        add_offense(min) do |corrector|
-          EmptyLineCorrector.insert_before(corrector, min)
-        end
+        add_offense(min) { |corrector| EmptyLineCorrector.insert_before(corrector, min) }
       end
 
       def first_by_line(nodes)

data/lib/rubocop/cop/mixin/frozen_string_literal.rb

@@ -11,9 +11,7 @@ module RuboCop
       FROZEN_STRING_LITERAL_TYPES = %i[str dstr].freeze
 
       def frozen_string_literal_comment_exists?
-        leading_comment_lines.any? do |line|
-          MagicComment.parse(line).valid_literal_value?
-        end
+        leading_comment_lines.any? { |line| MagicComment.parse(line).valid_literal_value? }
       end
 
       private
@@ -34,8 +32,12 @@ module RuboCop
         # And the above `ruby_version >= 3.1` is undecided whether it will be
         # Ruby 3.1, 3.2, 4.0 or others.
         # See https://bugs.ruby-lang.org/issues/8976#note-41 for details.
+        leading_comment_lines.any? { |line| MagicComment.parse(line).frozen_string_literal? }
+      end
+
+      def frozen_string_literals_disabled?
         leading_comment_lines.any? do |line|
-          MagicComment.parse(line).frozen_string_literal?
+          MagicComment.parse(line).frozen_string_literal == false
         end
       end
 
@@ -46,9 +48,7 @@ module RuboCop
       end
 
       def leading_comment_lines
-        first_non_comment_token = processed_source.tokens.find do |token|
-          !token.comment?
-        end
+        first_non_comment_token = processed_source.tokens.find { |token| !token.comment? }
 
         if first_non_comment_token
           # `line` is 1-indexed so we need to subtract 1 to get the array index

data/lib/rubocop/cop/mixin/gem_declaration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # Common functionality for checking gem declarations.
+    module GemDeclaration
+      extend NodePattern::Macros
+
+      # @!method gem_declaration?(node)
+      def_node_matcher :gem_declaration?, '(send nil? :gem str ...)'
+    end
+  end
+end

data/lib/rubocop/cop/mixin/hash_alignment_styles.rb

@@ -43,7 +43,7 @@ module RuboCop
         end
 
         def value_delta(pair)
-          return 0 if pair.kwsplat_type? || pair.value_on_new_line?
+          return 0 if pair.value_on_new_line?
 
           correct_value_column = pair.loc.operator.end.column + 1
           actual_value_column = pair.value.loc.column
@@ -60,10 +60,8 @@ module RuboCop
 
         def deltas(first_pair, current_pair)
           key_delta = key_delta(first_pair, current_pair)
-          separator_delta = separator_delta(first_pair, current_pair,
-                                            key_delta)
-          value_delta = value_delta(first_pair, current_pair) -
-                        key_delta - separator_delta
+          separator_delta = separator_delta(first_pair, current_pair, key_delta)
+          value_delta = value_delta(first_pair, current_pair) - key_delta - separator_delta
 
           { key: key_delta, separator: separator_delta, value: value_delta }
         end
@@ -106,13 +104,10 @@ module RuboCop
         end
 
         def hash_rocket_delta(first_pair, current_pair)
-          first_pair.loc.column + max_key_width + 1 -
-            current_pair.loc.operator.column
+          first_pair.loc.column + max_key_width + 1 - current_pair.loc.operator.column
         end
 
         def value_delta(first_pair, current_pair)
-          return 0 if current_pair.kwsplat_type?
-
           correct_value_column = first_pair.key.loc.column +
                                  current_pair.delimiter(true).length +
                                  max_key_width
@@ -142,6 +137,19 @@ module RuboCop
           first_pair.value_delta(current_pair)
         end
       end
+
+      # Handles calculation of deltas for `kwsplat` nodes.
+      # This is a special case that just ensures the kwsplat is aligned with the rest of the hash
+      # since a `kwsplat` does not have a key, separator or value.
+      class KeywordSplatAlignment
+        def deltas(first_pair, current_pair)
+          if Util.begins_its_line?(current_pair.source_range)
+            { key: first_pair.key_delta(current_pair) }
+          else
+            {}
+          end
+        end
+      end
     end
   end
 end

data/lib/rubocop/cop/mixin/hash_transform_method.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     # Common functionality for Style/HashTransformKeys and
     # Style/HashTransformValues
-    module HashTransformMethod # rubocop:disable Metrics/ModuleLength
+    module HashTransformMethod
       extend NodePattern::Macros
 
       RESTRICT_ON_SEND = %i[[] to_h].freeze
@@ -21,24 +21,18 @@ module RuboCop
 
         return if target_ruby_version < 2.6
 
-        on_bad_to_h(node) do |*match|
-          handle_possible_offense(node, match, 'to_h {...}')
-        end
+        on_bad_to_h(node) { |*match| handle_possible_offense(node, match, 'to_h {...}') }
       end
 
       def on_send(node)
         on_bad_hash_brackets_map(node) do |*match|
           handle_possible_offense(node, match, 'Hash[_.map {...}]')
         end
-        on_bad_map_to_h(node) do |*match|
-          handle_possible_offense(node, match, 'map {...}.to_h')
-        end
+        on_bad_map_to_h(node) { |*match| handle_possible_offense(node, match, 'map {...}.to_h') }
       end
 
       def on_csend(node)
-        on_bad_map_to_h(node) do |*match|
-          handle_possible_offense(node, match, 'map {...}.to_h')
-        end
+        on_bad_map_to_h(node) { |*match| handle_possible_offense(node, match, 'map {...}.to_h') }
       end
 
       private
@@ -115,10 +109,7 @@ module RuboCop
 
         captures = extract_captures(correction.match)
         correction.set_new_arg_name(captures.transformed_argname, corrector)
-        correction.set_new_body_expression(
-          captures.transforming_body_expr,
-          corrector
-        )
+        correction.set_new_body_expression(captures.transforming_body_expr, corrector)
       end
 
       # Internal helper class to hold match data
@@ -180,17 +171,11 @@ module RuboCop
         end
 
         def set_new_arg_name(transformed_argname, corrector)
-          corrector.replace(
-            block_node.arguments.loc.expression,
-            "|#{transformed_argname}|"
-          )
+          corrector.replace(block_node.arguments.loc.expression, "|#{transformed_argname}|")
         end
 
         def set_new_body_expression(transforming_body_expr, corrector)
-          corrector.replace(
-            block_node.body,
-            transforming_body_expr.loc.expression.source
-          )
+          corrector.replace(block_node.body, transforming_body_expr.loc.expression.source)
         end
       end
     end

data/lib/rubocop/cop/mixin/interpolation.rb

@@ -15,9 +15,7 @@ module RuboCop
       alias on_regexp on_dstr
 
       def on_node_with_interpolations(node)
-        node.each_child_node(:begin) do |begin_node|
-          on_interpolation(begin_node)
-        end
+        node.each_child_node(:begin) { |begin_node| on_interpolation(begin_node) }
       end
 
       # @!method on_interpolation(begin_node)

data/lib/rubocop/cop/mixin/line_length_help.rb

@@ -46,8 +46,7 @@ module RuboCop
           end_position += match.offset(0).last
         end
 
-        return nil if begin_position < max_line_length &&
-                      end_position < max_line_length
+        return nil if begin_position < max_line_length && end_position < max_line_length
 
         begin_position...end_position
       end
@@ -73,8 +72,7 @@ module RuboCop
 
       def uri_regexp
         @uri_regexp ||=
-          URI::DEFAULT_PARSER
-          .make_regexp(config.for_cop('Layout/LineLength')['URISchemes'])
+          URI::DEFAULT_PARSER.make_regexp(config.for_cop('Layout/LineLength')['URISchemes'])
       end
 
       def valid_uri?(uri_ish_string)

data/lib/rubocop/cop/mixin/match_range.rb

@@ -11,15 +11,12 @@ module RuboCop
       # Return a new `Range` covering the first matching group number for each
       # match of `regex` inside `range`
       def each_match_range(range, regex)
-        range.source.scan(regex) do
-          yield match_range(range, Regexp.last_match)
-        end
+        range.source.scan(regex) { yield match_range(range, Regexp.last_match) }
       end
 
       # For a `match` inside `range`, return a new `Range` covering the match
       def match_range(range, match)
-        range_between(range.begin_pos + match.begin(1),
-                      range.begin_pos + match.end(1))
+        range_between(range.begin_pos + match.begin(1), range.begin_pos + match.end(1))
       end
     end
   end