Add Comments Support

Author: gmitch215

src/main/java/xyz/calcugames/levelz/Keywords.java

@@ -25,4 +25,13 @@ public interface Keywords {
      */
     String DEFAULT_COORDINATE_3D = "[0, 0, 0]";
 
+    /**
+     * The beginning of a comment.
+     */
+    char COMMENT_CHAR = '#';
+
+    /**
+     * The beginning of a comment.
+     */
+    String COMMENT = "#";
 }

src/main/java/xyz/calcugames/levelz/parser/InternalParser.java

@@ -256,15 +256,19 @@ static Level parse(String[] file, Random seed) {
 
         Set<LevelObject> blocks = new HashSet<>();
         for (String line : split[1]) {
+            if (line.startsWith(Keywords.COMMENT)) continue;
             if (line.equalsIgnoreCase(Keywords.END)) break;
 
+            int ci = line.indexOf(Keywords.COMMENT_CHAR);
+            String line0 = line.substring(0, ci == -1 ? line.length() : ci).trim();
+
             if (is2D) {
-                Map<Block, Coordinate2D[]> blocks2D = read2DLine(line, seed);
+                Map<Block, Coordinate2D[]> blocks2D = read2DLine(line0, seed);
                 blocks2D.forEach((k, v) -> {
                     for (Coordinate2D c : v) blocks.add(new LevelObject(k, c));
                 });
             } else {
-                Map<Block, Coordinate3D[]> blocks3D = read3DLine(line, seed);
+                Map<Block, Coordinate3D[]> blocks3D = read3DLine(line0, seed);
                 blocks3D.forEach((k, v) -> {
                     for (Coordinate3D c : v) blocks.add(new LevelObject(k, c));
                 });

src/test/java/xyz/calcugames/levelz/parser/TestLevelParser.java

@@ -37,6 +37,19 @@ public void testParse() {
         Level3D l3 = (Level3D) p3.parse();
 
         Assertions.assertEquals(l3.getSpawn(), new Coordinate3D(0, 0, 0));
+
+        InputStream f4 = TestLevelParser.class.getResourceAsStream("/examples/2D/volcano/4.lvlz");
+        LevelParser p4 = builder.input(f4).build();
+        Level2D l4 = (Level2D) p4.parse();
+
+        Assertions.assertEquals(l4.getScroll(), Scroll.NONE);
+        Assertions.assertEquals(l4.getSpawn(), new Coordinate2D(5, 1));
+
+        InputStream f5 = TestLevelParser.class.getResourceAsStream("/examples/3D/grasslands/3.lvlz");
+        LevelParser p5 = builder.input(f5).build();
+        Level3D l5 = (Level3D) p5.parse();
+
+        Assertions.assertEquals(l5.getSpawn(), new Coordinate3D(0, 10, 0));
     }
 
 }