12565 refine file exists warning #12625

Oscar2343 · 2025-03-05T16:13:12Z

Refines the "File exists" warning
Adds "Keep both" button with tooltip
Adds "Provide alternative file name" button that triggers a renaming box
Improves title and context message

Closes #12565

Mandatory checks

I own the copyright of the code submitted and I licence it under the MIT license
Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
Screenshots added in PR description (for UI changes)
Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
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.

enhancement: Changed error box dialog to Taget file already exists #3

Suggested filename is generated for displaying when hovering over "Keep both" button. The action of the button has been implemented.

The content of the message box is no longer editable. The look has also been changed for the better.

Triggers the functionality "Rename file to a given name" from context menu. Placeholder triggers action.

Added the buttons without functionality or tool tip #6 closes #6

Add keep both functionality

…le-name Refactor functionality to the button Refactor name of the button from alternativeFileNameButton to provideAltFileNameButton

After merging, the function performRenameWithConflictCheck() was changed to use a different helper function, thereby making the textbox editable once again. This had to be updated.

1. make use of the passed AlertType instead of hardcoding 2. fix bug where pressing the red 'x' button on the textbox does nothing

…-long-filename

Make textbox content un-editable

Fix message box display issue for long file names ( #4 )

… )

…le-name

Add functionality for button "Provide alternative file name"

…ltip-for-keep-both-button

…th-button 13 add hover tooltip for keep both button closes #13

…ot using it anymore

github-actions

Your code currently does not meet JabRef's code guidelines. We use Checkstyle to identify issues. Please carefully follow the setup guide for the codestyle. Afterwards, please run checkstyle locally and fix the issues.
In case of issues with the import order, double check that you activated Auto Import. You can trigger fixing imports by pressing Ctrl+Alt+O to trigger Optimize Imports.

12565 refine file exists warning

github-actions

JUnit tests are failing. In the area "Some checks were not successful", locate "Tests / Unit tests (pull_request)" and click on "Details". This brings you to the test output.
You can then run these tests in IntelliJ to reproduce the failing tests locally. We offer a quick test running howto in the section Final build system checks in our setup guide.

Make tests for performRenameWithConflictCheck()

github-actions

Your code currently does not meet JabRef's code guidelines. We use Checkstyle to identify issues. Please carefully follow the setup guide for the codestyle. Afterwards, please run checkstyle locally and fix the issues.
In case of issues with the import order, double check that you activated Auto Import. You can trigger fixing imports by pressing Ctrl+Alt+O to trigger Optimize Imports.

github-actions

Your code currently does not meet JabRef's code guidelines. We use OpenRewrite to ensure "modern" Java coding practices. The issues found can be automatically fixed. Please execute the gradle task rewriteRun, check the results, commit, and push.
You can check the detailed error output by navigating to your pull request, selecting the tab "Checks", section "Tests" (on the left), subsection "OpenRewrite".

trag-bot · 2025-03-06T21:15:44Z

@trag-bot didn't find any issues in the code! ✅✨

trag-bot · 2025-03-06T21:16:16Z

Pull request summary

Added a "Keep both" option in the file renaming dialog to handle conflicts when a file with the same name already exists.
Introduced a "Provide alternative file name" option for users to specify a new name when a conflict occurs.
Enhanced the dialog interface to display a tooltip with a suggested file name when hovering over the "Keep both" button.
Updated the performRenameWithConflictCheck method to accommodate the new options and improve user interaction during file renaming.
Created unit tests to validate the new renaming functionality, including scenarios for no conflict, overriding, keeping both files, and providing an alternative name.
Modified the localization properties to include new strings related to the file renaming process.
Updated the changelog to reflect the new features and improvements made in this pull request.

tsukii7 · 2025-03-07T11:53:38Z

Updated screenshots for this PR (for UI changes):

Siedlerchr · 2025-03-07T14:27:36Z

src/main/java/org/jabref/gui/fieldeditors/LinkedFileViewModel.java

+            dialogPane.setPrefSize(700, 200);
+            dialogPane.setContent(contentLabel);
+
+            ButtonType overrideButton = new ButtonType("Override", ButtonBar.ButtonData.OTHER);


Add proper Localization for these button types to all buttons as well using Localization.lang

calixtus · 2025-03-08T15:32:34Z

src/main/java/org/jabref/gui/fieldeditors/LinkedFileViewModel.java

+                        if (btnKeepBoth != null) {
+                            Tooltip tooltip = new Tooltip(Localization.lang("New name: %0", suggestedFileName));
+                            tooltip.setShowDelay(Duration.millis(100));
+                            tooltip.setStyle("-fx-max-width: 20px; -fx-wrap-text: true; -fx-background-color: #FFFFE0;");


px values dont scale. use em
dont manually set colors. use constants from base.css

put the whole style into base.css and only set a style class for this tooltip

calixtus · 2025-03-08T15:33:53Z

src/main/resources/csl-styles

calixtus · 2025-03-08T15:34:57Z

src/test/java/org/jabref/gui/fieldeditors/PerformRenameWithConflictCheckTest.java

+
+    @BeforeEach
+    void setUp() {
+        MockitoAnnotations.openMocks(this);


if there is no mock annotation, this line has no effect.

calixtus · 2025-03-08T15:38:22Z

src/test/java/org/jabref/gui/fieldeditors/PerformRenameWithConflictCheckTest.java

+    @AfterEach
+    void tearDown() throws IOException {
+        // Clean up any real files after each test
+        Files.walk(tempDir)
+             .map(Path::toFile)
+             .forEach(file -> {
+                 if (!file.isDirectory()) {
+                     file.delete();
+                 }
+             });
+    }


Doesn't this do JUnit automatically with TempDirs?

ryan-carpenter · 2025-03-13T06:39:00Z

You can simplify the title as
"File already exists"

and clarify the prompt with
"A file with this name already exists"

"Override" is an incorrect term probably meant as "Overwrite", but most examples use
"Replace" and "Keep both" or
"Cancel", "Replace", and "Keep both".

If the last button is important, consider using
"Choose another name"

Oscar2343 and others added 28 commits February 27, 2025 14:27

enhancement: Changed error box dialog to Taget file already exists #3

aacc156

Fix message box display issue for long file names ( #4 )

981fc85

Merge pull request #7 from elwi7331/issue3

1f74bfb

enhancement: Changed error box dialog to Taget file already exists #3

Add initial "keep both" functionality #1

5892a67

Suggested filename is generated for displaying when hovering over "Keep both" button. The action of the button has been implemented.

fix: make content of message box not editable #5

bd6820d

The content of the message box is no longer editable. The look has also been changed for the better.

Add initial "Provide alternative file name" functionality #2

9912201

Triggers the functionality "Rename file to a given name" from context menu. Placeholder triggers action.

Added the buttons without functionality or tool tip #6

248a2f9

Merge pull request #9 from elwi7331/addButtons

6d8f9db

Added the buttons without functionality or tool tip #6 closes #6

Merge dev branch into feature branch #1

df68a80

Merge pull request #10 from elwi7331/1-allow-keep-both

cd65802

Add keep both functionality

Merge branch '12565_refine_file_exists_warning' into 2-provide-alt-fi…

d3439f5

…le-name Refactor functionality to the button Refactor name of the button from alternativeFileNameButton to provideAltFileNameButton

Merge branch '12565_refine_file_exists_warning' into contentUnEditable

81ce88d

fix: fix feature that does not allow dialog box to be edited #5

0423e65

After merging, the function performRenameWithConflictCheck() was changed to use a different helper function, thereby making the textbox editable once again. This had to be updated.

fix: add 2 fixes for showCustomButtonDialogAndWait()

7daa845

1. make use of the passed AlertType instead of hardcoding 2. fix bug where pressing the red 'x' button on the textbox does nothing

Merge branch '12565_refine_file_exists_warning' into 4-fix-messagebox…

3b7dc6a

…-long-filename

Merge pull request #11 from elwi7331/contentUnEditable

2584c56

Make textbox content un-editable

Merge pull request #12 from elwi7331/4-fix-messagebox-long-filename

f990da7

Fix message box display issue for long file names ( #4 )

Added hover tooltip for "Keep Both" button to preview target name ( #13…

4dd5364

… )

Merge branch '12565_refine_file_exists_warning' into 2-provide-alt-fi…

cf4d319

…le-name

Merge pull request #14 from elwi7331/2-provide-alt-file-name

2f79b3e

Add functionality for button "Provide alternative file name"

Fix dialog window size for showing the button name ( #13 )

bfca193

Merge branch '12565_refine_file_exists_warning' into 13-add-hover-too…

80e258c

…ltip-for-keep-both-button

Merge pull request #15 from elwi7331/13-add-hover-tooltip-for-keep-bo…

de2cba2

…th-button 13 add hover tooltip for keep both button closes #13

fix: fixed broken override functionallity and cleaned commented code

f2bf83a

doc: Added our changes to CHANGELOG.md #8

63f6d0e

Merge branch 'main' into 12565_refine_file_exists_warning

e1f61fb

fix: revert changes to showCustomButtonDialogAndWait() since we are n…

ac1fa53

…ot using it anymore

fix: remove unused imports

61065cb

github-actions bot reviewed Mar 5, 2025

View reviewed changes

Merge pull request #16 from elwi7331/12565_refine_file_exists_warning

7befdaf

12565 refine file exists warning

elwi7331 added 2 commits March 5, 2025 22:08

fix checkstyle import order

3025337

fix CHANGELOG markdown bare-url

30ac3c4

github-actions bot reviewed Mar 5, 2025

View reviewed changes

elwi7331 and others added 4 commits March 6, 2025 17:57

fix en_properties

019b53d

Merge branch 'main' into 12565_refine_file_exists_warning

28e050c

tests: add tests for performRenameWithConflictCheck()

efcbedb

Merge pull request #18 from elwi7331/makeTests

fc9365a

Make tests for performRenameWithConflictCheck()

github-actions bot reviewed Mar 6, 2025

View reviewed changes

Fix checkstyle issues in test

f1ff56d

github-actions bot reviewed Mar 6, 2025

View reviewed changes

Fix OpenRewrite import guidelines

945a81f

Siedlerchr requested changes Mar 7, 2025

View reviewed changes

calixtus reviewed Mar 8, 2025

View reviewed changes

src/main/resources/csl-styles

Copy link

Member

calixtus Mar 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Undo

calixtus reviewed Mar 8, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

12565 refine file exists warning #12625

12565 refine file exists warning #12625

Oscar2343 commented Mar 5, 2025 •

edited

Loading

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

trag-bot bot commented Mar 6, 2025

trag-bot bot commented Mar 6, 2025

tsukii7 commented Mar 7, 2025

Siedlerchr Mar 7, 2025 •

edited

Loading

calixtus Mar 8, 2025

calixtus Mar 8, 2025

calixtus Mar 8, 2025

calixtus Mar 8, 2025

calixtus Mar 8, 2025

ryan-carpenter commented Mar 13, 2025

12565 refine file exists warning #12625

Are you sure you want to change the base?

12565 refine file exists warning #12625

Conversation

Oscar2343 commented Mar 5, 2025 • edited Loading

Mandatory checks

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

trag-bot bot commented Mar 6, 2025

trag-bot bot commented Mar 6, 2025

Pull request summary

tsukii7 commented Mar 7, 2025

Siedlerchr Mar 7, 2025 • edited Loading

Choose a reason for hiding this comment

calixtus Mar 8, 2025

Choose a reason for hiding this comment

calixtus Mar 8, 2025

Choose a reason for hiding this comment

calixtus Mar 8, 2025

Choose a reason for hiding this comment

calixtus Mar 8, 2025

Choose a reason for hiding this comment

calixtus Mar 8, 2025

Choose a reason for hiding this comment

ryan-carpenter commented Mar 13, 2025

Oscar2343 commented Mar 5, 2025 •

edited

Loading

Siedlerchr Mar 7, 2025 •

edited

Loading