Sha256: 508c9732e8b9d10fb9627ee5ab3144ecbd597c1939317c5d19e455f395dc9163
Contents?: true
Size: 1.72 KB
Versions: 23
Compression:
Stored size: 1.72 KB
Contents
# frozen_string_literal: true
module RuboCop
module Cop
module Metrics
# This cop 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 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']
#
# class Foo
# ARRAY = [ # +1
# 1,
# 2
# ]
#
# HASH = { # +3
# key: 'value'
# }
#
# MSG = <<~HEREDOC # +1
# Heredoc
# content.
# HEREDOC
# end # 5 points
#
#
# NOTE: This cop also applies for `Struct` definitions.
class ClassLength < Base
include CodeLength
def on_class(node)
check_code_length(node)
end
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
private
def message(length, max_length)
format('Class has too many lines. [%<length>d/%<max>d]',
length: length,
max: max_length)
end
end
end
end
end
Version data entries
23 entries across 23 versions & 1 rubygems