rubocop 0.52.1 → 0.53.0

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

@@ -42,11 +42,12 @@ module RuboCop
       #     end
       #   end
       #   end
-      class IndentationWidth < Cop
+      class IndentationWidth < Cop # rubocop:disable Metrics/ClassLength
         include EndKeywordAlignment
         include Alignment
         include CheckAssignment
         include IgnoredPattern
+        include RangeHelp
 
         MSG = 'Use %<configured_indentation_width>d (not %<indentation>d) ' \
               'spaces for%<name>s indentation.'.freeze
@@ -100,7 +101,7 @@ module RuboCop
 
           *_, body = *node.first_argument
 
-          def_end_config = config.for_cop('Lint/DefEndAlignment')
+          def_end_config = config.for_cop('Layout/DefEndAlignment')
           style = def_end_config['EnforcedStyleAlignWith'] || 'start_of_line'
           base = style == 'def' ? node.first_argument : node
 
@@ -186,7 +187,7 @@ module RuboCop
           rhs = first_part_of_call_chain(rhs)
           return unless rhs
 
-          end_config = config.for_cop('Lint/EndAlignment')
+          end_config = config.for_cop('Layout/EndAlignment')
           style = end_config['EnforcedStyleAlignWith'] || 'keyword'
           base = variable_alignment?(node.loc, rhs, style.to_sym) ? node : rhs
 

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

@@ -5,7 +5,21 @@ module RuboCop
     module Layout
       # This cops checks for indentation of the first non-blank non-comment
       # line in a file.
+      #
+      # @example
+      #   # bad
+      #      class A
+      #        def foo; end
+      #      end
+      #
+      #   # good
+      #   class A
+      #     def foo; end
+      #   end
+      #
       class InitialIndentation < Cop
+        include RangeHelp
+
         MSG = 'Indentation of first line in file detected.'.freeze
 
         def investigate(_processed_source)
@@ -21,7 +35,7 @@ module RuboCop
         private
 
         def first_token
-          processed_source.tokens.find { |t| !t.text.start_with?('#') }
+          processed_source.find_token { |t| !t.text.start_with?('#') }
         end
 
         def space_before(token)

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

@@ -17,10 +17,12 @@ module RuboCop
       #   # good
       #   # Some comment
       class LeadingCommentSpace < Cop
+        include RangeHelp
+
         MSG = 'Missing space after `#`.'.freeze
 
         def investigate(processed_source)
-          processed_source.comments.each do |comment|
+          processed_source.each_comment do |comment|
             next unless comment.text =~ /\A#+[^#\s=:+-]/
             next if comment.loc.line == 1 && allowed_on_first_line?(comment)
 
@@ -50,7 +52,7 @@ module RuboCop
         end
 
         def rackup_config_file?
-          File.basename(processed_source.buffer.name).eql?('config.ru')
+          File.basename(processed_source.file_path).eql?('config.ru')
         end
       end
     end

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

@@ -34,6 +34,7 @@ module RuboCop
       class MultilineAssignmentLayout < Cop
         include CheckAssignment
         include ConfigurableEnforcedStyle
+        include RangeHelp
 
         NEW_LINE_OFFENSE = 'Right hand side of multi-line assignment is on ' \
           'the same line as the assignment operator `=`.'.freeze

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

@@ -36,6 +36,8 @@ module RuboCop
       #     bar(i)
       #   }
       class MultilineBlockLayout < Cop
+        include RangeHelp
+
         MSG = 'Block body expression is on the same line as ' \
               'the block start.'.freeze
         ARG_MSG = 'Block argument expression is not on the same line as the ' \

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

@@ -26,35 +26,68 @@ module RuboCop
       # The closing brace of a multi-line method call must be on the same
       # line as the last argument of the call.
       #
-      # @example
-      #
-      #     # symmetrical: bad
-      #     # new_line: good
-      #     # same_line: bad
-      #     foo(a,
-      #       b
-      #     )
-      #
-      #     # symmetrical: bad
-      #     # new_line: bad
-      #     # same_line: good
-      #     foo(
-      #       a,
-      #       b)
-      #
-      #     # symmetrical: good
-      #     # new_line: bad
-      #     # same_line: good
-      #     foo(a,
-      #       b)
-      #
-      #     # symmetrical: good
-      #     # new_line: good
-      #     # same_line: bad
-      #     foo(
-      #       a,
-      #       b
-      #     )
+      # @example EnforcedStyle: symmetrical (default)
+      #   # bad
+      #   foo(a,
+      #     b
+      #   )
+      #
+      #   # bad
+      #   foo(
+      #     a,
+      #     b)
+      #
+      #   # good
+      #   foo(a,
+      #     b)
+      #
+      #   # good
+      #   foo(
+      #     a,
+      #     b
+      #   )
+      #
+      # @example EnforcedStyle: new_line
+      #   # bad
+      #   foo(
+      #     a,
+      #     b)
+      #
+      #   # bad
+      #   foo(a,
+      #     b)
+      #
+      #   # good
+      #   foo(a,
+      #     b
+      #   )
+      #
+      #   # good
+      #   foo(
+      #     a,
+      #     b
+      #   )
+      #
+      # @example EnforcedStyle: same_line
+      #   # bad
+      #   foo(a,
+      #     b
+      #   )
+      #
+      #   # bad
+      #   foo(
+      #     a,
+      #     b
+      #   )
+      #
+      #   # good
+      #   foo(
+      #     a,
+      #     b)
+      #
+      #   # good
+      #   foo(a,
+      #     b)
       class MultilineMethodCallBraceLayout < Cop
         include MultilineLiteralBraceLayout
 

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

@@ -6,7 +6,7 @@ module RuboCop
       # This cop checks the indentation of the method name part in method calls
       # that span more than one line.
       #
-      # @example EnforcedStyle: aligned
+      # @example EnforcedStyle: aligned (default)
       #   # bad
       #   while myvariable
       #   .b

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

@@ -26,39 +26,80 @@ module RuboCop
       # The closing brace of a multi-line method definition must be on the same
       # line as the last parameter of the definition.
       #
-      # @example
-      #
-      #     # symmetrical: bad
-      #     # new_line: good
-      #     # same_line: bad
-      #     def foo(a,
-      #       b
-      #     )
-      #     end
-      #
-      #     # symmetrical: bad
-      #     # new_line: bad
-      #     # same_line: good
-      #     def foo(
-      #       a,
-      #       b)
-      #     end
-      #
-      #     # symmetrical: good
-      #     # new_line: bad
-      #     # same_line: good
-      #     def foo(a,
-      #       b)
-      #     end
-      #
-      #     # symmetrical: good
-      #     # new_line: good
-      #     # same_line: bad
-      #     def foo(
-      #       a,
-      #       b
-      #     )
-      #     end
+      # @example EnforcedStyle: symmetrical (default)
+      #   # bad
+      #   def foo(a,
+      #     b
+      #   )
+      #   end
+      #
+      #   # bad
+      #   def foo(
+      #     a,
+      #     b)
+      #   end
+      #
+      #   # good
+      #   def foo(a,
+      #     b)
+      #   end
+      #
+      #   # good
+      #   def foo(
+      #     a,
+      #     b
+      #   )
+      #   end
+      #
+      # @example EnforcedStyle: new_line
+      #   # bad
+      #   def foo(
+      #     a,
+      #     b)
+      #   end
+      #
+      #   # bad
+      #   def foo(a,
+      #     b)
+      #   end
+      #
+      #   # good
+      #   def foo(a,
+      #     b
+      #   )
+      #   end
+      #
+      #   # good
+      #   def foo(
+      #     a,
+      #     b
+      #   )
+      #   end
+      #
+      # @example EnforcedStyle: same_line
+      #   # bad
+      #   def foo(a,
+      #     b
+      #   )
+      #   end
+      #
+      #   # bad
+      #   def foo(
+      #     a,
+      #     b
+      #   )
+      #   end
+      #
+      #   # good
+      #   def foo(
+      #     a,
+      #     b)
+      #   end
+      #
+      #   # good
+      #   def foo(a,
+      #     b)
+      #   end
       class MultilineMethodDefinitionBraceLayout < Cop
         include MultilineLiteralBraceLayout
 

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

@@ -6,10 +6,10 @@ module RuboCop
       # This cop checks the indentation of the right hand side operand in
       # binary operations that span more than one line.
       #
-      # @example
+      # @example EnforcedStyle: aligned (default)
       #   # bad
       #   if a +
-      #   b
+      #       b
       #     something
       #   end
       #
@@ -18,6 +18,20 @@ module RuboCop
       #      b
       #     something
       #   end
+      #
+      # @example EnforcedStyle: indented
+      #   # bad
+      #   if a +
+      #      b
+      #     something
+      #   end
+      #
+      #   # good
+      #   if a +
+      #       b
+      #     something
+      #   end
+      #
       class MultilineOperationIndentation < Cop
         include ConfigurableEnforcedStyle
         include Alignment

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

@@ -22,6 +22,8 @@ module RuboCop
       #     puts 'error'
       #   end
       class RescueEnsureAlignment < Cop
+        include RangeHelp
+
         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
@@ -37,7 +39,7 @@ module RuboCop
         def investigate(processed_source)
           @modifier_locations =
             processed_source.tokens.each_with_object([]) do |token, locations|
-              next unless token.type == :kRESCUE_MOD
+              next unless token.rescue_modifier?
               locations << token.pos
             end
         end

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

@@ -15,6 +15,8 @@ module RuboCop
       #   def func(x) end
       #   def method=(y) end
       class SpaceAfterMethodName < Cop
+        include RangeHelp
+
         MSG = 'Do not put a space between a method name and the opening ' \
               'parenthesis.'.freeze
 

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

@@ -12,6 +12,8 @@ module RuboCop
       #   # good
       #   !something
       class SpaceAfterNot < Cop
+        include RangeHelp
+
         MSG = 'Do not leave space between `!` and its argument.'.freeze
 
         def on_send(node)

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

@@ -24,6 +24,7 @@ module RuboCop
       #   ->( x, y ) { puts x }
       class SpaceAroundBlockParameters < Cop
         include ConfigurableEnforcedStyle
+        include RangeHelp
 
         def on_block(node)
           return unless node.arguments?

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

@@ -5,7 +5,8 @@ module RuboCop
     module Layout
       # Checks that the equals signs in parameter default assignments
       # have or don't have surrounding space depending on configuration.
-      # @example
+      #
+      # @example EnforcedStyle: space (default)
       #   # bad
       #   def some_method(arg1=:default, arg2=nil, arg3=[])
       #     # do something...
@@ -15,9 +16,21 @@ module RuboCop
       #   def some_method(arg1 = :default, arg2 = nil, arg3 = [])
       #     # do something...
       #   end
+      #
+      # @example EnforcedStyle: no_space
+      #   # 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
+        include RangeHelp
 
         MSG = 'Surrounding space %<type>s in default value assignment.'.freeze
 
@@ -70,7 +83,7 @@ module RuboCop
           !arg.space_after? && !equals.space_after?
         end
 
-        def message(_)
+        def message(_node)
           format(MSG, type: style == :space ? 'missing' : 'detected')
         end
       end