Fix for issue #4652: Add Find Unlinked Files Filter based on Date #7846

gdrosos · 2021-06-22T23:10:53Z

Hello everyone, we made 3 additions to the Find Unlinked Files Function as following:

Firstly, for each file we showed to the relevant Dialog near its name the date of the last modification.

Secondly, we added a Date-based Filter to show only specific files based on the date of the last modification.

Finally, we made it possible to sort the files based on the date of the last modification.

For future steps, we plan to:

Address the potential requested changes by the reviewers.
Add Unit Tests to the created code where applicable.

Fixes #4652

Change in CHANGELOG.md described in a way that is understandable for the average user (if applicable)
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
Screenshots added in PR description (for UI changes)
Checked documentation: Is the information available and up to date? If not created an issue at https://github.com/JabRef/user-documentation/issues or, even better, submitted a pull request to the documentation repository.

Change getDisplayText to display the last edited time

The DateRange enum contains the different date range names to be displayed on the newly created "select by date" filter on the unlinked files dialog window.

Create the ViewModel object for the ExternalFilesDate field that will be an applicable search filter for external files.

The method has similar functionality to getDisplayText with the difference that it also returns the last edited date of a file to be displayed.

The file contains the implementation of the functionality for filtering the unlinked files by specified filters.

Create the view model representing a selected sort-by method.

Add the methods for sorting the unlinked local files based on last edited date.

Import java.util.List that was used, but not imported.

Siedlerchr

some optimizations for the test code, otherwise lgtm

src/test/java/org/jabref/gui/externalfiles/FileFilterUtilsTest.java

* Use streams instead of creating new arrays. * Use assertEquals and assertNotEquals instead of assertArrayEquals and assertFalse.

calixtus

4 issues I saw to make the changes more simple.

src/main/java/org/jabref/gui/externalfiles/ExternalFilesDateViewModel.java

src/main/java/org/jabref/gui/externalfiles/FileFilterUtils.java

src/main/java/org/jabref/gui/externalfiles/FileSortViewModel.java

gliargovas · 2021-06-27T20:54:29Z

Hello @Siedlerchr and @calixtus , we have addressed your suggestions. We are open to any further remarks.

calixtus

Some more small ideas

calixtus · 2021-06-27T21:28:14Z

src/main/java/org/jabref/gui/externalfiles/UnlinkedFilesDialogViewModel.java

+        this.dateFilterList = FXCollections.observableArrayList(
+            DateRange.ALL_TIME,
+            DateRange.YEAR,
+            DateRange.MONTH,
+            DateRange.WEEK,
+            DateRange.DAY);


Suggested change

this.dateFilterList = FXCollections.observableArrayList(

DateRange.ALL_TIME,

DateRange.YEAR,

DateRange.MONTH,

DateRange.WEEK,

DateRange.DAY);

this.dateFilterList = FXCollections.observableArrayList(DateRange.values());

calixtus · 2021-06-27T21:28:43Z

src/main/java/org/jabref/gui/externalfiles/UnlinkedFilesDialogViewModel.java

+        this.fileSortList = FXCollections.observableArrayList(
+            ExternalFileSorter.DEFAULT,
+            ExternalFileSorter.DATE_ASCENDING,
+            ExternalFileSorter.DATE_DESCENDING);


Suggested change

this.fileSortList = FXCollections.observableArrayList(

ExternalFileSorter.DEFAULT,

ExternalFileSorter.DATE_ASCENDING,

ExternalFileSorter.DATE_DESCENDING);

this.fileSortList = FXCollections.observableArrayList(ExternalFileSorter.values());

Co-authored-by: Carl Christian Snethlage <50491877+calixtus@users.noreply.github.com>

…sDialogViewModel Co-authored-by: Carl Christian Snethlage <50491877+calixtus@users.noreply.github.com>

gdrosos · 2021-06-27T21:50:29Z

Some more small ideas

Thanks @calixtus for the quick response, we commited your suggestions and we rearranged the sequence of DateTime Enums in order to have the correct order when the values() method is invoked

calixtus · 2021-06-27T22:15:45Z

src/main/java/org/jabref/gui/externalfiles/FileFilterUtils.java

+            LOGGER.error("Could not retrieve file time", e);
+        }
+        LocalDateTime localDateTime = lastEditedTime
+                .toInstant()


IntelliJ complains here, that toInstant may throw a NPE. This seems possible, since you don't return when a IOException occurs. Is that something we should think about?

Thanks @calixtus , so maybe we need to place the code in a try catch-block to handle the NPE or in the same try catch block so when an IO Exception occurs the toInstant() method call is omited.

Well, there must be a value returned from this method... Which one, if getLastModifiedTime fails?
Today? null?

Yes, sorry you are right, we will return LocalDateTime.now() when an IOException occurs

calixtus

Looks good to me now. Thanks!

gdrosos · 2021-06-27T22:23:52Z

Looks good to me now. Thanks!

Thank you very much @calixtus, we also face a problem regarding passing the github action check regarding the creation of the installer and portable version for macOS. Thanks in advance.

Siedlerchr · 2021-06-28T12:35:12Z

LGTM as well! You can ignore the mac, the action doesn't work on forks because it requires access to some secrets (and that are not avaiable on forks)

gdrosos · 2021-06-28T12:41:34Z

LGTM as well! You can ignore the mac, the action doesn't work on forks because it requires access to some secrets (and that are not avaiable on forks)

Thank you very much, so the only thing left now is to deal with the NPE @calixtus mentioned?

…me() method

calixtus · 2021-06-28T13:34:34Z

As soon as the tests are green, we can merge. Thanks!

gdrosos · 2021-06-28T13:44:51Z

Guys me and @gliargovas want to thank you very much for the cooperation and the help you offered us to deal with this issue, everything was great. We are more than happy to be part of this Community!

calixtus · 2021-06-28T13:47:04Z

You're welcome. We really appreciate your work you put in JabRef.

Siedlerchr · 2021-06-28T13:54:05Z

I can only fully agree with @calixtus, this was excellent work! We hope to see more from you in the future! :)

* upstream/main: (26 commits) Add unit test to four test classes (#7651) Fix IEEE test (#7852) New Crowdin updates (#7859) Fix markdown syntax of ADRs add missing l10n (#7857) New Crowdin updates (#7847) Bump mockito-core from 3.11.1 to 3.11.2 (#7856) Bump checkstyle from 8.43 to 8.44 (#7855) Fix for issue #4652: Add Find Unlinked Files Filter based on Date (#7846) Fix for entering a backslash in the custom entry preview dialog (#7851) Fixed INSPIREFetcherTest Fixed TitleFetcherTest Ignore baeldung.com and tldrlegal.com from out link checks New Crowdin updates (#7845) New Crowdin updates (#7843) Refactoring and addition of unit tests (#7597) CLI option to write XMP metadata to pdfs (#7814) Add query validation for web search (#7809) change eclipse default output dir (#7842) Bump lucene-queryparser from 8.8.2 to 8.9.0 (#7835) ...

…kflow-for-slr-search * upstream/main: (31 commits) New translations JabRef_en.properties (German) (#7868) Fix test "higherTrustLevelWins()" (#7866) Change WM_CLASS to jabref (#7858) [Bot] Update CSL styles (#7865) Add unit test to four test classes (#7651) Fix IEEE test (#7852) New Crowdin updates (#7859) Fix markdown syntax of ADRs add missing l10n (#7857) New Crowdin updates (#7847) Bump mockito-core from 3.11.1 to 3.11.2 (#7856) Bump checkstyle from 8.43 to 8.44 (#7855) Fix for issue #4652: Add Find Unlinked Files Filter based on Date (#7846) Fix for entering a backslash in the custom entry preview dialog (#7851) Fixed INSPIREFetcherTest Fixed TitleFetcherTest Ignore baeldung.com and tldrlegal.com from out link checks New Crowdin updates (#7845) New Crowdin updates (#7843) Refactoring and addition of unit tests (#7597) ... # Conflicts: # src/main/resources/l10n/JabRef_en.properties

gliargovas and others added 30 commits May 5, 2021 17:48

Display last edited date along with filename

afd9ba6

Change getDisplayText to display the last edited time

Create DateRange object

3d5c737

The DateRange enum contains the different date range names to be displayed on the newly created "select by date" filter on the unlinked files dialog window.

Add ExternalFilesDateViewModel

318e79d

Create the ViewModel object for the ExternalFilesDate field that will be an applicable search filter for external files.

Add getDisplayTextWithEditDate method

59d5bfd

The method has similar functionality to getDisplayText with the difference that it also returns the last edited date of a file to be displayed.

Create File Date Combobox

aed71d4

Fix typo

be11dab

Add Functionality of FileDateCombo box

3b9d286

Add ViewModel Functionality for the Last Edited Filter

3f7aa41

Modify Unlinked Files Crawler to support Last Edited Filter

cb303c5

Add FileFilterUtils.java

04962f0

The file contains the implementation of the functionality for filtering the unlinked files by specified filters.

Add "Last Edited:" to l10n package

c6625bf

add External File Sorter Class

ec54bc3

Add FileSortViewModel

c099ce0

Create the view model representing a selected sort-by method.

Add Sort by combo box

e6e15d5

Add fileSortCombo view side code

1e9ec13

Add sort by date functionality methods

639aa8e

Add the methods for sorting the unlinked local files based on last edited date.

Add View Model implementation for sort by date field

291d645

Add Sort Support to Crawler

ba7116e

Rename filteredFiles variable in Crawler

87c0111

Add "Sort by:" to en localiztion properties

7cc1c50

Fix syntax error

4b3038e

Import java.util.List that was used, but not imported.

Fix typo in File Filter Utils

7a53d2e

Fix incorrect reverse sorting method call

18b6df6

Convert days to months in isDuringLastMonth method

757a8a7

Add Unit Tests for isDuring methods in FileFilterUtils

22aef66

Improve code quality of FileFilterUtilsTest

f49a0ae

make variables of FileFilterUtilsTest final

07d5174

Leave new line to all files

6791053

Update Changelog

02017c3

Merge branch 'main' into fix-for-issue-4652

7fcfff6

Siedlerchr requested changes Jun 27, 2021

View reviewed changes

gdrosos and others added 4 commits June 27, 2021 21:16

Use TempDir at Unit Tests

6e721c5

Remove the use of java.io.File

a495c16

Use streams for sort tests

a6f91c0

* Use streams instead of creating new arrays. * Use assertEquals and assertNotEquals instead of assertArrayEquals and assertFalse.

Remove unused imports

5136b1f

calixtus requested changes Jun 27, 2021

View reviewed changes

gliargovas added 2 commits June 27, 2021 23:46

Use enums directly for filter and sort fields

0b459a6

Remove redundant default cases from FileFilterUtils.java

226010b

calixtus reviewed Jun 27, 2021

View reviewed changes

gdrosos and others added 3 commits June 28, 2021 00:45

replace DateRange enums with values() method

1e2f8c4

Co-authored-by: Carl Christian Snethlage <50491877+calixtus@users.noreply.github.com>

Replace ExternalFileSorter enums with values() method in UnlinkedFile…

3334398

…sDialogViewModel Co-authored-by: Carl Christian Snethlage <50491877+calixtus@users.noreply.github.com>

Place the correct order in DateTime enums

4ae48a1

calixtus reviewed Jun 27, 2021

View reviewed changes

calixtus approved these changes Jun 27, 2021

View reviewed changes

Siedlerchr approved these changes Jun 28, 2021

View reviewed changes

Make sure a value is returned when an IOException occurs in getFileTi…

4a00080

…me() method

calixtus approved these changes Jun 28, 2021

View reviewed changes

calixtus merged commit b4b3075 into JabRef:main Jun 28, 2021

koppor removed the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Jul 4, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix for issue #4652: Add Find Unlinked Files Filter based on Date #7846

Fix for issue #4652: Add Find Unlinked Files Filter based on Date #7846

gdrosos commented Jun 22, 2021 •

edited

Loading

Siedlerchr left a comment

calixtus left a comment

gliargovas commented Jun 27, 2021

calixtus left a comment

calixtus Jun 27, 2021

calixtus Jun 27, 2021

gdrosos commented Jun 27, 2021 •

edited

Loading

calixtus Jun 27, 2021

gdrosos Jun 27, 2021 •

edited

Loading

calixtus Jun 28, 2021

gdrosos Jun 28, 2021

calixtus left a comment

gdrosos commented Jun 27, 2021 •

edited

Loading

Siedlerchr commented Jun 28, 2021

gdrosos commented Jun 28, 2021 •

edited

Loading

calixtus commented Jun 28, 2021

gdrosos commented Jun 28, 2021

calixtus commented Jun 28, 2021

Siedlerchr commented Jun 28, 2021

Fix for issue #4652: Add Find Unlinked Files Filter based on Date #7846

Fix for issue #4652: Add Find Unlinked Files Filter based on Date #7846

Conversation

gdrosos commented Jun 22, 2021 • edited Loading

Siedlerchr left a comment

Choose a reason for hiding this comment

calixtus left a comment

Choose a reason for hiding this comment

gliargovas commented Jun 27, 2021

calixtus left a comment

Choose a reason for hiding this comment

calixtus Jun 27, 2021

Choose a reason for hiding this comment

calixtus Jun 27, 2021

Choose a reason for hiding this comment

gdrosos commented Jun 27, 2021 • edited Loading

calixtus Jun 27, 2021

Choose a reason for hiding this comment

gdrosos Jun 27, 2021 • edited Loading

Choose a reason for hiding this comment

calixtus Jun 28, 2021

Choose a reason for hiding this comment

gdrosos Jun 28, 2021

Choose a reason for hiding this comment

calixtus left a comment

Choose a reason for hiding this comment

gdrosos commented Jun 27, 2021 • edited Loading

Siedlerchr commented Jun 28, 2021

gdrosos commented Jun 28, 2021 • edited Loading

calixtus commented Jun 28, 2021

gdrosos commented Jun 28, 2021

calixtus commented Jun 28, 2021

Siedlerchr commented Jun 28, 2021

gdrosos commented Jun 22, 2021 •

edited

Loading

gdrosos commented Jun 27, 2021 •

edited

Loading

gdrosos Jun 27, 2021 •

edited

Loading

gdrosos commented Jun 27, 2021 •

edited

Loading

gdrosos commented Jun 28, 2021 •

edited

Loading