Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unique generation config #52

Merged
merged 16 commits into from
Dec 13, 2020
Merged

Unique generation config #52

Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
6c6e0fe
Update licence
serpro69 Nov 21, 2020
398bce8
Add kdocs for UniqueDataProvider
serpro69 Nov 21, 2020
a935de1
Configure GlobalUniqueDataProvider through configuration class
serpro69 Dec 2, 2020
f26d8f6
Extract Internet provider tests to separate class
serpro69 Dec 12, 2020
bf46807
Split test contexts
serpro69 Dec 12, 2020
8915e07
Move UniqueDataProvider to it's own package
serpro69 Dec 12, 2020
8b43d21
Extract classes from UniqueDataProvider.kt
serpro69 Dec 12, 2020
5329712
Remove unused code from provider/unique/* classes
serpro69 Dec 12, 2020
4fa7b53
Refactor integration tests
serpro69 Dec 12, 2020
e1547b7
Implement global exclusions by collection of values and patterns
serpro69 Dec 12, 2020
89da0f4
Exclude values for provider and provider's functions
serpro69 Dec 12, 2020
6c7553d
Exclude by patterns for provider and provider's functions
serpro69 Dec 12, 2020
52765fb
Extract integration tests for unique generation
serpro69 Dec 12, 2020
4169ebc
Reduce number of test repeats
serpro69 Dec 12, 2020
4eed1c2
Rename excludeFor* functions to excludeFrom{1}
serpro69 Dec 12, 2020
9935c88
Update readme and changelog
serpro69 Dec 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add kdocs for UniqueDataProvider
  • Loading branch information
@serpro69
serpro69 committed Dec 12, 2020
commit 398bce8856870d9ab43830dd0d530b6fd3d6e044
80 changes: 76 additions & 4 deletions core/src/main/kotlin/io/github/serpro69/kfaker/provider/UniqueDataProvider.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,77 @@
package io.github.serpro69.kfaker.provider

import kotlin.properties.*
import kotlin.reflect.*
import kotlin.reflect.full.*
import kotlin.reflect.jvm.*
import io.github.serpro69.kfaker.Faker
import kotlin.properties.ReadOnlyProperty
import kotlin.reflect.KClass
import kotlin.reflect.KProperty
import kotlin.reflect.KProperty0
import kotlin.reflect.full.memberProperties
import kotlin.reflect.full.primaryConstructor
import kotlin.reflect.jvm.javaField

abstract class UniqueDataProvider {
/**
* A set of providers that are configured to return unique values.
*/
internal abstract val markedUnique: Set<*>

/**
* A map of key=value pairs representing already returned (used) values
* which will not be returned again.
*/
internal abstract val usedValues: Map<*, *>

/**
* Disables "unique generation" for all providers that were configured to return unique values.
*/
abstract fun disableAll()

/**
* Clears the already returned (used) unique values so that they can again be returned.
*/
abstract fun clearAll()
}

/**
* Global provider for unique values.
*
* This provider is used in [Faker] class to control global unique generation configuration of faker providers.
*
* Example usage:
* ```
* val faker = Faker()
* faker.unique.enable(faker::address) // enables unique generation for all functions of Address provider
* ```
*/
@Suppress("UNCHECKED_CAST", "unused")
class GlobalUniqueDataDataProvider : UniqueDataProvider() {
/**
* A Set of [FakeDataProvider]s' [KClass]es that are configured to return unique values.
*/
@PublishedApi
@JvmSynthetic
override val markedUnique = mutableSetOf<KClass<out FakeDataProvider>>()

/**
* A HashMap where the key is a [KClass] of [FakeDataProvider],
* and values are Maps of provider's functionName to a set of already returned (used) values.
*/
@PublishedApi
@JvmSynthetic
override val usedValues = hashMapOf<KClass<out FakeDataProvider>, MutableMap<String, MutableSet<String>>>()

/**
* Disables "unique generation" for all providers that were configured to return unique values,
* and clears out any already returned values, so they can possibly be returned again.
*/
override fun disableAll() {
markedUnique.clear()
usedValues.clear()
}

/**
* Clears the already returned (used) unique values so that they can again be returned.
*/
override fun clearAll() {
usedValues.keys.forEach { k ->
usedValues[k] = hashMapOf()
Expand Down Expand Up @@ -84,11 +127,25 @@ class GlobalUniqueDataDataProvider : UniqueDataProvider() {
}
}

/**
* Local provider for unique values.
*
* This provider is used in [T] implementation of [FakeDataProvider] class,
* and controls unique generation configuration of [T]'s functions.
*
* Example usage:
* ```
* Faker().address.unique().country()
* ```
*/
@Suppress("UNCHECKED_CAST", "unused")
class LocalUniqueDataProvider<T : FakeDataProvider> : UniqueDataProvider() {
override val markedUnique: MutableSet<FakeDataProvider> = mutableSetOf()
override val usedValues = hashMapOf<String, MutableSet<String>>()

/**
* In `this` class the function works the same as [clearAll] implementation.
*/
override fun disableAll() {
clearAll()
}
Expand All @@ -99,11 +156,26 @@ class LocalUniqueDataProvider<T : FakeDataProvider> : UniqueDataProvider() {
}
}

/**
* Clears the already returned (used) unique values for the function with provided [name].
*
* Example usage:
* ```
* address.unique.clear("country") // clear (reset) unique values for 'country' function
* ```
*/
fun clear(name: String) {
usedValues[name] = mutableSetOf()
}
}

/**
* Delegate class for [LocalUniqueDataProvider] used to return local providers that generate unique values.
*
* @param T an implementation of [AbstractFakeDataProvider]
*
* @property uniqueDataProvider [LocalUniqueDataProvider] of [T] type.
*/
@Suppress("UNCHECKED_CAST")
class UniqueProviderDelegate<T : AbstractFakeDataProvider<*>>(
private val uniqueDataProvider: LocalUniqueDataProvider<T>
Expand Down