Skip to content

Commit 00e02a5

Browse files
serpro69serpro69
committed
Remove deprecated functionality from data providers
1 parent 64d8831 commit 00e02a5

File tree

22 files changed

+54
-282
lines changed

22 files changed

+54
-282
lines changed

‎README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,12 @@ repositories {
8080
</repositories>
8181
```
8282

83+
#### BOM
84+
85+
Kotlin-faker provides a [Bill-of-Materials](https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#bill-of-materials-bom-poms) that simplifies dependency management.
86+
87+
See [bom/README.md](bom/README.md) for more details.
88+
8389
#### Additional Fakers
8490

8591
Extra fakers covering a wide range of domains are available as separate dependencies. See [faker](faker) submodules in this repo for more details about each faker.

‎cli-bot/src/main/resources/META-INF/native-image/io.github.serpro69/cli-bot/reflect-config.json

Lines changed: 9 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@
9393
},
9494
{
9595
"name":"io.github.serpro69.kfaker.books.provider.Dune",
96-
"methods":[{"name":"quotes","parameterTypes":["io.github.serpro69.kfaker.books.provider.Dune$QuoteCharacter"] }, {"name":"quotes$default","parameterTypes":["io.github.serpro69.kfaker.books.provider.Dune","io.github.serpro69.kfaker.books.provider.Dune$QuoteCharacter","int","java.lang.Object"] }]
96+
"methods":[{"name":"characters","parameterTypes":[] }, {"name":"cities","parameterTypes":[] }, {"name":"planets","parameterTypes":[] }, {"name":"quotes","parameterTypes":["io.github.serpro69.kfaker.books.provider.Dune$QuoteCharacter"] }, {"name":"quotes$default","parameterTypes":["io.github.serpro69.kfaker.books.provider.Dune","io.github.serpro69.kfaker.books.provider.Dune$QuoteCharacter","int","java.lang.Object"] }, {"name":"sayings","parameterTypes":["io.github.serpro69.kfaker.books.provider.Dune$SayingOrigin"] }, {"name":"sayings$default","parameterTypes":["io.github.serpro69.kfaker.books.provider.Dune","io.github.serpro69.kfaker.books.provider.Dune$SayingOrigin","int","java.lang.Object"] }, {"name":"titles","parameterTypes":[] }]
9797
},
9898
{
9999
"name":"io.github.serpro69.kfaker.books.provider.Dune$QuoteCharacter"
@@ -304,9 +304,6 @@
304304
},
305305
{
306306
"name":"io.github.serpro69.kfaker.edu.provider.Educator",
307-
"allDeclaredFields":true,
308-
"queryAllDeclaredMethods":true,
309-
"queryAllDeclaredConstructors":true,
310307
"methods":[{"name":"campus","parameterTypes":[] }, {"name":"courseName","parameterTypes":[] }, {"name":"degree","parameterTypes":[] }, {"name":"getTertiary","parameterTypes":[] }, {"name":"primary","parameterTypes":[] }, {"name":"primarySchool","parameterTypes":[] }, {"name":"schoolName","parameterTypes":[] }, {"name":"secondary","parameterTypes":[] }, {"name":"secondarySchool","parameterTypes":[] }, {"name":"subject","parameterTypes":[] }, {"name":"university","parameterTypes":[] }]
311308
},
312309
{
@@ -535,9 +532,6 @@
535532
},
536533
{
537534
"name":"io.github.serpro69.kfaker.japmedia.provider.OnePiece",
538-
"allDeclaredFields":true,
539-
"queryAllDeclaredMethods":true,
540-
"queryAllDeclaredConstructors":true,
541535
"methods":[{"name":"akumaNoMi","parameterTypes":[] }, {"name":"characters","parameterTypes":[] }, {"name":"islands","parameterTypes":[] }, {"name":"locations","parameterTypes":[] }, {"name":"quotes","parameterTypes":[] }, {"name":"seas","parameterTypes":[] }]
542536
},
543537
{
@@ -766,9 +760,6 @@
766760
},
767761
{
768762
"name":"io.github.serpro69.kfaker.music.provider.Music",
769-
"allDeclaredFields":true,
770-
"queryAllDeclaredMethods":true,
771-
"queryAllDeclaredConstructors":true,
772763
"methods":[{"name":"albums","parameterTypes":[] }, {"name":"bands","parameterTypes":[] }, {"name":"genres","parameterTypes":[] }, {"name":"instruments","parameterTypes":[] }, {"name":"mamboNo5","parameterTypes":[] }]
773764
},
774765
{
@@ -812,9 +803,6 @@
812803
},
813804
{
814805
"name":"io.github.serpro69.kfaker.provider.Address",
815-
"allDeclaredFields":true,
816-
"queryAllDeclaredMethods":true,
817-
"queryAllDeclaredConstructors":true,
818806
"methods":[{"name":"buildingNumber","parameterTypes":[] }, {"name":"city","parameterTypes":[] }, {"name":"cityPrefix","parameterTypes":[] }, {"name":"citySuffix","parameterTypes":[] }, {"name":"cityWithState","parameterTypes":[] }, {"name":"community","parameterTypes":[] }, {"name":"communityPrefix","parameterTypes":[] }, {"name":"communitySuffix","parameterTypes":[] }, {"name":"country","parameterTypes":[] }, {"name":"countryByCode","parameterTypes":["java.lang.String"] }, {"name":"countryByName","parameterTypes":["java.lang.String"] }, {"name":"countryCode","parameterTypes":[] }, {"name":"countryCodeLong","parameterTypes":[] }, {"name":"defaultCountry","parameterTypes":[] }, {"name":"fullAddress","parameterTypes":[] }, {"name":"mailbox","parameterTypes":[] }, {"name":"postcode","parameterTypes":[] }, {"name":"postcodeByState","parameterTypes":["java.lang.String"] }, {"name":"secondaryAddress","parameterTypes":[] }, {"name":"state","parameterTypes":[] }, {"name":"stateAbbr","parameterTypes":[] }, {"name":"streetAddress","parameterTypes":[] }, {"name":"streetName","parameterTypes":[] }, {"name":"streetSuffix","parameterTypes":[] }, {"name":"timeZone","parameterTypes":[] }]
819807
},
820808
{
@@ -825,9 +813,6 @@
825813
"name":"io.github.serpro69.kfaker.provider.Color",
826814
"methods":[{"name":"name","parameterTypes":[] }]
827815
},
828-
{
829-
"name":"io.github.serpro69.kfaker.provider.CountryCode"
830-
},
831816
{
832817
"name":"io.github.serpro69.kfaker.provider.Currency",
833818
"methods":[{"name":"code","parameterTypes":[] }, {"name":"name","parameterTypes":[] }, {"name":"symbol","parameterTypes":[] }]
@@ -841,9 +826,6 @@
841826
},
842827
{
843828
"name":"io.github.serpro69.kfaker.provider.File",
844-
"allDeclaredFields":true,
845-
"queryAllDeclaredMethods":true,
846-
"queryAllDeclaredConstructors":true,
847829
"methods":[{"name":"extension","parameterTypes":[] }, {"name":"getMimeType","parameterTypes":[] }]
848830
},
849831
{
@@ -878,19 +860,13 @@
878860
},
879861
{
880862
"name":"io.github.serpro69.kfaker.provider.Name",
881-
"allDeclaredFields":true,
882-
"queryAllDeclaredMethods":true,
883-
"queryAllDeclaredConstructors":true,
884863
"methods":[{"name":"femaleFirstName","parameterTypes":[] }, {"name":"firstName","parameterTypes":[] }, {"name":"lastName","parameterTypes":[] }, {"name":"maleFirstName","parameterTypes":[] }, {"name":"name","parameterTypes":[] }, {"name":"nameWithMiddle","parameterTypes":[] }, {"name":"neutralFirstName","parameterTypes":[] }]
885864
},
886865
{
887866
"name":"io.github.serpro69.kfaker.provider.Person"
888867
},
889868
{
890869
"name":"io.github.serpro69.kfaker.provider.PhoneNumber",
891-
"allDeclaredFields":true,
892-
"queryAllDeclaredMethods":true,
893-
"queryAllDeclaredConstructors":true,
894870
"methods":[{"name":"areaCode","parameterTypes":[] }, {"name":"countryCode","parameterTypes":[] }, {"name":"exchangeCode","parameterTypes":[] }, {"name":"extension","parameterTypes":[] }, {"name":"getCellPhone","parameterTypes":[] }, {"name":"phoneNumber","parameterTypes":[] }, {"name":"subscriberNumber","parameterTypes":[] }]
895871
},
896872
{
@@ -990,9 +966,6 @@
990966
},
991967
{
992968
"name":"io.github.serpro69.kfaker.tech.provider.Computer",
993-
"allDeclaredFields":true,
994-
"queryAllDeclaredMethods":true,
995-
"queryAllDeclaredConstructors":true,
996969
"methods":[{"name":"getOs","parameterTypes":[] }, {"name":"platform","parameterTypes":[] }, {"name":"type","parameterTypes":[] }]
997970
},
998971
{
@@ -1121,9 +1094,6 @@
11211094
},
11221095
{
11231096
"name":"io.github.serpro69.kfaker.tv.provider.Buffy",
1124-
"allDeclaredFields":true,
1125-
"queryAllDeclaredMethods":true,
1126-
"queryAllDeclaredConstructors":true,
11271097
"methods":[{"name":"actors","parameterTypes":[] }, {"name":"bigBads","parameterTypes":[] }, {"name":"characters","parameterTypes":[] }, {"name":"episodes","parameterTypes":[] }, {"name":"quotes","parameterTypes":[] }]
11281098
},
11291099
{
@@ -1144,9 +1114,6 @@
11441114
},
11451115
{
11461116
"name":"io.github.serpro69.kfaker.tv.provider.FreshPriceOfBelAir",
1147-
"allDeclaredFields":true,
1148-
"queryAllDeclaredMethods":true,
1149-
"queryAllDeclaredConstructors":true,
11501117
"methods":[{"name":"actors","parameterTypes":[] }, {"name":"characters","parameterTypes":[] }, {"name":"quotes","parameterTypes":[] }]
11511118
},
11521119
{
@@ -1253,6 +1220,10 @@
12531220
"name":"io.github.serpro69.kfaker.tv.provider.VentureBros",
12541221
"methods":[{"name":"character","parameterTypes":[] }, {"name":"organization","parameterTypes":[] }, {"name":"quote","parameterTypes":[] }, {"name":"vehicle","parameterTypes":[] }]
12551222
},
1223+
{
1224+
"name":"java.io.Console",
1225+
"methods":[{"name":"isTerminal","parameterTypes":[] }]
1226+
},
12561227
{
12571228
"name":"java.lang.ClassValue"
12581229
},
@@ -1264,6 +1235,10 @@
12641235
{
12651236
"name":"java.lang.String"
12661237
},
1238+
{
1239+
"name":"java.lang.System",
1240+
"methods":[{"name":"console","parameterTypes":[] }]
1241+
},
12671242
{
12681243
"name":"java.nio.file.Path"
12691244
},

‎core/src/integration/kotlin/io/github/serpro69/kfaker/docs/Extras.kt

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ class Extras : DescribeSpec({
1919
class Foo(val a: String)
2020
class Bar(val foo: Foo)
2121

22-
val foo: Foo = faker.randomProvider.randomClassInstance()
23-
val bar: Bar = faker.randomProvider.randomClassInstance()
22+
val foo: Foo = faker.randomClass.randomClassInstance()
23+
val bar: Bar = faker.randomClass.randomClassInstance()
2424
// END extras_random_instance_one
2525
}
2626

@@ -31,7 +31,7 @@ class Extras : DescribeSpec({
3131
// START extras_random_instance_two
3232
class Baz(val id: Int, val uuid: UUID, val relatedUuid: UUID, val user: String)
3333

34-
val baz: Baz = faker.randomProvider.randomClassInstance {
34+
val baz: Baz = faker.randomClass.randomClassInstance {
3535
typeGenerator<UUID> { UUID.fromString("00000000-0000-0000-0000-000000000000") }
3636
typeGenerator<Int> { 0 }
3737
typeGenerator<String> { parameterInfo -> "${parameterInfo.name}_${randomString()}" }
@@ -75,7 +75,7 @@ class Extras : DescribeSpec({
7575

7676
it("should generate class with configured number of constructor args") {
7777
// START extras_random_instance_four
78-
val fooBarBaz: FooBarBaz = faker.randomProvider.randomClassInstance {
78+
val fooBarBaz: FooBarBaz = faker.randomClass.randomClassInstance {
7979
constructorParamSize = 3
8080
fallbackStrategy = FallbackStrategy.USE_MAX_NUM_OF_ARGS
8181
}
@@ -87,7 +87,7 @@ class Extras : DescribeSpec({
8787

8888
it("should use constructor filter strategy") {
8989
// START extras_random_instance_five
90-
val fooBarBaz: FooBarBaz = faker.randomProvider.randomClassInstance {
90+
val fooBarBaz: FooBarBaz = faker.randomClass.randomClassInstance {
9191
constructorFilterStrategy = ConstructorFilterStrategy.MAX_NUM_OF_ARGS
9292
}
9393
assertNotEquals(fooBarBaz.foo, null)
@@ -104,7 +104,7 @@ class Extras : DescribeSpec({
104104
val map: Map<String, Int>
105105
)
106106

107-
val foo = faker.randomProvider.randomClassInstance<Foo>()
107+
val foo = faker.randomClass.randomClassInstance<Foo>()
108108

109109
assertEquals(foo.list.size, 1)
110110
assertEquals(foo.set.size, 1)
@@ -120,7 +120,7 @@ class Extras : DescribeSpec({
120120
val map: Map<String, Int>
121121
)
122122

123-
val foo = faker.randomProvider.randomClassInstance<Foo> {
123+
val foo = faker.randomClass.randomClassInstance<Foo> {
124124
collectionsSize = 6
125125
}
126126

@@ -137,7 +137,7 @@ class Extras : DescribeSpec({
137137
val set: Set<String>
138138
)
139139

140-
val testClass = faker.randomProvider.randomClassInstance<TestClass> {
140+
val testClass = faker.randomClass.randomClassInstance<TestClass> {
141141
typeGenerator { "a string" }
142142
collectionsSize = 10
143143
}
@@ -156,7 +156,7 @@ class Extras : DescribeSpec({
156156
val map: Map<String, Int>
157157
)
158158

159-
val bar = faker.randomProvider.randomClassInstance<Bar> {
159+
val bar = faker.randomClass.randomClassInstance<Bar> {
160160
typeGenerator { emptyList<Foo>() }
161161
typeGenerator { setOf("one", "two", "fortytwo") }
162162
typeGenerator { mapOf("pwd" to 12177) }
@@ -183,39 +183,39 @@ class Extras : DescribeSpec({
183183
}
184184
}
185185
val f = Faker(cfg)
186-
val baz: Baz = f.randomProvider.randomClassInstance<Baz>()
186+
val baz: Baz = f.randomClass.randomClassInstance<Baz>()
187187
assertEquals(baz.bar, Bar(42, UUID.fromString("11111111-1111-1111-1111-111111111111")))
188-
val anotherBaz = f.randomProvider.new().randomClassInstance<Baz>()
188+
val anotherBaz = f.randomClass.new().randomClassInstance<Baz>()
189189
assertEquals(anotherBaz.bar, Bar(42, UUID.fromString("11111111-1111-1111-1111-111111111111")))
190190
// END extras_random_instance_eleven
191191
}
192192

193-
it("should configure random class instance from randomProvider") {
193+
it("should configure random class instance from randomClass") {
194194
// START extras_random_instance_twelve
195195
val cfg = fakerConfig {
196196
randomClassInstance {
197197
typeGenerator<Bar> { Bar(42, UUID.fromString("11111111-1111-1111-1111-111111111111")) }
198198
}
199199
}
200200
val f = Faker(cfg).also {
201-
it.randomProvider.configure {
201+
it.randomClass.configure {
202202
typeGenerator<UUID> { UUID.fromString("00000000-0000-0000-0000-000000000000") }
203203
}
204204
}
205205

206-
val bar: Bar = f.randomProvider.randomClassInstance()
207-
val baz: Baz = f.randomProvider.randomClassInstance()
206+
val bar: Bar = f.randomClass.randomClassInstance()
207+
val baz: Baz = f.randomClass.randomClassInstance()
208208
assertEquals(bar.uuid, UUID.fromString("00000000-0000-0000-0000-000000000000"))
209209
assertEquals(baz.bar, Bar(42, UUID.fromString("11111111-1111-1111-1111-111111111111")))
210210
// END extras_random_instance_twelve
211211
}
212212

213213
it("should configure random class instance from function") {
214214
// START extras_random_instance_thirteen
215-
faker.randomProvider.configure {
215+
faker.randomClass.configure {
216216
typeGenerator<Bar> { Bar(42, UUID.fromString("11111111-1111-1111-1111-111111111111")) }
217217
}
218-
val baz: Baz = faker.randomProvider.randomClassInstance {
218+
val baz: Baz = faker.randomClass.randomClassInstance {
219219
typeGenerator<Bar> { Bar(1, UUID.fromString("00000000-0000-0000-0000-000000000000")) }
220220
}
221221
assertEquals(baz.bar, Bar(1, UUID.fromString("00000000-0000-0000-0000-000000000000")))
@@ -236,11 +236,11 @@ class Extras : DescribeSpec({
236236
}
237237
}
238238
val f = Faker(cfg)
239-
f.randomProvider.configure { // ❷
239+
f.randomClass.configure { // ❷
240240
typeGenerator<Bar> { Bar(42, UUID.fromString("11111111-1111-1111-1111-111111111111")) }
241241
}
242-
val new = f.randomProvider.new() // ❸
243-
val baz: Baz = f.randomProvider.randomClassInstance<Baz>()
242+
val new = f.randomClass.new() // ❸
243+
val baz: Baz = f.randomClass.randomClassInstance<Baz>()
244244
val newBaz: Baz = new.randomClassInstance<Baz>()
245245
assertEquals(Bar(42, UUID.fromString("11111111-1111-1111-1111-111111111111")), baz.bar)
246246
assertEquals(Bar(1, UUID.fromString("00000000-0000-0000-0000-000000000000")), newBaz.bar)
@@ -255,19 +255,19 @@ class Extras : DescribeSpec({
255255
}
256256
}
257257
val f = Faker(cfg)
258-
f.randomProvider.configure { // ❷
258+
f.randomClass.configure { // ❷
259259
typeGenerator<Bar> { Bar(42, UUID.fromString("11111111-1111-1111-1111-111111111111")) }
260260
}
261-
val copy = f.randomProvider.copy() // ❸
262-
val baz: Baz = f.randomProvider.randomClassInstance<Baz>()
261+
val copy = f.randomClass.copy() // ❸
262+
val baz: Baz = f.randomClass.randomClassInstance<Baz>()
263263
val bazCopy: Baz = copy.randomClassInstance<Baz>()
264264
assertEquals(Bar(42, UUID.fromString("11111111-1111-1111-1111-111111111111")), baz.bar)
265265
assertEquals(Bar(42, UUID.fromString("11111111-1111-1111-1111-111111111111")), bazCopy.bar)
266266

267267
copy.configure { // ❹
268268
typeGenerator<Bar> { Bar(0, UUID.fromString("22222222-2222-2222-2222-222222222222")) }
269269
}
270-
val originalBaz: Baz = f.randomProvider.randomClassInstance<Baz>()
270+
val originalBaz: Baz = f.randomClass.randomClassInstance<Baz>()
271271
val reconfiguredBazCopy = copy.randomClassInstance<Baz>()
272272
assertEquals(Bar(42, UUID.fromString("11111111-1111-1111-1111-111111111111")), originalBaz.bar)
273273
assertEquals(Bar(0, UUID.fromString("22222222-2222-2222-2222-222222222222")), reconfiguredBazCopy.bar)

‎core/src/integration/kotlin/io/github/serpro69/kfaker/docs/FakerConfiguration.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ class FakerConfiguration : DescribeSpec({
108108
namedParameterGenerator("name") { faker {}.name.name() }
109109
}
110110
}
111-
val test = Faker(config).randomProvider.randomClassInstance<Test>()
111+
val test = Faker(config).randomClass.randomClassInstance<Test>()
112112
assertEquals(test.uuid, UUID.fromString("00000000-0000-0000-0000-000000000000"))
113113
// END faker_config_six
114114
}

‎core/src/integration/kotlin/io/github/serpro69/kfaker/docs/Homepage.kt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,16 +104,16 @@ class Homepage : DescribeSpec({
104104
class Foo(val a: String)
105105
class Bar(val foo: Foo)
106106

107-
val foo: Foo = faker.randomProvider.randomClassInstance()
108-
val bar: Bar = faker.randomProvider.randomClassInstance()
107+
val foo: Foo = faker.randomClass.randomClassInstance()
108+
val bar: Bar = faker.randomClass.randomClassInstance()
109109
// END random_class_instance_one
110110
}
111111
it("should generate types by configuration") {
112112
fun randomString() = "X3a8s813dcb";
113113
// START random_class_instance_two
114114
class Baz(val id: Int, val uuid: UUID, val username: String)
115115

116-
val baz: Baz = faker.randomProvider.randomClassInstance {
116+
val baz: Baz = faker.randomClass.randomClassInstance {
117117
// ヽ(^o^)丿 ᕕ(ᐛ)ᕗ Prepend string type parameter values with parameter name!
118118
typeGenerator<String> { parameterInfo -> "${parameterInfo.name}_${randomString()}" }
119119
typeGenerator<UUID> { UUID.fromString("00000000-0000-0000-0000-000000000000") }

‎core/src/integration/kotlin/io/github/serpro69/kfaker/provider/PhoneNumberIT.kt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,6 @@ class PhoneNumberIT : DescribeSpec({
5656
}
5757
it("should generate a countryCode run#$it") {
5858
phone.countryCode() shouldNotBe ""
59-
// test deprecated function until it's removed
60-
phone.countryCode.code() shouldNotBe ""
6159
}
6260
}
6361
}

‎core/src/main/kotlin/io/github/serpro69/kfaker/Faker.kt

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,6 @@ class Faker @JvmOverloads constructor(config: FakerConfig = fakerConfig { }) : A
4141
val randomClass: RandomClassProvider by lazy { RandomClassProvider(config) }
4242
val string: StringProvider by lazy { StringProvider(fakerService) }
4343

44-
@Deprecated(
45-
message = "This property is deprecated and will be removed in future releases",
46-
level = DeprecationLevel.WARNING,
47-
replaceWith = ReplaceWith("randomClass")
48-
)
49-
val randomProvider: RandomClassProvider by lazy { RandomClassProvider(config) }
50-
5144
// yml dictionary-based providers
5245
val address: Address by lazy { Address(fakerService) }
5346
val color: Color by lazy { Color(fakerService) }

‎core/src/main/kotlin/io/github/serpro69/kfaker/FakerConfig.kt

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -86,13 +86,6 @@ class FakerConfig private constructor(
8686
}
8787
}
8888

89-
@Deprecated(
90-
message = "This function is deprecated and will be removed in 1.9.0",
91-
ReplaceWith("fakerConfig { }"),
92-
level = DeprecationLevel.WARNING
93-
)
94-
fun FakerConfig.Builder.create(block: ConfigBuilder): FakerConfig = this.apply(block).build()
95-
9689
/**
9790
* Applies the the [block] function to [ConfigBuilder]
9891
* and returns as an instance of [FakerConfig] from that builder.

0 commit comments

Comments
 (0)