Merge pull request #28 from rabestro/develop

Added sample application

Author: Jegors Čemisovs

.gitignore

@@ -32,4 +32,6 @@ out/
 ##############################
 ## OS X
 ##############################
-.DS_Store
+.DS_Store
+/algorithm/gradle.properties
+/sample/gradle.properties

.idea/gradle.xml

@@ -0,0 +1,62 @@
+plugins {
+    id 'groovy'
+    id 'java-library'
+    id 'maven-publish'
+}
+
+group 'lv.id.jc'
+version '1.1'
+
+repositories {
+    mavenCentral()
+}
+
+// Configures the publishing
+publishing {
+    repositories {
+        // The target repository
+        maven {
+            // Choose whatever name you want
+            name = "Algorithms"
+            // The url of the repository, where the artifacts will be published
+            url = "https://maven.pkg.github.com/rabestro/algorithms"
+            credentials {
+                // The credentials (described in the next section)
+                username = project.findProperty("gpr.user")
+                password = project.findProperty("gpr.key")
+            }
+        }
+    }
+    publications {
+        gpr(MavenPublication) {
+            from(components.java)
+            // Fixes the error with dynamic versions when using Spring Boot
+            versionMapping {
+                usage('java-api') {
+                    fromResolutionOf('runtimeClasspath')
+                }
+                usage('java-runtime') {
+                    fromResolutionResult()
+                }
+            }
+        }
+    }
+}
+
+dependencies {
+    // Spock Framework
+    testImplementation 'org.spockframework:spock-core:2.0-groovy-3.0'
+    testImplementation 'org.codehaus.groovy:groovy-all:3.0.9'
+
+    // Spock Reports
+    testRuntimeClasspath( "com.athaydes:spock-reports:2.1.1-groovy-3.0" ) {
+        transitive = false // this avoids affecting your version of Groovy/Spock
+    }
+    // Required for spock-reports
+    testImplementation 'org.slf4j:slf4j-api:1.7.32'
+    testRuntimeClasspath 'org.slf4j:slf4j-simple:1.7.32'
+}
+
+test {
+    useJUnitPlatform()
+}

.idea/jarRepositories.xml

@@ -1,5 +1,6 @@
 package lv.id.jc.algorithm.graph;
 
+import java.util.ArrayDeque;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.LinkedList;
@@ -11,18 +12,18 @@
 
 /**
  * Algorithm for finding the shortest paths between nodes in a graph.
- *
+ * <p>
  * The algorithm doesn't take into account the distance between nodes.
  *
- * @author Jegors Čemisovs
  * @param <T> the type of vertex
+ * @author Jegors Čemisovs
  * @since 1.0
  */
 public class BreadthFirstSearch<T> implements SearchAlgorithm<T> {
 
     @Override
     public List<T> findPath(Graph<T> graph, T source, T target) {
-        var queue = new LinkedList<T>();
+        var queue = new ArrayDeque<T>();
         var visited = new HashSet<T>();
         var previous = new HashMap<T, T>();
         queue.add(source);

algorithm/build.gradle

@@ -1,5 +1,6 @@
 package lv.id.jc.algorithm.graph;
 
+import java.util.ArrayDeque;
 import java.util.HashMap;
 import java.util.LinkedList;
 import java.util.List;
@@ -12,15 +13,15 @@
  * <p>
  * The algorithm uses information about edge's distance to find the fastest path.
  *
- * @author Jegors Čemisovs
  * @param <T> the type of vertex
+ * @author Jegors Čemisovs
  * @since 1.0
  */
 public class DijkstrasAlgorithm<T> implements SearchAlgorithm<T> {
 
     @Override
     public List<T> findPath(Graph<T> graph, T source, T target) {
-        var queue = new LinkedList<T>();
+        var queue = new ArrayDeque<T>();
         var distances = new HashMap<T, Double>();
         var previous = new HashMap<T, T>();
         queue.add(source);

src/main/java/lv/id/jc/algorithm/graph/BreadthFirstSearch.java renamed to algorithm/src/main/java/lv/id/jc/algorithm/graph/BreadthFirstSearch.java

@@ -1,4 +1,4 @@
-package graph
+package lv.id.jc.graph
 
 import lv.id.jc.algorithm.graph.BreadthFirstSearch
 import lv.id.jc.algorithm.graph.Graph

src/main/java/lv/id/jc/algorithm/graph/DijkstrasAlgorithm.java renamed to algorithm/src/main/java/lv/id/jc/algorithm/graph/DijkstrasAlgorithm.java

@@ -1,4 +1,4 @@
-package graph
+package lv.id.jc.graph
 
 import lv.id.jc.algorithm.graph.DijkstrasAlgorithm
 import lv.id.jc.algorithm.graph.Graph

src/main/java/lv/id/jc/algorithm/graph/Graph.java renamed to algorithm/src/main/java/lv/id/jc/algorithm/graph/Graph.java

@@ -1,4 +1,4 @@
-package graph
+package lv.id.jc.graph
 
 import lv.id.jc.algorithm.graph.Graph
 import spock.lang.Narrative

src/main/java/lv/id/jc/algorithm/graph/SearchAlgorithm.java renamed to algorithm/src/main/java/lv/id/jc/algorithm/graph/SearchAlgorithm.java

@@ -1,4 +1,4 @@
-package graph
+package lv.id.jc.graph
 
 import lv.id.jc.algorithm.graph.BreadthFirstSearch
 import lv.id.jc.algorithm.graph.DijkstrasAlgorithm

src/main/java/lv/id/jc/algorithm/graph/package-info.java renamed to algorithm/src/main/java/lv/id/jc/algorithm/graph/package-info.java

@@ -0,0 +1,13 @@
+plugins {
+    id 'application'
+}
+
+dependencies {
+    implementation project(':algorithm')
+}
+
+application {
+    mainModule = 'lv.id.jc.application'
+    mainClass = 'lv.id.jc.application.GraphApp'
+    applicationDefaultJvmArgs = ['-Dgreeting.language=en']
+}

src/main/java/module-info.java renamed to algorithm/src/main/java/module-info.java

@@ -0,0 +1,46 @@
+package lv.id.jc.application;
+
+import lv.id.jc.algorithm.graph.BreadthFirstSearch;
+import lv.id.jc.algorithm.graph.DijkstrasAlgorithm;
+import lv.id.jc.algorithm.graph.Graph;
+import lv.id.jc.algorithm.graph.SearchAlgorithm;
+
+import java.util.Map;
+
+public class GraphApp {
+    private static final Graph<Character> graph = Graph.of(Map.of(
+            'A', Map.of('B', 5, 'H', 2),
+            'B', Map.of('A', 5, 'C', 7),
+            'C', Map.of('B', 7, 'D', 3, 'G', 4),
+            'D', Map.of('C', 20, 'E', 4),
+            'E', Map.of('F', 5),
+            'F', Map.of('G', 6),
+            'G', Map.of('C', 4),
+            'H', Map.of('G', 3)
+    ));
+    private static final SearchAlgorithm<Character> fastest = new DijkstrasAlgorithm<>();
+    private static final SearchAlgorithm<Character> shortest = new BreadthFirstSearch<>();
+
+    public static void main(String[] args) {
+        printRoute('D', 'C');
+        printRoute('A', 'G');
+        printRoute('D', 'H');
+    }
+
+    @SuppressWarnings("squid:S106")
+    private static void printRoute(Character source, Character target) {
+        var routeOne = shortest.findPath(graph, source, target);
+        var routeTwo = fastest.findPath(graph, source, target);
+        var message = """
+                        
+                Find the path from %s to %s
+                    - the shortest take %.0f min and the path is %s
+                    - the fastest take %.0f min and the path is %s"""
+                .formatted(
+                        source, target,
+                        graph.getDistance(routeOne), routeOne,
+                        graph.getDistance(routeTwo), routeTwo);
+
+        System.out.println(message);
+    }
+}

src/test/groovy/graph/BreadthFirstSearchSpec.groovy renamed to algorithm/src/test/groovy/lv/id/jc/graph/BreadthFirstSearchSpec.groovy

@@ -0,0 +1,4 @@
+module lv.id.jc.application {
+    requires lv.id.jc.algorithm.graph;
+    exports lv.id.jc.application;
+}

src/test/groovy/graph/DijkstrasAlgorithmSpec.groovy renamed to algorithm/src/test/groovy/lv/id/jc/graph/DijkstrasAlgorithmSpec.groovy

@@ -1 +1,2 @@
-rootProject.name = 'search-algorithm'
+rootProject.name = 'graphs-algorithms'
+include 'algorithm', 'application'