Fix Tagsfield in Keyword editor (#13858)

* Add failing test

* Fix StringConverter

* CHANGELOG.md

* Cleanup

Author: calixtus

CHANGELOG.md

@@ -131,6 +131,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 - We fixed an issue where theme or font size are not respected for all dialogs [#13558](https://github.com/JabRef/jabref/issues/13558)
 - We removed unnecessary spacing and margin in the AutomaticFieldEditor. [#13792](https://github.com/JabRef/jabref/pull/13792)
 - We fixed an issue where global search auto-completion only worked after switching tabs. [#11428](https://github.com/JabRef/jabref/issues/11428)
+- We fixed an issue where hierarchical keywords would only show the parent keyword in the entry editor. [#11390](https://github.com/JabRef/jabref/issues/11390)
 
 ### Removed
 

jabgui/src/main/java/org/jabref/gui/fieldeditors/KeywordsEditor.java

@@ -109,17 +109,17 @@ public KeywordsEditor(Field field,
         keywordTagsField.setTagViewFactory(this::createTag);
 
         keywordTagsField.setSuggestionProvider(request -> viewModel.getSuggestions(request.getUserText()));
-        keywordTagsField.setConverter(viewModel.getStringConverter());
+        keywordTagsField.setConverter(KeywordsEditorViewModel.getStringConverter());
         keywordTagsField.setMatcher((keyword, searchText) -> keyword.get().toLowerCase().startsWith(searchText.toLowerCase()));
         keywordTagsField.setComparator(Comparator.comparing(Keyword::get));
 
-        keywordTagsField.setNewItemProducer(searchText -> viewModel.getStringConverter().fromString(searchText));
+        keywordTagsField.setNewItemProducer(searchText -> KeywordsEditorViewModel.getStringConverter().fromString(searchText));
 
         keywordTagsField.setShowSearchIcon(false);
-        keywordTagsField.setOnMouseClicked(event -> keywordTagsField.getEditor().requestFocus());
+        keywordTagsField.setOnMouseClicked(_ -> keywordTagsField.getEditor().requestFocus());
         keywordTagsField.getEditor().getStyleClass().clear();
         keywordTagsField.getEditor().getStyleClass().add("tags-field-editor");
-        keywordTagsField.getEditor().focusedProperty().addListener((observable, oldValue, newValue) -> keywordTagsField.pseudoClassStateChanged(FOCUSED, newValue));
+        keywordTagsField.getEditor().focusedProperty().addListener((_, _, newValue) -> keywordTagsField.pseudoClassStateChanged(FOCUSED, newValue));
 
         String keywordSeparator = String.valueOf(viewModel.getKeywordSeparator());
         keywordTagsField.getEditor().setOnKeyReleased(event -> {
@@ -129,7 +129,7 @@ public KeywordsEditor(Field field,
             }
         });
 
-        this.viewModel.keywordListProperty().addListener((observable, oldValue, newValue) -> {
+        this.viewModel.keywordListProperty().addListener((_, _, _) -> {
             if (keywordTagsField.getTags().size() < 2) {
                 isSortedTagsField = false;
             } else if ((Comparators.isInOrder(keywordTagsField.getTags(), Comparator.comparing(Keyword::get))) || isSortedTagsField) {
@@ -159,7 +159,7 @@ private Node createTag(Keyword keyword) {
         Label tagLabel = new Label();
         tagLabel.setText(keywordTagsField.getConverter().toString(keyword));
         tagLabel.setGraphic(IconTheme.JabRefIcons.REMOVE_TAGS.getGraphicNode());
-        tagLabel.getGraphic().setOnMouseClicked(event -> keywordTagsField.removeTags(keyword));
+        tagLabel.getGraphic().setOnMouseClicked(_ -> keywordTagsField.removeTags(keyword));
         tagLabel.setContentDisplay(ContentDisplay.RIGHT);
         ContextMenu contextMenu = new ContextMenu();
         ActionFactory factory = new ActionFactory();
@@ -198,8 +198,8 @@ private Node createTag(Keyword keyword) {
             draggedKeyword = Optional.of(keyword);
             event.consume();
         });
-        tagLabel.setOnDragEntered(event -> tagLabel.setStyle("-fx-background-color: lightgrey;"));
-        tagLabel.setOnDragExited(event -> tagLabel.setStyle(""));
+        tagLabel.setOnDragEntered(_ -> tagLabel.setStyle("-fx-background-color: lightgrey;"));
+        tagLabel.setOnDragExited(_ -> tagLabel.setStyle(""));
         tagLabel.setOnDragDropped(event -> {
             Dragboard db = event.getDragboard();
             if (db.hasString() && draggedKeyword.isPresent()) {

jabgui/src/main/java/org/jabref/gui/fieldeditors/KeywordsEditorViewModel.java

@@ -60,20 +60,20 @@ public ListProperty<Keyword> keywordListProperty() {
         return keywordListProperty;
     }
 
-    public StringConverter<Keyword> getStringConverter() {
+    static StringConverter<Keyword> getStringConverter() {
         return new StringConverter<>() {
             @Override
             public String toString(Keyword keyword) {
                 if (keyword == null) {
                     LOGGER.debug("Keyword is null");
                     return "";
                 }
-                return keyword.get();
+                return keyword.toString();
             }
 
             @Override
             public Keyword fromString(String keywordString) {
-                return new Keyword(keywordString);
+                return Keyword.ofHierarchical(keywordString);
             }
         };
     }

jabgui/src/test/java/org/jabref/gui/fieldeditors/KeywordsEditorViewModelTest.java

@@ -0,0 +1,17 @@
+package org.jabref.gui.fieldeditors;
+
+import org.jabref.model.entry.Keyword;
+
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+class KeywordsEditorViewModelTest {
+    @Test
+    void stringConverterWithHierarchicalKeywords() {
+        String hierarchichalString = "parent > node > child";
+        Keyword keyword = Keyword.ofHierarchical(hierarchichalString);
+
+        assertEquals(hierarchichalString, KeywordsEditorViewModel.getStringConverter().toString(keyword));
+    }
+}

jablib/src/main/java/org/jabref/model/entry/Keyword.java

@@ -21,10 +21,8 @@ public Keyword(String keyword) {
         this.keyword = Objects.requireNonNull(keyword).trim();
     }
 
-    /**
-     * Connects all the given keywords into one chain and returns its root,
-     * e.g. "A", "B", "C" is transformed into "A > B > C".
-     */
+    /// Connects all the given keywords into one chain and returns its root,
+    /// e.g. "A", "B", "C" is transformed into "A > B > C".
     public static Keyword of(String... keywords) {
         if (keywords.length == 0) {
             return new Keyword("");
@@ -37,6 +35,11 @@ public static Keyword of(String... keywords) {
         return root;
     }
 
+    /// Converts a raw String to a single Keyword
+    public static Keyword ofHierarchical(String rawString) {
+        return Keyword.of(rawString.split(Keyword.DEFAULT_HIERARCHICAL_DELIMITER.toString()));
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) {

jablib/src/main/java/org/jabref/model/entry/KeywordList.java

@@ -56,7 +56,7 @@ public static KeywordList parse(String keywordString, Character delimiter, Chara
         StringTokenizer tok = new StringTokenizer(keywordString, delimiter.toString());
         while (tok.hasMoreTokens()) {
             String chain = tok.nextToken();
-            Keyword chainRoot = Keyword.of(chain.split(hierarchicalDelimiter.toString()));
+            Keyword chainRoot = Keyword.ofHierarchical(chain);
             keywordList.add(chainRoot);
         }
         return keywordList;