rubocop 1.18.1 → 1.22.3

data/lib/rubocop/cop/internal_affairs/undefined_config.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InternalAffairs
+      # Looks for references to a cop configuration key that isn't defined in config/default.yml.
+      class UndefinedConfig < Base
+        ALLOWED_CONFIGURATIONS = %w[
+          Safe SafeAutoCorrect AutoCorrect Severity StyleGuide Details Reference Include Exclude
+        ].freeze
+        RESTRICT_ON_SEND = %i[[] fetch].freeze
+        MSG = '`%<name>s` is not defined in the configuration for `%<cop>s` ' \
+              'in `config/default.yml`.'
+
+        # @!method cop_class_def(node)
+        def_node_search :cop_class_def, <<~PATTERN
+          (class _ (const _ {:Base :Cop}) ...)
+        PATTERN
+
+        # @!method cop_config_accessor?(node)
+        def_node_matcher :cop_config_accessor?, <<~PATTERN
+          (send (send nil? :cop_config) {:[] :fetch} ${str sym}...)
+        PATTERN
+
+        def on_new_investigation
+          super
+          return unless processed_source.ast
+
+          cop_class = cop_class_def(processed_source.ast).first
+          return unless (@cop_class_name = extract_cop_name(cop_class))
+
+          @config_for_cop = RuboCop::ConfigLoader.default_configuration.for_cop(@cop_class_name)
+        end
+
+        def on_send(node)
+          return unless cop_class_name
+          return unless (config_name_node = cop_config_accessor?(node))
+          return if always_allowed?(config_name_node)
+          return if configuration_key_defined?(config_name_node)
+
+          message = format(MSG, name: config_name_node.value, cop: cop_class_name)
+          add_offense(config_name_node, message: message)
+        end
+
+        private
+
+        attr_reader :config_for_cop, :cop_class_name
+
+        def extract_cop_name(class_node)
+          return unless class_node
+
+          segments = [class_node].concat(
+            class_node.each_ancestor(:class, :module).take_while do |n|
+              n.identifier.short_name != :Cop
+            end
+          )
+
+          segments.reverse_each.map { |s| s.identifier.short_name }.join('/')
+        end
+
+        def always_allowed?(node)
+          ALLOWED_CONFIGURATIONS.include?(node.value)
+        end
+
+        def configuration_key_defined?(node)
+          config_for_cop.key?(node.value)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/internal_affairs.rb

@@ -2,6 +2,8 @@
 
 require_relative 'internal_affairs/empty_line_between_expect_offense_and_correction'
 require_relative 'internal_affairs/example_description'
+require_relative 'internal_affairs/inherit_deprecated_cop_class'
+require_relative 'internal_affairs/location_line_equality_comparison'
 require_relative 'internal_affairs/method_name_equal'
 require_relative 'internal_affairs/node_destructuring'
 require_relative 'internal_affairs/node_matcher_directive'
@@ -12,4 +14,5 @@ require_relative 'internal_affairs/redundant_let_rubocop_config_new'
 require_relative 'internal_affairs/redundant_location_argument'
 require_relative 'internal_affairs/redundant_message_argument'
 require_relative 'internal_affairs/style_detected_api_use'
+require_relative 'internal_affairs/undefined_config'
 require_relative 'internal_affairs/useless_message_assertion'

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

@@ -54,7 +54,7 @@ module RuboCop
 
         def on_send(node)
           first_arg = node.first_argument
-          return if !multiple_arguments?(node, first_arg) || node.send_type? && node.method?(:[]=)
+          return if !multiple_arguments?(node, first_arg) || (node.send_type? && node.method?(:[]=))
 
           if first_arg.hash_type? && !first_arg.braces?
             pairs = first_arg.pairs

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

@@ -33,7 +33,7 @@ module RuboCop
         def check_assignment(node, rhs)
           return unless rhs
           return unless node.loc.operator
-          return if node.loc.operator.line == rhs.first_line
+          return if same_line?(node.loc.operator, rhs)
 
           base = display_column(leftmost_multiple_assignment(node).source_range)
           check_alignment([rhs], base + configured_indentation_width)

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

@@ -101,11 +101,11 @@ module RuboCop
         def block_end_align_target(node)
           lineage = [node, *node.ancestors]
 
-          target = lineage.each_cons(2) do |current, parent|
-            break current if end_align_target?(current, parent)
+          lineage.each_cons(2) do |current, parent|
+            return current if end_align_target?(current, parent)
           end
 
-          target || lineage.last
+          lineage.last
         end
 
         def end_align_target?(node, parent)

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

@@ -264,7 +264,8 @@ module RuboCop
 
         def source_range_with_comment(node)
           begin_pos, end_pos =
-            if node.def_type? && !node.method?(:initialize) || node.send_type? && node.def_modifier?
+            if (node.def_type? && !node.method?(:initialize)) ||
+               (node.send_type? && node.def_modifier?)
               start_node = find_visibility_start(node) || node
               end_node = find_visibility_end(node) || node
               [begin_pos_with_comment(start_node),
@@ -289,12 +290,16 @@ module RuboCop
           (node.first_line - 1).downto(1) do |annotation_line|
             break unless (comment = processed_source.comment_at_line(annotation_line))
 
-            first_comment = comment
+            first_comment = comment if whole_line_comment_at_line?(annotation_line)
           end
 
           start_line_position(first_comment || node)
         end
 
+        def whole_line_comment_at_line?(line)
+          /\A\s*#/.match?(processed_source.lines[line - 1])
+        end
+
         def start_line_position(node)
           buffer.line_range(node.loc.line).begin_pos - 1
         end

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

@@ -68,19 +68,22 @@ module RuboCop
         end
 
         def proper_dot_position?(node)
-          receiver_line = node.receiver.source_range.end.line
-          selector_line = selector_range(node).line
+          selector_range = selector_range(node)
 
-          # receiver and selector are on the same line
-          return true if selector_line == receiver_line
+          return true if same_line?(selector_range, end_range(node.receiver))
 
+          selector_line = selector_range.line
+          receiver_line = receiver_end_line(node.receiver)
           dot_line = node.loc.dot.line
 
           # don't register an offense if there is a line comment between the
           # dot and the selector otherwise, we might break the code while
           # "correcting" it (even if there is just an extra blank line, treat
           # it the same)
-          return true if line_between?(selector_line, dot_line)
+          # Also, in the case of a heredoc, the receiver will end after the dot,
+          # because the heredoc body is on subsequent lines, so use the highest
+          # line to compare to.
+          return true if line_between?(selector_line, [receiver_line, dot_line].max)
 
           correct_dot_position_style?(dot_line, selector_line)
         end
@@ -96,7 +99,33 @@ module RuboCop
           end
         end
 
+        def receiver_end_line(node)
+          if (line = last_heredoc_line(node))
+            line
+          else
+            node.source_range.end.line
+          end
+        end
+
+        def last_heredoc_line(node)
+          if node.send_type?
+            node.arguments.select { |arg| heredoc?(arg) }.map { |arg| arg.loc.heredoc_end.line }.max
+          elsif heredoc?(node)
+            node.loc.heredoc_end.line
+          end
+        end
+
+        def heredoc?(node)
+          (node.str_type? || node.dstr_type?) && node.heredoc?
+        end
+
+        def end_range(node)
+          node.source_range.end
+        end
+
         def selector_range(node)
+          return node unless node.call_type?
+
           # l.(1) has no selector, so we use the opening parenthesis instead
           node.loc.selector || node.loc.begin
         end

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

@@ -96,7 +96,7 @@ module RuboCop
 
         def autocorrect(corrector, node)
           previous_token = previous_token(node)
-          range = if previous_token && node.loc.line == previous_token.line
+          range = if previous_token && same_line?(node, previous_token)
                     range_with_surrounding_space(range: node.loc.expression, newlines: false)
                   else
                     range_by_whole_lines(node.loc.expression, include_final_newline: true)

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

@@ -38,12 +38,14 @@ module RuboCop
       class EmptyLineAfterGuardClause < Base
         include RangeHelp
         extend AutoCorrector
+        extend Util
 
         MSG = 'Add empty line after guard clause.'
         END_OF_HEREDOC_LINE = 1
 
         def on_if(node)
           return if correct_style?(node)
+          return if multiple_statements_on_line?(node)
 
           if node.modifier_form? && (heredoc_node = last_heredoc_argument(node))
             return if next_line_empty_or_enable_directive_comment?(heredoc_line(node, heredoc_node))
@@ -166,6 +168,13 @@ module RuboCop
             node
           end
         end
+
+        def multiple_statements_on_line?(node)
+          parent = node.parent
+          return false unless parent
+
+          parent.begin_type? && parent.single_line?
+        end
       end
     end
   end

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

@@ -65,21 +65,24 @@ module RuboCop
         MSG = 'Extra empty line detected %<location>s the `%<keyword>s`.'
 
         def on_def(node)
-          check_body(node.body)
+          check_body(node.body, node.loc.line)
         end
         alias on_defs on_def
 
         def on_kwbegin(node)
           body, = *node
-          check_body(body)
+          check_body(body, node.loc.line)
         end
 
         private
 
-        def check_body(node)
-          locations = keyword_locations(node)
+        def check_body(body, line_of_def_or_kwbegin)
+          locations = keyword_locations(body)
+
           locations.each do |loc|
             line = loc.line
+            next if line == line_of_def_or_kwbegin
+
             keyword = loc.source
             # below the keyword
             check_line(style, line, message('after', keyword), &:empty?)

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

@@ -165,9 +165,10 @@ module RuboCop
         end
 
         def alignment_node_for_variable_style(node)
-          return node.parent if node.case_type? && node.argument?
+          return node.parent if node.case_type? && node.argument? && same_line?(node, node.parent)
+
+          assignment = assignment_or_operator_method(node)
 
-          assignment = node.ancestors.find(&:assignment_or_similar?)
           if assignment && !line_break_before_keyword?(assignment.source_range, node)
             assignment
           else
@@ -177,6 +178,12 @@ module RuboCop
             node
           end
         end
+
+        def assignment_or_operator_method(node)
+          node.ancestors.find do |ancestor|
+            ancestor.assignment_or_similar? || (ancestor.send_type? && ancestor.operator_method?)
+          end
+        end
       end
     end
   end

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

@@ -154,7 +154,7 @@ module RuboCop
 
         def on_send(node)
           return if style != :consistent && enforce_first_argument_with_fixed_indentation?
-          return if !node.arguments? || bare_operator?(node)
+          return if !node.arguments? || bare_operator?(node) || node.setter_method?
 
           indent = base_indentation(node) + configured_indentation_width
 

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

@@ -115,7 +115,7 @@ module RuboCop
           left_bracket = array_node.loc.begin
           first_elem = array_node.values.first
           if first_elem
-            return if first_elem.source_range.line == left_bracket.line
+            return if same_line?(first_elem, left_bracket)
 
             check_first(first_elem, left_bracket, left_parenthesis, 0)
           end

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

@@ -116,7 +116,7 @@ module RuboCop
           first_pair = hash_node.pairs.first
 
           if first_pair
-            return if first_pair.first_line == left_brace.line
+            return if same_line?(first_pair, left_brace)
 
             if separator_style?(first_pair)
               check_based_on_longest_key(hash_node, left_brace, left_parenthesis)

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

@@ -74,7 +74,7 @@ module RuboCop
           left_parenthesis = def_node.arguments.loc.begin
           first_elem = def_node.arguments.first
           return unless first_elem
-          return if first_elem.source_range.line == left_parenthesis.line
+          return if same_line?(first_elem, left_parenthesis)
 
           check_first(first_elem, left_parenthesis, nil, 0)
         end

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

@@ -213,18 +213,22 @@ module RuboCop
           check_pairs(node)
         end
 
-        attr_accessor :offences_by, :column_deltas
+        attr_accessor :offenses_by, :column_deltas
 
         private
 
         def autocorrect_incompatible_with_other_cops?(node)
-          enforce_first_argument_with_fixed_indentation? &&
-            node.pairs.any? &&
-            node.parent&.call_type? && node.parent.loc.selector.line == node.pairs.first.loc.line
+          return false unless enforce_first_argument_with_fixed_indentation? &&
+                              node.pairs.any? &&
+                              node.parent&.call_type?
+
+          parent_loc = node.parent.loc
+          selector = parent_loc.selector || parent_loc.expression
+          same_line?(selector, node.pairs.first)
         end
 
         def reset!
-          self.offences_by = {}
+          self.offenses_by = {}
           self.column_deltas = Hash.new { |hash, key| hash[key] = {} }
         end
 
@@ -248,33 +252,33 @@ module RuboCop
             end
           end
 
-          add_offences
+          add_offenses
         end
 
-        def add_offences
-          kwsplat_offences = offences_by.delete(KeywordSplatAlignment)
-          register_offences_with_format(kwsplat_offences, KeywordSplatAlignment)
+        def add_offenses
+          kwsplat_offenses = offenses_by.delete(KeywordSplatAlignment)
+          register_offenses_with_format(kwsplat_offenses, KeywordSplatAlignment)
 
-          format, offences = offences_by.min_by { |_, v| v.length }
-          register_offences_with_format(offences, format)
+          format, offenses = offenses_by.min_by { |_, v| v.length }
+          register_offenses_with_format(offenses, format)
         end
 
-        def register_offences_with_format(offences, format)
-          (offences || []).each do |offence|
-            add_offense(offence, message: MESSAGES[format]) do |corrector|
-              delta = column_deltas[alignment_for(offence).first.class][offence]
+        def register_offenses_with_format(offenses, format)
+          (offenses || []).each do |offense|
+            add_offense(offense, message: MESSAGES[format]) do |corrector|
+              delta = column_deltas[alignment_for(offense).first.class][offense]
 
-              correct_node(corrector, offence, delta) unless delta.nil?
+              correct_node(corrector, offense, delta) unless delta.nil?
             end
           end
         end
 
         def check_delta(delta, node:, alignment:)
-          offences_by[alignment.class] ||= []
+          offenses_by[alignment.class] ||= []
           return if good_alignment? delta
 
           column_deltas[alignment.class][node] = delta
-          offences_by[alignment.class].push(node)
+          offenses_by[alignment.class].push(node)
         end
 
         def ignore_hash_argument?(node)

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

@@ -167,7 +167,7 @@ module RuboCop
 
           end_of_outer_send = outermost_send.loc.end
 
-          end_of_outer_send.line == end_of_last_arg_of_outer_send.line &&
+          same_line?(end_of_outer_send, end_of_last_arg_of_outer_send) &&
             end_of_outer_send.column == end_of_last_arg_of_outer_send.column + 1
         end
 

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

@@ -143,13 +143,6 @@ module RuboCop
           indent_level(base_line)
         end
 
-        def indent_level(str)
-          indentations = str.lines
-                            .map { |line| line[/^\s*/] }
-                            .reject { |line| line.end_with?("\n") }
-          indentations.empty? ? 0 : indentations.min_by(&:size).size
-        end
-
         # Returns '~', '-' or nil
         def heredoc_indent_type(node)
           node.source[/^<<([~-])/, 1]

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

@@ -43,7 +43,7 @@ module RuboCop
           str_ranges = string_literal_ranges(processed_source.ast)
 
           processed_source.lines.each.with_index(1) do |line, lineno|
-            next unless (range = find_offence(line, lineno))
+            next unless (range = find_offense(line, lineno))
             next if in_string_literal?(str_ranges, range)
 
             add_offense(range) { |corrector| autocorrect(corrector, range) }
@@ -60,7 +60,7 @@ module RuboCop
           end
         end
 
-        def find_offence(line, lineno)
+        def find_offense(line, lineno)
           match = if style == :spaces
                     line.match(/\A\s*\t+/)
                   else

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

@@ -341,7 +341,7 @@ module RuboCop
           return true unless body_node
 
           # Don't check if expression is on same line as "then" keyword, etc.
-          return true if body_node.loc.line == base_loc.line
+          return true if same_line?(body_node, base_loc)
 
           return true if starts_with_access_modifier?(body_node)
 

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

@@ -57,7 +57,7 @@ module RuboCop
 
         def on_new_investigation
           processed_source.comments.each do |comment|
-            next unless /\A#+[^#\s=:+-]/.match?(comment.text)
+            next unless /\A#+[^#\s=+-]/.match?(comment.text)
             next if comment.loc.line == 1 && allowed_on_first_line?(comment)
             next if doxygen_comment_style?(comment)
             next if gemfile_ruby_comment?(comment)
@@ -77,7 +77,7 @@ module RuboCop
         end
 
         def allowed_on_first_line?(comment)
-          shebang?(comment) || rackup_config_file? && rackup_options?(comment)
+          shebang?(comment) || (rackup_config_file? && rackup_options?(comment))
         end
 
         def shebang?(comment)

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

@@ -11,8 +11,7 @@ module RuboCop
       # concatenated string parts shall be indented regardless of `EnforcedStyle` configuration.
       #
       # If `EnforcedStyle: indented` is set, it's the second line that shall be indented one step
-      # more than the first line. Lines 3 and forward shall be aligned with line 2. Here too there
-      # are exceptions. Values in a hash literal are always aligned.
+      # more than the first line. Lines 3 and forward shall be aligned with line 2.
       #
       # @example
       #   # bad
@@ -34,29 +33,44 @@ module RuboCop
       #       'z'
       #   end
       #
-      #   my_hash = {
-      #     first: 'a message' \
-      #            'in two parts'
-      #   }
-      #
       # @example EnforcedStyle: aligned (default)
       #   # bad
       #   puts 'x' \
       #     'y'
       #
+      #   my_hash = {
+      #     first: 'a message' \
+      #       'in two parts'
+      #   }
+      #
       #   # good
       #   puts 'x' \
       #        'y'
       #
+      #   my_hash = {
+      #     first: 'a message' \
+      #            'in two parts'
+      #   }
+      #
       # @example EnforcedStyle: indented
       #   # bad
       #   result = 'x' \
       #            'y'
       #
+      #   my_hash = {
+      #     first: 'a message' \
+      #            'in two parts'
+      #   }
+      #
       #   # good
       #   result = 'x' \
       #     'y'
       #
+      #   my_hash = {
+      #     first: 'a message' \
+      #       'in two parts'
+      #   }
+      #
       class LineEndStringConcatenationIndentation < Base
         include ConfigurableEnforcedStyle
         include Alignment
@@ -70,7 +84,7 @@ module RuboCop
           return unless strings_concatenated_with_backslash?(node)
 
           children = node.children
-          if style == :aligned && !always_indented?(node) || always_aligned?(node)
+          if style == :aligned && !always_indented?(node)
             check_aligned(children, 1)
           else
             check_indented(children)
@@ -85,19 +99,15 @@ module RuboCop
         private
 
         def strings_concatenated_with_backslash?(dstr_node)
-          !dstr_node.heredoc? &&
-            dstr_node.children.length > 1 &&
-            dstr_node.children.all? { |c| c.str_type? || c.dstr_type? }
+          dstr_node.multiline? &&
+            dstr_node.children.all? { |c| c.str_type? || c.dstr_type? } &&
+            dstr_node.children.none?(&:multiline?)
         end
 
         def always_indented?(dstr_node)
           PARENT_TYPES_FOR_INDENTED.include?(dstr_node.parent&.type)
         end
 
-        def always_aligned?(dstr_node)
-          dstr_node.parent&.pair_type?
-        end
-
         def check_aligned(children, start_index)
           base_column = children[start_index - 1].loc.column
           children[start_index..-1].each do |child|
@@ -108,11 +118,20 @@ module RuboCop
         end
 
         def check_indented(children)
-          base_column = children[0].source_range.source_line =~ /\S/
-          @column_delta = base_column + configured_indentation_width - children[1].loc.column
+          @column_delta = base_column(children[0]) + configured_indentation_width -
+                          children[1].loc.column
           add_offense_and_correction(children[1], MSG_INDENT) if @column_delta != 0
         end
 
+        def base_column(child)
+          grandparent = child.parent.parent
+          if grandparent&.type == :pair
+            grandparent.loc.column
+          else
+            child.source_range.source_line =~ /\S/
+          end
+        end
+
         def add_offense_and_correction(node, message)
           add_offense(node, message: message) { |corrector| autocorrect(corrector, node) }
         end

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

@@ -137,7 +137,7 @@ module RuboCop
           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
+          return nil unless same_line?(next_range, range)
 
           next_char = next_range.source
           return nil if /[\r\n]/.match?(next_char)
@@ -176,15 +176,15 @@ module RuboCop
         def ignored_line?(line, line_index)
           matches_ignored_pattern?(line) ||
             shebang?(line, line_index) ||
-            heredocs && line_in_permitted_heredoc?(line_index.succ)
+            (heredocs && line_in_permitted_heredoc?(line_index.succ))
         end
 
         def shebang?(line, line_index)
           line_index.zero? && line.start_with?('#!')
         end
 
-        def register_offense(loc, line, line_index)
-          message = format(MSG, length: line_length(line), max: max)
+        def register_offense(loc, line, line_index, length: line_length(line))
+          message = format(MSG, length: length, max: max)
 
           self.breakable_range = breakable_range_by_line_index[line_index]
 
@@ -241,9 +241,10 @@ module RuboCop
         end
 
         def check_directive_line(line, line_index)
-          return if line_length_without_directive(line) <= max
+          length_without_directive = line_length_without_directive(line)
+          return if length_without_directive <= max
 
-          range = max..(line_length_without_directive(line) - 1)
+          range = max..(length_without_directive - 1)
           register_offense(
             source_range(
               processed_source.buffer,
@@ -251,7 +252,8 @@ module RuboCop
               range
             ),
             line,
-            line_index
+            line_index,
+            length: length_without_directive
           )
         end