verifyObjectNames: Verify Object Names

In wyz.code.offensiveProgramming: Wizardry Code Offensive Programming

Verify Object Names

Description

Verify object class name, object function names, and object function parameter names, and provides a synthesis of executed checks.

Proceeds also to some introspection on object to identify instrumentation of function return types and test case definitions. Provides information about completeness of instruction, and about missing functions and test cases.

Usage

verifyObjectNames(object_o_1)

Arguments

object_o_1

the object to be checked

Value

A list with following names

class_name	the class name of the provided object.
supports_strict_compliance	a single boolean.
supports_lazy_compliance	a single boolean.
class_name_compliance	a boolean value expression class name compliance
class_name_compliance	a vector of booleans, where names are the function names and values express the name compliance
class_name_compliance	a data.table exposing the name compliance and the semanting name compliance for each paramter
owns_function_return_type_information	a single boolean
can_be_type_checked	a single boolean
is_function_fully_instrumented	a single boolean
missing_function	a vector of uninstrumented function names
owns_test_case_definitions	a single boolean
is_test_case_fully_instrumented	a single boolean
missing_test_cases	a single boolean

Author(s)

Fabien Gelineau <[e-mail]>

Maintainer: Fabien Gelineau <[e-mail]>

See Also

Refer to verifyClassName and verifyFunctionName.

Examples

##---- typical case ----
library('data.table')
source(system.file('code-samples/frt-defs/good/full/AdditionFI.R',
                   package = 'wyz.code.offensiveProgramming'))
fi <- AdditionFI()
print(verifyObjectNames(fi))

wyz.code.offensiveProgramming documentation built on Sept. 25, 2023, 9:05 a.m.