class RuboCop::Cop::Metrics::ClassLength
Checks if the length of a class exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.
You can set constructs you want to fold with ‘CountAsOne`.
Available are: ‘array’, ‘hash’, ‘heredoc’, and ‘method_call’. Each construct will be counted as one line regardless of its actual size.
NOTE: This cop also applies for ‘Struct` definitions.
@example CountAsOne: [‘array’, ‘hash’, ‘heredoc’, ‘method_call’]
class Foo ARRAY = [ # +1 1, 2 ] HASH = { # +1 key: 'value' } MSG = <<~HEREDOC # +1 Heredoc content. HEREDOC foo( # +1 1, 2 ) end # 4 points
Public Instance Methods
Source
# File lib/rubocop/cop/metrics/class_length.rb, line 53 def on_casgn(node) block_node = node.expression || find_expression_within_parent(node.parent) return unless block_node.respond_to?(:class_definition?) && block_node.class_definition? check_code_length(block_node) end
Source
# File lib/rubocop/cop/metrics/class_length.rb, line 43 def on_class(node) check_code_length(node) end
Source
# File lib/rubocop/cop/metrics/class_length.rb, line 47 def on_sclass(node) return if node.each_ancestor(:class).any? on_class(node) end
Private Instance Methods
Source
# File lib/rubocop/cop/metrics/class_length.rb, line 67 def find_expression_within_parent(parent) if parent&.assignment? parent.expression elsif parent&.parent&.masgn_type? parent.parent.expression end end
Source
# File lib/rubocop/cop/metrics/class_length.rb, line 63 def message(length, max_length) format('Class has too many lines. [%<length>d/%<max>d]', length: length, max: max_length) end