Provide direct support for Map #142

pierangeloc · 2021-10-30T15:48:25Z

Resolves #138

CLAassistant · 2021-10-30T15:48:28Z

All committers have signed the CLA.

pierangeloc · 2021-10-31T22:35:21Z

@thinkharderdev While working on the Json serialization, and looking also at the Map as supported by DynamoDB (or by other formats such as Postgres hstore), it makes probably most sense to support Schema not for Map[K, V] with K and V having a Schema, but just for Map[String, V] with V having a Schema.
Should we apply this restriction?

thinkharderdev · 2021-11-01T11:57:21Z

@thinkharderdev While working on the Json serialization, and looking also at the Map as supported by DynamoDB (or by other formats such as Postgres hstore), it makes probably most sense to support Schema not for Map[K, V] with K and V having a Schema, but just for Map[String, V] with V having a Schema.
Should we apply this restriction?

I think we do want to support Map[K,V]. For JSON serialization (and also for other codecs) we would encode this as an array of tuples. So something like

case class Key(keyName: String, data: Int)
case class Value(value: String)

case class Foo(map: Map[Key,Value]

would get JSON encoded as

{"map":[{"left":{"keyName":"k","data":0},"right":{"value":"something"}}]

pierangeloc · 2021-11-06T17:01:55Z

@thinkharderdev I implemented the codecs as you suggested, and added unit tests

thinkharderdev · 2021-11-07T16:10:20Z

Looks great! I think you need to run Scalafmt again though to fix the listing errors.

Unit tests for json serdes Unit tests for protobuf serdes

pierangeloc · 2021-11-08T23:37:22Z

@thinkharderdev thanks, rebased and reformatted!

thinkharderdev · 2021-11-09T11:25:25Z

@thinkharderdev thanks, rebased and reformatted!

Seems like there is another linter error

pierangeloc · 2021-11-09T20:28:55Z

build.sbt was unformatted. I also added a small paragraph for contributors in the readme.md

thinkharderdev · 2021-11-11T12:42:15Z

build.sbt was unformatted. I also added a small paragraph for contributors in the readme.md

Linter is still failing :). I think you want to run sbt prepare instead of sbt fmt. The latter will only run scalafmt while the former will run scalafix and scalafmt.

thinkharderdev · 2021-11-11T12:43:33Z

README.md

+sbt test
+
+sbt fmt


I would reverse the order here and change sbt fmt to sbt prepare, so:

sbt prepare sbt test

since on rare occassions scalafix can make changes that cause compilation to fail.

@thinkharderdev thanks, now the linter should be happy 🤞

thinkharderdev

Awesome work!

@thinkharderdev

* added basic documentation with example * added more dependencies to docs * incorporated feedback by @thinkharderdev * fixed wording 'ZIO-Schema' -> 'ZIO Schema' * fixed naming of other zio libraries * fix sbt publish setting * added examples subproject * docs: fixed mdoc link and added version placeholder in overview/index.md * docs: incorporated suggestions by @TobiasPfeifer * scalafmt for build.sbt * incorporated suggestions by @thinkharderdev * Support for annotations on all types (#147) * Add addonation to Schema[A] interface and add as field in Schema.Sequence * Add annotation field to Schema.Transform * Add annotation field to Schema.Primitive * Add annotations field to Schema.Optional * Add annotations field to Schema.Fail * Add annotations field to Schema.Tuple * Add annotations field to EitherSchema * Add annotations field to Schema.Lazy * Add annotations field to Schema.Meta * Add remaining assertion equality checks to equalsSchema * Remove annotations from Record[A] (since it exists in Schema[A] already) and add annotations field to Schema.GenericRecord * Fix test case for schema generation on annotated ADT * Fix handling of annotations for Lazy (and thus failing tests) * Wherever we accept an annotations chunk in the constructor/method we default it to Chunk.empty * Add `def annotate(annotation: Any): Schema[A]` to Schema * Replace usage of Chunk.appended with :+ to fix 2.12.12 compilation * Provide direct support for Map (#142) * Provide direct support for Map Unit tests for json serdes Unit tests for protobuf serdes * run scalafmt * Rebased/reformatted * Rebased/reformatted, and added a minimum contribution guide * Run sbt `prepare test` instead of `fmt test` * Add defaultValue to Schema (#80) * feat(schema): add first draft defaultValue implementation for Schema * feat(schema): add missing test cases * feat(schema): change default value for BoolType to false * feat(schema): fold default values in Record type appropriately * fix(zio-schema): fix failing test * feat(zio-schema): add defaultValue implementation for MapSchema * patch(zio-schema): remove orElse for Scala 2.12 compat * first commit * [zio-schema-examples] sbt setup * [zio-schema-examples] readme init * [zio-schema-examples] example 1 * [zio-schema-examples] example 2 * [zio-schema-examples] example 3 (WIP) * [zio-schema-examples] example 3 * [zio-schema-examples] Example3: Don't share domain with other samples * [zio-schema-examples] Example4 transforming DTOs * [zio-schema-examples] Example5 diffing * [zio-schema-examples] example 4: fixed map/flatmap in example * [zio-schema-examples] example 4: another try to converting DTOs * [zio-schema-examples] example 6 reified optics stub * [zio-schema-examples] example 6 reified optics examples * [zio-schema-examples] example 1 + 2: schema fixes for newest zio-schema * [zio-schema-examples] Problem 7: Initial code * [zio-schema-examples] Example 6: adding employee now works * [zio-schema-examples] Example 7: added notes on performance requirements * [zio-schema-examples] Example 7: added parameter list to methods, fixed names * [zio-schema-examples] Example 7: added Person and Profile schema as implicits * [zio-schema-examples] Example 7: renamed method for viewing, added Runner * [zio-schema-examples] Example 7: sketched toDynamicValue method * [zio-schema-examples] Example 7: implemented toDynamicValue method * [zio-schema-examples] Example 7: primitive impl of decode using toDV * [zio-schema-examples] Example 7: produce multiple solutions, pick working one * [zio-schema-examples] Example 7: introduce QueryParam type alias and compile-function * [zio-schema-examples] Example 7: return static function on error case * [zio-schema-examples] Example 7: initial impl of Primitive(standardtype) * [zio-schema-examples] Example 7: implemented fail * [zio-schema-examples] Example 7: simple impl of lazy * [zio-schema-examples] Example 7: better lazy impl with `lazy val` * [zio-schema-examples] Example 7: impl of Meta * [zio-schema-examples] Example 7: impl of CaseClass1 * [zio-schema-examples] Example 7: impl of CaseClass2 * [zio-schema-examples] Example 7: impl of CaseClass3 * [zio-schema-examples] Example 7: extracted compiler to builder * [zio-schema-examples] Example 7: implemented Transform * [zio-schema-examples] * Example for an Encoder and Decoder using the DynamicValue API * Add scalafmt * Update zio-schema 0.1.2 * Update examples to account for annotations * revert local changes * moved sources to appropriate place * fixed example * [zio-schema-examples] reverted changes to build.sbt * [zio-schema-examples] removed additional build.sbt, fixed problems in example7, added explicit import in build.sbt * [zio-schema-examples] scalaFmt applied * Fix build for scala 2.12 and apply linter * Fix compilation errors for scala 2.12 * Unused imports Co-authored-by: Dominik Dorn <dominik@dominikdorn.com> Co-authored-by: Alexander van Olst <alexvanolst@gmail.com> Co-authored-by: Pierangelo Cecchetto <pierangeloc@gmail.com> Co-authored-by: Maxwell Brown <maxwellbrown1990@gmail.com> Co-authored-by: calvinlfer <calvin.l.fer@gmail.com>

* Provide direct support for Map Unit tests for json serdes Unit tests for protobuf serdes * run scalafmt * Rebased/reformatted * Rebased/reformatted, and added a minimum contribution guide * Run sbt `prepare test` instead of `fmt test`

@thinkharderdev

* added basic documentation with example * added more dependencies to docs * incorporated feedback by @thinkharderdev * fixed wording 'ZIO-Schema' -> 'ZIO Schema' * fixed naming of other zio libraries * fix sbt publish setting * added examples subproject * docs: fixed mdoc link and added version placeholder in overview/index.md * docs: incorporated suggestions by @TobiasPfeifer * scalafmt for build.sbt * incorporated suggestions by @thinkharderdev * Support for annotations on all types (zio#147) * Add addonation to Schema[A] interface and add as field in Schema.Sequence * Add annotation field to Schema.Transform * Add annotation field to Schema.Primitive * Add annotations field to Schema.Optional * Add annotations field to Schema.Fail * Add annotations field to Schema.Tuple * Add annotations field to EitherSchema * Add annotations field to Schema.Lazy * Add annotations field to Schema.Meta * Add remaining assertion equality checks to equalsSchema * Remove annotations from Record[A] (since it exists in Schema[A] already) and add annotations field to Schema.GenericRecord * Fix test case for schema generation on annotated ADT * Fix handling of annotations for Lazy (and thus failing tests) * Wherever we accept an annotations chunk in the constructor/method we default it to Chunk.empty * Add `def annotate(annotation: Any): Schema[A]` to Schema * Replace usage of Chunk.appended with :+ to fix 2.12.12 compilation * Provide direct support for Map (zio#142) * Provide direct support for Map Unit tests for json serdes Unit tests for protobuf serdes * run scalafmt * Rebased/reformatted * Rebased/reformatted, and added a minimum contribution guide * Run sbt `prepare test` instead of `fmt test` * Add defaultValue to Schema (zio#80) * feat(schema): add first draft defaultValue implementation for Schema * feat(schema): add missing test cases * feat(schema): change default value for BoolType to false * feat(schema): fold default values in Record type appropriately * fix(zio-schema): fix failing test * feat(zio-schema): add defaultValue implementation for MapSchema * patch(zio-schema): remove orElse for Scala 2.12 compat * first commit * [zio-schema-examples] sbt setup * [zio-schema-examples] readme init * [zio-schema-examples] example 1 * [zio-schema-examples] example 2 * [zio-schema-examples] example 3 (WIP) * [zio-schema-examples] example 3 * [zio-schema-examples] Example3: Don't share domain with other samples * [zio-schema-examples] Example4 transforming DTOs * [zio-schema-examples] Example5 diffing * [zio-schema-examples] example 4: fixed map/flatmap in example * [zio-schema-examples] example 4: another try to converting DTOs * [zio-schema-examples] example 6 reified optics stub * [zio-schema-examples] example 6 reified optics examples * [zio-schema-examples] example 1 + 2: schema fixes for newest zio-schema * [zio-schema-examples] Problem 7: Initial code * [zio-schema-examples] Example 6: adding employee now works * [zio-schema-examples] Example 7: added notes on performance requirements * [zio-schema-examples] Example 7: added parameter list to methods, fixed names * [zio-schema-examples] Example 7: added Person and Profile schema as implicits * [zio-schema-examples] Example 7: renamed method for viewing, added Runner * [zio-schema-examples] Example 7: sketched toDynamicValue method * [zio-schema-examples] Example 7: implemented toDynamicValue method * [zio-schema-examples] Example 7: primitive impl of decode using toDV * [zio-schema-examples] Example 7: produce multiple solutions, pick working one * [zio-schema-examples] Example 7: introduce QueryParam type alias and compile-function * [zio-schema-examples] Example 7: return static function on error case * [zio-schema-examples] Example 7: initial impl of Primitive(standardtype) * [zio-schema-examples] Example 7: implemented fail * [zio-schema-examples] Example 7: simple impl of lazy * [zio-schema-examples] Example 7: better lazy impl with `lazy val` * [zio-schema-examples] Example 7: impl of Meta * [zio-schema-examples] Example 7: impl of CaseClass1 * [zio-schema-examples] Example 7: impl of CaseClass2 * [zio-schema-examples] Example 7: impl of CaseClass3 * [zio-schema-examples] Example 7: extracted compiler to builder * [zio-schema-examples] Example 7: implemented Transform * [zio-schema-examples] * Example for an Encoder and Decoder using the DynamicValue API * Add scalafmt * Update zio-schema 0.1.2 * Update examples to account for annotations * revert local changes * moved sources to appropriate place * fixed example * [zio-schema-examples] reverted changes to build.sbt * [zio-schema-examples] removed additional build.sbt, fixed problems in example7, added explicit import in build.sbt * [zio-schema-examples] scalaFmt applied * Fix build for scala 2.12 and apply linter * Fix compilation errors for scala 2.12 * Unused imports Co-authored-by: Dominik Dorn <dominik@dominikdorn.com> Co-authored-by: Alexander van Olst <alexvanolst@gmail.com> Co-authored-by: Pierangelo Cecchetto <pierangeloc@gmail.com> Co-authored-by: Maxwell Brown <maxwellbrown1990@gmail.com> Co-authored-by: calvinlfer <calvin.l.fer@gmail.com>

pierangeloc requested a review from a team as a code owner October 30, 2021 15:48

zalbia mentioned this pull request Nov 1, 2021

Support native schema for Set #139

Closed

2 tasks

pierangeloc force-pushed the support-map branch 3 times, most recently from 02fad4b to 580b3c9 Compare November 6, 2021 17:00

pierangeloc added 3 commits November 8, 2021 17:22

Provide direct support for Map

38b60cd

Unit tests for json serdes Unit tests for protobuf serdes

run scalafmt

f6aebef

Rebased/reformatted

430e39f

pierangeloc force-pushed the support-map branch from e068f51 to 430e39f Compare November 8, 2021 23:34

Rebased/reformatted, and added a minimum contribution guide

52f4f2f

thinkharderdev reviewed Nov 11, 2021

View reviewed changes

Run sbt prepare test instead of fmt test

a030f9a

thinkharderdev approved these changes Nov 14, 2021

View reviewed changes

thinkharderdev merged commit b94ac75 into zio:main Nov 14, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Provide direct support for Map #142

Provide direct support for Map #142

pierangeloc commented Oct 30, 2021

CLAassistant commented Oct 30, 2021 •

edited

Loading

pierangeloc commented Oct 31, 2021

thinkharderdev commented Nov 1, 2021

pierangeloc commented Nov 6, 2021

thinkharderdev commented Nov 7, 2021

pierangeloc commented Nov 8, 2021

thinkharderdev commented Nov 9, 2021

pierangeloc commented Nov 9, 2021

thinkharderdev commented Nov 11, 2021

thinkharderdev Nov 11, 2021

pierangeloc Nov 13, 2021

thinkharderdev left a comment

Provide direct support for Map #142

Provide direct support for Map #142

Conversation

pierangeloc commented Oct 30, 2021

CLAassistant commented Oct 30, 2021 • edited Loading

pierangeloc commented Oct 31, 2021

thinkharderdev commented Nov 1, 2021

pierangeloc commented Nov 6, 2021

thinkharderdev commented Nov 7, 2021

pierangeloc commented Nov 8, 2021

thinkharderdev commented Nov 9, 2021

pierangeloc commented Nov 9, 2021

thinkharderdev commented Nov 11, 2021

thinkharderdev Nov 11, 2021

Choose a reason for hiding this comment

pierangeloc Nov 13, 2021

Choose a reason for hiding this comment

thinkharderdev left a comment

Choose a reason for hiding this comment

CLAassistant commented Oct 30, 2021 •

edited

Loading