rubocop 0.51.0 → 0.52.0

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

@@ -8,6 +8,9 @@ module RuboCop
       # In Ruby 2.3 or newer, squiggly heredocs (`<<~`) should be used. If you
       # use the older rubies, you should introduce some library to your project
       # (e.g. ActiveSupport, Powerpack or Unindent).
+      # Note: When `Metrics/LineLength`'s `AllowHeredoc` is false(not default),
+      #       this cop does not add any offenses for long here documents to
+      #       avoid `Metrics/LineLength`'s offenses.
       #
       # @example
       #
@@ -34,11 +37,12 @@ module RuboCop
         include ConfigurableEnforcedStyle
         include SafeMode
 
-        RUBY23_MSG = 'Use %d spaces for indentation in a heredoc by using ' \
-                     '`<<~` instead of `%s`.'.freeze
-        LIBRARY_MSG = 'Use %d spaces for indentation in a heredoc by using %s.'
-                      .freeze
-        StripMethods = {
+        RUBY23_MSG = 'Use %<indentation_width>d spaces for indentation in a ' \
+                     'heredoc by using `<<~` instead of ' \
+                     '`%<current_indent_type>s`.'.freeze
+        LIBRARY_MSG = 'Use %<indentation_width>d spaces for indentation in a ' \
+                      'heredoc by using %<method>s.'.freeze
+        STRIP_METHODS = {
           unindent: 'unindent',
           active_support: 'strip_heredoc',
           powerpack: 'strip_indent'
@@ -57,6 +61,7 @@ module RuboCop
             return unless body_indent_level.zero?
           end
 
+          return if too_long_line?(node)
           add_offense(node, location: :heredoc_body)
         end
 
@@ -88,16 +93,49 @@ module RuboCop
           case style
           when :squiggly
             current_indent_type = "<<#{heredoc_indent_type(node)}"
-            format(RUBY23_MSG, indentation_width, current_indent_type)
+            ruby23_message(indentation_width, current_indent_type)
           when nil
             method = "some library(e.g. ActiveSupport's `String#strip_heredoc`)"
-            format(LIBRARY_MSG, indentation_width, method)
+            library_message(indentation_width, method)
           else
-            method = "`String##{StripMethods[style]}`"
-            format(LIBRARY_MSG, indentation_width, method)
+            method = "`String##{STRIP_METHODS[style]}`"
+            library_message(indentation_width, method)
           end
         end
 
+        def library_message(indentation_width, method)
+          format(
+            LIBRARY_MSG,
+            indentation_width: indentation_width,
+            method: method
+          )
+        end
+
+        def ruby23_message(indentation_width, current_indent_type)
+          format(
+            RUBY23_MSG,
+            indentation_width: indentation_width,
+            current_indent_type: current_indent_type
+          )
+        end
+
+        def too_long_line?(node)
+          return false if config.for_cop('Metrics/LineLength')['AllowHeredoc']
+          body = heredoc_body(node)
+
+          expected_indent = base_indent_level(node) + indentation_width
+          actual_indent = indent_level(body)
+          increase_indent_level = expected_indent - actual_indent
+
+          max_line = body.each_line.map { |line| line.chomp.size }.max
+
+          max_line + increase_indent_level >= max_line_length
+        end
+
+        def max_line_length
+          config.for_cop('Metrics/LineLength')['Max']
+        end
+
         def correct_by_squiggly(node)
           return if target_ruby_version < 2.3
           lambda do |corrector|
@@ -114,7 +152,7 @@ module RuboCop
         def correct_by_library(node)
           lambda do |corrector|
             corrector.replace(node.loc.heredoc_body, indented_body(node))
-            corrected = ".#{StripMethods[style]}"
+            corrected = ".#{STRIP_METHODS[style]}"
             corrector.insert_after(node.loc.expression, corrected)
           end
         end
@@ -146,7 +184,9 @@ module RuboCop
         end
 
         def indent_level(str)
-          indentations = str.scan(/^\s*/).reject { |line| line == "\n" }
+          indentations = str.lines
+                            .map { |line| line[/^\s*/] }
+                            .reject { |line| line == "\n" }
           indentations.empty? ? 0 : indentations.min_by(&:size).size
         end
 

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

@@ -10,34 +10,31 @@ module RuboCop
       # one.
       #
       # @example
-      #   # bad, Width: 2
+      #   # bad
       #   class A
       #    def test
       #     puts 'hello'
       #    end
       #   end
       #
-      #   # bad, Width: 2,
-      #          IgnoredPatterns:
-      #            - '^\s*module'
-      #   module A
-      #   class B
+      #   # good
+      #   class A
       #     def test
-      #     puts 'hello'
+      #       puts 'hello'
       #     end
       #   end
-      #   end
       #
-      #   # good, Width: 2
-      #   class A
+      # @example IgnoredPatterns: ['^\s*module']
+      #   # bad
+      #   module A
+      #   class B
       #     def test
-      #       puts 'hello'
+      #     puts 'hello'
       #     end
       #   end
+      #   end
       #
-      #   # good, Width: 2,
-      #           IgnoredPatterns:
-      #             - '^\s*module'
+      #   # good
       #   module A
       #   class B
       #     def test
@@ -51,7 +48,8 @@ module RuboCop
         include CheckAssignment
         include IgnoredPattern
 
-        MSG = 'Use %d (not %d) spaces for%s indentation.'.freeze
+        MSG = 'Use %<configured_indentation_width>d (not %<indentation>d) ' \
+              'spaces for%<name>s indentation.'.freeze
 
         SPECIAL_MODIFIERS = %w[private protected].freeze
 
@@ -239,10 +237,19 @@ module RuboCop
                  end
 
           name = style == 'normal' ? '' : " #{style}"
-          msg = format(MSG, configured_indentation_width, indentation, name)
+          message = message(configured_indentation_width, indentation, name)
 
           add_offense(node, location: offending_range(body_node, indentation),
-                            message: msg)
+                            message: message)
+        end
+
+        def message(configured_indentation_width, indentation, name)
+          format(
+            MSG,
+            configured_indentation_width: configured_indentation_width,
+            indentation: indentation,
+            name: name
+          )
         end
 
         # Returns true if the given node is within another node that has

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

@@ -26,16 +26,18 @@ module RuboCop
 
         def space_before(token)
           return unless token
-          return if token.pos.column.zero?
+          return if token.column.zero?
 
-          token_with_space =
-            range_with_surrounding_space(token.pos, :left, false)
+          space_range =
+            range_with_surrounding_space(range: token.pos,
+                                         side: :left,
+                                         newlines: false)
           # If the file starts with a byte order mark (BOM), the column can be
           # non-zero, but then we find out here if there's no space to the left
           # of the first token.
-          return if token_with_space == token.pos
+          return if space_range == token.pos
 
-          yield range_between(token_with_space.begin_pos, token.pos.begin_pos)
+          yield range_between(space_range.begin_pos, token.begin_pos)
         end
       end
     end

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

@@ -28,8 +28,6 @@ module RuboCop
           end
         end
 
-        private
-
         def autocorrect(comment)
           expr = comment.loc.expression
           hash_mark = range_between(expr.begin_pos, expr.begin_pos + 1)
@@ -37,6 +35,8 @@ module RuboCop
           ->(corrector) { corrector.insert_after(hash_mark, ' ') }
         end
 
+        private
+
         def allowed_on_first_line?(comment)
           shebang?(comment) || rackup_config_file? && rackup_options?(comment)
         end

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

@@ -26,35 +26,68 @@ module RuboCop
       # The closing brace of a multi-line array literal must be on the same
       # line as the last element of the array.
       #
-      # @example
+      # @example EnforcedStyle: symmetrical (default)
+      #     # bad
+      #     [ :a,
+      #       :b
+      #     ]
+      #
+      #     # bad
+      #     [
+      #       :a,
+      #       :b ]
       #
-      #     # symmetrical: bad
-      #     # new_line: good
-      #     # same_line: bad
+      #     # good
       #     [ :a,
+      #       :b ]
+      #
+      #     # good
+      #     [
+      #       :a,
       #       :b
       #     ]
       #
-      #     # symmetrical: bad
-      #     # new_line: bad
-      #     # same_line: good
+      # @example EnforcedStyle: new_line
+      #     # bad
       #     [
       #       :a,
       #       :b ]
       #
-      #     # symmetrical: good
-      #     # new_line: bad
-      #     # same_line: good
+      #     # bad
       #     [ :a,
       #       :b ]
       #
-      #     # symmetrical: good
-      #     # new_line: good
-      #     # same_line: bad
+      #     # good
+      #     [ :a,
+      #       :b
+      #     ]
+      #
+      #     # good
       #     [
       #       :a,
       #       :b
       #     ]
+      #
+      # @example EnforcedStyle: same_line
+      #     # bad
+      #     [ :a,
+      #       :b
+      #     ]
+      #
+      #     # bad
+      #     [
+      #       :a,
+      #       :b
+      #     ]
+      #
+      #     # good
+      #     [
+      #       :a,
+      #       :b ]
+      #
+      #     # good
+      #     [ :a,
+      #       :b ]
       class MultilineArrayBraceLayout < Cop
         include MultilineLiteralBraceLayout
 
@@ -70,7 +103,7 @@ module RuboCop
           'after the last array element.'.freeze
 
         ALWAYS_SAME_LINE_MESSAGE = 'Closing array brace must be on the same ' \
-          'line as teh last array element.'.freeze
+          'line as the last array element.'.freeze
 
         def on_array(node)
           check_brace_layout(node)

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

@@ -6,30 +6,31 @@ module RuboCop
       # This cop checks whether the multiline assignments have a newline
       # after the assignment operator.
       #
-      # @example
-      #   # bad (with EnforcedStyle set to new_line)
+      # @example EnforcedStyle: new_line (default)
+      #   # bad
       #   foo = if expression
       #     'bar'
       #   end
       #
-      #   # good (with EnforcedStyle set to same_line)
-      #   foo = if expression
-      #     'bar'
-      #   end
-      #
-      #   # good (with EnforcedStyle set to new_line)
+      #   # good
       #   foo =
       #     if expression
       #       'bar'
       #     end
       #
-      #   # good (with EnforcedStyle set to new_line)
+      #   # good
       #   foo =
       #     begin
       #       compute
       #     rescue => e
       #       nil
       #     end
+      #
+      # @example EnforcedStyle: same_line
+      #   # good
+      #   foo = if expression
+      #     'bar'
+      #   end
       class MultilineAssignmentLayout < Cop
         include CheckAssignment
         include ConfigurableEnforcedStyle

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

@@ -53,20 +53,6 @@ module RuboCop
           add_offense_for_expression(node, node.body, MSG)
         end
 
-        private
-
-        def args_on_beginning_line?(node)
-          !node.arguments? ||
-            node.loc.begin.line == node.arguments.loc.last_line
-        end
-
-        def add_offense_for_expression(node, expr, msg)
-          expression = expr.source_range
-          range = range_between(expression.begin_pos, expression.end_pos)
-
-          add_offense(node, location: range, message: msg)
-        end
-
         def autocorrect(node)
           lambda do |corrector|
             unless args_on_beginning_line?(node)
@@ -84,9 +70,26 @@ module RuboCop
           end
         end
 
+        private
+
+        def args_on_beginning_line?(node)
+          !node.arguments? ||
+            node.loc.begin.line == node.arguments.loc.last_line
+        end
+
+        def add_offense_for_expression(node, expr, msg)
+          expression = expr.source_range
+          range = range_between(expression.begin_pos, expression.end_pos)
+
+          add_offense(node, location: range, message: msg)
+        end
+
         def autocorrect_arguments(corrector, node)
-          end_pos = range_with_surrounding_space(node.arguments.source_range,
-                                                 :right, false).end_pos
+          end_pos = range_with_surrounding_space(
+            range: node.arguments.source_range,
+            side: :right,
+            newlines: false
+          ).end_pos
           range = range_between(node.loc.begin.end.begin_pos, end_pos)
           corrector.replace(range, " |#{block_arg_string(node.arguments)}|")
         end

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

@@ -26,35 +26,68 @@ module RuboCop
       # The closing brace of a multi-line hash literal must be on the same
       # line as the last element of the hash.
       #
-      # @example
+      # @example EnforcedStyle: symmetrical (default)
       #
-      #     # symmetrical: bad
-      #     # new_line: good
-      #     # same_line: bad
+      #     # bad
       #     { a: 1,
       #       b: 2
       #     }
+      #     # bad
+      #     {
+      #       a: 1,
+      #       b: 2 }
+      #
+      #     # good
+      #     { a: 1,
+      #       b: 2 }
+      #
+      #     # good
+      #     {
+      #       a: 1,
+      #       b: 2
+      #     }
       #
-      #     # symmetrical: bad
-      #     # new_line: bad
-      #     # same_line: good
+      # @example EnforcedStyle: new_line
+      #     # bad
       #     {
       #       a: 1,
       #       b: 2 }
       #
-      #     # symmetrical: good
-      #     # new_line: bad
-      #     # same_line: good
+      #     # bad
       #     { a: 1,
       #       b: 2 }
       #
-      #     # symmetrical: good
-      #     # new_line: good
-      #     # same_line: bad
+      #     # good
+      #     { a: 1,
+      #       b: 2
+      #     }
+      #
+      #     # good
       #     {
       #       a: 1,
       #       b: 2
       #     }
+      #
+      # @example EnforcedStyle: same_line
+      #     # bad
+      #     { a: 1,
+      #       b: 2
+      #     }
+      #
+      #     # bad
+      #     {
+      #       a: 1,
+      #       b: 2
+      #     }
+      #
+      #     # good
+      #     {
+      #       a: 1,
+      #       b: 2 }
+      #
+      #     # good
+      #     { a: 1,
+      #       b: 2 }
       class MultilineHashBraceLayout < Cop
         include MultilineLiteralBraceLayout