Added gradle; added tests

Author: pgeadas

.gitattributes

@@ -0,0 +1,9 @@
+#
+# https://help.github.com/articles/dealing-with-line-endings/
+#
+# Linux start script should use lf
+/gradlew        text eol=lf
+
+# These are Windows script files and should use crlf
+*.bat           text eol=crlf
+

.gitignore

@@ -1,3 +1,8 @@
 *.idea
 out/**
-*.iml
+*.iml
+# Ignore Gradle project-specific cache directory
+.gradle
+
+# Ignore Gradle build output directory
+build

README.md

@@ -7,3 +7,33 @@ The implementation includes 3 files:
   - AStar.java : Main algorithm class.
   - Node.java : Class for the nodes used by the algorithm.
   - AStarTest.java : Class with a main method and a simple test for the algorithm implementation
+
+## Search Area
+
+              0   1   2   3   4   5   6
+         0    -   -   -   -   -   -   -
+         1    -   -   -   B   -   -   -
+         2    -   I   -   B   -   F   -
+         3    -   -   -   B   -   -   -
+         4    -   -   -   -   -   -   -
+         5    -   -   -   -   -   -   -
+
+## Search Path with diagonals
+
+              0   1   2   3   4   5   6
+         0    -   -   -   *   -   -   -
+         1    -   -   *   B   *   -   -
+         2    -   I*  -   B   -  *F   -
+         3    -   -   -   B   -   -   -
+         4    -   -   -   -   -   -   -
+         5    -   -   -   -   -   -   -
+
+## Search Path without diagonals
+
+              0   1   2   3   4   5   6
+         0    -   -   *   *   *   -   -
+         1    -   -   *   B   *   -   -
+         2    -   I*  *   B   *  *F   -
+         3    -   -   -   B   -   -   -
+         4    -   -   -   -   -   -   -
+         5    -   -   -   -   -   -   -

app/build.gradle.kts

@@ -0,0 +1,37 @@
+/*
+ * This file was generated by the Gradle 'init' task.
+ *
+ * This generated file contains a sample Java application project to get you started.
+ * For more details take a look at the 'Building Java & JVM projects' chapter in the Gradle
+ * User Manual available at https://docs.gradle.org/7.6/userguide/building_java_projects.html
+ */
+
+plugins {
+    // Apply the application plugin to add support for building a CLI application in Java.
+    application
+}
+
+repositories {
+    // Use Maven Central for resolving dependencies.
+    mavenCentral()
+}
+
+dependencies {
+    // Use JUnit Jupiter for testing.
+    testImplementation("org.junit.jupiter:junit-jupiter:5.9.1")
+
+    // This dependency is used by the application.
+    implementation("com.google.guava:guava:31.1-jre")
+
+    testImplementation("org.hamcrest:hamcrest:2.2")
+}
+
+application {
+    // Define the main class for the application.
+    mainClass.set("com.ai.astar.App")
+}
+
+tasks.named<Test>("test") {
+    // Use JUnit Platform for unit tests.
+    useJUnitPlatform()
+}

src/com/ai/astar/AStar.java renamed to app/src/main/java/com/ai/astar/domain/AStar.java

@@ -1,6 +1,5 @@
-package com.ai.astar;
+package com.ai.astar.domain;
 
-import com.ai.astar.domain.Node;
 import com.ai.astar.domain.searchstrategy.DiagonalMapChecker;
 import com.ai.astar.domain.searchstrategy.HorizontalVerticalChecker;
 import com.ai.astar.domain.searchstrategy.MapChecker;
@@ -19,7 +18,15 @@ public class AStar {
     private final MapChecker diagonalsChecker;
     private final MapChecker hvChecker;
 
-    public AStar(int rows, int cols, Node initialNode, Node finalNode, int[][] blocksArray, boolean searchDiagonals) {
+    public AStar(
+            int rows,
+            int cols,
+            Node initialNode,
+            Node finalNode,
+            int[][] blocksArray,
+            boolean searchDiagonals,
+            int diagonalCost,
+            int hvCost) {
         this.initialNode = initialNode;
         this.finalNode = finalNode;
         this.searchArea = new Node[rows][cols];
@@ -28,27 +35,31 @@ public AStar(int rows, int cols, Node initialNode, Node finalNode, int[][] block
         initBlocks(blocksArray);
         this.closedSet = new HashSet<>();
         if (searchDiagonals) {
-            this.diagonalsChecker = new DiagonalMapChecker(searchArea, openList, closedSet, DEFAULT_DIAGONAL_COST);
+            this.diagonalsChecker = new DiagonalMapChecker(searchArea, openList, closedSet, diagonalCost);
         } else {
             this.diagonalsChecker = new NoOpChecker(null, null, null);
         }
-        this.hvChecker = new HorizontalVerticalChecker(searchArea, openList, closedSet, DEFAULT_HV_COST);
+        this.hvChecker = new HorizontalVerticalChecker(searchArea, openList, closedSet, hvCost);
+    }
+
+    public AStar(int rows, int cols, Node initialNode, Node finalNode, int[][] blocksArray, boolean searchDiagonals) {
+        this(rows, cols, initialNode, finalNode, blocksArray, searchDiagonals, DEFAULT_DIAGONAL_COST, DEFAULT_HV_COST);
     }
 
     private void initNodes() {
         for (int i = 0; i < searchArea.length; i++) {
             for (int j = 0; j < searchArea[0].length; j++) {
-                Node node = new Node(i, j);
+                Node node = Node.of(i, j);
                 node.calculateHeuristic(finalNode);
                 this.searchArea[i][j] = node;
             }
         }
     }
 
     private void initBlocks(int[][] blocksArray) {
-        for (int[] ints : blocksArray) {
-            int row = ints[0];
-            int col = ints[1];
+        for (int[] block : blocksArray) {
+            int row = block[0];
+            int col = block[1];
             if (row < 0 || row >= searchArea.length) {
                 continue;
             }

src/com/ai/astar/domain/Node.java renamed to app/src/main/java/com/ai/astar/domain/Node.java

@@ -10,12 +10,16 @@ public class Node {
     private boolean isBlocked;
     private Node parent;
 
-    public Node(int row, int col) {
+    private Node(int row, int col) {
         super();
         this.row = row;
         this.col = col;
     }
 
+    public static Node of(int row, int col) {
+        return new Node(row, col);
+    }
+
     public void calculateHeuristic(Node finalNode) {
         this.heuristic = Math.abs(finalNode.row() - row) + Math.abs(finalNode.col() - col);
     }

src/com/ai/astar/domain/searchstrategy/DiagonalMapChecker.java renamed to app/src/main/java/com/ai/astar/domain/searchstrategy/DiagonalMapChecker.java

@@ -0,0 +1,49 @@
+package com.ai.astar;
+
+import com.ai.astar.domain.AStar;
+import com.ai.astar.domain.Node;
+import org.junit.jupiter.api.Test;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+class AStarTest {
+
+    private final Node initialNode = Node.of(2, 1);
+    private final Node finalNode = Node.of(2, 5);
+    private final int rows = 6;
+    private final int cols = 7;
+    private final int[][] blocksArray = new int[][]{{1, 3}, {2, 3}, {3, 3}};
+
+    @Test
+    void shouldFindShortestPath_whenSearchingDiagonals() {
+        AStar aStar = new AStar(rows, cols, initialNode, finalNode, blocksArray, true);
+        List<Node> expected = new ArrayList<>();
+        expected.add(Node.of(2, 1));
+        expected.add(Node.of(1, 2));
+        expected.add(Node.of(0, 3));
+        expected.add(Node.of(1, 4));
+        expected.add(Node.of(2, 5));
+        List<Node> path = aStar.findPath();
+        assertEquals(expected, path);
+    }
+
+    @Test
+    void shouldFindShortestPath_whenSearchingHorizontalVertical() {
+        AStar aStar = new AStar(rows, cols, initialNode, finalNode, blocksArray, false);
+        List<Node> expected = new ArrayList<>();
+        expected.add(Node.of(2, 1));
+        expected.add(Node.of(2, 2));
+        expected.add(Node.of(1, 2));
+        expected.add(Node.of(0, 2));
+        expected.add(Node.of(0, 3));
+        expected.add(Node.of(0, 4));
+        expected.add(Node.of(1, 4));
+        expected.add(Node.of(2, 4));
+        expected.add(Node.of(2, 5));
+        List<Node> path = aStar.findPath();
+        assertEquals(expected, path);
+    }
+}

src/com/ai/astar/domain/searchstrategy/HorizontalVerticalChecker.java renamed to app/src/main/java/com/ai/astar/domain/searchstrategy/HorizontalVerticalChecker.java

@@ -0,0 +1,6 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip
+networkTimeout=10000
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists