Add allNames() and use that for JsonViews

Author: rbygrave

blackbox-test/pom.xml

@@ -26,6 +26,12 @@
       <version>0.11-SNAPSHOT</version>
     </dependency>
 
+<!--    <dependency>-->
+<!--      <groupId>io.avaje</groupId>-->
+<!--      <artifactId>avaje-jsonb-jackson</artifactId>-->
+<!--      <version>0.11-SNAPSHOT</version>-->
+<!--    </dependency>-->
+
     <dependency>
       <groupId>io.avaje</groupId>
       <artifactId>avaje-jsonb-generator</artifactId>

blackbox-test/src/main/java/org/example/customer/views/VAddress.java

@@ -0,0 +1,35 @@
+package org.example.customer.views;
+
+public class VAddress {
+
+  String street;
+  String suburb;
+  String city;
+
+  public String street() {
+    return street;
+  }
+
+  public VAddress street(String street) {
+    this.street = street;
+    return this;
+  }
+
+  public String suburb() {
+    return suburb;
+  }
+
+  public VAddress suburb(String suburb) {
+    this.suburb = suburb;
+    return this;
+  }
+
+  public String city() {
+    return city;
+  }
+
+  public VAddress city(String city) {
+    this.city = city;
+    return this;
+  }
+}

blackbox-test/src/main/java/org/example/customer/views/VContact.java

@@ -0,0 +1,26 @@
+package org.example.customer.views;
+
+public class VContact {
+
+  private final Long id;
+  private final String firstName;
+  private final String lastName;
+
+  public VContact(Long id, String firstName, String lastName) {
+    this.id = id;
+    this.firstName = firstName;
+    this.lastName = lastName;
+  }
+
+  public Long id() {
+    return id;
+  }
+
+  public String firstName() {
+    return firstName;
+  }
+
+  public String lastName() {
+    return lastName;
+  }
+}

blackbox-test/src/main/java/org/example/customer/views/VCustomer.java

@@ -0,0 +1,62 @@
+package org.example.customer.views;
+
+import io.avaje.jsonb.Json;
+
+import java.time.Instant;
+import java.util.ArrayList;
+import java.util.List;
+
+@Json
+public class VCustomer {
+
+  Integer id;
+  String name;
+  Instant whenCreated;
+  VAddress billingAddress;
+  List<VContact> contacts = new ArrayList<>();
+
+  public Integer id() {
+    return id;
+  }
+
+  public VCustomer id(Integer id) {
+    this.id = id;
+    return this;
+  }
+
+  public String name() {
+    return name;
+  }
+
+  public VCustomer name(String name) {
+    this.name = name;
+    return this;
+  }
+
+  public Instant whenCreated() {
+    return whenCreated;
+  }
+
+  public VCustomer whenCreated(Instant whenCreated) {
+    this.whenCreated = whenCreated;
+    return this;
+  }
+
+  public VAddress billingAddress() {
+    return billingAddress;
+  }
+
+  public VCustomer billingAddress(VAddress billingAddress) {
+    this.billingAddress = billingAddress;
+    return this;
+  }
+
+  public List<VContact> contacts() {
+    return contacts;
+  }
+
+  public VCustomer contacts(List<VContact> contacts) {
+    this.contacts = contacts;
+    return this;
+  }
+}

blackbox-test/src/test/java/org/example/customer/views/ViewTest.java

@@ -0,0 +1,71 @@
+package org.example.customer.views;
+
+import io.avaje.jsonb.JsonView;
+import io.avaje.jsonb.Jsonb;
+import org.junit.jupiter.api.Test;
+
+import java.time.Instant;
+import java.util.ArrayList;
+import java.util.List;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class ViewTest {
+
+  Jsonb jsonb = Jsonb.newBuilder().build();
+
+  @Test
+  void jsonView_sameInstance() {
+    JsonView<VCustomer> v0 = jsonb.type(VCustomer.class).view("(id, name, billingAddress(street), contacts(id, lastName))");
+    JsonView<VCustomer> v1 = jsonb.type(VCustomer.class).view("(id, name, billingAddress(street), contacts(id, lastName))");
+
+    assertThat(v0).isSameAs(v1);
+  }
+
+  @Test
+  void jsonView_differentInstance_byDsl() {
+    JsonView<VCustomer> v0 = jsonb.type(VCustomer.class).view("(id, name)");
+    JsonView<VCustomer> v1 = jsonb.type(VCustomer.class).view("(id, name  )");
+    assertThat(v0).isNotSameAs(v1);
+  }
+
+  @Test
+  void jsonView_differentInstance_byType() {
+    JsonView<?> v0 = jsonb.type(VCustomer.class).view("(id, name)");
+    JsonView<?> v1 = jsonb.type(VContact.class).view("(id, name)");
+    assertThat(v0).isNotSameAs(v1);
+  }
+
+  @Test
+  void jsonView() {
+
+    JsonView<VCustomer> customerJsonView = jsonb.type(VCustomer.class).view("(id, name, billingAddress(street), contacts(id, lastName))");
+
+    VAddress billingAddress = new VAddress().street("my street").suburb("my suburb");
+    VCustomer customer = new VCustomer().id(42).name("rob").whenCreated(Instant.now()).billingAddress(billingAddress);
+    customer.contacts().add(new VContact(7L, "fo", "nar"));
+    customer.contacts().add(new VContact(8L, "ba", "zar"));
+
+    String asJson = customerJsonView.toJson(customer);
+    assertThat(asJson).isEqualTo("{\"id\":42,\"name\":\"rob\",\"billingAddress\":{\"street\":\"my street\"},\"contacts\":[{\"id\":7,\"lastName\":\"nar\"},{\"id\":8,\"lastName\":\"zar\"}]}");
+  }
+
+  @Test
+  void jsonView_list() {
+
+    JsonView<List<VCustomer>> customerJsonView = jsonb.type(VCustomer.class).list().view("(id, name, contacts(*))");
+
+    VAddress billingAddress = new VAddress().street("my street").suburb("my suburb");
+    VCustomer customer0 = new VCustomer().id(42).name("rob").whenCreated(Instant.now()).billingAddress(billingAddress);
+    VCustomer customer1 = new VCustomer().id(43).name("bob").whenCreated(Instant.now()).billingAddress(billingAddress);
+    customer0.contacts().add(new VContact(7L, "fo", "nar"));
+    customer0.contacts().add(new VContact(8L, "ba", "zar"));
+
+    List<VCustomer> customers = new ArrayList<>();
+    customers.add(customer0);
+    customers.add(customer1);
+
+    String asJson = customerJsonView.toJson(customers);
+    assertThat(asJson).isEqualTo("[{\"id\":42,\"name\":\"rob\",\"contacts\":[{\"id\":7,\"firstName\":\"fo\",\"lastName\":\"nar\"},{\"id\":8,\"firstName\":\"ba\",\"lastName\":\"zar\"}]},{\"id\":43,\"name\":\"bob\"}]");
+  }
+}

jsonb-jackson/src/main/java/io/avaje/jsonb/jackson/JacksonWriter.java

@@ -18,9 +18,9 @@ final class JacksonWriter implements JsonWriter {
   private boolean serializeEmpty;
   private boolean serializeNulls;
   private String deferredName;
-  private ArrayStack<JacksonNames> nameStack;
+  private final ArrayStack<JacksonNames> nameStack = new ArrayStack<>();
   private JacksonNames currentNames;
-  private boolean pushedNames;
+  private boolean allNames;
   private int namePos = -1;
 
   JacksonWriter(JsonGenerator generator, boolean serializeNulls, boolean serializeEmpty) {
@@ -114,9 +114,8 @@ public void beginObject() {
   public void endObject() {
     try {
       generator.writeEndObject();
-      if (pushedNames) {
-        pushedNames = false;
-        currentNames = nameStack != null ? nameStack.pop() : null;
+      if (!allNames) {
+        currentNames = nameStack.pop();
       }
     } catch (IOException e) {
       throw new JsonIoException(e);
@@ -129,21 +128,17 @@ public void name(String name) {
   }
 
   @Override
-  public void names(PropertyNames nextNames) {
-    if (currentNames != nextNames) {
-      if (currentNames != null) {
-        pushCurrentNames();
-      }
-      currentNames = (JacksonNames) nextNames;
-    }
+  public void allNames(PropertyNames names) {
+    allNames = true;
+    currentNames = (JacksonNames) names;
   }
 
-  private void pushCurrentNames() {
-    if (nameStack == null) {
-      nameStack = new ArrayStack<>();
+  @Override
+  public void names(PropertyNames names) {
+    if (currentNames != null) {
+      nameStack.push(currentNames);
     }
-    pushedNames = true;
-    nameStack.push(currentNames);
+    currentNames = (JacksonNames) names;
   }
 
   @Override

jsonb-jakarta/src/main/java/io/avaje/jsonb/jakarta/JakartaJsonWriter.java

@@ -55,6 +55,11 @@ public String path() {
     return null;
   }
 
+  @Override
+  public void allNames(PropertyNames names) {
+    this.names = (DPropertyNames) names;
+  }
+
   @Override
   public void names(PropertyNames names) {
     this.names = (DPropertyNames) names;

jsonb/src/main/java/io/avaje/jsonb/JsonWriter.java

@@ -57,13 +57,27 @@ public interface JsonWriter extends Closeable, Flushable {
    */
   String path();
 
+  /**
+   * Set the property names that will be used for all json generation.
+   * <p>
+   * These names should be used for all json generation for this generator and set once
+   * rather than set per object via {@link #names(PropertyNames)}.
+   * <p>
+   * This is used by view json generation where all the names are known at the point
+   * when the view is created (a sort of flattened nested tree).
+   */
+  void allNames(PropertyNames names);
+
   /**
    * Set the current property names.
+   * <p>
+   * This is expected to be called per object after each call to {@link #beginObject()}.
    */
   void names(PropertyNames names);
 
   /**
-   * Set the next property name to write by position.
+   * Set the next property name to write by position. This uses the already encoded
+   * name values of PropertyNames.
    */
   void name(int position);
 

jsonb/src/main/java/io/avaje/jsonb/core/ViewBuilder.java

@@ -221,7 +221,7 @@ public byte[] toJsonBytes(T value) {
     @Override
     public void toJson(T value, JsonWriter writer) {
       if (properties != null) {
-        writer.names(properties);
+        writer.allNames(properties);
       }
       try {
         element.write(writer, value);

jsonb/src/main/java/io/avaje/jsonb/spi/DelegateJsonWriter.java

@@ -76,6 +76,11 @@ public final void name(String name) {
     delegate.name(name);
   }
 
+  @Override
+  public void allNames(PropertyNames names) {
+    delegate.allNames(names);
+  }
+
   @Override
   public final void names(PropertyNames names) {
     delegate.names(names);