Release 0.40.3

- Rename on Kick, customAdaptersForMarshalling to customAdapters
- Make evaluateJS internal

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

Author: overfullstack

README.adoc

@@ -12,11 +12,12 @@ endif::[]
 :toc:
 :toc-placement!:
 :sourcedir: src/main/kotlin
-:testdir: src/integrationTest/java
+:testdir: src/test/java
+:integrationtestdir: src/integrationTest/java
 :pmtemplates: src/integrationTest/resources/pm-templates
 :imagesdir: docs/images
 :prewrap!:
-:revoman-version: 0.40.2
+:revoman-version: 0.40.3
 
 '''
 
@@ -130,13 +131,13 @@ You can import and manually test this collection through the `Run collection` bu
 image::resfulapi-dev-pm.png[]
 
 You can automate the same
-using ReṼoman in a link:{testdir}/com/salesforce/revoman/integration/restfulapidev/RestfulAPIDevTest.java[Junit test]
+using ReṼoman in a link:{integrationtestdir}/com/salesforce/revoman/integration/restfulapidev/RestfulAPIDevTest.java[Junit test]
 by supplying the template and environment path:
 
 ifdef::env-github[]
 
 [source,java,indent=0,options="nowrap"]
-.link:{testdir}/com/salesforce/revoman/integration/restfulapidev/RestfulAPIDevTest.java[RestfulAPIDevTest.java, tag=revoman-simple-demo]
+.link:{integrationtestdir}/com/salesforce/revoman/integration/restfulapidev/RestfulAPIDevTest.java[RestfulAPIDevTest.java, tag=revoman-simple-demo]
 ----
 @Test
 @DisplayName("restful-api.dev")
@@ -158,9 +159,9 @@ endif::[]
 ifndef::env-github[]
 
 [source,java,indent=0,options="nowrap"]
-.link:{testdir}/com/salesforce/revoman/integration/restfulapidev/RestfulAPIDevTest.java[RestfulAPIDevTest.java,tag=revoman-simple-demo]
+.link:{integrationtestdir}/com/salesforce/revoman/integration/restfulapidev/RestfulAPIDevTest.java[RestfulAPIDevTest.java,tag=revoman-simple-demo]
 ----
-include::{testdir}/com/salesforce/revoman/integration/restfulapidev/RestfulAPIDevTest.java[tag=revoman-simple-demo]
+include::{integrationtestdir}/com/salesforce/revoman/integration/restfulapidev/RestfulAPIDevTest.java[tag=revoman-simple-demo]
 ----
 <1> `revUp` is the method to call passing a configuration, built as below
 <2> Supply an exported Postman collection JSON file path
@@ -197,7 +198,7 @@ StepReport(
 `Rundown` has many convenience methods to ease applying further assertions on top of it.
 
 TIP:
-Other simple examples to see in Action: link:{testdir}/com/salesforce/revoman/integration/pokemon/PokemonTest.java[PokemonTest.java]
+Other simple examples to see in Action: link:{integrationtestdir}/com/salesforce/revoman/integration/pokemon/PokemonTest.java[PokemonTest.java]
 
 === Advanced Example
 
@@ -208,7 +209,7 @@ you can add more _bells & whistles_:
 ifdef::env-github[]
 
 [source,java,indent=0,options="nowrap"]
-.link:{testdir}/com/salesforce/revoman/integration/core/pq/PQE2EWithSMTest.java[PQE2EWithSMTest.java, tag=pq-e2e-with-revoman-config-demo]
+.link:{integrationtestdir}/com/salesforce/revoman/integration/core/pq/PQE2EWithSMTest.java[PQE2EWithSMTest.java, tag=pq-e2e-with-revoman-config-demo]
 ----
 final var pqRundown =
   ReVoman.revUp( // <1>
@@ -269,7 +270,7 @@ final var pqRundown =
               post(
                   afterStepName("query-quote-and-related-records"),
                   (ignore, rundown) -> assertAfterPQCreate(rundown.mutableEnv)))
-          .customAdaptersForMarshalling(new IDAdapter()) // <12>
+          .customAdapters(new IDAdapter()) // <12>
           .insecureHttp(true) // <13>
           .off()); // Kick-off
 assertThat(pqRundown.firstUnIgnoredUnsuccessfulStepReport()).isNull(); // <14>
@@ -299,9 +300,9 @@ endif::[]
 ifndef::env-github[]
 
 [source,java,indent=0,options="nowrap"]
-.link:{testdir}/com/salesforce/revoman/integration/core/pq/PQE2EWithSMTest.java[PQE2ETest.java, tag=pq-e2e-with-revoman-config-demo]
+.link:{integrationtestdir}/com/salesforce/revoman/integration/core/pq/PQE2EWithSMTest.java[PQE2ETest.java, tag=pq-e2e-with-revoman-config-demo]
 ----
-include::{testdir}/com/salesforce/revoman/integration/core/pq/PQE2EWithSMTest.java[tag=pq-e2e-with-revoman-config-demo]
+include::{integrationtestdir}/com/salesforce/revoman/integration/core/pq/PQE2EWithSMTest.java[tag=pq-e2e-with-revoman-config-demo]
 ----
 <1> `revUp` is the method to call passing a configuration, built as below
 <2> Supply the path (relative to resources) to the Template Collection JSON file
@@ -364,13 +365,22 @@ image:pq-exe-logging.gif[Monitor Execution]
 
 * ReṼoman internally uses a modern JSON library called https://github.com/square/moshi[**Moshi**]
 * There may be a POJO that inherits or contains legacy classes which are hard or impossible to serialize. ReṼoman lets you serialize such a legacy POJO by letting you pass `skipTypes`, where you can filter-out these legacy class types.
-* The payload may not map to POJO, and you may need a custom adapter for Conversion. Moshi has it covered for you with its advanced adapter mechanism and ReṼoman accepts Moshi adapters via `requestConfig`, `responseConfig` and `customAdaptersForMarshalling`
+* The payload may not map to POJO, and you may need a custom adapter for Conversion. Moshi has it covered for you with its advanced adapter mechanism and ReṼoman accepts Moshi adapters via `requestConfig`, `responseConfig` and `customAdapters`
 * ReṼoman also comes bundled with link:{sourcedir}/com/salesforce/revoman/input/json/JsonReaderUtils.kt[JSON Reader utils] and link:{sourcedir}/com/salesforce/revoman/input/json/JsonWriterUtils.kt[JSON Writer utils] to help build Moshi adapters.
 
-TIP: Refer link:{testdir}/com/salesforce/revoman/integration/core/pq/adapters/ConnectInputRepWithGraphAdapter.java[ConnectInputRepWithGraphAdapter]
+TIP: Refer link:{integrationtestdir}/com/salesforce/revoman/integration/core/pq/adapters/ConnectInputRepWithGraphAdapter.java[ConnectInputRepWithGraphAdapter]
 for an advanced adapter use-case
 
-* It also has link:{sourcedir}/com/salesforce/revoman/input/json/JsonPojoUtils.kt[JSON POJO Utils], which you can use to directly convert JSON to POJO and vice versa.
+==== JSON POJO Utils
+
+link:{sourcedir}/com/salesforce/revoman/input/json/JsonPojoUtils.kt[JSON POJO Utils] can be used to directly convert JSON to POJO and vice versa.
+
+[TIP]
+====
+Examples to refer:
+* link:{testdir}/com/salesforce/revoman/input/json/JsonPojoUtilsTest.java[JsonPojoUtilsTest]
+* link:{integrationtestdir}/com/salesforce/revoman/input/json/JsonPojoUtils2Test.java[JsonPojoUtils2Test]
+====
 
 === Execution Control
 
@@ -481,7 +491,7 @@ to be invoked to generate a value for your custom variable-key in the template a
 
 === Low-code
 
-TIP: Here is an example of a low-code link:{testdir}/com/salesforce/revoman/integration/core/pq/PQE2EWithSMTest.java[**E2E test**] that automates *~75 steps*
+TIP: Here is an example of a low-code link:{integrationtestdir}/com/salesforce/revoman/integration/core/pq/PQE2EWithSMTest.java[**E2E test**] that automates *~75 steps*
 
 [.lead]
 Compared to a traditional Integration/Functional or E2E test, approximately, the amount of code needed is *89%* less using ReṼoman.

buildSrc/src/main/kotlin/Config.kt

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

src/integrationTest/java/com/salesforce/revoman/integration/core/pq/PQE2EWithSMTest.java

@@ -122,7 +122,7 @@ void revUpPQ() {
                     post(
                         afterStepName("query-quote-and-related-records"),
                         (ignore, rundown) -> assertAfterPQCreate(rundown.mutableEnv)))
-                .customAdaptersForMarshalling(new IDAdapter()) // <12>
+                .customAdapters(new IDAdapter()) // <12>
                 .insecureHttp(true) // <13>
                 .off()); // Kick-off
     assertThat(pqRundown.firstUnIgnoredUnsuccessfulStepReport()).isNull(); // <14>

src/main/kotlin/com/salesforce/revoman/ReVoman.kt

@@ -68,7 +68,7 @@ object ReVoman {
         environment,
         kick,
         initMoshi(
-          kick.customAdaptersForMarshalling(),
+          kick.customAdapters(),
           kick.customAdaptersFromRequestConfig() + kick.customAdaptersFromResponseConfig(),
           kick.skipTypes()
         )

src/main/kotlin/com/salesforce/revoman/input/JSUtils.kt

@@ -14,7 +14,7 @@ import org.graalvm.polyglot.Context
 import org.graalvm.polyglot.HostAccess
 import org.graalvm.polyglot.Source
 import org.graalvm.polyglot.Value
-
+// ! TODO 01 Apr 2024 gopala.akshintala: Refactor this into a Class with DI
 /** Refer: https://www.graalvm.org/22.3/reference-manual/embed-languages/ */
 private lateinit var jsContext: Context
 
@@ -46,7 +46,7 @@ internal fun initJSContext(nodeModulesRelativePath: String?) {
       }
 }
 
-fun evaluateJS(js: String, bindings: Map<String, Any> = emptyMap()): Value? {
+internal fun evaluateJS(js: String, bindings: Map<String, Any> = emptyMap()): Value? {
   val contextBindings = jsContext.getBindings("js")
   bindings.forEach { (key, value) -> contextBindings.putMember(key, value) }
   val jsSource = Source.newBuilder("js", imports + js, "script.js").build()

src/main/kotlin/com/salesforce/revoman/input/config/KickDef.kt

@@ -78,7 +78,7 @@ internal interface KickDef {
       .filter { it.customAdapter != null }
       .groupBy({ it.objType }, { it.customAdapter!! })
 
-  fun customAdaptersForMarshalling(): List<Any>
+  fun customAdapters(): List<Any>
 
   fun skipTypes(): Set<Class<out Any>>