Skip to content

Commit

Permalink
updating v1.9.1 changelog and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pk044 committed Apr 8, 2021
1 parent f9e782f commit a4f40ea
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 16 deletions.
11 changes: 11 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
## Version 1.9.1
> 8.04.2021
* Added Mergify
* Dependency updates
* Added ScalaCheck generators
* Added json-schema support
* Added Numeric instances for tagged types using CaseClass1Rep
* Fixed `examples` module not compiling on CI
* Removed compiler warnings
* Provide mappings for all standard Java types

## Version 1.9.0
> 29.01.2021
* Added experimental version of Circe support
Expand Down
36 changes: 20 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,44 +31,44 @@ Slick (`kebs-slick`), Spray (`kebs-spray-json`), Play (`kebs-play-json`), Circe

Support for `slick`

`libraryDependencies += "pl.iterators" %% "kebs-slick" % "1.9.0"`
`libraryDependencies += "pl.iterators" %% "kebs-slick" % "1.9.1"`

Support for `spray-json`

`libraryDependencies += "pl.iterators" %% "kebs-spray-json" % "1.9.0"`
`libraryDependencies += "pl.iterators" %% "kebs-spray-json" % "1.9.1"`

Support for `play-json`

`libraryDependencies += "pl.iterators" %% "kebs-play-json" % "1.9.0"`
`libraryDependencies += "pl.iterators" %% "kebs-play-json" % "1.9.1"`

Support for `circe`

`libraryDependencies += "pl.iterators" %% "kebs-circe" % "1.9.0"`
`libraryDependencies += "pl.iterators" %% "kebs-circe" % "1.9.1"`

Support for `json-schema`

`libraryDependencies += "pl.iterators" %% "kebs-jsonschema" % "1.9.0"`
`libraryDependencies += "pl.iterators" %% "kebs-jsonschema" % "1.9.1"`

Support for `scalacheck`

`libraryDependencies += "pl.iterators" %% "kebs-scalacheck" % "1.9.0"`
`libraryDependencies += "pl.iterators" %% "kebs-scalacheck" % "1.9.1"`

Support for `akka-http`

`libraryDependencies += "pl.iterators" %% "kebs-akka-http" % "1.9.0"`
`libraryDependencies += "pl.iterators" %% "kebs-akka-http" % "1.9.1"`

Support for `tagged types`

`libraryDependencies += "pl.iterators" %% "kebs-tagged" % "1.9.0"`
`libraryDependencies += "pl.iterators" %% "kebs-tagged" % "1.9.1"`

or for tagged-types code generation support

`libraryDependencies += "pl.iterators" %% "kebs-tagged-meta" % "1.9.0"`
`libraryDependencies += "pl.iterators" %% "kebs-tagged-meta" % "1.9.1"`
`addCompilerPlugin("org.scalameta" % "paradise" % "3.0.0-M11" cross CrossVersion.full)`

Support for `instances`

`libraryDependencies += "pl.iterators" %% "kebs-instances" % "1.9.0"`
`libraryDependencies += "pl.iterators" %% "kebs-instances" % "1.9.1"`

Builds for Scala `2.12` and `2.13` are provided.

Expand Down Expand Up @@ -789,7 +789,9 @@ Also, `CaseClass1Rep` is generated for each tag meaning you will get a lot of `k

### JsonSchema support

Kebs contains a macro, which generate wrapped jsonschema object of `https://github.com/andyglow/scala-jsonschema`.
**Still at experimental stage.**

Kebs contains a macro which generates wrapped Json Schema object of `https://github.com/andyglow/scala-jsonschema`.
Kebs also provides proper implicits conversions for their tagged types and common Java types.
To get your json schema you need to use import pl.iterators.kebs.jsonschema.KebsJsonSchema
(together with pl.iterators.kebs.jsonschema.KebsJsonSchemaPredefs if you need support for more Java types).
Expand Down Expand Up @@ -823,13 +825,15 @@ object Sample extends KebsJsonSchema {

### Scalacheck support

Kebs provides support to use tagged types in your Arbitrary from scalacheck.
Along with this kebs provides support for Java types.
**Still at experimental stage.**

Kebs provides support to use tagged types in your Arbitrary instances from ScalaCheck.
Additionally, Kebs provides support for Java types.
Kebs also introduces term of minimal and maximal generator.
The minimal generator is an generator which always generates empty collection of Option, Set, Map etc.
The maximum - in the opposite - always generate non-empty collections.
The minimal generator is a generator which always generates empty collection of Option, Set, Map etc.
The maximum - in the opposite - always generates non-empty collections.
Kebs provides an useful trait called AllGenerators which binds minimal, normal and maximal generator all together,
so you can get easy generate the representation you currently need for tests.
so you can easily generate the representation you currently need for tests.

```scala
import pl.iterators.kebs.scalacheck.{KebsArbitraryPredefs, KebsScalacheckGenerators}
Expand Down

0 comments on commit a4f40ea

Please sign in to comment.