Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix for reading Some(Map.empty) #529

Merged
merged 3 commits into from
Sep 11, 2023
Merged

Fix for reading Some(Map.empty) #529

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1a3e5f0
Failing test demonstrating issue
martinw-ct Sep 4, 2023
1b0daf8
Added specialized reader for Option[Map[String, A]]
martinw-ct Sep 11, 2023
965f752
Added test for optional list
martinw-ct Sep 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions json/json-core/src/main/scala/io/sphere/json/FromJSON.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,17 @@ object FromJSON extends FromJSONInstances {
private def validEmptyVector[A]: Valid[Vector[A]] =
validEmptyAnyVector.asInstanceOf[Valid[Vector[A]]]

implicit def optionMapReader[@specialized A](implicit
c: FromJSON[A]): FromJSON[Option[Map[String, A]]] =
new FromJSON[Option[Map[String, A]]] {
private val internalMapReader = mapReader[A]

def read(jval: JValue): JValidation[Option[Map[String, A]]] = jval match {
case JNothing | JNull => validNone
case x => internalMapReader.read(x).map(Some.apply)
}
}

implicit def optionReader[@specialized A](implicit c: FromJSON[A]): FromJSON[Option[A]] =
new FromJSON[Option[A]] {
def read(jval: JValue): JValidation[Option[A]] = jval match {
Expand Down
46 changes: 46 additions & 0 deletions json/json-derivation/src/test/scala/io/sphere/json/OptionReaderSpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package io.sphere.json

import io.sphere.json.generic._
import org.json4s.{JArray, JLong, JNothing, JObject, JString}
import org.scalatest.OptionValues
import org.scalatest.matchers.must.Matchers
import org.scalatest.wordspec.AnyWordSpec
Expand All @@ -19,6 +20,15 @@ object OptionReaderSpec {
implicit val json: JSON[ComplexClass] = jsonProduct(apply _)
}

case class MapClass(id: Long, map: Option[Map[String, String]])
object MapClass {
implicit val json: JSON[MapClass] = jsonProduct(apply _)
}

case class ListClass(id: Long, list: Option[List[String]])
object ListClass {
implicit val json: JSON[ListClass] = jsonProduct(apply _)
}
}

class OptionReaderSpec extends AnyWordSpec with Matchers with OptionValues {
Expand Down Expand Up @@ -61,6 +71,42 @@ class OptionReaderSpec extends AnyWordSpec with Matchers with OptionValues {
result mustEqual None
}

"handle optional map" in {
getFromJValue[MapClass](JObject("id" -> JLong(1L))) mustEqual MapClass(1L, None)

getFromJValue[MapClass](JObject("id" -> JLong(1L), "map" -> JObject())) mustEqual
MapClass(1L, Some(Map.empty))

getFromJValue[MapClass](
JObject("id" -> JLong(1L), "map" -> JObject("a" -> JString("b")))) mustEqual
MapClass(1L, Some(Map("a" -> "b")))

toJValue[MapClass](MapClass(1L, None)) mustEqual
JObject("id" -> JLong(1L), "map" -> JNothing)
toJValue[MapClass](MapClass(1L, Some(Map()))) mustEqual
JObject("id" -> JLong(1L), "map" -> JObject())
toJValue[MapClass](MapClass(1L, Some(Map("a" -> "b")))) mustEqual
JObject("id" -> JLong(1L), "map" -> JObject("a" -> JString("b")))
}

"handle optional list" in {
getFromJValue[ListClass](
JObject("id" -> JLong(1L), "list" -> JArray(List(JString("hi"))))) mustEqual
ListClass(1L, Some(List("hi")))
getFromJValue[ListClass](JObject("id" -> JLong(1L), "list" -> JArray(List.empty))) mustEqual
ListClass(1L, Some(List()))
getFromJValue[ListClass](JObject("id" -> JLong(1L))) mustEqual
ListClass(1L, None)

toJValue(ListClass(1L, Some(List("hi")))) mustEqual JObject(
"id" -> JLong(1L),
"list" -> JArray(List(JString("hi"))))
toJValue(ListClass(1L, Some(List.empty))) mustEqual JObject(
"id" -> JLong(1L),
"list" -> JArray(List.empty))
toJValue(ListClass(1L, None)) mustEqual JObject("id" -> JLong(1L), "list" -> JNothing)
}

"handle absence of all fields mixed with ignored fields" in {
val json = """{ "value3": "a" }"""
val result = getFromJSON[Option[SimpleClass]](json)
Expand Down