rubocop 0.51.0 → 0.52.0

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

@@ -25,6 +25,7 @@ module RuboCop
       #     x,
       #     y
       #     )
+      #   end
       class ClosingParenthesisIndentation < Cop
         include AutocorrectAlignment
 

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

@@ -4,10 +4,39 @@ module RuboCop
   module Cop
     module Layout
       # This cops checks the indentation of comments.
+      #
+      # @example
+      #   # bad
+      #     # comment here
+      #   def method_name
+      #   end
+      #
+      #     # comment here
+      #   a = 'hello'
+      #
+      #   # yet another comment
+      #     if true
+      #       true
+      #     end
+      #
+      #   # good
+      #   # comment here
+      #   def method_name
+      #   end
+      #
+      #   # comment here
+      #   a = 'hello'
+      #
+      #   # yet another comment
+      #   if true
+      #     true
+      #   end
+      #
       class CommentIndentation < Cop
         include AutocorrectAlignment
 
-        MSG = 'Incorrect indentation detected (column %d instead of %d).'.freeze
+        MSG = 'Incorrect indentation detected (column %<column>d ' \
+          'instead of %<correct_comment_indentation>d).'.freeze
 
         def investigate(processed_source)
           processed_source.comments.each { |comment| check(comment) }
@@ -35,7 +64,15 @@ module RuboCop
 
           add_offense(
             comment,
-            message: format(MSG, column, correct_comment_indentation)
+            message: message(column, correct_comment_indentation)
+          )
+        end
+
+        def message(column, correct_comment_indentation)
+          format(
+            MSG,
+            column: column,
+            correct_comment_indentation: correct_comment_indentation
           )
         end
 

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

@@ -5,7 +5,7 @@ module RuboCop
     module Layout
       # This cop checks the . position in multi-line method calls.
       #
-      # @example
+      # @example EnforcedStyle: leading (default)
       #   # bad
       #   something.
       #     mehod
@@ -13,6 +13,15 @@ module RuboCop
       #   # good
       #   something
       #     .method
+      #
+      # @example EnforcedStyle: trailing
+      #   # bad
+      #   something
+      #     .method
+      #
+      #   # good
+      #   something.
+      #     mehod
       class DotPosition < Cop
         include ConfigurableEnforcedStyle
 
@@ -26,6 +35,18 @@ module RuboCop
           end
         end
 
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.remove(node.loc.dot)
+            case style
+            when :leading
+              corrector.insert_before(selector_range(node), '.')
+            when :trailing
+              corrector.insert_after(node.receiver.source_range, '.')
+            end
+          end
+        end
+
         private
 
         def message(_node)
@@ -67,18 +88,6 @@ module RuboCop
           end
         end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.remove(node.loc.dot)
-            case style
-            when :leading
-              corrector.insert_before(selector_range(node), '.')
-            when :trailing
-              corrector.insert_after(node.receiver.source_range, '.')
-            end
-          end
-        end
-
         def selector_range(node)
           if node.loc.selector
             node.loc.selector

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

@@ -34,7 +34,7 @@ module RuboCop
         include AutocorrectAlignment
         include CheckAssignment
 
-        MSG = 'Align `%s` with `%s`.'.freeze
+        MSG = 'Align `%<else_range>s` with `%<base_range>s`.'.freeze
 
         def on_if(node, base = nil)
           return if ignored_node?(node)
@@ -112,12 +112,12 @@ module RuboCop
 
           @column_delta = effective_column(base_range) - else_range.column
           return if @column_delta.zero?
-
-          add_offense(
-            else_range,
-            location: else_range,
-            message: format(MSG, else_range.source, base_range.source[/^\S*/])
+          message = format(
+            MSG,
+            else_range: else_range.source,
+            base_range: base_range.source[/^\S*/]
           )
+          add_offense(else_range, location: else_range, message: message)
         end
       end
     end

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

@@ -57,6 +57,23 @@ module RuboCop
           add_offense(nodes.last, location: :keyword)
         end
 
+        def autocorrect(node)
+          prev_def = prev_node(node)
+
+          # finds position of first newline
+          end_pos = prev_def.loc.end.end_pos
+          source_buffer = prev_def.loc.end.source_buffer
+          newline_pos = source_buffer.source.index("\n", end_pos)
+
+          count = blank_lines_count_between(prev_def, node)
+
+          if count > maximum_empty_lines
+            autocorrect_remove_lines(newline_pos, count)
+          else
+            autocorrect_insert_lines(newline_pos, count)
+          end
+        end
+
         private
 
         def def_node?(node)
@@ -109,23 +126,6 @@ module RuboCop
           node.loc.end.line
         end
 
-        def autocorrect(node)
-          prev_def = prev_node(node)
-
-          # finds position of first newline
-          end_pos = prev_def.loc.end.end_pos
-          source_buffer = prev_def.loc.end.source_buffer
-          newline_pos = source_buffer.source.index("\n", end_pos)
-
-          count = blank_lines_count_between(prev_def, node)
-
-          if count > maximum_empty_lines
-            autocorrect_remove_lines(newline_pos, count)
-          else
-            autocorrect_insert_lines(newline_pos, count)
-          end
-        end
-
         def autocorrect_remove_lines(newline_pos, count)
           difference = count - maximum_empty_lines
           range_to_remove = range_between(newline_pos, newline_pos + difference)

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

@@ -6,6 +6,20 @@ module RuboCop
   module Cop
     module Layout
       # This cops checks for two or more consecutive blank lines.
+      #
+      # @example
+      #
+      #   # bad - It has two empty lines.
+      #   some_method
+      #   # one empty line
+      #   # two empty lines
+      #   some_method
+      #
+      #   # good
+      #   some_method
+      #   # one empty line
+      #   some_method
+      #
       class EmptyLines < Cop
         MSG = 'Extra blank line detected.'.freeze
         LINE_OFFSET = 2
@@ -15,7 +29,7 @@ module RuboCop
 
           lines = Set.new
           processed_source.tokens.each do |token|
-            lines << token.pos.line
+            lines << token.line
           end
 
           each_extra_empty_line(lines.sort) do |range|

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

@@ -24,7 +24,8 @@ module RuboCop
       #   end
       class EmptyLinesAroundAccessModifier < Cop
         MSG_AFTER = 'Keep a blank line after `%s`.'.freeze
-        MSG_BEFORE_AND_AFTER = 'Keep a blank line before and after `%s`.'.freeze
+        MSG_BEFORE_AND_AFTER = 'Keep a blank line before and after `%<node>s`.'
+                               .freeze
 
         def on_send(node)
           return unless node.access_modifier?
@@ -97,7 +98,7 @@ module RuboCop
              class_def?(previous_line)
             format(MSG_AFTER, node.loc.selector.source)
           else
-            format(MSG_BEFORE_AND_AFTER, node.loc.selector.source)
+            format(MSG_BEFORE_AND_AFTER, node: node.loc.selector.source)
           end
         end
       end

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # This cops checks if empty lines exist around the arguments
+      # of a method invocation.
+      #
+      # @example
+      #   # bad
+      #   do_something(
+      #     foo
+      #
+      #   )
+      #
+      #   process(bar,
+      #
+      #           baz: qux,
+      #           thud: fred)
+      #
+      #   some_method(
+      #
+      #     [1,2,3],
+      #     x: y
+      #   )
+      #
+      #   # good
+      #   do_something(
+      #     foo
+      #   )
+      #
+      #   process(bar,
+      #           baz: qux,
+      #           thud: fred)
+      #
+      #   some_method(
+      #     [1,2,3],
+      #     x: y
+      #   )
+      #
+      class EmptyLinesAroundArguments < Cop
+        MSG = 'Empty line detected around arguments.'.freeze
+
+        def on_send(node)
+          return if node.single_line?
+          return if empty_lines(node).empty?
+          extra_lines(node) { |range| add_offense(node, location: range) }
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            extra_lines(node) { |range| corrector.remove(range) }
+          end
+        end
+
+        private
+
+        def empty_lines(node)
+          @empty_lines ||= begin
+            lines = source_lines(node).map.with_index(1).to_a
+            lines.select! { |code, _| code == '' }
+            lines.map { |_, line| line }
+          end
+        end
+
+        def source_lines(node)
+          source =
+            if node.arguments.last && node.arguments.last.block_type?
+              source_without_block(node, node.arguments.last)
+            else
+              node.source
+            end
+          source.lines.map { |line| line.delete("\n") }
+        end
+
+        def extra_lines(node)
+          empty_lines(node).each do |line|
+            range = source_range(processed_source.buffer, line, 0)
+            yield(range)
+          end
+        end
+
+        def source_without_block(node, block_node)
+          node.source.split(block_node.source).first
+        end
+      end
+    end
+  end
+end

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

@@ -12,14 +12,14 @@ module RuboCop
       #   # good
       #
       #   begin
-      #     ...
+      #     # ...
       #   end
       #
       #   # bad
       #
       #   begin
       #
-      #     ...
+      #     # ...
       #
       #   end
       class EmptyLinesAroundBeginBody < Cop

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

@@ -6,24 +6,20 @@ module RuboCop
       # This cops checks if empty lines around the bodies of blocks match
       # the configuration.
       #
-      # @example
-      #
-      #   # EnforcedStyle: empty_lines
-      #
+      # @example EnforcedStyle: empty_lines
       #   # good
       #
       #   foo do |bar|
       #
-      #     ...
+      #     # ...
       #
       #   end
       #
-      #   # EnforcedStyle: no_empty_lines
-      #
+      # @example EnforcedStyle: no_empty_lines (default)
       #   # good
       #
       #   foo do |bar|
-      #     ...
+      #     # ...
       #   end
       class EmptyLinesAroundBlockBody < Cop
         include EmptyLinesAroundBody

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

@@ -6,18 +6,43 @@ module RuboCop
       # This cops checks if empty lines around the bodies of classes match
       # the configuration.
       #
-      # @example
+      # @example EnforcedStyle: empty_lines
+      #   # good
+      #
+      #   class Foo
+      #
+      #     def bar
+      #       # ...
+      #     end
       #
-      #   EnforcedStyle: empty_lines
+      #   end
       #
+      # @example EnforcedStyle: empty_lines_except_namespace
       #   # good
       #
       #   class Foo
+      #     class Bar
+      #
+      #       # ...
+      #
+      #     end
+      #   end
+      #
+      # @example EnforcedStyle: empty_lines_special
+      #   # good
+      #   class Foo
+      #
+      #     def bar; end
       #
-      #      def bar
-      #        ...
-      #      end
+      #   end
+      #
+      # @example EnforcedStyle: no_empty_lines (default)
+      #   # good
       #
+      #   class Foo
+      #     def bar
+      #       # ...
+      #     end
       #   end
       class EmptyLinesAroundClassBody < Cop
         include EmptyLinesAroundBody

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

@@ -61,7 +61,7 @@ module RuboCop
       class EmptyLinesAroundExceptionHandlingKeywords < Cop
         include EmptyLinesAroundBody
 
-        MSG = 'Extra empty line detected %s the `%s`.'.freeze
+        MSG = 'Extra empty line detected %<location>s the `%<keyword>s`.'.freeze
 
         def on_def(node)
           check_body(node.body)
@@ -81,15 +81,19 @@ module RuboCop
             line = loc.line
             keyword = loc.source
             # below the keyword
-            check_line(style, line, format(MSG, 'after', keyword), &:empty?)
+            check_line(style, line, message('after', keyword), &:empty?)
             # above the keyword
             check_line(style,
                        line - 2,
-                       format(MSG, 'before', keyword),
+                       message('before', keyword),
                        &:empty?)
           end
         end
 
+        def message(location, keyword)
+          format(MSG, location: location, keyword: keyword)
+        end
+
         def style
           :no_empty_lines
         end