library/io.github.baole.konture/SlicesShould

SlicesShould

class SlicesShould(builder: SlicesRuleBuilder)

Assertions that the slices derived by SlicesRuleBuilder must satisfy.

Constructors

Link copied to clipboard
constructor(builder: SlicesRuleBuilder)

Functions

Link copied to clipboard
fun allOf(vararg blocks: SlicesShould.() -> Unit): SlicesRuleBuilder

Asserts that slices satisfy all assertion blocks in blocks.

Link copied to clipboard
fun anyOf(vararg blocks: SlicesShould.() -> Unit): SlicesRuleBuilder

Asserts that slices satisfy at least one assertion block in blocks.

Link copied to clipboard
fun beFreeOfCycles(): SlicesRuleBuilder

Asserts that the slices have no cyclic dependencies between them. Each detected cycle is reported as a path, e.g. payment -> billing -> payment.

Link copied to clipboard
fun containClasses(): SlicesRuleBuilder

Asserts that slices contain classes.

Link copied to clipboard
fun containClassesInPackage(vararg packagePatterns: String): SlicesRuleBuilder

Asserts that slices contain classes in packages matching vararg packagePatterns.

infix fun containClassesInPackage(packagePattern: String): SlicesRuleBuilder

Asserts that slices contain classes in package matching packagePattern.

infix fun containClassesInPackage(packagePatterns: List<String>): SlicesRuleBuilder

Asserts that slices contain classes in packages matching packagePatterns.

Link copied to clipboard
fun containClassesWithAnnotation(vararg annotationFqNames: String): SlicesRuleBuilder

Asserts that slices contain classes with vararg annotations annotationFqNames.

infix fun containClassesWithAnnotation(annotationFqName: String): SlicesRuleBuilder

Asserts that slices contain classes with annotation annotationFqName.

infix fun containClassesWithAnnotation(annotationFqNames: List<String>): SlicesRuleBuilder

Asserts that slices contain classes with annotations annotationFqNames.

infix fun containClassesWithAnnotation(annotation: KClass<out Annotation>): SlicesRuleBuilder

Asserts that slices contain classes with annotation annotation.

Link copied to clipboard
inline fun <T : Annotation> SlicesShould.containClassesWithAnnotation(): SlicesRuleBuilder

Asserts that slices contain classes with annotation type parameter T.

Link copied to clipboard
fun containFiles(): SlicesRuleBuilder

Asserts that slices contain files.

Link copied to clipboard
fun containOnlyClassesWithVisibility(vararg visibilities: Visibility): SlicesRuleBuilder
fun containOnlyClassesWithVisibility(visibilities: List<Visibility>): SlicesRuleBuilder

Asserts that all classes in matching slices have one of the specified visibilities.

Link copied to clipboard
fun containOnlyFunctionsWithVisibility(vararg visibilities: Visibility): SlicesRuleBuilder
fun containOnlyFunctionsWithVisibility(visibilities: List<Visibility>): SlicesRuleBuilder

Asserts that all top-level functions in matching slices have one of the specified visibilities.

Link copied to clipboard
fun containOnlyPropertiesWithVisibility(vararg visibilities: Visibility): SlicesRuleBuilder
fun containOnlyPropertiesWithVisibility(visibilities: List<Visibility>): SlicesRuleBuilder

Asserts that all top-level properties in matching slices have one of the specified visibilities.

Link copied to clipboard
infix fun dependOnSlice(requiredSliceKey: String): SlicesRuleBuilder

Asserts that slices depend on the specified required slice.

Link copied to clipboard
fun dependOnSlices(vararg requiredSliceKeys: String): SlicesRuleBuilder

Asserts that slices depend on all specified required slices.

infix fun dependOnSlices(requiredSliceKeys: List<String>): SlicesRuleBuilder

Asserts that slices depend on required slices in requiredSliceKeys.

Link copied to clipboard
infix fun haveName(namePattern: String): SlicesRuleBuilder

Asserts that slices have key matching namePattern.

Link copied to clipboard
fun noneOf(vararg blocks: SlicesShould.() -> Unit): SlicesRuleBuilder

Asserts that slices satisfy none of the assertion blocks in blocks.

Link copied to clipboard
fun notCall(fqName: String): SlicesRuleBuilder

Fails for every call usage matching fqName in any file contained in the selected slices.

fun notCall(kClass: KClass<*>): SlicesRuleBuilder

Fails for every call usage matching class kClass in any file contained in the selected slices.

Link copied to clipboard
inline fun <T : Any> SlicesShould.notCall(): SlicesRuleBuilder

Asserts that slices do not call members of type parameter T.

Link copied to clipboard
infix fun notContainClass(fqName: String): SlicesRuleBuilder

Asserts that slices do not contain class fqName.

infix fun notContainClass(type: KClass<*>): SlicesRuleBuilder

Asserts that slices do not contain class type.

Link copied to clipboard
inline fun <T : Any> SlicesShould.notContainClass(): SlicesRuleBuilder

Asserts that slices do not contain the class specified by type parameter T.

Link copied to clipboard
fun notContainClasses(): SlicesRuleBuilder

Asserts that slices do not contain classes.

Link copied to clipboard
infix fun notContainClassesInPackage(packagePattern: String): SlicesRuleBuilder

Asserts that slices do not contain classes in package matching packagePattern.

Link copied to clipboard
infix fun notContainClassesWithAnnotation(annotationFqName: String): SlicesRuleBuilder

Asserts that slices do not contain classes with annotation annotationFqName.

infix fun notContainClassesWithAnnotation(annotation: KClass<out Annotation>): SlicesRuleBuilder

Asserts that slices do not contain classes with annotation annotation.

Link copied to clipboard
inline fun <T : Annotation> SlicesShould.notContainClassesWithAnnotation(): SlicesRuleBuilder

Asserts that slices do not contain classes annotated with annotation type parameter T.

Link copied to clipboard
fun notContainFiles(): SlicesRuleBuilder

Asserts that slices do not contain files.

Link copied to clipboard
fun notDependOnEachOther(): SlicesRuleBuilder

Asserts that no slice depends on any other slice — enforcing complete isolation between them. Every inter-slice dependency is reported.

Link copied to clipboard
infix fun notDependOnSlice(forbiddenSliceKey: String): SlicesRuleBuilder

Asserts that slices do not depend on the specified forbidden slice.

Link copied to clipboard
fun notDependOnSlices(vararg forbiddenSliceKeys: String): SlicesRuleBuilder
infix fun notDependOnSlices(forbiddenSliceKeys: List<String>): SlicesRuleBuilder

Asserts that slices do not depend on any of the specified forbidden slices.

Link copied to clipboard
infix fun notHaveName(namePattern: String): SlicesRuleBuilder

Asserts that slices do not have key matching namePattern.

Link copied to clipboard
fun notReferenceClass(fqName: String): SlicesRuleBuilder

Fails for every class reference usage matching fqName in any file contained in the selected slices.

fun notReferenceClass(kClass: KClass<*>): SlicesRuleBuilder

Fails for every class reference usage matching kClass in any file contained in the selected slices.

Link copied to clipboard
inline fun <T : Any> SlicesShould.notReferenceClass(): SlicesRuleBuilder

Asserts that slices do not reference class type parameter T.

Link copied to clipboard
infix fun notResideInModule(modulePath: String): SlicesRuleBuilder

Asserts that slices do not reside in module modulePath.

Link copied to clipboard
fun notResideInModules(vararg modulePaths: String): SlicesRuleBuilder

Asserts that slices do not reside in vararg modules modulePaths.

infix fun notResideInModules(modulePaths: List<String>): SlicesRuleBuilder

Asserts that slices do not reside in modules modulePaths.

Link copied to clipboard
fun onlyDependOnSlices(vararg allowedSliceKeys: String): SlicesRuleBuilder

Asserts that slices depend only on the specified allowed slices vararg.

fun onlyDependOnSlices(allowedSliceKeys: List<String>): SlicesRuleBuilder

Asserts that slices depend only on the specified allowed slices.

Link copied to clipboard
infix fun resideInModule(modulePath: String): SlicesRuleBuilder

Asserts that slices reside in module modulePath.

Link copied to clipboard
fun resideInModules(vararg modulePaths: String): SlicesRuleBuilder

Asserts that slices reside in vararg modules modulePaths.

infix fun resideInModules(modulePaths: List<String>): SlicesRuleBuilder

Asserts that slices reside in modules modulePaths.

Link copied to clipboard
infix fun satisfy(description: String): SlicesRuleBuilder

Asserts that slices satisfy custom description description.

fun satisfy(id: String, description: String? = null, predicate: SatisfyContext<List<Slice>>.(List<Slice>) -> Boolean): SlicesRuleBuilder

Asserts that the derived slices satisfy a custom predicate within a SatisfyContext block identified by id and optional description.