✨ feat: Armies | Army command model (#2)

MateuszNaKodach · MateuszNaKodach · commit 0d1675e26558 · 2025-02-06T14:15:02.000+01:00
diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml
@@ -35,5 +35,5 @@ jobs:
         run: mvn -B package --file pom.xml
 
       # Optional: Uploads the full dependency graph to GitHub to improve the quality of Dependabot alerts this repository can receive
-      - name: 📈 Update dependency graph
-        uses: advanced-security/maven-dependency-submission-action@571e99aab1055c2e71a1e2309b9691de18d6b7d6
+#      - name: 📈 Update dependency graph
+#        uses: advanced-security/maven-dependency-submission-action@571e99aab1055c2e71a1e2309b9691de18d6b7d6
diff --git a/src/main/java/com/dddheroes/heroesofddd/armies/write/Army.java b/src/main/java/com/dddheroes/heroesofddd/armies/write/Army.java
@@ -0,0 +1,83 @@
+package com.dddheroes.heroesofddd.armies.write;
+
+import com.dddheroes.heroesofddd.armies.write.addcreature.AddCreatureToArmy;
+import com.dddheroes.heroesofddd.armies.write.addcreature.CreatureAddedToArmy;
+import com.dddheroes.heroesofddd.armies.write.addcreature.CanHaveMax7CreatureStacksInArmy;
+import com.dddheroes.heroesofddd.armies.write.removecreature.CreatureRemovedFromArmy;
+import com.dddheroes.heroesofddd.armies.write.removecreature.CanRemoveOnlyPresentCreatures;
+import com.dddheroes.heroesofddd.armies.write.removecreature.RemoveCreatureFromArmy;
+import com.dddheroes.heroesofddd.shared.Amount;
+import com.dddheroes.heroesofddd.shared.ArmyId;
+import com.dddheroes.heroesofddd.shared.CreatureId;
+import org.axonframework.commandhandling.CommandHandler;
+import org.axonframework.eventsourcing.EventSourcingHandler;
+import org.axonframework.modelling.command.AggregateCreationPolicy;
+import org.axonframework.modelling.command.AggregateIdentifier;
+import org.axonframework.modelling.command.CreationPolicy;
+import org.axonframework.spring.stereotype.Aggregate;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import static org.axonframework.modelling.command.AggregateLifecycle.apply;
+
+@Aggregate
+class Army {
+
+    @AggregateIdentifier
+    private ArmyId armyId;
+    private final Map<CreatureId, Amount> creatureStacks = new HashMap<>();
+
+    @CommandHandler
+    @CreationPolicy(AggregateCreationPolicy.CREATE_IF_MISSING)
+    void handle(AddCreatureToArmy command) {
+        new CanHaveMax7CreatureStacksInArmy(command.creatureId(), creatureStacks).verify();
+
+        apply(
+                CreatureAddedToArmy.event(
+                        command.armyId(),
+                        command.creatureId(),
+                        command.quantity()
+                )
+        );
+    }
+
+    @EventSourcingHandler
+    void on(CreatureAddedToArmy event) {
+        this.armyId = new ArmyId(event.armyId());
+        creatureStacks.merge(new CreatureId(event.creatureId()), new Amount(event.quantity()), Amount::plus);
+    }
+
+    @CommandHandler
+    void handle(RemoveCreatureFromArmy command) {
+        new CanRemoveOnlyPresentCreatures(command.creatureId(), command.quantity(), creatureStacks).verify();
+
+        apply(
+                CreatureRemovedFromArmy.event(
+                        command.armyId(),
+                        command.creatureId(),
+                        command.quantity()
+                )
+        );
+    }
+
+    @EventSourcingHandler
+    void on(CreatureRemovedFromArmy event) {
+        var creatureId = new CreatureId(event.creatureId());
+        var currentQuantity = creatureStacks.get(creatureId);
+        var removedQuantity = new Amount(event.quantity());
+        if (currentQuantity.equals(removedQuantity)) {
+            creatureStacks.remove(creatureId);
+        } else {
+            creatureStacks.merge(
+                    creatureId,
+                    removedQuantity,
+                    Amount::minus
+            );
+        }
+    }
+
+    Army() {
+        // required by Axon
+    }
+}
diff --git a/src/main/java/com/dddheroes/heroesofddd/armies/write/ArmyCommand.java b/src/main/java/com/dddheroes/heroesofddd/armies/write/ArmyCommand.java
@@ -0,0 +1,8 @@
+package com.dddheroes.heroesofddd.armies.write;
+
+import com.dddheroes.heroesofddd.shared.ArmyId;
+
+public interface ArmyCommand {
+
+    ArmyId armyId();
+}
diff --git a/src/main/java/com/dddheroes/heroesofddd/armies/write/ArmyEvent.java b/src/main/java/com/dddheroes/heroesofddd/armies/write/ArmyEvent.java
@@ -0,0 +1,6 @@
+package com.dddheroes.heroesofddd.armies.write;
+
+public interface ArmyEvent {
+
+    String armyId();
+}
diff --git a/src/main/java/com/dddheroes/heroesofddd/armies/write/addcreature/AddCreatureToArmy.java b/src/main/java/com/dddheroes/heroesofddd/armies/write/addcreature/AddCreatureToArmy.java
@@ -0,0 +1,24 @@
+package com.dddheroes.heroesofddd.armies.write.addcreature;
+
+import com.dddheroes.heroesofddd.shared.Amount;
+import com.dddheroes.heroesofddd.shared.ArmyId;
+import com.dddheroes.heroesofddd.shared.CreatureId;
+import org.axonframework.modelling.command.TargetAggregateIdentifier;
+
+public record AddCreatureToArmy(
+        @TargetAggregateIdentifier
+        ArmyId armyId,
+        CreatureId creatureId,
+        Amount quantity
+) {
+
+    public AddCreatureToArmy {
+        if (quantity.raw() <= 0) {
+            throw new IllegalArgumentException("Quantity must be greater than 0");
+        }
+    }
+
+    public AddCreatureToArmy command(String armyId, String creatureId, int quantity) {
+        return new AddCreatureToArmy(new ArmyId(armyId), new CreatureId(creatureId), new Amount(quantity));
+    }
+}
diff --git a/src/main/java/com/dddheroes/heroesofddd/armies/write/addcreature/CanHaveMax7CreatureStacksInArmy.java b/src/main/java/com/dddheroes/heroesofddd/armies/write/addcreature/CanHaveMax7CreatureStacksInArmy.java
@@ -0,0 +1,26 @@
+package com.dddheroes.heroesofddd.armies.write.addcreature;
+
+import com.dddheroes.heroesofddd.shared.Amount;
+import com.dddheroes.heroesofddd.shared.CreatureId;
+import com.dddheroes.heroesofddd.shared.DomainRule;
+
+import java.util.Map;
+
+public record CanHaveMax7CreatureStacksInArmy(
+        CreatureId creatureToAdd,
+        Map<CreatureId, Amount> creatureStacksBeforeAdd
+) implements DomainRule {
+
+    private static final int MAX_CREATURE_STACKS = 7;
+
+    @Override
+    public boolean isViolated() {
+        return creatureStacksBeforeAdd.size() >= MAX_CREATURE_STACKS
+                && !creatureStacksBeforeAdd.containsKey(creatureToAdd);
+    }
+
+    @Override
+    public String message() {
+        return "Can have max 7 different creature stacks in the army";
+    }
+}
diff --git a/src/main/java/com/dddheroes/heroesofddd/armies/write/addcreature/CreatureAddedToArmy.java b/src/main/java/com/dddheroes/heroesofddd/armies/write/addcreature/CreatureAddedToArmy.java
@@ -0,0 +1,25 @@
+package com.dddheroes.heroesofddd.armies.write.addcreature;
+
+import com.dddheroes.heroesofddd.armies.write.ArmyEvent;
+import com.dddheroes.heroesofddd.shared.Amount;
+import com.dddheroes.heroesofddd.shared.ArmyId;
+import com.dddheroes.heroesofddd.shared.CreatureId;
+
+public record CreatureAddedToArmy(
+        String armyId,
+        String creatureId,
+        Integer quantity
+) implements ArmyEvent {
+
+    public static CreatureAddedToArmy event(
+            ArmyId armyId,
+            CreatureId creatureId,
+            Amount quantity
+    ) {
+        return new CreatureAddedToArmy(
+                armyId.raw(),
+                creatureId.raw(),
+                quantity.raw()
+        );
+    }
+}
diff --git a/src/main/java/com/dddheroes/heroesofddd/armies/write/removecreature/CanRemoveOnlyPresentCreatures.java b/src/main/java/com/dddheroes/heroesofddd/armies/write/removecreature/CanRemoveOnlyPresentCreatures.java
@@ -0,0 +1,25 @@
+package com.dddheroes.heroesofddd.armies.write.removecreature;
+
+import com.dddheroes.heroesofddd.shared.Amount;
+import com.dddheroes.heroesofddd.shared.CreatureId;
+import com.dddheroes.heroesofddd.shared.DomainRule;
+
+import java.util.Map;
+
+public record CanRemoveOnlyPresentCreatures(
+        CreatureId creatureToRemove,
+        Amount quantityToRemove,
+        Map<CreatureId, Amount> creatureStacksBeforeRemoved
+) implements DomainRule {
+
+    @Override
+    public boolean isViolated() {
+        return creatureStacksBeforeRemoved
+                .getOrDefault(creatureToRemove, Amount.zero()).raw() < quantityToRemove.raw();
+    }
+
+    @Override
+    public String message() {
+        return "Can remove only present creatures";
+    }
+}
diff --git a/src/main/java/com/dddheroes/heroesofddd/armies/write/removecreature/CreatureRemovedFromArmy.java b/src/main/java/com/dddheroes/heroesofddd/armies/write/removecreature/CreatureRemovedFromArmy.java
@@ -0,0 +1,25 @@
+package com.dddheroes.heroesofddd.armies.write.removecreature;
+
+import com.dddheroes.heroesofddd.armies.write.ArmyEvent;
+import com.dddheroes.heroesofddd.shared.Amount;
+import com.dddheroes.heroesofddd.shared.ArmyId;
+import com.dddheroes.heroesofddd.shared.CreatureId;
+
+public record CreatureRemovedFromArmy(
+        String armyId,
+        String creatureId,
+        Integer quantity
+) implements ArmyEvent {
+
+    public static CreatureRemovedFromArmy event(
+            ArmyId armyId,
+            CreatureId creatureId,
+            Amount quantity
+    ) {
+        return new CreatureRemovedFromArmy(
+                armyId.raw(),
+                creatureId.raw(),
+                quantity.raw()
+        );
+    }
+}
diff --git a/src/main/java/com/dddheroes/heroesofddd/armies/write/removecreature/RemoveCreatureFromArmy.java b/src/main/java/com/dddheroes/heroesofddd/armies/write/removecreature/RemoveCreatureFromArmy.java
@@ -0,0 +1,24 @@
+package com.dddheroes.heroesofddd.armies.write.removecreature;
+
+import com.dddheroes.heroesofddd.shared.Amount;
+import com.dddheroes.heroesofddd.shared.ArmyId;
+import com.dddheroes.heroesofddd.shared.CreatureId;
+import org.axonframework.modelling.command.TargetAggregateIdentifier;
+
+public record RemoveCreatureFromArmy(
+        @TargetAggregateIdentifier
+        ArmyId armyId,
+        CreatureId creatureId,
+        Amount quantity
+) {
+
+    public RemoveCreatureFromArmy {
+        if (quantity.raw() <= 0) {
+            throw new IllegalArgumentException("Quantity must be greater than 0");
+        }
+    }
+
+    public RemoveCreatureFromArmy command(String armyId, String creatureId, int quantity) {
+        return new RemoveCreatureFromArmy(new ArmyId(armyId), new CreatureId(creatureId), new Amount(quantity));
+    }
+}
diff --git a/src/main/java/com/dddheroes/heroesofddd/creaturerecruitment/write/Dwelling.java b/src/main/java/com/dddheroes/heroesofddd/creaturerecruitment/write/Dwelling.java
@@ -22,7 +22,7 @@
 import static org.axonframework.modelling.command.AggregateLifecycle.*;
 
 @Aggregate
-public class Dwelling {
+class Dwelling {
 
     @AggregateIdentifier
     private DwellingId dwellingId;
@@ -77,24 +77,24 @@ void handle(RecruitCreature command) {
                 creatureId,
                 availableCreatures,
                 command.creatureId(),
-                command.recruit()
+                command.quantity()
         ).verify();
 
         apply(
                 CreatureRecruited.event(
                         command.dwellingId(),
                         command.creatureId(),
                         command.toArmy(),
-                        command.recruit(),
-                        costPerTroop.multiply(command.recruit())
+                        command.quantity(),
+                        costPerTroop.multiply(command.quantity())
                 )
         );
     }
 
     @EventSourcingHandler
     void on(CreatureRecruited event) {
         // todo: consider if it's OK or RecruitCreature should cause also AvailableCreaturesChanged event
-        this.availableCreatures = this.availableCreatures.minus(new Amount(event.recruited()));
+        this.availableCreatures = this.availableCreatures.minus(new Amount(event.quantity()));
     }
 
     Dwelling() {
diff --git a/src/main/java/com/dddheroes/heroesofddd/creaturerecruitment/write/recruitcreature/CreatureRecruited.java b/src/main/java/com/dddheroes/heroesofddd/creaturerecruitment/write/recruitcreature/CreatureRecruited.java
@@ -13,22 +13,22 @@ public record CreatureRecruited(
         String dwellingId,
         String creatureId,
         String toArmy,
-        Integer recruited,
+        Integer quantity,
         Map<String, Integer> totalCost
 ) implements DwellingEvent {
 
     public static CreatureRecruited event(
             DwellingId dwellingId,
             CreatureId creatureId,
             ArmyId toArmy,
-            Amount recruited,
+            Amount quantity,
             Cost totalCost
     ) {
         return new CreatureRecruited(
                 dwellingId.raw(),
                 creatureId.raw(),
                 toArmy.raw(),
-                recruited.raw(),
+                quantity.raw(),
                 totalCost.raw()
         );
     }
diff --git a/src/main/java/com/dddheroes/heroesofddd/creaturerecruitment/write/recruitcreature/RecruitCreature.java b/src/main/java/com/dddheroes/heroesofddd/creaturerecruitment/write/recruitcreature/RecruitCreature.java
@@ -12,13 +12,13 @@ public record RecruitCreature(
         DwellingId dwellingId,
         CreatureId creatureId,
         ArmyId toArmy,
-        Amount recruit
+        Amount quantity
 ) implements DwellingCommand {
 
-    public static RecruitCreature command(String dwellingId, String creatureId, String toArmy, Integer recruit) {
+    public static RecruitCreature command(String dwellingId, String creatureId, String toArmy, Integer quantity) {
         return new RecruitCreature(DwellingId.of(dwellingId),
                                    CreatureId.of(creatureId),
                                    ArmyId.of(toArmy),
-                                   Amount.of(recruit));
+                                   Amount.of(quantity));
     }
 }
diff --git a/src/test/java/com/dddheroes/heroesofddd/armies/write/ArmyTest.java b/src/test/java/com/dddheroes/heroesofddd/armies/write/ArmyTest.java
@@ -0,0 +1,29 @@
+package com.dddheroes.heroesofddd.armies.write;
+
+import com.dddheroes.heroesofddd.armies.write.addcreature.CreatureAddedToArmy;
+import com.dddheroes.heroesofddd.armies.write.removecreature.CreatureRemovedFromArmy;
+import com.dddheroes.heroesofddd.shared.Amount;
+import com.dddheroes.heroesofddd.shared.ArmyId;
+import com.dddheroes.heroesofddd.shared.CreatureId;
+import org.axonframework.test.aggregate.AggregateTestFixture;
+import org.junit.jupiter.api.*;
+
+public class ArmyTest {
+
+    protected final ArmyId armyId = ArmyId.random();
+
+    protected AggregateTestFixture<?> fixture;
+
+    @BeforeEach
+    void setUp() {
+        fixture = new AggregateTestFixture<>(Army.class);
+    }
+
+    protected CreatureAddedToArmy creatureAddedToArmy(CreatureId creatureId, int quantity) {
+        return CreatureAddedToArmy.event(armyId, creatureId, Amount.of(quantity));
+    }
+
+    protected CreatureRemovedFromArmy creatureRemovedFromArmy(CreatureId creatureId, int quantity) {
+        return CreatureRemovedFromArmy.event(armyId, creatureId, Amount.of(quantity));
+    }
+}
diff --git a/src/test/java/com/dddheroes/heroesofddd/armies/write/addcreature/AddCreatureToArmyTest.java b/src/test/java/com/dddheroes/heroesofddd/armies/write/addcreature/AddCreatureToArmyTest.java
diff --git a/src/test/java/com/dddheroes/heroesofddd/armies/write/removecreature/RemoveCreatureFromArmyTest.java b/src/test/java/com/dddheroes/heroesofddd/armies/write/removecreature/RemoveCreatureFromArmyTest.java
diff --git a/src/test/java/com/dddheroes/heroesofddd/creaturerecruitment/write/DwellingTest.java b/src/test/java/com/dddheroes/heroesofddd/creaturerecruitment/write/DwellingTest.java
diff --git a/src/test/java/com/dddheroes/heroesofddd/creaturerecruitment/write/changeavailablecreatures/IncreaseAvailableCreaturesTest.java b/src/test/java/com/dddheroes/heroesofddd/creaturerecruitment/write/changeavailablecreatures/IncreaseAvailableCreaturesTest.java
diff --git a/src/test/java/com/dddheroes/heroesofddd/creaturerecruitment/write/recruitcreature/RecruitCreatureTest.java b/src/test/java/com/dddheroes/heroesofddd/creaturerecruitment/write/recruitcreature/RecruitCreatureTest.java
diff --git a/src/test/java/com/dddheroes/heroesofddd/shared/CreatureIds.java b/src/test/java/com/dddheroes/heroesofddd/shared/CreatureIds.java
