rubocop 1.18.3 → 1.20.0

data/lib/rubocop/cop/documentation.rb

@@ -8,7 +8,7 @@ module RuboCop
 
       # @api private
       def department_to_basename(department)
-        "cops_#{department.downcase}"
+        "cops_#{department.to_s.downcase.tr('/', '_')}"
       end
 
       # @api private

data/lib/rubocop/cop/gemspec/ordered_dependencies.rb

@@ -50,7 +50,7 @@ module RuboCop
       #   spec.add_dependency 'rubocop'
       #   # For tests
       #   spec.add_dependency 'rspec'
-      class OrderedDependencies < Cop
+      class OrderedDependencies < Cop # rubocop:disable InternalAffairs/InheritDeprecatedCopClass
         include ConfigurableEnforcedStyle
         include OrderedGemNode
 

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InternalAffairs
+      # `RuboCop::Cop::Cop` is deprecated and will be removed in Rubocop 2.0.
+      # Your custom cop class should inherit from `RuboCop::Cop::Base` instead of
+      # `RuboCop::Cop::Cop`.
+      #
+      # See "v1 Upgrade Notes" for more details:
+      # https://docs.rubocop.org/rubocop/v1_upgrade_notes.html
+      #
+      # @example
+      #   # bad
+      #   class Foo < Cop
+      #   end
+      #
+      #   # good
+      #   class Foo < Base
+      #   end
+      #
+      class InheritDeprecatedCopClass < Base
+        MSG = 'Use `Base` instead of `Cop`.'
+
+        def on_class(node)
+          return unless (parent_class = node.parent_class)
+          return unless parent_class.children.last == :Cop
+
+          add_offense(parent_class)
+        end
+      end
+    end
+  end
+end

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,7 @@
 
 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/method_name_equal'
 require_relative 'internal_affairs/node_destructuring'
 require_relative 'internal_affairs/node_matcher_directive'
@@ -12,4 +13,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/class_structure.rb

@@ -289,12 +289,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/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/end_alignment.rb

@@ -165,9 +165,11 @@ 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? &&
+                                node.loc.line == node.parent.loc.line
+
+          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 +179,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/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
+          selector.line == node.pairs.first.loc.line
         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_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/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)

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)
@@ -94,10 +108,6 @@ module RuboCop
           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