Consider directory pattern when checking if a file can be moved #8244

ruoyu-qian · 2021-11-14T23:29:29Z

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.

Settings:

Local files:

When a linked file is in the main file directory, the option “move file to file directory” and “move file to file directory and rename file” are now enabled if users right click on the linked file:

If the linked file is already in the correct file directory pattern, both options are disabled:

Disable MOVE_FILE_TO_FOLDER_AND_RENAME using the same logic as MOVE_FILE_TO_FOLDER

Added Javadoc comment

Adds test to test if isGeneratedPathSameAsOriginal takes into consideration File directory pattern

ruoyu-qian · 2021-11-21T00:08:15Z

There was one unit test failed org.jabref.logic.importer.fileformat.PdfMergeMetadataImporterTest

I looked into it.

Here is what I got:

According to https://www.ebook.de/de/product/28983211/joshua_bloch_effective_java.html, it seems like the actual should be '2018-01-31' rather than '2018-01-01' which was set by the test.

Adds unit tests for FileHelper.equals

Siedlerchr · 2021-11-21T12:01:24Z

HI, thanks for the PR, if you merge in the latest main branch from jabref/jabref the Unit test should be fixed.
But please have a look at the checkstyle (or go to the files changes tab to see the reviewdog)

ruoyu-qian · 2021-11-21T21:14:49Z

HI, thanks for the PR, if you merge in the latest main branch from jabref/jabref the Unit test should be fixed. But please have a look at the checkstyle (or go to the files changes tab to see the reviewdog)

Thanks for the response. I have updated my code according to the checkstyle.

Siedlerchr

Thanks for your PR, codewise lgtm. And also thanks for adding a test case.
Will try this out tomorrow

k3KAW8Pnf7mkmdSMPHz27

Hello @ruoyu-qian!

Thank you for looking into the issue!

I agree that code-wise it looks good and a thank you for the added test cases and JavaDoc!

There are only two required changes, anything that starts with nitpick I'd consider an improvement but not necessary (i.e., I'll approve the PR even if you don't address all/any of them)

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

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

k3KAW8Pnf7mkmdSMPHz27 · 2021-11-24T16:33:00Z

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

+        if (newDir.isEmpty()) {
+            // could not find default path
+            return false;
+        }


This changes the behavior of the method. I am aware that you cannot reach this point in the code if linkedFile.findIn(databaseContext, preferences.getFilePreferences()) is empty, but if someone chooses to use this method for a different purpose in the future, I'd still want it to return true when both
linkedFile.findIn(databaseContext, preferences.getFilePreferences())
and
databaseContext.getFirstExistingFileDir(filePreferences)
are empty (.isEmpty() == true).

Hi @k3KAW8Pnf7mkmdSMPHz27!

Thank you for reviewing my PR. Could you elaborate on this request a bit more? You mentioned two directories are empty. Other than linkedFile.findIn(databaseContext, preferences.getFilePreferences()), what is the other one?

I'm also trying to understand the logic here. For the part you quoted, it means if the user did not set default path in preference, this function would return false, which means the two options would be disabled. Similarly, in line 351-354, if(currentDir.isEmpty()), the function is also going to return false, under the logic that in this case, we are not able to find the current directory of the file. Are you expecting different behaviors for these two cases?

Thanks a lot!

Are you expecting different behaviors for these two cases?

Oups, sorry about both the delayed response and the typo in my comment, I've updated it.
The original comment is regarding changing the behavior of the method when neither is present (no default path and no linked file)

previously the only value returned from the method was this,

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

Line 346 in 69467d3

return OptionalUtil.equals(newDir, currentDir, equality);

and if both

linkedFile.findIn(databaseContext, preferences.getFilePreferences())

databaseContext.getFirstExistingFileDir(preferences.getFilePreferences()

are empty we return

jabref/src/main/java/org/jabref/model/util/OptionalUtil.java

Lines 25 to 26 in 69467d3

if (!left.isPresent()) {

return !right.isPresent();

true.

which means the two options would be disabled

wouldn't this mean that they are enabled since it gets negated later on?

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

Line 305 in 69467d3

&& !linkedFile.isGeneratedPathSameAsOriginal(),

P.S, that would be an awesome test case 😃

Huge thanks for addressing all the nitpicks and yet again, sorry about the delayed response. I'll try to be more responsive if you have follow up questions about this :/

I realized I dodged your question a bit, the short(ish) answer to

I'm also trying to understand the logic here.

is that I believe the separation of concern can be improved upon in the original method

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

Line 334 in 69467d3

public boolean isGeneratedPathSameAsOriginal() {

In my opinion, the "correct" method signature should be public Optional<Boolean> isGeneratedPathSameAsOriginal() {
because the two cases you bring up don't match very well with a true or false value to the question "is the generated path the same as the original path" (since there doesn't exist a generated path or an original path). That is part of what I hoped to bring up in the follow-up issue 😛

In my opinion the check for

if the user did not set default path in preference

and

Similarly, in line 351-354, if(currentDir.isEmpty())

provides improved separation of concern if they are done in

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

Lines 302 to 305 in 69467d3

case MOVE_FILE_TO_FOLDER -> Bindings.createBooleanBinding(

() -> !linkedFile.getFile().isOnlineLink()

&& linkedFile.getFile().findIn(databaseContext, preferencesService.getFilePreferences()).isPresent()

&& !linkedFile.isGeneratedPathSameAsOriginal(),

So that those lines read

is it an online link?

is there a linked file?

can we generate a path?

is the generated path the same as the current path (or does this question not make sense, in which case we are getting an Optional.empty)?

As I am writing this I realize that this is probably quite a bit into the nitpicking territory.

Imo the main thing a PR should do is improve on the code, which your PR does, so view this as a nitpick, would you like to address it otherwise we merge this PR as-is as soon as you get back to us

Addressing the nitpick could either be to change the method signature or to match the true/false behavior of the unmodified method (in which case changing the method signature will be part of the follow-up issue when I have time to write it)

Imo you would match the behavior of the unmodified method if you remove the two if statements

Hi @k3KAW8Pnf7mkmdSMPHz27, I now apologize for my delayed response. Thanks a lot for the detailed explanation. I realized I confused myself a bit earlier.

For the part you quoted, it means if the user did not set default path in preference, this function would return false, which means the two options would be disabled.

This would actually be the opposite to what I previously said. Simply with isGeneratedPathSameAsOriginal() equal to false would mean the two options being enabled rather than disabled.

I'm now getting what you would like to address here and I agree true/false is not a perfect answer to these two cases.

My apology for not responding earlier, but since the PR has been merged, I would be happy to take a look at the follow-up issue when I have time. :)

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

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

k3KAW8Pnf7mkmdSMPHz27 · 2021-11-24T17:26:36Z

Oups, I forgot, could you update the CHANGELOG.md as well? Something along the lines of

- We fixed an issue where the actions to move a file to a directory were incorrectly disabled [#7908](https://github.com/JabRef/jabref/issues/7908)

Or some text that you'd consider to be more descriptive

removed newly added function, which is no longer needed

removed newly added tests for the function no longer exist

ruoyu-qian · 2021-11-26T04:19:46Z

Oups, I forgot, could you update the CHANGELOG.md as well? Something along the lines of
- We fixed an issue where the actions to move a file to a directory were incorrectly disabled [#7908](https://github.com/JabRef/jabref/issues/7908)
Or some text that you'd consider to be more descriptive

Thanks! I have added this fix into the CHANGELOG.md.

calixtus

Codewise looks good to me. If @k3KAW8Pnf7mkmdSMPHz27 approves, then we'll merge.
Thank you for your interest in JabRef. Feel free to send more PRs. :-D

* upstream/main: Consider directory pattern when checking if a file can be moved (#8244) Bump byte-buddy-parent from 1.12.1 to 1.12.2 (#8285) Bump unirest-java from 3.13.3 to 3.13.4 (#8283) Bump checkstyle from 9.1 to 9.2 (#8284) Bump classgraph from 4.8.135 to 4.8.137 (#8282) Do not resize main table columns in search dialog window (#8253) Fix NegativeArraySizeException (#8270) Update deployment.yml TEst Grand unified library properties (GRULPS) (#8264) Fixes RFC fetcher test case (#8271) Update Gradle Wrapper from 7.2 to 7.3 (#8246) Observable Preferences H (WorkingDir, getUser, NameFormatter, Version, SpecialFields) (#8260) Bump checkstyle from 9.0.1 to 9.1 (#8266) Bump mockito-core from 4.0.0 to 4.1.0 (#8267) Bump classgraph from 4.8.130 to 4.8.135 (#8268) Fix some fetcher tests (#8258) Clicking a DOI link in the preview pane no longer crashes (#8255)

* upstream/main: (259 commits) Fix exception on preview style edit and selection (#8293) Fix icon picker excpetion in groups dialog (#8290) Add doc tests (#8242) fix merge conflict Squashed 'buildres/csl/csl-locales/' changes from 0cc3885f61..d5ee85de8e Squashed 'buildres/csl/csl-styles/' changes from 3a6a0a7..3bb4b5f Consider directory pattern when checking if a file can be moved (#8244) Bump byte-buddy-parent from 1.12.1 to 1.12.2 (#8285) Bump unirest-java from 3.13.3 to 3.13.4 (#8283) Bump checkstyle from 9.1 to 9.2 (#8284) Bump classgraph from 4.8.135 to 4.8.137 (#8282) Do not resize main table columns in search dialog window (#8253) Fix NegativeArraySizeException (#8270) Update deployment.yml TEst Grand unified library properties (GRULPS) (#8264) Fixes RFC fetcher test case (#8271) Update Gradle Wrapper from 7.2 to 7.3 (#8246) Observable Preferences H (WorkingDir, getUser, NameFormatter, Version, SpecialFields) (#8260) Bump checkstyle from 9.0.1 to 9.1 (#8266) ...

ruoyu-qian added 7 commits November 14, 2021 16:10

Update LinkedFilesEditor.java

9fb9533

Disable MOVE_FILE_TO_FOLDER_AND_RENAME using the same logic as MOVE_FILE_TO_FOLDER

Update FileHelper.java

b8da9cf

Update LinkedFileViewModel.java

fcbc66f

Update FileHelper.java

b18bbef

Added Javadoc comment

Update LinkedFileViewModelTest.java

b5a1656

Update LinkedFileViewModelTest.java

2498240

Update LinkedFileViewModelTest.java

ced2753

Adds test to test if isGeneratedPathSameAsOriginal takes into consideration File directory pattern

ruoyu-qian marked this pull request as ready for review November 21, 2021 00:05

Update FileUtilTest.java

66a8a7e

Adds unit tests for FileHelper.equals

Update FileUtilTest.java

3e6e977

Siedlerchr approved these changes Nov 21, 2021

View reviewed changes

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

k3KAW8Pnf7mkmdSMPHz27 self-requested a review November 22, 2021 20:36

k3KAW8Pnf7mkmdSMPHz27 requested changes Nov 24, 2021

View reviewed changes

k3KAW8Pnf7mkmdSMPHz27 added status: changes required Pull requests that are not yet complete and removed status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers labels Nov 24, 2021

ruoyu-qian added 8 commits November 25, 2021 22:10

Update LinkedFileViewModelTest.java

a81205e

Update LinkedFileViewModel.java

4f4739f

Update LinkedFileViewModel.java

836819e

Update LinkedFileViewModel.java

4d710ba

Update LinkedFileViewModel.java

03dbdb9

Update FileHelper.java

da804bd

removed newly added function, which is no longer needed

Update FileUtilTest.java

c071548

removed newly added tests for the function no longer exist

Update CHANGELOG.md

f9630b6

Update CHANGELOG.md

ec98c2f

calixtus approved these changes Nov 28, 2021

View reviewed changes

k3KAW8Pnf7mkmdSMPHz27 added status: waiting-for-feedback The submitter or other users need to provide more information about the issue and removed status: changes required Pull requests that are not yet complete labels Nov 29, 2021

k3KAW8Pnf7mkmdSMPHz27 approved these changes Nov 29, 2021

View reviewed changes

Siedlerchr merged commit 217f902 into JabRef:main Nov 29, 2021

k3KAW8Pnf7mkmdSMPHz27 removed the status: waiting-for-feedback The submitter or other users need to provide more information about the issue label Nov 29, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Consider directory pattern when checking if a file can be moved #8244

Consider directory pattern when checking if a file can be moved #8244

ruoyu-qian commented Nov 14, 2021 •

edited

Loading

ruoyu-qian commented Nov 21, 2021

Siedlerchr commented Nov 21, 2021

ruoyu-qian commented Nov 21, 2021

Siedlerchr left a comment

k3KAW8Pnf7mkmdSMPHz27 left a comment

k3KAW8Pnf7mkmdSMPHz27 Nov 24, 2021 •

edited

Loading

ruoyu-qian Nov 26, 2021 •

edited

Loading

k3KAW8Pnf7mkmdSMPHz27 Nov 29, 2021 •

edited

Loading

k3KAW8Pnf7mkmdSMPHz27 Nov 29, 2021 •

edited

Loading

k3KAW8Pnf7mkmdSMPHz27 Nov 29, 2021

k3KAW8Pnf7mkmdSMPHz27 Nov 29, 2021 •

edited

Loading

ruoyu-qian Nov 30, 2021

k3KAW8Pnf7mkmdSMPHz27 commented Nov 24, 2021

ruoyu-qian commented Nov 26, 2021

calixtus left a comment

	case MOVE_FILE_TO_FOLDER -> Bindings.createBooleanBinding(
	() -> !linkedFile.getFile().isOnlineLink()
	&& linkedFile.getFile().findIn(databaseContext, preferencesService.getFilePreferences()).isPresent()
	&& !linkedFile.isGeneratedPathSameAsOriginal(),

Consider directory pattern when checking if a file can be moved #8244

Consider directory pattern when checking if a file can be moved #8244

Conversation

ruoyu-qian commented Nov 14, 2021 • edited Loading

ruoyu-qian commented Nov 21, 2021

Siedlerchr commented Nov 21, 2021

ruoyu-qian commented Nov 21, 2021

Siedlerchr left a comment

Choose a reason for hiding this comment

k3KAW8Pnf7mkmdSMPHz27 left a comment

Choose a reason for hiding this comment

k3KAW8Pnf7mkmdSMPHz27 Nov 24, 2021 • edited Loading

Choose a reason for hiding this comment

ruoyu-qian Nov 26, 2021 • edited Loading

Choose a reason for hiding this comment

k3KAW8Pnf7mkmdSMPHz27 Nov 29, 2021 • edited Loading

Choose a reason for hiding this comment

k3KAW8Pnf7mkmdSMPHz27 Nov 29, 2021 • edited Loading

Choose a reason for hiding this comment

k3KAW8Pnf7mkmdSMPHz27 Nov 29, 2021

Choose a reason for hiding this comment

k3KAW8Pnf7mkmdSMPHz27 Nov 29, 2021 • edited Loading

Choose a reason for hiding this comment

ruoyu-qian Nov 30, 2021

Choose a reason for hiding this comment

k3KAW8Pnf7mkmdSMPHz27 commented Nov 24, 2021

ruoyu-qian commented Nov 26, 2021

calixtus left a comment

Choose a reason for hiding this comment

ruoyu-qian commented Nov 14, 2021 •

edited

Loading

k3KAW8Pnf7mkmdSMPHz27 Nov 24, 2021 •

edited

Loading

ruoyu-qian Nov 26, 2021 •

edited

Loading

k3KAW8Pnf7mkmdSMPHz27 Nov 29, 2021 •

edited

Loading

k3KAW8Pnf7mkmdSMPHz27 Nov 29, 2021 •

edited

Loading

k3KAW8Pnf7mkmdSMPHz27 Nov 29, 2021 •

edited

Loading