Merge pull request #145 from qbicsoftware/release/1.0.0-beta.3

Release/1.0.0 beta.3

Author: jenniferboedker

.qube.yml

@@ -3,7 +3,7 @@ full_name: Jennifer Bödker
 email: [email protected]
 project_name: Sample Tracking Status Overview
 project_short_description: Gives a visual overview of sample statuses
-version: 1.0.1-beta
+version: 1.0.0-beta.3
 domain: portlet
 language: groovy
 project_slug: Sample_Tracking_Status_Overview

CHANGELOG.rst

@@ -4,6 +4,25 @@ Changelog
 
 This project adheres to `Semantic Versioning <https://semver.org/>`_.
 
+1.0.0-beta.3 (2021-11-08)
+---------------------------
+
+**Added**
+
+* Introduce split panel for showing failing QC samples (`#140 <https://github.com/qbicsoftware/sample-tracking-status-overview/issues/140>`_)
+
+* Minor refactoring of the page organisation (`#141 <https://github.com/qbicsoftware/sample-tracking-status-overview/pull/141>`_)
+
+* Add filtering to the ProjectId and ProjectTitle Columns (`#142 <https://github.com/qbicsoftware/sample-tracking-status-overview/pull/142>`_)
+
+**Fixed**
+
+* More informative message after subscription change (`#144 <https://github.com/qbicsoftware/sample-tracking-status-overview/pull/141>`_)
+
+**Dependencies**
+
+**Deprecated**
+
 1.0.1-beta (2021-10-28)
 ---------------------------
 
@@ -27,6 +46,8 @@ This project adheres to `Semantic Versioning <https://semver.org/>`_.
 
 * Unsubscribe from project (`#129 <https://github.com/qbicsoftware/sample-tracking-status-overview/issues/129>`_)
 
+* Samples with failed QC are shown to the user directly after selecting a project (`#138 <https://github.com/qbicsoftware/sample-tracking-status-overview/pull/138>`_)
+
 **Fixed**
 
 * Show correct number of passing QC numbers (`#130 <https://github.com/qbicsoftware/sample-tracking-status-overview/pull/130>`_)

docs/conf.py

@@ -57,9 +57,9 @@
 # the built documents.
 #
 # The short X.Y version.
-version = '1.0.1-beta'
+version = '1.0.0-beta.3'
 # The full version, including alpha/beta/rc tags.
-release = '1.0.1-beta'
+release = '1.0.0-beta.3'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

pom.xml

@@ -10,7 +10,7 @@
   </modules>
   <artifactId>sample-tracking-status-overview</artifactId>
   <groupId>life.qbic</groupId>
-  <version>1.0.1-beta</version> <!-- <<QUBE_FORCE_BUMP>> -->
+  <version>1.0.0-beta.3</version> <!-- <<QUBE_FORCE_BUMP>> -->
   <name>Sample Tracking Status Overview</name>
   <url>http://github.com/qbicsoftware/sample-tracking-status-overview</url>
   <description>Gives a visual overview of sample statuses</description>

qube.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.0.1-beta
+current_version = 1.0.0-beta.3
 
 [bumpversion_files_whitelisted]
 dot_qube = .qube.yml

sample-tracking-status-overview-app/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>sample-tracking-status-overview</artifactId>
         <groupId>life.qbic</groupId>
-        <version>1.0.1-beta</version> <!-- <<QUBE_FORCE_BUMP>> -->
+        <version>1.0.0-beta.3</version> <!-- <<QUBE_FORCE_BUMP>> -->
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <packaging>war</packaging>
@@ -16,7 +16,7 @@
         <dependency>
             <groupId>life.qbic</groupId>
             <artifactId>sample-tracking-status-overview-domain</artifactId>
-            <version>1.0.1-beta</version> <!-- <<QUBE_FORCE_BUMP>> -->
+            <version>1.0.0-beta.3</version> <!-- <<QUBE_FORCE_BUMP>> -->
             <scope>compile</scope>
         </dependency>
         <dependency>

sample-tracking-status-overview-app/src/main/groovy/life/qbic/portal/sampletracking/components/GridUtils.groovy

@@ -0,0 +1,71 @@
+package life.qbic.portal.sampletracking.components
+
+import com.vaadin.data.provider.ListDataProvider
+import com.vaadin.shared.ui.ValueChangeMode
+import com.vaadin.ui.Grid
+import com.vaadin.ui.TextField
+import com.vaadin.ui.components.grid.HeaderRow
+import com.vaadin.ui.themes.ValoTheme
+import org.apache.commons.lang3.StringUtils
+
+/**
+ * A helper class with static utility functions for Vaadin Grids.
+ *
+ * @since 1.0.0
+ */
+class GridUtils {
+
+    /**
+     * Provides a filter field into a header row of a grid for a given column.
+     *
+     * The current implementation filters for content that contains the filter criteria in the
+     * column values and ignores the case.
+     *
+     * @param dataProvider The grid's {@link ListDataProvider}
+     * @param column The column to add the filter to
+     * @param headerRow The{@link com.vaadin.ui.components.grid.HeaderRow} of the {@link Grid}, where the filter input field is added
+     */
+    static <T> void setupColumnFilter(ListDataProvider<T> dataProvider,
+                                      Grid.Column<T, String> column,
+                                      HeaderRow headerRow) {
+        TextField filterTextField = new TextField()
+        filterTextField.addValueChangeListener(event -> {
+            dataProvider.addFilter(element ->
+                    StringUtils.containsIgnoreCase(column.getValueProvider().apply(element), filterTextField.getValue())
+            )
+        })
+        styleFilterTextField(filterTextField, column.getCaption())
+        headerRow.getCell(column).setComponent(filterTextField)
+    }
+
+    private static void styleFilterTextField(TextField filterTextField, String columnCaption) {
+        filterTextField.setValueChangeMode(ValueChangeMode.EAGER)
+        filterTextField.addStyleName(ValoTheme.TEXTFIELD_TINY)
+        filterTextField.setPlaceholder("Filter by $columnCaption")
+        filterTextField.setSizeFull()
+    }
+
+    /**
+     * Provides filter fields into the header row of the provided grid for multiple column identifiers
+     *
+     * The current implementation filters for content that contains the filter criteria in the
+     * column values and ignores the case.
+     *
+     * @param grid The vaadin grid {@link Grid} for which the filter columns should be added
+     * @param columnIdentifiers The column identifiers specifying into which column a filter should be added
+     */
+    static <T> void setupFilters(Grid<T> grid, Collection<String> columnIdentifiers) {
+        HeaderRow customerFilterRow
+        if (grid.headerRowCount > 1) {
+            customerFilterRow = grid.getHeaderRow(1)
+        } else {
+            customerFilterRow = grid.appendHeaderRow()
+        }
+        ListDataProvider<T> gridDataProvider = grid.getDataProvider() as ListDataProvider<T>
+        columnIdentifiers.forEach { String columnId ->
+            setupColumnFilter(gridDataProvider,
+                    grid.getColumn(columnId),
+                    customerFilterRow)
+        }
+    }
+}

sample-tracking-status-overview-app/src/main/groovy/life/qbic/portal/sampletracking/components/projectoverview/ProjectOverviewView.groovy

@@ -1,20 +1,21 @@
 package life.qbic.portal.sampletracking.components.projectoverview
 
-
 import com.vaadin.data.provider.DataProvider
 import com.vaadin.data.provider.ListDataProvider
 import com.vaadin.event.selection.SingleSelectionEvent
 import com.vaadin.icons.VaadinIcons
 import com.vaadin.server.FileDownloader
 import com.vaadin.server.StreamResource
 import com.vaadin.shared.ui.ContentMode
+import com.vaadin.shared.ui.MarginInfo
 import com.vaadin.shared.ui.grid.HeightMode
 import com.vaadin.ui.*
 import com.vaadin.ui.Grid.Column
 import com.vaadin.ui.themes.ValoTheme
 import groovy.util.logging.Log4j2
 import life.qbic.portal.sampletracking.Constants
 import life.qbic.portal.sampletracking.communication.notification.NotificationService
+import life.qbic.portal.sampletracking.components.GridUtils
 import life.qbic.portal.sampletracking.components.projectoverview.download.DownloadProjectController
 import life.qbic.portal.sampletracking.components.projectoverview.samplelist.FailedQCSamplesView
 import life.qbic.portal.sampletracking.components.projectoverview.samplelist.ProjectOverviewController
@@ -32,7 +33,7 @@ import life.qbic.portal.sampletracking.components.projectoverview.subscribe.Subs
  *
 */
 @Log4j2
-class ProjectOverviewView extends VerticalLayout{
+class ProjectOverviewView extends VerticalLayout {
 
     private final ProjectOverviewViewModel viewModel
     private final DownloadProjectController downloadProjectController
@@ -42,6 +43,8 @@ class ProjectOverviewView extends VerticalLayout{
     private final ProjectOverviewController projectOverviewController
 
     private Grid<ProjectSummary> projectGrid
+    private HorizontalSplitPanel splitPanel
+    private static final Collection<String> columnIdsWithFilters = ["ProjectCode", "ProjectTitle"]
 
     final static int MAX_CODE_COLUMN_WIDTH = 400
     final static int MAX_STATUS_COLUMN_WIDTH = 200
@@ -61,12 +64,40 @@ class ProjectOverviewView extends VerticalLayout{
 
     private void initLayout(){
         Label titleLabel = new Label("Project Overview")
-        titleLabel.addStyleName(ValoTheme.LABEL_LARGE)
+        titleLabel.addStyleName(ValoTheme.LABEL_HUGE)
+
+        Label spacerLabel = new Label("&nbsp;", ContentMode.HTML)
+
         setupProjects()
-        HorizontalLayout buttonBar = setupButtonLayout()
-        failedQCSamplesView.setVisible(false)
+
+        HorizontalLayout projectButtonBar = setupButtonLayout()
+        VerticalLayout projectLayout = new VerticalLayout(projectButtonBar,projectGrid)
+        projectLayout.setMargin(false)
+
+        splitPanel = createSplitLayout(projectLayout,failedQCSamplesView)
+        failedQCSamplesView.addVisibilityChangeListener({ splitPanel.splitPosition = it.newValue ? 65 : 100 })
+
+        connectFailedQcSamplesView()
         bindManifestToProjectSelection()
-        this.addComponents(titleLabel,buttonBar, projectGrid, failedQCSamplesView)
+
+        this.addComponents(titleLabel, spacerLabel, splitPanel)
+    }
+
+    private void connectFailedQcSamplesView() {
+        FailedQCSamplesView samplesView = failedQCSamplesView
+        showWhenFailingSamplesExist(samplesView)
+
+        viewModel.addPropertyChangeListener("selectedProject", {
+            Optional<ProjectSummary> selectedProject = Optional.ofNullable(viewModel.selectedProject)
+            selectedProject.ifPresent({
+                if(failingSamplesExist()){
+                    loadFailedQcSamples(it)
+                }
+            })
+            if (!selectedProject.isPresent()) {
+                samplesView.reset()
+            }
+        })
     }
 
     private HorizontalLayout setupButtonLayout() {
@@ -75,37 +106,17 @@ class ProjectOverviewView extends VerticalLayout{
 
         Button postmanLink = setUpLinkButton()
         Button downloadManifestAction = setupDownloadButton()
-        Button showDetails = setupShowDetails()
         CheckBox subscriptionCheckBox = setupSubscriptionCheckBox()
-        buttonBar.addComponents(showDetails, downloadManifestAction, postmanLink, subscriptionCheckBox)
+
+        buttonBar.addComponents(downloadManifestAction, postmanLink, subscriptionCheckBox)
         buttonBar.setComponentAlignment(postmanLink, Alignment.MIDDLE_CENTER)
         buttonBar.setComponentAlignment(subscriptionCheckBox, Alignment.MIDDLE_CENTER)
         return buttonBar
     }
 
-    private Button setupShowDetails(){
-        Button detailsButton = new Button("Show Details")
-        detailsButton.setIcon(VaadinIcons.INFO_CIRCLE)
-        detailsButton.setEnabled(false)
-
-        projectGrid.addSelectionListener({
-            failedQCSamplesView.setVisible(false)
-
-            if(viewModel.selectedProject && viewModel.selectedProject.samplesQc.failingSamples > 0){
-                detailsButton.setEnabled(true)
-            }else{
-                detailsButton.setEnabled(false)
-            }
-        })
-
-        detailsButton.addClickListener({
-            if(viewModel.selectedProject){
-                projectOverviewController.getFailedQcSamples(viewModel.selectedProject.code)
-                failedQCSamplesView.setVisible(true)
-            }
-        })
-
-        return detailsButton
+    private void loadFailedQcSamples(ProjectSummary projectSummary) {
+        String code = projectSummary.getCode()
+        projectOverviewController.getFailedQcSamples(code)
     }
 
     private Button setUpLinkButton(){
@@ -145,7 +156,7 @@ class ProjectOverviewView extends VerticalLayout{
 
         CheckBox subscriptionCheckBox = new CheckBox("Subscribe")
         subscriptionCheckBox.setVisible(false)
-        enableWhenProjectIsSelected(subscriptionCheckBox)
+        showWhenProjectIsSelected(subscriptionCheckBox)
         subscriptionCheckBox.setValue(false)
         viewModel.addPropertyChangeListener("selectedProject", {
             Optional<ProjectSummary> selectedProjectSummary = Optional.ofNullable(it.newValue as ProjectSummary)
@@ -201,7 +212,6 @@ class ProjectOverviewView extends VerticalLayout{
                 selectedItem.ifPresent({
                     selectProject(it)
                 })
-
             }
         })
         viewModel.updatedProjectsChannel.subscribe({updatedProjectCode ->
@@ -229,12 +239,18 @@ class ProjectOverviewView extends VerticalLayout{
         }
     }
 
+    private static HorizontalSplitPanel createSplitLayout(Layout leftComponent, VerticalLayout rightComponent){
+        HorizontalSplitPanel splitPanel = new HorizontalSplitPanel(leftComponent,rightComponent)
+        splitPanel.setSplitPosition(100)
+        rightComponent.setMargin(new MarginInfo(false,false,false,true))
+
+        return splitPanel
+    }
+
     private void bindManifestToProjectSelection() {
         viewModel.addPropertyChangeListener("selectedProject", { tryToDownloadManifest() })
     }
 
-
-
     private void clearProjectSelection() {
         viewModel.selectedProject = null
     }
@@ -285,9 +301,9 @@ class ProjectOverviewView extends VerticalLayout{
         if( viewModel.selectedProject ) {
             projectGrid.select(viewModel.selectedProject)
         }
+        GridUtils.setupFilters(projectGrid, columnIdsWithFilters)
     }
 
-
     private void tryToDownloadManifest() {
         Optional<ProjectSummary> selectedSummary = Optional.empty()
         try {
@@ -323,14 +339,29 @@ class ProjectOverviewView extends VerticalLayout{
         return isAvailable
     }
 
-    private void enableWhenProjectIsSelected(CheckBox checkBox) {
-        viewModel.addPropertyChangeListener("selectedProject") {
+    private void showWhenProjectIsSelected(CheckBox checkBox) {
+        viewModel.addPropertyChangeListener("selectedProject", {
             if(viewModel.selectedProject){
              checkBox.setVisible(true)
             }else{
               checkBox.setVisible(false)
             }
-        }
+        })
+    }
+
+    private void showWhenFailingSamplesExist(Component component) {
+        component.setVisible(failingSamplesExist())
+        viewModel.addPropertyChangeListener("selectedProject", {
+            component.setVisible(failingSamplesExist())
+        })
+    }
+
+    private boolean failingSamplesExist() {
+        Optional<ProjectSummary> selectedProject = Optional.ofNullable(viewModel.selectedProject)
+        boolean hasFailingSamples = selectedProject
+                .map({ it.samplesQc.failingSamples > 0 })
+                .orElse(false)
+        return hasFailingSamples
     }
 
     private void subscribeToProject(String projectCode) {
@@ -354,16 +385,13 @@ class ProjectOverviewView extends VerticalLayout{
      * @param sampleCount The total number of samples registered
      */
     private static State determineCompleteness(SampleCount sampleCount) {
-        if (sampleCount.failingSamples > 0){
+        if (sampleCount.failingSamples > 0) {
             return State.FAILED
-        }
-        else if (sampleCount.passingSamples == sampleCount.totalSampleCount) {
+        } else if (sampleCount.passingSamples == sampleCount.totalSampleCount) {
             return State.COMPLETED
-        }
-        else if (sampleCount.passingSamples < sampleCount.totalSampleCount) {
+        } else if (sampleCount.passingSamples < sampleCount.totalSampleCount) {
             return State.IN_PROGRESS
-        }
-        else {
+        } else {
             //unexpected!!
             throw new IllegalStateException("status count $sampleCount.passingSamples must not be greater total count $sampleCount.totalSampleCount")
         }