rubocop 0.51.0 → 0.52.0

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

@@ -6,34 +6,34 @@ module RuboCop
       # This cop checks the indentation of the method name part in method calls
       # that span more than one line.
       #
-      # @example
+      # @example EnforcedStyle: aligned
       #   # bad
       #   while myvariable
       #   .b
       #     # do something
       #   end
       #
-      #   # good, EnforcedStyle: aligned
+      #   # good
       #   while myvariable
       #         .b
       #     # do something
       #   end
       #
-      #   # good, EnforcedStyle: aligned
+      #   # good
       #   Thing.a
       #        .b
       #        .c
       #
-      #   # good, EnforcedStyle:    indented,
-      #           IndentationWidth: 2
+      # @example EnforcedStyle: indented
+      #   # good
       #   while myvariable
       #     .b
       #
       #     # do something
       #   end
       #
-      #   # good, EnforcedStyle:    indented_relative_to_receiver,
-      #           IndentationWidth: 2
+      # @example EnforcedStyle: indented_relative_to_receiver
+      #   # good
       #   while myvariable
       #           .a
       #           .b
@@ -41,8 +41,7 @@ module RuboCop
       #     # do something
       #   end
       #
-      #   # good, EnforcedStyle:    indented_relative_to_receiver,
-      #           IndentationWidth: 2
+      #   # good
       #   myvariable = Thing
       #                  .a
       #                  .b
@@ -167,7 +166,7 @@ module RuboCop
           return unless rhs.source.start_with?('.')
 
           node = semantic_alignment_node(node)
-          return unless node
+          return unless node && node.loc.selector
 
           node.loc.dot.join(node.loc.selector)
         end

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

@@ -34,6 +34,7 @@ module RuboCop
       #     def foo(a,
       #       b
       #     )
+      #     end
       #
       #     # symmetrical: bad
       #     # new_line: bad
@@ -41,12 +42,14 @@ module RuboCop
       #     def foo(
       #       a,
       #       b)
+      #     end
       #
       #     # symmetrical: good
       #     # new_line: bad
       #     # same_line: good
       #     def foo(a,
       #       b)
+      #     end
       #
       #     # symmetrical: good
       #     # new_line: good
@@ -55,6 +58,7 @@ module RuboCop
       #       a,
       #       b
       #     )
+      #     end
       class MultilineMethodDefinitionBraceLayout < Cop
         include MultilineLiteralBraceLayout
 

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

@@ -22,7 +22,9 @@ module RuboCop
       #     puts 'error'
       #   end
       class RescueEnsureAlignment < Cop
-        MSG = '`%s` at %d, %d is not aligned with `end` at %d, %d.'.freeze
+        MSG = '`%<kw_loc>s` at %<kw_loc_line>d, %<kw_loc_column>d is not ' \
+              'aligned with `end` at %<end_loc_line>d, %<end_loc_column>d.'
+              .freeze
 
         def on_resbody(node)
           check(node) unless modifier?(node)
@@ -63,8 +65,12 @@ module RuboCop
         end
 
         def format_message(kw_loc, end_loc)
-          format(MSG, kw_loc.source, kw_loc.line, kw_loc.column, end_loc.line,
-                 end_loc.column)
+          format(MSG,
+                 kw_loc: kw_loc.source,
+                 kw_loc_line: kw_loc.line,
+                 kw_loc_column: kw_loc.column,
+                 end_loc_line: end_loc.line,
+                 end_loc_column: end_loc.column)
         end
 
         def modifier?(node)

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

@@ -32,15 +32,15 @@ module RuboCop
           add_offense(colon, location: colon) unless followed_by_space?(colon)
         end
 
+        def autocorrect(range)
+          ->(corrector) { corrector.insert_after(range, ' ') }
+        end
+
         private
 
         def followed_by_space?(colon)
           colon.source_buffer.source[colon.end_pos] =~ /\s/
         end
-
-        def autocorrect(range)
-          ->(corrector) { corrector.insert_after(range, ' ') }
-        end
       end
     end
   end

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

@@ -8,11 +8,11 @@ module RuboCop
       # @example
       #
       #   # bad
-      #   1,2
+      #   [1,2]
       #   { foo:bar,}
       #
       #   # good
-      #   1, 2
+      #   [1, 2]
       #   { foo:bar, }
       class SpaceAfterComma < Cop
         include SpaceAfterPunctuation
@@ -23,7 +23,7 @@ module RuboCop
         end
 
         def kind(token)
-          'comma' if token.type == :tCOMMA
+          'comma' if token.comma?
         end
       end
     end

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

@@ -8,10 +8,12 @@ module RuboCop
       # @example
       #
       #   # bad
-      #   def func (x) ... end
+      #   def func (x) end
+      #   def method= (y) end
       #
       #   # good
-      #   def func(x) ... end
+      #   def func(x) end
+      #   def method=(y) end
       class SpaceAfterMethodName < Cop
         MSG = 'Do not put a space between a method name and the opening ' \
               'parenthesis.'.freeze
@@ -28,8 +30,6 @@ module RuboCop
         end
         alias on_defs on_def
 
-        private
-
         def autocorrect(pos_before_left_paren)
           ->(corrector) { corrector.remove(pos_before_left_paren) }
         end

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

@@ -4,6 +4,13 @@ module RuboCop
   module Cop
     module Layout
       # Checks for semicolon (;) not followed by some kind of space.
+      #
+      # @example
+      #   # bad
+      #   x = 1;y = 2
+      #
+      #   # good
+      #   x = 1; y = 2
       class SpaceAfterSemicolon < Cop
         include SpaceAfterPunctuation
 
@@ -13,7 +20,7 @@ module RuboCop
         end
 
         def kind(token)
-          'semicolon' if token.type == :tSEMI
+          'semicolon' if token.semicolon?
         end
       end
     end

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

@@ -5,10 +5,7 @@ module RuboCop
     module Layout
       # Checks the spacing inside and after block parameters pipes.
       #
-      # @example
-      #
-      #   # EnforcedStyleInsidePipes: no_space (default)
-      #
+      # @example EnforcedStyleInsidePipes: no_space (default)
       #   # bad
       #   {}.each { | x,  y |puts x }
       #   ->( x,  y ) { puts x }
@@ -17,10 +14,7 @@ module RuboCop
       #   {}.each { |x, y| puts x }
       #   ->(x, y) { puts x }
       #
-      # @example
-      #
-      #   # EnforcedStyleInsidePipes: space
-      #
+      # @example EnforcedStyleInsidePipes: space
       #   # bad
       #   {}.each { |x,  y| puts x }
       #   ->(x,  y) { puts x }
@@ -50,6 +44,15 @@ module RuboCop
           check_each_arg(args)
         end
 
+        def autocorrect(range)
+          lambda do |corrector|
+            case range.source
+            when /^\s+$/ then corrector.remove(range)
+            else              corrector.insert_after(range, ' ')
+            end
+          end
+        end
+
         private
 
         def style_parameter_name
@@ -105,8 +108,11 @@ module RuboCop
         def check_each_arg(args)
           args.children.butfirst.each do |arg|
             expr = arg.source_range
-            check_no_space(range_with_surrounding_space(expr, :left).begin_pos,
-                           expr.begin_pos - 1, 'Extra space before')
+            check_no_space(
+              range_with_surrounding_space(range: expr, side: :left).begin_pos,
+              expr.begin_pos - 1,
+              'Extra space before'
+            )
           end
         end
 
@@ -123,15 +129,6 @@ module RuboCop
           add_offense(range, location: range,
                              message: "#{msg} block parameter detected.")
         end
-
-        def autocorrect(range)
-          lambda do |corrector|
-            case range.source
-            when /^\s+$/ then corrector.remove(range)
-            else              corrector.insert_after(range, ' ')
-            end
-          end
-        end
       end
     end
   end

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

@@ -5,21 +5,40 @@ module RuboCop
     module Layout
       # Checks that the equals signs in parameter default assignments
       # have or don't have surrounding space depending on configuration.
+      # @example
+      #   # bad
+      #   def some_method(arg1=:default, arg2=nil, arg3=[])
+      #     # do something...
+      #   end
+      #
+      #   # good
+      #   def some_method(arg1 = :default, arg2 = nil, arg3 = [])
+      #     # do something...
+      #   end
       class SpaceAroundEqualsInParameterDefault < Cop
         include SurroundingSpace
         include ConfigurableEnforcedStyle
 
+        MSG = 'Surrounding space %<type>s in default value assignment.'.freeze
+
         def on_optarg(node)
           index = index_of_first_token(node)
           arg, equals, value = processed_source.tokens[index, 3]
           check_optarg(arg, equals, value)
         end
 
+        def autocorrect(range)
+          m = range.source.match(/=\s*(\S+)/)
+          rest = m ? m.captures[0] : ''
+          replacement = style == :space ? ' = ' : '='
+          ->(corrector) { corrector.replace(range, replacement + rest) }
+        end
+
         private
 
         def check_optarg(arg, equals, value)
-          space_on_both_sides = space_on_both_sides?(arg, equals, value)
-          no_surrounding_space = no_surrounding_space?(arg, equals, value)
+          space_on_both_sides = space_on_both_sides?(arg, equals)
+          no_surrounding_space = no_surrounding_space?(arg, equals)
 
           if style == :space && space_on_both_sides ||
              style == :no_space && no_surrounding_space
@@ -32,7 +51,7 @@ module RuboCop
 
         def incorrect_style_detected(arg, value, space_on_both_sides,
                                      no_surrounding_space)
-          range = range_between(arg.pos.end_pos, value.pos.begin_pos)
+          range = range_between(arg.end_pos, value.begin_pos)
           add_offense(range, location: range) do
             if style == :space && no_surrounding_space ||
                style == :no_space && space_on_both_sides
@@ -43,24 +62,16 @@ module RuboCop
           end
         end
 
-        def space_on_both_sides?(arg, equals, value)
-          space_between?(arg, equals) && space_between?(equals, value)
+        def space_on_both_sides?(arg, equals)
+          arg.space_after? && equals.space_after?
         end
 
-        def no_surrounding_space?(arg, equals, value)
-          !space_between?(arg, equals) && !space_between?(equals, value)
+        def no_surrounding_space?(arg, equals)
+          !arg.space_after? && !equals.space_after?
         end
 
         def message(_)
-          format('Surrounding space %s in default value assignment.',
-                 style == :space ? 'missing' : 'detected')
-        end
-
-        def autocorrect(range)
-          m = range.source.match(/=\s*(\S+)/)
-          rest = m ? m.captures[0] : ''
-          replacement = style == :space ? ' = ' : '='
-          ->(corrector) { corrector.replace(range, replacement + rest) }
+          format(MSG, type: style == :space ? 'missing' : 'detected')
         end
       end
     end

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

@@ -25,8 +25,8 @@ module RuboCop
       #
       #   something = 123 if test
       class SpaceAroundKeyword < Cop
-        MSG_BEFORE = 'Space before keyword `%s` is missing.'.freeze
-        MSG_AFTER = 'Space after keyword `%s` is missing.'.freeze
+        MSG_BEFORE = 'Space before keyword `%<range>s` is missing.'.freeze
+        MSG_AFTER = 'Space after keyword `%<range>s` is missing.'.freeze
 
         DO = 'do'.freeze
         SAFE_NAVIGATION = '&.'.freeze
@@ -127,6 +127,14 @@ module RuboCop
           check(node, [:keyword].freeze)
         end
 
+        def autocorrect(range)
+          if space_before_missing?(range)
+            ->(corrector) { corrector.insert_before(range, ' '.freeze) }
+          else
+            ->(corrector) { corrector.insert_after(range, ' '.freeze) }
+          end
+        end
+
         private
 
         def check(node, locations, begin_keyword = DO)
@@ -166,7 +174,9 @@ module RuboCop
         end
 
         def offense(range, msg)
-          add_offense(range, location: range, message: msg % range.source)
+          add_offense(range,
+                      location: range,
+                      message: format(msg, range: range.source))
         end
 
         def space_before_missing?(range)
@@ -214,14 +224,6 @@ module RuboCop
           end
           false
         end
-
-        def autocorrect(range)
-          if space_before_missing?(range)
-            ->(corrector) { corrector.insert_before(range, ' '.freeze) }
-          else
-            ->(corrector) { corrector.insert_after(range, ' '.freeze) }
-          end
-        end
       end
     end
   end

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

@@ -5,6 +5,19 @@ module RuboCop
     module Layout
       # Checks that operators have space around them, except for **
       # which should not have surrounding space.
+      #
+      # @example
+      #   # bad
+      #   total = 3*4
+      #   "apple"+"juice"
+      #   my_number = 38/4
+      #   a ** b
+      #
+      #   # good
+      #   total = 3 * 4
+      #   "apple" + "juice"
+      #   my_number = 38 / 4
+      #   a**b
       class SpaceAroundOperators < Cop
         include PrecedingFollowingAlignment
 
@@ -73,6 +86,18 @@ module RuboCop
         alias on_and_asgn on_binary
         alias on_op_asgn  on_special_asgn
 
+        def autocorrect(range)
+          lambda do |corrector|
+            if range.source =~ /\*\*/
+              corrector.replace(range, '**')
+            elsif range.source.end_with?("\n")
+              corrector.replace(range, " #{range.source.strip}\n")
+            else
+              corrector.replace(range, " #{range.source.strip} ")
+            end
+          end
+        end
+
         private
 
         def regular_operator?(send_node)
@@ -86,7 +111,7 @@ module RuboCop
         end
 
         def check_operator(op, right_operand)
-          with_space = range_with_surrounding_space(op)
+          with_space = range_with_surrounding_space(range: op)
           return if with_space.source.start_with?("\n")
 
           offense(op, with_space, right_operand) do |msg|
@@ -120,18 +145,6 @@ module RuboCop
             (!allow_for_alignment? || !aligned_with_something?(right_operand))
         end
 
-        def autocorrect(range)
-          lambda do |corrector|
-            if range.source =~ /\*\*/
-              corrector.replace(range, '**')
-            elsif range.source.end_with?("\n")
-              corrector.replace(range, " #{range.source.strip}\n")
-            else
-              corrector.replace(range, " #{range.source.strip} ")
-            end
-          end
-        end
-
         def align_hash_cop_config
           config.for_cop('Layout/AlignHash')
         end