Merge branch 'uid' into dev-uid_resolve-conflicts

Bram-Hub · Mar 10, 2022 · 81ab94b · 81ab94b
2 parents 79969b1 + 0a6e808
commit 81ab94b
Show file tree

Hide file tree

Showing 161 changed files with 446 additions and 166 deletions.
diff --git a/.gitignore b/.gitignore
@@ -138,4 +138,4 @@ gradle-app.setting
 # JDT-specific (Eclipse Java Development Tools)
 .classpath
 
-# End of https://www.toptal.com/developers/gitignore/api/intellij+all,gradle,java
+# End of https://www.toptal.com/developers/gitignore/api/intellij+all,gradle,java
diff --git a/src/main/java/edu/rpi/legup/model/Puzzle.java b/src/main/java/edu/rpi/legup/model/Puzzle.java
@@ -385,6 +385,35 @@ public Rule getRuleByName(String name) {
         return null;
     }
 
+    /**
+     * Gets the rule using the specified name
+     *
+     * @param id name of the rule
+     * @return Rule
+     */
+    public Rule getRuleByID(String id) {
+        for (Rule rule : basicRules) {
+            if (rule.getRuleID().equals(id)) {
+                return rule;
+            }
+        }
+        for (Rule rule : contradictionRules) {
+            if (rule.getRuleID().equals(id)) {
+                return rule;
+            }
+        }
+        for (Rule rule : caseRules) {
+            if (rule.getRuleID().equals(id)) {
+                return rule;
+            }
+        }
+        Rule mergeRule = new MergeRule();
+        if (mergeRule.getRuleID().equals(id)) {
+            return mergeRule;
+        }
+        return null;
+    }
+
     /**
      * Gets the current board
      *

diff --git a/src/main/java/edu/rpi/legup/model/PuzzleExporter.java b/src/main/java/edu/rpi/legup/model/PuzzleExporter.java
@@ -44,7 +44,7 @@ public void exportPuzzle(String fileName) throws ExportFileException {
             Document newDocument = docBuilder.newDocument();
 
             org.w3c.dom.Element legupElement = newDocument.createElement("Legup");
-            legupElement.setAttribute("version", "2.0.0");
+            legupElement.setAttribute("version", "3.0.0");
             newDocument.appendChild(legupElement);
 
             org.w3c.dom.Element puzzleElement = newDocument.createElement("puzzle");
@@ -112,6 +112,7 @@ protected Element createTreeElement(Document newDocument) {
 
                     if (transition.isJustified()) {
                         transElement.setAttribute("rule", transition.getRule().getRuleName());
+                        transElement.setAttribute("rule_id", transition.getRule().getRuleID());
                     }
 
                     for (PuzzleElement data : transition.getBoard().getModifiedData()) {

diff --git a/src/main/java/edu/rpi/legup/model/PuzzleImporter.java b/src/main/java/edu/rpi/legup/model/PuzzleImporter.java
@@ -154,10 +154,10 @@ protected void createTree(Node node) throws InvalidFileFormatException {
             String nodeId = treeNodeElement.getAttribute("id");
             String isRoot = treeNodeElement.getAttribute("root");
             if (nodeId.isEmpty()) {
-                throw new InvalidFileFormatException("Proof Tree construction error: cannot find node id");
+                throw new InvalidFileFormatException("Proof Tree construction error: cannot find node ID");
             }
             if (treeNodes.containsKey(nodeId)) {
-                throw new InvalidFileFormatException("Proof Tree construction error: duplicate tree node id found");
+                throw new InvalidFileFormatException("Proof Tree construction error: duplicate tree node ID found");
             }
             TreeNode treeNode = new TreeNode(puzzle.getCurrentBoard().copy());
             if (isRoot.equalsIgnoreCase("true")) {
@@ -187,23 +187,24 @@ protected void createTree(Node node) throws InvalidFileFormatException {
                         treeNode.addChild(transition);
                         continue;
                     } else {
-                        throw new InvalidFileFormatException("Proof Tree construction error: duplicate transition id found");
+                        throw new InvalidFileFormatException("Proof Tree construction error: duplicate transition ID found");
                     }
 
                 }
 
                 String childId = trans.getAttribute("child");
                 String ruleName = trans.getAttribute("rule");
+                String ruleId = trans.getAttribute("rule_id");
 
                 TreeNode child = treeNodes.get(childId);
 
                 transition = new TreeTransition(treeNode, treeNode.getBoard().copy());
 
                 Rule rule;
                 if (!ruleName.isEmpty()) {
-                    rule = puzzle.getRuleByName(ruleName);
+                    rule = puzzle.getRuleByID(ruleId);
                     if (rule == null) {
-                        throw new InvalidFileFormatException("Proof Tree construction error: could not find rule by name");
+                        throw new InvalidFileFormatException("Proof Tree construction error: could not find rule by ID");
                     }
                     transition.setRule(rule);
                 }

diff --git a/src/main/java/edu/rpi/legup/model/rules/BasicRule.java b/src/main/java/edu/rpi/legup/model/rules/BasicRule.java
@@ -11,12 +11,13 @@ public abstract class BasicRule extends Rule {
     /**
      * BasicRule Constructor creates a new basic rule.
      *
+     * @param ruleID      ID of the rule
      * @param ruleName    name of the rule
      * @param description description of the rule
      * @param imageName   file name of the image
      */
-    public BasicRule(String ruleName, String description, String imageName) {
-        super(ruleName, description, imageName);
+    public BasicRule(String ruleID, String ruleName, String description, String imageName) {
+        super(ruleID, ruleName, description, imageName);
         this.ruleType = BASIC;
     }
 

diff --git a/src/main/java/edu/rpi/legup/model/rules/CaseRule.java b/src/main/java/edu/rpi/legup/model/rules/CaseRule.java
@@ -20,12 +20,13 @@ public abstract class CaseRule extends Rule {
     /**
      * CaseRule Constructor creates a new case rule.
      *
+     * @param ruleID      ID of the rule
      * @param ruleName    name of the rule
      * @param description description of the rule
      * @param imageName   file name of the image
      */
-    public CaseRule(String ruleName, String description, String imageName) {
-        super(ruleName, description, imageName);
+    public CaseRule(String ruleID, String ruleName, String description, String imageName) {
+        super(ruleID, ruleName, description, imageName);
         this.ruleType = CASE;
         this.INVALID_USE_MESSAGE = "Invalid use of the case rule " + this.ruleName;
     }

diff --git a/src/main/java/edu/rpi/legup/model/rules/ContradictionRule.java b/src/main/java/edu/rpi/legup/model/rules/ContradictionRule.java
@@ -13,12 +13,13 @@ public abstract class ContradictionRule extends Rule {
     /**
      * ContradictionRule Constructor creates a new contradiction rule
      *
+     * @param ruleID      ID of the rule
      * @param ruleName    name of the rule
      * @param description description of the rule
      * @param imageName   file name of the image
      */
-    public ContradictionRule(String ruleName, String description, String imageName) {
-        super(ruleName, description, imageName);
+    public ContradictionRule(String ruleID, String ruleName, String description, String imageName) {
+        super(ruleID, ruleName, description, imageName);
         ruleType = CONTRADICTION;
     }
 

diff --git a/src/main/java/edu/rpi/legup/model/rules/MergeRule.java b/src/main/java/edu/rpi/legup/model/rules/MergeRule.java
@@ -19,7 +19,7 @@ public class MergeRule extends Rule {
      * MergeRule Constructor merges to board states together
      */
     public MergeRule() {
-        super("Merge Rule",
+        super("MERGE","Merge Rule",
                 "Merge any number of nodes into one",
                 "edu/rpi/legup/images/Legup/MergeRule.png");
         this.ruleType = MERGE;

diff --git a/src/main/java/edu/rpi/legup/model/rules/Rule.java b/src/main/java/edu/rpi/legup/model/rules/Rule.java
@@ -13,6 +13,7 @@
 
 @RegisterRule
 public abstract class Rule {
+    protected String ruleID;
     protected String ruleName;
     protected String description;
     protected String imageName;
@@ -24,14 +25,16 @@ public abstract class Rule {
     /**
      * Rule Constructor creates a new rule
      *
+     * @param ruleID      ID of the rule
      * @param ruleName    name of the rule
      * @param description description of the rule
      * @param imageName   file name of the image
      */
-    public Rule(String ruleName, String description, String imageName) {
-        this.imageName = imageName;
+    public Rule(String ruleID, String ruleName, String description, String imageName) {
+        this.ruleID = ruleID;
         this.ruleName = ruleName;
         this.description = description;
+        this.imageName = imageName;
         this.INVALID_USE_MESSAGE = "Invalid use of the rule " + this.ruleName;
         loadImage();
     }
@@ -108,6 +111,15 @@ public String getRuleName() {
         return ruleName;
     }
 
+    /**
+     * Gets the name of the rule
+     *
+     * @return name of the rule
+     */
+    public String getRuleID() {
+        return ruleID;
+    }
+
     /**
      * Sets the rule name
      *

diff --git a/src/main/java/edu/rpi/legup/puzzle/battleship/rules/AdjacentShipsContradictionRule.java b/src/main/java/edu/rpi/legup/puzzle/battleship/rules/AdjacentShipsContradictionRule.java
@@ -7,7 +7,8 @@
 public class AdjacentShipsContradictionRule extends ContradictionRule {
 
     public AdjacentShipsContradictionRule() {
-        super("Adjacent Ships",
+        super("BTSP-CONT-0001",
+                "Adjacent Ships",
                 "",
                 "edu/rpi/legup/images/battleship/contradictions/AdjacentShips.png");
     }

diff --git a/src/main/java/edu/rpi/legup/puzzle/battleship/rules/ContinueShipBasicRule.java b/src/main/java/edu/rpi/legup/puzzle/battleship/rules/ContinueShipBasicRule.java
@@ -9,7 +9,8 @@
 public class ContinueShipBasicRule extends BasicRule {
 
     public ContinueShipBasicRule() {
-        super("Continue Ship",
+        super("BTSP-BASC-0001",
+                "Continue Ship",
                 "",
                 "edu/rpi/legup/images/battleship/rules/ContinueShip.png");
     }

diff --git a/src/main/java/edu/rpi/legup/puzzle/battleship/rules/FinishWithWaterBasicRule.java b/src/main/java/edu/rpi/legup/puzzle/battleship/rules/FinishWithWaterBasicRule.java
@@ -9,7 +9,8 @@
 public class FinishWithWaterBasicRule extends BasicRule {
 
     public FinishWithWaterBasicRule() {
-        super("Finish with Water",
+        super("BTSP-BASC-0003",
+                "Finish with Water",
                 "",
                 "edu/rpi/legup/images/battleship/rules/finishWater.png");
     }

diff --git a/src/main/java/edu/rpi/legup/puzzle/battleship/rules/FinishedWithShipsBasicRule.java b/src/main/java/edu/rpi/legup/puzzle/battleship/rules/FinishedWithShipsBasicRule.java
@@ -9,7 +9,8 @@
 public class FinishedWithShipsBasicRule extends BasicRule {
 
     public FinishedWithShipsBasicRule() {
-        super("Finished with Ships",
+        super("BTSP-BASC-0002",
+                "Finished with Ships",
                 "",
                 "edu/rpi/legup/images/battleship/rules/finishShip.png");
     }

diff --git a/src/main/java/edu/rpi/legup/puzzle/battleship/rules/IncompleteShipContradictionRule.java b/src/main/java/edu/rpi/legup/puzzle/battleship/rules/IncompleteShipContradictionRule.java
@@ -7,7 +7,8 @@
 public class IncompleteShipContradictionRule extends ContradictionRule {
 
     public IncompleteShipContradictionRule() {
-        super("Incomplete Ship",
+        super("BTSP-CONT-0002",
+                "Incomplete Ship",
                 "",
                 "edu/rpi/legup/images/battleship/contradictions/IncompleteShip.png");
     }

diff --git a/src/main/java/edu/rpi/legup/puzzle/battleship/rules/SegmentTypeBasicRule.java b/src/main/java/edu/rpi/legup/puzzle/battleship/rules/SegmentTypeBasicRule.java
@@ -9,7 +9,8 @@
 public class SegmentTypeBasicRule extends BasicRule {
 
     public SegmentTypeBasicRule() {
-        super("Segment Type",
+        super("BTSP-BASC-0004",
+                "Segment Type",
                 "",
                 "edu/rpi/legup/images/battleship/rules/SegmentChoice.png");
     }

diff --git a/src/main/java/edu/rpi/legup/puzzle/battleship/rules/SegmentTypeCaseRule.java b/src/main/java/edu/rpi/legup/puzzle/battleship/rules/SegmentTypeCaseRule.java
@@ -10,7 +10,8 @@
 
 public class SegmentTypeCaseRule extends CaseRule {
     public SegmentTypeCaseRule() {
-        super("Segment Type",
+        super("BTSP-CASE-0001",
+                "Segment Type",
                 "",
                 "edu/rpi/legup/images/battleship/cases/SegmentType.png");
     }

diff --git a/src/main/java/edu/rpi/legup/puzzle/battleship/rules/ShipLocationCaseRule.java b/src/main/java/edu/rpi/legup/puzzle/battleship/rules/ShipLocationCaseRule.java
@@ -11,7 +11,8 @@
 public class ShipLocationCaseRule extends CaseRule {
 
     public ShipLocationCaseRule() {
-        super("Ship Location",
+        super("BTSP-CASE-0002",
+                "Ship Location",
                 "",
                 "edu/rpi/legup/images/battleship/cases/ShipLocations.png");
     }

diff --git a/src/main/java/edu/rpi/legup/puzzle/battleship/rules/ShipOrWaterCaseRule.java b/src/main/java/edu/rpi/legup/puzzle/battleship/rules/ShipOrWaterCaseRule.java
@@ -11,7 +11,8 @@
 public class ShipOrWaterCaseRule extends CaseRule {
 
     public ShipOrWaterCaseRule() {
-        super("Ship or Water",
+        super("BTSP-CASE-0003",
+                "Ship or Water",
                 "",
                 "edu/rpi/legup/images/battleship/cases/ShipOrWater.png");
     }

diff --git a/src/main/java/edu/rpi/legup/puzzle/battleship/rules/SurroundShipBasicRule.java b/src/main/java/edu/rpi/legup/puzzle/battleship/rules/SurroundShipBasicRule.java
@@ -9,7 +9,8 @@
 public class SurroundShipBasicRule extends BasicRule {
 
     public SurroundShipBasicRule() {
-        super("Surround Ship",
+        super("BTSP-BASC-0005",
+                "Surround Ship",
                 "",
                 "edu/rpi/legup/images/battleship/rules/SurroundShip.png");
     }

diff --git a/src/main/java/edu/rpi/legup/puzzle/battleship/rules/TooFewInFleetContradictionRule.java b/src/main/java/edu/rpi/legup/puzzle/battleship/rules/TooFewInFleetContradictionRule.java
@@ -7,7 +7,8 @@
 public class TooFewInFleetContradictionRule extends ContradictionRule {
 
     public TooFewInFleetContradictionRule() {
-        super("Too Few in Fleet",
+        super("BTSP-CONT-0003",
+                "Too Few in Fleet",
                 "",
                 "edu/rpi/legup/images/battleship/contradictions/too_few_in_fleet.png");
     }

diff --git a/src/main/java/edu/rpi/legup/puzzle/battleship/rules/TooFewRowColContradictionRule.java b/src/main/java/edu/rpi/legup/puzzle/battleship/rules/TooFewRowColContradictionRule.java
@@ -7,7 +7,8 @@
 public class TooFewRowColContradictionRule extends ContradictionRule {
 
     public TooFewRowColContradictionRule() {
-        super("Too few in row/col",
+        super("BTSP-CONT-0004",
+                "Too few in row/col",
                 "",
                 "edu/rpi/legup/images/battleship/contradictions/too_few_segments.png");
     }

diff --git a/src/main/java/edu/rpi/legup/puzzle/battleship/rules/TooManyInFleetContradictionRule.java b/src/main/java/edu/rpi/legup/puzzle/battleship/rules/TooManyInFleetContradictionRule.java
@@ -7,7 +7,8 @@
 public class TooManyInFleetContradictionRule extends ContradictionRule {
 
     public TooManyInFleetContradictionRule() {
-        super("Too Many in Fleet",
+        super("BTSP-CONT-0005",
+                "Too Many in Fleet",
                 "",
                 "edu/rpi/legup/images/battleship/contradictions/too_many_in_fleet.png");
     }

diff --git a/src/main/java/edu/rpi/legup/puzzle/battleship/rules/TooManyRowColContradiction.java b/src/main/java/edu/rpi/legup/puzzle/battleship/rules/TooManyRowColContradiction.java
@@ -7,7 +7,8 @@
 public class TooManyRowColContradiction extends ContradictionRule {
 
     public TooManyRowColContradiction() {
-        super("Too Many row/col",
+        super("BTSP-CONT-0006",
+                "Too Many row/col",
                 "",
                 "edu/rpi/legup/images/battleship/contradictions/too_many_segments.png");
     }

diff --git a/src/main/java/edu/rpi/legup/puzzle/battleship/rules/battleship_reference_sheet.txt b/src/main/java/edu/rpi/legup/puzzle/battleship/rules/battleship_reference_sheet.txt
@@ -0,0 +1,17 @@
+BTSP-BASC-0001 : ContinueShipBasicRule
+BTSP-BASC-0002 : FinishedWithShipsBasicRule
+BTSP-BASC-0003 : FinishWithWaterBasicRule
+BTSP-BASC-0004 : SegmentTypeBasicRule
+BTSP-BASC-0005 : SurroundShipBasicRule
+
+BTSP-CONT-0001 : AdjacentShipsContradictionRule
+BTSP-CONT-0002 : IncompleteShipContradictionRule
+BTSP-CONT-0003 : TooFewInFleetContradictionRule
+BTSP-CONT-0004 : TooFewRowColContradictionRule
+BTSP-CONT-0005 : TooManyInFleetContradictionRule
+BTSP-CONT-0006 : TooManyRowColContradiction
+
+BTSP-CASE-0001 : SegmentTypeCaseRule
+BTSP-CASE-0002 : ShipLocationCaseRule
+BTSP-CASE-0003 : ShipOrWaterCaseRule
+
diff --git a/src/main/java/edu/rpi/legup/puzzle/fillapix/rules/BlackOrWhiteCaseRule.java b/src/main/java/edu/rpi/legup/puzzle/fillapix/rules/BlackOrWhiteCaseRule.java
@@ -14,7 +14,8 @@
 
 public class BlackOrWhiteCaseRule extends CaseRule {
     public BlackOrWhiteCaseRule() {
-        super("Black or White",
+        super("FPIX-CASE-0001",
+                "Black or White",
                 "Each cell is either black or white.",
                 "edu/rpi/legup/images/fillapix/cases/BlackOrWhite.png");
     }

diff --git a/src/main/java/edu/rpi/legup/puzzle/fillapix/rules/FinishWithBlackBasicRule.java b/src/main/java/edu/rpi/legup/puzzle/fillapix/rules/FinishWithBlackBasicRule.java
@@ -11,7 +11,8 @@
 
 public class FinishWithBlackBasicRule extends BasicRule {
     public FinishWithBlackBasicRule() {
-        super("Finish with Black",
+        super("FPIX-BASC-0001",
+                "Finish with Black",
                 "The remaining unknowns around and on a cell must be black to satisfy the number",
                 "edu/rpi/legup/images/fillapix/rules/FinishWithBlack.png");
     }

diff --git a/src/main/java/edu/rpi/legup/puzzle/fillapix/rules/FinishWithWhiteBasicRule.java b/src/main/java/edu/rpi/legup/puzzle/fillapix/rules/FinishWithWhiteBasicRule.java
@@ -11,7 +11,8 @@
 
 public class FinishWithWhiteBasicRule extends BasicRule {
     public FinishWithWhiteBasicRule() {
-        super("Finish with White",
+        super("FinishWithWhiteBasicRule",
+                "Finish with White",
                 "The remaining unknowns around and on a cell must be white to satisfy the number",
                 "edu/rpi/legup/images/fillapix/rules/FinishWithWhite.png");
     }

diff --git a/src/main/java/edu/rpi/legup/puzzle/fillapix/rules/TooFewBlackCellsContradictionRule.java b/src/main/java/edu/rpi/legup/puzzle/fillapix/rules/TooFewBlackCellsContradictionRule.java
@@ -12,7 +12,8 @@
 public class TooFewBlackCellsContradictionRule extends ContradictionRule {
 
     public TooFewBlackCellsContradictionRule() {
-        super("Too Few Black Cells",
+        super("FPIX-CONT-0001",
+                "Too Few Black Cells",
                 "There may not be fewer black cells than the number.",
                 "edu/rpi/legup/images/fillapix/contradictions/TooFewBlackCells.png");
     }