rubocop 0.76.0 → 0.80.1

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

@@ -20,7 +20,7 @@ module RuboCop
       #   a = ['run',
       #        'forrest',
       #        'run']
-      class AlignArray < Cop
+      class ArrayAlignment < Cop
         include Alignment
 
         MSG = 'Align the elements of an array literal if they span more ' \

data/lib/rubocop/cop/layout/{indent_assignment.rb → assignment_indentation.rb}

@@ -21,7 +21,7 @@ module RuboCop
       #
       # The indentation of the remaining lines can be corrected with
       # other cops such as `IndentationConsistency` and `EndAlignment`.
-      class IndentAssignment < Cop
+      class AssignmentIndentation < Cop
         include CheckAssignment
         include Alignment
 

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

@@ -56,7 +56,8 @@ module RuboCop
           return if nodes.all?(&:single_line?) &&
                     cop_config['AllowAdjacentOneLineDefs']
 
-          add_offense(nodes.last, location: :keyword)
+          location = nodes.last.loc.keyword.join(nodes.last.loc.name)
+          add_offense(nodes.last, location: location)
         end
 
         def autocorrect(node)

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

@@ -114,7 +114,7 @@ module RuboCop
 
         # Returns an array of ranges that should not be reported. It's the
         # extra spaces between the keys and values in a multiline hash,
-        # since those are handled by the Style/AlignHash cop.
+        # since those are handled by the Layout/HashAlignment cop.
         def ignored_ranges(ast)
           return [] unless ast
 

data/lib/rubocop/cop/layout/{indent_first_argument.rb → first_argument_indentation.rb}

@@ -2,14 +2,14 @@
 
 module RuboCop
   module Cop
-    # rubocop:disable Metrics/LineLength
+    # rubocop:disable Layout/LineLength
     module Layout
       # This cop checks the indentation of the first argument in a method call.
-      # Arguments after the first one are checked by Layout/AlignArguments,
+      # Arguments after the first one are checked by Layout/ArgumentAlignment,
       # not by this cop.
       #
       # For indenting the first parameter of method *definitions*, check out
-      # Layout/IndentFirstParameter.
+      # Layout/FirstParameterIndentation.
       #
       # @example
       #
@@ -142,8 +142,8 @@ module RuboCop
       #     nested_first_param),
       #   second_param
       #
-      class IndentFirstArgument < Cop
-        # rubocop:enable Metrics/LineLength
+      class FirstArgumentIndentation < Cop
+        # rubocop:enable Layout/LineLength
         include Alignment
         include ConfigurableEnforcedStyle
         include RangeHelp

data/lib/rubocop/cop/layout/{indent_first_array_element.rb → first_array_element_indentation.rb}

@@ -5,7 +5,7 @@ module RuboCop
     module Layout
       # This cop checks the indentation of the first element in an array literal
       # where the opening bracket and the first element are on separate lines.
-      # The other elements' indentations are handled by the AlignArray cop.
+      # The other elements' indentations are handled by the ArrayAlignment cop.
       #
       # By default, array literals that are arguments in a method call with
       # parentheses, and where the opening square bracket of the array is on the
@@ -22,7 +22,7 @@ module RuboCop
       # @example EnforcedStyle: special_inside_parentheses (default)
       #   # The `special_inside_parentheses` style enforces that the first
       #   # element in an array literal where the opening bracket and first
-      #   # element are on seprate lines is indented one step (two spaces) more
+      #   # element are on separate lines is indented one step (two spaces) more
       #   # than the position inside the opening parenthesis.
       #
       #   #bad
@@ -44,7 +44,7 @@ module RuboCop
       # @example EnforcedStyle: consistent
       #   # The `consistent` style enforces that the first element in an array
       #   # literal where the opening bracket and the first element are on
-      #   # seprate lines is indented the same as an array literal which is not
+      #   # separate lines is indented the same as an array literal which is not
       #   # defined inside a method call.
       #
       #   #bad
@@ -79,7 +79,7 @@ module RuboCop
       #   and_now_for_something = [
       #                             :completely_different
       #                           ]
-      class IndentFirstArrayElement < Cop
+      class FirstArrayElementIndentation < Cop
         include Alignment
         include ConfigurableEnforcedStyle
         include MultilineElementIndentation

data/lib/rubocop/cop/layout/{indent_first_hash_element.rb → first_hash_element_indentation.rb}

@@ -5,7 +5,7 @@ module RuboCop
     module Layout
       # This cop checks the indentation of the first key in a hash literal
       # where the opening brace and the first key are on separate lines. The
-      # other keys' indentations are handled by the AlignHash cop.
+      # other keys' indentations are handled by the HashAlignment cop.
       #
       # By default, Hash literals that are arguments in a method call with
       # parentheses, and where the opening curly brace of the hash is on the
@@ -77,7 +77,7 @@ module RuboCop
       #   and_now_for_something = {
       #                             completely: :different
       #                           }
-      class IndentFirstHashElement < Cop
+      class FirstHashElementIndentation < Cop
         include Alignment
         include ConfigurableEnforcedStyle
         include MultilineElementIndentation
@@ -149,7 +149,7 @@ module RuboCop
         def separator_style?(first_pair)
           separator = first_pair.loc.operator
           key = "Enforced#{separator.is?(':') ? 'Colon' : 'HashRocket'}Style"
-          config.for_cop('Layout/AlignHash')[key] == 'separator'
+          config.for_cop('Layout/HashAlignment')[key] == 'separator'
         end
 
         def check_based_on_longest_key(hash_node, left_brace, left_parenthesis)

data/lib/rubocop/cop/layout/{indent_first_parameter.rb → first_parameter_indentation.rb}

@@ -5,10 +5,10 @@ module RuboCop
     module Layout
       # This cop checks the indentation of the first parameter in a method
       # definition. Parameters after the first one are checked by
-      # Layout/AlignParameters, not by this cop.
+      # Layout/ParameterAlignment, not by this cop.
       #
       # For indenting the first argument of method *calls*, check out
-      # Layout/IndentFirstArgument, which supports options related to
+      # Layout/FirstArgumentIndentation, which supports options related to
       # nesting that are irrelevant for method *definitions*.
       #
       # @example
@@ -41,7 +41,7 @@ module RuboCop
       #   second_param)
       #     123
       #   end
-      class IndentFirstParameter < Cop
+      class FirstParameterIndentation < Cop
         include Alignment
         include ConfigurableEnforcedStyle
         include MultilineElementIndentation

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

@@ -175,12 +175,16 @@ module RuboCop
       #   do_something({foo: 1,
       #     bar: 2})
       #
-      class AlignHash < Cop
-        include HashAlignment
+      class HashAlignment < Cop
+        include HashAlignmentStyles
         include RangeHelp
 
-        MSG = 'Align the elements of a hash literal if they span more than ' \
-              'one line.'
+        MESSAGES = { KeyAlignment => 'Align the keys of a hash literal if ' \
+                      'they span more than one line.',
+                     SeparatorAlignment => 'Align the separators of a hash ' \
+                       'literal if they span more than one line.',
+                     TableAlignment => 'Align the keys and values of a hash ' \
+                       'literal if they span more than one line.' }.freeze
 
         def on_send(node)
           return if double_splat?(node)
@@ -249,9 +253,9 @@ module RuboCop
         end
 
         def add_offences
-          _format, offences = offences_by.min_by { |_, v| v.length }
+          format, offences = offences_by.min_by { |_, v| v.length }
           (offences || []).each do |offence|
-            add_offense offence
+            add_offense(offence, message: MESSAGES[format])
           end
         end
 

data/lib/rubocop/cop/layout/{indent_heredoc.rb → heredoc_indentation.rb}

@@ -8,9 +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),
+      # Note: When `Layout/LineLength`'s `AllowHeredoc` is false (not default),
       #       this cop does not add any offenses for long here documents to
-      #       avoid `Metrics/LineLength`'s offenses.
+      #       avoid `Layout/LineLength`'s offenses.
       #
       # @example EnforcedStyle: squiggly (default)
       #   # bad
@@ -49,7 +49,7 @@ module RuboCop
       #     something
       #   RUBY
       #
-      class IndentHeredoc < Cop
+      class HeredocIndentation < Cop
         include Heredoc
         include ConfigurableEnforcedStyle
 
@@ -159,11 +159,11 @@ module RuboCop
         end
 
         def unlimited_heredoc_length?
-          config.for_cop('Metrics/LineLength')['AllowHeredoc']
+          config.for_cop('Layout/LineLength')['AllowHeredoc']
         end
 
         def max_line_length
-          config.for_cop('Metrics/LineLength')['Max']
+          config.for_cop('Layout/LineLength')['Max']
         end
 
         def correct_by_squiggly(node)

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

@@ -35,6 +35,20 @@ module RuboCop
       #   # Another line of comment
       #   #*
       #
+      # @example AllowGemfileRubyComment: false (default)
+      #
+      #   # bad
+      #
+      #   #ruby=2.7.0
+      #   #ruby-gemset=myproject
+      #
+      # @example AllowGemfileRubyComment: true
+      #
+      #   # good
+      #
+      #   #ruby=2.7.0
+      #   #ruby-gemset=myproject
+      #
       class LeadingCommentSpace < Cop
         include RangeHelp
 
@@ -44,7 +58,8 @@ module RuboCop
           processed_source.each_comment do |comment|
             next unless comment.text =~ /\A#+[^#\s=:+-]/
             next if comment.loc.line == 1 && allowed_on_first_line?(comment)
-            next if allow_doxygen_comment? && doxygen_comment_style?(comment)
+            next if doxygen_comment_style?(comment)
+            next if gemfile_ruby_comment?(comment)
 
             add_offense(comment)
           end
@@ -80,7 +95,23 @@ module RuboCop
         end
 
         def doxygen_comment_style?(comment)
-          comment.text.start_with?('#*')
+          allow_doxygen_comment? && comment.text.start_with?('#*')
+        end
+
+        def allow_gemfile_ruby_comment?
+          cop_config['AllowGemfileRubyComment']
+        end
+
+        def gemfile?
+          File.basename(processed_source.file_path).eql?('Gemfile')
+        end
+
+        def ruby_comment_in_gemfile?(comment)
+          gemfile? && comment.text.start_with?('#ruby')
+        end
+
+        def gemfile_ruby_comment?(comment)
+          allow_gemfile_ruby_comment? && ruby_comment_in_gemfile?(comment)
         end
       end
     end

data/lib/rubocop/cop/layout/{leading_blank_lines.rb → leading_empty_lines.rb}

@@ -27,7 +27,7 @@ module RuboCop
       #   # good
       #   # (start of file)
       #   # a comment
-      class LeadingBlankLines < Cop
+      class LeadingEmptyLines < Cop
         MSG = 'Unnecessary blank line at the beginning of the source.'
 
         def investigate(processed_source)

data/lib/rubocop/cop/{metrics → layout}/line_length.rb

@@ -2,10 +2,9 @@
 
 require 'uri'
 
-# rubocop:disable Metrics/ClassLength
 module RuboCop
   module Cop
-    module Metrics
+    module Layout
       # This cop checks the length of lines in the source code.
       # The maximum length is configurable.
       # The tab size is configured in the `IndentationWidth`
@@ -20,19 +19,25 @@ module RuboCop
       #
       # If autocorrection is enabled, the following Layout cops
       # are recommended to further format the broken lines.
+      # (Many of these are enabled by default.)
       #
-      #   - AlignArray
-      #   - AlignHash
-      #   - AlignParameters
+      #   - ArgumentAlignment
+      #   - BlockAlignment
+      #   - BlockDelimiters
+      #   - BlockEndNewline
       #   - ClosingParenthesisIndentation
-      #   - IndentFirstArgument
-      #   - IndentFirstArrayElement
-      #   - IndentFirstHashElement
-      #   - IndentFirstParameter
+      #   - FirstArgumentIndentation
+      #   - FirstArrayElementIndentation
+      #   - FirstHashElementIndentation
+      #   - FirstParameterIndentation
+      #   - HashAlignment
+      #   - IndentationWidth
       #   - MultilineArrayLineBreaks
+      #   - MultilineBlockLayout
       #   - MultilineHashBraceLayout
       #   - MultilineHashKeyLineBreaks
       #   - MultilineMethodArgumentLineBreaks
+      #   - ParameterAlignment
       #
       # Together, these cops will pretty print hashes, arrays,
       # method calls, etc. For example, let's say the max columns
@@ -58,9 +63,14 @@ module RuboCop
         include ConfigurableMax
         include IgnoredPattern
         include RangeHelp
+        include LineLengthHelp
 
         MSG = 'Line is too long. [%<length>d/%<max>d]'
 
+        def on_block(node)
+          check_for_breakable_block(node)
+        end
+
         def on_potential_breakable_node(node)
           check_for_breakable_node(node)
         end
@@ -68,6 +78,10 @@ module RuboCop
         alias on_hash on_potential_breakable_node
         alias on_send on_potential_breakable_node
 
+        def investigate(processed_source)
+          check_for_breakable_semicolons(processed_source)
+        end
+
         def investigate_post_walk(processed_source)
           processed_source.lines.each_with_index do |line, line_index|
             check_line(line, line_index)
@@ -89,29 +103,60 @@ module RuboCop
           return if breakable_node.nil?
 
           line_index = breakable_node.first_line - 1
-          breakable_nodes_by_line_index[line_index] = breakable_node
+          range = breakable_node.source_range
+
+          existing = breakable_range_by_line_index[line_index]
+          return if existing
+
+          breakable_range_by_line_index[line_index] = range
         end
 
-        def breakable_nodes_by_line_index
-          @breakable_nodes_by_line_index ||= {}
+        def check_for_breakable_semicolons(processed_source)
+          tokens = processed_source.tokens.select { |t| t.type == :tSEMI }
+          tokens.reverse_each do |token|
+            range = breakable_range_after_semicolon(token)
+            breakable_range_by_line_index[range.line - 1] = range if range
+          end
         end
 
-        def heredocs
-          @heredocs ||= extract_heredocs(processed_source.ast)
+        def check_for_breakable_block(block_node)
+          return unless block_node.single_line?
+
+          line_index = block_node.loc.line - 1
+          range = breakable_block_range(block_node)
+          pos = range.begin_pos + 1
+
+          breakable_range_by_line_index[line_index] =
+            range_between(pos, pos + 1)
         end
 
-        def tab_indentation_width
-          config.for_cop('Layout/Tab')['IndentationWidth']
+        def breakable_block_range(block_node)
+          if block_node.arguments? && !block_node.lambda?
+            block_node.arguments.loc.end
+          else
+            block_node.loc.begin
+          end
         end
 
-        def indentation_difference(line)
-          return 0 unless tab_indentation_width
+        def breakable_range_after_semicolon(semicolon_token)
+          range = semicolon_token.pos
+          end_pos = range.end_pos
+          next_range = range_between(end_pos, end_pos + 1)
+          return nil unless next_range.line == range.line
 
-          line.match(/^\t*/)[0].size * (tab_indentation_width - 1)
+          next_char = next_range.source
+          return nil if /[\r\n]/ =~ next_char
+          return nil if next_char == ';'
+
+          next_range
+        end
+
+        def breakable_range_by_line_index
+          @breakable_range_by_line_index ||= {}
         end
 
-        def line_length(line)
-          line.length + indentation_difference(line)
+        def heredocs
+          @heredocs ||= extract_heredocs(processed_source.ast)
         end
 
         def highlight_start(line)
@@ -147,33 +192,12 @@ module RuboCop
         def register_offense(loc, line, line_index)
           message = format(MSG, length: line_length(line), max: max)
 
-          breakable_range = breakable_range(line, line_index)
+          breakable_range = breakable_range_by_line_index[line_index]
           add_offense(breakable_range, location: loc, message: message) do
             self.max = line_length(line)
           end
         end
 
-        def breakable_range(line, line_index)
-          return if line_in_heredoc?(line_index + 1)
-
-          semicolon_range = breakable_semicolon_range(line, line_index)
-          return semicolon_range if semicolon_range
-
-          breakable_node = breakable_nodes_by_line_index[line_index]
-          return breakable_node.source_range if breakable_node
-        end
-
-        def breakable_semicolon_range(line, line_index)
-          semicolon_separated_parts = line.split(';')
-          return if semicolon_separated_parts.length <= 1
-
-          column = semicolon_separated_parts.first.length + 1
-          range = source_range(processed_source.buffer, line_index, column, 1)
-          return if processed_source.commented?(range)
-
-          range
-        end
-
         def excess_range(uri_range, line, line_index)
           excessive_position = if uri_range && uri_range.begin < max
                                  uri_range.end
@@ -222,53 +246,6 @@ module RuboCop
           end
         end
 
-        def allow_uri?
-          cop_config['AllowURI']
-        end
-
-        def ignore_cop_directives?
-          cop_config['IgnoreCopDirectives']
-        end
-
-        def allowed_uri_position?(line, uri_range)
-          uri_range.begin < max &&
-            (uri_range.end == line_length(line) ||
-             uri_range.end == line_length(line) - 1)
-        end
-
-        def find_excessive_uri_range(line)
-          last_uri_match = match_uris(line).last
-          return nil unless last_uri_match
-
-          begin_position, end_position =
-            last_uri_match.offset(0).map do |pos|
-              pos + indentation_difference(line)
-            end
-          return nil if begin_position < max && end_position < max
-
-          begin_position...end_position
-        end
-
-        def match_uris(string)
-          matches = []
-          string.scan(uri_regexp) do
-            matches << $LAST_MATCH_INFO if valid_uri?($LAST_MATCH_INFO[0])
-          end
-          matches
-        end
-
-        def valid_uri?(uri_ish_string)
-          URI.parse(uri_ish_string)
-          true
-        rescue URI::InvalidURIError, NoMethodError
-          false
-        end
-
-        def uri_regexp
-          @uri_regexp ||=
-            URI::DEFAULT_PARSER.make_regexp(cop_config['URISchemes'])
-        end
-
         def check_directive_line(line, line_index)
           return if line_length_without_directive(line) <= max
 
@@ -284,23 +261,6 @@ module RuboCop
           )
         end
 
-        def directive_on_source_line?(line_index)
-          source_line_number = line_index + processed_source.buffer.first_line
-          comment =
-            processed_source
-            .comments
-            .detect { |e| e.location.line == source_line_number }
-
-          return false unless comment
-
-          comment.text.match(CommentConfig::COMMENT_DIRECTIVE_REGEXP)
-        end
-
-        def line_length_without_directive(line)
-          before_comment, = line.split(CommentConfig::COMMENT_DIRECTIVE_REGEXP)
-          before_comment.rstrip.length
-        end
-
         def check_uri_line(line, line_index)
           uri_range = find_excessive_uri_range(line)
           return if uri_range && allowed_uri_position?(line, uri_range)
@@ -315,4 +275,3 @@ module RuboCop
     end
   end
 end
-# rubocop:enable Metrics/ClassLength