Add dokka to generate documentation for the project (#56)

Author: mattmook

build.gradle.kts

@@ -15,12 +15,12 @@
  */
 
 import com.android.build.gradle.internal.tasks.factory.dependsOn
-import com.github.benmanes.gradle.versions.updates.DependencyUpdatesTask
+import org.jetbrains.dokka.gradle.DokkaTask
 
 plugins {
-    id("com.github.ben-manes.versions") version "0.28.0"
-    id("io.gitlab.arturbosch.detekt") version "1.9.1"
+    id("io.gitlab.arturbosch.detekt") version "1.10.0"
     id("com.appmattus.markdown") version "0.6.0"
+    id("org.jetbrains.dokka") version "0.10.1"
 }
 
 buildscript {
@@ -34,6 +34,7 @@ buildscript {
     }
 }
 
+apply(from = "$rootDir/gradle/scripts/dependencyUpdates.gradle.kts")
 apply(from = "$rootDir/owaspDependencyCheck.gradle.kts")
 apply<JacocoPlugin>()
 
@@ -50,24 +51,8 @@ task("clean", type = Delete::class) {
     delete(rootProject.buildDir)
 }
 
-tasks.withType(DependencyUpdatesTask::class.java).all {
-    resolutionStrategy {
-        componentSelection {
-            all {
-                val rejected = listOf("alpha", "beta", "rc", "cr", "m", "preview")
-                    .map { qualifier -> Regex("(?i).*[.-]$qualifier[.\\d-]*") }
-                    .any { it.matches(candidate.version) }
-
-                if (rejected) {
-                    reject("Release candidate")
-                }
-            }
-        }
-    }
-}
-
 dependencies {
-    detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:1.9.1")
+    detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:1.10.0")
 }
 
 detekt {
@@ -95,7 +80,29 @@ val jacocoTestReport by tasks.registering(JacocoReport::class) {
     }
 }
 
-tasks.register("check").dependsOn(jacocoTestReport)
+val dokka = tasks.named<DokkaTask>("dokka") {
+    outputFormat = "html"
+    outputDirectory = "$buildDir/reports/dokka"
+
+    subProjects = listOf(
+        "fixture",
+        "fixture-generex",
+        "fixture-javafaker",
+        "fixture-kotest"
+    )
+
+    configuration {
+        skipDeprecated = true
+
+        sourceLink {
+            path = "$rootDir"
+            url = "https://github.com/appmattus/kotlinfixture/blob/master/"
+            lineSuffix = "#L"
+        }
+    }
+}
+
+tasks.register("check").dependsOn(jacocoTestReport).dependsOn(dokka)
 
 subprojects {
     plugins.withType<JacocoPlugin> {

fixture-android-tests/build.gradle.kts

@@ -58,7 +58,9 @@ dependencies {
     testImplementation("androidx.test:core:1.2.0")
     testImplementation("androidx.test:runner:1.2.0")
     testImplementation("androidx.test.ext:junit:1.1.1")
-    testImplementation("org.robolectric:robolectric:4.3.1")
+    testImplementation("org.robolectric:robolectric:4.3.1") {
+        exclude(group = "com.google.auto.service", module = "auto-service")
+    }
 
     testImplementation("junit:junit:4.13")
     testImplementation(kotlin("test"))

fixture-generex/src/main/kotlin/com/appmattus/kotlinfixture/config/GeneratorString.kt

@@ -19,7 +19,7 @@ package com.appmattus.kotlinfixture.config
 import com.mifmif.common.regex.Generex
 
 /**
- * # Generate a random string from a regular expression
+ * Generate a random string from a regular expression
  *
  * ```
  * data class DataClass(val index: String, val value: String)
@@ -45,7 +45,7 @@ fun Generator<String>.regexToRandom(regex: String, minLength: Int = 1, maxLength
 }
 
 /**
- * # Generate a random string from a regular expression
+ * Generate a random string from a regular expression
  *
  * ```
  * data class DataClass(val index: String, val value: String)

fixture-javafaker/src/main/kotlin/com/appmattus/kotlinfixture/decorator/fake/javafaker/JavaFakerConfiguration.kt

@@ -30,7 +30,7 @@ import java.time.temporal.ChronoUnit
 import java.util.Locale
 
 /**
- * Configuration for the [JavaFakerStrategy]
+ * Configuration for the JavaFakerStrategy
  */
 data class JavaFakerConfiguration internal constructor(
     internal val creditCard: CreditCard = CreditCard.Any,
@@ -235,7 +235,7 @@ data class JavaFakerConfiguration internal constructor(
 }
 
 /**
- * # Fake object generation with `javaFakerStrategy`
+ * Fake object generation with `javaFakerStrategy`
  *
  * The faker intercepts the generation of named properties so their values can be replaced with fake data generated by
  * the [Java Faker](https://github.com/DiUS/java-faker) library

fixture-kotest/build.gradle.kts

@@ -27,7 +27,7 @@ apply(from = "$rootDir/gradle/scripts/jacoco.gradle.kts")
 dependencies {
     api(kotlin("stdlib-jdk8"))
     api(project(":fixture"))
-    api("io.kotest:kotest-property-jvm:4.0.6")
+    api("io.kotest:kotest-property-jvm:4.1.1")
 
     testImplementation("junit:junit:4.13")
     testImplementation(kotlin("test"))

fixture-kotest/src/main/kotlin/com/appmattus/kotlinfixture/kotest/ForAllExt.kt

@@ -29,7 +29,7 @@ import io.kotest.property.internal.proptest
 // 1 parameter
 
 /**
- * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true [forAll].
+ * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true `forAll`.
  */
 suspend inline fun <reified A> Fixture.forAll(
     crossinline function: suspend PropertyContext.(a: A) -> Boolean
@@ -38,7 +38,7 @@ suspend inline fun <reified A> Fixture.forAll(
 }
 
 /**
- * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true [forAll].
+ * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true `forAll`.
  */
 suspend inline fun <reified A> Fixture.forAll(
     iterations: Int,
@@ -48,7 +48,7 @@ suspend inline fun <reified A> Fixture.forAll(
 }
 
 /**
- * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true [forAll].
+ * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true `forAll`.
  */
 suspend inline fun <reified A> Fixture.forAll(
     config: PropTestConfig,
@@ -58,7 +58,7 @@ suspend inline fun <reified A> Fixture.forAll(
 }
 
 /**
- * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true [forAll].
+ * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true `forAll`.
  */
 suspend inline fun <reified A> Fixture.forAll(
     iterations: Int,
@@ -71,30 +71,30 @@ suspend inline fun <reified A> Fixture.forAll(
 // 2 parameters
 
 /**
- * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true [forAll].
+ * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true `forAll`.
  */
 suspend inline fun <reified A, reified B> Fixture.forAll(
     noinline function: suspend PropertyContext.(a: A, b: B) -> Boolean
 ) = forAll(kotestGen(), kotestGen(), function)
 
 /**
- * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true [forAll].
+ * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true `forAll`.
  */
 suspend inline fun <reified A, reified B> Fixture.forAll(
     iterations: Int,
     noinline function: suspend PropertyContext.(a: A, b: B) -> Boolean
 ) = forAll(iterations, kotestGen(), kotestGen(), function)
 
 /**
- * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true [forAll].
+ * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true `forAll`.
  */
 suspend inline fun <reified A, reified B> Fixture.forAll(
     config: PropTestConfig,
     noinline function: suspend PropertyContext.(a: A, b: B) -> Boolean
 ) = forAll(config, kotestGen(), kotestGen(), function)
 
 /**
- * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true [forAll].
+ * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true `forAll`.
  */
 suspend inline fun <reified A, reified B> Fixture.forAll(
     iterations: Int,
@@ -105,30 +105,30 @@ suspend inline fun <reified A, reified B> Fixture.forAll(
 // 3 parameters
 
 /**
- * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true [forAll].
+ * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true `forAll`.
  */
 suspend inline fun <reified A, reified B, reified C> Fixture.forAll(
     noinline function: suspend PropertyContext.(a: A, b: B, c: C) -> Boolean
 ) = forAll(kotestGen(), kotestGen(), kotestGen(), function)
 
 /**
- * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true [forAll].
+ * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true `forAll`.
  */
 suspend inline fun <reified A, reified B, reified C> Fixture.forAll(
     iterations: Int,
     noinline function: suspend PropertyContext.(a: A, b: B, c: C) -> Boolean
 ) = forAll(iterations, kotestGen(), kotestGen(), kotestGen(), function)
 
 /**
- * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true [forAll].
+ * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true `forAll`.
  */
 suspend inline fun <reified A, reified B, reified C> Fixture.forAll(
     config: PropTestConfig,
     noinline function: suspend PropertyContext.(a: A, b: B, c: C) -> Boolean
 ) = forAll(config, kotestGen(), kotestGen(), kotestGen(), function)
 
 /**
- * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true [forAll].
+ * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true `forAll`.
  */
 suspend inline fun <reified A, reified B, reified C> Fixture.forAll(
     iterations: Int,
@@ -139,30 +139,30 @@ suspend inline fun <reified A, reified B, reified C> Fixture.forAll(
 // 4 parameters
 
 /**
- * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true [forAll].
+ * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true `forAll`.
  */
 suspend inline fun <reified A, reified B, reified C, reified D> Fixture.forAll(
     noinline function: suspend PropertyContext.(a: A, b: B, c: C, d: D) -> Boolean
 ) = forAll(kotestGen(), kotestGen(), kotestGen(), kotestGen(), function)
 
 /**
- * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true [forAll].
+ * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true `forAll`.
  */
 suspend inline fun <reified A, reified B, reified C, reified D> Fixture.forAll(
     iterations: Int,
     noinline function: suspend PropertyContext.(a: A, b: B, c: C, d: D) -> Boolean
 ) = forAll(iterations, kotestGen(), kotestGen(), kotestGen(), kotestGen(), function)
 
 /**
- * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true [forAll].
+ * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true `forAll`.
  */
 suspend inline fun <reified A, reified B, reified C, reified D> Fixture.forAll(
     config: PropTestConfig,
     noinline function: suspend PropertyContext.(a: A, b: B, c: C, d: D) -> Boolean
 ) = forAll(config, kotestGen(), kotestGen(), kotestGen(), kotestGen(), function)
 
 /**
- * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true [forAll].
+ * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true `forAll`.
  */
 suspend inline fun <reified A, reified B, reified C, reified D> Fixture.forAll(
     iterations: Int,
@@ -173,30 +173,30 @@ suspend inline fun <reified A, reified B, reified C, reified D> Fixture.forAll(
 // 5 parameters
 
 /**
- * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true [forAll].
+ * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true `forAll`.
  */
 suspend inline fun <reified A, reified B, reified C, reified D, reified E> Fixture.forAll(
     noinline function: suspend PropertyContext.(a: A, b: B, c: C, d: D, e: E) -> Boolean
 ) = forAll(kotestGen(), kotestGen(), kotestGen(), kotestGen(), kotestGen(), function)
 
 /**
- * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true [forAll].
+ * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true `forAll`.
  */
 suspend inline fun <reified A, reified B, reified C, reified D, reified E> Fixture.forAll(
     iterations: Int,
     noinline function: suspend PropertyContext.(a: A, b: B, c: C, d: D, e: E) -> Boolean
 ) = forAll(iterations, kotestGen(), kotestGen(), kotestGen(), kotestGen(), kotestGen(), function)
 
 /**
- * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true [forAll].
+ * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true `forAll`.
  */
 suspend inline fun <reified A, reified B, reified C, reified D, reified E> Fixture.forAll(
     config: PropTestConfig,
     noinline function: suspend PropertyContext.(a: A, b: B, c: C, d: D, e: E) -> Boolean
 ) = forAll(config, kotestGen(), kotestGen(), kotestGen(), kotestGen(), kotestGen(), function)
 
 /**
- * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true [forAll].
+ * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true `forAll`.
  */
 suspend inline fun <reified A, reified B, reified C, reified D, reified E> Fixture.forAll(
     iterations: Int,
@@ -207,30 +207,30 @@ suspend inline fun <reified A, reified B, reified C, reified D, reified E> Fixtu
 // 6 parameters
 
 /**
- * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true [forAll].
+ * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true `forAll`.
  */
 suspend inline fun <reified A, reified B, reified C, reified D, reified E, reified F> Fixture.forAll(
     noinline function: suspend PropertyContext.(a: A, b: B, c: C, d: D, e: E, f: F) -> Boolean
 ) = forAll(kotestGen(), kotestGen(), kotestGen(), kotestGen(), kotestGen(), kotestGen(), function)
 
 /**
- * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true [forAll].
+ * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true `forAll`.
  */
 suspend inline fun <reified A, reified B, reified C, reified D, reified E, reified F> Fixture.forAll(
     iterations: Int,
     noinline function: suspend PropertyContext.(a: A, b: B, c: C, d: D, e: E, f: F) -> Boolean
 ) = forAll(iterations, kotestGen(), kotestGen(), kotestGen(), kotestGen(), kotestGen(), kotestGen(), function)
 
 /**
- * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true [forAll].
+ * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true `forAll`.
  */
 suspend inline fun <reified A, reified B, reified C, reified D, reified E, reified F> Fixture.forAll(
     config: PropTestConfig,
     noinline function: suspend PropertyContext.(a: A, b: B, c: C, d: D, e: E, f: F) -> Boolean
 ) = forAll(config, kotestGen(), kotestGen(), kotestGen(), kotestGen(), kotestGen(), kotestGen(), function)
 
 /**
- * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true [forAll].
+ * Use [Fixture] to generate random objects for type parameters and validate the [function] returns true `forAll`.
  */
 suspend inline fun <reified A, reified B, reified C, reified D, reified E, reified F> Fixture.forAll(
     iterations: Int,

fixture-kotest/src/main/kotlin/com/appmattus/kotlinfixture/kotest/KotestGenerator.kt

@@ -22,5 +22,6 @@ import io.kotest.property.arbitrary.arb
 
 /**
  * Creates a new [Arb] that performs no shrinking, and generates values for the given type, [T].
+ * @suppress
  */
 inline fun <reified T> Fixture.kotestGen() = arb { asSequence<T>() }

fixture/build.gradle.kts

@@ -26,7 +26,7 @@ apply(from = "$rootDir/gradle/scripts/jacoco.gradle.kts")
 
 dependencies {
     api(kotlin("stdlib-jdk8"))
-    api("io.github.classgraph:classgraph:4.8.80")
+    api("io.github.classgraph:classgraph:4.8.87")
     api(kotlin("reflect"))
 
     compileOnly("joda-time:joda-time:2.10.6")

fixture/src/main/kotlin/com/appmattus/kotlinfixture/Context.kt

@@ -39,5 +39,6 @@ interface Context {
 
 /**
  * Return the configuration for a given strategy or [default] if none is found
+ * @suppress
  */
 inline fun <reified T> Context.strategyOrDefault(default: T): T = configuration.strategies[T::class] as? T ?: default

fixture/src/main/kotlin/com/appmattus/kotlinfixture/KotlinFixture.kt

@@ -96,6 +96,7 @@ class Fixture @JvmOverloads constructor(val fixtureConfiguration: Configuration
 }
 
 /**
- * Create a [Fixture] with configuration
+ * Create a [Fixture] with [configuration]
  */
-fun kotlinFixture(init: ConfigurationBuilder.() -> Unit = {}) = Fixture(ConfigurationBuilder().apply(init).build())
+fun kotlinFixture(configuration: ConfigurationBuilder.() -> Unit = {}) =
+    Fixture(ConfigurationBuilder().apply(configuration).build())