IPTE-22: added more logstatements and user feedback

* introduced new application.properties
* reading properties file now with spring tools
* adapted layout to have same button size for buttons

Author: Death111

pom.xml

@@ -5,7 +5,7 @@
 
   <groupId>de.doubleslash</groupId>
   <artifactId>keeptime</artifactId>
-  <version>1.1.0-SNAPSHOT</version>
+  <version>1.2.0-SNAPSHOT</version>
   <packaging>jar</packaging>
 
   <name>KeepTime</name>
@@ -173,13 +173,6 @@
       </plugin>
 
     </plugins>
-    
-    <!-- resources>
-      <resource>
-        <filtering>true</filtering>
-        <directory>src/main/resources</directory>
-      </resource>
-    </resources -->
   </build>
 
   <reporting>

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

@@ -0,0 +1,71 @@
+package de.doubleslash.keeptime;
+
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.stereotype.Service;
+
+@Service
+public class ApplicationProperties {
+
+   private String buildVersion;
+   private String buildTimestamp;
+
+   private String h2Version;
+
+   private String springDataSourceUrl;
+   private String springDataSourceUserName;
+   private String springDataSourcePassword;
+
+   public String getBuildVersion() {
+      return buildVersion;
+   }
+
+   @Value("${build.version}")
+   private void setBuildVersion(String projectVersion) {
+      this.buildVersion = projectVersion;
+   }
+
+   public String getBuildTimestamp() {
+      return buildTimestamp;
+   }
+
+   @Value("${build.timestamp}")
+   public void setBuildTimestamp(String buildTimestamp) {
+      this.buildTimestamp = buildTimestamp;
+   }
+
+   public String getH2Version() {
+      return this.h2Version;
+   }
+
+   @Value("${h2.version}")
+   private void setH2Version(final String h2Version) {
+      this.h2Version = h2Version;
+   }
+
+   public String getSpringDataSourceUrl() {
+      return springDataSourceUrl;
+   }
+
+   @Value("${spring.datasource.url}")
+   private void setSpringDataSourceUrl(String springDataSourceUrl) {
+      this.springDataSourceUrl = springDataSourceUrl;
+   }
+
+   public String getSpringDataSourceUserName() {
+      return springDataSourceUserName;
+   }
+
+   @Value("${spring.datasource.username}")
+   private void setSpringDataSourceUserName(String springDataSourceUserName) {
+      this.springDataSourceUserName = springDataSourceUserName;
+   }
+
+   public String getSpringDataSourcePassword() {
+      return springDataSourcePassword;
+   }
+
+   @Value("${spring.datasource.password}")
+   private void setSpringDataSourcePassword(String springDataSourcePassword) {
+      this.springDataSourcePassword = springDataSourcePassword;
+   }
+}

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

@@ -65,8 +65,6 @@ public class Main extends Application {
 
    private static final Logger LOG = LoggerFactory.getLogger(Main.class);
 
-   public static final String VERSION = "v1.1.0";
-
    private ConfigurableApplicationContext springContext;
 
    private Stage popupViewStage;
@@ -81,12 +79,14 @@ public class Main extends Application {
 
    @Override
    public void init() throws Exception {
-      LOG.info("Starting KeepTime {}", VERSION);
+      LOG.info("Starting KeepTime.");
       final DefaultExceptionHandler defaultExceptionHandler = new DefaultExceptionHandler();
       defaultExceptionHandler.register();
 
       springContext = SpringApplication.run(Main.class);
-      // TODO test if everywhere is used the same model
+      ApplicationProperties applicationProperties = springContext.getBean(ApplicationProperties.class);
+      LOG.info("KeepTime Version: '{}'.", applicationProperties.getBuildVersion());
+      LOG.info("KeepTime Build Timestamp: '{}'.", applicationProperties.getBuildTimestamp());
       model = springContext.getBean(Model.class);
       controller = springContext.getBean(Controller.class);
       model.setSpringContext(springContext);

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

@@ -22,6 +22,7 @@
 import org.slf4j.LoggerFactory;
 import org.springframework.stereotype.Component;
 
+import de.doubleslash.keeptime.ApplicationProperties;
 import de.doubleslash.keeptime.Main;
 import de.doubleslash.keeptime.common.BrowserHelper;
 import de.doubleslash.keeptime.common.FileOpenHelper;
@@ -67,10 +68,16 @@ public class AboutController {
 
    private static final Logger LOG = LoggerFactory.getLogger(AboutController.class);
 
+   private final ApplicationProperties applicationProperties;
+
+   public AboutController (ApplicationProperties applicationProperties) {
+	   this.applicationProperties = applicationProperties;
+   }
+   
    @FXML
    public void initialize() {
       LOG.debug("set version label");
-      versionNumberLabel.setText(Main.VERSION);
+      versionNumberLabel.setText(applicationProperties.getBuildVersion());
 
       ourLicenseHyperLink.setFocusTraversable(false);
       ourLicenseHyperLink.setOnAction(ae -> showLicense(Licenses.GPLV3));

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

@@ -18,18 +18,16 @@
 
 import java.io.File;
 import java.io.IOException;
-import java.io.InputStream;
-import java.nio.file.Files;
 import java.nio.file.Paths;
 import java.sql.SQLException;
-import java.util.Properties;
 
 import org.h2.tools.Script;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
 
+import de.doubleslash.keeptime.ApplicationProperties;
 import de.doubleslash.keeptime.common.OS;
 import de.doubleslash.keeptime.common.Resources;
 import de.doubleslash.keeptime.common.Resources.RESOURCE;
@@ -118,6 +116,7 @@ public class SettingsController {
 
    private final Controller controller;
    private final Model model;
+   private final ApplicationProperties applicationProperties;
 
    private Stage thisStage;
 
@@ -127,9 +126,11 @@ public class SettingsController {
    ViewController mainscreen;
 
    @Autowired
-   public SettingsController(final Model model, final Controller controller) {
+   public SettingsController(final Model model, final Controller controller,
+         ApplicationProperties applicationProperties) {
       this.model = model;
       this.controller = controller;
+      this.applicationProperties = applicationProperties;
    }
 
    @FXML
@@ -217,11 +218,11 @@ private void initialize() {
       });
 
       LOG.debug("resetButton.setOnAction");
-      resetHoverBackgroundButton
-            .setOnAction(ae -> hoverBackgroundColor.setValue(Model.ORIGINAL_HOVER_BACKGROUND_COLOR));
+      resetHoverBackgroundButton.setOnAction(
+            ae -> hoverBackgroundColor.setValue(Model.ORIGINAL_HOVER_BACKGROUND_COLOR));
       resetHoverFontButton.setOnAction(ae -> hoverFontColor.setValue(Model.ORIGINAL_HOVER_Font_COLOR));
-      resetDefaultBackgroundButton
-            .setOnAction(ae -> defaultBackgroundColor.setValue(Model.ORIGINAL_DEFAULT_BACKGROUND_COLOR));
+      resetDefaultBackgroundButton.setOnAction(
+            ae -> defaultBackgroundColor.setValue(Model.ORIGINAL_DEFAULT_BACKGROUND_COLOR));
       resetDefaultFontButton.setOnAction(ae -> defaultFontColor.setValue(Model.ORIGINAL_DEFAULT_FONT_COLOR));
       resetTaskBarFontButton.setOnAction(ae -> taskBarColor.setValue(Model.ORIGINAL_TASK_BAR_FONT_COLOR));
 
@@ -237,26 +238,42 @@ private void initExportButton() {
       exportButton.setOnAction(actionEvent -> {
          LOG.info("Button pressed: exportButton");
 
-         final Properties properties = new Properties();
-         try (InputStream resourceStream = SettingsController.class.getResourceAsStream("/application.properties")) {
-            properties.load(resourceStream);
+         try {
+            final String h2Version = applicationProperties.getH2Version();
 
             final FileChooser fileChooser = new FileChooser();
             fileChooser.setInitialDirectory(Paths.get(".").toFile());
-            final String h2Version = properties.getProperty("h2.version");
             fileChooser.setInitialFileName(String.format("KeepTime_database-export_H2-version-%s.sql", h2Version));
-            fileChooser.getExtensionFilters().add(new ExtensionFilter("SQL scrip files.", "*.sql"));
-
+            fileChooser.getExtensionFilters().add(new ExtensionFilter("SQL script files.", "*.sql"));
             final File fileToSave = fileChooser.showSaveDialog(thisStage);
-            Files.deleteIfExists(Paths.get(fileToSave.getAbsolutePath()));
+            if (fileToSave == null) {
+               LOG.info("User canceled export.");
+               return;
+            }
 
-            final String url = properties.getProperty("spring.datasource.url");
-            final String username = properties.getProperty("spring.datasource.username");
-            final String password = properties.getProperty("spring.datasource.password");
+            final String url = applicationProperties.getSpringDataSourceUrl();
+            final String username = applicationProperties.getSpringDataSourceUserName();
+            final String password = applicationProperties.getSpringDataSourcePassword();
 
+            LOG.info("Exporting database to '{}'.", fileToSave);
             Script.process(url, username, password, fileToSave.getAbsolutePath(), "", "");
-         } catch (final SQLException | IOException e) {
+            LOG.info("Export done.");
+
+            Alert informationDialog = new Alert(AlertType.INFORMATION);
+            informationDialog.setTitle("Export done");
+            informationDialog.setHeaderText("The current data was exported.");
+            informationDialog.setContentText("The data was exported to '" + fileToSave + "'.");
+
+            informationDialog.showAndWait();
+         } catch (final SQLException e) {
             LOG.error("Could not export db to script file.", e);
+
+            Alert errorDialog = new Alert(AlertType.ERROR);
+            errorDialog.setTitle("Export failed");
+            errorDialog.setHeaderText("The current data could not be exported.");
+            errorDialog.setContentText("Please inform a developer and provide your log file.");
+
+            errorDialog.showAndWait();
          }
       });
    }

src/main/resources/application.properties

@@ -2,7 +2,10 @@
 spring.h2.console.enabled=true
 spring.h2.console.path=/h2
 
-h2.version=1.4.197
+h2.version=@h2.version@
+
+build.version=@project.version@
+build.timestamp=@maven.build.timestamp@
 
 # Datasource
 spring.datasource.url=jdbc:h2:file:./db/keeptime-h2-db;DB_CLOSE_ON_EXIT=FALSE

src/main/resources/layouts/settings.fxml

@@ -28,7 +28,7 @@
 <?import javafx.scene.layout.VBox?>
 <?import javafx.scene.text.Font?>
 
-<AnchorPane fx:id="settingsRoot" focusTraversable="true" xmlns="http://javafx.com/javafx/8.0.202-ea" xmlns:fx="http://javafx.com/fxml/1" fx:controller="de.doubleslash.keeptime.view.SettingsController">
+<AnchorPane fx:id="settingsRoot" focusTraversable="true" xmlns="http://javafx.com/javafx/8.0.171" xmlns:fx="http://javafx.com/fxml/1" fx:controller="de.doubleslash.keeptime.view.SettingsController">
    <children>
       <VBox spacing="10.0" stylesheets="@../css/menu.css">
          <children>
@@ -291,14 +291,22 @@
                         <Font name="Open Sans Regular" size="12.0" />
                      </font>
                   </Button>
-                  <Button fx:id="cancelButton" layoutX="10.0" layoutY="10.0" mnemonicParsing="false" text="Cancel">
+                  <Button fx:id="cancelButton" mnemonicParsing="false" text="Cancel">
                      <font>
                         <Font name="Open Sans Regular" size="12.0" />
                      </font>
                   </Button>
-                  <Button fx:id="exportButton" mnemonicParsing="false" text="Export" />
                   <Region HBox.hgrow="ALWAYS" />
-                  <Button fx:id="aboutButton" mnemonicParsing="false" prefHeight="25.0" prefWidth="70.0" text="About" HBox.hgrow="ALWAYS" />
+                  <Button fx:id="exportButton" mnemonicParsing="false" text="Export">
+                     <font>
+                        <Font name="Open Sans Regular" size="12.0" />
+                     </font>
+                  </Button>
+                  <Button fx:id="aboutButton" mnemonicParsing="false" text="About">
+                     <font>
+                        <Font name="Open Sans Regular" size="12.0" />
+                     </font>
+                  </Button>
                </children>
             </HBox>
          </children>