# frozen_string_literal: true module RuboCop module Cop module Metrics # Checks if the length of a block exceeds some maximum value. # Comment lines can optionally be ignored. # The maximum allowed length is configurable. # The cop can be configured to ignore blocks passed to certain methods. # # 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. # # # NOTE: The `ExcludedMethods` configuration is deprecated and only kept # for backwards compatibility. Please use `IgnoredMethods` instead. # By default, there are no methods to ignored. # # @example CountAsOne: ['array', 'heredoc'] # # something do # array = [ # +1 # 1, # 2 # ] # # hash = { # +3 # key: 'value' # } # # msg = <<~HEREDOC # +1 # Heredoc # content. # HEREDOC # end # 5 points # # NOTE: This cop does not apply for `Struct` definitions. class BlockLength < Base include CodeLength include IgnoredMethods ignored_methods deprecated_key: 'ExcludedMethods' LABEL = 'Block' def on_block(node) return if ignored_method?(node.method_name) return if method_receiver_excluded?(node) return if node.class_constructor? || node.struct_constructor? check_code_length(node) end alias on_numblock on_block private def method_receiver_excluded?(node) node_receiver = node.receiver&.source&.gsub(/\s+/, '') node_method = String(node.method_name) ignored_methods.any? do |config| next unless config.is_a?(String) receiver, method = config.split('.') unless method method = receiver receiver = node_receiver end method == node_method && receiver == node_receiver end end def cop_label LABEL end end end end end