class RuboCop::Cop::Metrics::ClassLength

Checks if the length 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.

@example CountAsOne: ['array', 'heredoc', 'method_call']

class Foo
  ARRAY = [         # +1
    1,
    2
  ]

  HASH = {          # +3
    key: 'value'
  }

  MSG = <<~HEREDOC  # +1
    Heredoc
    content.
  HEREDOC

  foo(              # +1
    1,
    2
  )
end                 # 6 points

NOTE: This cop also applies for `Struct` definitions.

Public Instance Methods

on_casgn(node) click to toggle source

# File lib/rubocop/cop/metrics/class_length.rb, line 46
def on_casgn(node)
  parent = node.parent

  if parent&.assignment?
    block_node = parent.children[1]
  elsif parent&.parent&.masgn_type?
    block_node = parent.parent.children[1]
  else
    _scope, _name, block_node = *node
  end

  return unless block_node.respond_to?(:class_definition?) && block_node.class_definition?

  check_code_length(block_node)
end

on_class(node) click to toggle source

# File lib/rubocop/cop/metrics/class_length.rb, line 42
def on_class(node)
  check_code_length(node)
end

Private Instance Methods

message(length, max_length) click to toggle source

# File lib/rubocop/cop/metrics/class_length.rb, line 64
def message(length, max_length)
  format('Class has too many lines. [%<length>d/%<max>d]', length: length, max: max_length)
end