tidy up the package structure and simplify the second check gate

pauldambra · pauldambra · commit 730bab786756 · 2017-07-09T22:44:10.000+01:00
diff --git a/src/main/java/com/dambra/paul/moduluschecker/ModulusCheckingChain.java b/src/main/java/com/dambra/paul/moduluschecker/ModulusCheckingChain.java
@@ -1,6 +1,10 @@
 package com.dambra.paul.moduluschecker;
 
 import com.dambra.paul.moduluschecker.chain.*;
+import com.dambra.paul.moduluschecker.chain.gates.*;
+import com.dambra.paul.moduluschecker.chain.transformers.ExceptionEightAccountTransformer;
+import com.dambra.paul.moduluschecker.chain.transformers.ExceptionSevenAccountTransformer;
+import com.dambra.paul.moduluschecker.chain.transformers.ExceptionTenAccountTransformer;
 import com.dambra.paul.moduluschecker.valacdosFile.ModulusWeightRows;
 
 final class ModulusCheckingChain {
@@ -57,6 +61,7 @@ static ModulusChainLink create(ModulusWeightRows weightRows, SortCodeSubstitutio
         final ExceptionFourteenGate exceptionFourteenGate = new ExceptionFourteenGate(exceptionTwoAndNineGate);
         final ExceptionTwoGate exceptionTwoGate = new ExceptionTwoGate(exceptionFourteenGate);
         final SecondCheckRequiredGate secondCheckRequiredGate = new SecondCheckRequiredGate(exceptionTwoGate);
+
         final FirstModulusCheckRouter firstModulusCheckRouter = new FirstModulusCheckRouter(
                 sortCodeSubstitution,
                 secondCheckRequiredGate
diff --git a/src/main/java/com/dambra/paul/moduluschecker/chain/FirstModulusCheckRouter.java b/src/main/java/com/dambra/paul/moduluschecker/chain/FirstModulusCheckRouter.java
@@ -6,6 +6,7 @@
 import com.dambra.paul.moduluschecker.chain.checks.ExceptionFiveModulusElevenCheck;
 import com.dambra.paul.moduluschecker.chain.checks.ModulusElevenCheck;
 import com.dambra.paul.moduluschecker.chain.checks.ModulusTenCheck;
+import com.dambra.paul.moduluschecker.chain.gates.SecondCheckRequiredGate;
 import com.dambra.paul.moduluschecker.valacdosFile.WeightRow;
 
 import java.util.function.Function;
diff --git a/src/main/java/com/dambra/paul/moduluschecker/chain/ModulusResult.java b/src/main/java/com/dambra/paul/moduluschecker/chain/ModulusResult.java
@@ -8,9 +8,9 @@
 public class ModulusResult {
 
     /** the default is for a check to pass **/
-    static final ModulusResult PASSES = new ModulusResult(Optional.of(true), Optional.of(true));
+    public static final ModulusResult PASSES = new ModulusResult(Optional.of(true), Optional.of(true));
 
-    static final List<Integer> exceptionsThatRequireSecondCheck = ImmutableList.of(2, 5, 9, 10, 11, 12, 13, 14);
+    public static final List<Integer> exceptionsThatRequireSecondCheck = ImmutableList.of(2, 5, 9, 10, 11, 12, 13, 14);
 
     public final Optional<Boolean> firstCheckResult;
     public final Optional<Boolean> secondCheckResult;
diff --git a/src/main/java/com/dambra/paul/moduluschecker/chain/SecondCheckRequiredGate.java b/src/main/java/com/dambra/paul/moduluschecker/chain/SecondCheckRequiredGate.java
diff --git a/src/main/java/com/dambra/paul/moduluschecker/chain/SecondModulusCheckRouter.java b/src/main/java/com/dambra/paul/moduluschecker/chain/SecondModulusCheckRouter.java
@@ -1,6 +1,5 @@
 package com.dambra.paul.moduluschecker.chain;
 
-import com.dambra.paul.moduluschecker.Account.BankAccount;
 import com.dambra.paul.moduluschecker.ModulusCheckParams;
 import com.dambra.paul.moduluschecker.SortCodeSubstitution;
 import com.dambra.paul.moduluschecker.chain.checks.*;
@@ -25,13 +24,15 @@ public ModulusResult check(ModulusCheckParams params) {
 
         switch (rowSelector.apply(params).modulusAlgorithm) {
             case DOUBLE_ALTERNATE:
-                result = runStandardOrExceptionFiveCheck(params, rowSelector);
+                result = params.secondWeightRow.get().isException(5)
+                        ? new ExceptionFiveDoubleAlternateCheck(sortCodeSubstitution).check(params, rowSelector)
+                        : new DoubleAlternateCheck().check(params, rowSelector);
                 break;
             case MOD10:
                 result = new ModulusTenCheck().check(params, rowSelector);
                 break;
             case MOD11:
-                result = runStandardOrExceptionFourteenCheck(params, rowSelector);
+                result = new ModulusElevenCheck().check(params, rowSelector);
                 break;
         }
 
@@ -41,14 +42,4 @@ public ModulusResult check(ModulusCheckParams params) {
         );
     }
 
-    private Boolean runStandardOrExceptionFiveCheck(ModulusCheckParams params, Function<ModulusCheckParams, WeightRow> rowSelector) {
-        if (params.secondWeightRow.get().isException(5)) {
-            return new ExceptionFiveDoubleAlternateCheck(sortCodeSubstitution).check(params, rowSelector);
-        }
-        return new DoubleAlternateCheck().check(params, rowSelector);
-    }
-
-    private Boolean runStandardOrExceptionFourteenCheck(ModulusCheckParams params, Function<ModulusCheckParams, WeightRow> rowSelector) {
-        return new ModulusElevenCheck().check(params, rowSelector);
-    }
 }
diff --git a/src/main/java/com/dambra/paul/moduluschecker/chain/gates/AtLeastOneWeightRowGate.java b/src/main/java/com/dambra/paul/moduluschecker/chain/gates/AtLeastOneWeightRowGate.java
@@ -1,6 +1,8 @@
-package com.dambra.paul.moduluschecker.chain;
+package com.dambra.paul.moduluschecker.chain.gates;
 
 import com.dambra.paul.moduluschecker.ModulusCheckParams;
+import com.dambra.paul.moduluschecker.chain.ModulusChainLink;
+import com.dambra.paul.moduluschecker.chain.ModulusResult;
 import com.dambra.paul.moduluschecker.valacdosFile.ModulusWeightRows;
 
 import java.util.Optional;
diff --git a/src/main/java/com/dambra/paul/moduluschecker/chain/gates/ExceptionFourteenGate.java b/src/main/java/com/dambra/paul/moduluschecker/chain/gates/ExceptionFourteenGate.java
@@ -1,6 +1,8 @@
-package com.dambra.paul.moduluschecker.chain;
+package com.dambra.paul.moduluschecker.chain.gates;
 
 import com.dambra.paul.moduluschecker.ModulusCheckParams;
+import com.dambra.paul.moduluschecker.chain.ModulusChainLink;
+import com.dambra.paul.moduluschecker.chain.ModulusResult;
 import com.dambra.paul.moduluschecker.chain.checks.ExceptionFourteenModulusElevenCheck;
 import com.dambra.paul.moduluschecker.valacdosFile.WeightRow;
 
diff --git a/src/main/java/com/dambra/paul/moduluschecker/chain/gates/ExceptionSixGate.java b/src/main/java/com/dambra/paul/moduluschecker/chain/gates/ExceptionSixGate.java
@@ -1,7 +1,10 @@
-package com.dambra.paul.moduluschecker.chain;
+package com.dambra.paul.moduluschecker.chain.gates;
 
 import com.dambra.paul.moduluschecker.Account.BankAccount;
 import com.dambra.paul.moduluschecker.ModulusCheckParams;
+import com.dambra.paul.moduluschecker.chain.ModulusChainLink;
+import com.dambra.paul.moduluschecker.chain.ModulusResult;
+import com.dambra.paul.moduluschecker.chain.transformers.ExceptionSevenAccountTransformer;
 
 import java.util.Arrays;
 import java.util.Optional;
diff --git a/src/main/java/com/dambra/paul/moduluschecker/chain/gates/ExceptionThreeGate.java b/src/main/java/com/dambra/paul/moduluschecker/chain/gates/ExceptionThreeGate.java
@@ -1,7 +1,10 @@
-package com.dambra.paul.moduluschecker.chain;
+package com.dambra.paul.moduluschecker.chain.gates;
 
 import com.dambra.paul.moduluschecker.Account.BankAccount;
 import com.dambra.paul.moduluschecker.ModulusCheckParams;
+import com.dambra.paul.moduluschecker.chain.ModulusChainLink;
+import com.dambra.paul.moduluschecker.chain.ModulusResult;
+import com.dambra.paul.moduluschecker.chain.SecondModulusCheckRouter;
 
 public final class ExceptionThreeGate implements ModulusChainLink {
 
diff --git a/src/main/java/com/dambra/paul/moduluschecker/chain/gates/ExceptionTwoAndNineGate.java b/src/main/java/com/dambra/paul/moduluschecker/chain/gates/ExceptionTwoAndNineGate.java
@@ -1,6 +1,9 @@
-package com.dambra.paul.moduluschecker.chain;
+package com.dambra.paul.moduluschecker.chain.gates;
 
 import com.dambra.paul.moduluschecker.ModulusCheckParams;
+import com.dambra.paul.moduluschecker.chain.ModulusChainLink;
+import com.dambra.paul.moduluschecker.chain.ModulusResult;
+import com.dambra.paul.moduluschecker.chain.transformers.ExceptionSevenAccountTransformer;
 import com.dambra.paul.moduluschecker.valacdosFile.WeightRow;
 
 public final class ExceptionTwoAndNineGate implements ModulusChainLink {
diff --git a/src/main/java/com/dambra/paul/moduluschecker/chain/gates/ExceptionTwoGate.java b/src/main/java/com/dambra/paul/moduluschecker/chain/gates/ExceptionTwoGate.java
@@ -1,6 +1,8 @@
-package com.dambra.paul.moduluschecker.chain;
+package com.dambra.paul.moduluschecker.chain.gates;
 
 import com.dambra.paul.moduluschecker.ModulusCheckParams;
+import com.dambra.paul.moduluschecker.chain.ModulusChainLink;
+import com.dambra.paul.moduluschecker.chain.ModulusResult;
 import com.dambra.paul.moduluschecker.valacdosFile.WeightRow;
 
 public class ExceptionTwoGate implements ModulusChainLink {
diff --git a/src/main/java/com/dambra/paul/moduluschecker/chain/gates/SecondCheckRequiredGate.java b/src/main/java/com/dambra/paul/moduluschecker/chain/gates/SecondCheckRequiredGate.java
@@ -0,0 +1,42 @@
+package com.dambra.paul.moduluschecker.chain.gates;
+
+import com.dambra.paul.moduluschecker.ModulusCheckParams;
+import com.dambra.paul.moduluschecker.chain.ModulusChainLink;
+import com.dambra.paul.moduluschecker.chain.ModulusResult;
+import com.dambra.paul.moduluschecker.valacdosFile.WeightRow;
+
+import java.util.Optional;
+
+public class SecondCheckRequiredGate implements ModulusChainLink {
+
+    private final ExceptionTwoGate next;
+
+    public SecondCheckRequiredGate(ExceptionTwoGate next) {
+        this.next = next;
+    }
+
+    @Override
+    public ModulusResult check(ModulusCheckParams params) {
+
+        if (exceptionRequiresSecondCheck(params)) {
+            return next.check(params);
+        }
+
+        if (params.secondWeightRow.isPresent()) {
+            return next.check(params);
+        }
+
+        return params.modulusResult.orElse(ModulusResult.PASSES);
+    }
+
+    private boolean exceptionRequiresSecondCheck(ModulusCheckParams params) {
+        return rowExceptionRequiresSecondCheck(params.firstWeightRow)
+                || rowExceptionRequiresSecondCheck(params.secondWeightRow);
+    }
+
+    private boolean rowExceptionRequiresSecondCheck(Optional<WeightRow> row) {
+        return row.isPresent()
+                && ModulusResult.exceptionsThatRequireSecondCheck.contains(
+                row.get().exception.orElse(-1));
+    }
+}
diff --git a/src/main/java/com/dambra/paul/moduluschecker/chain/transformers/ExceptionEightAccountTransformer.java b/src/main/java/com/dambra/paul/moduluschecker/chain/transformers/ExceptionEightAccountTransformer.java
@@ -1,7 +1,9 @@
-package com.dambra.paul.moduluschecker.chain;
+package com.dambra.paul.moduluschecker.chain.transformers;
 
 import com.dambra.paul.moduluschecker.Account.BankAccount;
 import com.dambra.paul.moduluschecker.ModulusCheckParams;
+import com.dambra.paul.moduluschecker.chain.ModulusChainLink;
+import com.dambra.paul.moduluschecker.chain.ModulusResult;
 import com.dambra.paul.moduluschecker.valacdosFile.WeightRow;
 
 import java.util.function.Function;
diff --git a/src/main/java/com/dambra/paul/moduluschecker/chain/transformers/ExceptionSevenAccountTransformer.java b/src/main/java/com/dambra/paul/moduluschecker/chain/transformers/ExceptionSevenAccountTransformer.java
@@ -1,7 +1,9 @@
-package com.dambra.paul.moduluschecker.chain;
+package com.dambra.paul.moduluschecker.chain.transformers;
 
 import com.dambra.paul.moduluschecker.Account.BankAccount;
 import com.dambra.paul.moduluschecker.ModulusCheckParams;
+import com.dambra.paul.moduluschecker.chain.ModulusChainLink;
+import com.dambra.paul.moduluschecker.chain.ModulusResult;
 import com.dambra.paul.moduluschecker.valacdosFile.WeightRow;
 
 import java.util.function.Function;
diff --git a/src/main/java/com/dambra/paul/moduluschecker/chain/transformers/ExceptionTenAccountTransformer.java b/src/main/java/com/dambra/paul/moduluschecker/chain/transformers/ExceptionTenAccountTransformer.java
@@ -1,7 +1,10 @@
-package com.dambra.paul.moduluschecker.chain;
+package com.dambra.paul.moduluschecker.chain.transformers;
 
 import com.dambra.paul.moduluschecker.Account.BankAccount;
 import com.dambra.paul.moduluschecker.ModulusCheckParams;
+import com.dambra.paul.moduluschecker.chain.FirstModulusCheckRouter;
+import com.dambra.paul.moduluschecker.chain.ModulusChainLink;
+import com.dambra.paul.moduluschecker.chain.ModulusResult;
 
 public final class ExceptionTenAccountTransformer implements ModulusChainLink {
 
