Release 0.34.3

Add builders to JsonPojoUtils

Signed-off-by: Gopal S Akshintala <[email protected]>

Author: overfullstack

README.adoc

@@ -16,7 +16,7 @@ endif::[]
 :pmtemplates: src/integrationTest/resources/pm-templates
 :imagesdir: docs/images
 :prewrap!:
-:revoman-version: 0.34.2
+:revoman-version: 0.34.3
 
 '''
 

buildSrc/src/main/kotlin/Config.kt

@@ -6,6 +6,6 @@
  * ************************************************************************************************
  */
 const val GROUP_ID = "com.salesforce.revoman"
-const val VERSION = "0.34.2"
+const val VERSION = "0.34.3"
 const val ARTIFACT_ID = "revoman"
 const val STAGING_PROFILE_ID = "1ea0a23e61ba7d"

src/integrationTest/java/com/salesforce/revoman/input/json/JsonPojoUtils2Test.java

@@ -31,15 +31,14 @@ class JsonPojoUtils2Test {
   @DisplayName("toJson: PQ Payload JSON -> PlaceQuoteInputRep -> PQ Payload JSON")
   void pqInputRepToPQPayloadJson() throws JSONException {
     final var pqAdapter = adapter(PlaceQuoteInputRepresentation.class);
-    final var pqPayloadJsonFilePath = "json/pq-payload.json";
+    final var expectedPQPayload = readFileInResourcesToString("json/pq-payload.json");
     final var pqInputRep =
-        JsonPojoUtils.<PlaceQuoteInputRepresentation>jsonFileToPojo(
-            PlaceQuoteInputRepresentation.class, pqPayloadJsonFilePath, List.of(pqAdapter));
+        JsonPojoUtils.<PlaceQuoteInputRepresentation>jsonToPojo(
+            PlaceQuoteInputRepresentation.class, expectedPQPayload, List.of(pqAdapter));
     assertThat(pqInputRep).isNotNull();
     final var pqPayloadJsonStr =
         JsonPojoUtils.pojoToJson(
             PlaceQuoteInputRepresentation.class, pqInputRep, List.of(pqAdapter));
-    final var expectedPQPayload = readFileInResourcesToString(pqPayloadJsonFilePath);
     JSONAssert.assertEquals(expectedPQPayload, pqPayloadJsonStr, JSONCompareMode.STRICT);
   }
 
@@ -48,8 +47,12 @@ void pqInputRepToPQPayloadJson() throws JSONException {
   void pqPayloadJsonToPQInputRep() {
     final var pqAdapter = adapter(PlaceQuoteInputRepresentation.class);
     final var pqInputRep =
-        JsonPojoUtils.<PlaceQuoteInputRepresentation>jsonFileToPojo(
-            PlaceQuoteInputRepresentation.class, "json/pq-payload.json", List.of(pqAdapter));
+        JsonPojoUtils.jsonFileToPojo(
+            JsonFile.<PlaceQuoteInputRepresentation>unmarshall()
+                .pojoType(PlaceQuoteInputRepresentation.class)
+                .jsonFilePath("json/pq-payload.json")
+                .customAdapter(pqAdapter)
+                .done());
     assertThat(pqInputRep).isNotNull();
     assertThat(pqInputRep.getPricingPref()).isEqualTo(PricingPreferenceEnum.System);
     assertThat(pqInputRep.getDoAsync()).isTrue();
@@ -63,8 +66,12 @@ void pqPayloadJsonToPQInputRep() {
   void unmarshallMarshallPqResponse() throws JSONException {
     final var pqResponseFromJson = readFileInResourcesToString("json/pq-response.json");
     final var pqResp =
-        JsonPojoUtils.<PlaceQuoteOutputRepresentation>jsonToPojo(
-            PlaceQuoteOutputRepresentation.class, pqResponseFromJson, List.of(new IDAdapter()));
+        JsonPojoUtils.jsonToPojo(
+            JsonString.<PlaceQuoteOutputRepresentation>unmarshall()
+                .pojoType(PlaceQuoteOutputRepresentation.class)
+                .jsonString(pqResponseFromJson)
+                .customAdapter(new IDAdapter())
+                .done());
     assertNotNull(pqResp);
     final var pqOutputRepJson =
         JsonPojoUtils.pojoToJson(

src/main/kotlin/com/salesforce/revoman/input/json/JsonPojoUtils.kt

@@ -15,54 +15,93 @@ import com.squareup.moshi.JsonAdapter
 import com.squareup.moshi.JsonAdapter.Factory
 import io.vavr.control.Either
 import java.lang.reflect.Type
+import org.immutables.value.Value
 
+/**
+ * Parses a JSON file and converts it to a POJO of type [PojoT].
+ *
+ * @param pojoType The type of the POJO to be created
+ * @param jsonFilePath The path to the JSON file
+ * @param customAdapters A list of custom JSON adapters to be used during the parsing process
+ * @param customAdaptersWithType A map of custom JSON adapters with their respective types
+ * @param typesToSkip A set of types to be skipped during the parsing process
+ * @param <PojoT> The type of the POJO to be created
+ * @return the parsed POJO or null if the parsing fails
+ */
 @JvmOverloads
 fun <PojoT : Any> jsonFileToPojo(
   pojoType: Type,
   jsonFilePath: String,
   customAdapters: List<Any> = emptyList(),
   customAdaptersWithType: Map<Type, List<Either<JsonAdapter<Any>, Factory>>> = emptyMap(),
-  typesToIgnore: Set<Class<out Any>> = emptySet()
+  typesToSkip: Set<Class<out Any>> = emptySet()
 ): PojoT? {
-  val jsonAdapter =
-    initMoshi<PojoT>(customAdapters, customAdaptersWithType, typesToIgnore, pojoType)
+  val jsonAdapter = initMoshi<PojoT>(customAdapters, customAdaptersWithType, typesToSkip, pojoType)
   return jsonAdapter.fromJson(bufferFileInResources(jsonFilePath))
 }
 
+fun <PojoT : Any> jsonFileToPojo(jsonFile: JsonFile<PojoT>): PojoT? =
+  jsonFileToPojo(
+    jsonFile.pojoType(),
+    jsonFile.jsonFilePath(),
+    jsonFile.customAdapters(),
+    jsonFile.customAdaptersWithType(),
+    jsonFile.typesToSkip()
+  )
+
 inline fun <reified PojoT : Any> jsonFileToPojo(
   jsonFilePath: String,
   customAdapters: List<Any> = emptyList(),
   customAdaptersWithType: Map<Type, List<Either<JsonAdapter<Any>, Factory>>> = emptyMap(),
-  typesToIgnore: Set<Class<out Any>> = emptySet()
+  typesToSkip: Set<Class<out Any>> = emptySet()
 ): PojoT? =
   jsonFileToPojo(
     PojoT::class.java,
     jsonFilePath,
     customAdapters,
     customAdaptersWithType,
-    typesToIgnore
+    typesToSkip
   )
 
+/**
+ * A generic function that parses a JSON string into a POJO (Plain Old Java Object) of type PojoT.
+ *
+ * @param <PojoT> The type of the resulting POJO.
+ * @param pojoType The class of the resulting POJO.
+ * @param jsonStr The JSON string to be parsed.
+ * @param customAdapters A list of custom adapters to be used during the parsing process.
+ * @param customAdaptersWithType A map of custom adapters with their respective types.
+ * @param typesToSkip A set of classes to be skipped during the parsing process.
+ * @return The parsed POJO of type PojoT.
+ */
 @JvmOverloads
 fun <PojoT : Any> jsonToPojo(
   pojoType: Type,
   jsonStr: String,
   customAdapters: List<Any> = emptyList(),
   customAdaptersWithType: Map<Type, List<Either<JsonAdapter<Any>, Factory>>> = emptyMap(),
-  typesToIgnore: Set<Class<out Any>> = emptySet()
+  typesToSkip: Set<Class<out Any>> = emptySet()
 ): PojoT? {
-  val jsonAdapter =
-    initMoshi<PojoT>(customAdapters, customAdaptersWithType, typesToIgnore, pojoType)
+  val jsonAdapter = initMoshi<PojoT>(customAdapters, customAdaptersWithType, typesToSkip, pojoType)
   return jsonAdapter.fromJson(jsonStr)
 }
 
+fun <PojoT : Any> jsonToPojo(jsonString: JsonString<PojoT>): PojoT? =
+  jsonToPojo(
+    jsonString.pojoType(),
+    jsonString.jsonString(),
+    jsonString.customAdapters(),
+    jsonString.customAdaptersWithType(),
+    jsonString.typesToSkip()
+  )
+
 inline fun <reified PojoT : Any> jsonToPojo(
   jsonStr: String,
   customAdapters: List<Any> = emptyList(),
   customAdaptersWithType: Map<Type, List<Either<JsonAdapter<Any>, Factory>>> = emptyMap(),
-  typesToIgnore: Set<Class<out Any>> = emptySet()
+  typesToSkip: Set<Class<out Any>> = emptySet()
 ): PojoT? =
-  jsonToPojo(PojoT::class.java, jsonStr, customAdapters, customAdaptersWithType, typesToIgnore)
+  jsonToPojo(PojoT::class.java, jsonStr, customAdapters, customAdaptersWithType, typesToSkip)
 
 /**
  * Generate a JSON string from a POJO object.
@@ -71,7 +110,7 @@ inline fun <reified PojoT : Any> jsonToPojo(
  * @param pojo The POJO object to be converted to JSON.
  * @param customAdapters A list of custom adapters for Moshi to use during the conversion.
  * @param customAdaptersWithType A map of custom adapters with their respective types.
- * @param typesToIgnore A set of classes to ignore during the conversion.
+ * @param typesToSkip A set of classes to ignore during the conversion.
  * @param indent An optional string for pretty-printing the JSON output.
  * @param <PojoT> The type of the POJO object.
  * @return A JSON string or null if the input is null.
@@ -82,30 +121,107 @@ fun <PojoT : Any> pojoToJson(
   pojo: PojoT,
   customAdapters: List<Any> = emptyList(),
   customAdaptersWithType: Map<Type, List<Either<JsonAdapter<Any>, Factory>>> = emptyMap(),
-  typesToIgnore: Set<Class<out Any>> = emptySet(),
+  typesToSkip: Set<Class<out Any>> = emptySet(),
   indent: String? = "  "
 ): String? {
-  val jsonAdapter =
-    initMoshi<PojoT>(customAdapters, customAdaptersWithType, typesToIgnore, pojoType)
+  val jsonAdapter = initMoshi<PojoT>(customAdapters, customAdaptersWithType, typesToSkip, pojoType)
   return (indent?.let { jsonAdapter.indent(indent) } ?: jsonAdapter).toJson(pojo)
 }
 
+fun <PojoT : Any> pojoToJson(config: Pojo<PojoT>): String? =
+  pojoToJson(
+    config.pojoType(),
+    config.pojo(),
+    config.customAdapters(),
+    config.customAdaptersWithType(),
+    config.typesToSkip(),
+    config.indent()
+  )
+
 inline fun <reified PojoT : Any> pojoToJson(
   pojo: PojoT,
   customAdapters: List<Any> = emptyList(),
   customAdaptersWithType: Map<Type, List<Either<JsonAdapter<Any>, Factory>>> = emptyMap(),
-  typesToIgnore: Set<Class<out Any>> = emptySet(),
+  typesToSkip: Set<Class<out Any>> = emptySet(),
   indent: String? = "  "
 ): String? =
-  pojoToJson(PojoT::class.java, pojo, customAdapters, customAdaptersWithType, typesToIgnore, indent)
+  pojoToJson(PojoT::class.java, pojo, customAdapters, customAdaptersWithType, typesToSkip, indent)
 
 @SuppressWarnings("kotlin:S3923")
 private fun <PojoT : Any> initMoshi(
   customAdapters: List<Any> = emptyList(),
   customAdaptersWithType: Map<Type, List<Either<JsonAdapter<Any>, Factory>>> = emptyMap(),
-  typesToIgnore: Set<Class<out Any>> = emptySet(),
+  typesToSkip: Set<Class<out Any>> = emptySet(),
   pojoType: Type
 ): JsonAdapter<PojoT> {
-  val moshiBuilder = buildMoshi(customAdapters, customAdaptersWithType, typesToIgnore)
+  val moshiBuilder = buildMoshi(customAdapters, customAdaptersWithType, typesToSkip)
   return moshiBuilder.build().adapter(pojoType)
 }
+
+@PojoConfig
+@Value.Immutable
+internal interface PojoDef<PojoT> {
+  fun pojoType(): Type
+
+  fun pojo(): PojoT
+
+  fun customAdapters(): List<Any>
+
+  fun customAdaptersWithType(): Map<Type, List<Either<JsonAdapter<Any>, Factory>>>
+
+  fun typesToSkip(): Set<Class<out Any>>
+
+  @Value.Default fun indent(): String = "  "
+}
+
+@Target(AnnotationTarget.CLASS)
+@Retention(AnnotationRetention.SOURCE)
+@Value.Style(
+  typeImmutable = "*",
+  typeAbstract = ["*Def"],
+  builder = "marshall",
+  build = "done",
+  depluralize = true,
+  add = "*",
+  put = "*",
+  with = "override*",
+  visibility = Value.Style.ImplementationVisibility.PUBLIC,
+)
+private annotation class PojoConfig
+
+internal interface JsonConfig<PojoT> {
+  fun pojoType(): Type
+
+  fun customAdapters(): List<Any>
+
+  fun customAdaptersWithType(): Map<Type, List<Either<JsonAdapter<Any>, Factory>>>
+
+  fun typesToSkip(): Set<Class<out Any>>
+}
+
+@ConfigForJson
+@Value.Immutable
+internal interface JsonFileDef<PojoT> : JsonConfig<PojoT> {
+  fun jsonFilePath(): String
+}
+
+@ConfigForJson
+@Value.Immutable
+internal interface JsonStringDef<PojoT> : JsonConfig<PojoT> {
+  fun jsonString(): String
+}
+
+@Target(AnnotationTarget.CLASS)
+@Retention(AnnotationRetention.SOURCE)
+@Value.Style(
+  typeImmutable = "*",
+  typeAbstract = ["*Def"],
+  builder = "unmarshall",
+  build = "done",
+  depluralize = true,
+  add = "*",
+  put = "*",
+  with = "override*",
+  visibility = Value.Style.ImplementationVisibility.PUBLIC,
+)
+private annotation class ConfigForJson

src/main/kotlin/com/salesforce/revoman/internal/json/MoshiReVoman.kt

@@ -14,7 +14,7 @@ import com.salesforce.revoman.internal.json.adapters.EpochAdapter
 import com.salesforce.revoman.internal.json.adapters.TypeAdapter
 import com.salesforce.revoman.internal.json.adapters.UUIDAdapter
 import com.salesforce.revoman.internal.json.factories.CaseInsensitiveEnumAdapter
-import com.salesforce.revoman.internal.json.factories.IgnoreUnknownFactory
+import com.salesforce.revoman.internal.json.factories.SkipTypesFactory
 import com.squareup.moshi.JsonAdapter
 import com.squareup.moshi.JsonAdapter.Factory
 import com.squareup.moshi.Moshi
@@ -81,7 +81,7 @@ internal fun buildMoshi(
     }
   }
   if (typesToIgnore.isNotEmpty()) {
-    moshiBuilder.add(IgnoreUnknownFactory(typesToIgnore))
+    moshiBuilder.add(SkipTypesFactory(typesToIgnore))
   }
   return moshiBuilder
 }

src/main/kotlin/com/salesforce/revoman/internal/json/factories/IgnoreUnknownFactory.kt renamed to src/main/kotlin/com/salesforce/revoman/internal/json/factories/SkipTypesFactory.kt

@@ -15,10 +15,10 @@ import com.squareup.moshi.Moshi
 import com.squareup.moshi.Types
 import java.lang.reflect.Type
 
-internal class IgnoreUnknownFactory(private val typesToIgnore: Set<Class<out Any>>) : Factory {
+internal class SkipTypesFactory(private val typesToSkip: Set<Class<out Any>>) : Factory {
   override fun create(type: Type, annotations: Set<Annotation?>, moshi: Moshi): JsonAdapter<*>? {
     val rawType: Class<*> = Types.getRawType(type)
-    return if (typesToIgnore.contains(rawType)) {
+    return if (typesToSkip.contains(rawType)) {
       object : JsonAdapter<Type>() {
         override fun fromJson(reader: JsonReader): Type? {
           reader.skipValue()

src/test/java/com/salesforce/revoman/input/json/JsonPojoUtilsTest.java

@@ -43,9 +43,11 @@ void compositeGraphSuccessResponseMarshallUnmarshall() throws JSONException {
     assertThat(successGraphResponse.getGraphs().get(0)).isInstanceOf(SuccessGraph.class);
     final var successGraphResponseUnmarshalled =
         JsonPojoUtils.pojoToJson(
-            CompositeGraphResponse.class,
-            successGraphResponse,
-            List.of(CompositeGraphResponse.ADAPTER));
+            Pojo.marshall()
+                .pojoType(CompositeGraphResponse.class)
+                .pojo(successGraphResponse)
+                .customAdapter(CompositeGraphResponse.ADAPTER)
+                .done());
     JSONAssert.assertEquals(
         graphSuccessResponseJsonStr, successGraphResponseUnmarshalled, JSONCompareMode.STRICT);
   }