rubocop 0.48.1 → 0.49.0

data/lib/rubocop/cop/badge.rb

@@ -5,7 +5,7 @@ module RuboCop
     # Identifier of all cops containing a department and cop name.
     #
     # All cops are identified by their badge. For example, the badge
-    # for `RuboCop::Cop::Style::Tab` is `Style/Tab`. Badges can be
+    # for `RuboCop::Cop::Layout::Tab` is `Layout/Tab`. Badges can be
     # parsed as either `Department/CopName` or just `CopName` to allow
     # for badge references in source files that omit the department
     # for RuboCop to infer.

data/lib/rubocop/cop/bundler/duplicated_gem.rb

@@ -54,13 +54,13 @@ module RuboCop
             .values
         end
 
-        def register_offense(node, gem_name, line_of_first_occurence)
+        def register_offense(node, gem_name, line_of_first_occurrence)
           line_range = node.loc.column...node.loc.last_column
 
           add_offense(
             node,
             source_range(processed_source.buffer, node.loc.line, line_range),
-            format(MSG, gem_name, line_of_first_occurence)
+            format(MSG, gem_name, line_of_first_occurrence)
           )
         end
       end

data/lib/rubocop/cop/commissioner.rb

@@ -34,7 +34,7 @@ module RuboCop
 
       callback_methods.each do |callback|
         next unless method_defined?(callback)
-        class_eval <<-EOS, __FILE__, __LINE__
+        class_eval <<-EOS, __FILE__, __LINE__ + 1
           def #{callback}(node)
             @callbacks[:"#{callback}"] ||= @cops.select do |cop|
               cop.respond_to?(:"#{callback}")

data/lib/rubocop/cop/cop.rb

@@ -81,6 +81,16 @@ module RuboCop
           given_names.include?(department.to_s)
       end
 
+      # List of cops that should not try to autocorrect at the same
+      # time as this cop
+      #
+      # @return [Array<RuboCop::Cop::Cop>]
+      #
+      # @api public
+      def self.autocorrect_incompatible_with
+        []
+      end
+
       def initialize(config = nil, options = nil)
         @config = config || Config.new
         @options = options || { debug: false }

data/lib/rubocop/cop/{style → layout}/access_modifier_indentation.rb

@@ -2,9 +2,38 @@
 
 module RuboCop
   module Cop
-    module Style
+    module Layout
       # Modifiers should be indented as deep as method definitions, or as deep
       # as the class/module keyword, depending on configuration.
+      #
+      # @example
+      #   # EnforcedStyle: indent (default)
+      #
+      #   # bad
+      #   class Plumbus
+      #   private
+      #     def smooth; end
+      #   end
+      #
+      #   # good
+      #   class Plumbus
+      #     private
+      #     def smooth; end
+      #   end
+      #
+      #   # EnforcedStyle: outdent
+      #
+      #   # bad
+      #   class Plumbus
+      #     private
+      #     def smooth; end
+      #   end
+      #
+      #   # good
+      #   class Plumbus
+      #   private
+      #     def smooth; end
+      #   end
       class AccessModifierIndentation < Cop
         include AutocorrectAlignment
         include ConfigurableEnforcedStyle
@@ -28,8 +57,9 @@ module RuboCop
         end
 
         def on_block(node)
-          _method, _args, body = *node
-          check_body(body, node) if node.class_constructor?
+          return unless node.class_constructor?
+
+          check_body(node.body, node)
         end
 
         private

data/lib/rubocop/cop/{style → layout}/align_array.rb

@@ -2,9 +2,24 @@
 
 module RuboCop
   module Cop
-    module Style
+    module Layout
       # Here we check if the elements of a multi-line array literal are
       # aligned.
+      #
+      # @example
+      #   # bad
+      #   a = [1, 2, 3
+      #     4, 5, 6]
+      #   array = ['run',
+      #        'forrest',
+      #        'run']
+      #
+      #   # good
+      #   a = [1, 2, 3
+      #        4, 5, 6]
+      #   a = ['run',
+      #        'forrest',
+      #        'run']
       class AlignArray < Cop
         include AutocorrectAlignment
 

data/lib/rubocop/cop/{style → layout}/align_hash.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    module Style
+    module Layout
       # Check that the keys, separators, and values of a multi-line hash
       # literal are aligned according to configuration. The configuration
       # options are:

data/lib/rubocop/cop/{style → layout}/align_parameters.rb

@@ -2,9 +2,37 @@
 
 module RuboCop
   module Cop
-    module Style
+    module Layout
       # Here we check if the parameters on a multi-line method call or
       # definition are aligned.
+      #
+      # @example
+      #
+      #   # EnforcedStyle: with_first_parameter
+      #
+      #   # good
+      #
+      #   foo :bar,
+      #       :baz
+      #
+      #   # bad
+      #
+      #   foo :bar,
+      #     :baz
+      #
+      # @example
+      #
+      #   # EnforcedStyle: with_fixed_indentation
+      #
+      #   # good
+      #
+      #   foo :bar,
+      #     :baz
+      #
+      #   # bad
+      #
+      #   foo :bar,
+      #       :baz
       class AlignParameters < Cop
         include AutocorrectAlignment
         include OnMethodDef

data/lib/rubocop/cop/{style → layout}/block_end_newline.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    module Style
+    module Layout
       # This cop checks whether the end statement of a do..end block
       # is on its own line.
       #
@@ -28,17 +28,18 @@ module RuboCop
         MSG = 'Expression at %d, %d should be on its own line.'.freeze
 
         def on_block(node)
+          return if node.single_line?
+
           end_loc = node.loc.end
-          do_loc = node.loc.begin # Actually it's either do or {.
-          return if do_loc.line == end_loc.line # Ignore one-liners.
 
           # If the end is on its own line, there is no offense
           return if end_loc.source_line =~ /^\s*#{end_loc.source}/
 
-          msg = format(MSG, end_loc.line, end_loc.column + 1)
-          add_offense(node, end_loc, msg)
+          add_offense(node, end_loc)
         end
 
+        private
+
         def autocorrect(node)
           lambda do |corrector|
             indentation = indentation_of_block_start_line(node)
@@ -46,6 +47,10 @@ module RuboCop
           end
         end
 
+        def message(node)
+          format(MSG, node.loc.end.line, node.loc.end.column + 1)
+        end
+
         def indentation_of_block_start_line(node)
           match = /\S.*/.match(node.loc.begin.source_line)
           match.begin(0)

data/lib/rubocop/cop/{style → layout}/case_indentation.rb

@@ -2,11 +2,74 @@
 
 module RuboCop
   module Cop
-    module Style
+    module Layout
       # This cop checks how the *when*s of a *case* expression
       # are indented in relation to its *case* or *end* keyword.
       #
       # It will register a separate offense for each misaligned *when*.
+      #
+      # @example
+      #   # If Layout/EndAlignment is set to keyword style (default)
+      #   # *case* and *end* should always be aligned to same depth,
+      #   # and therefore *when* should always be aligned to both -
+      #   # regardless of configuration.
+      #
+      #   # bad for all styles
+      #   case n
+      #     when 0
+      #       x * 2
+      #     else
+      #       y / 3
+      #   end
+      #
+      #   # good for all styles
+      #   case n
+      #   when 0
+      #     x * 2
+      #   else
+      #     y / 3
+      #   end
+      #
+      # @example
+      #   # if EndAlignment is set to other style such as
+      #   # start_of_line (as shown below), then *when* alignment
+      #   # configuration does have an effect.
+      #
+      #   # EnforcedStyle: case (default)
+      #
+      #   # bad
+      #   a = case n
+      #   when 0
+      #     x * 2
+      #   else
+      #     y / 3
+      #   end
+      #
+      #   # good
+      #   a = case n
+      #       when 0
+      #         x * 2
+      #       else
+      #         y / 3
+      #   end
+      #
+      #   # EnforcedStyle: end
+      #
+      #   # bad
+      #   a = case n
+      #       when 0
+      #         x * 2
+      #       else
+      #         y / 3
+      #   end
+      #
+      #   # good
+      #   a = case n
+      #   when 0
+      #     x * 2
+      #   else
+      #     y / 3
+      #   end
       class CaseIndentation < Cop
         include AutocorrectAlignment
         include ConfigurableEnforcedStyle

data/lib/rubocop/cop/{style → layout}/closing_parenthesis_indentation.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    module Style
+    module Layout
       # This cops checks the indentation of hanging closing parentheses in
       # method calls, method definitions, and grouped expressions. A hanging
       # closing parenthesis means `)` preceded by a line break.
@@ -75,7 +75,7 @@ module RuboCop
         end
 
         def fixed_parameter_indentation?
-          config.for_cop('Style/AlignParameters')['EnforcedStyle'] ==
+          config.for_cop('Layout/AlignParameters')['EnforcedStyle'] ==
             'with_fixed_indentation'
         end
 

data/lib/rubocop/cop/{style → layout}/comment_indentation.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    module Style
+    module Layout
       # This cops checks the indentation of comments.
       class CommentIndentation < Cop
         include AutocorrectAlignment

data/lib/rubocop/cop/{style → layout}/dot_position.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    module Style
+    module Layout
       # This cop checks the . position in multi-line method calls.
       class DotPosition < Cop
         include ConfigurableEnforcedStyle

data/lib/rubocop/cop/{style → layout}/else_alignment.rb

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

data/lib/rubocop/cop/{style → layout}/empty_line_after_magic_comment.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    module Style
+    module Layout
       # Checks for a newline after the final magic comment.
       #
       # @example

data/lib/rubocop/cop/{style → layout}/empty_line_between_defs.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    module Style
+    module Layout
       # This cop checks whether method definitions are
       # separated by one empty line.
       #

data/lib/rubocop/cop/{style → layout}/empty_lines.rb

@@ -4,7 +4,7 @@ require 'set'
 
 module RuboCop
   module Cop
-    module Style
+    module Layout
       # This cops checks for two or more consecutive blank lines.
       class EmptyLines < Cop
         MSG = 'Extra blank line detected.'.freeze

data/lib/rubocop/cop/{style → layout}/empty_lines_around_access_modifier.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    module Style
+    module Layout
       # Access modifiers should be surrounded by blank lines.
       class EmptyLinesAroundAccessModifier < Cop
         include AccessModifierNode
@@ -23,7 +23,7 @@ module RuboCop
             send_line = node.loc.line
             previous_line = processed_source[send_line - 2]
             next_line = processed_source[send_line]
-            line = line_range(node)
+            line = range_by_whole_lines(node.source_range)
 
             unless previous_line_empty?(previous_line)
               corrector.insert_before(line, "\n")
@@ -37,11 +37,6 @@ module RuboCop
 
         private
 
-        def line_range(node)
-          range_between(node.source_range.begin_pos - node.loc.column,
-                        node.source_range.end_pos)
-        end
-
         def previous_line_ignoring_comments(processed_source, send_line)
           processed_source[0..send_line - 2].reverse.find do |line|
             !comment_line?(line)

data/lib/rubocop/cop/{style → layout}/empty_lines_around_begin_body.rb

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

data/lib/rubocop/cop/{style → layout}/empty_lines_around_block_body.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    module Style
+    module Layout
       # This cops checks if empty lines around the bodies of blocks match
       # the configuration.
       #
@@ -31,9 +31,7 @@ module RuboCop
         KIND = 'block'.freeze
 
         def on_block(node)
-          _send, _args, body = *node
-
-          check(node, body)
+          check(node, node.body)
         end
       end
     end

data/lib/rubocop/cop/{style → layout}/empty_lines_around_class_body.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    module Style
+    module Layout
       # This cops checks if empty lines around the bodies of classes match
       # the configuration.
       #