Add annotations for jvm

LilianaFaustinoDev · LilianaFaustinoDev · commit 540f3391e70c · 2023-06-07T18:00:59.000+01:00
diff --git a/lib/src/main/kotlin/io/bloco/faker/Faker.kt b/lib/src/main/kotlin/io/bloco/faker/Faker.kt
@@ -28,27 +28,27 @@ import java.io.IOException
 import java.io.InputStream
 
 class Faker(val locale: String = DEFAULT_LOCALE) {
-    val address: Address
-    val app: App
-    val avatar: Avatar
-    val book: Book
-    val bool: Bool
-    val business: Business
-    val color: Color
-    val commerce: Commerce
-    val company: Company
-    val date: Date
-    val food: Food
-    val internet: Internet
-    val lorem: Lorem
-    val name: Name
-    val number: Number
-    val placeholdit: Placeholdit
-    val phoneNumber: PhoneNumber
-    val slackEmoji: SlackEmoji
-    val team: Team
-    val time: Time
-    val university: University
+    @JvmField val address: Address
+    @JvmField val app: App
+    @JvmField val avatar: Avatar
+    @JvmField val book: Book
+    @JvmField val bool: Bool
+    @JvmField val business: Business
+    @JvmField val color: Color
+    @JvmField val commerce: Commerce
+    @JvmField val company: Company
+    @JvmField val date: Date
+    @JvmField val food: Food
+    @JvmField val internet: Internet
+    @JvmField val lorem: Lorem
+    @JvmField val name: Name
+    @JvmField val number: Number
+    @JvmField val placeholdit: Placeholdit
+    @JvmField val phoneNumber: PhoneNumber
+    @JvmField val slackEmoji: SlackEmoji
+    @JvmField val team: Team
+    @JvmField val time: Time
+    @JvmField val university: University
     private val data: FakerData
 
     init {
diff --git a/lib/src/main/kotlin/io/bloco/faker/components/Avatar.kt b/lib/src/main/kotlin/io/bloco/faker/components/Avatar.kt
@@ -4,6 +4,7 @@ import io.bloco.faker.FakerComponent
 import io.bloco.faker.FakerData
 
 class Avatar(data: FakerData) : FakerComponent(data) {
+    @JvmOverloads
     fun image(
         slug: String? = "image",
         size: String = "300x300",
diff --git a/lib/src/main/kotlin/io/bloco/faker/components/Bool.kt b/lib/src/main/kotlin/io/bloco/faker/components/Bool.kt
@@ -4,6 +4,7 @@ import io.bloco.faker.FakerComponent
 import io.bloco.faker.FakerData
 
 class Bool(data: FakerData) : FakerComponent(data) {
+    @JvmOverloads
     fun bool(trueRatio: Float = 0.5f): Boolean {
         return Math.random() < trueRatio
     }
diff --git a/lib/src/main/kotlin/io/bloco/faker/components/Commerce.kt b/lib/src/main/kotlin/io/bloco/faker/components/Commerce.kt
@@ -10,13 +10,13 @@ class Commerce(data: FakerData) : FakerComponent(data) {
         return call("color.colorName")
     }
 
+    @JvmOverloads
     fun department(max: Int = 3, fixedAmount: Boolean = false): String {
         val num = if (fixedAmount) max else randomHelper.number(max) + 1
         val categories = getCategories(num)
         return if (num > 1) mergeCategories(categories) else categories.first()
     }
 
-
     fun productName(): String {
         return listOf(
             fetch("commerce.product_name.adjective"),
@@ -25,15 +25,16 @@ class Commerce(data: FakerData) : FakerComponent(data) {
         ).joinToString(" ")
     }
 
-
     fun material(): String {
         return fetch("commerce.product_name.material")
     }
 
+    @JvmOverloads
     fun price(min: Int = 0, max: Int = 100): BigDecimal {
         return BigDecimal(randomHelper.range(min, max)).setScale(2, RoundingMode.HALF_UP)
     }
 
+    @JvmOverloads
     fun promotionCode(digits: Int = 6): String {
         return listOf(
             fetch("commerce.promotion_code.adjective"),
diff --git a/lib/src/main/kotlin/io/bloco/faker/components/Date.kt b/lib/src/main/kotlin/io/bloco/faker/components/Date.kt
@@ -12,7 +12,7 @@ import java.util.Date
 import kotlin.random.Random
 
 class Date(fakerData: FakerData) : FakerComponent(fakerData) {
-    private var formatter: SimpleDateFormat = SimpleDateFormat("yyyy-MM-dd")
+    private val formatter = SimpleDateFormat("yyyy-MM-dd")
 
     fun between(from: String, to: String): Date {
         return try {
@@ -28,14 +28,17 @@ class Date(fakerData: FakerData) : FakerComponent(fakerData) {
         return between(from.toLocalDate(), to.toLocalDate())
     }
 
+    @JvmOverloads
     fun forward(numberOfDays: Int = DEFAULT_NUM_OF_DAYS): Date {
         return between(today(), today().plusDays(numberOfDays.toLong()))
     }
 
+    @JvmOverloads
     fun backward(numberOfDays: Int = DEFAULT_NUM_OF_DAYS): Date {
         return between(today().minusDays(numberOfDays.toLong()), today())
     }
 
+    @JvmOverloads
     fun birthday(minAge: Int = DEFAULT_MIN_AGE, maxAge: Int = DEFAULT_MAX_AGE): Date {
         return between(today().plusYears(minAge.toLong()), today().plusYears(maxAge.toLong()))
     }
diff --git a/lib/src/main/kotlin/io/bloco/faker/components/Internet.kt b/lib/src/main/kotlin/io/bloco/faker/components/Internet.kt
@@ -4,18 +4,23 @@ import io.bloco.faker.FakerComponent
 import io.bloco.faker.FakerData
 
 class Internet(data: FakerData) : FakerComponent(data) {
+
+    @JvmOverloads
     fun email(name: String? = null): String {
         return userName(name) + "@" + domainName()
     }
 
+    @JvmOverloads
     fun freeEmail(name: String? = null): String {
         return userName(name) + "@" + fetch("internet.free_email")
     }
 
+    @JvmOverloads
     fun safeEmail(name: String? = null): String {
         return userName(name) + "@" + SAFE_EMAIL_HOST + randomHelper.sample(SAFE_EMAIL_TLDS)
     }
 
+    @JvmOverloads
     fun userName(specifier: String? = null, separators: List<String> = DEFAULT_SEPARATORS): String {
         val separator = randomHelper.sample(separators)
         return when {
@@ -34,6 +39,7 @@ class Internet(data: FakerData) : FakerComponent(data) {
         }
     }
 
+    @JvmOverloads
     fun password(
         minLength: Int = PASSWORD_MIN_LENGTH,
         maxLength: Int = PASSWORD_MAX_LENGTH,
@@ -105,6 +111,7 @@ class Internet(data: FakerData) : FakerComponent(data) {
         return "http://$host$path"
     }
 
+    @JvmOverloads
     fun slug(
         words: List<String> = listOf(fetch("lorem.words"), fetch("lorem.words")),
         glue: String = randomHelper.sample(DEFAULT_SLUG_GLUE)
diff --git a/lib/src/main/kotlin/io/bloco/faker/components/Lorem.kt b/lib/src/main/kotlin/io/bloco/faker/components/Lorem.kt
@@ -12,6 +12,7 @@ class Lorem(data: FakerData?) : FakerComponent(data!!) {
         return fetch("lorem.supplemental")
     }
 
+    @JvmOverloads
     fun words(num: Int = DEFAULT_NUM, supplemental: Boolean = DEFAULT_SUPPLEMENTAL): List<String> {
         return List(num) {
             if (supplemental && randomHelper.randBoolean()) {
@@ -30,6 +31,7 @@ class Lorem(data: FakerData?) : FakerComponent(data!!) {
         return List(count) { character() }.joinToString("")
     }
 
+    @JvmOverloads
     fun sentence(
         wordCount: Int = DEFAULT_WORD_COUNT,
         supplemental: Boolean = DEFAULT_SUPPLEMENTAL,
@@ -41,13 +43,15 @@ class Lorem(data: FakerData?) : FakerComponent(data!!) {
             .replaceFirstChar { it.titlecase() } + "."
     }
 
+    @JvmOverloads
     fun sentences(
         sentenceCount: Int = DEFAULT_SENTENCE_COUNT,
         supplemental: Boolean = DEFAULT_SUPPLEMENTAL
     ): List<String> {
         return List(sentenceCount) { sentence(DEFAULT_WORD_COUNT, supplemental) }
     }
 
+    @JvmOverloads
     fun paragraph(
         sentenceCount: Int = DEFAULT_SENTENCE_COUNT,
         supplemental: Boolean = DEFAULT_SUPPLEMENTAL,
@@ -58,13 +62,15 @@ class Lorem(data: FakerData?) : FakerComponent(data!!) {
         return sentences.joinToString(" ")
     }
 
+    @JvmOverloads
     fun paragraphs(
         paragraphCount: Int = DEFAULT_PARAGRAPH_COUNT,
         supplemental: Boolean = DEFAULT_SUPPLEMENTAL
     ): List<String> {
         return List(paragraphCount) { paragraph(DEFAULT_SENTENCE_COUNT, supplemental) }
     }
 
+    @JvmOverloads
     fun question(
         wordCount: Int = 4,
         supplemental: Boolean = false,
@@ -77,7 +83,7 @@ class Lorem(data: FakerData?) : FakerComponent(data!!) {
         return "$sentence?"
     }
 
-
+    @JvmOverloads
     fun questions(questionsCount: Int = 3, supplemental: Boolean = false): List<String> {
         return List(questionsCount) { question(3, supplemental) }
     }
diff --git a/lib/src/main/kotlin/io/bloco/faker/components/Number.kt b/lib/src/main/kotlin/io/bloco/faker/components/Number.kt
@@ -44,6 +44,7 @@ class Number(data: FakerData) : FakerComponent(data) {
         return "%0${digits}x".format(num)
     }
 
+    @JvmOverloads
     fun between(from: Int = DEFAULT_FROM, to: Int = DEFAULT_TO): Int {
         return randomHelper.range(from, to)
     }
@@ -56,6 +57,7 @@ class Number(data: FakerData) : FakerComponent(data) {
         return randomHelper.range(from, to)
     }
 
+    @JvmOverloads
     fun positive(from: Int = DEFAULT_FROM, to: Int = DEFAULT_TO): Int {
         return abs(between(from, to))
     }
@@ -68,6 +70,7 @@ class Number(data: FakerData) : FakerComponent(data) {
         return abs(between(from, to))
     }
 
+    @JvmOverloads
     fun negative(from: Int = DEFAULT_FROM, to: Int = DEFAULT_TO): Int {
         return abs(between(from, to)) * -1
     }
diff --git a/lib/src/main/kotlin/io/bloco/faker/components/Placeholdit.kt b/lib/src/main/kotlin/io/bloco/faker/components/Placeholdit.kt
@@ -4,6 +4,8 @@ import io.bloco.faker.FakerComponent
 import io.bloco.faker.FakerData
 
 class Placeholdit(data: FakerData) : FakerComponent(data) {
+
+    @JvmOverloads
     fun image(
         size: String = "300x300",
         format: String = "png",
@@ -32,7 +34,7 @@ class Placeholdit(data: FakerData) : FakerComponent(data) {
     companion object {
         val SUPPORTED_FORMATS = listOf("png", "jpg", "jpeg", "gif")
         private const val PLACEHOLDER_URL = "https://placehold.it/"
-        private const val SIZE_REGEX =  "^[0-9]+x[0-9]+$";
+        private const val SIZE_REGEX =  "^[0-9]+x[0-9]+$"
         private const val HEX_REGEX = "((?:^[0-9a-fA-F]{3}$)|(?:^[0-9a-fA-F]{6}$)){1}(?!.*[^0-9a-fA-F])"
     }
 }
diff --git a/lib/src/main/kotlin/io/bloco/faker/components/Time.kt b/lib/src/main/kotlin/io/bloco/faker/components/Time.kt
@@ -19,10 +19,12 @@ class Time(fakerData: FakerData) : FakerComponent(fakerData) {
         return between(from, to, Period.All)
     }
 
+    @JvmOverloads
     fun forward(numberOfDays: Int, period: Period = Period.All): Date {
         return randomTime(now(), period).plusDays(numberOfDays.toLong()).toDate()
     }
 
+    @JvmOverloads
     fun backward(numberOfDays: Int, period: Period = Period.All): Date {
         return randomTime(now(), period).minusDays(numberOfDays.toLong()).toDate()
     }

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ import io.bloco.faker.FakerComponent`
`4`	`4`	`import io.bloco.faker.FakerData`
`5`	`5`
`6`	`6`	`class Bool(data: FakerData) : FakerComponent(data) {`
	`7`	`+ @JvmOverloads`
`7`	`8`	`fun bool(trueRatio: Float = 0.5f): Boolean {`
`8`	`9`	`return Math.random() < trueRatio`
`9`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,13 +10,13 @@ class Commerce(data: FakerData) : FakerComponent(data) {`
`10`	`10`	`return call("color.colorName")`
`11`	`11`	`}`
`12`	`12`
	`13`	`+ @JvmOverloads`
`13`	`14`	`fun department(max: Int = 3, fixedAmount: Boolean = false): String {`
`14`	`15`	`val num = if (fixedAmount) max else randomHelper.number(max) + 1`
`15`	`16`	`val categories = getCategories(num)`
`16`	`17`	`return if (num > 1) mergeCategories(categories) else categories.first()`
`17`	`18`	`}`
`18`	`19`
`19`		`-`
`20`	`20`	`fun productName(): String {`
`21`	`21`	`return listOf(`
`22`	`22`	`fetch("commerce.product_name.adjective"),`
`@@ -25,15 +25,16 @@ class Commerce(data: FakerData) : FakerComponent(data) {`
`25`	`25`	`).joinToString(" ")`
`26`	`26`	`}`
`27`	`27`
`28`		`-`
`29`	`28`	`fun material(): String {`
`30`	`29`	`return fetch("commerce.product_name.material")`
`31`	`30`	`}`
`32`	`31`
	`32`	`+ @JvmOverloads`
`33`	`33`	`fun price(min: Int = 0, max: Int = 100): BigDecimal {`
`34`	`34`	`return BigDecimal(randomHelper.range(min, max)).setScale(2, RoundingMode.HALF_UP)`
`35`	`35`	`}`
`36`	`36`
	`37`	`+ @JvmOverloads`
`37`	`38`	`fun promotionCode(digits: Int = 6): String {`
`38`	`39`	`return listOf(`
`39`	`40`	`fetch("commerce.promotion_code.adjective"),`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ import java.util.Date`
`12`	`12`	`import kotlin.random.Random`
`13`	`13`
`14`	`14`	`class Date(fakerData: FakerData) : FakerComponent(fakerData) {`
`15`		`- private var formatter: SimpleDateFormat = SimpleDateFormat("yyyy-MM-dd")`
	`15`	`+ private val formatter = SimpleDateFormat("yyyy-MM-dd")`
`16`	`16`
`17`	`17`	`fun between(from: String, to: String): Date {`
`18`	`18`	`return try {`
`@@ -28,14 +28,17 @@ class Date(fakerData: FakerData) : FakerComponent(fakerData) {`
`28`	`28`	`return between(from.toLocalDate(), to.toLocalDate())`
`29`	`29`	`}`
`30`	`30`
	`31`	`+ @JvmOverloads`
`31`	`32`	`fun forward(numberOfDays: Int = DEFAULT_NUM_OF_DAYS): Date {`
`32`	`33`	`return between(today(), today().plusDays(numberOfDays.toLong()))`
`33`	`34`	`}`
`34`	`35`
	`36`	`+ @JvmOverloads`
`35`	`37`	`fun backward(numberOfDays: Int = DEFAULT_NUM_OF_DAYS): Date {`
`36`	`38`	`return between(today().minusDays(numberOfDays.toLong()), today())`
`37`	`39`	`}`
`38`	`40`
	`41`	`+ @JvmOverloads`
`39`	`42`	`fun birthday(minAge: Int = DEFAULT_MIN_AGE, maxAge: Int = DEFAULT_MAX_AGE): Date {`
`40`	`43`	`return between(today().plusYears(minAge.toLong()), today().plusYears(maxAge.toLong()))`
`41`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,18 +4,23 @@ import io.bloco.faker.FakerComponent`
`4`	`4`	`import io.bloco.faker.FakerData`
`5`	`5`
`6`	`6`	`class Internet(data: FakerData) : FakerComponent(data) {`
	`7`	`+`
	`8`	`+ @JvmOverloads`
`7`	`9`	`fun email(name: String? = null): String {`
`8`	`10`	`return userName(name) + "@" + domainName()`
`9`	`11`	`}`
`10`	`12`
	`13`	`+ @JvmOverloads`
`11`	`14`	`fun freeEmail(name: String? = null): String {`
`12`	`15`	`return userName(name) + "@" + fetch("internet.free_email")`
`13`	`16`	`}`
`14`	`17`
	`18`	`+ @JvmOverloads`
`15`	`19`	`fun safeEmail(name: String? = null): String {`
`16`	`20`	`return userName(name) + "@" + SAFE_EMAIL_HOST + randomHelper.sample(SAFE_EMAIL_TLDS)`
`17`	`21`	`}`
`18`	`22`
	`23`	`+ @JvmOverloads`
`19`	`24`	`fun userName(specifier: String? = null, separators: List<String> = DEFAULT_SEPARATORS): String {`
`20`	`25`	`val separator = randomHelper.sample(separators)`
`21`	`26`	`return when {`
`@@ -34,6 +39,7 @@ class Internet(data: FakerData) : FakerComponent(data) {`
`34`	`39`	`}`
`35`	`40`	`}`
`36`	`41`
	`42`	`+ @JvmOverloads`
`37`	`43`	`fun password(`
`38`	`44`	`minLength: Int = PASSWORD_MIN_LENGTH,`
`39`	`45`	`maxLength: Int = PASSWORD_MAX_LENGTH,`
`@@ -105,6 +111,7 @@ class Internet(data: FakerData) : FakerComponent(data) {`
`105`	`111`	`return "http://$host$path"`
`106`	`112`	`}`
`107`	`113`
	`114`	`+ @JvmOverloads`
`108`	`115`	`fun slug(`
`109`	`116`	`words: List<String> = listOf(fetch("lorem.words"), fetch("lorem.words")),`
`110`	`117`	`glue: String = randomHelper.sample(DEFAULT_SLUG_GLUE)`
Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,7 @@ class Number(data: FakerData) : FakerComponent(data) {`
`44`	`44`	`return "%0${digits}x".format(num)`
`45`	`45`	`}`
`46`	`46`
	`47`	`+ @JvmOverloads`
`47`	`48`	`fun between(from: Int = DEFAULT_FROM, to: Int = DEFAULT_TO): Int {`
`48`	`49`	`return randomHelper.range(from, to)`
`49`	`50`	`}`
`@@ -56,6 +57,7 @@ class Number(data: FakerData) : FakerComponent(data) {`
`56`	`57`	`return randomHelper.range(from, to)`
`57`	`58`	`}`
`58`	`59`
	`60`	`+ @JvmOverloads`
`59`	`61`	`fun positive(from: Int = DEFAULT_FROM, to: Int = DEFAULT_TO): Int {`
`60`	`62`	`return abs(between(from, to))`
`61`	`63`	`}`
`@@ -68,6 +70,7 @@ class Number(data: FakerData) : FakerComponent(data) {`
`68`	`70`	`return abs(between(from, to))`
`69`	`71`	`}`
`70`	`72`
	`73`	`+ @JvmOverloads`
`71`	`74`	`fun negative(from: Int = DEFAULT_FROM, to: Int = DEFAULT_TO): Int {`
`72`	`75`	`return abs(between(from, to)) * -1`
`73`	`76`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,10 +19,12 @@ class Time(fakerData: FakerData) : FakerComponent(fakerData) {`
`19`	`19`	`return between(from, to, Period.All)`
`20`	`20`	`}`
`21`	`21`
	`22`	`+ @JvmOverloads`
`22`	`23`	`fun forward(numberOfDays: Int, period: Period = Period.All): Date {`
`23`	`24`	`return randomTime(now(), period).plusDays(numberOfDays.toLong()).toDate()`
`24`	`25`	`}`
`25`	`26`
	`27`	`+ @JvmOverloads`
`26`	`28`	`fun backward(numberOfDays: Int, period: Period = Period.All): Date {`
`27`	`29`	`return randomTime(now(), period).minusDays(numberOfDays.toLong()).toDate()`
`28`	`30`	`}`