added ability to edit individual Work Items closes #28 closes #29

Author: JSchraff

pom.xml

@@ -64,6 +64,12 @@
       <artifactId>spring-boot-starter-test</artifactId>
       <scope>test</scope>
     </dependency>
+    
+    <dependency>
+        <groupId>no.tornado</groupId>
+        <artifactId>tornadofx-controls</artifactId>
+        <version>1.0.3</version>
+    </dependency>
 
     <dependency>
       <groupId>org.flywaydb</groupId>

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

@@ -39,11 +39,13 @@ public enum RESOURCE {
       FXML_REPORT("/layouts/report.fxml"),
       FXML_ABOUT("/layouts/about.fxml"),
       FXML_MANAGE_PROJECT("/layouts/manage-project.fxml"),
+      FXML_MANAGE_WORK("/layouts/manage-work.fxml"),
 
       // icon
       ICON_MAIN("/icons/icon.png"),
 
       ;
+
       String resourceLocation;
 
       private RESOURCE(final String resourceLocation) {

src/main/java/de/doubleslash/keeptime/controller/Controller.java

@@ -184,17 +184,40 @@ public void editProject(final Project projectToBeUpdated, final Project newValue
       model.getProjectRepository().saveAll(changedProjects);
    }
 
+   public void editWork(final Work workToBeEdited, final Work newValuedWork) {
+      LOG.info("Changing work '{}' to '{}'.", workToBeEdited, newValuedWork);
+      int index = model.getPastWorkItems().size() - 1;
+      if (model.getPastWorkItems().contains(workToBeEdited)) {
+         index = model.getPastWorkItems().indexOf(workToBeEdited);
+         model.getPastWorkItems().remove(index);
+      }
+
+      workToBeEdited.setCreationDate(newValuedWork.getCreationDate());
+      workToBeEdited.setStartTime(newValuedWork.getStartTime());
+      workToBeEdited.setEndTime(newValuedWork.getEndTime());
+      workToBeEdited.setNotes(newValuedWork.getNotes());
+      workToBeEdited.setProject(newValuedWork.getProject());
+
+      final LocalDate dateNow = dateProvider.dateTimeNow().toLocalDate();
+      if (dateNow.equals(workToBeEdited.getCreationDate())) {
+         model.getPastWorkItems().add(index, workToBeEdited);
+      }
+
+      model.getWorkRepository().save(workToBeEdited);
+
+   }
+
    /**
     * Changes the indexes of the originalList parameter to have a consistent order.
     * 
     * @param originalList
-    *           list of all projects to adapt the indexes for
+    *                          list of all projects to adapt the indexes for
     * @param changedProject
-    *           the project which has changed which already has the new index
+    *                          the project which has changed which already has the new index
     * @param oldIndex
-    *           the old index of the changed project
+    *                          the old index of the changed project
     * @param newIndex
-    *           the new index of the changed project (which the projects also already has)
+    *                          the new index of the changed project (which the projects also already has)
     * @return all projects whose index has been adapted
     */
    List<Project> resortProjectIndexes(final List<Project> originalList, final Project changedProject,
@@ -231,9 +254,9 @@ List<Project> resortProjectIndexes(final List<Project> originalList, final Proje
     * Decreases all indexes by one, after the removed index
     * 
     * @param originalList
-    *           list of all projects to adapt the indexes for
+    *                        list of all projects to adapt the indexes for
     * @param removedIndex
-    *           the index which has been removed
+    *                        the index which has been removed
     * @return all projects whose index has been adapted
     */
    List<Project> adaptProjectIndexesAfterRemoving(final List<Project> originalList, final int removedIndex) {
@@ -298,4 +321,5 @@ public long calcSeconds(final List<Work> workItems) {
 
       return seconds;
    }
+
 }

src/main/java/de/doubleslash/keeptime/model/Work.java

@@ -45,7 +45,8 @@ public class Work {
    @Lob
    private String notes;
 
-   public Work() {}
+   public Work() {
+   }
 
    public Work(final LocalDate creationDate, final LocalDateTime startTime, final LocalDateTime endTime,
          final Project project, final String notes) {
@@ -89,6 +90,10 @@ public Project getProject() {
       return project;
    }
 
+   public void setProject(final Project project) {
+      this.project = project;
+   }
+
    public String getNotes() {
       return notes;
    }
@@ -97,4 +102,10 @@ public void setNotes(final String notes) {
       this.notes = notes;
    }
 
+   @Override
+   public String toString() {
+      return "Work [id=" + id + ", creationDate=" + creationDate + ", startTime=" + startTime + ", endTime=" + endTime
+            + ", projectName=" + project.getName() + ", notes=" + notes + "]";
+   }
+
 }

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

@@ -0,0 +1,121 @@
+// Copyright 2019 doubleSlash Net Business GmbH
+//
+// This file is part of KeepTime.
+// KeepTime is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+package de.doubleslash.keeptime.view;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import de.doubleslash.keeptime.model.Model;
+import de.doubleslash.keeptime.model.Project;
+import de.doubleslash.keeptime.model.Work;
+import javafx.fxml.FXML;
+import javafx.scene.control.ComboBox;
+import javafx.scene.control.DatePicker;
+import javafx.scene.control.ListCell;
+import javafx.scene.control.ListView;
+import javafx.scene.control.TextField;
+import javafx.scene.layout.GridPane;
+import javafx.util.Callback;
+import javafx.util.StringConverter;
+import tornadofx.control.DateTimePicker;
+
+public class ManageWorkController {
+
+   private static final Logger LOG = LoggerFactory.getLogger(ManageWorkController.class);
+
+   private Model model;
+
+   @FXML
+   private GridPane grid;
+
+   @FXML
+   private DateTimePicker startTimePicker;
+
+   @FXML
+   private DateTimePicker endTimePicker;
+
+   @FXML
+   private DatePicker creationDatePicker;
+
+   @FXML
+   private TextField noteTextBox;
+
+   @FXML
+   private ComboBox<Project> projectComboBox;
+
+   public void setModel(final Model model) {
+      this.model = model;
+   }
+
+   public void initializeWith(final Work work) {
+      LOG.info("Setting values.");
+      startTimePicker.setDateTimeValue(work.getStartTime());
+      startTimePicker.setFormat("yyyy-MM-dd HH:mm:ss");
+      endTimePicker.setDateTimeValue(work.getEndTime());
+      endTimePicker.setFormat("yyyy-MM-dd HH:mm:ss");
+      creationDatePicker.setValue(work.getCreationDate());
+      noteTextBox.setText(work.getNotes());
+      projectComboBox.getItems().addAll(model.getAvailableProjects());
+
+      projectComboBox.setCellFactory(new Callback<ListView<Project>, ListCell<Project>>() {
+
+         @Override
+         public ListCell<Project> call(final ListView<Project> l) {
+            return new ListCell<Project>() {
+
+               @Override
+               protected void updateItem(final Project item, final boolean empty) {
+                  super.updateItem(item, empty);
+                  if (item == null || empty) {
+                     setGraphic(null);
+                  } else {
+                     setText(item.getName());
+                  }
+               }
+            };
+         }
+      });
+
+      projectComboBox.setConverter(new StringConverter<Project>() {
+
+         @Override
+         public String toString(final Project project) {
+            if (project == null) {
+               return null;
+            } else {
+               return project.getName();
+            }
+         }
+
+         @Override
+         public Project fromString(final String string) {
+            return null;
+         }
+      });
+
+      projectComboBox.getSelectionModel().select(work.getProject());
+
+   }
+
+   public Work getWorkFromUserInput() {
+
+      return new Work(creationDatePicker.getValue(), startTimePicker.getDateTimeValue(),
+            endTimePicker.getDateTimeValue(), projectComboBox.getSelectionModel().getSelectedItem(),
+            noteTextBox.getText());
+   }
+
+}

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

@@ -16,9 +16,11 @@
 
 package de.doubleslash.keeptime.view;
 
+import java.io.IOException;
 import java.time.LocalDate;
 import java.util.Comparator;
 import java.util.List;
+import java.util.Optional;
 import java.util.SortedSet;
 import java.util.TreeSet;
 import java.util.stream.Collectors;
@@ -30,21 +32,29 @@
 
 import de.doubleslash.keeptime.common.DateFormatter;
 import de.doubleslash.keeptime.common.FontProvider;
+import de.doubleslash.keeptime.common.Resources;
+import de.doubleslash.keeptime.common.Resources.RESOURCE;
 import de.doubleslash.keeptime.controller.Controller;
+import de.doubleslash.keeptime.exceptions.FXMLLoaderException;
 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.fxml.FXMLLoader;
 import javafx.geometry.Insets;
 import javafx.geometry.Pos;
 import javafx.scene.Node;
 import javafx.scene.canvas.Canvas;
 import javafx.scene.control.Button;
+import javafx.scene.control.ButtonType;
+import javafx.scene.control.ContextMenu;
 import javafx.scene.control.DateCell;
 import javafx.scene.control.DatePicker;
+import javafx.scene.control.Dialog;
 import javafx.scene.control.Label;
+import javafx.scene.control.MenuItem;
 import javafx.scene.control.ScrollPane;
 import javafx.scene.input.Clipboard;
 import javafx.scene.input.ClipboardContent;
@@ -53,6 +63,7 @@
 import javafx.scene.layout.GridPane;
 import javafx.scene.layout.HBox;
 import javafx.scene.shape.Circle;
+import javafx.stage.Stage;
 import javafx.util.Callback;
 
 public class ReportController {
@@ -93,6 +104,8 @@ public class ReportController {
 
    private Controller controller;
 
+   private Stage stage;
+
    private ColorTimeLine colorTimeLine;
 
    @FXML
@@ -186,6 +199,29 @@ private void updateReport(final LocalDate dateToShow) {
             workedHoursLabel.setFont(FontProvider.getDefaultFont());
             this.gridPane.add(workedHoursLabel, 2, rowIndex);
 
+            final HBox clickDummy = new HBox();
+            final ContextMenu contextMenu = new ContextMenu();
+            final MenuItem editMenuItem = new MenuItem("edit");
+
+            editMenuItem.setOnAction(e -> {
+               LOG.info("Edit work");
+               final Dialog<Work> dialog = setupEditWorkDialog("Edit work", "Edit work ", work);
+
+               final Optional<Work> result = dialog.showAndWait();
+
+               result.ifPresent(editedWork -> {
+                  controller.editWork(work, editedWork);
+                  this.update();
+               });
+            });
+
+            contextMenu.getItems().add(editMenuItem);
+
+            clickDummy.setOnContextMenuRequested(
+                  event -> contextMenu.show(clickDummy, event.getScreenX(), event.getScreenY()));
+
+            this.gridPane.add(clickDummy, 0, rowIndex, 3, 1);
+
             rowIndex++;
          }
          bProjectReport.setUserData(pr.getNotes(true));
@@ -197,6 +233,43 @@ private void updateReport(final LocalDate dateToShow) {
 
    }
 
+   private Dialog<Work> setupEditWorkDialog(final String title, final String headerText, final Work work) {
+      final Dialog<Work> dialog = new Dialog<>();
+
+      dialog.initOwner(stage);
+      dialog.setTitle(title);
+      dialog.setHeaderText(headerText);
+      dialog.getDialogPane().getButtonTypes().addAll(ButtonType.OK, ButtonType.CANCEL);
+
+      final GridPane grid = setUpEditWorkGridPane(work, dialog);
+      dialog.getDialogPane().setContent(grid);
+
+      return dialog;
+   }
+
+   private GridPane setUpEditWorkGridPane(final Work work, final Dialog<Work> dialog) {
+      final GridPane grid;
+      final FXMLLoader loader = new FXMLLoader(Resources.getResource(RESOURCE.FXML_MANAGE_WORK));
+      try {
+         grid = loader.load();
+      } catch (final IOException e) {
+         throw new FXMLLoaderException("Error while loading '" + Resources.RESOURCE.FXML_MANAGE_WORK + "'.", e);
+      }
+      final ManageWorkController manageWorkController = loader.getController();
+      manageWorkController.setModel(model);
+      manageWorkController.initializeWith(work);
+
+      dialog.setResultConverter(dialogButton -> {
+         if (dialogButton == ButtonType.OK) {
+            return manageWorkController.getWorkFromUserInput();
+         }
+         // TODO: Do you really want to return null?
+         return null;
+      });
+
+      return grid;
+   }
+
    private Button createProjectReport() {
       final Button bProjectReport = new Button("Copy to clipboard");
       final EventHandler<ActionEvent> eventListener = new EventHandler<ActionEvent>() {
@@ -248,4 +321,8 @@ public void update() {
    public void setController(final Controller controller) {
       this.controller = controller;
    }
+
+   public void setStage(final Stage stage) {
+      this.stage = stage;
+   }
 }

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

@@ -381,9 +381,10 @@ private void loadSubStages() {
          reportController = fxmlLoader.getController();
          reportController.setModel(model);
          reportController.setController(controller);
+
          reportStage = new Stage();
          reportStage.initModality(Modality.APPLICATION_MODAL);
-
+         reportController.setStage(reportStage);
          final Scene reportScene = new Scene(root);
          reportScene.setOnKeyPressed(ke -> {
             if (ke.getCode() == KeyCode.ESCAPE) {