Sha256: b998a0b1fec60e26b899f70d4e517c3a70ca2214624932274326d0f96bce08b2
Contents?: true
Size: 1.61 KB
Versions: 8
Compression:
Stored size: 1.61 KB
Contents
# frozen_string_literal: true
module RuboCop
module Cop
module Metrics
# Checks if the length of a module 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', 'hash', 'heredoc', 'method_call']
#
# module M
# ARRAY = [ # +1
# 1,
# 2
# ]
#
# HASH = { # +1
# key: 'value'
# }
#
# MSG = <<~HEREDOC # +1
# Heredoc
# content.
# HEREDOC
#
# foo( # +1
# 1,
# 2
# )
# end # 4 points
#
class ModuleLength < Base
include CodeLength
def on_module(node)
check_code_length(node)
end
def on_casgn(node)
module_definition?(node) { check_code_length(node) }
end
private
# @!method module_definition?(node)
def_node_matcher :module_definition?, <<~PATTERN
(casgn nil? _ ({block numblock} (send (const {nil? cbase} :Module) :new) ...))
PATTERN
def message(length, max_length)
format('Module has too many lines. [%<length>d/%<max>d]', length: length, max: max_length)
end
end
end
end
end
Version data entries
8 entries across 8 versions & 1 rubygems