Deprecated forgotten precision methods; improved unit tests

Author: rijnb

src/main/java/com/mapcode/Mapcode.java

@@ -30,15 +30,23 @@
  * is not checked for validity, other than its syntax.
  */
 public final class Mapcode {
+
     @Nonnull
     private final String mapcodePrecision0;
+
     @Nonnull
     private final String mapcodePrecision1;
+
     @Nonnull
     private final String mapcodePrecision2;
+
     @Nonnull
     private final Territory territory;
 
+    public static final double PRECISION_0_MAX_DELTA_METERS = 10.0;
+    public static final double PRECISION_1_MAX_DELTA_METERS = 2.0;
+    public static final double PRECISION_2_MAX_DELTA_METERS = 0.4;
+
     public Mapcode(
             @Nonnull final String mapcode,
             @Nonnull final Territory territory) throws IllegalArgumentException {

src/test/java/com/mapcode/EncodeDecodeTest.java

@@ -37,10 +37,6 @@ public class EncodeDecodeTest {
     private static final int NUMBER_OF_POINTS = 5000;
     private static final int LOG_LINE_EVERY = 100;
 
-    private static final double PRECISION_0_METERS = 10.0;
-    private static final double PRECISION_1_METERS = 2.0;
-    private static final double PRECISION_2_METERS = 0.4;
-
     @Test
     public void encodeDecodeTestFixedSeed() throws Exception {
         LOG.info("encodeDecodeTestFixedSeed");
@@ -91,15 +87,17 @@ private static void doEncodeDecode(final long seed) throws UnknownMapcodeExcepti
                     }
 
                     // Check if the territory matches.
+                    assertEquals(territory, result.getTerritory());
+
+                    // Check max distance.
                     final String mapcodePrecision0 = result.getMapcodePrecision(0);
                     final String mapcodePrecision1 = result.getMapcodePrecision(1);
                     final String mapcodePrecision2 = result.getMapcodePrecision(2);
-                    assertEquals(territory, result.getTerritory());
 
-                    // Check max distance.
                     final Point decodeLocationPrecision0 = MapcodeCodec.decode(mapcodePrecision0, territory);
                     final Point decodeLocationPrecision1 = MapcodeCodec.decode(mapcodePrecision1, territory);
                     final Point decodeLocationPrecision2 = MapcodeCodec.decode(mapcodePrecision2, territory);
+
                     final double distancePrecision0Meters = Point.distanceInMeters(encode, decodeLocationPrecision0);
                     final double distancePrecision1Meters = Point.distanceInMeters(encode, decodeLocationPrecision1);
                     final double distancePrecision2Meters = Point.distanceInMeters(encode, decodeLocationPrecision2);
@@ -108,12 +106,12 @@ private static void doEncodeDecode(final long seed) throws UnknownMapcodeExcepti
                     maxDistancePrecision1Meters = Math.max(maxDistancePrecision1Meters, distancePrecision1Meters);
                     maxDistancePrecision2Meters = Math.max(maxDistancePrecision2Meters, distancePrecision2Meters);
 
-                    assertTrue("distancePrecision0Meters=" + distancePrecision0Meters + " >= " + PRECISION_0_METERS,
-                            distancePrecision0Meters < PRECISION_0_METERS);
-                    assertTrue("distancePrecision1Meters=" + distancePrecision1Meters + " >= " + PRECISION_1_METERS,
-                            distancePrecision1Meters < PRECISION_1_METERS);
-                    assertTrue("distancePrecision2Meters=" + distancePrecision2Meters + " >= " + PRECISION_2_METERS,
-                            distancePrecision2Meters < PRECISION_2_METERS);
+                    assertTrue("distancePrecision0Meters=" + distancePrecision0Meters + " >= " + Mapcode.PRECISION_0_MAX_DELTA_METERS,
+                            distancePrecision0Meters < Mapcode.PRECISION_0_MAX_DELTA_METERS);
+                    assertTrue("distancePrecision1Meters=" + distancePrecision1Meters + " >= " + Mapcode.PRECISION_1_MAX_DELTA_METERS,
+                            distancePrecision1Meters < Mapcode.PRECISION_1_MAX_DELTA_METERS);
+                    assertTrue("distancePrecision2Meters=" + distancePrecision2Meters + " >= " + Mapcode.PRECISION_2_MAX_DELTA_METERS,
+                            distancePrecision2Meters < Mapcode.PRECISION_2_MAX_DELTA_METERS);
 
                     if (showLogLine) {
                         LOG.info("encodeDecodeTest: #{}/{}, result={}, mapcode={}, territory={} --> " +

src/test/java/com/mapcode/ReferenceFileTest.java

@@ -55,7 +55,6 @@ public class ReferenceFileTest {
     private static final String BOUNDARIES_REFERENCE_FILE_HP = "/boundaries_hp.txt";
 
     private static final int LOG_LINE_EVERY = 25000;
-    private static final double METERS_DELTA = 10.0;
 
     @SuppressWarnings("JUnitTestMethodWithNoAssertions")
     @Test
@@ -147,17 +146,6 @@ private static void checkFile(@Nonnull final String baseFileName) throws Excepti
                     ++error;
                 }
 
-                /**
-                 * Check encodeToShortest.
-                 */
-                final Mapcode resultShortest = MapcodeCodec.encodeToShortest(reference.point.getLatDeg(), reference.point.getLonDeg());
-                final Mapcode expectedShortest = results.get(0);
-                if (!resultShortest.asLocal().equals(expectedShortest.asLocal())) {
-                    LOG.error("checkFile: encodeToShortest fails, expected={}, got={} for reference",
-                            expectedShortest, resultShortest, reference);
-                    ++error;
-                }
-
                 /**
                  * Check encodeToInternational.
                  */
@@ -169,7 +157,6 @@ private static void checkFile(@Nonnull final String baseFileName) throws Excepti
                     ++error;
                 }
 
-
                 // Check the size and order of the results with a single assertion.
                 //
                 assertEquals("Encode #" + i + " incorrect number of results:" +
@@ -241,7 +228,7 @@ private static void checkFile(@Nonnull final String baseFileName) throws Excepti
                         final Point result = MapcodeCodec.decode(mapcodeRec.mapcode, mapcodeRec.territory);
                         final double distanceMeters = Point.distanceInMeters(reference.point, result);
                         maxdelta = Math.max(maxdelta, distanceMeters);
-                        if (distanceMeters > METERS_DELTA) {
+                        if (distanceMeters > Mapcode.PRECISION_0_MAX_DELTA_METERS) {
                             LOG.error(
                                     "Mapcode {} {} was generated for point {}, but decodes to point {} which is {} meters from the original point.",
                                     mapcodeRec.territory, mapcodeRec.mapcode, reference.point, result, distanceMeters);