Fix dir handling

Author: SpaiR

src/main/java/io/github/spair/byond/dmi/SpriteDir.java

@@ -2,42 +2,42 @@
 
 public enum SpriteDir {
 
-    SOUTH(2, "S"),
     NORTH(1, "N"),
+    SOUTH(2, "S"),
     EAST(4, "E"),
     WEST(8, "W"),
 
-    SOUTHEAST(6, "SE"),
-    SOUTHWEST(10, "SW"),
     NORTHEAST(5, "NE"),
-    NORTHWEST(9, "NW");
+    NORTHWEST(9, "NW"),
+    SOUTHEAST(6, "SE"),
+    SOUTHWEST(10, "SW");
 
     /**
      * <p>BYOND representation of dir as int value.
      * <ul>
-     *     <li>SOUTH - 2</li>
-     *     <li>NORTH - 1</li>
-     *     <li>EAST - 4</li>
-     *     <li>WEST - 8</li>
-     *     <li>SOUTHEAST - 6</li>
-     *     <li>SOUTHWEST - 10</li>
-     *     <li>NORTHEAST - 5</li>
-     *     <li>NORTHWEST - 9</li>
+     * <li>NORTH - 1</li>
+     * <li>SOUTH - 2</li>
+     * <li>EAST - 4</li>
+     * <li>WEST - 8</li>
+     * <li>NORTHEAST - 5</li>
+     * <li>NORTHWEST - 9</li>
+     * <li>SOUTHEAST - 6</li>
+     * <li>SOUTHWEST - 10</li>
      * </ul>
      */
     public final int dirValue;
 
     /**
      * <p>Shorted string representation of constant values.
      * <ul>
-     *     <li>SOUTH - S</li>
-     *     <li>NORTH - N</li>
-     *     <li>EAST - E</li>
-     *     <li>WEST - W</li>
-     *     <li>SOUTHEAST - SE</li>
-     *     <li>SOUTHWEST - SW</li>
-     *     <li>NORTHEAST - NE</li>
-     *     <li>NORTHWEST - NW</li>
+     * <li>NORTH - N</li>
+     * <li>SOUTH - S</li>
+     * <li>EAST - E</li>
+     * <li>WEST - W</li>
+     * <li>SOUTHEAST - SE</li>
+     * <li>SOUTHWEST - SW</li>
+     * <li>NORTHEAST - NE</li>
+     * <li>NORTHWEST - NW</li>
      * </ul>
      */
     public final String shortName;
@@ -48,53 +48,48 @@ public enum SpriteDir {
     }
 
     /**
-     * Returns {@link SpriteDir} equivalent to BYOND dir value. If method got value different from the list below,
+     * Returns {@link SpriteDir} equivalent to BYOND dir value. If method got value lesser then 0 or bigger then 10,
      * {@link IllegalArgumentException} will be thrown.
      * <ul>
-     *     <li>0,1,3,7 - NORTH</li>
-     *     <li>2 - SOUTH</li>
-     *     <li>4 - EAST</li>
-     *     <li>8 - WEST</li>
-     *     <li>5 - NORTHEAST</li>
-     *     <li>6 - SOUTHEAST</li>
-     *     <li>9 - NORTHWEST</li>
-     *     <li>10 - SOUTHWEST</li>
+     * <li>1 - NORTH</li>
+     * <li>2 - SOUTH</li>
+     * <li>4 - EAST</li>
+     * <li>8 - WEST</li>
+     * <li>5 - NORTHEAST</li>
+     * <li>6 - SOUTHEAST</li>
+     * <li>9 - NORTHWEST</li>
+     * <li>10 - SOUTHWEST</li>
      * </ul>
      *
      * @param dirValue BYOND representation of dir
      * @return {@link SpriteDir} equivalent of BYOND dir value
      */
     @SuppressWarnings("checkstyle:MagicNumber")
     public static SpriteDir valueOfByondDir(final int dirValue) {
+        if (dirValue < 0 || dirValue > 10) {
+            throw new IllegalArgumentException("Illegal value of BYOND dir. Dir value: " + dirValue);
+        }
+
+        // Values below sorted in order in which dirs appears in `dmi` file.
         switch (dirValue) {
-            case 0: case 1: case 3: case 7:
-                return NORTH;
             case 2:
                 return SOUTH;
+            case 1:
+                return NORTH;
             case 4:
                 return EAST;
             case 8:
                 return WEST;
             case 5:
                 return NORTHEAST;
-            case 6:
-                return SOUTHEAST;
             case 9:
                 return NORTHWEST;
+            case 6:
+                return SOUTHEAST;
             case 10:
                 return SOUTHWEST;
             default:
-                throw new IllegalArgumentException("Illegal value of BYOND dir. Dir value: " + dirValue);
+                return SOUTH;
         }
     }
-
-    /**
-     * Same as {@link #valueOfByondDir(int)}, but accept value as string instead of int.
-     *
-     * @param dirValue BYOND representation of dir
-     * @return {@link SpriteDir} equivalent of BYOND dir value
-     */
-    public static SpriteDir valueOfByondDir(final String dirValue) {
-        return valueOfByondDir(Integer.parseInt(dirValue));
-    }
 }

src/main/java/io/github/spair/byond/dmi/slurper/SpriteDirHelper.java

@@ -5,7 +5,7 @@
 @SuppressWarnings("checkstyle:MagicNumber")
 final class SpriteDirHelper {
 
-    // During DMI slurping all dirs are passed in `for(i = 0; i <= n; i++)` cycle.
+    // During DMI slurping all dirs images parsed one by one.
     // This method determines the order in which dirs are placed in `.dmi` file.
     static SpriteDir dirByIndex(final int dirCount) {
         switch (dirCount) {

src/test/java/io/github/spair/byond/dmi/SpriteDirTest.java

@@ -8,11 +8,13 @@ public class SpriteDirTest {
 
     @Test
     public void testValueOfByondDir() {
-        assertEquals(SpriteDir.NORTH, SpriteDir.valueOfByondDir(0));
         assertEquals(SpriteDir.NORTH, SpriteDir.valueOfByondDir(1));
-        assertEquals(SpriteDir.NORTH, SpriteDir.valueOfByondDir(3));
-        assertEquals(SpriteDir.NORTH, SpriteDir.valueOfByondDir(7));
+
+        assertEquals(SpriteDir.SOUTH, SpriteDir.valueOfByondDir(0));
         assertEquals(SpriteDir.SOUTH, SpriteDir.valueOfByondDir(2));
+        assertEquals(SpriteDir.SOUTH, SpriteDir.valueOfByondDir(3));
+        assertEquals(SpriteDir.SOUTH, SpriteDir.valueOfByondDir(7));
+
         assertEquals(SpriteDir.EAST, SpriteDir.valueOfByondDir(4));
         assertEquals(SpriteDir.WEST, SpriteDir.valueOfByondDir(8));
 
@@ -27,15 +29,4 @@ public void testValueOfByondDirWithIllegalValue() {
         //noinspection ResultOfMethodCallIgnored
         SpriteDir.valueOfByondDir(-1);
     }
-
-    @Test
-    public void testValueOfByondDirWithString() {
-        assertEquals(SpriteDir.NORTH, SpriteDir.valueOfByondDir("1"));
-        assertEquals(SpriteDir.SOUTHWEST, SpriteDir.valueOfByondDir("10"));
-    }
-
-    @Test(expected = IllegalArgumentException.class)
-    public void testValueOfByondDirWithIllegalString() {
-        SpriteDir.valueOfByondDir("85");
-    }
 }