library/io.github.baole.konture/FunctionsShould

FunctionsShould

class FunctionsShould : FunctionsShouldCallAssertions, FunctionsShouldNameAssertions, FunctionsShouldModifierAssertions, FunctionsShouldSignatureAssertions, FunctionsShouldDependencyAssertions, FunctionsShouldCompositeAssertions

Assertion builder for checking rule expectations on Kotlin function declarations.

Properties

builder

open override val builder: FunctionsRuleBuilder

Filter or assertion criteria for builder.

Functions

allOf

open fun allOf(vararg blocks: FunctionsShould.() -> Unit): FunctionsRuleBuilder

Filter or assertion criteria for all of.

anyOf

open fun anyOf(vararg blocks: FunctionsShould.() -> Unit): FunctionsRuleBuilder

Asserts that selected functions satisfy at least one of the specified assertion blocks.

beAbstract

open fun beAbstract(): FunctionsRuleBuilder

Filter or assertion criteria for be abstract.

beAnnotatedWith

inline fun <T : Annotation> FunctionsShould.beAnnotatedWith(): FunctionsRuleBuilder

Asserts that functions are annotated with the annotation specified by type parameter T.

infix fun FunctionsShould.beAnnotatedWith(annotation: KClass<out Annotation>): FunctionsRuleBuilder

Asserts that functions are annotated with the specified annotation class.

beDocumentedWithKDoc

open fun beDocumentedWithKDoc(): FunctionsRuleBuilder

Filter or assertion criteria for be documented with k doc.

beExtension

open fun beExtension(): FunctionsRuleBuilder

Filter or assertion criteria for be extension.

beInfix

open fun beInfix(): FunctionsRuleBuilder

Filter or assertion criteria for be infix.

beInline

open fun beInline(): FunctionsRuleBuilder

Filter or assertion criteria for be inline.

beInternal

open fun beInternal(): FunctionsRuleBuilder

Filter or assertion criteria for be internal.

beMember

open fun beMember(): FunctionsRuleBuilder

Filter or assertion criteria for be member.

beOpen

open fun beOpen(): FunctionsRuleBuilder

Filter or assertion criteria for be open.

beOperator

open fun beOperator(): FunctionsRuleBuilder

Filter or assertion criteria for be operator.

beOverride

open fun beOverride(): FunctionsRuleBuilder

Filter or assertion criteria for be override.

bePrivate

open fun bePrivate(): FunctionsRuleBuilder

Filter or assertion criteria for be private.

beProtected

open fun beProtected(): FunctionsRuleBuilder

Filter or assertion criteria for be protected.

bePublic

open fun bePublic(): FunctionsRuleBuilder

Filter or assertion criteria for be public.

beSuspend

open fun beSuspend(): FunctionsRuleBuilder

Filter or assertion criteria for be suspend.

beTopLevel

open fun beTopLevel(): FunctionsRuleBuilder

Filter or assertion criteria for be top level.

dependOnPackageOf

open fun dependOnPackageOf(vararg classes: KClass<*>): FunctionsRuleBuilder

Asserts that selected functions depend on package containing classes.

dependOnPackageOf

inline fun <T : Any> FunctionsShould.dependOnPackageOf(): FunctionsRuleBuilder

Asserts that functions depend on package of T.

dependOnPackages

open fun dependOnPackages(vararg patterns: String): FunctionsRuleBuilder

open infix fun dependOnPackages(patterns: List<String>): FunctionsRuleBuilder

Asserts that selected functions depend on types or usages in packages matching patterns.

haveAllAnnotationsOf

open fun haveAllAnnotationsOf(vararg names: String): FunctionsRuleBuilder

open infix fun haveAllAnnotationsOf(names: List<String>): FunctionsRuleBuilder

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

haveAllAnnotationsOf

fun FunctionsShould.haveAllAnnotationsOf(vararg annotations: KClass<out Annotation>): FunctionsRuleBuilder

Asserts that functions have all of the specified annotations.

haveAllModifiers

open fun haveAllModifiers(vararg modifiers: Modifier): FunctionsRuleBuilder

open infix fun haveAllModifiers(modifiers: List<Modifier>): FunctionsRuleBuilder

Asserts that selected functions have all of the specified modifiers.

haveAnnotationOf

open fun haveAnnotationOf(vararg annotationNames: String): FunctionsRuleBuilder

open infix fun haveAnnotationOf(annotationName: String): FunctionsRuleBuilder

open infix fun haveAnnotationOf(annotationNames: List<String>): FunctionsRuleBuilder

Filter or assertion criteria for have annotation of.

haveAnnotationOf

infix fun FunctionsShould.haveAnnotationOf(annotation: KClass<out Annotation>): FunctionsRuleBuilder

Asserts that functions have the specified annotation class.

haveAnnotationOfType

inline fun <T : Annotation> FunctionsShould.haveAnnotationOfType(): FunctionsRuleBuilder

Asserts that functions have the annotation type parameter T.

haveAnnotationWithArgument

open fun haveAnnotationWithArgument(annotationName: String, argName: String? = null, argValue: String): FunctionsRuleBuilder

Filter or assertion criteria for have annotation with argument.

haveAnnotationWithArgument

fun FunctionsShould.haveAnnotationWithArgument(annotation: KClass<out Annotation>, argName: String?, argValue: String): FunctionsRuleBuilder

Asserts that functions have an annotation annotation with an argument argName equal to argValue.

haveAnyAnnotationOf

open fun haveAnyAnnotationOf(vararg names: String): FunctionsRuleBuilder

open infix fun haveAnyAnnotationOf(names: List<String>): FunctionsRuleBuilder

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

haveAnyAnnotationOf

fun FunctionsShould.haveAnyAnnotationOf(vararg annotations: KClass<out Annotation>): FunctionsRuleBuilder

Asserts that functions have any of the specified annotations.

haveAnyModifier

open fun haveAnyModifier(vararg modifiers: Modifier): FunctionsRuleBuilder

open infix fun haveAnyModifier(modifiers: List<Modifier>): FunctionsRuleBuilder

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

haveAnyParameterType

open fun haveAnyParameterType(vararg types: String): FunctionsRuleBuilder

open infix fun haveAnyParameterType(types: List<String>): FunctionsRuleBuilder

Asserts that selected functions have at least one parameter of one of the specified types.

open fun haveAnyParameterType(first: KClass<*>, vararg additional: KClass<*>): FunctionsRuleBuilder

Asserts that selected functions have a parameter of any specified raw type.

haveAnyParameterTypeOf

inline fun <T : Any> FunctionsShould.haveAnyParameterTypeOf(): FunctionsRuleBuilder

Asserts that selected functions have a parameter of raw type T.

haveAnyVisibility

open fun haveAnyVisibility(vararg visibilities: Visibility): FunctionsRuleBuilder

open infix fun haveAnyVisibility(visibilities: List<Visibility>): FunctionsRuleBuilder

Asserts that selected functions have any of the specified visibilities.

haveModifier

open infix fun haveModifier(modifier: Modifier): FunctionsRuleBuilder

Asserts that selected functions contain the specified modifier.

haveName

open fun haveName(vararg names: String): FunctionsRuleBuilder

open infix fun haveName(predicate: (String) -> Boolean): FunctionsRuleBuilder

open infix fun haveName(name: String): FunctionsRuleBuilder

open infix fun haveName(names: List<String>): FunctionsRuleBuilder

Filter or assertion criteria for have name.

haveNameEndingWith

open fun haveNameEndingWith(vararg suffixes: String): FunctionsRuleBuilder

open infix fun haveNameEndingWith(suffix: String): FunctionsRuleBuilder

open infix fun haveNameEndingWith(suffixes: List<String>): FunctionsRuleBuilder

Filter or assertion criteria for have name ending with.

haveNameMatching

open fun haveNameMatching(vararg patterns: String): FunctionsRuleBuilder

open infix fun haveNameMatching(pattern: String): FunctionsRuleBuilder

open infix fun haveNameMatching(patterns: List<String>): FunctionsRuleBuilder

Filter or assertion criteria for have name matching.

haveNameStartingWith

open fun haveNameStartingWith(vararg prefixes: String): FunctionsRuleBuilder

open infix fun haveNameStartingWith(prefix: String): FunctionsRuleBuilder

open infix fun haveNameStartingWith(prefixes: List<String>): FunctionsRuleBuilder

Filter or assertion criteria for have name starting with.

haveNoParameters

open fun haveNoParameters(): FunctionsRuleBuilder

Filter or assertion criteria for have no parameters.

haveParameterTypes

open fun haveParameterTypes(vararg types: String): FunctionsRuleBuilder

open infix fun haveParameterTypes(types: List<String>): FunctionsRuleBuilder

Asserts that selected functions take exactly these parameter types in order (simple or fully qualified).

open fun haveParameterTypes(first: KClass<*>, vararg additional: KClass<*>): FunctionsRuleBuilder

Asserts that selected functions take exactly these raw parameter types in order.

haveReturnType

open fun haveReturnType(vararg typeFqNames: String): FunctionsRuleBuilder

open infix fun haveReturnType(typeFqNames: List<String>): FunctionsRuleBuilder

Filter or assertion criteria for have return type.

open infix fun haveReturnType(typeFqName: String): FunctionsRuleBuilder

Asserts that selected functions have the specified return type fully qualified name typeFqName.

open infix fun haveReturnType(type: KClass<*>): FunctionsRuleBuilder

Asserts that selected functions have the specified raw return type.

haveReturnTypeOf

inline fun <T : Any> FunctionsShould.haveReturnTypeOf(): FunctionsRuleBuilder

Asserts that selected functions have the specified raw return type.

haveVisibility

open infix fun haveVisibility(visibility: Visibility): FunctionsRuleBuilder

Asserts that selected functions have the specified visibility.

noneOf

open fun noneOf(vararg blocks: FunctionsShould.() -> Unit): FunctionsRuleBuilder

Filter or assertion criteria for none of.

notBeAbstract

open fun notBeAbstract(): FunctionsRuleBuilder

Filter or assertion criteria for not be abstract.

notBeExtension

open fun notBeExtension(): FunctionsRuleBuilder

Filter or assertion criteria for not be extension.

notBeInfix

open fun notBeInfix(): FunctionsRuleBuilder

Filter or assertion criteria for not be infix.

notBeInline

open fun notBeInline(): FunctionsRuleBuilder

Filter or assertion criteria for not be inline.

notBeInternal

open fun notBeInternal(): FunctionsRuleBuilder

Filter or assertion criteria for not be internal.

notBeOpen

open fun notBeOpen(): FunctionsRuleBuilder

Filter or assertion criteria for not be open.

notBeOperator

open fun notBeOperator(): FunctionsRuleBuilder

Filter or assertion criteria for not be operator.

notBeOverride

open fun notBeOverride(): FunctionsRuleBuilder

Filter or assertion criteria for not be override.

notBePrivate

open fun notBePrivate(): FunctionsRuleBuilder

Filter or assertion criteria for not be private.

notBeProtected

open fun notBeProtected(): FunctionsRuleBuilder

Filter or assertion criteria for not be protected.

notBePublic

open fun notBePublic(): FunctionsRuleBuilder

Filter or assertion criteria for not be public.

notBeSuspend

open fun notBeSuspend(): FunctionsRuleBuilder

Filter or assertion criteria for not be suspend.

notCall

open fun notCall(fqName: String): FunctionsRuleBuilder

Fails when the selected function invokes fqName.

open fun notCall(kClass: KClass<*>): FunctionsRuleBuilder

Fails when the selected function invokes kClass.

notCall

inline fun <T : Any> FunctionsShouldCallAssertions.notCall(): FunctionsRuleBuilder

Fails when the selected function invokes T.

notDependOnPackageOf

open fun notDependOnPackageOf(vararg classes: KClass<*>): FunctionsRuleBuilder

Asserts that selected functions do not depend on package containing classes.

notDependOnPackageOf

inline fun <T : Any> FunctionsShould.notDependOnPackageOf(): FunctionsRuleBuilder

Asserts that functions do not depend on package of T.

notDependOnPackages

open fun notDependOnPackages(vararg patterns: String): FunctionsRuleBuilder

open infix fun notDependOnPackages(patterns: List<String>): FunctionsRuleBuilder

Asserts that selected functions do not depend on types or usages in packages matching patterns.

notHaveModifier

open infix fun notHaveModifier(modifier: Modifier): FunctionsRuleBuilder

Filter or assertion criteria for not have modifier.

notHaveName

open fun notHaveName(vararg names: String): FunctionsRuleBuilder

open infix fun notHaveName(name: String): FunctionsRuleBuilder

open infix fun notHaveName(names: List<String>): FunctionsRuleBuilder

Filter or assertion criteria for not have name.

notHaveNameEndingWith

open fun notHaveNameEndingWith(vararg suffixes: String): FunctionsRuleBuilder

open infix fun notHaveNameEndingWith(suffix: String): FunctionsRuleBuilder

open infix fun notHaveNameEndingWith(suffixes: List<String>): FunctionsRuleBuilder

Filter or assertion criteria for not have name ending with.

notHaveNameMatching

open fun notHaveNameMatching(vararg patterns: String): FunctionsRuleBuilder

open infix fun notHaveNameMatching(pattern: String): FunctionsRuleBuilder

open infix fun notHaveNameMatching(patterns: List<String>): FunctionsRuleBuilder

Filter or assertion criteria for not have name matching.

notHaveNameStartingWith

open fun notHaveNameStartingWith(vararg prefixes: String): FunctionsRuleBuilder

open infix fun notHaveNameStartingWith(prefix: String): FunctionsRuleBuilder

open infix fun notHaveNameStartingWith(prefixes: List<String>): FunctionsRuleBuilder

Filter or assertion criteria for not have name starting with.

notReferenceClass

open fun notReferenceClass(fqName: String): FunctionsRuleBuilder

Fails for every actual class/type use of fqName in the selected function; imports alone do not match.

open fun notReferenceClass(kClass: KClass<*>): FunctionsRuleBuilder

Fails for every actual class/type use of kClass in the selected function; imports alone do not match.

notReferenceClass

inline fun <T : Any> FunctionsShouldCallAssertions.notReferenceClass(): FunctionsRuleBuilder

Fails for every actual class/type use of T in the selected function.

notResideInAModule

open fun notResideInAModule(vararg modulePaths: String): FunctionsRuleBuilder

open infix fun notResideInAModule(modulePath: String): FunctionsRuleBuilder

open infix fun notResideInAModule(modulePaths: List<String>): FunctionsRuleBuilder

Filter or assertion criteria for not reside in a module.

notResideInModule

open infix fun notResideInModule(modulePath: String): FunctionsRuleBuilder

Filter or assertion criteria for not reside in module.

notResideInModules

open fun notResideInModules(vararg modulePaths: String): FunctionsRuleBuilder

open infix fun notResideInModules(modulePaths: List<String>): FunctionsRuleBuilder

Filter or assertion criteria for not reside in modules.

onlyDependOnPackageOf

open fun onlyDependOnPackageOf(vararg classes: KClass<*>): FunctionsRuleBuilder

Asserts that selected functions only depend on package containing classes.

onlyDependOnPackageOf

inline fun <T : Any> FunctionsShould.onlyDependOnPackageOf(): FunctionsRuleBuilder

Asserts that functions only depend on package of T.

onlyDependOnPackages

open fun onlyDependOnPackages(vararg patterns: String): FunctionsRuleBuilder

open infix fun onlyDependOnPackages(patterns: List<String>): FunctionsRuleBuilder

Asserts that selected functions only depend on types or usages in packages matching patterns.

resideInAModule

open fun resideInAModule(vararg modulePaths: String): FunctionsRuleBuilder

open infix fun resideInAModule(modulePath: String): FunctionsRuleBuilder

open infix fun resideInAModule(modulePaths: List<String>): FunctionsRuleBuilder

Filter or assertion criteria for reside in a module.

resideInAPackage

open fun resideInAPackage(vararg packagePatterns: String): FunctionsRuleBuilder

open infix fun resideInAPackage(predicate: (String) -> Boolean): FunctionsRuleBuilder

open infix fun resideInAPackage(packagePattern: String): FunctionsRuleBuilder

open infix fun resideInAPackage(packagePatterns: List<String>): FunctionsRuleBuilder

Filter or assertion criteria for reside in a package.

resideInModule

open infix fun resideInModule(modulePath: String): FunctionsRuleBuilder

Filter or assertion criteria for reside in module.

resideInModules

open fun resideInModules(vararg modulePaths: String): FunctionsRuleBuilder

open infix fun resideInModules(modulePaths: List<String>): FunctionsRuleBuilder

Filter or assertion criteria for reside in modules.

resideInPackageOf

open infix fun resideInPackageOf(type: KClass<*>): FunctionsRuleBuilder

Filter or assertion criteria for reside in package of.

resideInPackageOf

inline fun <T : Any> FunctionsShould.resideInPackageOf(): FunctionsRuleBuilder

Asserts that functions reside in the package of the type parameter T.

infix fun FunctionsShould.resideInPackageOf(type: KClass<*>): FunctionsRuleBuilder

Asserts that functions reside in the package of the specified type.

satisfy

open infix fun satisfy(assertion: (FunctionDeclarationContext) -> Boolean): FunctionsRuleBuilder

Asserts that selected functions satisfy a custom boolean condition.

open fun satisfy(assertion: (FunctionDeclarationContext, MutableList<String>) -> Unit): FunctionsRuleBuilder

Asserts that selected functions satisfy a custom violation-collecting assertion.

open infix fun satisfy(description: String): FunctionsRuleBuilder

Asserts that selected functions satisfy custom description description.

open fun satisfy(description: String, assertion: (FunctionDeclarationContext, List<FunctionDeclarationContext>) -> Boolean): FunctionsRuleBuilder

Asserts that selected functions satisfy a custom boolean condition with description.

open fun satisfy(id: String, description: String? = null, predicate: SatisfyContext<FunctionDeclarationContext>.(FunctionDeclarationContext) -> Boolean): FunctionsRuleBuilder

Asserts that selected functions satisfy a custom predicate within a SatisfyContext block identified by id and optional description.