rubocop 0.83.0 → 0.87.0

data/lib/rubocop/cop/metrics/cyclomatic_complexity.rb

@@ -13,19 +13,51 @@ module RuboCop
       # operator (or keyword and) can be converted to a nested if statement,
       # and ||/or is shorthand for a sequence of ifs, so they also add one.
       # Loops can be said to have an exit condition, so they add one.
+      # Blocks that are calls to builtin iteration methods
+      # (e.g. `ary.map{...}) also add one, others are ignored.
+      #
+      #   def each_child_node(*types)               # count begins: 1
+      #     unless block_given?                     # unless: +1
+      #       return to_enum(__method__, *types)
+      #
+      #     children.each do |child|                # each{}: +1
+      #       next unless child.is_a?(Node)         # unless: +1
+      #
+      #       yield child if types.empty? ||        # if: +1, ||: +1
+      #                      types.include?(child.type)
+      #     end
+      #
+      #     self
+      #   end                                       # total: 6
       class CyclomaticComplexity < Cop
         include MethodComplexity
+        include Utils::IteratingBlock
 
         MSG = 'Cyclomatic complexity for %<method>s is too high. ' \
               '[%<complexity>d/%<max>d]'
-        COUNTED_NODES = %i[if while until for
-                           rescue when and or].freeze
+        COUNTED_NODES = %i[if while until for csend block block_pass
+                           rescue when and or or_asgn and_asgn].freeze
 
         private
 
-        def complexity_score_for(_node)
+        def complexity_score_for(node)
+          return 0 if iterating_block?(node) == false
+
           1
         end
+
+        def block_method(node)
+          case node.type
+          when :block
+            node.method_name
+          when :block_pass
+            node.parent.method_name
+          end
+        end
+
+        def count_block?(block)
+          KNOWN_ITERATING_METHODS.include? block.method_name
+        end
       end
     end
   end

data/lib/rubocop/cop/metrics/method_length.rb

@@ -6,6 +6,29 @@ module RuboCop
       # This cop checks if the length of a method exceeds some maximum value.
       # Comment lines can optionally be ignored.
       # The maximum allowed length is configurable.
+      #
+      # You can set literals you want to fold with `CountAsOne`.
+      # Available are: 'array', 'hash', and 'heredoc'. Each literal
+      # will be counted as one line regardless of its actual size.
+      #
+      # @example CountAsOne: ['array', 'heredoc']
+      #
+      #   def m
+      #     array = [       # +1
+      #       1,
+      #       2
+      #     ]
+      #
+      #     hash = {        # +3
+      #       key: 'value'
+      #     }
+      #
+      #     <<~HEREDOC      # +1
+      #       Heredoc
+      #       content.
+      #     HEREDOC
+      #   end               # 5 points
+      #
       class MethodLength < Cop
         include TooManyLines
 

data/lib/rubocop/cop/metrics/module_length.rb

@@ -6,8 +6,31 @@ module RuboCop
       # This cop checks if the length a module exceeds some maximum value.
       # Comment lines can optionally be ignored.
       # The maximum allowed length is configurable.
+      #
+      # You can set literals you want to fold with `CountAsOne`.
+      # Available are: 'array', 'hash', and 'heredoc'. Each literal
+      # will be counted as one line regardless of its actual size.
+      #
+      # @example CountAsOne: ['array', 'heredoc']
+      #
+      #   module M
+      #     ARRAY = [         # +1
+      #       1,
+      #       2
+      #     ]
+      #
+      #     HASH = {          # +3
+      #       key: 'value'
+      #     }
+      #
+      #     MSG = <<~HEREDOC  # +1
+      #       Heredoc
+      #       content.
+      #     HEREDOC
+      #   end                 # 5 points
+      #
       class ModuleLength < Cop
-        include ClassishLength
+        include TooManyLines
 
         def on_module(node)
           check_code_length(node)
@@ -22,7 +45,7 @@ module RuboCop
         private
 
         def_node_matcher :module_definition?, <<~PATTERN
-          (casgn nil? _ (block (send (const nil? :Module) :new) ...))
+          (casgn nil? _ (block (send (const {nil? cbase} :Module) :new) ...))
         PATTERN
 
         def message(length, max_length)

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

@@ -19,7 +19,7 @@ module RuboCop
           # > Condition -- a logical/Boolean test, == != <= >= < > else case
           # > default try catch ? and unary conditionals.
           # > http://c2.com/cgi/wiki?AbcMetric
-          CONDITION_NODES = CyclomaticComplexity::COUNTED_NODES.freeze
+          CONDITION_NODES = (CyclomaticComplexity::COUNTED_NODES - %i[block block_pass]).freeze
 
           def self.calculate(node)
             new(node).calculate

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

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Metrics
+      module Utils
+        # Helps to calculate code length for the provided node.
+        class CodeLengthCalculator
+          extend NodePattern::Macros
+          include Util
+
+          FOLDABLE_TYPES = %i[array hash heredoc].freeze
+          CLASSISH_TYPES = %i[class module].freeze
+
+          def initialize(node, count_comments: false, foldable_types: [])
+            @node = node
+            @count_comments = count_comments
+            @foldable_checks = build_foldable_checks(foldable_types)
+            @foldable_types = normalize_foldable_types(foldable_types)
+          end
+
+          def calculate
+            length = code_length(@node)
+
+            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)
+                length = length - descendant_length + 1
+              end
+            end
+
+            length
+          end
+
+          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
+              when :array
+                ->(node) { node.array_type? }
+              when :hash
+                ->(node) { node.hash_type? }
+              when :heredoc
+                ->(node) { heredoc_node?(node) }
+              else
+                raise ArgumentError, "Unknown foldable type: #{type.inspect}. "\
+                  "Valid foldable types are: #{FOLDABLE_TYPES.join(', ')}."
+              end
+            end
+          end
+
+          def normalize_foldable_types(types)
+            types.concat(%i[str dstr]) if types.delete(:heredoc)
+            types
+          end
+
+          def code_length(node)
+            return heredoc_length(node) if heredoc_node?(node)
+
+            body = extract_body(node)
+            lines = body&.source&.lines || []
+            lines.count { |line| !irrelevant_line?(line) }
+          end
+
+          def heredoc_node?(node)
+            node.respond_to?(:heredoc?) && node.heredoc?
+          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)
+            node.each_child_node do |child|
+              if types.include?(child.type)
+                yield child
+              else
+                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)))
+          end
+
+          def foldable_node?(node)
+            @foldable_checks.any? { |check| check.call(node) }
+          end
+
+          def extract_body(node)
+            case node.type
+            when :class, :module, :block, :def, :defs
+              node.body
+            when :casgn
+              _scope, _name, value = *node
+              extract_body(value)
+            else
+              node
+            end
+          end
+
+          # Returns true for lines that shall not be included in the count.
+          def irrelevant_line?(source_line)
+            source_line.blank? || !count_comments? && comment_line?(source_line)
+          end
+
+          def count_comments?
+            @count_comments
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Metrics
+      module Utils
+        # Used to identify iterating blocks like `.map{}` and `.map(&:...)`
+        module IteratingBlock
+          enumerable = %i[
+            all? any? chain chunk chunk_while collect collect_concat count cycle
+            detect drop drop_while each each_cons each_entry each_slice
+            each_with_index each_with_object entries filter filter_map find
+            find_all find_index flat_map grep grep_v group_by inject lazy map
+            max max_by min min_by minmax minmax_by none? one? partition reduce
+            reject reverse_each select slice_after slice_before slice_when sort
+            sort_by sum take take_while tally to_h uniq zip
+          ]
+
+          enumerator = %i[with_index with_object]
+
+          array = %i[
+            bsearch bsearch_index collect! combination d_permutation delete_if
+            each_index keep_if map! permutation product reject! repeat
+            repeated_combination select! sort sort! sort_by sort_by
+          ]
+
+          hash = %i[
+            each_key each_pair each_value fetch fetch_values has_key? merge
+            merge! transform_keys transform_keys! transform_values
+            transform_values!
+          ]
+
+          KNOWN_ITERATING_METHODS = (Set.new(enumerable) + enumerator + array + hash).freeze
+
+          # Returns the name of the method called with a block
+          # if node is a block node, or a block-pass node.
+          def block_method_name(node)
+            case node.type
+            when :block
+              node.method_name
+            when :block_pass
+              node.parent.method_name
+            end
+          end
+
+          # Returns true iff name is a known iterating type (e.g. :each, :transform_values)
+          def iterating_method?(name)
+            KNOWN_ITERATING_METHODS.include? name
+          end
+
+          # Returns nil if node is neither a block node or a block-pass node.
+          # Otherwise returns true/false if method call is a known iterating call
+          def iterating_block?(node)
+            name = block_method_name(node)
+            name && iterating_method?(name)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -24,15 +24,15 @@ module RuboCop
 
             offset = Regexp.last_match(1).length
 
-            Regexp.last_match(4).scan(/[^,]+|[\W]+/) do |name|
+            Regexp.last_match(4).scan(/[^,]+|\W+/) do |name|
               trimmed_name = name.strip
 
-              break if contain_plain_comment?(trimmed_name)
-
               unless valid_content_token?(trimmed_name)
                 check_cop_name(trimmed_name, comment, offset)
               end
 
+              break if contain_unexpected_character_for_department_name?(name)
+
               offset += name.length
             end
           end
@@ -64,12 +64,12 @@ module RuboCop
         end
 
         def valid_content_token?(content_token)
-          !/\W+/.match(content_token).nil? ||
-            !DISABLING_COPS_CONTENT_TOKEN.match(content_token).nil?
+          /\W+/.match?(content_token) ||
+            DISABLING_COPS_CONTENT_TOKEN.match?(content_token)
         end
 
-        def contain_plain_comment?(name)
-          name == '#'
+        def contain_unexpected_character_for_department_name?(name)
+          name.match?(%r{[^A-z/, ]})
         end
 
         def qualified_legacy_cop_name(cop_name)

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

@@ -25,9 +25,7 @@ module RuboCop
       end
 
       def check_alignment(items, base_column = nil)
-        unless items.empty?
-          base_column ||= display_column(items.first.source_range)
-        end
+        base_column ||= display_column(items.first.source_range) unless items.empty?
 
         each_bad_alignment(items, base_column) do |current|
           expr = current.source_range

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # This module encapsulates the ability to allow certain methods when
+    # parsing.
+    module AllowedMethods
+      private
+
+      def allowed_method?(name)
+        allowed_methods.include?(name.to_s)
+      end
+
+      def allowed_methods
+        cop_config.fetch('AllowedMethods', [])
+      end
+    end
+  end
+end

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

@@ -48,9 +48,7 @@ module RuboCop
       def smallest_percent_size(style, ary_size)
         @smallest_percent ||= Float::INFINITY
 
-        if style == :percent && ary_size < @smallest_percent
-          @smallest_percent = ary_size
-        end
+        @smallest_percent = ary_size if style == :percent && ary_size < @smallest_percent
 
         @smallest_percent
       end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # extend this module to signal autocorrection support
+    module AutoCorrector
+      def support_autocorrect?
+        true
+      end
+    end
+  end
+end

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

@@ -88,9 +88,7 @@ module RuboCop
         # or redundant edits, we only mark one offense at a time.
         return true if contained_by_breakable_collection_on_same_line?(node)
 
-        if contained_by_multiline_collection_that_could_be_broken_up?(node)
-          return true
-        end
+        return true if contained_by_multiline_collection_that_could_be_broken_up?(node)
 
         false
       end
@@ -141,9 +139,7 @@ module RuboCop
           next unless ancestor.send_type?
 
           args = process_args(ancestor.arguments)
-          if breakable_collection?(ancestor, args)
-            return children_could_be_broken_up?(args)
-          end
+          return children_could_be_broken_up?(args) if breakable_collection?(ancestor, args)
         end
 
         false
@@ -175,9 +171,7 @@ 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)
-          if last_arg.hash_type? && !last_arg.braces?
-            args = args.concat(args.pop.children)
-          end
+          args = args.concat(args.pop.children) if last_arg.hash_type? && !last_arg.braces?
         end
         args
       end