Merge pull request #358 from uptane/time-based-uuid

Add support for time based uuids

build.sbt

@@ -13,6 +13,8 @@ val Library = new {
     val flyway = "10.8.1"
   }
 
+  val javaUuidGenerator = "com.fasterxml.uuid" % "java-uuid-generator" % "4.3.0"
+
   val logback = "ch.qos.logback" % "logback-classic" % Version.logback
 
   val flyway = "org.flywaydb" % "flyway-core" % Version.flyway
@@ -71,7 +73,9 @@ val Library = new {
 lazy val scala213 = "2.13.12"
 lazy val supportedScalaVersions = List(scala213)
 lazy val commonDeps =
-  libraryDependencies ++= Library.circe ++ Seq(Library.refined, Library.scalatest) ++ Library.cats :+ Library.logback
+  libraryDependencies ++= Library.circe ++
+    Seq(Library.refined, Library.scalatest) ++
+    Library.cats :+ Library.logback :+ Library.javaUuidGenerator
 
 lazy val commonConfigs = Seq.empty
 

libats/src/main/scala/com/advancedtelematic/libats/data/UUIDKey.scala

@@ -1,20 +1,22 @@
 package com.advancedtelematic.libats.data
 
 import java.util.UUID
-
 import cats.Show
+import com.fasterxml.uuid.Generators
 import io.circe.{Decoder, Encoder, KeyDecoder, KeyEncoder}
-import shapeless._
+import shapeless.*
 
 object UUIDKey {
+  private lazy val timeBasedUuidGenerator = Generators.timeBasedEpochGenerator()
+
   abstract class UUIDKeyObj[Self <: UUIDKey] {
 
     type SelfGen = Generic.Aux[Self, UUID :: HNil]
 
     def generate()(implicit gen: SelfGen): Self =
       fromJava(UUID.randomUUID())
 
-    private def fromJava(value: UUID)(implicit gen: SelfGen): Self = {
+    protected def fromJava(value: UUID)(implicit gen: SelfGen): Self = {
       gen.from(value :: HNil)
     }
 
@@ -31,6 +33,11 @@ object UUIDKey {
     implicit val abstractKeyShow: Show[Self] = Show.show[Self](_.uuid.toString)
   }
 
+  abstract class UuidKeyObjTimeBased[Self <: UUIDKey] extends UUIDKeyObj[Self] {
+    override def generate()(implicit gen: SelfGen) =
+      fromJava(timeBasedUuidGenerator.generate())
+  }
+
   abstract class UUIDKey {
     val uuid: UUID
   }