Sha256: c4b91ea5c7141eea5ff7107d62f529313dd0fa844e6092980f08f4d6a707c82c
Contents?: true
Size: 1.88 KB
Versions: 10
Compression:
Stored size: 1.88 KB
Contents
# frozen_string_literal: true
module RuboCop
module Cop
module Metrics
# This cop 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.
#
# @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
LABEL = 'Block'
def on_block(node)
return if excluded_method?(node)
return if node.class_constructor? || node.struct_constructor?
check_code_length(node)
end
private
def excluded_method?(node)
node_receiver = node.receiver&.source&.gsub(/\s+/, '')
node_method = String(node.method_name)
excluded_methods.any? do |config|
receiver, method = config.split('.')
unless method
method = receiver
receiver = node_receiver
end
method == node_method && receiver == node_receiver
end
end
def excluded_methods
cop_config['ExcludedMethods'] || []
end
def cop_label
LABEL
end
end
end
end
end
Version data entries
10 entries across 10 versions & 1 rubygems