add state to json and jdbc processor streams (allowing persisting entity state to a plain file and/or to a database table)

Author: fupelaqu

build.sbt

@@ -8,7 +8,7 @@ ThisBuild / organization := "app.softnetwork"
 
 name := "generic-persistence-api"
 
-ThisBuild / version := "0.6.2.1"
+ThisBuild / version := "0.7-SNAPSHOT"
 
 ThisBuild / scalaVersion := "2.12.18"
 

common/src/main/scala/app/softnetwork/serialization/package.scala

@@ -4,7 +4,11 @@ import org.json4s.ext.{JavaTypesSerializers, JodaTimeSerializers}
 import org.json4s.jackson.Serialization
 import org.json4s._
 
+import java.text.SimpleDateFormat
+import java.time.{Instant, LocalDate, LocalDateTime}
+import java.util.Date
 import scala.language.implicitConversions
+import scala.reflect.ClassTag
 
 /** Created by smanciot on 14/05/2020.
   */
@@ -21,7 +25,8 @@ package object serialization {
   implicit def map2String(data: Map[String, Any])(implicit formats: Formats): String =
     serialization.write(data)
 
-  val defaultExcludedFields = List("serialVersionUID", "__serializedSizeCachedValue", "bitmap$0")
+  val defaultExcludedFields: List[String] =
+    List("serialVersionUID", "__serializedSizeCachedValue", "bitmap$0")
 
   def caseClass2Map(
     cc: AnyRef
@@ -64,4 +69,67 @@ package object serialization {
     */
   implicit def option2String(opt: Option[String]): String = opt.getOrElse("")
 
+  import scala.reflect.runtime.universe._
+  import scala.reflect.runtime.{currentMirror => cm}
+
+  def isCaseClass[T: TypeTag](paramType: Type): Boolean = {
+    paramType.typeSymbol.isClass && paramType.typeSymbol.asClass.isCaseClass
+  }
+
+  def updateCaseClass[T: TypeTag](obj: T, updates: Map[String, Any])(implicit
+    tag: ClassTag[T]
+  ): T = {
+    val classType = typeOf[T].typeSymbol.asClass
+    val classMirror = cm.reflect(obj)
+
+    // Get the primary constructor of the case class
+    val constructor = typeOf[T].decl(termNames.CONSTRUCTOR).asMethod
+    val classInstanceMirror = cm.reflectClass(classType)
+
+    // Get the parameters of the constructor
+    val params = constructor.paramLists.flatten
+
+    // Build new parameter values (updated if in the map, or original if not)
+    val newArgs = params.map { param =>
+      val paramName = param.name.toString
+      val paramType = param.typeSignature
+      updates.get(paramName) match {
+        case Some(newValue) =>
+          // Handle type conversion based on the expected parameter type
+          (paramType, newValue) match {
+            case (t, v: String) if t =:= typeOf[Boolean] =>
+              v.toBoolean // Convert string to Boolean
+            case (t, v: String) if t =:= typeOf[Date] =>
+              new SimpleDateFormat().parse(v) // Convert string to Date
+            case (t, v: String) if t =:= typeOf[Double] =>
+              v.toDouble // Convert string to Double
+            case (t, v: String) if t =:= typeOf[Float] =>
+              v.toFloat // Convert string to Float
+            case (t, v: String) if t =:= typeOf[Instant] =>
+              Instant.parse(v) // Convert string to Instant
+            case (t, v: String) if t =:= typeOf[Int] =>
+              v.toInt // Convert string to Int
+            case (t, v: String) if t =:= typeOf[LocalDate] =>
+              LocalDate.parse(v) // Convert string to LocalDate
+            case (t, v: String) if t =:= typeOf[LocalDateTime] =>
+              LocalDateTime.parse(v) // Convert string to LocalDateTime
+            case (t, v: String) if t =:= typeOf[Long] =>
+              v.toLong // Convert string to Long
+            case (t, v: String) if t =:= typeOf[Short] =>
+              v.toShort // Convert string to Short
+            case (t, v: Map[String, Any]) if isCaseClass(t) =>
+              updateCaseClass(classMirror.reflectField(t.decl(TermName(paramName)).asTerm).get, v)
+            case _ =>
+              newValue // If types match or are already compatible, use the value directly
+          }
+        case None =>
+          // Reflectively get the current field value from the case class instance
+          val fieldTerm = typeOf[T].decl(TermName(paramName)).asTerm
+          classMirror.reflectField(fieldTerm).get
+      }
+    }
+
+    // Create a new instance of the case class using the updated arguments
+    classInstanceMirror.reflectConstructor(constructor)(newArgs: _*).asInstanceOf[T]
+  }
 }

core/src/main/scala/app/softnetwork/persistence/model/package.scala

@@ -1,6 +1,11 @@
 package app.softnetwork.persistence
 
+import app.softnetwork.serialization._
+import org.json4s.Formats
+
 import java.time.Instant
+import scala.language.postfixOps
+import scala.reflect.ClassTag
 
 /** Created by smanciot on 27/05/2020.
   */
@@ -30,4 +35,33 @@ package object model {
   trait CborDomainObject
 
   trait ProtobufStateObject extends ProtobufDomainObject with State
+
+  implicit class CamelCaseString(s: String) {
+    def toSnakeCase: String = s.foldLeft("") { (acc, char) =>
+      if (char.isUpper) {
+        if (acc.isEmpty) char.toLower.toString
+        else acc + "_" + char.toLower
+      } else {
+        acc + char
+      }
+    }
+    def $: String = toSnakeCase
+  }
+
+  case class StateWrapper[T <: State](
+    uuid: String,
+    lastUpdated: Instant,
+    deleted: Boolean,
+    state: Option[T]
+  ) extends State {
+    def asJson(implicit formats: Formats): String = {
+      serialization.write[StateWrapper[T]](this.copy(deleted = deleted || state.isEmpty))
+    }
+  }
+
+  trait StateWrappertReader[T <: State] extends ManifestWrapper[StateWrapper[T]] {
+    def read(json: String)(implicit formats: Formats): StateWrapper[T] = {
+      serialization.read[StateWrapper[T]](json)(formats, manifestWrapper.wrapped)
+    }
+  }
 }

core/src/main/scala/app/softnetwork/persistence/query/ExternalPersistenceProvider.scala

@@ -10,7 +10,7 @@ import scala.reflect.ClassTag
   */
 trait ExternalPersistenceProvider[T <: Timestamped] { _: ManifestWrapper[T] =>
 
-  /** Creates the unerlying document to the external system
+  /** Creates the underlying document to the external system
     *
     * @param document
     *   - the document to create
@@ -22,7 +22,7 @@ trait ExternalPersistenceProvider[T <: Timestamped] { _: ManifestWrapper[T] =>
   def createDocument(document: T)(implicit t: ClassTag[T] = manifestWrapper.wrapped): Boolean =
     false
 
-  /** Updates the unerlying document to the external system
+  /** Updates the underlying document to the external system
     *
     * @param document
     *   - the document to update
@@ -38,7 +38,7 @@ trait ExternalPersistenceProvider[T <: Timestamped] { _: ManifestWrapper[T] =>
     t: ClassTag[T] = manifestWrapper.wrapped
   ): Boolean = false
 
-  /** Upserts the unerlying document referenced by its uuid to the external system
+  /** Upsert the underlying document referenced by its uuid to the external system
     *
     * @param uuid
     *   - the uuid of the document to upsert
@@ -49,7 +49,7 @@ trait ExternalPersistenceProvider[T <: Timestamped] { _: ManifestWrapper[T] =>
     */
   def upsertDocument(uuid: String, data: String): Boolean = false
 
-  /** Deletes the unerlying document referenced by its uuid to the external system
+  /** Deletes the underlying document referenced by its uuid to the external system
     *
     * @param uuid
     *   - the uuid of the document to delete
@@ -78,7 +78,7 @@ trait ExternalPersistenceProvider[T <: Timestamped] { _: ManifestWrapper[T] =>
     * @param m
     *   - implicit Manifest for T
     * @return
-    *   the documents founds or an empty list otherwise
+    *   the documents found or an empty list otherwise
     */
   def searchDocuments(
     query: String