rubocop 1.39.0 → 1.44.1

data/lib/rubocop/cop/layout/first_method_parameter_line_break.rb

@@ -6,7 +6,7 @@ module RuboCop
       # Checks for a line break before the first parameter in a
       # multi-line method parameter definition.
       #
-      # @example
+      # @example AllowMultilineFinalElement: false (default)
       #
       #     # bad
       #     def method(foo, bar,
@@ -14,6 +14,13 @@ module RuboCop
       #       do_something
       #     end
       #
+      #     # bad
+      #     def method(foo, bar, baz = {
+      #       :a => "b",
+      #     })
+      #       do_something
+      #     end
+      #
       #     # good
       #     def method(
       #         foo, bar,
@@ -21,11 +28,48 @@ module RuboCop
       #       do_something
       #     end
       #
+      #     # good
+      #     def method(
+      #       foo, bar, baz = {
+      #       :a => "b",
+      #     })
+      #       do_something
+      #     end
+      #
       #     # ignored
       #     def method foo,
       #         bar
       #       do_something
       #     end
+      #
+      # @example AllowMultilineFinalElement: true
+      #
+      #     # bad
+      #     def method(foo, bar,
+      #         baz)
+      #       do_something
+      #     end
+      #
+      #     # good
+      #     def method(foo, bar, baz = {
+      #       :a => "b",
+      #     })
+      #       do_something
+      #     end
+      #
+      #     # good
+      #     def method(
+      #         foo, bar,
+      #         baz)
+      #       do_something
+      #     end
+      #
+      #     # ignored
+      #     def method foo,
+      #         bar
+      #       do_something
+      #     end
+      #
       class FirstMethodParameterLineBreak < Base
         include FirstElementLineBreak
         extend AutoCorrector
@@ -33,9 +77,15 @@ module RuboCop
         MSG = 'Add a line break before the first parameter of a multi-line method parameter list.'
 
         def on_def(node)
-          check_method_line_break(node, node.arguments)
+          check_method_line_break(node, node.arguments, ignore_last: ignore_last_element?)
         end
         alias on_defs on_def
+
+        private
+
+        def ignore_last_element?
+          !!cop_config['AllowMultilineFinalElement']
+        end
       end
     end
   end

data/lib/rubocop/cop/layout/heredoc_indentation.rb

@@ -22,6 +22,7 @@ module RuboCop
       #   RUBY
       #
       class HeredocIndentation < Base
+        include Alignment
         include Heredoc
         extend AutoCorrector
 
@@ -37,7 +38,7 @@ module RuboCop
           heredoc_indent_type = heredoc_indent_type(node)
 
           if heredoc_indent_type == '~'
-            expected_indent_level = base_indent_level(node) + indentation_width
+            expected_indent_level = base_indent_level(node) + configured_indentation_width
             return if expected_indent_level == body_indent_level
           else
             return unless body_indent_level.zero?
@@ -66,9 +67,9 @@ module RuboCop
           current_indent_type = "<<#{heredoc_indent_type}"
 
           if current_indent_type == '<<~'
-            width_message(indentation_width)
+            width_message(configured_indentation_width)
           else
-            type_message(indentation_width, current_indent_type)
+            type_message(configured_indentation_width, current_indent_type)
           end
         end
 
@@ -89,7 +90,7 @@ module RuboCop
 
           body = heredoc_body(node)
 
-          expected_indent = base_indent_level(node) + indentation_width
+          expected_indent = base_indent_level(node) + configured_indentation_width
           actual_indent = indent_level(body)
           increase_indent_level = expected_indent - actual_indent
 
@@ -122,7 +123,7 @@ module RuboCop
         def indented_body(node)
           body = heredoc_body(node)
           body_indent_level = indent_level(body)
-          correct_indent_level = base_indent_level(node) + indentation_width
+          correct_indent_level = base_indent_level(node) + configured_indentation_width
           body.gsub(/^[^\S\r\n]{#{body_indent_level}}/, ' ' * correct_indent_level)
         end
 
@@ -148,10 +149,6 @@ module RuboCop
           node.source[/^<<([~-])/, 1]
         end
 
-        def indentation_width
-          @config.for_cop('Layout/IndentationWidth')['Width'] || 2
-        end
-
         def heredoc_body(node)
           node.loc.heredoc_body.source
         end

data/lib/rubocop/cop/layout/indentation_style.rb

@@ -40,10 +40,13 @@ module RuboCop
         MSG = '%<type>s detected in indentation.'
 
         def on_new_investigation
-          str_ranges = string_literal_ranges(processed_source.ast)
+          str_ranges = nil
 
           processed_source.lines.each.with_index(1) do |line, lineno|
             next unless (range = find_offense(line, lineno))
+
+            # Perform costly calculation only when needed.
+            str_ranges ||= string_literal_ranges(processed_source.ast)
             next if in_string_literal?(str_ranges, range)
 
             add_offense(range) { |corrector| autocorrect(corrector, range) }
@@ -90,7 +93,8 @@ module RuboCop
           # which lines start inside a string literal?
           return [] if ast.nil?
 
-          ast.each_node(:str, :dstr).with_object(Set.new) do |str, ranges|
+          ranges = Set.new
+          ast.each_node(:str, :dstr) do |str|
             loc = str.location
 
             if str.heredoc?
@@ -99,6 +103,7 @@ module RuboCop
               ranges << loc.expression
             end
           end
+          ranges
         end
 
         def message(_node)

data/lib/rubocop/cop/layout/line_continuation_leading_space.rb

@@ -51,7 +51,11 @@ module RuboCop
         private_constant :LINE_1_ENDING, :LINE_2_BEGINNING,
                          :LEADING_STYLE_OFFENSE, :TRAILING_STYLE_OFFENSE
 
+        # rubocop:disable Metrics/AbcSize
         def on_dstr(node)
+          # Quick check if we possibly have line continuations.
+          return unless node.source.include?('\\')
+
           end_of_first_line = node.loc.expression.begin_pos - node.loc.expression.column
 
           raw_lines(node).each_cons(2) do |raw_line_one, raw_line_two|
@@ -66,6 +70,7 @@ module RuboCop
             end
           end
         end
+        # rubocop:enable Metrics/AbcSize
 
         private
 

data/lib/rubocop/cop/layout/line_continuation_spacing.rb

@@ -32,10 +32,9 @@ module RuboCop
         extend AutoCorrector
 
         def on_new_investigation
-          last_line = last_line(processed_source)
+          return unless processed_source.raw_source.include?('\\')
 
-          @ignored_ranges = string_literal_ranges(processed_source.ast) +
-                            comment_ranges(processed_source.comments)
+          last_line = last_line(processed_source)
 
           processed_source.raw_source.lines.each_with_index do |line, index|
             break if index >= last_line
@@ -92,7 +91,8 @@ module RuboCop
           # which lines start inside a string literal?
           return [] if ast.nil?
 
-          ast.each_node(:str, :dstr).with_object(Set.new) do |str, ranges|
+          ranges = Set.new
+          ast.each_node(:str, :dstr) do |str|
             loc = str.location
 
             if str.heredoc?
@@ -101,6 +101,7 @@ module RuboCop
               ranges << loc.expression
             end
           end
+          ranges
         end
 
         def comment_ranges(comments)
@@ -114,7 +115,12 @@ module RuboCop
         end
 
         def ignore_range?(backtick_range)
-          @ignored_ranges.any? { |range| range.contains?(backtick_range) }
+          ignored_ranges.any? { |range| range.contains?(backtick_range) }
+        end
+
+        def ignored_ranges
+          @ignored_ranges ||= string_literal_ranges(processed_source.ast) +
+                              comment_ranges(processed_source.comments)
         end
 
         def no_space_style?

data/lib/rubocop/cop/layout/line_length.rb

@@ -86,6 +86,8 @@ module RuboCop
         alias on_def on_potential_breakable_node
 
         def on_new_investigation
+          return unless processed_source.raw_source.include?(';')
+
           check_for_breakable_semicolons(processed_source)
         end
 

data/lib/rubocop/cop/layout/multiline_array_line_breaks.rb

@@ -6,7 +6,7 @@ module RuboCop
       # Ensures that each item in a multi-line array
       # starts on a separate line.
       #
-      # @example
+      # @example AllowMultilineFinalElement: false (default)
       #
       #   # bad
       #   [
@@ -14,12 +14,55 @@ module RuboCop
       #     c
       #   ]
       #
+      #   # bad
+      #   [ a, b, foo(
+      #     bar
+      #   )]
+      #
       #   # good
       #   [
       #     a,
       #     b,
       #     c
       #   ]
+      #
+      #   # good
+      #   [
+      #     a,
+      #     b,
+      #     foo(
+      #       bar
+      #     )
+      #   ]
+      #
+      # @example AllowMultilineFinalElement: true
+      #
+      #   # bad
+      #   [
+      #     a, b,
+      #     c
+      #   ]
+      #
+      #   # good
+      #   [ a, b, foo(
+      #     bar
+      #   )]
+      #
+      #   # good
+      #   [
+      #     a,
+      #     b,
+      #     c
+      #   ]
+      #
+      #   # good
+      #   [
+      #     a,
+      #     b,
+      #     foo(
+      #       bar
+      #     )
+      #   ]
       class MultilineArrayLineBreaks < Base
         include MultilineElementLineBreaks
         extend AutoCorrector
@@ -27,7 +70,13 @@ module RuboCop
         MSG = 'Each item in a multi-line array must start on a separate line.'
 
         def on_array(node)
-          check_line_breaks(node, node.children)
+          check_line_breaks(node, node.children, ignore_last: ignore_last_element?)
+        end
+
+        private
+
+        def ignore_last_element?
+          !!cop_config['AllowMultilineFinalElement']
         end
       end
     end

data/lib/rubocop/cop/layout/multiline_block_layout.rb

@@ -91,7 +91,7 @@ module RuboCop
           if node.source.lines.first.end_with?("|\n")
             PIPE_SIZE
           else
-            1 + (PIPE_SIZE * 2)
+            (PIPE_SIZE * 2) + 1
           end
         end
 

data/lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb

@@ -6,7 +6,7 @@ module RuboCop
       # Ensures that each key in a multi-line hash
       # starts on a separate line.
       #
-      # @example
+      # @example AllowMultilineFinalElement: false (default)
       #
       #   # bad
       #   {
@@ -14,12 +14,54 @@ module RuboCop
       #     c: 3
       #   }
       #
+      #   # bad
+      #   { a: 1, b: {
+      #     c: 3,
+      #   }}
+      #
       #   # good
       #   {
       #     a: 1,
       #     b: 2,
       #     c: 3
       #   }
+      #
+      #   # good
+      #   {
+      #     a: 1,
+      #     b: {
+      #       c: 3,
+      #     }
+      #   }
+      #
+      # @example AllowMultilineFinalElement: true
+      #
+      #   # bad
+      #   {
+      #     a: 1, b: 2,
+      #     c: 3
+      #   }
+      #
+      #   # good
+      #   { a: 1, b: {
+      #     c: 3,
+      #   }}
+      #
+      #   # good
+      #   {
+      #     a: 1,
+      #     b: 2,
+      #     c: 3
+      #   }
+      #
+      #
+      #   # good
+      #   {
+      #     a: 1,
+      #     b: {
+      #       c: 3,
+      #     }
+      #   }
       class MultilineHashKeyLineBreaks < Base
         include MultilineElementLineBreaks
         extend AutoCorrector
@@ -31,8 +73,9 @@ module RuboCop
           # braces like {foo: 1}. That is, not a kwargs hashes.
           # Style/MultilineMethodArgumentLineBreaks handles those.
           return unless starts_with_curly_brace?(node)
+          return unless node.loc.begin
 
-          check_line_breaks(node, node.children) if node.loc.begin
+          check_line_breaks(node, node.children, ignore_last: ignore_last_element?)
         end
 
         private
@@ -40,6 +83,10 @@ module RuboCop
         def starts_with_curly_brace?(node)
           node.loc.begin
         end
+
+        def ignore_last_element?
+          !!cop_config['AllowMultilineFinalElement']
+        end
       end
     end
   end

data/lib/rubocop/cop/layout/multiline_method_argument_line_breaks.rb

@@ -9,13 +9,18 @@ module RuboCop
       # NOTE: This cop does not move the first argument, if you want that to
       # be on a separate line, see `Layout/FirstMethodArgumentLineBreak`.
       #
-      # @example
+      # @example AllowMultilineFinalElement: false (default)
       #
       #   # bad
       #   foo(a, b,
       #     c
       #   )
       #
+      #   # bad
+      #   foo(a, b, {
+      #     foo: "bar",
+      #   })
+      #
       #   # good
       #   foo(
       #     a,
@@ -25,6 +30,46 @@ module RuboCop
       #
       #   # good
       #   foo(a, b, c)
+      #
+      #   # good
+      #   foo(
+      #     a,
+      #     b,
+      #     {
+      #       foo: "bar",
+      #     }
+      #   )
+      #
+      # @example AllowMultilineFinalElement: true
+      #
+      #   # bad
+      #   foo(a, b,
+      #     c
+      #   )
+      #
+      #   # good
+      #   foo(a, b, {
+      #     foo: "bar",
+      #   })
+      #
+      #   # good
+      #   foo(
+      #     a,
+      #     b,
+      #     c
+      #   )
+      #
+      #   # good
+      #   foo(a, b, c)
+      #
+      #   # good
+      #   foo(
+      #     a,
+      #     b,
+      #     {
+      #       foo: "bar",
+      #     }
+      #   )
       class MultilineMethodArgumentLineBreaks < Base
         include MultilineElementLineBreaks
         extend AutoCorrector
@@ -45,7 +90,13 @@ module RuboCop
           last_arg = args.last
           args = args[0...-1] + last_arg.children if last_arg&.hash_type? && !last_arg&.braces?
 
-          check_line_breaks(node, args)
+          check_line_breaks(node, args, ignore_last: ignore_last_element?)
+        end
+
+        private
+
+        def ignore_last_element?
+          !!cop_config['AllowMultilineFinalElement']
         end
       end
     end

data/lib/rubocop/cop/layout/multiline_method_parameter_line_breaks.rb

@@ -9,7 +9,7 @@ module RuboCop
       # NOTE: This cop does not move the first argument, if you want that to
       # be on a separate line, see `Layout/FirstMethodParameterLineBreak`.
       #
-      # @example
+      # @example AllowMultilineFinalElement: false (default)
       #
       #   # bad
       #   def foo(a, b,
@@ -17,6 +17,47 @@ module RuboCop
       #   )
       #   end
       #
+      #   # bad
+      #   def foo(a, b = {
+      #     foo: "bar",
+      #   })
+      #   end
+      #
+      #   # good
+      #   def foo(
+      #     a,
+      #     b,
+      #     c
+      #   )
+      #   end
+      #
+      #   # good
+      #   def foo(
+      #     a,
+      #     b = {
+      #       foo: "bar",
+      #     }
+      #   )
+      #   end
+      #
+      #   # good
+      #   def foo(a, b, c)
+      #   end
+      #
+      # @example AllowMultilineFinalElement: true
+      #
+      #   # bad
+      #   def foo(a, b,
+      #     c
+      #   )
+      #   end
+      #
+      #   # good
+      #   def foo(a, b = {
+      #     foo: "bar",
+      #   })
+      #   end
+      #
       #   # good
       #   def foo(
       #     a,
@@ -26,6 +67,15 @@ module RuboCop
       #   end
       #
       #   # good
+      #   def foo(
+      #     a,
+      #     b = {
+      #       foo: "bar",
+      #     }
+      #   )
+      #   end
+      #
+      #   # good
       #   def foo(a, b, c)
       #   end
       class MultilineMethodParameterLineBreaks < Base
@@ -37,7 +87,13 @@ module RuboCop
         def on_def(node)
           return if node.arguments.empty?
 
-          check_line_breaks(node, node.arguments)
+          check_line_breaks(node, node.arguments, ignore_last: ignore_last_element?)
+        end
+
+        private
+
+        def ignore_last_element?
+          !!cop_config['AllowMultilineFinalElement']
         end
       end
     end

data/lib/rubocop/cop/layout/redundant_line_break.rb

@@ -84,11 +84,11 @@ module RuboCop
           return true if other_cop_takes_precedence?(node)
 
           !cop_config['InspectBlocks'] && (node.block_type? ||
-                                           node.each_descendant(:block).any?(&:multiline?))
+                                           any_descendant?(node, :block, &:multiline?))
         end
 
         def other_cop_takes_precedence?(node)
-          single_line_block_chain_enabled? && node.each_descendant(:block).any? do |block_node|
+          single_line_block_chain_enabled? && any_descendant?(node, :block) do |block_node|
             block_node.parent.send_type? && block_node.parent.loc.dot && !block_node.multiline?
           end
         end

data/lib/rubocop/cop/layout/space_around_keyword.rb

@@ -256,7 +256,7 @@ module RuboCop
           # regular dotted method calls bind more tightly than operators
           # so we need to climb up the AST past them
           node.each_ancestor do |ancestor|
-            return true if ancestor.and_type? || ancestor.or_type?
+            return true if ancestor.and_type? || ancestor.or_type? || ancestor.range_type?
             return false unless ancestor.send_type?
             return true if ancestor.operator_method?
           end

data/lib/rubocop/cop/layout/space_inside_array_literal_brackets.rb

@@ -178,8 +178,6 @@ module RuboCop
         def multi_dimensional_array?(node, token, side: :right)
           offset = side == :right ? -1 : +1
           i = index_for(node, token) + offset
-          # TODO: change this type check once
-          # https://github.com/rubocop/rubocop-ast/pull/240 is merged
           i += offset while processed_source.tokens_within(node)[i].new_line?
           if side == :right
             processed_source.tokens_within(node)[i].right_bracket?

data/lib/rubocop/cop/layout/trailing_empty_lines.rb

@@ -79,7 +79,7 @@ module RuboCop
         def ends_in_end?(processed_source)
           buffer = processed_source.buffer
 
-          return true if buffer.source.strip.start_with?('__END__')
+          return true if buffer.source.match?(/\s*__END__/)
           return false if processed_source.tokens.empty?
 
           extra = buffer.source[processed_source.tokens.last.end_pos..]

data/lib/rubocop/cop/layout/trailing_whitespace.rb

@@ -47,7 +47,6 @@ module RuboCop
         MSG = 'Trailing whitespace detected.'
 
         def on_new_investigation
-          @heredocs = extract_heredocs(processed_source.ast)
           processed_source.lines.each_with_index do |line, index|
             next unless line.end_with?(' ', "\t")
 
@@ -102,17 +101,25 @@ module RuboCop
         end
 
         def find_heredoc(line_number)
-          @heredocs.each { |node, r| return node if r.include?(line_number) }
+          heredocs.each { |node, r| return node if r.include?(line_number) }
           nil
         end
 
+        def heredocs
+          @heredocs ||= extract_heredocs(processed_source.ast)
+        end
+
         def extract_heredocs(ast)
           return [] unless ast
 
-          ast.each_node(:str, :dstr, :xstr).select(&:heredoc?).map do |node|
+          heredocs = []
+          ast.each_node(:str, :dstr, :xstr) do |node|
+            next unless node.heredoc?
+
             body = node.location.heredoc_body
-            [node, body.first_line...body.last_line]
+            heredocs << [node, body.first_line...body.last_line]
           end
+          heredocs
         end
 
         def offense_range(lineno, line)

data/lib/rubocop/cop/lint/ambiguous_block_association.rb

@@ -63,7 +63,7 @@ module RuboCop
           return unless node.arguments?
 
           return unless ambiguous_block_association?(node)
-          return if node.parenthesized? || node.last_argument.lambda? || node.last_argument.proc? ||
+          return if node.parenthesized? || node.last_argument.lambda_or_proc? ||
                     allowed_method_pattern?(node)
 
           message = message(node)