Merge pull request #18 from doubleSlashde/release/v1.0.0

Release/v1.0.0

Author: Death111

README.md

@@ -17,13 +17,14 @@ Main view (when you hover over the app):\
 **You need to close the application manualy before you shutdown your PC. Otherwise the last running project is not saved to database.**
 
 # Install
-Download and execute .jar file (see [releases](https://github.com/doubleSlashde/KeepTime/releases)). You should put the .jar in an extra folder as a *logs* and a *db* folder will be created next to it.\
-It is recommended to run the application at windows start. 
+Download and execute .jar file (see [releases](https://github.com/doubleSlashde/KeepTime/releases)). The start may take up to one minute. You should put the .jar in an extra folder as a *logs* and a *db* folder will be created next to it.\
+It is recommended to run the application at windows start so you do not forget to track your time. To do this follow these steps:
 * Copy the keeptime.bat file from this repo next to the *.jar*. Adapt the path inside the *keeptime.bat* to the name of the *.jar* file (if needed). Try starting the application by executing the *keeptime.bat* file. Close the app
 * Open the autostart folder: Press *Windows+R*, execute *shell:startup*
 * Create a shortcut to the *.bat* in the autostart folder
 
 **migrate from old version**
 If you used this application before with a *config.xml* you can import your old projects in the settings dialog. Place your config.xml next to the jar and press "parse config.xml". Otherwise no steps are needed.
 ## Requirements
-Only works correct for windows currently. Tested on 7 and 10.
+* Windows 7 or 10 (Linux is not yet supported)
+* Java 8

keeptime.bat

@@ -1 +1 @@
-start "" "javaw" -Dprism.order=sw -jar keeptime-1.0.0-SNAPSHOT.jar
+start "" "javaw" -Dprism.order=sw -jar keeptime-v1.0.0.jar

src/main/java/de/doubleslash/keeptime/DefaultExceptionHandler.java

@@ -12,7 +12,7 @@
  */
 public class DefaultExceptionHandler implements UncaughtExceptionHandler {
 
-   private final Logger LOG = LoggerFactory.getLogger(this.getClass());
+   private static final Logger LOG = LoggerFactory.getLogger(DefaultExceptionHandler.class);
 
    @Override
    public void uncaughtException(final Thread t, final Throwable e) {

src/main/java/de/doubleslash/keeptime/Main.java

@@ -1,6 +1,8 @@
 package de.doubleslash.keeptime;
 
 import java.io.IOException;
+import java.io.PrintWriter;
+import java.io.StringWriter;
 import java.time.LocalDate;
 import java.util.List;
 import java.util.Optional;
@@ -27,7 +29,13 @@
 import javafx.fxml.FXMLLoader;
 import javafx.scene.Parent;
 import javafx.scene.Scene;
+import javafx.scene.control.Alert;
+import javafx.scene.control.Alert.AlertType;
+import javafx.scene.control.Label;
+import javafx.scene.control.TextArea;
+import javafx.scene.layout.GridPane;
 import javafx.scene.layout.Pane;
+import javafx.scene.layout.Priority;
 import javafx.scene.paint.Color;
 import javafx.stage.Stage;
 import javafx.stage.StageStyle;
@@ -36,9 +44,9 @@
 @SpringBootApplication
 public class Main extends Application {
 
-   private final Logger LOG = LoggerFactory.getLogger(this.getClass());
+   private static final Logger LOG = LoggerFactory.getLogger(Main.class);
 
-   public static final String VERSION = "v0.0.2";
+   public static final String VERSION = "v1.0.0";
 
    private ConfigurableApplicationContext springContext;
 
@@ -47,6 +55,10 @@ public class Main extends Application {
    private Model model;
    private Controller controller;
 
+   private ViewController viewController;
+
+   private GlobalScreenListener globalScreenListener;
+
    @Override
    public void init() throws Exception {
       LOG.info("Starting KeepTime {}", VERSION);
@@ -60,36 +72,49 @@ public void init() throws Exception {
    }
 
    @Override
-   public void start(final Stage primaryStage) throws Exception {
+   public void start(final Stage primaryStage) {
+      LOG.info("Initialising the UI");
+      try {
+         initUI(primaryStage);
+         LOG.info("UI successfully initialised.");
+      } catch (final Exception e) {
+         LOG.error("There was an error while initialising the UI", e);
 
-      LOG.debug("Reading configuration");
+         final Alert alert = new Alert(AlertType.ERROR);
+         alert.setTitle("Error");
+         alert.setHeaderText("Could not start application");
+         alert.setContentText("Please send the error with your logs folder to a developer");
 
-      // TODO there should just be one instance of settings in the repo
-      final List<Settings> settingsList = model.settingsRepository.findAll();
-      final Settings settings;
-      if (settingsList.isEmpty()) {
-         settings = new Settings();
-         settings.setTaskBarColor(model.taskBarColor.get());
+         final StringWriter sw = new StringWriter();
+         final PrintWriter pw = new PrintWriter(sw);
+         e.printStackTrace(pw);
+         final String exceptionText = sw.toString();
 
-         settings.setDefaultBackgroundColor(model.defaultBackgroundColor.get());
-         settings.setDefaultFontColor(model.defaultFontColor.get());
+         final Label label = new Label("The exception stacktrace was:");
 
-         settings.setHoverBackgroundColor(model.hoverBackgroundColor.get());
-         settings.setHoverFontColor(model.hoverFontColor.get());
-         settings.setUseHotkey(false);
-         settings.setDisplayProjectsRight(false);
-         model.settingsRepository.save(settings);
-      } else {
-         settings = settingsList.get(0);
+         final TextArea textArea = new TextArea(exceptionText);
+         textArea.setEditable(false);
+         textArea.setWrapText(true);
+
+         textArea.setMaxWidth(Double.MAX_VALUE);
+         textArea.setMaxHeight(Double.MAX_VALUE);
+         GridPane.setVgrow(textArea, Priority.ALWAYS);
+         GridPane.setHgrow(textArea, Priority.ALWAYS);
+
+         final GridPane expContent = new GridPane();
+         expContent.setMaxWidth(Double.MAX_VALUE);
+         expContent.add(label, 0, 0);
+         expContent.add(textArea, 0, 1);
+
+         alert.getDialogPane().setExpandableContent(expContent);
+         alert.showAndWait();
+         System.exit(1);
       }
+   }
 
-      model.defaultBackgroundColor.set(settings.getDefaultBackgroundColor());
-      model.defaultFontColor.set(settings.getDefaultFontColor());
-      model.hoverBackgroundColor.set(settings.getHoverBackgroundColor());
-      model.hoverFontColor.set(settings.getHoverFontColor());
-      model.taskBarColor.set(settings.getTaskBarColor());
-      model.useHotkey.set(settings.isUseHotkey());
-      model.displayProjectsRight.set(settings.isDisplayProjectsRight());
+   private void initUI(final Stage primaryStage) throws Exception {
+
+      readSettings();
 
       final List<Work> todaysWorkItems = model.workRepository.findByCreationDate(LocalDate.now());
       LOG.info("Found {} past work items", todaysWorkItems.size());
@@ -109,51 +134,63 @@ public void start(final Stage primaryStage) throws Exception {
             .addAll(model.allProjects.stream().filter(Project::isEnabled).collect(Collectors.toList()));
 
       // set default project
-      final Optional<Project> findAny = projects.stream().filter(p -> p.isDefault()).findAny();
+      final Optional<Project> findAny = projects.stream().filter(Project::isDefault).findAny();
       if (findAny.isPresent()) {
          model.idleProject = findAny.get();
          LOG.debug("Using project '{}' as default project.", model.idleProject);
       }
 
       primaryStage.setOnHiding((we) -> {
-         // shutdown();
          popupViewStage.close();
-         globalScreenListener.register(false); // deregister, as this will keep app running
+         globalScreenListener.shutdown(); // deregister, as this will keep app running
       });
 
-      Runtime.getRuntime().addShutdownHook(new Thread() {
-         @Override
-         public void run() {
-            // TODO this does not work - spring uses own hooks and may already be shutdown
-            // shutdown();
-         }
-      });
+      initialiseUI(primaryStage);
+      initialisePopupUI(primaryStage);
+   }
 
-      try {
-         initialiseUI(primaryStage);
-      } catch (final Exception e) {
-         e.printStackTrace();
-      }
+   private void readSettings() {
+      LOG.debug("Reading configuration");
 
-      try {
-         initialisePopupUI(primaryStage);
-      } catch (final Exception e) {
-         e.printStackTrace();
+      final List<Settings> settingsList = model.settingsRepository.findAll();
+      final Settings settings;
+      if (settingsList.isEmpty()) {
+         settings = new Settings();
+         settings.setTaskBarColor(model.taskBarColor.get());
+
+         settings.setDefaultBackgroundColor(model.defaultBackgroundColor.get());
+         settings.setDefaultFontColor(model.defaultFontColor.get());
+
+         settings.setHoverBackgroundColor(model.hoverBackgroundColor.get());
+         settings.setHoverFontColor(model.hoverFontColor.get());
+         settings.setUseHotkey(false);
+         settings.setDisplayProjectsRight(false);
+         settings.setHideProjectsOnMouseExit(true);
+         model.settingsRepository.save(settings);
+      } else {
+         settings = settingsList.get(0);
       }
-   }
 
-   GlobalScreenListener globalScreenListener;
+      model.defaultBackgroundColor.set(settings.getDefaultBackgroundColor());
+      model.defaultFontColor.set(settings.getDefaultFontColor());
+      model.hoverBackgroundColor.set(settings.getHoverBackgroundColor());
+      model.hoverFontColor.set(settings.getHoverFontColor());
+      model.taskBarColor.set(settings.getTaskBarColor());
+      model.useHotkey.set(settings.isUseHotkey());
+      model.displayProjectsRight.set(settings.isDisplayProjectsRight());
+      model.hideProjectsOnMouseExit.set(settings.isHideProjectsOnMouseExit());
+   }
 
    private void initialisePopupUI(final Stage primaryStage) throws IOException {
-      // TODO register only if it is enabled
+      LOG.debug("Initialising popup UI.");
+
       globalScreenListener = new GlobalScreenListener();
-      // TODO stop and close stage when main stage is shutdown
+      // stop and close stage when main stage is shutdown
       model.useHotkey.addListener((a, b, newValue) -> {
          globalScreenListener.register(newValue);
       });
       globalScreenListener.register(model.useHotkey.get());
 
-      // Platform.setImplicitExit(false); // TODO maybe not needed as other view will be available
       popupViewStage = new Stage();
       popupViewStage.initOwner(primaryStage);
       // Load root layout from fxml file.
@@ -172,61 +209,41 @@ private void initialisePopupUI(final Stage primaryStage) throws IOException {
       viewControllerPopupController.setStage(popupViewStage, popupScene);
       viewControllerPopupController.setController(controller, model);
       globalScreenListener.setViewController(viewControllerPopupController);
-
    }
 
-   private void shutdown() {
-      LOG.info("Shutting down");
-      // viewController.changeProject(model.idleProject, 0); // TODO not so nice (view has the comments for the current
-      // // job)
-      controller.shutdown();
-   }
-
-   ViewController viewController;
-
-   private void initialiseUI(final Stage primaryStage) {
-      try {
-         Pane mainPane;
-
-         // Load root layout from fxml file.
-         final FXMLLoader loader = new FXMLLoader();
-         loader.setLocation(Resources.getResource(RESOURCE.FXML_VIEW_LAYOUT));
-         loader.setControllerFactory(springContext::getBean);
-         mainPane = loader.load();
-         primaryStage.initStyle(StageStyle.TRANSPARENT);
-         // Show the scene containing the root layout.
-         final Scene mainScene = new Scene(mainPane, Color.TRANSPARENT);
-
-         // Image(Resources.getResource(RESOURCE.ICON_MAIN).toString()));
+   private void initialiseUI(final Stage primaryStage) throws IOException {
+      LOG.debug("Initialising main UI.");
+      Pane mainPane;
 
-         primaryStage.setTitle("KeepTime");
-         primaryStage.setScene(mainScene);
-         primaryStage.setAlwaysOnTop(true);
-         primaryStage.setResizable(false);
-
-         primaryStage.setOnCloseRequest(new EventHandler<WindowEvent>() {
-            @Override
-            public void handle(final WindowEvent event) {
-               LOG.info("On close request");
-               // shutdown();
-               // Platform.exit();
-            }
-         });
+      // Load root layout from fxml file.
+      final FXMLLoader loader = new FXMLLoader();
+      loader.setLocation(Resources.getResource(RESOURCE.FXML_VIEW_LAYOUT));
+      loader.setControllerFactory(springContext::getBean);
+      mainPane = loader.load();
+      primaryStage.initStyle(StageStyle.TRANSPARENT);
+      // Show the scene containing the root layout.
+      final Scene mainScene = new Scene(mainPane, Color.TRANSPARENT);
 
-         viewController = loader.getController();
-         // Give the controller access to the main app.
-         viewController.setStage(primaryStage);
+      // Image(Resources.getResource(RESOURCE.ICON_MAIN).toString())); // TODO use an app icon
 
-         // controller = springContext.getBean(Controller.class, model, new RealDateProvider());
+      primaryStage.setTitle("KeepTime");
+      primaryStage.setScene(mainScene);
+      primaryStage.setAlwaysOnTop(true);
+      primaryStage.setResizable(false);
 
-         viewController.setController(controller, model);
+      primaryStage.setOnCloseRequest(new EventHandler<WindowEvent>() {
+         @Override
+         public void handle(final WindowEvent event) {
+            LOG.info("On close request");
+         }
+      });
 
-         primaryStage.show();
+      viewController = loader.getController();
+      // Give the controller access to the main app.
+      viewController.setStage(primaryStage);
+      viewController.setController(controller, model);
 
-      } catch (final Exception e) {
-         LOG.error("Error: " + e.toString(), e);
-         e.printStackTrace();
-      }
+      primaryStage.show();
    }
 
    @Override

src/main/java/de/doubleslash/keeptime/common/ColorHelper.java

@@ -4,6 +4,10 @@
 
 public class ColorHelper {
 
+   private ColorHelper() {
+      throw new IllegalStateException("Utility class");
+   }
+
    public static Color randomColor() {
       return Color.BLACK;
    }

src/main/java/de/doubleslash/keeptime/common/ConfigParser.java

@@ -17,7 +17,7 @@
 import javafx.scene.paint.Color;
 
 public class ConfigParser {
-   private final Logger LOG = LoggerFactory.getLogger(this.getClass());
+   private static final Logger LOG = LoggerFactory.getLogger(ConfigParser.class);
 
    private final Controller controller;
 

src/main/java/de/doubleslash/keeptime/common/DateFormatter.java

@@ -9,15 +9,22 @@ public class DateFormatter {
    private static DateTimeFormatter dayDateFormatter = DateTimeFormatter.ofPattern("eeee dd.MM.yyyy");
    private static DateTimeFormatter timeFormatter = DateTimeFormatter.ofPattern("HH:mm:ss");
 
+   private DateFormatter() {
+      throw new IllegalStateException("Utility class");
+   }
+
    public static String secondsToHHMMSS(final long currentWorkSeconds) {
       final int hours = (int) (currentWorkSeconds / 3600);
       final int minutes = (int) ((currentWorkSeconds % 3600) / 60);
 
       final int sec = (int) (((currentWorkSeconds % 3600) % 60));
 
-      final String a = (hours > 9 ? hours : "0" + hours) + ":" + (minutes > 9 ? minutes : "0" + minutes) + ":"
-            + (sec > 9 ? sec : "0" + sec);
-      return a;
+      final Object hoursString = hours > 9 ? hours : "0" + hours;
+      final Object minutesString = minutes > 9 ? minutes : "0" + minutes;
+      final Object secondsString = sec > 9 ? sec : "0" + sec;
+
+      final String timeString = hoursString + ":" + minutesString + ":" + secondsString;
+      return timeString;
    }
 
    public static long getSecondsBewtween(final LocalDateTime startDate, final LocalDateTime endDate) {

src/main/java/de/doubleslash/keeptime/common/Resources.java

@@ -4,6 +4,10 @@
 
 public class Resources {
 
+   private Resources() {
+      throw new IllegalStateException("Utility class");
+   }
+
    public enum RESOURCE {
       /** LAYOUTS **/
       // main
@@ -30,6 +34,5 @@ public String getResourceLocation() {
 
    public static URL getResource(final RESOURCE resource) {
       return Resources.class.getResource(resource.getResourceLocation());
-      // return ClassLoader.getSystemResource(resource.getResourceLocation());
    }
 }