Fix Part of Issue#3861: Edit->Replace String #4227

marisuki · 2018-07-22T11:51:30Z

Hi, we fixed part of the Issue#3861, change the Swing Dialog to the JavaFx Dialog: the Edit -> Replace String Dialog, we add 3 files and modified the general control to link the Replace String controller of JavaFX Dialog, and we did not delete the old dialog logic (ReplaceStringDialog.java). The outlook of Dialog hasn't change a lot, and the previous logic is inherited.

The Screenshot is pasted below, just like the design before.

Change in CHANGELOG.md described
Tests created for changes
Manually tested changed features in running JabRef
Screenshots added in PR description (for bigger UI changes)
Ensured that the git commit message is a good one
Check documentation status (Issue created for outdated help page at help.jabref.org?)

Siedlerchr

Thanks again for your contribution!
Generally it goes in the right direction, but some minor improvements and it's good from my point of view.

Siedlerchr · 2018-07-23T12:28:10Z

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

+    private BasePanel basePanel;
+
+    public ReplaceStringAction(BasePanel bPanel) {
+        this.basePanel = bPanel;


Typically you name the parameter also basePanel as the field and use this to distinguish the field from the parameter.
e.g. this.baesPanel = basePanel

Siedlerchr · 2018-07-23T12:39:03Z

src/main/java/org/jabref/gui/ReplaceString.fxml

+
+<DialogPane  maxHeight="-Infinity" maxWidth="-Infinity" minHeight="-Infinity" minWidth="-Infinity" prefHeight="339.0" prefWidth="476.0" xmlns:fx="http://javafx.com/fxml/1" xmlns="http://javafx.com/javafx/8" fx:controller="org.jabref.gui.ReplaceStringView" fx:id="pane">
+  <content>
+    <AnchorPane minHeight="0.0" minWidth="0.0" prefHeight="376.0" prefWidth="552.0">


You better should use a GridPane here for positioning the label and the text fields, that allows them to be properly aligned. Can be easily done using the Scence Builder.
You can also take a look at the FXML here from my other PR #4040 for the db login dialog:
https://github.com/JabRef/jabref/pull/4040/files#diff-200f60f39aab2550ae174ea88d604981

Siedlerchr · 2018-07-23T12:42:19Z

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

+    @FXML
+    public void initialize() {
+        visualizer.setDecoration(new IconValidationDecorator());
+        LimitFieldInput.setEditable(true);


They should already be editable by default.

Siedlerchr · 2018-07-23T12:43:15Z

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

+                counter += replaceField(be, s, ce);
+            }
+        } else {
+            for (String fld : fieldStrings) {


String field : fieldStrings

Siedlerchr · 2018-07-23T12:43:41Z

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

+    public int replaceItem(BibEntry be, NamedCompound ce) {
+        int counter = 0;
+        if (this.AllFieldReplace) {
+            for (String s : be.getFieldNames()) {


Named Compound ce -> NamedCompound compound

And String string : be.getFieldNames...

even better: String fieldName : ...

Siedlerchr · 2018-07-23T12:45:11Z

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

+        int ind;
+        int piv = 0;
+        int counter = 0;
+        int len1 = this.findString.length();


maybe better findStringLength to directly make clear what the variable represent

marisuki · 2018-07-23T13:24:20Z

I am sorry for the bad naming fields, and Thank you for your advice, I will fix them later.

Siedlerchr · 2018-07-23T13:33:46Z

@marisuki you don't have to be sorry or take it personally ;) We really much appreciate your contribution
The reviews are meant to improve and maintain a clean code base, although they sometimes may seem a bit nitpicking. Variable naming is one important part, ideally variables should be self-documenting, e.g. they should be meaningful. Here are some tips. https://dzone.com/articles/best-practices-variable-and

tobiasdiez

Thanks for your contribution. In general, the code looks good but I've some (more or less) minor remarks.

Please also remove the old swing dialog (and make sure it is no longer used).

tobiasdiez · 2018-07-23T13:08:22Z

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

@@ -598,6 +598,7 @@ private Node createToolbar() {
                factory.createIconButton(StandardActions.CUT, new OldDatabaseCommandWrapper(Actions.CUT, this, Globals.stateManager)),
                factory.createIconButton(StandardActions.COPY, new OldDatabaseCommandWrapper(Actions.COPY, this, Globals.stateManager)),
                factory.createIconButton(StandardActions.PASTE, new OldDatabaseCommandWrapper(Actions.PASTE, this, Globals.stateManager)),
+                factory.createIconButton(StandardActions.REPLACE_ALL, new ReplaceStringAction(this.getCurrentBasePanel())),


This adds the action to the toolbar. I don't think that "replace all" is important enough to appear there. Please remove it again.

tobiasdiez · 2018-07-23T13:09:57Z

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

+    @Override
+    public void execute() {
+        BibDatabase database = basePanel.getDatabase();
+        ReplaceStringView rsc = new ReplaceStringView(database, basePanel);


Please don't use abbreviations in names etc. dialog is better.

tobiasdiez · 2018-07-23T13:10:38Z

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

+    public void execute() {
+        BibDatabase database = basePanel.getDatabase();
+        ReplaceStringView rsc = new ReplaceStringView(database, basePanel);
+        rsc.showAndWait().filter(response -> rsc.isExit());


I think there is no need for the filter command.

tobiasdiez · 2018-07-23T13:12:01Z

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

+public class ReplaceStringView extends BaseDialog<Void>
+{
+
+    @FXML public ToggleGroup RadioGroup;


we usual follow camel casing, i.e it should be radioGroup. Please also try to give these fields a more descriptive name (like you did below). Also please make these fields private.

tobiasdiez · 2018-07-23T13:22:37Z

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

+                  .setAsDialogPane(this);
+
+        st = (Stage) this.pane.getScene().getWindow();
+        st.setOnCloseRequest(event -> st.close());


Normally there is no need for handling the close request in a special way. The problem is that you didn't defined a Cancel/Accept button in the dialog. Have a look at the keybindings dialog on how to handle this correctly:

jabref/src/main/java/org/jabref/gui/keyboard/KeyBindingsDialog.fxml

Lines 24 to 26 in d5d67d7

<ButtonType fx:id="resetButton" text="%Reset Bindings" buttonData="LEFT"/>

<ButtonType fx:id="saveButton" text="%Save" buttonData="OK_DONE"/>

<ButtonType fx:constant="CANCEL"/>

jabref/src/main/java/org/jabref/gui/keyboard/KeyBindingsDialogView.java

Lines 48 to 49 in d5d67d7

ControlHelper.setAction(resetButton, getDialogPane(), event -> setDefaultBindings());

ControlHelper.setAction(saveButton, getDialogPane(), event -> saveKeyBindingsAndCloseDialog());

tobiasdiez · 2018-07-23T13:23:30Z

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

+    }
+
+    /**
+     * FXML Message handler


no need to state the obvious in a comment (the method already has a @FXML decoration).

tobiasdiez · 2018-07-23T13:27:31Z

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

+     * FXML Message handler
+    */
+    @FXML
+    public void buttonReplace() {


In the Model-View-ViewModel spirit, the view should never contain any logic. The complete logic should be contained in the ViewModel. The rationale behind this is, that you can test logic in the view model using ordinary (junit) tests without the need to instantiate the ui. Thus, please introduce a new ReplaceStringViewModel and bind its values against the textfields. See, for example,

jabref/src/main/java/org/jabref/gui/keyboard/KeyBindingsDialogView.java

Lines 80 to 84 in d5d67d7

@FXML

private void saveKeyBindingsAndCloseDialog() {

viewModel.saveKeyBindings();

closeDialog();

}

This applies also to all other methods below that contain logic.

tobiasdiez · 2018-07-23T13:29:20Z

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

+        return this.exitSignal;
+    }
+
+    /**


The comments were helpful for the review. Thanks! But they should be removed in the final version.

tobiasdiez · 2018-07-23T13:30:33Z

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

+    public int replaceItem(BibEntry be, NamedCompound ce) {
+        int counter = 0;
+        if (this.AllFieldReplace) {
+            for (String s : be.getFieldNames()) {


even better: String fieldName : ...

marisuki · 2018-07-25T08:33:25Z

Thank you for all the advice above :), and I changed the dialog based on GridPane also the "ViewModel", and modified the miss using of field names, finally deleted the ReplaceStringDialog.java, which is about the old style logic: Swing. I hope it would be better. :)

tobiasdiez

Thanks for the quick follow-up. It clearly moves in the right direction. It would be nice if you could also change the structure to follow the usual MVVM pattern (see below for details).

tobiasdiez · 2018-07-25T18:48:29Z

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

+            stage.close();
+            return;
+        }
+        ReplaceStringViewModel viewModel = new ReplaceStringViewModel(panel, fieldStrings, findString, replaceString, selOnly, allFieldReplace);


This works because the dialog is very simple, but goes against the usual strategy of JavaFX / MVVM. You should add properties in the ViewModel class and bind these properties to the corresponding properties of the controls. Please have a look at the other JavaFX dialogs to see how this is done.

Since this approach is a bit different from what you are used to in the Swing world, let me quickly explain the big overall picture and its advantages. You are probably used to program against the UI controls (as you do here right now): for example, if you want to know the input from the user, you use textbox.getText() to get it. Similarly, for other input controls. This works all nicely until the user reports a bug and you have to write a test for it. The problem you then face is the following: how do I automate the user interaction in my test? There are different approaches to this issue but the general answer is: there is no good solution ;-) UI automation is usually ugly and breaks as soon as you change the design. The idea behind the MVVM approach is that you completely separate the UI from the logic that performs the action. So you create a class (the ViewModel) that holds the state of the UI (i.e. you have string field that corresponds to the user input, but at this point you don't care how or where this string is manipulated). This state in the ViewModel is then bound to the actual userinterface in the View class using JavaFX bindings. In this way, you can test the ViewModel, i.e. the complete logic, without ever knowing how the user interface looks like.

tobiasdiez · 2018-07-25T18:49:02Z

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

+        }
+        ReplaceStringViewModel viewModel = new ReplaceStringViewModel(panel, fieldStrings, findString, replaceString, selOnly, allFieldReplace);
+        viewModel.replace();
+        stage.close();


As BaseDialog derives from Dialog you can simply use close() (without the reference to the stage).

marisuki · 2018-08-07T12:42:05Z

Thank you for your comment ! :) @tobiasdiez , this time I changed the initial part of "view" and add the property bindings to make it a little more MVVM pattern alike ;-). I hope it would be better.

Siedlerchr · 2018-08-08T10:52:06Z

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

+        return selectOnlyProperty;
+    }
+
+    public StringProperty getFieldStringProperty() {


Properties in javafx don't have the traditional get/set prefix. So just rename them as the ones abvove,
e.g. fieldStringProperty and findStringProperty etc

Siedlerchr · 2018-08-08T10:55:59Z

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

+
+        final NamedCompound compound = new NamedCompound(Localization.lang("Replace string"));
+        int counter = 0;
+        if (this.panel == null)


Is this check necessary? You always pass the basePanel as constructor argument.
I would suggest you add an Objects.requireNonNull(basePanel) in the constructor to ensure that the argument is never null. If it is null, it will directly throw and exception which makes it easier to see the real reason,

Yes, you are right :), I forgot to check my logic after converting to a viewModel ;-). Thank You!

Siedlerchr · 2018-08-08T10:57:50Z

From my point of view this looks good. Just some minor code improvements. Let's see what @tobiasdiez thinks about it

tobiasdiez

Looks good to me! Thanks again for the quick follow-ups.

I removed the changelog entries since we will probably only add one big statement announcing that the ui and many dialogs where redesigned. Please resolve the conflicts and then we will merge.

Siedlerchr · 2018-08-10T10:20:44Z

I don't know why, but apparently you still have a conflict in the ReplaceStringDialog

marisuki · 2018-08-10T10:30:59Z

Yeah, I tried every means to avoid the conflict ;-), but it does not work (caused by delete a file) . Does this conflict be inevitable ;-)? Or, do you have any idea to solve it? Thank you.

Siedlerchr · 2018-08-10T10:38:02Z

Okay, I tried around and found a solution:
just do git rm src/main/java/org/jabref/gui/ReplaceStringDialog.java

tobiasdiez · 2018-08-10T10:38:44Z

Something like the following should work:

git pull upstream master (replace "upstream" by whatever you named the JabRef rep)
> git warns about merge conflict
git mergetool
> accept deletion of file
git commit
git push

marisuki · 2018-08-10T10:39:46Z

Thank you, I will give it a try! :)

marisuki · 2018-08-10T13:20:04Z

I think it works! :) this time I use "git pull git@github.com:jabref/jabref.git master" to merge and then remove and push again, there becomes no conflicts :). Thank you! But there shows a failure on build process, need I do something? (Since I did not change the related files.)

Siedlerchr

In general lgtm, you just need to fix the l10n and it should be fine

Siedlerchr · 2018-08-10T14:19:45Z

src/main/java/org/jabref/gui/ReplaceString.fxml

+                                <RowConstraints minHeight="10.0" prefHeight="30.0" vgrow="SOMETIMES"/>
+                                <RowConstraints minHeight="10.0" prefHeight="30.0" vgrow="SOMETIMES"/>
+                            </rowConstraints>
+                            <Label text="Find and Replace"/>


You need to add a % sign in front of the label text, so that it will be recognized as translatable string.
That is probably one of the reasons why the l10n test fails

Siedlerchr · 2018-08-10T14:22:03Z

The Travis CI failed, because of the localiation test. If you click on the Traivs Details and then expand the railed build jpb, you will see the reason. In this case you need to add the missing/remove the obsolete ones from the file. But first you have to add a % sign in front of every translatable label text

marisuki · 2018-08-11T07:10:24Z

Finally! I updated the properties in resources and make the "text" value linked with the file: Jabref_en.properties, also, I deleted the unused key-values (may generated from the previous replace string dialog) to make no obsolete item in the file. And thank you again for your help! :) @Siedlerchr @tobiasdiez

Siedlerchr · 2018-08-11T09:10:23Z

src/main/java/org/jabref/gui/ReplaceString.fxml

+                                <RowConstraints minHeight="10.0" prefHeight="30.0" vgrow="SOMETIMES"/>
+                                <RowConstraints minHeight="10.0" prefHeight="30.0" vgrow="SOMETIMES"/>
+                            </rowConstraints>
+                            <Label text="Find and Replace"/>


I think you missed this one ;) But all others look good

Yeah ;-) I miss it. Thank you for mention! :)

Siedlerchr · 2018-08-11T09:11:23Z

Thank you very much for your contribution! I think you just forgot one little string, if you add this again, then we can finally merge!

Siedlerchr · 2018-08-11T11:16:56Z

As the faling test on Travis CI is not related to your changes I am going to merge it now.

marisuki · 2018-08-11T11:17:55Z

Thank you! :-)

Siedlerchr · 2018-08-11T11:19:49Z

We have to thank for your contribution! 👍 That's a good start. I hope you are interested in contributing some more ;)

marisuki added 3 commits July 22, 2018 19:33

Fix#3861_Edit_ReplaceString

9f5da55

Fix#3861_Edit_ReplaceString_BUILD

44a8efd

Fix#3861_Edit_ReplaceString_BUILDS

90800c3

Siedlerchr requested changes Jul 23, 2018

View reviewed changes

tobiasdiez requested changes Jul 23, 2018

View reviewed changes

FIX#3861ReplaceString_CheckStyle

b601ba6

tobiasdiez requested changes Jul 25, 2018

View reviewed changes

ReplaceStringMVVMPattern

d4f00ad

Fix#3861ReplaceString_ContributeLog

91420f2

Siedlerchr reviewed Aug 8, 2018

View reviewed changes

marisuki and others added 3 commits August 8, 2018 19:25

Fix#3861ReplaceString_Improvements

3300aa5

Fix#3861ReplaceString_checkStyle

3c89dee

Remove changelog entries

6dad44f

tobiasdiez approved these changes Aug 8, 2018

View reviewed changes

Siedlerchr approved these changes Aug 8, 2018

View reviewed changes

marisuki added 5 commits August 9, 2018 15:38

Fix#3861RS_conflicttest

cf7d6b8

Fix#3861RS_conflicttest

609a065

solvemerge

ff7dc5d

Fix#3861ReplaceString_solveConflict

df86b62

Fix#ReplaceString_ChangeConflict

d055f98

Siedlerchr closed this Aug 10, 2018

Siedlerchr reopened this Aug 10, 2018

Fix#3861_conflictsRemoved

8f39723

Siedlerchr approved these changes Aug 10, 2018

View reviewed changes

marisuki added 3 commits August 11, 2018 14:30

Fix#3861_build

48a4c31

Fix#3861_build_addneeded/deleteobsoleteproperties

6c65676

Fix#3861_build_addneeded/deleteobsoleteproperties2

45152d5

Siedlerchr reviewed Aug 11, 2018

View reviewed changes

Siedlerchr approved these changes Aug 11, 2018

View reviewed changes

Fix

b254487

Siedlerchr merged commit 5712665 into JabRef:master Aug 11, 2018

Siedlerchr mentioned this pull request Aug 11, 2018

Convert/rework rest of the Swing Dialogs to javafx #3861

Closed

36 tasks

luizphilipe2 mentioned this pull request Jun 26, 2021

Convert AutoLinkFilesAction to JavafX luizphilipe2/jabref_experiment#32

Open

	<ButtonType fx:id="resetButton" text="%Reset Bindings" buttonData="LEFT"/>
	<ButtonType fx:id="saveButton" text="%Save" buttonData="OK_DONE"/>
	<ButtonType fx:constant="CANCEL"/>

	ControlHelper.setAction(resetButton, getDialogPane(), event -> setDefaultBindings());
	ControlHelper.setAction(saveButton, getDialogPane(), event -> saveKeyBindingsAndCloseDialog());

	@FXML
	private void saveKeyBindingsAndCloseDialog() {
	viewModel.saveKeyBindings();
	closeDialog();
	}

Fix Part of Issue#3861: Edit->Replace String #4227

Fix Part of Issue#3861: Edit->Replace String #4227

Conversation

marisuki commented Jul 22, 2018 • edited Loading

Siedlerchr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marisuki commented Jul 23, 2018

Siedlerchr commented Jul 23, 2018

tobiasdiez left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marisuki commented Jul 25, 2018

tobiasdiez left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marisuki commented Aug 7, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Siedlerchr commented Aug 8, 2018

tobiasdiez left a comment • edited Loading

Choose a reason for hiding this comment

Siedlerchr commented Aug 10, 2018

marisuki commented Aug 10, 2018

Siedlerchr commented Aug 10, 2018 • edited Loading

tobiasdiez commented Aug 10, 2018

marisuki commented Aug 10, 2018

marisuki commented Aug 10, 2018

Siedlerchr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Siedlerchr commented Aug 10, 2018

marisuki commented Aug 11, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Siedlerchr commented Aug 11, 2018

Siedlerchr commented Aug 11, 2018

marisuki commented Aug 11, 2018

Siedlerchr commented Aug 11, 2018

marisuki commented Jul 22, 2018 •

edited

Loading

tobiasdiez left a comment •

edited

Loading

Siedlerchr commented Aug 10, 2018 •

edited

Loading

marisuki commented Aug 11, 2018 •

edited

Loading