library/io.github.baole.konture/ClassesShould

ClassesShould

class ClassesShould

Fluent API for defining assertion rules on Kotlin classes.

Functions

Link copied to clipboard
fun allFunctions(block: FunctionAssertionScope.() -> Unit): ClassesRuleBuilder

Asserts that all member functions in selected classes satisfy the assertions specified in the block.

Link copied to clipboard
fun allOf(vararg blocks: ClassesShould.() -> Unit): ClassesRuleBuilder

Asserts that all of the nested assertion blocks are satisfied.

Link copied to clipboard
fun allProperties(block: PropertyAssertionScope.() -> Unit): ClassesRuleBuilder

Asserts that all member properties in selected classes satisfy the assertions specified in the block.

Link copied to clipboard
fun anyOf(vararg blocks: ClassesShould.() -> Unit): ClassesRuleBuilder

Asserts that at least one of the nested assertion blocks is satisfied.

Link copied to clipboard
fun beAbstract(): ClassesRuleBuilder

Asserts that selected classes are abstract classes.

Link copied to clipboard
infix fun beAssignableTo(superType: String): ClassesRuleBuilder

Asserts that selected classes extend or implement specified supertype.

Link copied to clipboard
fun beAssignableToAllOf(vararg superTypes: String): ClassesRuleBuilder
infix fun beAssignableToAllOf(superTypes: List<String>): ClassesRuleBuilder

Asserts that selected classes are assignable to all of the specified supertypes.

infix fun beAssignableToAllOf(superType: String): ClassesRuleBuilder

Asserts that selected classes are assignable to specified supertype.

Link copied to clipboard
fun beAssignableToAnyOf(vararg superTypes: String): ClassesRuleBuilder
infix fun beAssignableToAnyOf(superTypes: List<String>): ClassesRuleBuilder

Asserts that selected classes are assignable to any of the specified supertypes.

infix fun beAssignableToAnyOf(superType: String): ClassesRuleBuilder

Asserts that selected classes are assignable to specified supertype.

Link copied to clipboard
fun beData(): ClassesRuleBuilder

Asserts that selected classes are data classes.

Link copied to clipboard
fun beDocumentedWithKDoc(): ClassesRuleBuilder

Asserts that selected classes have KDoc documentation.

Link copied to clipboard
fun beEnums(): ClassesRuleBuilder

Asserts that selected classes are enum classes.

Link copied to clipboard
fun beInline(): ClassesRuleBuilder

Asserts that selected classes are inline/value classes.

Link copied to clipboard
fun beInterfaces(): ClassesRuleBuilder

Asserts that selected classes are interface definitions.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun beSealed(): ClassesRuleBuilder

Asserts that selected classes are sealed.

Link copied to clipboard
fun haveAllAnnotationsOf(vararg names: String): ClassesRuleBuilder
infix fun haveAllAnnotationsOf(names: List<String>): ClassesRuleBuilder

Asserts that selected classes are annotated with all of the specified annotations.

infix fun haveAllAnnotationsOf(name: String): ClassesRuleBuilder

Asserts that selected classes are annotated with the specified annotation. Matches either simple names or FQNs.

Link copied to clipboard
infix fun haveAllModifiers(modifier: Modifier): ClassesRuleBuilder

Asserts that selected classes have the specified modifier.

fun haveAllModifiers(vararg modifiers: Modifier): ClassesRuleBuilder
infix fun haveAllModifiers(modifiers: List<Modifier>): ClassesRuleBuilder

Asserts that selected classes have all of the specified modifiers.

Link copied to clipboard
infix fun haveAnnotationOf(annotationFqName: String): ClassesRuleBuilder

Asserts that selected classes are annotated with the specified annotation. Matches either the annotation's simple name or its FQN.

Link copied to clipboard
fun haveAnnotationWithArgument(annotationName: String, argName: String?, argValue: String): ClassesRuleBuilder

Asserts that selected classes have the specified annotation with a matching argument name and value.

Link copied to clipboard
fun haveAnyAnnotationOf(vararg names: String): ClassesRuleBuilder
infix fun haveAnyAnnotationOf(names: List<String>): ClassesRuleBuilder

Asserts that selected classes are annotated with any of the specified annotations.

infix fun haveAnyAnnotationOf(name: String): ClassesRuleBuilder

Asserts that selected classes are annotated with the specified annotation. Matches either simple names or FQNs.

Link copied to clipboard
infix fun haveAnyModifier(modifier: Modifier): ClassesRuleBuilder

Asserts that selected classes have the specified modifier.

fun haveAnyModifier(vararg modifiers: Modifier): ClassesRuleBuilder
infix fun haveAnyModifier(modifiers: List<Modifier>): ClassesRuleBuilder

Asserts that selected classes have at least one of the specified modifiers.

Link copied to clipboard
infix fun haveAnyVisibility(visibility: Visibility): ClassesRuleBuilder

Asserts that selected classes have specified visibility.

fun haveAnyVisibility(vararg visibilities: Visibility): ClassesRuleBuilder
infix fun haveAnyVisibility(visibilities: List<Visibility>): ClassesRuleBuilder

Asserts that selected classes have any of the specified visibilities.

Link copied to clipboard
infix fun haveModifier(modifier: Modifier): ClassesRuleBuilder

Asserts that selected classes have specified modifier.

Link copied to clipboard
infix fun haveName(predicate: (String) -> Boolean): ClassesRuleBuilder
fun haveName(description: String, predicate: (String) -> Boolean): ClassesRuleBuilder

Asserts that selected classes have simple names matching the specified predicate.

Link copied to clipboard
fun haveNameEndingWith(vararg suffixes: String): ClassesRuleBuilder
infix fun haveNameEndingWith(suffixes: List<String>): ClassesRuleBuilder

Asserts that selected classes have simple names ending with any of the specified suffixes.

infix fun haveNameEndingWith(suffix: String): ClassesRuleBuilder

Asserts that selected classes have simple names ending with the specified suffix.

Link copied to clipboard
fun haveNameMatching(vararg patterns: String): ClassesRuleBuilder
infix fun haveNameMatching(patterns: List<String>): ClassesRuleBuilder

Asserts that selected classes have simple names matching any of the specified glob patterns. Supports '*' wildcards.

infix fun haveNameMatching(pattern: String): ClassesRuleBuilder

Asserts that selected classes have simple names matching the specified glob pattern. Supports '*' wildcards.

Link copied to clipboard
fun haveNameStartingWith(vararg prefixes: String): ClassesRuleBuilder
infix fun haveNameStartingWith(prefixes: List<String>): ClassesRuleBuilder

Asserts that selected classes have simple names starting with any of the specified prefixes.

infix fun haveNameStartingWith(prefix: String): ClassesRuleBuilder

Asserts that selected classes have simple names starting with the specified prefix.

Link copied to clipboard
infix fun haveVisibility(visibility: Visibility): ClassesRuleBuilder

Asserts that selected classes have specified visibility.

Link copied to clipboard
fun noneOf(vararg blocks: ClassesShould.() -> Unit): ClassesRuleBuilder

Asserts that none of the nested assertion blocks are satisfied.

Link copied to clipboard
fun notDependOnClassesInAnyPackage(vararg packagePatterns: String): ClassesRuleBuilder
infix fun notDependOnClassesInAnyPackage(packagePatterns: List<String>): ClassesRuleBuilder

Asserts that selected classes do not depend on classes residing in packages matching the specified patterns.

infix fun notDependOnClassesInAnyPackage(packagePattern: String): ClassesRuleBuilder

Asserts that selected classes do not depend on classes residing in packages matching the specified pattern.

Link copied to clipboard
fun notHaveSignaturesWithTypesAnnotatedWith(vararg annotationNames: String): ClassesRuleBuilder

Asserts that selected classes do not expose types annotated with the specified annotations in their property, function return, or parameter signatures.

infix fun notHaveSignaturesWithTypesAnnotatedWith(annotationName: String): ClassesRuleBuilder

Asserts that selected classes do not expose types annotated with the specified annotation in their property, function return, or parameter signatures.

infix fun notHaveSignaturesWithTypesAnnotatedWith(annotationNames: List<String>): ClassesRuleBuilder

Asserts that selected classes do not expose types annotated with any of the specified annotations in their property, function return, or parameter signatures.

Link copied to clipboard
fun onlyBeAccessedByAnyPackage(vararg packagePatterns: String): ClassesRuleBuilder
infix fun onlyBeAccessedByAnyPackage(packagePatterns: List<String>): ClassesRuleBuilder

Asserts that selected classes are accessed only by classes residing in packages matching the specified patterns.

infix fun onlyBeAccessedByAnyPackage(packagePattern: String): ClassesRuleBuilder

Asserts that selected classes are accessed only by classes residing in packages matching the specified pattern.

Link copied to clipboard
fun onlyDependOnClassesInAnyPackage(vararg packagePatterns: String): ClassesRuleBuilder
infix fun onlyDependOnClassesInAnyPackage(packagePatterns: List<String>): ClassesRuleBuilder

Asserts that selected classes depend only on classes residing in packages matching the specified patterns.

infix fun onlyDependOnClassesInAnyPackage(packagePattern: String): ClassesRuleBuilder

Asserts that selected classes depend only on classes residing in packages matching the specified pattern.

Link copied to clipboard
fun resideInAPackage(vararg packagePatterns: String): ClassesRuleBuilder
infix fun resideInAPackage(packagePatterns: List<String>): ClassesRuleBuilder

Asserts that selected classes reside in packages matching any of the specified patterns. Supports .. segment wildcards.

infix fun resideInAPackage(predicate: (String) -> Boolean): ClassesRuleBuilder
fun resideInAPackage(description: String, predicate: (String) -> Boolean): ClassesRuleBuilder

Asserts that selected classes reside in packages matching the specified predicate.

infix fun resideInAPackage(packagePattern: String): ClassesRuleBuilder

Asserts that selected classes reside in packages matching the specified pattern. Supports .. segment wildcards.

Link copied to clipboard
infix fun satisfy(assertion: (ClassDeclaration) -> Boolean): ClassesRuleBuilder
infix fun satisfy(description: String): ClassesRuleBuilder

Asserts that selected classes satisfy a custom condition.

fun satisfy(assertion: (ClassDeclaration, MutableList<String>) -> Unit): ClassesRuleBuilder

Satisfies an arbitrary custom assertion logic with custom violations builder.