refactor: move value objects to separate project (DEV-615)

build.sbt

@@ -201,6 +201,7 @@ lazy val webapi: Project = Project(id = "webapi", base = file("webapi"))
     ),
     buildInfoPackage := "org.knora.webapi.http.version"
   )
+  .dependsOn(valueObjects)
 
 lazy val webapiJavaRunOptions = Seq(
   // "-showversion",
@@ -282,3 +283,11 @@ lazy val schemaRepoSearchService = project
     testFrameworks := Seq(new TestFramework("zio.test.sbt.ZTestFramework"))
   )
   .dependsOn(schemaRepo)
+
+lazy val valueObjects = project
+  .in(file("dsp-value-objects"))
+  .settings(
+    name := "valueObjects",
+    libraryDependencies ++= Dependencies.valueObjectsLibraryDependencies,
+    testFrameworks := Seq(new TestFramework("zio.test.sbt.ZTestFramework"))
+  )

dsp-value-objects/src/main/scala/dsp/valueobjects/Group.scala

@@ -0,0 +1,100 @@
+/*
+ * Copyright © 2021 - 2022 Swiss National Data and Service Center for the Humanities and/or DaSCH Service Platform contributors.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package dsp.valueobjects
+
+import zio.prelude.Validation
+
+sealed trait Group
+object Group {
+
+  /**
+   * GroupName value object.
+   */
+  sealed abstract case class GroupName private (value: String)
+  object GroupName { self =>
+    def make(value: String): Validation[Throwable, GroupName] =
+      if (value.isEmpty) {
+        Validation.fail(V2.BadRequestException(GroupErrorMessages.GroupNameMissing))
+      } else {
+        val validatedValue = Validation(
+          V2IriValidation.toSparqlEncodedString(
+            value,
+            throw V2.BadRequestException(GroupErrorMessages.GroupNameInvalid)
+          )
+        )
+
+        validatedValue.map(new GroupName(_) {})
+      }
+
+    def make(value: Option[String]): Validation[Throwable, Option[GroupName]] =
+      value match {
+        case Some(v) => self.make(v).map(Some(_))
+        case None    => Validation.succeed(None)
+      }
+  }
+
+  /**
+   * GroupDescriptions value object.
+   */
+  sealed abstract case class GroupDescriptions private (value: Seq[V2.StringLiteralV2])
+  object GroupDescriptions { self =>
+    def make(value: Seq[V2.StringLiteralV2]): Validation[Throwable, GroupDescriptions] =
+      if (value.isEmpty) {
+        Validation.fail(V2.BadRequestException(GroupErrorMessages.GroupDescriptionMissing))
+      } else {
+        val validatedDescriptions = Validation(value.map { description =>
+          val validatedDescription =
+            V2IriValidation.toSparqlEncodedString(
+              description.value,
+              throw V2.BadRequestException(GroupErrorMessages.GroupDescriptionInvalid)
+            )
+          V2.StringLiteralV2(value = validatedDescription, language = description.language)
+        })
+        validatedDescriptions.map(new GroupDescriptions(_) {})
+      }
+
+    def make(value: Option[Seq[V2.StringLiteralV2]]): Validation[Throwable, Option[GroupDescriptions]] =
+      value match {
+        case Some(v) => self.make(v).map(Some(_))
+        case None    => Validation.succeed(None)
+      }
+  }
+
+  /**
+   * GroupStatus value object.
+   */
+  sealed abstract case class GroupStatus private (value: Boolean)
+  object GroupStatus { self =>
+    def make(value: Boolean): Validation[Throwable, GroupStatus] =
+      Validation.succeed(new GroupStatus(value) {})
+    def make(value: Option[Boolean]): Validation[Throwable, Option[GroupStatus]] =
+      value match {
+        case Some(v) => self.make(v).map(Some(_))
+        case None    => Validation.succeed(None)
+      }
+  }
+
+  /**
+   * GroupSelfJoin value object.
+   */
+  sealed abstract case class GroupSelfJoin private (value: Boolean)
+  object GroupSelfJoin { self =>
+    def make(value: Boolean): Validation[Throwable, GroupSelfJoin] =
+      Validation.succeed(new GroupSelfJoin(value) {})
+    def make(value: Option[Boolean]): Validation[Throwable, Option[GroupSelfJoin]] =
+      value match {
+        case Some(v) => self.make(v).map(Some(_))
+        case None    => Validation.succeed(None)
+      }
+  }
+}
+
+object GroupErrorMessages {
+  val GroupNameMissing        = "Group name cannot be empty."
+  val GroupNameInvalid        = "Group name is invalid."
+  val GroupDescriptionMissing = "Group description cannot be empty." // make it plural
+  val GroupDescriptionInvalid = "Group description is invalid."      // make it plural
+}

dsp-value-objects/src/main/scala/dsp/valueobjects/Iri.scala

@@ -0,0 +1,157 @@
+/*
+ * Copyright © 2021 - 2022 Swiss National Data and Service Center for the Humanities and/or DaSCH Service Platform contributors.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package dsp.valueobjects
+
+import zio.prelude.Validation
+
+sealed trait Iri
+object Iri {
+
+  /**
+   * GroupIri value object.
+   */
+  sealed abstract case class GroupIri private (value: String)
+  object GroupIri { self =>
+    def make(value: String): Validation[Throwable, GroupIri] =
+      if (value.isEmpty) {
+        Validation.fail(V2.BadRequestException(IriErrorMessages.GroupIriMissing))
+      } else {
+        val isUUID: Boolean = V2UuidValidation.hasUUIDLength(value.split("/").last)
+
+        if (!V2IriValidation.isKnoraGroupIriStr(value)) {
+          Validation.fail(V2.BadRequestException(IriErrorMessages.GroupIriInvalid))
+        } else if (isUUID && !V2UuidValidation.isUUIDVersion4Or5(value)) {
+          Validation.fail(V2.BadRequestException(IriErrorMessages.UuidInvalid))
+        } else {
+          val validatedValue = Validation(
+            V2IriValidation.validateAndEscapeIri(value, throw V2.BadRequestException(IriErrorMessages.GroupIriInvalid))
+          )
+
+          validatedValue.map(new GroupIri(_) {})
+        }
+      }
+
+    def make(value: Option[String]): Validation[Throwable, Option[GroupIri]] =
+      value match {
+        case Some(v) => self.make(v).map(Some(_))
+        case None    => Validation.succeed(None)
+      }
+  }
+
+  /**
+   * ListIri value object.
+   */
+  sealed abstract case class ListIri private (value: String)
+  object ListIri { self =>
+    def make(value: String): Validation[Throwable, ListIri] =
+      if (value.isEmpty) {
+        Validation.fail(V2.BadRequestException(IriErrorMessages.ListIriMissing))
+      } else {
+        val isUUID: Boolean = V2UuidValidation.hasUUIDLength(value.split("/").last)
+
+        if (!V2IriValidation.isKnoraListIriStr(value)) {
+          Validation.fail(V2.BadRequestException(IriErrorMessages.ListIriInvalid))
+        } else if (isUUID && !V2UuidValidation.isUUIDVersion4Or5(value)) {
+          Validation.fail(V2.BadRequestException(IriErrorMessages.UuidInvalid))
+        } else {
+          val validatedValue = Validation(
+            V2IriValidation.validateAndEscapeIri(
+              value,
+              throw V2.BadRequestException(IriErrorMessages.ListIriInvalid)
+            )
+          )
+
+          validatedValue.map(new ListIri(_) {})
+        }
+      }
+
+    def make(value: Option[String]): Validation[Throwable, Option[ListIri]] =
+      value match {
+        case Some(v) => self.make(v).map(Some(_))
+        case None    => Validation.succeed(None)
+      }
+  }
+
+  /**
+   * ProjectIri value object.
+   */
+  sealed abstract case class ProjectIri private (value: String)
+  object ProjectIri { self =>
+    def make(value: String): Validation[Throwable, ProjectIri] =
+      if (value.isEmpty) {
+        Validation.fail(V2.BadRequestException(IriErrorMessages.ProjectIriMissing))
+      } else {
+        val isUUID: Boolean = V2UuidValidation.hasUUIDLength(value.split("/").last)
+
+        if (!V2IriValidation.isKnoraProjectIriStr(value)) {
+          Validation.fail(V2.BadRequestException(IriErrorMessages.ProjectIriInvalid))
+        } else if (isUUID && !V2UuidValidation.isUUIDVersion4Or5(value)) {
+          Validation.fail(V2.BadRequestException(IriErrorMessages.UuidInvalid))
+        } else {
+          val validatedValue = Validation(
+            V2IriValidation.validateAndEscapeProjectIri(
+              value,
+              throw V2.BadRequestException(IriErrorMessages.ProjectIriInvalid)
+            )
+          )
+
+          validatedValue.map(new ProjectIri(_) {})
+        }
+      }
+
+    def make(value: Option[String]): Validation[Throwable, Option[ProjectIri]] =
+      value match {
+        case Some(v) => self.make(v).map(Some(_))
+        case None    => Validation.succeed(None)
+      }
+  }
+
+  /**
+   * UserIri value object.
+   */
+  sealed abstract case class UserIri private (value: String) extends Iri
+  object UserIri { self =>
+    def make(value: String): Validation[Throwable, UserIri] =
+      if (value.isEmpty) {
+        Validation.fail(V2.BadRequestException(IriErrorMessages.UserIriMissing))
+      } else {
+        val isUUID: Boolean = V2UuidValidation.hasUUIDLength(value.split("/").last)
+
+        if (!V2IriValidation.isKnoraUserIriStr(value)) {
+          Validation.fail(V2.BadRequestException(IriErrorMessages.UserIriInvalid))
+        } else if (isUUID && !V2UuidValidation.isUUIDVersion4Or5(value)) {
+          Validation.fail(V2.BadRequestException(IriErrorMessages.UuidInvalid))
+        } else {
+          val validatedValue = Validation(
+            V2IriValidation.validateAndEscapeUserIri(
+              value,
+              throw V2.BadRequestException(IriErrorMessages.UserIriInvalid)
+            )
+          )
+
+          validatedValue.map(new UserIri(_) {})
+        }
+      }
+
+    def make(value: Option[String]): Validation[Throwable, Option[UserIri]] =
+      value match {
+        case Some(v) => self.make(v).map(Some(_))
+        case None    => Validation.succeed(None)
+      }
+  }
+}
+
+object IriErrorMessages {
+  val GroupIriMissing   = "Group IRI cannot be empty."
+  val GroupIriInvalid   = "Group IRI is invalid."
+  val ListIriMissing    = "List IRI cannot be empty."
+  val ListIriInvalid    = "List IRI cannot be empty."
+  val ProjectIriMissing = "Project IRI cannot be empty."
+  val ProjectIriInvalid = "Project IRI is invalid."
+  val UserIriMissing    = "User IRI cannot be empty."
+  val UserIriInvalid    = "User IRI is invalid."
+  val UuidInvalid       = "Invalid UUID used to create IRI. Only versions 4 and 5 are supported."
+}