Merge pull request #67 from Bram-Hub/truth-table_issue57_and-elim-bug…

…-restructuring Standardized Error Messages
Bram-Hub · Jan 4, 2022 · 89cf87b · 89cf87b
2 parents ab322d0 + abae849
commit 89cf87b
Show file tree

Hide file tree

Showing 62 changed files with 220 additions and 230 deletions.
diff --git a/src/main/java/edu/rpi/legup/model/rules/CaseRule.java b/src/main/java/edu/rpi/legup/model/rules/CaseRule.java
@@ -14,6 +14,9 @@
 import static edu.rpi.legup.model.rules.RuleType.CASE;
 
 public abstract class CaseRule extends Rule {
+
+    private final String INVALID_USE_MESSAGE;
+
     /**
      * CaseRule Constructor creates a new case rule.
      *
@@ -24,6 +27,7 @@ public abstract class CaseRule extends Rule {
     public CaseRule(String ruleName, String description, String imageName) {
         super(ruleName, description, imageName);
         this.ruleType = CASE;
+        this.INVALID_USE_MESSAGE = "Invalid use of the case rule " + this.ruleName;
     }
 
     /**
@@ -103,8 +107,7 @@ public String checkRule(TreeTransition transition) {
      */
     @Override
     public String checkRuleAt(TreeTransition transition, PuzzleElement puzzleElement) {
-//        System.out.println("Nurikabe case rule check reached here");
-        return "Invalid use of a case rule";
+        return this.INVALID_USE_MESSAGE;
     }
 
     /**

diff --git a/src/main/java/edu/rpi/legup/model/rules/ContradictionRule.java b/src/main/java/edu/rpi/legup/model/rules/ContradictionRule.java
@@ -7,6 +7,9 @@
 import static edu.rpi.legup.model.rules.RuleType.CONTRADICTION;
 
 public abstract class ContradictionRule extends Rule {
+
+    private final String NO_CONTRADICTION_MESSAGE = "No instance of the contradiction " + this.ruleName + " here";
+
     /**
      * ContradictionRule Constructor creates a new contradiction rule
      *
@@ -84,7 +87,12 @@ public String checkContradiction(Board board) {
                 return checkStr;
             }
         }
-        return "Does not contain a contradiction";
+        return this.NO_CONTRADICTION_MESSAGE;
+    }
+
+    public String getNoContradictionMessage()
+    {
+        return this.NO_CONTRADICTION_MESSAGE;
     }
 
     /**
@@ -96,4 +104,5 @@ public String checkContradiction(Board board) {
      * otherwise error message
      */
     public abstract String checkContradictionAt(Board board, PuzzleElement puzzleElement);
+
 }
diff --git a/src/main/java/edu/rpi/legup/model/rules/Rule.java b/src/main/java/edu/rpi/legup/model/rules/Rule.java
@@ -19,6 +19,8 @@ public abstract class Rule {
     protected ImageIcon image;
     protected RuleType ruleType;
 
+    private final String INVALID_USE_MESSAGE;
+
     /**
      * Rule Constructor creates a new rule
      *
@@ -30,6 +32,7 @@ public Rule(String ruleName, String description, String imageName) {
         this.imageName = imageName;
         this.ruleName = ruleName;
         this.description = description;
+        this.INVALID_USE_MESSAGE = "Invalid use of the rule " + this.ruleName;
         loadImage();
     }
 
@@ -140,4 +143,9 @@ public ImageIcon getImageIcon() {
     public RuleType getRuleType() {
         return ruleType;
     }
+
+    public String getInvalidUseOfRuleMessage()
+    {
+        return this.INVALID_USE_MESSAGE;
+    }
 }
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
@@ -56,25 +56,25 @@ public ArrayList<Board> getCases(Board board, PuzzleElement puzzleElement) {
     public String checkRuleRaw(TreeTransition transition) {
         List<TreeTransition> childTransitions = transition.getParents().get(0).getChildren();
         if (childTransitions.size() != 2) {
-            return "This case rule must have 2 children.";
+            return super.getInvalidUseOfRuleMessage() + ": This case rule must have 2 children.";
         }
 
         TreeTransition case1 = childTransitions.get(0);
         TreeTransition case2 = childTransitions.get(1);
         if (case1.getBoard().getModifiedData().size() != 1 ||
                 case2.getBoard().getModifiedData().size() != 1) {
-            return "This case rule must have 1 modified cell for each case.";
+            return super.getInvalidUseOfRuleMessage() + ": This case rule must have 1 modified cell for each case.";
         }
 
         FillapixCell mod1 = (FillapixCell) case1.getBoard().getModifiedData().iterator().next();
         FillapixCell mod2 = (FillapixCell) case2.getBoard().getModifiedData().iterator().next();
         if (!mod1.getLocation().equals(mod2.getLocation())) {
-            return "This case rule must modify the same cell for each case.";
+            return super.getInvalidUseOfRuleMessage() + ": This case rule must modify the same cell for each case.";
         }
 
         if (!((mod1.getType() == FillapixCellType.BLACK && mod2.getType() == FillapixCellType.WHITE)
                 || (mod2.getType() == FillapixCellType.BLACK && mod1.getType() == FillapixCellType.WHITE))) {
-            return "This case rule must an empty cell and a lite cell.";
+            return super.getInvalidUseOfRuleMessage() + ": This case rule must an empty cell and a lit cell.";
         }
 
         return null;

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
@@ -24,13 +24,13 @@ public String checkRuleRawAt(TreeTransition transition, PuzzleElement puzzleElem
         FillapixCell parentCell = (FillapixCell) parentBoard.getPuzzleElement(puzzleElement);
 
         if (!(parentCell.getType() == FillapixCellType.UNKNOWN && cell.getType() == FillapixCellType.BLACK)) {
-            return "This cell must be black to be applicable with this rule.";
+            return super.getInvalidUseOfRuleMessage() + ": This cell must be black to be applicable with this rule.";
         }
 
         if (isForcedBlack(parentBoard, cell)) {
             return null;
         } else {
-            return "This cell is not forced to be black";
+            return super.getInvalidUseOfRuleMessage() + ": This cell is not forced to be black";
         }
     }
 

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
@@ -24,13 +24,13 @@ public String checkRuleRawAt(TreeTransition transition, PuzzleElement puzzleElem
         FillapixCell parentCell = (FillapixCell) parentBoard.getPuzzleElement(puzzleElement);
 
         if (!(parentCell.getType() == FillapixCellType.UNKNOWN && cell.getType() == FillapixCellType.WHITE)) {
-            return "This cell must be white to be applicable with this rule.";
+            return super.getInvalidUseOfRuleMessage() + ": This cell must be white to be applicable with this rule";
         }
 
         if (isForcedWhite(parentBoard, cell)) {
             return null;
         } else {
-            return "This cell is not forced to be white";
+            return super.getInvalidUseOfRuleMessage() + ": This cell is not forced to be white";
         }
     }
 

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
@@ -46,6 +46,6 @@ public String checkContradictionAt(Board board, PuzzleElement puzzleElement) {
                 }
             }
         }
-        return "Board does not contain a contradiction";
+        return super.getNoContradictionMessage();
     }
 }
diff --git a/src/main/java/edu/rpi/legup/puzzle/fillapix/rules/TooManyBlackCellsContradictionRule.java b/src/main/java/edu/rpi/legup/puzzle/fillapix/rules/TooManyBlackCellsContradictionRule.java
@@ -45,6 +45,6 @@ public String checkContradictionAt(Board board, PuzzleElement puzzleElement) {
                 }
             }
         }
-        return "Board does not contain a contradiction";
+        return super.getNoContradictionMessage();
     }
 }
diff --git a/src/main/java/edu/rpi/legup/puzzle/lightup/rules/BulbsInPathContradictionRule.java b/src/main/java/edu/rpi/legup/puzzle/lightup/rules/BulbsInPathContradictionRule.java
@@ -30,7 +30,7 @@ public String checkContradictionAt(Board board, PuzzleElement puzzleElement) {
         LightUpBoard lightUpBoard = (LightUpBoard) board;
         LightUpCell cell = (LightUpCell) lightUpBoard.getPuzzleElement(puzzleElement);
         if (cell.getType() != LightUpCellType.BULB) {
-            return "Does not contain a contradiction at this index";
+            return super.getNoContradictionMessage();
         }
 
         Point location = cell.getLocation();
@@ -66,6 +66,6 @@ public String checkContradictionAt(Board board, PuzzleElement puzzleElement) {
                 return null;
             }
         }
-        return "Does not contain a contradiction at this index";
+        return super.getNoContradictionMessage();
     }
 }
diff --git a/src/main/java/edu/rpi/legup/puzzle/lightup/rules/CannotLightACellContradictionRule.java b/src/main/java/edu/rpi/legup/puzzle/lightup/rules/CannotLightACellContradictionRule.java
@@ -33,7 +33,7 @@ public String checkContradictionAt(Board board, PuzzleElement puzzleElement) {
             return "This cell does not contain a contradiction";
         }*/
         if (cell.getType() != LightUpCellType.EMPTY || cell.isLite()) {
-            return "This cell does not contain a contradiction";
+            return super.getNoContradictionMessage();
         }
         Point location = cell.getLocation();
         int ver_count = 0;
@@ -74,6 +74,6 @@ public String checkContradictionAt(Board board, PuzzleElement puzzleElement) {
         if(hor_count == 0 && ver_count == 0) {
             return null;
         }
-        return "This cell does not contain a contradiction";
+        return super.getNoContradictionMessage();
     }
 }
diff --git a/src/main/java/edu/rpi/legup/puzzle/lightup/rules/EmptyCellinLightBasicRule.java b/src/main/java/edu/rpi/legup/puzzle/lightup/rules/EmptyCellinLightBasicRule.java
@@ -35,7 +35,7 @@ public String checkRuleRawAt(TreeTransition transition, PuzzleElement puzzleElem
         if (finalCell.getType() == LightUpCellType.EMPTY && initCell.getType() == LightUpCellType.UNKNOWN && initCell.isLite()) {
             return null;
         }
-        return "Cell is not forced to be empty";
+        return super.getInvalidUseOfRuleMessage() + ": Cell is not forced to be empty";
     }
 
     /**

diff --git a/src/main/java/edu/rpi/legup/puzzle/lightup/rules/EmptyCornersBasicRule.java b/src/main/java/edu/rpi/legup/puzzle/lightup/rules/EmptyCornersBasicRule.java
@@ -38,7 +38,7 @@ public String checkRuleRawAt(TreeTransition transition, PuzzleElement puzzleElem
         LightUpCell finalCell = (LightUpCell) finalBoard.getPuzzleElement(puzzleElement);
 
         if (!(cell.getType() == LightUpCellType.UNKNOWN && finalCell.getType() == LightUpCellType.EMPTY)) {
-            return "This cell must be an empty cell.";
+            return super.getInvalidUseOfRuleMessage() + ": This cell must be an empty cell";
         }
 
         Point loc = finalCell.getLocation();
@@ -60,7 +60,7 @@ public String checkRuleRawAt(TreeTransition transition, PuzzleElement puzzleElem
             numberedCells.add(lowerLeft);
         }
         if (numberedCells.isEmpty()) {
-            return "This cell must diagonal to a numbered cell.";
+            return super.getInvalidUseOfRuleMessage() + ": This cell must diagonal to a numbered cell";
         }
 
         TooFewBulbsContradictionRule tooFew = new TooFewBulbsContradictionRule();
@@ -76,7 +76,7 @@ public String checkRuleRawAt(TreeTransition transition, PuzzleElement puzzleElem
         if (createsContra) {
             return null;
         } else {
-            return "This cell is not forced to be empty.";
+            return super.getInvalidUseOfRuleMessage() + ": This cell is not forced to be empty";
         }
     }
 

diff --git a/src/main/java/edu/rpi/legup/puzzle/lightup/rules/FinishWithBulbsBasicRule.java b/src/main/java/edu/rpi/legup/puzzle/lightup/rules/FinishWithBulbsBasicRule.java
@@ -35,13 +35,13 @@ public String checkRuleRawAt(TreeTransition transition, PuzzleElement puzzleElem
         LightUpBoard finalBoard = (LightUpBoard) transition.getBoard();
         LightUpCell finalCell = (LightUpCell) finalBoard.getPuzzleElement(puzzleElement);
         if (!(initCell.getType() == LightUpCellType.UNKNOWN && finalCell.getType() == LightUpCellType.BULB)) {
-            return "Modified cells must be bulbs";
+            return super.getInvalidUseOfRuleMessage() + ": Modified cells must be bulbs";
         }
 
         Set<LightUpCell> adjCells = finalBoard.getAdj(finalCell);
         adjCells.removeIf(cell -> cell.getType() != LightUpCellType.NUMBER);
         if (adjCells.isEmpty()) {
-            return "This cell is not adjacent to a numbered cell.";
+            return super.getInvalidUseOfRuleMessage() + ": This cell is not adjacent to a numbered cell";
         }
 
         LightUpBoard emptyCase = initialBoard.copy();
@@ -52,7 +52,7 @@ public String checkRuleRawAt(TreeTransition transition, PuzzleElement puzzleElem
                 return null;
             }
         }
-        return "This cell is not forced to be a bulb.";
+        return super.getInvalidUseOfRuleMessage() + ": This cell is not forced to be a bulb";
     }
 
     private boolean isForced(LightUpBoard board, LightUpCell cell) {

diff --git a/src/main/java/edu/rpi/legup/puzzle/lightup/rules/FinishWithEmptyBasicRule.java b/src/main/java/edu/rpi/legup/puzzle/lightup/rules/FinishWithEmptyBasicRule.java
@@ -34,13 +34,13 @@ public String checkRuleRawAt(TreeTransition transition, PuzzleElement puzzleElem
         LightUpBoard finalBoard = (LightUpBoard) transition.getBoard();
         LightUpCell cell = (LightUpCell) finalBoard.getPuzzleElement(puzzleElement);
         if (cell.getType() != LightUpCellType.EMPTY) {
-            return "Modified cells must be empty";
+            return super.getInvalidUseOfRuleMessage() + ": Modified cells must be empty";
         }
 
         if (isForced(initialBoard, cell.getLocation())) {
             return null;
         }
-        return "Empty is not forced";
+        return super.getInvalidUseOfRuleMessage() + ": Empty is not forced";
     }
 
     private boolean isForced(LightUpBoard board, Point location) {

diff --git a/src/main/java/edu/rpi/legup/puzzle/lightup/rules/LightOrEmptyCaseRule.java b/src/main/java/edu/rpi/legup/puzzle/lightup/rules/LightOrEmptyCaseRule.java
@@ -68,25 +68,25 @@ public ArrayList<Board> getCases(Board board, PuzzleElement puzzleElement) {
     public String checkRuleRaw(TreeTransition transition) {
         List<TreeTransition> childTransitions = transition.getParents().get(0).getChildren();
         if (childTransitions.size() != 2) {
-            return "This case rule must have 2 children.";
+            return super.getInvalidUseOfRuleMessage() + ": This case rule must have 2 children";
         }
 
         TreeTransition case1 = childTransitions.get(0);
         TreeTransition case2 = childTransitions.get(1);
         if (case1.getBoard().getModifiedData().size() != 1 ||
                 case2.getBoard().getModifiedData().size() != 1) {
-            return "This case rule must have 1 modified cell for each case.";
+            return super.getInvalidUseOfRuleMessage() + ": This case rule must have 1 modified cell for each case";
         }
 
         LightUpCell mod1 = (LightUpCell) case1.getBoard().getModifiedData().iterator().next();
         LightUpCell mod2 = (LightUpCell) case2.getBoard().getModifiedData().iterator().next();
         if (!mod1.getLocation().equals(mod2.getLocation())) {
-            return "This case rule must modify the same cell for each case.";
+            return super.getInvalidUseOfRuleMessage() + ": This case rule must modify the same cell for each case";
         }
 
         if (!((mod1.getType() == LightUpCellType.EMPTY && mod2.getType() == LightUpCellType.BULB) ||
                 (mod2.getType() == LightUpCellType.EMPTY && mod1.getType() == LightUpCellType.BULB))) {
-            return "This case rule must an empty cell and a bulb cell.";
+            return super.getInvalidUseOfRuleMessage() + ": This case rule must an empty cell and a bulb cell";
         }
 
         return null;

diff --git a/src/main/java/edu/rpi/legup/puzzle/lightup/rules/MustLightBasicRule.java b/src/main/java/edu/rpi/legup/puzzle/lightup/rules/MustLightBasicRule.java
@@ -35,7 +35,7 @@ public String checkRuleRawAt(TreeTransition transition, PuzzleElement puzzleElem
         LightUpCell parentCell = (LightUpCell) parentBoard.getPuzzleElement(puzzleElement);
         LightUpCell finalCell = (LightUpCell) finalBoard.getPuzzleElement(puzzleElement);
         if (!(parentCell.getType() == LightUpCellType.UNKNOWN && !parentCell.isLite() && finalCell.getType() == LightUpCellType.BULB)) {
-            return "Modified cells must be bulbs";
+            return super.getInvalidUseOfRuleMessage() + ": Modified cells must be bulbs";
         }
 
         finalCell.setData(LightUpCellType.EMPTY.value);
@@ -47,7 +47,7 @@ public String checkRuleRawAt(TreeTransition transition, PuzzleElement puzzleElem
         if (isForced) {
             return null;
         } else {
-            return "This cell can be lite by another cell.";
+            return super.getInvalidUseOfRuleMessage() + ": This cell can be lit by another cell";
         }
     }
 

diff --git a/src/main/java/edu/rpi/legup/puzzle/lightup/rules/SatisfyNumberCaseRule.java b/src/main/java/edu/rpi/legup/puzzle/lightup/rules/SatisfyNumberCaseRule.java
@@ -163,7 +163,7 @@ public String checkRuleRaw(TreeTransition transition) {
 
         List<LightUpCell> spots = getPossibleSpots(transition);
         if (spots == null) {
-            return "This case rule must have a valid spot for where it was applied";
+            return super.getInvalidUseOfRuleMessage();
         }
 
         for (LightUpCell c : spots) {
@@ -212,7 +212,7 @@ public String checkRuleRaw(TreeTransition transition) {
                 }
             }
         }
-        return "This case rule is not valid";
+        return super.getInvalidUseOfRuleMessage();
     }
 
     /**

diff --git a/src/main/java/edu/rpi/legup/puzzle/lightup/rules/TooFewBulbsContradictionRule.java b/src/main/java/edu/rpi/legup/puzzle/lightup/rules/TooFewBulbsContradictionRule.java
@@ -30,17 +30,15 @@ public String checkContradictionAt(Board board, PuzzleElement puzzleElement) {
         LightUpBoard lightUpBoard = (LightUpBoard) board;
         LightUpCell cell = (LightUpCell) lightUpBoard.getPuzzleElement(puzzleElement);
         if (cell.getType() != LightUpCellType.NUMBER) {
-            return "Does not contain a contradiction";
+            return super.getNoContradictionMessage();
         }
 
-        Point location = cell.getLocation();
-
         int bulbs = lightUpBoard.getNumAdj(cell, LightUpCellType.BULB);
         int placeable = lightUpBoard.getNumPlacble(cell);
 
         if (bulbs + placeable < cell.getData()) {
             return null;
         }
-        return "Number does not contain a contradiction";
+        return super.getNoContradictionMessage();
     }
 }
diff --git a/src/main/java/edu/rpi/legup/puzzle/lightup/rules/TooManyBulbsContradictionRule.java b/src/main/java/edu/rpi/legup/puzzle/lightup/rules/TooManyBulbsContradictionRule.java
@@ -30,7 +30,7 @@ public String checkContradictionAt(Board board, PuzzleElement puzzleElement) {
         LightUpBoard lightUpBoard = (LightUpBoard) board;
         LightUpCell cell = (LightUpCell) lightUpBoard.getPuzzleElement(puzzleElement);
         if (cell.getType() != LightUpCellType.NUMBER) {
-            return "Does not contain a contradiction";
+            return super.getNoContradictionMessage();
         }
 
         Point location = cell.getLocation();
@@ -57,6 +57,6 @@ public String checkContradictionAt(Board board, PuzzleElement puzzleElement) {
         if (bulbs > cell.getData()) {
             return null;
         }
-        return "Number does not contain a contradiction";
+        return super.getNoContradictionMessage();
     }
 }
diff --git a/src/main/java/edu/rpi/legup/puzzle/nurikabe/rules/BlackBetweenRegionsBasicRule.java b/src/main/java/edu/rpi/legup/puzzle/nurikabe/rules/BlackBetweenRegionsBasicRule.java
@@ -45,7 +45,7 @@ public String checkRuleRawAt(TreeTransition transition, PuzzleElement puzzleElem
         NurikabeCell cell = (NurikabeCell) destBoardState.getPuzzleElement(puzzleElement);
 
         if (cell.getType() != NurikabeType.BLACK) {
-            return "Only black cells are allowed for this rule!";
+            return super.getInvalidUseOfRuleMessage() + ": Only black cells are allowed for this rule!";
         }
 
         int x = cell.getLocation().x;
-Original file line number
+Diff line change
@@ Expand Up @@
                     }
                 }
             }
-            return "Board does not contain a contradiction";
+            return super.getNoContradictionMessage();
         }
     }