fix(cardinality): Check cardinality with multiple inherited classes (DEV-1189) (#2164)

* check that always the stricter cardinality is taken

* add unit tests

* remove replaced method

* add comments

* introduce value objects for cardinalities

* check cardinality compatibility in case of multiple super classes

* fix error message

* clean up docstrings

* fix broken docs link

* remove unused project

* fix error in docs

* add testdata and tests

* fix build.sbt

* simplify test data

* improve comments

* cleanup imports

* fix bad references for coverage

* improve comments

* reintroduce return

* wrap case objects

* simplify test

* fix missing import

* implement feedback from review

* run scalafmt

Co-authored-by: Ivan Subotic <400790+subotic@users.noreply.github.com>

Author: irinaschubert

Makefile

@@ -209,7 +209,6 @@ test: build ## runs all tests
 	sbt -v coverage "userHandler/test"
 	sbt -v coverage "userInterface/test"
 	sbt -v coverage "userRepo/test"
-	sbt -v coverage "valueObjects/test"
 	sbt -v coverage "webapi/test"
 	sbt coverageAggregate
 

build.sbt

@@ -27,7 +27,20 @@ lazy val buildSettings = Seq(
 lazy val rootBaseDir = ThisBuild / baseDirectory
 
 lazy val root: Project = Project(id = "root", file("."))
-  .aggregate(webapi, sipi, shared, valueObjects, userCore, userHandler, userRepo, userInterface)
+  .aggregate(
+    webapi,
+    sipi,
+    shared,
+    userCore,
+    userHandler,
+    userRepo,
+    userInterface,
+    roleCore,
+    roleRepo,
+    roleHandler,
+    roleInterface,
+    schemaCore
+  )
   .enablePlugins(GitVersioning, GitBranchPrompt)
   .settings(
     // values set for all sub-projects
@@ -231,16 +244,6 @@ lazy val webapiJavaTestOptions = Seq(
 // DSP's new codebase
 //////////////////////////////////////
 
-// Value Objects project
-
-lazy val valueObjects = project
-  .in(file("dsp-value-objects"))
-  .settings(
-    name := "valueObjects",
-    libraryDependencies ++= Dependencies.valueObjectsLibraryDependencies,
-    testFrameworks := Seq(new TestFramework("zio.test.sbt.ZTestFramework"))
-  )
-
 // Role projects
 
 lazy val roleInterface = project

docs/02-knora-ontologies/knora-base.md

@@ -32,7 +32,7 @@ In Knora, each item of data belongs to some particular project. Each project usi
 
 - `projectShortname` (1): A short name that can be used to identify the project in configuration files and the like.
 
-- `projectLongname` (1): The full name of the project.
+- `projectLongname` (0-1): The full name of the project.
 
 - `projectShortcode` (1): A hexadecimal code that uniquely identifies the project. These codes are assigned to projects
   by the [DaSCH](http://dasch.swiss/).

docs/Readme.md

@@ -3,7 +3,7 @@
 ## MkDocs Documentation
 
 This folder contains the sources to the DSP-API documentation website published
-under <http://docs-api.dasch.swiss>
+under <https://docs.dasch.swiss/>
 
 The `src` folder contains the following documentation sources:
 

dsp-role/handler/src/main/scala/dsp/role/handler/RoleHandler.scala

@@ -138,11 +138,10 @@ final case class RoleHandler(repo: RoleRepo) {
  * Companion object providing the layer with an initialized implementation
  */
 object RoleHandler {
-  val layer: ZLayer[RoleRepo, Nothing, RoleHandler] = {
+  val layer: ZLayer[RoleRepo, Nothing, RoleHandler] =
     ZLayer {
       for {
         repo <- ZIO.service[RoleRepo]
       } yield RoleHandler(repo)
     }.tap(_ => ZIO.logInfo(">>> Role Handler initilaized <<<"))
-  }
 }

dsp-role/repo/src/main/scala/dsp/role/repo/impl/RoleRepoLive.scala

@@ -63,11 +63,10 @@ final case class RoleRepoLive(
  * Companion object providing the layer with an initialized implementation of [[RoleRepo]]
  */
 object RoleRepoLive {
-  val layer: ZLayer[Any, Nothing, RoleRepo] = {
+  val layer: ZLayer[Any, Nothing, RoleRepo] =
     ZLayer {
       for {
         roles <- TMap.empty[UUID, Role].commit
       } yield RoleRepoLive(roles)
     }.tap(_ => ZIO.logInfo(">>> Role repository initialized <<<"))
-  }
 }

dsp-role/repo/src/test/scala/dsp/role/repo/impl/RoleRepoMock.scala

@@ -63,11 +63,10 @@ final case class RoleRepoMock(
  * Companion object providing the layer with an initialized implementation of [[RoleRepo]]
  */
 object RoleRepoMock {
-  val layer: ZLayer[Any, Nothing, RoleRepo] = {
+  val layer: ZLayer[Any, Nothing, RoleRepo] =
     ZLayer {
       for {
         roles <- TMap.empty[UUID, Role].commit
       } yield RoleRepoMock(roles)
     }.tap(_ => ZIO.logInfo(">>> In-memory role repository initialized <<<"))
-  }
 }

dsp-schema/core/src/main/scala/dsp/schema/domain/SchemaDomain.scala

@@ -0,0 +1,68 @@
+/*
+ * Copyright © 2021 - 2022 Data and Service Center for the Humanities and/or DaSCH Service Platform contributors.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package dsp.schema.domain
+
+import Cardinality._
+
+/**
+ * Represents a cardinality value object.
+ */
+sealed trait Cardinality { self =>
+
+  /**
+   * The string representation of the cardinality
+   */
+  val value: String
+
+  /**
+   * Checks whether a cardinality is stricter than another one.
+   *
+   * @param that      the cardinality to be compared against
+   * @return          `true` if the present cardinality is stricter than `that`, `false` otherwise
+   */
+  def isStricterThan(that: Cardinality): Boolean =
+    if (self == that) {
+      false
+    } else {
+      self match {
+        case MustHaveOne  => true
+        case MustHaveSome => that == MayHaveMany
+        case MayHaveOne   => that == MayHaveMany
+        case MayHaveMany  => false
+      }
+    }
+}
+
+object Cardinality {
+
+  /**
+   * The cardinality of a property that must have one value.
+   */
+  final case object MustHaveOne extends Cardinality {
+    override val value: String = "1"
+  }
+
+  /**
+   * The cardinality of a property that must have at least one value.
+   */
+  final case object MustHaveSome extends Cardinality {
+    override val value: String = "1-n"
+  }
+
+  /**
+   * The cardinality of a property that may have one value.
+   */
+  final case object MayHaveOne extends Cardinality {
+    override val value: String = "0-1"
+  }
+
+  /**
+   * The cardinality of a property that may have one or more values.
+   */
+  final case object MayHaveMany extends Cardinality {
+    override val value: String = "0-n"
+  }
+}

dsp-schema/core/src/main/scala/dsp/schema/domain/SchemaFunctionalDomain.scala

@@ -210,7 +210,7 @@ object SchemaDomain extends App {
     implicit def isSubtypeOf2[A, B >: A]: NotSubtypeOf[A, B] = new NotSubtypeOf[A, B] {}
   }
 
-  //trying it out
+  // trying it out
   val ontoInfo = OntologyInfo("test", "http://example.org/test", "Test", "Test")
 
   val classOne    = OntologyClass("ClassOne", "Class One", "Class One")
@@ -230,8 +230,8 @@ object SchemaDomain extends App {
       .withClass(classOne)
       .withClass(classTwo)
       .withProperty(propertyOne)
-      //.withProperty(propertyOne)
-      //.withProperty(propertyTwo)
+      // .withProperty(propertyOne)
+      // .withProperty(propertyTwo)
       .withCardinality(cardOne)
       .withCardinality(cardOne)
 

dsp-schema/core/src/main/scala/dsp/schema/handler/CreateSchema.scala

@@ -1,5 +1,3 @@
 package dsp.schema.handler
 
-object CreateSchema {
-    
-}
+object CreateSchema {}