refactor some of the supporting classes to change the API

pauldambra · pauldambra · commit bdfcc5be259e · 2017-07-09T13:40:24.000+01:00
diff --git a/src/main/java/com/dambra/paul/moduluschecker/Account/BankAccount.java b/src/main/java/com/dambra/paul/moduluschecker/Account/BankAccount.java
@@ -13,18 +13,21 @@ public class BankAccount {
     public final String sortCode;
     public final String accountNumber;
 
-    public BankAccount(String sortCode, String accountNumber) {
-        String[] corrected = NonStandardAccounts.corrections(sortCode, accountNumber);
-
-        this.sortCode = corrected[0];
-        this.accountNumber = corrected[1];
+    private BankAccount(String sortCode, String accountNumber) {
+        this.sortCode = sortCode;
+        this.accountNumber = accountNumber;
     }
 
     public BankAccount(BankAccount bankAccount) {
         this.sortCode = bankAccount.sortCode;
         this.accountNumber = bankAccount.accountNumber;
     }
 
+    public static BankAccount Of(String sortCode, String accountNumber) {
+        String[] corrected = NonStandardAccounts.corrections(sortCode, accountNumber);
+        return new BankAccount(corrected[0], corrected[1]);
+    }
+
     public Stream<Integer> allDigits() {
         return Stream.concat(
                 As.integerStream(sortCode),
@@ -46,84 +49,9 @@ public String toString() {
     public BankAccount zeroiseUToB() {
         if (getNumberAt(G) == 9) {
             String account = Strings.padStart(accountNumber.substring(2), 8, '0');
-            return new BankAccount("000000", account);
-        }
-        return new BankAccount(sortCode, accountNumber);
-    }
-
-    private static class NonStandardAccounts {
-        public static String[] corrections(String sortCode, String accountNumber) {
-
-            accountNumber = CorrectForNatWest(sortCode, accountNumber);
-            accountNumber = CorrectForCoop(sortCode, accountNumber);
-            accountNumber = correctForShortAccountNumber(accountNumber);
-
-            return CorrectForSantander(sortCode, accountNumber);
-        }
-
-        /**
-         * pad left with zeros until 8 in length
-         */
-        private static String correctForShortAccountNumber(String accountNumber) {
-            return Strings.padStart(accountNumber, 8, '0');
-        }
-
-        /**
-         * Replace the last digit of the sorting code with
-         * the first digit of the account number, then use
-         * the last eight digits of the account number only.
-         */
-        private static String[] CorrectForSantander(String sortCode, String accountNumber) {
-            if (accountNumber.length()!=9) {
-                return new String[] {sortCode, accountNumber};
-            }
-
-            return new String[]{
-                    sortCode.substring(0, 5) + accountNumber.substring(0, 1),
-                    accountNumber.substring(1, 9)
-            };
-        }
-
-        /**
-         * use the first eight digits only
-         */
-        private static String CorrectForCoop(String sortCode, String accountNumber) {
-            return SortCode.IsCooperativeBankSortCode(sortCode)
-                    ? accountNumber.substring(0, 8)
-                    : accountNumber;
-        }
-
-        /**
-         * NatWest have ten digit account numbers
-         *
-         * Use the last eight digits only. If there is a hyphen
-         * in the account number between the second and
-         * third numbers this should be ignored.
-         */
-        private static String CorrectForNatWest(String sortCode, String accountNumber) {
-            if (!SortCode.IsNatWestSortCode(sortCode)) {
-                return accountNumber;
-            }
-
-            accountNumber = accountNumber.replaceAll("[\\D]", "");
-            return accountNumber.substring(accountNumber.length() - 8);
+            return Of("000000", account);
         }
+        return Of(sortCode, accountNumber);
     }
 
-    // I didn't log where I got this data... is it correct?
-    // todo allow external hookup of ISCD? Can't find a free version
-    private static class SortCode {
-        static boolean IsCooperativeBankSortCode(String sortCode) {
-            return sortCode.startsWith("08") || sortCode.startsWith("839");
-        }
-
-        static boolean IsNatWestSortCode(String sortCode) {
-            return sortCode.startsWith("600")
-                    || sortCode.startsWith("606")
-                    || sortCode.startsWith("601")
-                    || sortCode.startsWith("609")
-                    || sortCode.startsWith("830")
-                    || sortCode.startsWith("602");
-        }
-    }
 }
diff --git a/src/main/java/com/dambra/paul/moduluschecker/Account/NonStandardAccounts.java b/src/main/java/com/dambra/paul/moduluschecker/Account/NonStandardAccounts.java
@@ -0,0 +1,62 @@
+package com.dambra.paul.moduluschecker.Account;
+
+import com.google.common.base.Strings;
+
+class NonStandardAccounts {
+    static String[] corrections(String sortCode, String accountNumber) {
+
+        accountNumber = CorrectForNatWest(sortCode, accountNumber);
+        accountNumber = CorrectForCoop(sortCode, accountNumber);
+        accountNumber = correctForShortAccountNumber(accountNumber);
+
+        return CorrectForSantander(sortCode, accountNumber);
+    }
+
+    /**
+     * pad left with zeros until 8 in length
+     */
+    private static String correctForShortAccountNumber(String accountNumber) {
+        return Strings.padStart(accountNumber, 8, '0');
+    }
+
+    /**
+     * Replace the last digit of the sorting code with
+     * the first digit of the account number, then use
+     * the last eight digits of the account number only.
+     */
+    private static String[] CorrectForSantander(String sortCode, String accountNumber) {
+        if (accountNumber.length()!=9) {
+            return new String[] {sortCode, accountNumber};
+        }
+
+        return new String[]{
+                sortCode.substring(0, 5) + accountNumber.substring(0, 1),
+                accountNumber.substring(1, 9)
+        };
+    }
+
+    /**
+     * use the first eight digits only
+     */
+    private static String CorrectForCoop(String sortCode, String accountNumber) {
+        return SortCode.IsCooperativeBankSortCode(sortCode)
+                ? accountNumber.substring(0, 8)
+                : accountNumber;
+    }
+
+    /**
+     * NatWest have ten digit account numbers
+     *
+     * Use the last eight digits only. If there is a hyphen
+     * in the account number between the second and
+     * third numbers this should be ignored.
+     */
+    private static String CorrectForNatWest(String sortCode, String accountNumber) {
+        if (!SortCode.IsNatWestSortCode(sortCode)) {
+            return accountNumber;
+        }
+
+        accountNumber = accountNumber.replaceAll("[\\D]", "");
+        return accountNumber.substring(accountNumber.length() - 8);
+    }
+}
diff --git a/src/main/java/com/dambra/paul/moduluschecker/Account/SortCode.java b/src/main/java/com/dambra/paul/moduluschecker/Account/SortCode.java
@@ -0,0 +1,18 @@
+package com.dambra.paul.moduluschecker.Account;
+
+// I didn't log where I got this data... is it correct?
+// todo allow external hookup of ISCD? Can't find a free version
+class SortCode {
+    static boolean IsCooperativeBankSortCode(String sortCode) {
+        return sortCode.startsWith("08") || sortCode.startsWith("839");
+    }
+
+    static boolean IsNatWestSortCode(String sortCode) {
+        return sortCode.startsWith("600")
+                || sortCode.startsWith("606")
+                || sortCode.startsWith("601")
+                || sortCode.startsWith("609")
+                || sortCode.startsWith("830")
+                || sortCode.startsWith("602");
+    }
+}
diff --git a/src/main/java/com/dambra/paul/moduluschecker/ModulusCheckParams.java b/src/main/java/com/dambra/paul/moduluschecker/ModulusCheckParams.java
@@ -23,6 +23,10 @@ public ModulusCheckParams(
         this.modulusResult = modulusResult;
     }
 
+    static ModulusCheckParams startingParams(BankAccount account) {
+        return new ModulusCheckParams(account, Optional.empty(), Optional.empty(), Optional.empty());
+    }
+
     public ModulusCheckParams withAccount(BankAccount bankAccount) {
         return new ModulusCheckParams(
                 bankAccount,
diff --git a/src/main/java/com/dambra/paul/moduluschecker/ModulusChecker.java b/src/main/java/com/dambra/paul/moduluschecker/ModulusChecker.java
@@ -5,7 +5,6 @@
 import com.dambra.paul.moduluschecker.valacdosFile.ModulusWeightRows;
 
 import java.io.IOException;
-import java.util.Optional;
 
 public class ModulusChecker {
     private SortCodeSubstitution sortCodeSubstitution = SortCodeSubstitution.fromFile("file/scsubtab.txt");
@@ -16,15 +15,9 @@ public ModulusChecker() throws IOException {
     }
 
     public Boolean checkBankAccount(String sortCode, String accountNumber) {
-
-        BankAccount account = new BankAccount(sortCode, accountNumber);
-
-        ModulusCheckParams startingParams = new ModulusCheckParams(account, Optional.empty(), Optional.empty(), Optional.empty());
-
+        BankAccount account = BankAccount.Of(sortCode, accountNumber);
         ModulusChainCheck chain = makeModulusChainCheck();
-
-        ModulusResult modulusResults = chain.check(startingParams);
-
+        ModulusResult modulusResults = chain.check(ModulusCheckParams.startingParams(account));
         return modulusResults.processResults();
     }
 
diff --git a/src/main/java/com/dambra/paul/moduluschecker/SortCodeSubstitution.java b/src/main/java/com/dambra/paul/moduluschecker/SortCodeSubstitution.java
@@ -10,7 +10,6 @@
 import java.io.IOException;
 import java.net.URL;
 import java.util.Map;
-import java.util.Optional;
 import java.util.regex.Pattern;
 import java.util.stream.Collectors;
 
@@ -25,13 +24,13 @@ public SortCodeSubstitution(ImmutableMap<String, String> sortCodeSubstitutionTab
         this.sortCodeSubstitutionTable = sortCodeSubstitutionTable;
     }
 
-    public SortCodeSubstitution(Map<String, String> sortCodeSubstitutionTable) {
+    private SortCodeSubstitution(Map<String, String> sortCodeSubstitutionTable) {
         this.sortCodeSubstitutionTable = ImmutableMap.copyOf(sortCodeSubstitutionTable);
     }
 
     public BankAccount Apply(BankAccount bankAccount) {
         return sortCodeSubstitutionTable.containsKey(bankAccount.sortCode)
-                ? new BankAccount(sortCodeSubstitutionTable.get(bankAccount.sortCode), bankAccount.accountNumber)
+                ? BankAccount.Of(sortCodeSubstitutionTable.get(bankAccount.sortCode), bankAccount.accountNumber)
                 : new BankAccount(bankAccount);
     }
 
diff --git a/src/main/java/com/dambra/paul/moduluschecker/chain/FirstModulusCheckRouter.java b/src/main/java/com/dambra/paul/moduluschecker/chain/FirstModulusCheckRouter.java
@@ -38,12 +38,12 @@ public ModulusResult check(ModulusCheckParams params) {
         }
 
         if (rowSelector.apply(params).isException(8)) {
-            BankAccount account = new BankAccount("090126", params.account.accountNumber);
+            BankAccount account = BankAccount.Of("090126", params.account.accountNumber);
             params = params.withAccount(account);
         }
 
         if (rowSelector.apply(params).isException(10)) {
-            //For the exception 10 check, if ab = 09 or ab = 99 and g = 9, zeroise weighting positions u-b.
+            //Of the exception 10 check, if ab = 09 or ab = 99 and g = 9, zeroise weighting positions u-b.
             int a = params.account.getNumberAt(BankAccount.A);
             int b = params.account.getNumberAt(BankAccount.B);
             int g = params.account.getNumberAt(BankAccount.G);
diff --git a/src/main/java/com/dambra/paul/moduluschecker/chain/SecondModulusCheckRouter.java b/src/main/java/com/dambra/paul/moduluschecker/chain/SecondModulusCheckRouter.java
@@ -41,7 +41,7 @@ public ModulusResult check(ModulusCheckParams params) {
         }
 
         if (rowSelector.apply(params).isException(8)) {
-            BankAccount account = new BankAccount("090126", params.account.accountNumber);
+            BankAccount account = BankAccount.Of("090126", params.account.accountNumber);
             params = params.withAccount(account);
         }
 
diff --git a/src/main/java/com/dambra/paul/moduluschecker/chain/checks/ExceptionFourteenModulusElevenCheck.java b/src/main/java/com/dambra/paul/moduluschecker/chain/checks/ExceptionFourteenModulusElevenCheck.java
@@ -31,7 +31,7 @@ public Boolean check(ModulusCheckParams params) {
         }
 
         final String newAccountNumber = "0" + params.account.accountNumber.substring(0, 7);
-        final BankAccount correctedAccount = new BankAccount(params.account.sortCode, newAccountNumber);
+        final BankAccount correctedAccount = BankAccount.Of(params.account.sortCode, newAccountNumber);
 
         int total = ModulusTotal.calculate(
                 correctedAccount,
diff --git a/src/main/java/com/dambra/paul/moduluschecker/chain/checks/LloydsAlternateModulusElevenCheck.java b/src/main/java/com/dambra/paul/moduluschecker/chain/checks/LloydsAlternateModulusElevenCheck.java
@@ -17,7 +17,7 @@ public Boolean check(ModulusCheckParams params, Function<ModulusCheckParams, Wei
             return false;
         }
 
-        BankAccount account = new BankAccount(BankAccount.LLOYDS_EURO_SORT_CODE, params.account.accountNumber);
+        BankAccount account = BankAccount.Of(BankAccount.LLOYDS_EURO_SORT_CODE, params.account.accountNumber);
 
         int total = ModulusTotal.calculate(account, selectedRow.getWeights());
         return total % 11 == 0;
diff --git a/src/main/java/com/dambra/paul/moduluschecker/valacdosFile/ModulusWeightRows.java b/src/main/java/com/dambra/paul/moduluschecker/valacdosFile/ModulusWeightRows.java
@@ -31,7 +31,7 @@ public ModulusCheckParams FindFor(BankAccount account) {
         for (ValacdosRow vr : this.valacdosRows) {
             boolean stillSeekingFirstMatch = first == null;
 
-            if (!vr.getSortCodeRange().contains(account.sortCode)) {
+            if (!vr.sortCodeRange.contains(account.sortCode)) {
                 if (stillSeekingFirstMatch) {
                     continue;
                 } else {
@@ -40,11 +40,11 @@ public ModulusCheckParams FindFor(BankAccount account) {
             }
 
             if (stillSeekingFirstMatch) {
-                first = vr.getWeightRow();
+                first = vr.weightRow;
                 continue;
             }
 
-            second = vr.getWeightRow();
+            second = vr.weightRow;
         }
 
         return new ModulusCheckParams(
diff --git a/src/main/java/com/dambra/paul/moduluschecker/valacdosFile/SortCodeRange.java b/src/main/java/com/dambra/paul/moduluschecker/valacdosFile/SortCodeRange.java
@@ -10,8 +10,6 @@ public final class SortCodeRange {
     private static final Splitter splitter = Splitter.on(CharMatcher.whitespace())
             .omitEmptyStrings();
 
-    private static final int LOWEST_SORT_CODE_INDEX = 0;
-    private static final int HIGHEST_SORT_CODE_INDEX = 1;
     private final int start;
     private final int end;
 
@@ -33,8 +31,8 @@ static Optional<SortCodeRange> parse(String input) {
 
         return Optional.of(
                 new SortCodeRange(
-                        parts.get(LOWEST_SORT_CODE_INDEX),
-                        parts.get(HIGHEST_SORT_CODE_INDEX)));
+                        parts.get(WeightRow.LOWEST_SORT_CODE_INDEX),
+                        parts.get(WeightRow.HIGHEST_SORT_CODE_INDEX)));
     }
 
     public boolean contains(String sortCode) {
diff --git a/src/main/java/com/dambra/paul/moduluschecker/valacdosFile/ValacdosRow.java b/src/main/java/com/dambra/paul/moduluschecker/valacdosFile/ValacdosRow.java
@@ -1,19 +1,11 @@
 package com.dambra.paul.moduluschecker.valacdosFile;
 
 public final class ValacdosRow {
-    private final SortCodeRange sortCodeRange;
-    private final WeightRow weightRow;
+    final SortCodeRange sortCodeRange;
+    final WeightRow weightRow;
 
     public ValacdosRow(SortCodeRange sortCodeRange, WeightRow weightRow) {
         this.sortCodeRange = sortCodeRange;
         this.weightRow = weightRow;
     }
-
-    SortCodeRange getSortCodeRange() {
-        return sortCodeRange;
-    }
-
-    WeightRow getWeightRow() {
-        return weightRow;
-    }
 }
diff --git a/src/main/java/com/dambra/paul/moduluschecker/valacdosFile/WeightRow.java b/src/main/java/com/dambra/paul/moduluschecker/valacdosFile/WeightRow.java
@@ -14,14 +14,15 @@
 public final class WeightRow {
     private static final Splitter splitter = Splitter.on(CharMatcher.whitespace())
                                               .omitEmptyStrings();
+    static final int LOWEST_SORT_CODE_INDEX = 0;
+    static final int HIGHEST_SORT_CODE_INDEX = 1;
+    private static final int MODULUS_INDEX = 2;
+    private static final int EXCEPTION_INDEX = 17;
 
     public final ModulusAlgorithm modulusAlgorithm;
     public final Optional<Integer> exception;
     private final ImmutableList<Integer> weights;
 
-    private static final int MODULUS_INDEX = 2;
-    private static final int EXCEPTION_INDEX = 17;
-
     public WeightRow(ModulusAlgorithm modulusAlgorithm, List<Integer> weights, Optional<Integer> exception) {
         this.modulusAlgorithm = modulusAlgorithm;
         this.exception = exception;
diff --git a/src/test/java/AccountTests.java b/src/test/java/AccountTests.java
diff --git a/src/test/java/DoubleAlternateTests.java b/src/test/java/DoubleAlternateTests.java
diff --git a/src/test/java/LoadModulusWeightRowTests.java b/src/test/java/LoadModulusWeightRowTests.java
diff --git a/src/test/java/ModulusElevenTests.java b/src/test/java/ModulusElevenTests.java
diff --git a/src/test/java/ModulusTenTests.java b/src/test/java/ModulusTenTests.java
diff --git a/src/test/java/NonStandardAccountNumberTests.java b/src/test/java/NonStandardAccountNumberTests.java
diff --git a/src/test/java/SortCodeSubstitutionTests.java b/src/test/java/SortCodeSubstitutionTests.java

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,6 @@`
`10`	`10`	`import java.io.IOException;`
`11`	`11`	`import java.net.URL;`
`12`	`12`	`import java.util.Map;`
`13`		`-import java.util.Optional;`
`14`	`13`	`import java.util.regex.Pattern;`
`15`	`14`	`import java.util.stream.Collectors;`
`16`	`15`
`@@ -25,13 +24,13 @@ public SortCodeSubstitution(ImmutableMap<String, String> sortCodeSubstitutionTab`
`25`	`24`	`this.sortCodeSubstitutionTable = sortCodeSubstitutionTable;`
`26`	`25`	`}`
`27`	`26`
`28`		`- public SortCodeSubstitution(Map<String, String> sortCodeSubstitutionTable) {`
	`27`	`+ private SortCodeSubstitution(Map<String, String> sortCodeSubstitutionTable) {`
`29`	`28`	`this.sortCodeSubstitutionTable = ImmutableMap.copyOf(sortCodeSubstitutionTable);`
`30`	`29`	`}`
`31`	`30`
`32`	`31`	`public BankAccount Apply(BankAccount bankAccount) {`
`33`	`32`	`return sortCodeSubstitutionTable.containsKey(bankAccount.sortCode)`
`34`		`- ? new BankAccount(sortCodeSubstitutionTable.get(bankAccount.sortCode), bankAccount.accountNumber)`
	`33`	`+ ? BankAccount.Of(sortCodeSubstitutionTable.get(bankAccount.sortCode), bankAccount.accountNumber)`
`35`	`34`	`: new BankAccount(bankAccount);`
`36`	`35`	`}`
`37`	`36`
Original file line number	Diff line number	Diff line change
`@@ -38,12 +38,12 @@ public ModulusResult check(ModulusCheckParams params) {`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`if (rowSelector.apply(params).isException(8)) {`
`41`		`- BankAccount account = new BankAccount("090126", params.account.accountNumber);`
	`41`	`+ BankAccount account = BankAccount.Of("090126", params.account.accountNumber);`
`42`	`42`	`params = params.withAccount(account);`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`if (rowSelector.apply(params).isException(10)) {`
`46`		`- //For the exception 10 check, if ab = 09 or ab = 99 and g = 9, zeroise weighting positions u-b.`
	`46`	`+ //Of the exception 10 check, if ab = 09 or ab = 99 and g = 9, zeroise weighting positions u-b.`
`47`	`47`	`int a = params.account.getNumberAt(BankAccount.A);`
`48`	`48`	`int b = params.account.getNumberAt(BankAccount.B);`
`49`	`49`	`int g = params.account.getNumberAt(BankAccount.G);`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public ModulusResult check(ModulusCheckParams params) {`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`if (rowSelector.apply(params).isException(8)) {`
`44`		`- BankAccount account = new BankAccount("090126", params.account.accountNumber);`
	`44`	`+ BankAccount account = BankAccount.Of("090126", params.account.accountNumber);`
`45`	`45`	`params = params.withAccount(account);`
`46`	`46`	`}`
`47`	`47`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public Boolean check(ModulusCheckParams params) {`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`final String newAccountNumber = "0" + params.account.accountNumber.substring(0, 7);`
`34`		`- final BankAccount correctedAccount = new BankAccount(params.account.sortCode, newAccountNumber);`
	`34`	`+ final BankAccount correctedAccount = BankAccount.Of(params.account.sortCode, newAccountNumber);`
`35`	`35`
`36`	`36`	`int total = ModulusTotal.calculate(`
`37`	`37`	`correctedAccount,`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ public Boolean check(ModulusCheckParams params, Function<ModulusCheckParams, Wei`
`17`	`17`	`return false;`
`18`	`18`	`}`
`19`	`19`
`20`		`- BankAccount account = new BankAccount(BankAccount.LLOYDS_EURO_SORT_CODE, params.account.accountNumber);`
	`20`	`+ BankAccount account = BankAccount.Of(BankAccount.LLOYDS_EURO_SORT_CODE, params.account.accountNumber);`
`21`	`21`
`22`	`22`	`int total = ModulusTotal.calculate(account, selectedRow.getWeights());`
`23`	`23`	`return total % 11 == 0;`