Add 'misc' provider module

serpro69 · serpro69 · Feb 18, 2024 · Feb 14, 2024 · Feb 15, 2024 · Feb 15, 2024
commit ab4d1b7fbdbdf94c42e2048b335e907ab1726e14
diff --git a/core/src/main/kotlin/io/github/serpro69/kfaker/Faker.kt b/core/src/main/kotlin/io/github/serpro69/kfaker/Faker.kt
@@ -5,16 +5,12 @@ package io.github.serpro69.kfaker
 import io.github.serpro69.kfaker.provider.Address
 import io.github.serpro69.kfaker.provider.Ancient
 import io.github.serpro69.kfaker.provider.Animal
-import io.github.serpro69.kfaker.provider.Artist
 import io.github.serpro69.kfaker.provider.Bird
-import io.github.serpro69.kfaker.provider.Blood
 import io.github.serpro69.kfaker.provider.Cat
 import io.github.serpro69.kfaker.provider.Color
 import io.github.serpro69.kfaker.provider.Currency
 import io.github.serpro69.kfaker.provider.CurrencySymbol
-import io.github.serpro69.kfaker.provider.Demographic
 import io.github.serpro69.kfaker.provider.Dog
-import io.github.serpro69.kfaker.provider.DrivingLicense
 import io.github.serpro69.kfaker.provider.Emotion
 import io.github.serpro69.kfaker.provider.File
 import io.github.serpro69.kfaker.provider.Gender
@@ -25,30 +21,28 @@ import io.github.serpro69.kfaker.provider.Horse
 import io.github.serpro69.kfaker.provider.IdNumber
 import io.github.serpro69.kfaker.provider.Internet
 import io.github.serpro69.kfaker.provider.Measurement
-import io.github.serpro69.kfaker.provider.Military
 import io.github.serpro69.kfaker.provider.Money
 import io.github.serpro69.kfaker.provider.Name
 import io.github.serpro69.kfaker.provider.Person
 import io.github.serpro69.kfaker.provider.PhoneNumber
 import io.github.serpro69.kfaker.provider.Quote
 import io.github.serpro69.kfaker.provider.Rajnikanth
-import io.github.serpro69.kfaker.provider.Relationship
 import io.github.serpro69.kfaker.provider.Separator
 import io.github.serpro69.kfaker.provider.misc.CryptographyProvider
 import io.github.serpro69.kfaker.provider.misc.RandomClassProvider
 import io.github.serpro69.kfaker.provider.misc.RandomProvider
 import io.github.serpro69.kfaker.provider.misc.StringProvider
 
 /**
- * Provides access to fake data generators.
+ * Provides access to 'core' fake data generators.
  *
  * Each category (generator) from this [Faker] is represented by a property that has the same name as the `.yml` file.
  *
- * @property random provides public access to the functions of [RandomService].
- * @property randomProvider provides additional functionality that is not covered by other data providers
+ * @property random      provides data-generator-like functionality for the functions of [RandomService].
+ * @property randomClass provides additional functionality that is not covered by other data providers
  * such as [address], [name], [internet], and so on. See [RandomClassProvider] for more details.
- * @property string provides functionality to generate strings from expressions/templates
- * @property unique global provider for generation of unique values.
+ * @property string      provides functionality to generate strings from expressions/templates
+ * @property unique      global provider for generation of unique values.
  */
 @Suppress("unused")
 class Faker @JvmOverloads constructor(config: FakerConfig = fakerConfig { }) : AbstractFaker(config) {
@@ -77,28 +71,22 @@ class Faker @JvmOverloads constructor(config: FakerConfig = fakerConfig { }) : A
 
     // creature
     val animal: Animal by lazy { Animal(fakerService) }
-    val artist: Artist by lazy { Artist(fakerService) }
 
     // creature
     val bird: Bird by lazy { Bird(fakerService) }
-    val blood: Blood by lazy { Blood(fakerService) }
 
     // creature
     val cat: Cat by lazy { Cat(fakerService) }
+
     val color: Color by lazy { Color(fakerService) }
     val currency: Currency by lazy { Currency(fakerService) }
 
-    // misc
-    val demographic: Demographic by lazy { Demographic(fakerService) }
-
     // creature
     val dog: Dog by lazy { Dog(fakerService) }
 
-    // misc
-    val drivingLicense: DrivingLicense by lazy { DrivingLicense(fakerService) }
-
     // lorem
     val emotion: Emotion by lazy { Emotion(fakerService) }
+
     val file: File by lazy { File(fakerService) }
     val gender: Gender by lazy { Gender(fakerService) }
 
@@ -113,13 +101,10 @@ class Faker @JvmOverloads constructor(config: FakerConfig = fakerConfig { }) : A
 
     // creature
     val horse: Horse by lazy { Horse(fakerService) }
+
     val idNumber: IdNumber by lazy { IdNumber(fakerService) }
     val internet: Internet by lazy { Internet(fakerService, name) }
-
     val measurement: Measurement by lazy { Measurement(fakerService) }
-
-    // misc
-    val military: Military by lazy { Military(fakerService) }
     val money: Money by lazy { Money(fakerService) }
     val name: Name by lazy { Name(fakerService) }
     val person: Person by lazy { Person(config.random) }
@@ -131,10 +116,7 @@ class Faker @JvmOverloads constructor(config: FakerConfig = fakerConfig { }) : A
     // movie
     val rajnikanth: Rajnikanth by lazy { Rajnikanth(fakerService) }
 
-    // misc
-    val relationship: Relationship by lazy { Relationship(fakerService) }
-
-    //    val source: Source by lazy { Source(fakerService) }
+    // TODO val source: Source by lazy { Source(fakerService) }
 
     @FakerDsl
     /**

diff --git a/provider/misc/build.gradle.kts b/provider/misc/build.gradle.kts
@@ -0,0 +1,4 @@
+plugins {
+    `faker-lib-conventions`
+    `faker-provider-conventions`
+}
diff --git a/provider/misc/src/main/kotlin/io/github/serpro69/kfaker/misc/MiscFaker.kt b/provider/misc/src/main/kotlin/io/github/serpro69/kfaker/misc/MiscFaker.kt
@@ -0,0 +1,56 @@
+package io.github.serpro69.kfaker.misc
+
+import io.github.serpro69.kfaker.AbstractFaker
+import io.github.serpro69.kfaker.FakerConfig
+import io.github.serpro69.kfaker.FakerDsl
+import io.github.serpro69.kfaker.fakerConfig
+import io.github.serpro69.kfaker.misc.provider.Artist
+import io.github.serpro69.kfaker.misc.provider.Blood
+import io.github.serpro69.kfaker.misc.provider.Demographic
+import io.github.serpro69.kfaker.misc.provider.DrivingLicense
+import io.github.serpro69.kfaker.misc.provider.Military
+import io.github.serpro69.kfaker.misc.provider.Relationship
+import io.github.serpro69.kfaker.Faker as CoreFaker
+
+/**
+ * Typealias for the [MiscFaker]
+ */
+typealias Faker = MiscFaker
+
+/**
+ * Provides access to fake data generators that don't belong in the [CoreFaker]
+ * but also don't fit into any of the existing providers.
+ *
+ * Each category (generator) from this [MiscFaker] is represented by a property
+ * that (usually) has the same name as the `.yml` dictionary file.
+ *
+ * @property unique global provider for generation of unique values.
+ */
+@Suppress("unused")
+class MiscFaker @JvmOverloads constructor(config: FakerConfig = fakerConfig { }) : AbstractFaker(config) {
+
+    val artist: Artist by lazy { Artist(fakerService) }
+    val blood: Blood by lazy { Blood(fakerService) }
+    val demographic: Demographic by lazy { Demographic(fakerService) }
+    val drivingLicense: DrivingLicense by lazy { DrivingLicense(fakerService) }
+    val military: Military by lazy { Military(fakerService) }
+    val relationship: Relationship by lazy { Relationship(fakerService) }
+
+    @FakerDsl
+    /**
+     * DSL builder for creating instances of [Faker]
+     */
+    class Builder internal constructor() : AbstractFaker.Builder<Faker>() {
+
+        /**
+         * Builds an instance of [Faker] with this [config].
+         */
+        override fun build(): Faker = Faker(config)
+    }
+}
+
+/**
+ * Applies the [block] function to [MiscFaker.Builder]
+ * and returns as an instance of [MiscFaker] from that builder.
+ */
+fun faker(block: MiscFaker.Builder.() -> Unit): MiscFaker = MiscFaker.Builder().apply(block).build()
diff --git a/...github/serpro69/kfaker/provider/Artist.kt → ...b/serpro69/kfaker/misc/provider/Artist.kt b/...github/serpro69/kfaker/provider/Artist.kt → ...b/serpro69/kfaker/misc/provider/Artist.kt
@@ -1,7 +1,9 @@
-package io.github.serpro69.kfaker.provider
+package io.github.serpro69.kfaker.misc.provider
 
-import io.github.serpro69.kfaker.*
-import io.github.serpro69.kfaker.dictionary.*
+import io.github.serpro69.kfaker.FakerService
+import io.github.serpro69.kfaker.dictionary.YamlCategory
+import io.github.serpro69.kfaker.provider.FakeDataProvider
+import io.github.serpro69.kfaker.provider.YamlFakeDataProvider
 import io.github.serpro69.kfaker.provider.unique.LocalUniqueDataProvider
 import io.github.serpro69.kfaker.provider.unique.UniqueProviderDelegate
 

diff --git a/.../github/serpro69/kfaker/provider/Blood.kt → ...ub/serpro69/kfaker/misc/provider/Blood.kt b/.../github/serpro69/kfaker/provider/Blood.kt → ...ub/serpro69/kfaker/misc/provider/Blood.kt
@@ -1,7 +1,9 @@
-package io.github.serpro69.kfaker.provider
+package io.github.serpro69.kfaker.misc.provider
 
-import io.github.serpro69.kfaker.*
-import io.github.serpro69.kfaker.dictionary.*
+import io.github.serpro69.kfaker.FakerService
+import io.github.serpro69.kfaker.dictionary.YamlCategory
+import io.github.serpro69.kfaker.provider.FakeDataProvider
+import io.github.serpro69.kfaker.provider.YamlFakeDataProvider
 import io.github.serpro69.kfaker.provider.unique.LocalUniqueDataProvider
 import io.github.serpro69.kfaker.provider.unique.UniqueProviderDelegate
 

diff --git a/...b/serpro69/kfaker/provider/Demographic.kt → ...pro69/kfaker/misc/provider/Demographic.kt b/...b/serpro69/kfaker/provider/Demographic.kt → ...pro69/kfaker/misc/provider/Demographic.kt
@@ -1,7 +1,9 @@
-package io.github.serpro69.kfaker.provider
+package io.github.serpro69.kfaker.misc.provider
 
-import io.github.serpro69.kfaker.*
-import io.github.serpro69.kfaker.dictionary.*
+import io.github.serpro69.kfaker.FakerService
+import io.github.serpro69.kfaker.dictionary.YamlCategory
+import io.github.serpro69.kfaker.provider.FakeDataProvider
+import io.github.serpro69.kfaker.provider.YamlFakeDataProvider
 import io.github.serpro69.kfaker.provider.unique.LocalUniqueDataProvider
 import io.github.serpro69.kfaker.provider.unique.UniqueProviderDelegate
 

diff --git a/...erpro69/kfaker/provider/DrivingLicense.kt → ...69/kfaker/misc/provider/DrivingLicense.kt b/...erpro69/kfaker/provider/DrivingLicense.kt → ...69/kfaker/misc/provider/DrivingLicense.kt
@@ -1,7 +1,9 @@
-package io.github.serpro69.kfaker.provider
+package io.github.serpro69.kfaker.misc.provider
 
-import io.github.serpro69.kfaker.*
-import io.github.serpro69.kfaker.dictionary.*
+import io.github.serpro69.kfaker.FakerService
+import io.github.serpro69.kfaker.dictionary.YamlCategory
+import io.github.serpro69.kfaker.provider.FakeDataProvider
+import io.github.serpro69.kfaker.provider.YamlFakeDataProvider
 import io.github.serpro69.kfaker.provider.unique.LocalUniqueDataProvider
 import io.github.serpro69.kfaker.provider.unique.UniqueProviderDelegate
 

diff --git a/...thub/serpro69/kfaker/provider/Military.kt → ...serpro69/kfaker/misc/provider/Military.kt b/...thub/serpro69/kfaker/provider/Military.kt → ...serpro69/kfaker/misc/provider/Military.kt
@@ -1,7 +1,9 @@
-package io.github.serpro69.kfaker.provider
+package io.github.serpro69.kfaker.misc.provider
 
-import io.github.serpro69.kfaker.*
-import io.github.serpro69.kfaker.dictionary.*
+import io.github.serpro69.kfaker.FakerService
+import io.github.serpro69.kfaker.dictionary.YamlCategory
+import io.github.serpro69.kfaker.provider.FakeDataProvider
+import io.github.serpro69.kfaker.provider.YamlFakeDataProvider
 import io.github.serpro69.kfaker.provider.unique.LocalUniqueDataProvider
 import io.github.serpro69.kfaker.provider.unique.UniqueProviderDelegate
 

diff --git a/.../serpro69/kfaker/provider/Relationship.kt → ...ro69/kfaker/misc/provider/Relationship.kt b/.../serpro69/kfaker/provider/Relationship.kt → ...ro69/kfaker/misc/provider/Relationship.kt
@@ -1,7 +1,9 @@
-package io.github.serpro69.kfaker.provider
+package io.github.serpro69.kfaker.misc.provider
 
-import io.github.serpro69.kfaker.*
-import io.github.serpro69.kfaker.dictionary.*
+import io.github.serpro69.kfaker.FakerService
+import io.github.serpro69.kfaker.dictionary.YamlCategory
+import io.github.serpro69.kfaker.provider.FakeDataProvider
+import io.github.serpro69.kfaker.provider.YamlFakeDataProvider
 import io.github.serpro69.kfaker.provider.unique.LocalUniqueDataProvider
 import io.github.serpro69.kfaker.provider.unique.UniqueProviderDelegate
 

diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -25,6 +25,7 @@ val providers = listOf(
     "humor",
     "japmedia",
     "lorem",
+    "misc",
     "movies",
     "music",
     "sports",