Merge pull request #521 from Ayowel/feature/create-services-interfaces

Feature/create services interfaces

Author: rahmanusta

pom.xml

@@ -21,6 +21,8 @@
         <openjfx.version>16</openjfx.version>
         <ikonli.version>12.2.0</ikonli.version>
         <jaxb.version>2.3.2</jaxb.version>
+        <jacoco.version>0.8.7</jacoco.version>
+        <logunit.version>1.1.0</logunit.version>
     </properties>
 
     <organization>
@@ -242,6 +244,42 @@
             <version>${openjfx.version}</version>
             <scope>provided</scope>
         </dependency>
+        <!-- Add test dependencies -->
+        <dependency>
+            <groupId>io.github.netmikey.logunit</groupId>
+            <artifactId>logunit-core</artifactId>
+            <version>${logunit.version}</version>
+            <scope>test</scope>
+         </dependency>
+        <dependency>
+            <groupId>io.github.netmikey.logunit</groupId>
+            <artifactId>logunit-logback</artifactId>
+            <version>${logunit.version}</version>
+            <scope>test</scope>
+         </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-api</artifactId>
+            <version>${junit-jupiter.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-engine</artifactId>
+            <version>${junit-jupiter.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+           <groupId>org.springframework.boot</groupId>
+           <artifactId>spring-boot-starter-test</artifactId>
+           <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.testfx</groupId>
+            <artifactId>testfx-junit5</artifactId>
+            <version>4.0.16-alpha</version>
+            <scope>test</scope>
+        </dependency>
 
     </dependencies>
 
@@ -430,9 +468,42 @@
                     </execution>
                 </executions>
             </plugin>
+               <!-- Test reporting -->
+            <plugin>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>${maven-surefire-plugin.version}</version>
+            </plugin>
+            <plugin>
+                <groupId>org.jacoco</groupId>
+                <artifactId>jacoco-maven-plugin</artifactId>
+                <version>${jacoco.version}</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>prepare-agent</goal>
+                        </goals>
+                    </execution>
+                    <execution>
+                        <id>report</id>
+                        <phase>test</phase>
+                        <goals>
+                            <goal>report</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
 
+    <reporting>
+        <plugins>
+            <plugin>
+                <groupId>org.jacoco</groupId>
+                <artifactId>jacoco-maven-plugin</artifactId>
+                <version>${jacoco.version}</version>
+            </plugin>
+        </plugins>
+    </reporting>
     <repositories>
         <repository>
             <id>central</id>

src/main/java/com/kodedu/controller/ApplicationController.java

@@ -84,6 +84,7 @@
 import org.springframework.web.socket.handler.TextWebSocketHandler;
 import org.springframework.web.util.UriComponentsBuilder;
 
+import javax.annotation.PostConstruct;
 import javax.imageio.ImageIO;
 import javax.imageio.ImageReader;
 import javax.imageio.stream.ImageInputStream;
@@ -303,6 +304,9 @@ public class ApplicationController extends TextWebSocketHandler implements Initi
     @Autowired
     private SpellcheckConfigBean spellcheckConfigBean;
 
+    @Autowired
+    private EventService eventService;
+
     private Stage stage;
     private List<WebSocketSession> sessionList = new ArrayList<>();
     private Scene scene;
@@ -373,6 +377,15 @@ public class ApplicationController extends TextWebSocketHandler implements Initi
     private Scene markdownTableScene;
     private String VERSION_PATTERN = "\\.AsciidocFX-\\d+\\.\\d+\\.\\d+";
 
+    @PostConstruct
+    public void install_listeners() {
+        // Listen to working directory update events
+        eventService.subscribe(DirectoryService.WORKING_DIRECTORY_UPDATE_EVENT, event -> {
+            Path path = (Path) event.getData();
+            getStage().setTitle(String.format("AsciidocFX - %s", path));
+        });
+    }
+
     public void createAsciidocTable() {
         asciidocTableStage.showAndWait();
     }
@@ -2548,7 +2561,7 @@ public String readAsciidoctorResource(String uri, Integer parent) {
             return String.format("link:%s[]", uri);
         }
 
-        PathFinderService fileReader = applicationContext.getBean("pathFinder", PathFinderService.class);
+        PathFinderService fileReader = applicationContext.getBean(PathFinderService.label, PathFinderService.class);
         Path path = fileReader.findPath(uri, parent);
 
         if (!Files.exists(path)) {

src/main/java/com/kodedu/service/DirectoryService.java

@@ -12,6 +12,12 @@
  * Created by usta on 25.12.2014.
  */
 public interface DirectoryService {
+    public final static String label = "core::service::DirectoryService";
+
+    /**
+     * Notify a working directory update. Sends a nullable {@link java.nio.file.Path}.
+     */
+    public final static String WORKING_DIRECTORY_UPDATE_EVENT = "event::directory::workingdirectory::update";
 
     public DirectoryChooser newDirectoryChooser(String title);
 

src/main/java/com/kodedu/service/EventService.java

@@ -0,0 +1,72 @@
+package com.kodedu.service;
+
+import java.util.Date;
+import java.util.function.Consumer;
+
+/**
+ * Used to share state changes accross the application
+ * @author Ayowel
+ * @since RC-SNAPSHOT
+ */
+public interface EventService {
+    /**
+     * The default service label to use
+     */
+    public final static String label = "core::service::EventService";
+
+    /**
+     * Propagate an event to all subscribed listeners
+     * @param label
+     *   The label of the event to subscribe to.
+     *   Label have scopes separated with :: scopes must be alpha-numerical
+     * @param data The dataset associated to the dispatched event
+     */
+    public void sendEvent(String label, Object data);
+
+    /**
+     * Subscribe to receive event notifications
+     * @param eventLabel The name of the event to listen for. May use a whole-scope wildcard with * instead of a scope's name
+     * @param callback A consumer to call when the event is triggered
+     * @return An event subscription object used to unsubscribe if needs be
+     * @see #sendEvent(String, Object)
+     */
+    public Subscription subscribe(String eventLabel, Consumer<Event> callback);
+
+    /**
+     * Stop receiving event notifications for a subscription
+     * @param subscription The event subscription to cancel
+     */
+    public void unsubscribe(Subscription subscription);
+
+    /**
+     * Represents a subscription to an event
+     * @author Ayowel
+     * @since RC-SNAPSHOT
+     */
+    public interface Subscription { }
+
+    /**
+     * Event object
+     * @author Ayowel
+     * @since RC-SNAPSHOT
+     * @param <T> The data type propagated by the event
+     */
+    public interface Event {
+        /**
+         * The label of the event
+         * @return
+         */
+        public String getLabel();
+        /**
+         * The event's payload
+         * @return
+         */
+        public Object getData();
+
+        /**
+         * The event's creation timestamp
+         * @return
+         */
+        public Date getTimestamp();
+    }
+}

src/main/java/com/kodedu/service/FileWatchService.java

@@ -8,6 +8,7 @@
  * Created by usta on 31.12.2014.
  */
 public interface FileWatchService {
+    public final static String label = "core::service::FileWatch";
 
     public void reCreateWatchService();
 

src/main/java/com/kodedu/service/ParserService.java

@@ -9,6 +9,7 @@
  * Created by usta on 16.12.2014.
  */
 public interface ParserService {
+    public final static String label = "core::service::Parser";
 
     public Optional<String> toIncludeBlock(List<File> dropFiles);
 

src/main/java/com/kodedu/service/PathFinderService.java

@@ -6,6 +6,7 @@
  * Created by usta on 20.05.2015.
  */
 public interface PathFinderService {
+    public final static String label = "core::service::PathFinder";
 
     public Path findPath(String uri, Integer parent);
 }

src/main/java/com/kodedu/service/PathOrderService.java

@@ -6,6 +6,7 @@
  * Created by usta on 01.01.2015.
  */
 public interface PathOrderService {
+    public final static String label = "core::service::PathOrder";
 
     public int comparePaths(Path first, Path second);
 

src/main/java/com/kodedu/service/PathResolverService.java

@@ -6,6 +6,7 @@
  * Created by usta on 07.09.2014.
  */
 public interface PathResolverService {
+    public final static String label = "core::service::PathResolver";
 
     public boolean isPDF(Path path);
 
@@ -25,7 +26,6 @@ public interface PathResolverService {
 
     public boolean isOffice(Path path);
 
-
     public boolean isBook(Path path);
 
     public boolean isMobi(Path path);

src/main/java/com/kodedu/service/SampleBookService.java

@@ -6,6 +6,7 @@
  * Created by usta on 02.09.2014.
  */
 public interface SampleBookService {
+    public final static String label = "core::service::SampleBook";
 
     public void produceSampleBook(Path configPath, Path outputPath);
 }