#11: Implement sorting possibility

pom.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
 
@@ -78,11 +78,6 @@
       <groupId>com.h2database</groupId>
       <artifactId>h2</artifactId>
     </dependency>
-    <dependency>
-      <groupId>org.springframework.boot</groupId>
-      <artifactId>spring-boot-starter-test</artifactId>
-      <scope>test</scope>
-    </dependency>
 
     <dependency>
       <groupId>org.flywaydb</groupId>
@@ -101,6 +96,38 @@
       <artifactId>sonar-maven-plugin</artifactId>
       <version>3.9.1.2184</version>
     </dependency>
+
+    <!-- test dependencies-->
+    <!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-test -->
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-test</artifactId>
+      <version>3.0.3</version>
+      <scope>test</scope>
+    </dependency>
+    <!-- https://mvnrepository.com/artifact/org.testfx/testfx-core -->
+    <dependency>
+      <groupId>org.testfx</groupId>
+      <artifactId>testfx-core</artifactId>
+      <version>4.0.16-alpha</version>
+      <scope>test</scope>
+    </dependency>
+    <!-- https://mvnrepository.com/artifact/org.testfx/testfx-junit5 -->
+    <dependency>
+      <groupId>org.testfx</groupId>
+      <artifactId>testfx-junit5</artifactId>
+      <version>4.0.16-alpha</version>
+      <scope>test</scope>
+    </dependency>
+    <!-- https://mvnrepository.com/artifact/org.testfx/openjfx-monocle -->
+    <dependency>
+      <groupId>org.testfx</groupId>
+      <artifactId>openjfx-monocle</artifactId>
+      <version>jdk-11+26</version>
+      <scope>test</scope>
+    </dependency>
+
+
     <dependency>
       <groupId>org.hamcrest</groupId>
       <artifactId>hamcrest-library</artifactId>
@@ -172,6 +199,20 @@
           <generateGitPropertiesFile>false</generateGitPropertiesFile>
         </configuration>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-surefire-plugin</artifactId>
+        <version>3.0.0-M9</version>
+        <configuration>
+          <systemPropertyVariables>
+            <!-- Execute JavaFX tests headless -->
+            <testfx.robot>glass</testfx.robot>
+            <glass.platform>Monocle</glass.platform>
+            <monocle.platform>Headless</monocle.platform>
+            <testfx.headless>true</testfx.headless>
+          </systemPropertyVariables>
+        </configuration>
+      </plugin>
     </plugins>
   </build>
-</project>
+</project>

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

@@ -24,6 +24,10 @@ private Resources() {
         throw new IllegalStateException("Utility class");
     }
 
+    public static URL getResource(final RESOURCE resource) {
+        return Resources.class.getResource(resource.getResourceLocation());
+    }
+
     public enum RESOURCE {
         /**
          * FONTS
@@ -35,16 +39,16 @@ public enum RESOURCE {
          * LAYOUTS
          **/
         // main
-        FXML_VIEW_LAYOUT("/layouts/ViewLayout.fxml"),
+        FXML_VIEW_LAYOUT("/layouts/MainWindowLayout.fxml"),
         FXML_EDIT_WORKITEM_LAYOUT("/layouts/EditWorkItemDialog.fxml"),
         FXML_FILTER_LAYOUT("/layouts/FiltersLayout.fxml"),
+        FXML_SORTING_LAYOUT("/layouts/SortingLayout.fxml"),
 
         SVG_TRASH_ICON("/svgs/trash-can.svg"),
 
         SVG_PENCIL_ICON("/svgs/pencil.svg"),
 
-        ICON_MAIN("/icons/icon.png")
-        ;
+        ICON_MAIN("/icons/icon.png");
 
         String resourceLocation;
 
@@ -56,8 +60,4 @@ public String getResourceLocation() {
             return resourceLocation;
         }
     }
-
-    public static URL getResource(final RESOURCE resource) {
-        return Resources.class.getResource(resource.getResourceLocation());
-    }
 }

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

@@ -16,20 +16,17 @@
 
 package de.doubleslash.keeptask.controller;
 
-import java.time.LocalDateTime;
-import java.util.List;
-import java.util.function.Predicate;
-
-import javax.annotation.PreDestroy;
-
+import de.doubleslash.keeptask.model.Model;
 import de.doubleslash.keeptask.model.WorkItem;
 import de.doubleslash.keeptask.model.repos.WorkItemRepository;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 
-import de.doubleslash.keeptask.model.Model;
+import javax.annotation.PreDestroy;
+import java.time.LocalDateTime;
+import java.util.List;
 
 @Service
 public class Controller {
@@ -95,11 +92,6 @@ public void shutdown() {
         LOG.info("Controller shutdown");
     }
 
-    public void setFilterPredicate(Predicate<WorkItem> filterPredicate) {
-        LOG.debug("Filters were changed");
-        model.getWorkFilteredList().setPredicate(filterPredicate);
-    }
-
     public void setLatestSelectedProject(String projectName) {
         model.setLatestSelectedProject(projectName);
     }

src/main/java/de/doubleslash/keeptask/controller/SortingController.java

@@ -0,0 +1,93 @@
+package de.doubleslash.keeptask.controller;
+
+import de.doubleslash.keeptask.model.Sorting.DueDate;
+import de.doubleslash.keeptask.model.Sorting.Priority;
+import de.doubleslash.keeptask.model.Sorting.SortingCriteria;
+import de.doubleslash.keeptask.model.Sorting.SortingDirection;
+import de.doubleslash.keeptask.model.WorkItem;
+import javafx.collections.FXCollections;
+import javafx.collections.ListChangeListener;
+import javafx.collections.ObservableList;
+import javafx.collections.transformation.SortedList;
+
+import java.util.Arrays;
+import java.util.Comparator;
+import java.util.List;
+import java.util.stream.Collectors;
+
+public class SortingController {
+    final ObservableList<SortingCriteria> selectedSortingCriteriaList = FXCollections.observableArrayList();
+    private List<SortingCriteria> possibleSortingCriteriaList;
+    private SortedList<WorkItem> sortedWorkItems;
+
+    public SortingController() {
+        possibleSortingCriteriaList = Arrays.asList(
+                new Priority(),
+                new DueDate()
+        );
+        selectedSortingCriteriaList.addListener((ListChangeListener<? super SortingCriteria>) change -> updateComparator());
+    }
+
+    private Comparator<WorkItem> getSortingComparator() {
+        Comparator comparator = null;
+        SortingCriteria sortingCriteria;
+
+        if (selectedSortingCriteriaList.size() > 0) {
+            sortingCriteria = selectedSortingCriteriaList.get(0);
+            comparator = Comparator.comparing(sortingCriteria.getOrderFunction(), Comparator.nullsLast(getComparatorBySortingDirection(sortingCriteria.getSortingDirection())));
+        }
+
+        for (int i = 1; i < selectedSortingCriteriaList.size(); i++) {
+            sortingCriteria = selectedSortingCriteriaList.get(i);
+            comparator = comparator.thenComparing(sortingCriteria.getOrderFunction(), Comparator.nullsLast(getComparatorBySortingDirection(sortingCriteria.getSortingDirection())));
+        }
+        return comparator;
+    }
+
+    private Comparator getComparatorBySortingDirection(final SortingDirection sortingDirection) {
+        Comparator comparator = null;
+
+        switch (sortingDirection) {
+            case Ascending:
+                comparator = Comparator.naturalOrder();
+                break;
+
+            case Descending:
+                comparator = Comparator.reverseOrder();
+                break;
+
+            default:
+                throw new RuntimeException("The selected sorting direction could not be mapped to a comparator.");
+        }
+
+        return comparator;
+    }
+
+    private void updateComparator() {
+        Comparator<WorkItem> comparator = getSortingComparator();
+        sortedWorkItems.setComparator(comparator);
+    }
+
+    public void setWorkItemsToSort(ObservableList<WorkItem> workItemsToSort) {
+        sortedWorkItems = new SortedList<>(workItemsToSort);
+        updateComparator();
+    }
+
+    public SortedList<WorkItem> getSortedWorkItems() {
+        return sortedWorkItems;
+    }
+
+    public void addSortingCriteriaByString(String sortingCriteriaString) {
+        SortingCriteria foundSortingCriteria = possibleSortingCriteriaList.stream().filter(sortingCriteria -> sortingCriteria.getName() == sortingCriteriaString).findFirst().get();
+        selectedSortingCriteriaList.add(foundSortingCriteria);
+    }
+
+    public void removeSortingCriteriaByString(String sortingCriteriaString) {
+        SortingCriteria foundSortingCriteria = possibleSortingCriteriaList.stream().filter(sortingCriteria -> sortingCriteria.getName() == sortingCriteriaString).findFirst().get();
+        selectedSortingCriteriaList.remove(foundSortingCriteria);
+    }
+
+    public List<String> getSortingCriterias() {
+        return possibleSortingCriteriaList.stream().map(SortingCriteria::getName).collect(Collectors.toList());
+    }
+}

src/main/java/de/doubleslash/keeptask/model/Model.java

@@ -16,57 +16,42 @@
 
 package de.doubleslash.keeptask.model;
 
-import de.doubleslash.keeptask.model.repos.WorkItemRepository;
-import javafx.beans.InvalidationListener;
 import javafx.beans.property.ObjectProperty;
 import javafx.beans.property.SimpleObjectProperty;
 import javafx.beans.property.SimpleStringProperty;
 import javafx.beans.property.StringProperty;
-import javafx.beans.value.ChangeListener;
-import javafx.beans.value.ObservableValue;
 import javafx.collections.FXCollections;
 import javafx.collections.ObservableList;
-import javafx.collections.transformation.FilteredList;
+import javafx.scene.paint.Color;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
 
-import javafx.scene.paint.Color;
-
 import java.util.List;
 
 @Component
 public class Model {
 
 
-
     public static final Color ORIGINAL_DEFAULT_BACKGROUND_COLOR = Color.WHITE;
     public final ObjectProperty<Color> defaultBackgroundColor = new SimpleObjectProperty<>(
             ORIGINAL_DEFAULT_BACKGROUND_COLOR);
     private ObservableList<WorkItem> workItems = FXCollections.observableArrayList();
-    private FilteredList<WorkItem> workFilteredItems = new FilteredList(workItems);
-
     private StringProperty latestSelectedProject = new SimpleStringProperty();
 
     @Autowired
     public Model() {
         super();
     }
 
-    public void setWorkItems(List<WorkItem> workItems) {
-        this.workItems.clear();
-        this.workItems.addAll(workItems);
-    }
-
     public ObservableList<WorkItem> getWorkItems() {
         return FXCollections.unmodifiableObservableList(workItems);
     }
 
-    public ObservableList<WorkItem> getWorkFilteredItems() {
-        return FXCollections.unmodifiableObservableList(workFilteredItems);
+    public void setWorkItems(List<WorkItem> workItems) {
+        this.workItems.clear();
+        this.workItems.addAll(workItems);
     }
 
-    public FilteredList<WorkItem> getWorkFilteredList(){return workFilteredItems;}
-
     public StringProperty latestSelectedProjectProperty() {
         return latestSelectedProject;
     }

src/main/java/de/doubleslash/keeptask/model/Sorting/DueDate.java

@@ -0,0 +1,17 @@
+package de.doubleslash.keeptask.model.Sorting;
+
+import de.doubleslash.keeptask.model.WorkItem;
+
+import java.util.function.Function;
+
+public class DueDate extends SortingCriteria {
+    public DueDate() {
+        name = "Due Date";
+        sortingDirection = SortingDirection.Ascending;
+    }
+
+    @Override
+    public Function<WorkItem, ? extends Comparable> getOrderFunction() {
+        return WorkItem::getDueDateTime;
+    }
+}

src/main/java/de/doubleslash/keeptask/model/Sorting/Priority.java

@@ -0,0 +1,17 @@
+package de.doubleslash.keeptask.model.Sorting;
+
+import de.doubleslash.keeptask.model.WorkItem;
+
+import java.util.function.Function;
+
+public class Priority extends SortingCriteria {
+    public Priority() {
+        name = "Priority";
+        sortingDirection = SortingDirection.Descending;
+    }
+
+    @Override
+    public Function<WorkItem, ? extends Comparable> getOrderFunction() {
+        return WorkItem::getPriority;
+    }
+}

src/main/java/de/doubleslash/keeptask/model/Sorting/SortingCriteria.java

@@ -0,0 +1,24 @@
+package de.doubleslash.keeptask.model.Sorting;
+
+import de.doubleslash.keeptask.model.WorkItem;
+
+import java.util.function.Function;
+
+public abstract class SortingCriteria {
+    protected String name = null;
+    protected SortingDirection sortingDirection = SortingDirection.Ascending;
+
+    public String getName() {
+        return name;
+    }
+
+    public SortingDirection getSortingDirection() {
+        return sortingDirection;
+    }
+
+    public void setSortingDirection(SortingDirection sortingDirection) {
+        this.sortingDirection = sortingDirection;
+    }
+
+    public abstract Function<WorkItem, ? extends Comparable> getOrderFunction();
+}

src/main/java/de/doubleslash/keeptask/model/Sorting/SortingDirection.java

@@ -0,0 +1,5 @@
+package de.doubleslash.keeptask.model.Sorting;
+
+public enum SortingDirection {
+    Ascending, Descending
+}