Skip to content

Commit

Permalink
[Release] Prepare Version 0.9.0 (#164)
Browse files Browse the repository at this point in the history
* readme

* migration guide

* changelog

* release baby

* small p

* update deprecation messages

Co-authored-by: Kyle <[hopeman1986@gmail.com]>
  • Loading branch information
hopeman15 and Kyle authored Mar 22, 2022
1 parent 65c2037 commit 5a8e5f2
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 10 deletions.
9 changes: 6 additions & 3 deletions CHANGELOG.MD
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
## [0.9.0] - Not released yet
## [0.9.0] - March 22nd 2022

* Support for map collection type
* Better output message when using `attempt`
* Support for map collection type.
* Better output message when using `attempt`.
* Removed the custom Provider interface in favor of `javax.inject.Provider`.
* See [Migration Guide](https://github.com/HelloCuriosity/model-forge/blob/main/MIGRATION.MD) for details.
* Moved dependency definitions to `buildSrc`
* Fixed StringProvider to be more explicit when generating strings.

## [0.8.0] - December 7th 2021

Expand Down
16 changes: 16 additions & 0 deletions MIGRATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Migration Guide

## 0.9.0

In version 0.9.0 we removed the custom provider in favor of javax provider for easier
adaptation in other projects.

Replace all instances of:
```kotlin
import io.github.hellocuriosity.providers.Provider
```

with:
```kotlin
import javax.inject.Provider
```
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Model Forge is a library to automate model generation for automated testing:

```kotlin
dependencies {
testImplementation("io.github.hellocuriosity:model-forge:0.8.0")
testImplementation("io.github.hellocuriosity:model-forge:0.9.0")
}
```

Expand All @@ -34,7 +34,7 @@ dependencies {

```groovy
dependencies {
testImplementation 'io.github.hellocuriosity:model-forge:0.8.0'
testImplementation 'io.github.hellocuriosity:model-forge:0.9.0'
}
```

Expand All @@ -53,7 +53,7 @@ repositories {
}

dependencies {
testImplementation("io.github.hellocuriosity:model-forge:0.8.0.xx-SNAPSHOT")
testImplementation("io.github.hellocuriosity:model-forge:0.9.0.xx-SNAPSHOT")
}
```

Expand All @@ -68,7 +68,7 @@ repositories {
}
dependencies {
testImplementation 'io.github.hellocuriosity:model-forge:0.8.0.xx-SNAPSHOT'
testImplementation 'io.github.hellocuriosity:model-forge:0.9.0.xx-SNAPSHOT'
}
```

Expand Down Expand Up @@ -183,7 +183,7 @@ Model Forge currently supports the auto generation for the following types:
### Collections

* List
* Map (_SNAPSHOT_)
* Map
* Set

_Can't find your data type? Feel free to create a pull request or open an issue_ :parachute:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ public inline fun <reified T : Any> forgery(forger: ModelForge = ModelForge()):
}

@Deprecated(
"forgeries is not used and will be removed in the future.",
"forgeries is not used and will be removed in version 1.0.0.",
ReplaceWith("forgeryList(forger: ModelForge = ModelForge(), size: Int = 10)")
)
public inline fun <reified T : Any> forgeries(forger: ModelForge = ModelForge(), size: Int = 10): Lazy<List<T>> = lazy {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public fun <T : Any> ModelForge.addProvider(clazz: KClass<T>, provider: Provider
public inline fun <reified T : Any> ModelForge.build(): T = build(T::class)

@Deprecated(
"ModelForge.build is not used and will be removed in the future.",
"ModelForge.build is not used and will be removed in version 1.0.0.",
ReplaceWith("ModelForge.buildList(size: Int = 10)")
)
public inline fun <reified T : Any> ModelForge.build(size: Int = 10): List<T> = buildList(T::class, size)
Expand Down

0 comments on commit 5a8e5f2

Please sign in to comment.