rubocop 1.19.0 → 1.40.0

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks for conditions that are not on the same line as
+      # Checks for conditions that are not on the same line as
       # if/while/until.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks whether the end keywords of method definitions are
+      # Checks whether the end keywords of method definitions are
       # aligned properly.
       #
       # Two modes are supported through the EnforcedStyleAlignWith configuration

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks the . position in multi-line method calls.
+      # Checks the . position in multi-line method calls.
       #
       # @example EnforcedStyle: leading (default)
       #   # bad
@@ -27,6 +27,10 @@ module RuboCop
         include RangeHelp
         extend AutoCorrector
 
+        def self.autocorrect_incompatible_with
+          [Style::RedundantSelf]
+        end
+
         def on_send(node)
           return unless node.dot? || ampersand_dot?(node)
 
@@ -68,19 +72,22 @@ module RuboCop
         end
 
         def proper_dot_position?(node)
-          receiver_line = node.receiver.source_range.end.line
-          selector_line = selector_range(node).line
+          selector_range = selector_range(node)
 
-          # receiver and selector are on the same line
-          return true if selector_line == receiver_line
+          return true if same_line?(selector_range, end_range(node.receiver))
 
+          selector_line = selector_range.line
+          receiver_line = receiver_end_line(node.receiver)
           dot_line = node.loc.dot.line
 
           # don't register an offense if there is a line comment between the
           # dot and the selector otherwise, we might break the code while
           # "correcting" it (even if there is just an extra blank line, treat
           # it the same)
-          return true if line_between?(selector_line, dot_line)
+          # Also, in the case of a heredoc, the receiver will end after the dot,
+          # because the heredoc body is on subsequent lines, so use the highest
+          # line to compare to.
+          return true if line_between?(selector_line, [receiver_line, dot_line].max)
 
           correct_dot_position_style?(dot_line, selector_line)
         end
@@ -96,7 +103,33 @@ module RuboCop
           end
         end
 
+        def receiver_end_line(node)
+          if (line = last_heredoc_line(node))
+            line
+          else
+            node.source_range.end.line
+          end
+        end
+
+        def last_heredoc_line(node)
+          if node.send_type?
+            node.arguments.select { |arg| heredoc?(arg) }.map { |arg| arg.loc.heredoc_end.line }.max
+          elsif heredoc?(node)
+            node.loc.heredoc_end.line
+          end
+        end
+
+        def heredoc?(node)
+          (node.str_type? || node.dstr_type?) && node.heredoc?
+        end
+
+        def end_range(node)
+          node.source_range.end
+        end
+
         def selector_range(node)
+          return node unless node.call_type?
+
           # l.(1) has no selector, so we use the opening parenthesis instead
           node.loc.selector || node.loc.begin
         end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks the alignment of else keywords. Normally they should
+      # Checks the alignment of else keywords. Normally they should
       # be aligned with an if/unless/while/until/begin/def/rescue keyword, but there
       # are special cases when they should follow the same rules as the
       # alignment of end.

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks empty comment.
+      # Checks empty comment.
       #
       # @example
       #   # bad
@@ -96,8 +96,8 @@ module RuboCop
 
         def autocorrect(corrector, node)
           previous_token = previous_token(node)
-          range = if previous_token && node.loc.line == previous_token.line
-                    range_with_surrounding_space(range: node.loc.expression, newlines: false)
+          range = if previous_token && same_line?(node, previous_token)
+                    range_with_surrounding_space(node.loc.expression, newlines: false)
                   else
                     range_by_whole_lines(node.loc.expression, include_final_newline: true)
                   end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop enforces empty line after guard clause
+      # Enforces empty line after guard clause
       #
       # @example
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop enforces empty line after multiline condition.
+      # Enforces empty line after multiline condition.
       #
       # @example
       #   # bad

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks whether class/module/method definitions are
+      # Checks whether class/module/method definitions are
       # separated by one or more empty lines.
       #
       # `NumberOfEmptyLines` can be an integer (default is 1) or
@@ -77,13 +77,34 @@ module RuboCop
       #   def b
       #   end
       #
-      # @example AllowAdjacentOneLineDefs: true
+      # @example AllowAdjacentOneLineDefs: true (default)
       #
       #   # good
       #   class ErrorA < BaseError; end
       #   class ErrorB < BaseError; end
       #   class ErrorC < BaseError; end
       #
+      #   # good
+      #   class ErrorA < BaseError; end
+      #
+      #   class ErrorB < BaseError; end
+      #
+      #   class ErrorC < BaseError; end
+      #
+      # @example AllowAdjacentOneLineDefs: false
+      #
+      #   # bad
+      #   class ErrorA < BaseError; end
+      #   class ErrorB < BaseError; end
+      #   class ErrorC < BaseError; end
+      #
+      #   # good
+      #   class ErrorA < BaseError; end
+      #
+      #   class ErrorB < BaseError; end
+      #
+      #   class ErrorC < BaseError; end
+      #
       class EmptyLineBetweenDefs < Base
         include RangeHelp
         extend AutoCorrector

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks for two or more consecutive blank lines.
+      # Checks for two or more consecutive blank lines.
       #
       # @example
       #

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

@@ -80,8 +80,11 @@ module RuboCop
           @block_line = node.source_range.first_line
         end
 
-        def on_send(node)
-          return unless node.bare_access_modifier? && !node.parent&.block_type?
+        alias on_numblock on_block
+
+        def on_send(node) # rubocop:disable Metrics/CyclomaticComplexity
+          return unless node.bare_access_modifier? &&
+                        !(node.parent&.block_type? || node.parent&.numblock_type?)
           return if expected_empty_lines?(node)
 
           message = message(node)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks if empty lines exist around the arguments
+      # Checks if empty lines exist around the arguments
       # of a method invocation.
       #
       # @example

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

@@ -70,18 +70,39 @@ module RuboCop
         def on_send(node)
           return unless node.attribute_accessor?
           return if next_line_empty?(node.last_line)
+          return if next_line_empty_or_enable_directive_comment?(node.last_line)
 
           next_line_node = next_line_node(node)
           return unless require_empty_line?(next_line_node)
 
-          add_offense(node) do |corrector|
-            range = range_by_whole_lines(node.source_range)
+          add_offense(node) { |corrector| autocorrect(corrector, node) }
+        end
+
+        private
 
-            corrector.insert_after(range, "\n")
+        def autocorrect(corrector, node)
+          node_range = range_by_whole_lines(node.source_range)
+
+          next_line = node_range.last_line + 1
+          if next_line_enable_directive_comment?(next_line)
+            node_range = processed_source.comment_at_line(next_line)
           end
+
+          corrector.insert_after(node_range, "\n")
         end
 
-        private
+        def next_line_empty_or_enable_directive_comment?(line)
+          return true if next_line_empty?(line)
+
+          next_line = line + 1
+          next_line_enable_directive_comment?(next_line) && next_line_empty?(next_line)
+        end
+
+        def next_line_enable_directive_comment?(line)
+          return false unless (comment = processed_source.comment_at_line(line))
+
+          DirectiveComment.new(comment).enabled?
+        end
 
         def next_line_empty?(line)
           processed_source[line].nil? || processed_source[line].blank?

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks if empty lines exist around the bodies of begin-end
+      # Checks if empty lines exist around the bodies of begin-end
       # blocks.
       #
       # @example

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

@@ -3,23 +3,23 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks if empty lines around the bodies of blocks match
+      # Checks if empty lines around the bodies of blocks match
       # the configuration.
       #
-      # @example EnforcedStyle: empty_lines
+      # @example EnforcedStyle: no_empty_lines (default)
       #   # good
       #
       #   foo do |bar|
-      #
       #     # ...
-      #
       #   end
       #
-      # @example EnforcedStyle: no_empty_lines (default)
+      # @example EnforcedStyle: empty_lines
       #   # good
       #
       #   foo do |bar|
+      #
       #     # ...
+      #
       #   end
       class EmptyLinesAroundBlockBody < Base
         include EmptyLinesAroundBody
@@ -32,6 +32,8 @@ module RuboCop
 
           check(node, node.body, adjusted_first_line: first_line)
         end
+
+        alias on_numblock on_block
       end
     end
   end

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

@@ -3,9 +3,18 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks if empty lines around the bodies of classes match
+      # Checks if empty lines around the bodies of classes match
       # the configuration.
       #
+      # @example EnforcedStyle: no_empty_lines (default)
+      #   # good
+      #
+      #   class Foo
+      #     def bar
+      #       # ...
+      #     end
+      #   end
+      #
       # @example EnforcedStyle: empty_lines
       #   # good
       #
@@ -55,15 +64,6 @@ module RuboCop
       #     end
       #
       #   end
-      #
-      # @example EnforcedStyle: no_empty_lines (default)
-      #   # good
-      #
-      #   class Foo
-      #     def bar
-      #       # ...
-      #     end
-      #   end
       class EmptyLinesAroundClassBody < Base
         include EmptyLinesAroundBody
         extend AutoCorrector

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks if empty lines exist around the bodies of `begin`
+      # Checks if empty lines exist around the bodies of `begin`
       # sections. This cop doesn't check empty lines at `begin` body
       # beginning/end and around method definition body.
       # `Style/EmptyLinesAroundBeginBody` or `Style/EmptyLinesAroundMethodBody`
@@ -65,21 +65,24 @@ module RuboCop
         MSG = 'Extra empty line detected %<location>s the `%<keyword>s`.'
 
         def on_def(node)
-          check_body(node.body)
+          check_body(node.body, node.loc.line)
         end
         alias on_defs on_def
 
         def on_kwbegin(node)
           body, = *node
-          check_body(body)
+          check_body(body, node.loc.line)
         end
 
         private
 
-        def check_body(node)
-          locations = keyword_locations(node)
+        def check_body(body, line_of_def_or_kwbegin)
+          locations = keyword_locations(body)
+
           locations.each do |loc|
             line = loc.line
+            next if line == line_of_def_or_kwbegin || last_rescue_and_end_on_same_line(body)
+
             keyword = loc.source
             # below the keyword
             check_line(style, line, message('after', keyword), &:empty?)
@@ -88,6 +91,10 @@ module RuboCop
           end
         end
 
+        def last_rescue_and_end_on_same_line(body)
+          body.rescue_type? && body.resbody_branches.last.loc.line == body.parent.loc.end.line
+        end
+
         def message(location, keyword)
           format(MSG, location: location, keyword: keyword)
         end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks if empty lines exist around the bodies of methods.
+      # Checks if empty lines exist around the bodies of methods.
       #
       # @example
       #

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

@@ -3,9 +3,18 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks if empty lines around the bodies of modules match
+      # Checks if empty lines around the bodies of modules match
       # the configuration.
       #
+      # @example EnforcedStyle: no_empty_lines (default)
+      #   # good
+      #
+      #   module Foo
+      #     def bar
+      #       # ...
+      #     end
+      #   end
+      #
       # @example EnforcedStyle: empty_lines
       #   # good
       #
@@ -35,15 +44,6 @@ module RuboCop
       #     def bar; end
       #
       #   end
-      #
-      # @example EnforcedStyle: no_empty_lines (default)
-      #   # good
-      #
-      #   module Foo
-      #     def bar
-      #       # ...
-      #     end
-      #   end
       class EmptyLinesAroundModuleBody < Base
         include EmptyLinesAroundBody
         extend AutoCorrector

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks whether the end keywords are aligned properly.
+      # Checks whether the end keywords are aligned properly.
       #
       # Three modes are supported through the `EnforcedStyleAlignWith`
       # configuration parameter:
@@ -165,8 +165,7 @@ module RuboCop
         end
 
         def alignment_node_for_variable_style(node)
-          return node.parent if node.case_type? && node.argument? &&
-                                node.loc.line == node.parent.loc.line
+          return node.parent if node.case_type? && node.argument? && same_line?(node, node.parent)
 
           assignment = assignment_or_operator_method(node)
 
@@ -182,7 +181,7 @@ module RuboCop
 
         def assignment_or_operator_method(node)
           node.ancestors.find do |ancestor|
-            ancestor.assignment_or_similar? || ancestor.send_type? && ancestor.operator_method?
+            ancestor.assignment_or_similar? || (ancestor.send_type? && ancestor.operator_method?)
           end
         end
       end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks for Windows-style line endings in the source code.
+      # Checks for Windows-style line endings in the source code.
       #
       # @example EnforcedStyle: native (default)
       #   # The `native` style means that CR+LF (Carriage Return + Line Feed) is
@@ -22,20 +22,20 @@ module RuboCop
       #   # all platforms.
       #
       #   # bad
-      #   puts 'Hello' # Return character is CR+LF on all platfoms.
+      #   puts 'Hello' # Return character is CR+LF on all platforms.
       #
       #   # good
-      #   puts 'Hello' # Return character is LF on all platfoms.
+      #   puts 'Hello' # Return character is LF on all platforms.
       #
       # @example EnforcedStyle: crlf
       #   # The `crlf` style means that CR+LF (Carriage Return + Line Feed) is
       #   # enforced on all platforms.
       #
       #   # bad
-      #   puts 'Hello' # Return character is LF on all platfoms.
+      #   puts 'Hello' # Return character is LF on all platforms.
       #
       #   # good
-      #   puts 'Hello' # Return character is CR+LF on all platfoms.
+      #   puts 'Hello' # Return character is CR+LF on all platforms.
       #
       class EndOfLine < Base
         include ConfigurableEnforcedStyle

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks for extra/unnecessary whitespace.
+      # Checks for extra/unnecessary whitespace.
       #
       # @example
       #