rubocop 0.87.0 → 0.90.0

data/lib/rubocop/cop/metrics/utils/code_length_calculator.rb

@@ -10,10 +10,12 @@ module RuboCop
           include Util
 
           FOLDABLE_TYPES = %i[array hash heredoc].freeze
-          CLASSISH_TYPES = %i[class module].freeze
+          CLASSLIKE_TYPES = %i[class module].freeze
+          private_constant :FOLDABLE_TYPES, :CLASSLIKE_TYPES
 
-          def initialize(node, count_comments: false, foldable_types: [])
+          def initialize(node, processed_source, count_comments: false, foldable_types: [])
             @node = node
+            @processed_source = processed_source
             @count_comments = count_comments
             @foldable_checks = build_foldable_checks(foldable_types)
             @foldable_types = normalize_foldable_types(foldable_types)
@@ -21,13 +23,11 @@ module RuboCop
 
           def calculate
             length = code_length(@node)
+            return length if @foldable_types.empty?
 
-            each_top_level_descendant(@node, *@foldable_types, *CLASSISH_TYPES) do |descendant|
-              descendant_length = code_length(descendant)
-
-              if classlike_node?(descendant)
-                length -= (descendant_length + 2)
-              elsif foldable_node?(descendant)
+            each_top_level_descendant(@node, @foldable_types) do |descendant|
+              if foldable_node?(descendant)
+                descendant_length = code_length(descendant)
                 length = length - descendant_length + 1
               end
             end
@@ -37,14 +37,6 @@ module RuboCop
 
           private
 
-          def_node_matcher :class_definition?, <<~PATTERN
-            (casgn nil? _ (block (send (const nil? :Class) :new) ...))
-          PATTERN
-
-          def_node_matcher :module_definition?, <<~PATTERN
-            (casgn nil? _ (block (send (const nil? :Module) :new) ...))
-          PATTERN
-
           def build_foldable_checks(types)
             types.map do |type|
               case type
@@ -67,35 +59,72 @@ module RuboCop
           end
 
           def code_length(node)
-            return heredoc_length(node) if heredoc_node?(node)
+            if classlike_node?(node)
+              classlike_code_length(node)
+            elsif heredoc_node?(node)
+              heredoc_length(node)
+            else
+              body = extract_body(node)
+              return 0 unless body
 
-            body = extract_body(node)
-            lines = body&.source&.lines || []
-            lines.count { |line| !irrelevant_line?(line) }
+              body.source.each_line.count { |line| !irrelevant_line?(line) }
+            end
           end
 
           def heredoc_node?(node)
             node.respond_to?(:heredoc?) && node.heredoc?
           end
 
+          def classlike_code_length(node)
+            return 0 if namespace_module?(node)
+
+            body_line_numbers = line_range(node).to_a[1...-1]
+
+            target_line_numbers = body_line_numbers -
+                                  line_numbers_of_inner_nodes(node, :module, :class)
+
+            target_line_numbers.reduce(0) do |length, line_number|
+              source_line = @processed_source[line_number]
+              next length if irrelevant_line?(source_line)
+
+              length + 1
+            end
+          end
+
+          def namespace_module?(node)
+            classlike_node?(node.body)
+          end
+
+          def line_numbers_of_inner_nodes(node, *types)
+            line_numbers = Set.new
+
+            node.each_descendant(*types) do |inner_node|
+              line_range = line_range(inner_node)
+              line_numbers.merge(line_range)
+            end
+
+            line_numbers.to_a
+          end
+
           def heredoc_length(node)
             lines = node.loc.heredoc_body.source.lines
             lines.count { |line| !irrelevant_line?(line) } + 2
           end
 
-          def each_top_level_descendant(node, *types, &block)
+          def each_top_level_descendant(node, types, &block)
             node.each_child_node do |child|
+              next if classlike_node?(child)
+
               if types.include?(child.type)
                 yield child
               else
-                each_top_level_descendant(child, *types, &block)
+                each_top_level_descendant(child, types, &block)
               end
             end
           end
 
           def classlike_node?(node)
-            CLASSISH_TYPES.include?(node.type) ||
-              (node.casgn_type? && (class_definition?(node) || module_definition?(node)))
+            CLASSLIKE_TYPES.include?(node.type)
           end
 
           def foldable_node?(node)

data/lib/rubocop/cop/metrics/utils/repeated_csend_discount.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Metrics
+      module Utils
+        # @api private
+        #
+        # Helps to calculate code length for the provided node.
+        module RepeatedCsendDiscount
+          def reset_repeated_csend
+            @repeated_csend = {}
+          end
+
+          def discount_for_repeated_csend?(csend_node)
+            receiver = csend_node.receiver
+
+            return false unless receiver.lvar_type?
+
+            var_name = receiver.children.first
+            seen = @repeated_csend.fetch(var_name) do
+              @repeated_csend[var_name] = csend_node
+              return false
+            end
+
+            !seen.equal?(csend_node)
+          end
+
+          def reset_on_lvasgn(node)
+            var_name = node.children.first
+            @repeated_csend.delete(var_name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/migration/department_name.rb

@@ -5,8 +5,9 @@ module RuboCop
     module Migration
       # Check that cop names in rubocop:disable comments are given with
       # department name.
-      class DepartmentName < Cop
+      class DepartmentName < Base
         include RangeHelp
+        extend AutoCorrector
 
         MSG = 'Department name is missing.'
 
@@ -18,8 +19,8 @@ module RuboCop
         # `DepartmentName/CopName` or` all`.
         DISABLING_COPS_CONTENT_TOKEN = %r{[A-z]+/[A-z]+|all}.freeze
 
-        def investigate(processed_source)
-          processed_source.each_comment do |comment|
+        def on_new_investigation
+          processed_source.comments.each do |comment|
             next if comment.text !~ DISABLE_COMMENT_FORMAT
 
             offset = Regexp.last_match(1).length
@@ -38,18 +39,6 @@ module RuboCop
           end
         end
 
-        def autocorrect(range)
-          shall_warn = false
-          cop_name = range.source
-          qualified_cop_name = Cop.registry.qualified_cop_name(cop_name,
-                                                               nil, shall_warn)
-          unless qualified_cop_name.include?('/')
-            qualified_cop_name = qualified_legacy_cop_name(cop_name)
-          end
-
-          ->(corrector) { corrector.replace(range, qualified_cop_name) }
-        end
-
         private
 
         def disable_comment_offset
@@ -60,7 +49,16 @@ module RuboCop
           start = comment.location.expression.begin_pos + offset
           range = range_between(start, start + name.length)
 
-          add_offense(range, location: range)
+          add_offense(range) do |corrector|
+            cop_name = range.source
+            qualified_cop_name = Registry.global.qualified_cop_name(cop_name, nil, warn: false)
+
+            unless qualified_cop_name.include?('/')
+              qualified_cop_name = qualified_legacy_cop_name(cop_name)
+            end
+
+            corrector.replace(range, qualified_cop_name)
+          end
         end
 
         def valid_content_token?(content_token)

data/lib/rubocop/cop/mixin/alignment.rb

@@ -42,6 +42,7 @@ module RuboCop
         end
       end
 
+      # @api private
       def each_bad_alignment(items, base_column)
         prev_line = -1
         items.each do |current|
@@ -55,17 +56,20 @@ module RuboCop
         end
       end
 
+      # @api public
       def display_column(range)
         line = processed_source.lines[range.line - 1]
         Unicode::DisplayWidth.of(line[0, range.column])
       end
 
+      # @api public
       def within?(inner, outer)
         inner.begin_pos >= outer.begin_pos && inner.end_pos <= outer.end_pos
       end
 
+      # @deprecated Use processed_source.comment_at_line(line)
       def end_of_line_comment(line)
-        processed_source.find_comment { |c| c.loc.line == line }
+        processed_source.line_with_comment?(line)
       end
     end
   end

data/lib/rubocop/cop/mixin/allowed_methods.rb

@@ -7,10 +7,12 @@ module RuboCop
     module AllowedMethods
       private
 
+      # @api public
       def allowed_method?(name)
         allowed_methods.include?(name.to_s)
       end
 
+      # @api public
       def allowed_methods
         cop_config.fetch('AllowedMethods', [])
       end

data/lib/rubocop/cop/mixin/annotation_comment.rb

@@ -7,12 +7,14 @@ module RuboCop
       module AnnotationComment
         private
 
+        # @api public
         def annotation?(comment)
           _margin, first_word, colon, space, note = split_comment(comment)
           keyword_appearance?(first_word, colon, space) &&
             !just_first_word_of_sentence?(first_word, colon, space, note)
         end
 
+        # @api public
         def split_comment(comment)
           match = comment.text.match(/^(# ?)([A-Za-z]+)(\s*:)?(\s+)?(\S+)?/)
           return false unless match
@@ -20,14 +22,17 @@ module RuboCop
           match.captures
         end
 
+        # @api public
         def keyword_appearance?(first_word, colon, space)
           first_word && keyword?(first_word.upcase) && (colon || space)
         end
 
+        # @api private
         def just_first_word_of_sentence?(first_word, colon, space, note)
           first_word == first_word.capitalize && !colon && space && note
         end
 
+        # @api public
         def keyword?(word)
           config.for_cop('Style/CommentAnnotation')['Keywords'].include?(word)
         end

data/lib/rubocop/cop/mixin/array_min_size.rb

@@ -16,7 +16,7 @@ module RuboCop
         cop_config['MinSize']
       end
 
-      def array_style_detected(style, ary_size)
+      def array_style_detected(style, ary_size) # rubocop:todo Metrics/AbcSize
         cfg = config_to_allow_offenses
         return if cfg['Enabled'] == false
 

data/lib/rubocop/cop/mixin/check_line_breakable.rb

@@ -54,17 +54,19 @@ module RuboCop
 
       private
 
+      # @api private
       def extract_breakable_node_from_elements(node, elements, max)
         return unless breakable_collection?(node, elements)
         return if safe_to_ignore?(node)
 
         line = processed_source.lines[node.first_line - 1]
-        return if processed_source.commented?(node.loc.begin)
+        return if processed_source.line_with_comment?(node.loc.line)
         return if line.length <= max
 
         extract_first_element_over_column_limit(node, elements, max)
       end
 
+      # @api private
       def extract_first_element_over_column_limit(node, elements, max)
         line = node.first_line
         i = 0
@@ -74,10 +76,12 @@ module RuboCop
         elements[i - 1]
       end
 
+      # @api private
       def within_column_limit?(element, max, line)
         element && element.loc.column < max && element.loc.line == line
       end
 
+      # @api private
       def safe_to_ignore?(node)
         return true unless max
         return true if already_on_multiple_lines?(node)
@@ -93,6 +97,7 @@ module RuboCop
         false
       end
 
+      # @api private
       def breakable_collection?(node, elements)
         # For simplicity we only want to insert breaks in normal
         # hashes wrapped in a set of curly braces like {foo: 1}.
@@ -109,6 +114,7 @@ module RuboCop
         starts_with_bracket && has_second_element
       end
 
+      # @api private
       def contained_by_breakable_collection_on_same_line?(node)
         node.each_ancestor.find do |ancestor|
           # Ignore ancestors on different lines.
@@ -128,12 +134,12 @@ module RuboCop
         false
       end
 
+      # @api private
       def contained_by_multiline_collection_that_could_be_broken_up?(node)
         node.each_ancestor.find do |ancestor|
-          if ancestor.hash_type? || ancestor.array_type?
-            if breakable_collection?(ancestor, ancestor.children)
-              return children_could_be_broken_up?(ancestor.children)
-            end
+          if (ancestor.hash_type? || ancestor.array_type?) &&
+             breakable_collection?(ancestor, ancestor.children)
+            return children_could_be_broken_up?(ancestor.children)
           end
 
           next unless ancestor.send_type?
@@ -145,6 +151,7 @@ module RuboCop
         false
       end
 
+      # @api private
       def children_could_be_broken_up?(children)
         return false if all_on_same_line?(children)
 
@@ -157,12 +164,14 @@ module RuboCop
         false
       end
 
+      # @api private
       def all_on_same_line?(nodes)
         return true if nodes.empty?
 
         nodes.first.first_line == nodes.last.last_line
       end
 
+      # @api private
       def process_args(args)
         # If there is a trailing hash arg without explicit braces, like this:
         #
@@ -170,12 +179,12 @@ module RuboCop
         #
         # ...then each key/value pair is treated as a method 'argument'
         # when determining where line breaks should appear.
-        if (last_arg = args.last)
-          args = args.concat(args.pop.children) if last_arg.hash_type? && !last_arg.braces?
-        end
+        last_arg = args.last
+        args = args[0...-1] + last_arg.children if last_arg&.hash_type? && !last_arg&.braces?
         args
       end
 
+      # @api private
       def already_on_multiple_lines?(node)
         node.first_line != node.last_line
       end

data/lib/rubocop/cop/mixin/code_length.rb

@@ -6,8 +6,14 @@ module RuboCop
     module CodeLength
       include ConfigurableMax
 
+      MSG = '%<label>s has too many lines. [%<length>d/%<max>d]'
+
       private
 
+      def message(length, max_length)
+        format(MSG, label: cop_label, length: length, max: max_length)
+      end
+
       def max_length
         cop_config['Max']
       end
@@ -21,14 +27,16 @@ module RuboCop
       end
 
       def check_code_length(node)
-        length = code_length(node)
+        # Skip costly calculation when definitely not needed
+        return if node.line_count <= max_length
 
-        return unless length > max_length
+        calculator = build_code_length_calculator(node)
+        length = calculator.calculate
+        return if length <= max_length
 
-        location = node.casgn_type? ? :name : :expression
+        location = node.casgn_type? ? node.loc.name : node.loc.expression
 
-        add_offense(node, location: location,
-                          message: message(length, max_length)) do
+        add_offense(location, message: message(length, max_length)) do
           self.max = length
         end
       end
@@ -37,6 +45,15 @@ module RuboCop
       def irrelevant_line(source_line)
         source_line.blank? || !count_comments? && comment_line?(source_line)
       end
+
+      def build_code_length_calculator(node)
+        Metrics::Utils::CodeLengthCalculator.new(
+          node,
+          processed_source,
+          count_comments: count_comments?,
+          foldable_types: count_as_one
+        )
+      end
     end
   end
 end