Support for javafaker library (#47)

Author: mattmook

README.md

@@ -14,6 +14,9 @@ testImplementation("com.appmattus.fixture:fixture:<latest-version>")
 
 // Add for Kotest integration
 testImplementation("com.appmattus.fixture:fixture-kotest:<latest-version>")
+
+// Add for Java Faker integration
+testImplementation("com.appmattus.fixture:fixture-javafaker:<latest-version>")
 ```
 
 Simply create a fixture and invoke it with the type to be generated:
@@ -415,6 +418,53 @@ fixture.checkAll { person1: Person, person2: Person ->
 }
 ```
 
+## Java Faker support
+
+The [Java Faker](http://dius.github.io/java-faker/) library generates
+fake data, useful if you need to generate objects with pretty data.
+
+Including the `fixture-javafaker` dependency in your project adds a
+`javaFakerStrategy` which will use
+[Java Faker](http://dius.github.io/java-faker/) to populate named
+properties such as `name`, `city` and `phoneNumber`. A full list of
+supported properties and how they map to
+[Java Faker](http://dius.github.io/java-faker/) can be found in
+[JavaFakerConfiguration](fixture-javafaker/src/main/kotlin/com/appmattus/kotlinfixture/decorator/fake/javafaker/JavaFakerConfiguration.kt).
+
+Additionally, the `javaFakerStrategy` function allows you to override
+faker settings such as `locale`.
+
+```kotlin
+
+val fixture = kotlinFixture {
+    javaFakerStrategy()
+}
+
+data class Person(val name: String, val age: Long)
+
+println(fixture<Person>()) // Person(name=Keneth Bartoletti, age=54)
+```
+
+### Regex to String generation
+
+The module also introduces the ability to generate a random string from
+a Regex, with no need to enable the faker functionality:
+
+```kotlin
+        data class DataClass(val index: String, val value: String)
+
+        val indexRegex = "[a-z][0-9]".toRegex()
+        val valueRegex = "[A-Z]{3}".toRegex()
+
+        val fixture = kotlinFixture {
+            factory<String> { regexify(indexRegex) }
+
+            property(DataClass::value) { regexify(valueRegex) }
+        }
+
+        println(fixture<DataClass>()) // DataClass(index=m3, value=CGJ)
+```
+
 ## Contributing
 
 Please fork this repository and contribute back using

detekt-config.yml

@@ -4,6 +4,8 @@ build:
 style:
   MagicNumber:
     excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt,**/*.gradle.kts"
+  MaxLineLength:
+    active: false
 
 formatting:
   StringTemplate:

fixture-javafaker/build.gradle.kts

@@ -0,0 +1,67 @@
+/*
+ * Copyright 2020 Appmattus Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+
+plugins {
+    kotlin("jvm")
+    id("com.android.lint")
+}
+
+apply(from = "$rootDir/bintray.gradle.kts")
+apply(from = "$rootDir/gradle/scripts/jacoco.gradle.kts")
+
+dependencies {
+    api(kotlin("stdlib-jdk8"))
+    api(project(":fixture"))
+    api("com.github.javafaker:javafaker:1.0.2")
+
+    testImplementation("junit:junit:4.13")
+    testImplementation(kotlin("test"))
+    testImplementation(kotlin("test-junit"))
+    testImplementation("com.nhaarman.mockitokotlin2:mockito-kotlin:2.2.0")
+
+    testImplementation(kotlin("reflect"))
+    testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-test:1.3.7")
+}
+
+lintOptions {
+    isAbortOnError = true
+    isWarningsAsErrors = true
+    htmlOutput = file("${buildDir}/reports/lint-results.html")
+    xmlOutput = file("${buildDir}/reports/lint-results.xml")
+}
+
+java {
+    sourceCompatibility = JavaVersion.VERSION_1_8
+    targetCompatibility = JavaVersion.VERSION_1_8
+}
+
+tasks.withType<KotlinCompile> {
+    kotlinOptions.jvmTarget = "1.8"
+}
+
+// Fix lack of source code when publishing pure Kotlin projects
+// See https://github.com/novoda/bintray-release/issues/262
+tasks.whenTaskAdded {
+    if (name == "generateSourcesJarForMavenPublication") {
+        this as Jar
+        from(sourceSets.main.get().allSource)
+    }
+}
+
+tasks.getByName("check").finalizedBy(rootProject.tasks.getByName("detekt"))
+tasks.getByName("check").finalizedBy(rootProject.tasks.getByName("markdownlint"))

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

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2020 Appmattus Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.appmattus.kotlinfixture.decorator.fake.javafaker
+
+import com.appmattus.kotlinfixture.config.Generator
+import com.github.javafaker.Faker
+import kotlin.random.asJavaRandom
+
+@Suppress("SpellCheckingInspection")
+fun Generator<String>.regexify(regex: String): String {
+    return Faker(random.asJavaRandom()).regexify(regex)
+}
+
+@Suppress("SpellCheckingInspection")
+fun Generator<String>.regexify(regex: Regex): String {
+    return regexify(regex.pattern)
+}