#21 merged into cleanup branch

Merge branch 'feature/copy_project_report' into feature/sonar_issue_cleanup

# Conflicts:
#	src/main/java/de/doubleslash/keeptime/view/ReportController.java

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 the .jar and .bat file and execute the .bat (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/Main.java

@@ -46,7 +46,7 @@ public class Main extends Application {
 
    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;
 

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

@@ -0,0 +1,51 @@
+package de.doubleslash.keeptime.view;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import static de.doubleslash.keeptime.view.ReportController.EMPTY_NOTE;
+import static de.doubleslash.keeptime.view.ReportController.NOTE_DELIMETER;
+
+import java.lang.invoke.MethodHandles;
+
+public class ProjectReport {
+
+   /** The slf4j-logger for this class. */
+   private static final Logger LOG = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
+
+   private int numberOfNotes;
+
+   private final int size;
+
+   private final StringBuilder sb;
+
+   public ProjectReport(final int size) {
+      this.size = size;
+      this.sb = new StringBuilder(2 * 1024);
+   }
+
+   public void appendToWorkNotes(final String currentWorkNote) {
+      this.numberOfNotes++;
+      if (!currentWorkNote.equals(EMPTY_NOTE)) {
+         if (this.numberOfNotes > 1) {
+            this.sb.append(NOTE_DELIMETER);
+         }
+         this.sb.append(currentWorkNote.trim());
+      } else {
+         LOG.debug("Skipping empty note.");
+      }
+   }
+
+   public int getNumberOfNotes() {
+      return this.numberOfNotes;
+   }
+
+   public String getNotes(final boolean addNumberOfNotes) {
+      if (addNumberOfNotes) {
+         return Integer.toString(this.numberOfNotes) + " Notes: " + this.sb.toString();
+      } else {
+         return this.sb.toString();
+      }
+   }
+
+}

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

@@ -16,12 +16,17 @@
 import de.doubleslash.keeptime.model.Model;
 import de.doubleslash.keeptime.model.Project;
 import de.doubleslash.keeptime.model.Work;
+import javafx.event.ActionEvent;
+import javafx.event.EventHandler;
 import javafx.fxml.FXML;
 import javafx.scene.Node;
+import javafx.scene.control.Button;
 import javafx.scene.control.DateCell;
 import javafx.scene.control.DatePicker;
 import javafx.scene.control.Label;
 import javafx.scene.control.ScrollPane;
+import javafx.scene.input.Clipboard;
+import javafx.scene.input.ClipboardContent;
 import javafx.scene.layout.BorderPane;
 import javafx.scene.layout.GridPane;
 import javafx.scene.text.Font;
@@ -30,6 +35,10 @@
 
 public class ReportController {
 
+   public static final String NOTE_DELIMETER = "; ";
+
+   public static final String EMPTY_NOTE = "- No notes -";
+
    private static final String FX_BACKGROUND_COLOR_NOT_WORKED = "-fx-background-color: #BBBBBB;";
 
    @FXML
@@ -57,22 +66,22 @@ public class ReportController {
    private void initialize() {
       LOG.info("Init reportController");
 
-      datePicker = new DatePicker(LocalDate.now());
-      datePicker.valueProperty().addListener((observable, oldvalue, newvalue) -> {
+      this.datePicker = new DatePicker(LocalDate.now());
+      this.datePicker.valueProperty().addListener((observable, oldvalue, newvalue) -> {
          LOG.info("Datepicker selected value changed to {}", newvalue);
          updateReport(newvalue);
       });
    }
 
    private void updateReport(final LocalDate newvalue) {
-      currentDayLabel.setText(DateFormatter.toDayDateString(newvalue));
+      this.currentDayLabel.setText(DateFormatter.toDayDateString(newvalue));
       final List<Work> currentWorkItems = model.getWorkRepository().findByCreationDate(newvalue);
 
       final SortedSet<Project> workedProjectsSet = currentWorkItems.stream().map(Work::getProject)
             .collect(Collectors.toCollection(() -> new TreeSet<>(Comparator.comparing(Project::getName))));
 
-      gridPane.getChildren().clear();
-      gridPane.getRowConstraints().clear();
+      this.gridPane.getChildren().clear();
+      this.gridPane.getRowConstraints().clear();
 
       int rowIndex = 0;
       long currentWorkSeconds = 0;
@@ -82,9 +91,8 @@ private void updateReport(final LocalDate newvalue) {
 
       for (final Project project : workedProjectsSet) {
          final Label projectName = new Label(project.getName());
-
          projectName.setFont(labelFontBold);
-         gridPane.add(projectName, 0, rowIndex);
+         this.gridPane.add(projectName, 0, rowIndex);
 
          final List<Work> onlyCurrentProjectWork = currentWorkItems.stream().filter(w -> w.getProject() == project)
                .collect(Collectors.toList());
@@ -99,46 +107,81 @@ private void updateReport(final LocalDate newvalue) {
 
          final Label workedTimeLabel = new Label(DateFormatter.secondsToHHMMSS(todaysWorkSeconds));
          workedTimeLabel.setFont(labelFontBold);
+         this.gridPane.add(workedTimeLabel, 2, rowIndex);
+
+         // text will be set later
+         /*
+          * final TextArea textArea = new TextArea(); textArea.setMaxHeight(20); textArea.setFont(Font.font("System",
+          * FontWeight.NORMAL, 15)); textArea.setWrapText(true); this.gridPane.add(textArea, 1, rowIndex);
+          */
+         final Button bProjectReport = createProjectReport();
+         this.gridPane.add(bProjectReport, 1, rowIndex);
 
-         gridPane.add(workedTimeLabel, 2, rowIndex);
          rowIndex++;
 
+         final ProjectReport pr = new ProjectReport(onlyCurrentProjectWork.size());
          for (int j = 0; j < onlyCurrentProjectWork.size(); j++) {
             final Work work = onlyCurrentProjectWork.get(j);
             final String workedHours = DateFormatter
                   .secondsToHHMMSS(DateFormatter.getSecondsBewtween(work.getStartTime(), work.getEndTime()));
 
-            final Label commentLabel = new Label(work.getNotes());
+            final String currentWorkNote = work.getNotes();
+            pr.appendToWorkNotes(currentWorkNote);
+            final Label commentLabel = new Label(currentWorkNote);
             commentLabel.setFont(labelFontNormal);
             commentLabel.setWrapText(true);
-            gridPane.add(commentLabel, 0, rowIndex);
+            this.gridPane.add(commentLabel, 0, rowIndex);
 
             final Label fromTillLabel = new Label(DateFormatter.toTimeString(work.getStartTime()) + " - "
                   + DateFormatter.toTimeString(work.getEndTime()));
             fromTillLabel.setFont(labelFontNormal);
             fromTillLabel.setWrapText(true);
-            gridPane.add(fromTillLabel, 1, rowIndex);
+            this.gridPane.add(fromTillLabel, 1, rowIndex);
 
             final Label workedHoursLabel = new Label(workedHours);
             workedHoursLabel.setFont(labelFontNormal);
-            gridPane.add(workedHoursLabel, 2, rowIndex);
+            this.gridPane.add(workedHoursLabel, 2, rowIndex);
 
             rowIndex++;
          }
+         // textArea.setText(pr.getNotes(true));
+         bProjectReport.setUserData(pr.getNotes(true));
       }
-      scrollPane.setVvalue(0); // scroll to the top
+      this.scrollPane.setVvalue(0); // scroll to the top
+
+      this.currentDayTimeLabel.setText(DateFormatter.secondsToHHMMSS(currentSeconds));
+      this.currentDayWorkTimeLabel.setText(DateFormatter.secondsToHHMMSS(currentWorkSeconds));
+   }
 
-      currentDayTimeLabel.setText(DateFormatter.secondsToHHMMSS(currentSeconds));
-      currentDayWorkTimeLabel.setText(DateFormatter.secondsToHHMMSS(currentWorkSeconds));
+   private Button createProjectReport() {
+      final Button bProjectReport = new Button("Copy to clipboard");
+      final EventHandler<ActionEvent> eventListener = new EventHandler<ActionEvent>() {
+
+         @Override
+         public void handle(final ActionEvent event) {
+            final Object source = event.getSource();
+            final Button btn = (Button) source;
+            final Object userData = btn.getUserData();
+            final String notes = (String) userData;
+
+            final Clipboard clipboard = Clipboard.getSystemClipboard();
+            final ClipboardContent content = new ClipboardContent();
+            content.putString(notes);
+            clipboard.setContent(content);
+         }
+
+      };
+      bProjectReport.setOnAction(eventListener);
+      return bProjectReport;
    }
 
    public void setModel(final Model model) {
       this.model = model;
 
       // HACK to show calendar from datepicker
       // https://stackoverflow.com/questions/34681975/javafx-extract-calendar-popup-from-datepicker-only-show-popup
-      final DatePickerSkin datePickerSkin = new DatePickerSkin(datePicker);
-      final Callback<DatePicker, DateCell> dayCellFactory = callback -> new DateCell() {
+      final DatePickerSkin datePickerSkin = new DatePickerSkin(this.datePicker);
+      final Callback<DatePicker, DateCell> dayCellFactory = new Callback<DatePicker, DateCell>() {
          @Override
          public void updateItem(final LocalDate item, final boolean empty) {
             super.updateItem(item, empty);
@@ -148,13 +191,12 @@ public void updateItem(final LocalDate item, final boolean empty) {
             }
          }
       };
-
-      datePicker.setDayCellFactory(dayCellFactory);
+      this.datePicker.setDayCellFactory(dayCellFactory);
       final Node popupContent = datePickerSkin.getPopupContent();
-      topBorderPane.setRight(popupContent);
+      this.topBorderPane.setRight(popupContent);
    }
 
    public void update() {
-      updateReport(datePicker.getValue());
+      updateReport(this.datePicker.getValue());
    }
 }

src/test/java/de/doubleslash/keeptime/view/ProjectReportTest.java

@@ -0,0 +1,63 @@
+package de.doubleslash.keeptime.view;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import static org.junit.Assert.assertEquals;
+
+import java.lang.invoke.MethodHandles;
+
+public class ProjectReportTest {
+
+   /** The slf4j-logger for this class. */
+   private static final Logger LOG = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
+
+   private ProjectReport uut;
+
+   @Before
+   public void setUp() throws Exception {
+      this.uut = new ProjectReport(3);
+   }
+
+   @Test
+   public void testAppendToWorkNotes() {
+      this.uut.appendToWorkNotes("note 1 ");
+      this.uut.appendToWorkNotes(ReportController.EMPTY_NOTE);
+      this.uut.appendToWorkNotes("note 2 ");
+      final String expected = "note 1; note 2";
+      assertEquals(expected, this.uut.getNotes(false));
+   }
+
+   @Test
+   public void testAppendToWorkNotesAddNumberOfNotes() {
+      this.uut.appendToWorkNotes("note 1 ");
+      this.uut.appendToWorkNotes(ReportController.EMPTY_NOTE);
+      this.uut.appendToWorkNotes("note 2 ");
+      final String expected = "3 Notes: note 1; note 2";
+      assertEquals(expected, this.uut.getNotes(true));
+   }
+
+   @Test
+   public void testAppendToWorkNotesAddNumberOfNotes_2() {
+      this.uut = new ProjectReport(3);
+      this.uut.appendToWorkNotes("note 1");
+      this.uut.appendToWorkNotes("note 2");
+      this.uut.appendToWorkNotes("note 3");
+      final String expected = "3 Notes: note 1; note 2; note 3";
+      assertEquals(expected, this.uut.getNotes(true));
+   }
+
+   @Test
+   public void testAppendToWorkNotesAddNumberOfNotes_EmptyNotesAtTheEnd() {
+      this.uut = new ProjectReport(4);
+      this.uut.appendToWorkNotes("note 1");
+      this.uut.appendToWorkNotes("note 2");
+      this.uut.appendToWorkNotes(ReportController.EMPTY_NOTE);
+      this.uut.appendToWorkNotes(ReportController.EMPTY_NOTE);
+      final String expected = "4 Notes: note 1; note 2";
+      assertEquals(expected, this.uut.getNotes(true));
+   }
+
+}