qmap contract fix

univie-nutrition · Jun 19, 2024 · c1f9d0a · c1f9d0a
1 parent 7806483
commit c1f9d0a
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 6 deletions.
diff --git a/antora/modules/ROOT/pages/designdocs/InterviewModel.adoc b/antora/modules/ROOT/pages/designdocs/InterviewModel.adoc
@@ -122,7 +122,7 @@ it should be possible to create a new tree that has some selected nodes modified
 
 * *Navigable.* For every node in the tree we want to be able to navigate to its parent node or child nodes.
 
-* *Immutable.* Modification of the tree (once created), should not be possible unless by means of a transformer.
+* *Immutable.* Modification of the tree (once created), should not be possible.
 
 === GloboDiet Interview Export Semantics
 

diff --git a/commons/src/main/java/dita/commons/qmap/QualifiedMap.java b/commons/src/main/java/dita/commons/qmap/QualifiedMap.java
@@ -254,4 +254,20 @@ public static Try<QualifiedMap> tryFromYamlAllowEmptyTargets(@Nullable final Dat
                 .mapSuccessAsNullable(dto->Dtos.fromDto(dto, Policy.EMPTY_TARGET_ALLOWED));
     }
 
+    // -- CONTRACT
+
+    @Override
+    public boolean equals(final Object obj) {
+        return switch(obj) {
+            case QualifiedMap other -> other.internalMap.equals(this.internalMap);
+            default -> false;
+        };
+    }
+
+    @Override
+    public int hashCode() {
+        return internalMap.hashCode();
+    }
+
+
 }
diff --git a/commons/src/test/java/dita/commons/food/FoodTest.java b/commons/src/test/java/dita/commons/food/FoodTest.java
@@ -28,6 +28,7 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
 import org.apache.causeway.commons.collections.Can;
+import org.apache.causeway.commons.io.DataSource;
 
 import dita.commons.food.composition.FoodComponent;
 import dita.commons.food.composition.FoodComponent.ComponentUnit;
@@ -45,20 +46,19 @@ class FoodTest {
     private SemanticIdentifier blsBananaId = new SemanticIdentifier("bls", "F503100"); // Banana raw
 
     @Test
-    void test() {
+    void qMapCreation() {
 
         // setup food consumption
         var bananaConsumption = createFoodConsumption();
         var foodCompositionRepo = FoodCompositionSampler.createFoodCompositionRepository();
-        System.err.printf("%s%n", foodCompositionRepo.toYaml());
+        //debug
+        //System.err.printf("%s%n", foodCompositionRepo.toYaml());
 
         final FoodComponent blsZuckerGesamt = foodCompositionRepo.componentCatalog()
                 .lookupEntryElseFail(new SemanticIdentifier("bls", "KMD"));
 
-
         // setup nutrient mapping
-        final QualifiedMap qMap = new QualifiedMap(new HashMap<>());
-        qMap.put(new QualifiedMapEntry(bananaConsumption.foodId(), bananaConsumption.facetIds(), blsBananaId));
+        final QualifiedMap qMap = createQMap();
 
         // verify lookups
         assertEquals(
@@ -85,8 +85,31 @@ void test() {
                 fcac.quantifiedComponent(blsZuckerGesamt));
     }
 
+    @Test
+    void qMapRoundtrip() {
+        // setup nutrient mapping
+        final QualifiedMap qMap = createQMap();
+        var yaml = qMap.toYaml();
+        var qMapAfterRoundtrip = QualifiedMap.tryFromYaml(DataSource.ofStringUtf8(yaml))
+                .valueAsNonNullElseFail();
+
+        //debug
+        System.err.printf("%s%n", yaml);
+
+        assertEquals(qMap, qMapAfterRoundtrip);
+    }
+
     // -- HELPER
 
+    QualifiedMap createQMap() {
+        // setup food consumption
+        var bananaConsumption = createFoodConsumption();
+        // setup nutrient mapping
+        final QualifiedMap qMap = new QualifiedMap(new HashMap<>());
+        qMap.put(new QualifiedMapEntry(bananaConsumption.foodId(), bananaConsumption.facetIds(), blsBananaId));
+        return qMap;
+    }
+
     FoodConsumption createFoodConsumption() {
         var gdBanana = new SemanticIdentifier("gd", "00136"); // Banana
         var gdFacetRaw = new SemanticIdentifier("gd", "0399");