Add confirmation dialog for empty entries in JabRef #8218

ruoyu-qian · 2021-11-08T03:27:31Z

Fixes #8096
Logic:

When a user wants to close certain library/JabRef app, detect if there are any empty entries.
If there is one or more empty entries, give a dialog box for user to choose if they want to delete or keep empty entries.
If "Delete empty entries" is chosen, delete the empty entries; If "Keep empty entries" is chosen, keep the empty entries. If "Return to JabRef" is chosen, return to JabRef.

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, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

Siedlerchr · 2021-11-08T08:05:07Z

src/main/java/org/jabref/model/database/BibDatabaseContext.java

+     * @return true if the database has any empty entries; otherwise false
+     */
+    public boolean hasEmptyEntries() {
+        for (BibEntry currentEntry: this.getEntries()) {


You can use streams here:
return this.getEntries().stream().anyMatch(entry->entry.getFields().isEmpty())

Thank you! I have updated the function.

Siedlerchr · 2021-11-09T08:12:39Z

src/main/java/org/jabref/gui/JabRefFrame.java

+        if (response.isPresent() && response.get().equals(deleteEmptyEntries)) {
+            // The user wants to delete.
+            try {
+                for (BibEntry currentEntry : new ArrayList<BibEntry>(context.getEntries())) {


Why do you create a new array list here?

If I don't create a new array list, removing the empty entry from the original array list will lead to out of index error.

Are there any other approaches you would recommend? @Siedlerchr

Ah yes, now I see it. It's because you can't remove an entry from a collection over that you are still iterating. So your solutions is fine.
Please add one more test where you check and verify that the context.getEntries() is indeed entry
e.e.g assertEquals(Collections.emptyList(), context.getEntries())

Yes, exactly.
In @test withEmptyEntry() I have added a delete command and a test to check the database is empty after deleting. Would this be sufficient, or would you like me to add a test to actually test the function confirmEmptyEntry() that I added in JabRefFrame.java? Thanks!

Siedlerchr

Please add one more test to verify that the database is empty after deleting

add one more test to verify that the database is empty after deleting

koppor · 2021-11-13T11:35:37Z

@ruoyu-qian Congratulations for your first GitHub contribution ever. Thank you for choosing JabRef! We are looking forward to more contributions!

ruoyu-qian · 2021-11-14T03:05:35Z

@ruoyu-qian Congratulations for your first GitHub contribution ever. Thank you for choosing JabRef! We are looking forward to more contributions!

@koppor Thank you! Thanks a lot to @Siedlerchr for reviewing my PR. I feel like JabRef is a very supportive community. It's been a great experience! I look forward to working with you all more. 😄

* upstream/main: (181 commits) Add of ADRs 22 and 23 (#8256) [Bot] Update CSL styles (#8245) Replace styfle/cancel-workflow-action@0.9.1 by GitHub's "concurrency" feature (#8243) Bump gittools/actions from 0.9.10 to 0.9.11 (#8248) Bump commons-cli from 1.4 to 1.5.0 (#8250) Bump byte-buddy-parent from 1.12.0 to 1.12.1 (#8249) Bump antlr4 from 4.9.2 to 4.9.3 (#8251) Bump archunit-junit5-api from 0.21.0 to 0.22.0 (#8252) Fix search: NOT binds more than AND (#8241) New Crowdin updates (#8240) Make PdfGrobiImporterTest as FetcherTest Oobranch g : add actions (#7792) Fix mixed CRLF / CR (#8238) Fix "Library has changed externally" with CRLF markers (#8239) Fix for issue 8198, 8133 (#8229) Added more unit tests in AuthorTest (#8214) Add confirmation dialog for empty entries in JabRef (#8218) Fix entry editor column visibility (#8232) Use regexp to remove non-ASCII characters from DOI and inform user when data for valid DOI does not exist #8127 (#8228) Fix exception for search flags (#8237) ...

ruoyu-qian added 20 commits November 4, 2021 21:02

Create EmptyEntryCleanup.java

55be347

Update CleanupWorker.java

ef96463

Update CleanupPreset.java

572a345

Update BibDatabaseContext.java

274b357

Add function showEmptyEntryWarning()

3985260

Update JabRefFrame.java

518d6fc

Update JabRefFrame.java

932bf8b

Update JabRefFrame.java

05d700a

Update JabRefFrame.java

2a23bad

Update JabRefFrame.java

2e5604a

Delete previous change in LibraryTab.java

12137ed

Delete previous change in CleanupPreset.java

61a8144

Delete previous change in CleanupWorker.java

e8ea0b2

Delete EmptyEntryCleanup.java

f0dce18

Update CHANGELOG.md

440bb42

Update CHANGELOG.md

1d58043

Update JabRef_en.properties

554ed0d

Update CHANGELOG.md

f711365

Update JabRef_en.properties

e99c931

Update JabRefFrame.java

dac8dc9

ruoyu-qian marked this pull request as ready for review November 8, 2021 04:33

ruoyu-qian added 2 commits November 8, 2021 01:01

Add Unit tests for hasEmptyEntries() in BibDatabaseTest.java

011091d

Add Javadoc comment

845aa1e

Siedlerchr reviewed Nov 8, 2021

View reviewed changes

Update BibDatabaseContext.java

65ae566

Siedlerchr reviewed Nov 9, 2021

View reviewed changes

Siedlerchr approved these changes Nov 12, 2021

View reviewed changes

Siedlerchr added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Nov 12, 2021

Update BibDatabaseTest.java

6e19d11

add one more test to verify that the database is empty after deleting

koppor approved these changes Nov 13, 2021

View reviewed changes

koppor merged commit c593f35 into JabRef:main Nov 13, 2021

ruoyu-qian mentioned this pull request Dec 5, 2021

No information about "empty entry" available JabRef/user-documentation#374

Open

mlep mentioned this pull request Apr 5, 2022

An empty entry can still be added without warning message (and lead to an error when compiling) #8645

Closed

2 tasks

ThiloteE mentioned this pull request Jul 15, 2022

Fix for #8645: Refactor of empty entry handling #8981

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add confirmation dialog for empty entries in JabRef #8218

Add confirmation dialog for empty entries in JabRef #8218

ruoyu-qian commented Nov 8, 2021 •

edited

Loading

Siedlerchr Nov 8, 2021

ruoyu-qian Nov 9, 2021

Siedlerchr Nov 9, 2021

ruoyu-qian Nov 9, 2021

ruoyu-qian Nov 11, 2021

Siedlerchr Nov 12, 2021

ruoyu-qian Nov 13, 2021 •

edited

Loading

Siedlerchr left a comment •

edited

Loading

koppor commented Nov 13, 2021

ruoyu-qian commented Nov 14, 2021 •

edited

Loading

Add confirmation dialog for empty entries in JabRef #8218

Add confirmation dialog for empty entries in JabRef #8218

Conversation

ruoyu-qian commented Nov 8, 2021 • edited Loading

Siedlerchr Nov 8, 2021

Choose a reason for hiding this comment

ruoyu-qian Nov 9, 2021

Choose a reason for hiding this comment

Siedlerchr Nov 9, 2021

Choose a reason for hiding this comment

ruoyu-qian Nov 9, 2021

Choose a reason for hiding this comment

ruoyu-qian Nov 11, 2021

Choose a reason for hiding this comment

Siedlerchr Nov 12, 2021

Choose a reason for hiding this comment

ruoyu-qian Nov 13, 2021 • edited Loading

Choose a reason for hiding this comment

Siedlerchr left a comment • edited Loading

Choose a reason for hiding this comment

koppor commented Nov 13, 2021

ruoyu-qian commented Nov 14, 2021 • edited Loading

ruoyu-qian commented Nov 8, 2021 •

edited

Loading

ruoyu-qian Nov 13, 2021 •

edited

Loading

Siedlerchr left a comment •

edited

Loading

ruoyu-qian commented Nov 14, 2021 •

edited

Loading