Merge branch 'develop' into feature/#6warning_transparency

Author: mplieske

.gitignore

@@ -28,4 +28,5 @@
 logs/
 *.jar
 
-config.xml
+config.xml
+db/

README.md

@@ -1,9 +1,4 @@
 # KeepTime
-Readme is WIP\
-Project is Beta\
-You will most probably have to reconfigure the application with your details if a newer version will appear.\
-
-# Use
 Application to track your time spent on different projects each day. Aim was to create an easy and fast way to track the doings over the day. In the end you get a summary for the day.
 
 Create projects and choose if they are counted as 'work time'. Select the project you work on. Before you switch the project, write a comment on what u did. Change the project. Repeat.
@@ -22,11 +17,13 @@ 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). You should put the .jar in an extra folder as a *logs* folder will be created next to it.\
+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. 
-* 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*.
+* 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.

pom.xml

@@ -40,6 +40,14 @@
       <artifactId>spring-boot-starter-test</artifactId>
       <scope>test</scope>
     </dependency>
+    <!-- https://mvnrepository.com/artifact/org.flywaydb/flyway-maven-plugin -->
+    <dependency>
+      <groupId>org.flywaydb</groupId>
+      <artifactId>flyway-maven-plugin</artifactId>
+      <version>5.1.4</version>
+    </dependency>
+
+
     <dependency>
       <groupId>com.1stleg</groupId>
       <artifactId>jnativehook</artifactId>

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

@@ -0,0 +1,34 @@
+package de.doubleslash.keeptime;
+
+import java.lang.Thread.UncaughtExceptionHandler;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Handler logging uncaught exceptions. Gotta Catch 'Em All
+ * 
+ * @author nmutter
+ */
+public class DefaultExceptionHandler implements UncaughtExceptionHandler {
+
+   private final Logger LOG = LoggerFactory.getLogger(this.getClass());
+
+   @Override
+   public void uncaughtException(final Thread t, final Throwable e) {
+      LOG.error("Uncaught exception on thread '{}'.", t, e);
+   }
+
+   /**
+    * Registers this class as default uncaught exception handler
+    */
+   public void register() {
+      LOG.debug("Registering uncaught exception handler");
+      final UncaughtExceptionHandler defaultUncaughtExceptionHandler = Thread.getDefaultUncaughtExceptionHandler();
+      if (defaultUncaughtExceptionHandler != null) {
+         LOG.warn("Uncaught exception handler was already set ('{}'). Overwritting.", defaultUncaughtExceptionHandler);
+      }
+      Thread.setDefaultUncaughtExceptionHandler(this);
+   }
+
+}

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

@@ -36,18 +36,23 @@
 @SpringBootApplication
 public class Main extends Application {
 
-   private ConfigurableApplicationContext springContext;
+   private final Logger LOG = LoggerFactory.getLogger(this.getClass());
 
-   public static Stage stage;
-   Stage popupViewStage;
+   public static final String VERSION = "v0.0.2";
 
-   private final Logger LOG = LoggerFactory.getLogger(this.getClass());
+   private ConfigurableApplicationContext springContext;
+
+   private Stage popupViewStage;
 
    private Model model;
    private Controller controller;
 
    @Override
    public void init() throws Exception {
+      LOG.info("Starting KeepTime {}", VERSION);
+      final DefaultExceptionHandler defaultExceptionHandler = new DefaultExceptionHandler();
+      defaultExceptionHandler.register();
+
       springContext = SpringApplication.run(Main.class);
       // TODO test if everywhere is used the same model
       model = springContext.getBean(Model.class);
@@ -57,8 +62,6 @@ public void init() throws Exception {
    @Override
    public void start(final Stage primaryStage) throws Exception {
 
-      stage = primaryStage;
-
       LOG.debug("Reading configuration");
 
       // TODO there should just be one instance of settings in the repo
@@ -92,8 +95,6 @@ public void start(final Stage primaryStage) throws Exception {
       LOG.info("Found {} past work items", todaysWorkItems.size());
       model.pastWorkItems.addAll(todaysWorkItems);
 
-      // createProjects();
-
       final List<Project> projects = model.projectRepository.findAll();
 
       LOG.debug("Found '{}' projects", projects.size());

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

@@ -5,23 +5,23 @@
 import javax.xml.parsers.DocumentBuilder;
 import javax.xml.parsers.DocumentBuilderFactory;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
 import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
 
 import de.doubleslash.keeptime.controller.Controller;
-import de.doubleslash.keeptime.model.Model;
 import de.doubleslash.keeptime.model.Project;
 import javafx.scene.paint.Color;
 
 public class ConfigParser {
+   private final Logger LOG = LoggerFactory.getLogger(this.getClass());
 
-   Controller controller;
-   Model model;
+   private final Controller controller;
 
-   public ConfigParser(final Model model, final Controller controller) {
-      this.model = model;
+   public ConfigParser(final Controller controller) {
       this.controller = controller;
    }
 
@@ -30,15 +30,15 @@ public static boolean hasConfigFile(final String fileName) {
       return f.exists();
    }
 
-   public void parserConfig(final File inputFile) {
+   public void parseConfig(final File inputFile) {
+      LOG.info("Starting import of projects in file '{}'.", inputFile);
       try {
          final DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();
          final DocumentBuilder dBuilder = dbFactory.newDocumentBuilder();
          final Document doc = dBuilder.parse(inputFile);
          doc.getDocumentElement().normalize();
-         System.out.println("Root element :" + doc.getDocumentElement().getNodeName());
+         LOG.debug("Root element '{}'.", doc.getDocumentElement().getNodeName());
          final NodeList nList = doc.getElementsByTagName("project");
-         System.out.println("----------------------------");
 
          // index makes sure to add new projects at the end
          int index = controller.getAvailableProjects().size();
@@ -51,26 +51,29 @@ public void parserConfig(final File inputFile) {
                final String isWork = eElement.getElementsByTagName("isWork").item(0).getTextContent();
                final String color = eElement.getElementsByTagName("color").item(0).getTextContent();
 
-               System.out.println("checking for: " + name);
+               LOG.debug("Testing if project with name '{}' already exists.", name);
                boolean exists = false;
 
                for (final Project p : controller.getAvailableProjects()) {
                   if (name.equals(p.getName())) {
-                     System.out.println(name + "    " + Boolean.toString(exists));
                      exists = true;
+                     break;
                   }
                }
                if (!exists) {
+                  LOG.info("Adding project '{}'.", name);
                   final Color colorTemp = Color.valueOf(color);
                   controller.addNewProject(name, Boolean.parseBoolean(isWork), colorTemp, index);
                   index++;
+               } else {
+                  LOG.debug("Project '{}' already exists", name);
                }
 
             }
          }
-
+         LOG.info("Import of '{}' finished.", inputFile);
       } catch (final Exception e) {
-         e.printStackTrace();
+         LOG.error("There was an error while importing projects from config.xml", e);
       }
    }
 }

src/main/java/de/doubleslash/keeptime/view/SettingsController.java

@@ -5,15 +5,19 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import de.doubleslash.keeptime.Main;
 import de.doubleslash.keeptime.common.ConfigParser;
 import de.doubleslash.keeptime.controller.Controller;
 import de.doubleslash.keeptime.model.Model;
+import javafx.event.ActionEvent;
+import javafx.event.EventHandler;
 import javafx.fxml.FXML;
 import javafx.scene.control.Alert;
 import javafx.scene.control.Alert.AlertType;
 import javafx.scene.control.Button;
 import javafx.scene.control.CheckBox;
 import javafx.scene.control.ColorPicker;
+import javafx.scene.control.Label;
 import javafx.scene.layout.Region;
 import javafx.scene.paint.Color;
 import javafx.stage.Stage;
@@ -54,18 +58,22 @@ public class SettingsController {
    @FXML
    private Button cancelButton;
 
-   private final Logger LOG = LoggerFactory.getLogger(this.getClass());
-
    @FXML
    private Button parseConfigButton;
 
+   @FXML
+   private Label versionLabel;
+
+   private final Logger LOG = LoggerFactory.getLogger(this.getClass());
+
    private Model model;
    private Controller controller;
    private Stage thisStage;
    private static final String INPUT_FILE = "config.xml";
 
    @FXML
    private void initialize() {
+      versionLabel.setText(Main.VERSION);
       saveButton.setOnAction(ae -> {
          LOG.info("Save clicked");
 
@@ -133,10 +141,13 @@ private void initialize() {
          taskBarColor.setValue(Model.originalTaskBarFontColor);
       });
 
-      parseConfigButton.setOnAction(ae -> {
-         if (ConfigParser.hasConfigFile(INPUT_FILE)) {
-            final ConfigParser parser = new ConfigParser(model, controller);
-            parser.parserConfig(new File(INPUT_FILE));
+      parseConfigButton.setOnAction(new EventHandler<ActionEvent>() {
+         @Override
+         public void handle(final ActionEvent actionEvent) {
+            if (ConfigParser.hasConfigFile(INPUT_FILE)) {
+               final ConfigParser parser = new ConfigParser(controller);
+               parser.parseConfig(new File(INPUT_FILE));
+            }
          }
       });
 

src/main/java/de/doubleslash/keeptime/view/ViewController.java

@@ -14,7 +14,6 @@
 import org.slf4j.LoggerFactory;
 import org.springframework.stereotype.Component;
 
-import de.doubleslash.keeptime.Main;
 import de.doubleslash.keeptime.common.ColorHelper;
 import de.doubleslash.keeptime.common.DateFormatter;
 import de.doubleslash.keeptime.common.Resources;
@@ -130,6 +129,7 @@ class Delta {
 
    private final Delta dragDelta = new Delta();
 
+   private Stage mainStage;
    private Controller controller;
    private Model model;
 
@@ -185,23 +185,23 @@ private void initialize() throws IOException {
       mouseHoveringProperty.addListener((a, b, c) -> {
          // TODO fix the not so nice jumping..
          projectsVBox.setManaged(c);
-         final double beforeWidth = Main.stage.getWidth();
-         Main.stage.sizeToScene();
-         final double afterWidth = Main.stage.getWidth();
+         final double beforeWidth = mainStage.getWidth();
+         mainStage.sizeToScene();
+         final double afterWidth = mainStage.getWidth();
          projectsVBox.setVisible(c);
          final double offset = afterWidth - beforeWidth;
          if (!model.displayProjectsRight.get()) {
             // we only need to move the stage if the node on the left is hidden
-            Main.stage.setX(Main.stage.getX() - offset);
+            mainStage.setX(mainStage.getX() - offset);
          }
       });
 
       minimizeButton.setOnAction((ae) -> {
-         Main.stage.setIconified(true);
+         mainStage.setIconified(true);
       });
       minimizeButton.textFillProperty().bind(fontColorProperty);
       closeButton.setOnAction((ae) -> {
-         Main.stage.close();
+         mainStage.close();
       });
       closeButton.textFillProperty().bind(fontColorProperty);
 
@@ -792,7 +792,7 @@ private void updateTaskbarIcon(final long currentWorkSeconds) {
       final BufferedImage bi = SwingFXUtils.fromFXImage(image, null);
       final Image icon = SwingFXUtils.toFXImage(bi, null);
 
-      final ObservableList<Image> icons = Main.stage.getIcons();
+      final ObservableList<Image> icons = mainStage.getIcons();
       icons.addAll(icon);
       if (icons.size() > 1) {
          icons.remove(0);
@@ -820,8 +820,6 @@ public static String changeStyleAttribute(final String style, final String attri
       return newStyle;
    }
 
-   Stage mainStage;
-
    public void setStage(final Stage primaryStage) {
       this.mainStage = primaryStage;
    }

src/main/resources/application.properties

@@ -3,8 +3,12 @@ spring.h2.console.enabled=true
 spring.h2.console.path=/h2
 
 # Datasource
-spring.datasource.url=jdbc:h2:file:~/keeptime/db/keeptime-h2-db;DB_CLOSE_ON_EXIT=FALSE
+spring.datasource.url=jdbc:h2:file:./db/keeptime-h2-db;DB_CLOSE_ON_EXIT=FALSE
 spring.datasource.username=sa
 spring.datasource.password=
 spring.datasource.driver-class-name=org.h2.Driver
-spring.jpa.hibernate.ddl-auto=update
+
+spring.flyway.baselineOnMigrate=true
+spring.flyway.baselineVersion=0.0.0
+
+spring.jpa.hibernate.ddl-auto=validate

src/main/resources/db/migration/V0_0_1__init.sql

@@ -0,0 +1,39 @@
+ CREATE TABLE IF NOT EXISTS project
+  (
+     id         BIGINT GENERATED BY DEFAULT AS IDENTITY,
+     color      VARCHAR(255),
+     index      INTEGER NOT NULL,
+     is_default BOOLEAN NOT NULL,
+     is_enabled BOOLEAN NOT NULL,
+     is_work    BOOLEAN NOT NULL,
+     name       VARCHAR(255),
+     PRIMARY KEY (id)
+  );
+
+CREATE TABLE IF NOT EXISTS settings
+  (
+     id                       BIGINT GENERATED BY DEFAULT AS IDENTITY,
+     default_background_color VARCHAR(255),
+     default_font_color       VARCHAR(255),
+     display_projects_right   BOOLEAN NOT NULL,
+     hover_background_color   VARCHAR(255),
+     hover_font_color         VARCHAR(255),
+     task_bar_color           VARCHAR(255),
+     use_hotkey               BOOLEAN NOT NULL,
+     PRIMARY KEY (id)
+  );
+
+CREATE TABLE IF NOT EXISTS work
+  (
+     id            BIGINT GENERATED BY DEFAULT AS IDENTITY,
+     creation_date DATE,
+     end_time      TIMESTAMP,
+     notes         CLOB,
+     start_time    TIMESTAMP,
+     project_id    BIGINT,
+     PRIMARY KEY (id)
+  );
+
+ALTER TABLE work
+  ADD CONSTRAINT IF NOT EXISTS fkf4jf1abybj7fc5w1nt686svxt FOREIGN KEY (project_id) REFERENCES
+  project;