Merge pull request #39 from bowbahdoe/cleanup-feb-20

Add more examples

Author: bowbahdoe

README.md

@@ -525,6 +525,7 @@ public class Main {
 </details>
 
 ### Decode an object with optional fields.
+
 <details>
     <summary>Show</summary>
 
@@ -676,6 +677,53 @@ public class Main {
 
 </details>
 
+### Decode json with a fixed set of keys
+
+<details>
+    <summary>Show</summary>
+
+```java
+import dev.mccue.json.Json;
+import dev.mccue.json.JsonDecodeException;
+import dev.mccue.json.JsonDecoder;
+
+import java.util.HashSet;
+import java.util.Set;
+
+record Prison(String location) {
+    public static Prison fromJson(Json json) {
+        var object = JsonDecoder.object(json);
+        var expected = Set.of("location");
+        if (!expected.equals(object.keySet())) {
+            var extra = new HashSet<>(object.keySet());
+            extra.removeAll(expected);
+            throw JsonDecodeException.of("Extra Keys: " + extra, json);
+        }
+
+        return new Prison(
+                JsonDecoder.field(json, "location", JsonDecoder::string)
+        );
+    }
+}
+public class Main {
+    public static void main(String[] args) {
+        Json withExtraKeys = Json.readString(
+                """
+                        {
+                            "location": "Siberia",
+                            "escapeMethod": "tunnelling"
+                        }
+                        """
+        );
+
+        var prison = Prison.fromJson(withExtraKeys);
+    }
+}
+```
+
+</details>
+
+
 ### Decode json into bean
 
 <details>
@@ -736,7 +784,11 @@ public class Main {
         var fozzie = new Fozzie();
         fozzie.setJoke(JsonDecoder.field(json, "joke", JsonDecoder::string));
         fozzie.setPunchline(JsonDecoder.field(json, "punchline", JsonDecoder::string));
-        fozzie.setHecklers(JsonDecoder.field(json, "hecklers", JsonDecoder.array(JsonDecoder::string)));
+        fozzie.setHecklers(JsonDecoder.field(
+                json, 
+                "hecklers", 
+                JsonDecoder.array(JsonDecoder::string)
+        ));
         return fozzie;
     }
 
@@ -817,4 +869,233 @@ public class Main {
 [Person[firstName=Great, lastName=Gonzo], Person[firstName=Jim, lastName=Henson]]
 ```
 
+</details>
+
+### Encode and Decode with Kotlin 
+
+<details>
+    <summary>Show</summary>
+
+```kotlin
+import dev.mccue.json.Json
+import dev.mccue.json.JsonDecoder
+import dev.mccue.json.JsonEncodable
+import dev.mccue.json.JsonWriteOptions
+
+data class Muppet(
+   val name: String,
+   val scientist: Boolean,
+   val lines: String?
+) : JsonEncodable {
+   override fun toJson(): Json =
+      Json.objectBuilder()
+         .put("name", name)
+         .put("scientist", scientist)
+         .put("lines", lines)
+         .build()
+
+   companion object {
+      fun fromJson(json: Json): Muppet =
+         Muppet(
+            JsonDecoder.field(json, "name") { JsonDecoder.string(it) },
+            JsonDecoder.field(json, "scientist") { JsonDecoder.boolean_(it) },
+            JsonDecoder.nullableField(json,
+               "lines",
+               { JsonDecoder.string(it) },
+               null
+            )
+         )
+   }
+}
+
+
+
+data class Movie(
+   val title: String,
+   val muppets: List<Muppet>
+) : JsonEncodable {
+   override fun toJson(): Json {
+      return Json.objectBuilder()
+         .put("title", title)
+         .put("muppets", muppets)
+         .build()
+   }
+
+   companion object {
+      fun fromJson(json: Json): Movie =
+         Movie(
+            JsonDecoder.field(json, "title") { JsonDecoder.string(it) },
+            JsonDecoder.field(json, "muppets", JsonDecoder.array { Muppet.fromJson(it) })
+         )
+   }
+}
+
+
+fun main(args: Array<String>) {
+   val movie = Movie(
+      "Most wanted",
+      listOf(
+         Muppet(
+            "kermit",
+            false,
+            "I'm not Constantine!"
+         ),
+         Muppet(
+            "beaker",
+            true,
+            null
+         ),
+         Muppet(
+            "bunsen",
+            true,
+            "I don't mean to be a stickler"
+         )
+      )
+   )
+
+   println(Json.writeString(movie, JsonWriteOptions().withIndentation(4)))
+
+   val movieRoundTripped = Movie.fromJson(Json.readString(Json.writeString(movie)))
+
+   println(movieRoundTripped)
+   println(movie)
+   println(movie == movieRoundTripped)
+}
+```
+
+```
+{
+    "title": "Most wanted",
+    "muppets": [
+        {
+            "name": "kermit",
+            "scientist": false,
+            "lines": "I'm not Constantine!"
+        },
+        {
+            "name": "beaker",
+            "scientist": true,
+            "lines": null
+        },
+        {
+            "name": "bunsen",
+            "scientist": true,
+            "lines": "I don't mean to be a stickler"
+        }
+    ]
+}
+Movie(title=Most wanted, muppets=[Muppet(name=kermit, scientist=false, lines=I'm not Constantine!), Muppet(name=beaker, scientist=true, lines=null), Muppet(name=bunsen, scientist=true, lines=I don't mean to be a stickler)])
+Movie(title=Most wanted, muppets=[Muppet(name=kermit, scientist=false, lines=I'm not Constantine!), Muppet(name=beaker, scientist=true, lines=null), Muppet(name=bunsen, scientist=true, lines=I don't mean to be a stickler)])
+true
+```
+
+</details>
+
+### Encode and Decode with Scala 3
+
+<details>
+    <summary>Show</summary>
+
+```scala
+import dev.mccue.json.{Json, JsonDecoder, JsonEncodable, JsonWriteOptions}
+
+import scala.jdk.CollectionConverters._
+
+case class Muppet(name: String, scientist: Boolean, lines: Option[String]) extends JsonEncodable {
+  override def toJson: Json =
+    Json.objectBuilder()
+      .put("name", name)
+      .put("scientist", scientist)
+      .put("lines", lines.orNull)
+      .build
+}
+
+object Muppet {
+  def fromJson(json: Json): Muppet =
+    Muppet(
+      JsonDecoder.field(json, "name", JsonDecoder.string _),
+      JsonDecoder.field(json, "scientist", JsonDecoder.boolean_ _),
+      JsonDecoder.nullableField(json, "name", JsonDecoder.string _)
+        .map(Option(_))
+        .orElse(None)
+    )
+}
+
+case class Movie(title: String, muppets: Seq[Muppet]) extends JsonEncodable {
+  override def toJson: Json =
+    Json.objectBuilder()
+      .put("title", title)
+      .put("muppets", muppets.asJava)
+      .build()
+}
+
+object Movie {
+  def fromJson(json: Json): Movie =
+    Movie(
+      JsonDecoder.field(json, "title", JsonDecoder.string _),
+      JsonDecoder.field(json, "muppets", JsonDecoder.array(Muppet.fromJson _))
+        .asScala
+        .toSeq
+    )
+}
+
+
+@main
+def main(): Unit = {
+  val movie = Movie(
+    "Most wanted",
+    Seq(
+      Muppet(
+        "kermit",
+        false,
+        Some("I'm not Constantine!")
+      ),
+      Muppet(
+        "beaker",
+        true,
+        None
+      ),
+      Muppet(
+        "bunsen",
+        true,
+        Some("I don't mean to be a stickler")
+      )
+    )
+  )
+
+  println(Json.writeString(movie, JsonWriteOptions().withIndentation(4)))
+
+  val movieRoundTripped = Movie.fromJson(Json.readString(Json.writeString(movie)))
+
+  println(movieRoundTripped)
+  println(movie)
+  println(movie == movieRoundTripped)
+}
+```
+
+``` 
+{
+    "title": "Most wanted",
+    "muppets": [
+        {
+            "name": "kermit",
+            "scientist": false,
+            "lines": "I'm not Constantine!"
+        },
+        {
+            "name": "beaker",
+            "scientist": true,
+            "lines": null
+        },
+        {
+            "name": "bunsen",
+            "scientist": true,
+            "lines": "I don't mean to be a stickler"
+        }
+    ]
+}
+Movie(Most wanted,List(Muppet(kermit,false,Some(kermit)), Muppet(beaker,true,Some(beaker)), Muppet(bunsen,true,Some(bunsen))))
+Movie(Most wanted,List(Muppet(kermit,false,Some(I'm not Constantine!)), Muppet(beaker,true,None), Muppet(bunsen,true,Some(I don't mean to be a stickler))))
+false
+```
 </details>