Document rubocops/class cops.

This commit is contained in:
Markus Reiter 2020-08-26 02:28:17 +02:00
parent 69a0e3fb61
commit 26af3b5807

View File

@ -5,6 +5,9 @@ require "rubocops/extend/formula"
module RuboCop module RuboCop
module Cop module Cop
module FormulaAudit module FormulaAudit
# This cop makes sure that `Formula` is used as superclass.
#
# @api private
class ClassName < FormulaCop class ClassName < FormulaCop
DEPRECATED_CLASSES = %w[ DEPRECATED_CLASSES = %w[
GithubGistFormula GithubGistFormula
@ -26,6 +29,9 @@ module RuboCop
end end
end end
# This cop makes sure that a `test` block contains a proper test.
#
# @api private
class Test < FormulaCop class Test < FormulaCop
def audit_formula(_node, _class_node, _parent_class_node, body_node) def audit_formula(_node, _class_node, _parent_class_node, body_node)
test = find_block(body_node, :test) test = find_block(body_node, :test)
@ -78,7 +84,9 @@ module RuboCop
end end
module FormulaAuditStrict module FormulaAuditStrict
# - `test do ..end` should defined in the formula. # This cop makes sure that a `test` block exists.
#
# @api private
class TestPresent < FormulaCop class TestPresent < FormulaCop
def audit_formula(_node, _class_node, _parent_class_node, body_node) def audit_formula(_node, _class_node, _parent_class_node, body_node)
return if find_block(body_node, :test) return if find_block(body_node, :test)