Fixes miss-parsed names in AutomaticPersonsGroup

CHANGELOG.md

@@ -92,6 +92,7 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
 - We fixed an issue where the password for a shared SQL database was not remembered [#6869](https://github.com/JabRef/jabref/issues/6869)
 - We fixed an issue where newly added entires were not synced to a shared SQL database [#7176](https://github.com/JabRef/jabref/issues/7176)
 - We fixed an issue where the PDF-Content importer threw an exception when no DOI number is present at the first page of the PDF document [#7203](https://github.com/JabRef/jabref/issues/7203)
+- We fixed an issue where groups generated from authors' last names did not include all entries of the authors' [#5833](https://github.com/JabRef/jabref/issues/5833)
 - We fixed an issue where authors that only have last names were incorrectly identified as institutes when generating citation keys [#7199](https://github.com/JabRef/jabref/issues/7199)
 - We fixed an issue where institutes were incorrectly identified as universities when generating citation keys [#6942](https://github.com/JabRef/jabref/issues/6942)
 

src/main/java/org/jabref/model/entry/Author.java

@@ -3,49 +3,31 @@
 import java.util.Objects;
 import java.util.Optional;
 
+import org.jabref.model.strings.LatexToUnicodeAdapter;
 import org.jabref.model.strings.StringUtil;
 
 /**
- * This is an immutable class that keeps information regarding single
- * author. It is just a container for the information, with very simple
- * methods to access it.
+ * This is an immutable class that keeps information regarding single author. It is just a container for the information, with very simple methods to access it.
  * <p>
- * Current usage: only methods <code>getLastOnly</code>,
- * <code>getFirstLast</code>, and <code>getLastFirst</code> are used;
- * all other methods are provided for completeness.
+ * Current usage: only methods <code>getLastOnly</code>, <code>getFirstLast</code>, and <code>getLastFirst</code> are used; all other methods are provided for completeness.
  */
 public class Author {
 
     private final String firstPart;
-
     private final String firstAbbr;
-
     private final String vonPart;
-
     private final String lastPart;
-
     private final String jrPart;
+    private String latexFreeLastPart;
 
     /**
-     * Creates the Author object. If any part of the name is absent, <CODE>null</CODE>
-     * must be passed; otherwise other methods may return erroneous results.
+     * Creates the Author object. If any part of the name is absent, <CODE>null</CODE> must be passed; otherwise other methods may return erroneous results.
      *
-     * @param first     the first name of the author (may consist of several
-     *                  tokens, like "Charles Louis Xavier Joseph" in "Charles
-     *                  Louis Xavier Joseph de la Vall{\'e}e Poussin")
-     * @param firstabbr the abbreviated first name of the author (may consist of
-     *                  several tokens, like "C. L. X. J." in "Charles Louis
-     *                  Xavier Joseph de la Vall{\'e}e Poussin"). It is a
-     *                  responsibility of the caller to create a reasonable
-     *                  abbreviation of the first name.
-     * @param von       the von part of the author's name (may consist of several
-     *                  tokens, like "de la" in "Charles Louis Xavier Joseph de la
-     *                  Vall{\'e}e Poussin")
-     * @param last      the last name of the author (may consist of several
-     *                  tokens, like "Vall{\'e}e Poussin" in "Charles Louis Xavier
-     *                  Joseph de la Vall{\'e}e Poussin")
-     * @param jr        the junior part of the author's name (may consist of
-     *                  several tokens, like "Jr. III" in "Smith, Jr. III, John")
+     * @param first     the first name of the author (may consist of several tokens, like "Charles Louis Xavier Joseph" in "Charles Louis Xavier Joseph de la Vall{\'e}e Poussin")
+     * @param firstabbr the abbreviated first name of the author (may consist of several tokens, like "C. L. X. J." in "Charles Louis Xavier Joseph de la Vall{\'e}e Poussin"). It is a responsibility of the caller to create a reasonable abbreviation of the first name.
+     * @param von       the von part of the author's name (may consist of several tokens, like "de la" in "Charles Louis Xavier Joseph de la Vall{\'e}e Poussin")
+     * @param last      the last name of the author (may consist of several tokens, like "Vall{\'e}e Poussin" in "Charles Louis Xavier Joseph de la Vall{\'e}e Poussin")
+     * @param jr        the junior part of the author's name (may consist of several tokens, like "Jr. III" in "Smith, Jr. III, John")
      */
     public Author(String first, String firstabbr, String von, String last, String jr) {
         firstPart = addDotIfAbbreviation(removeStartAndEndBraces(first));
@@ -198,9 +180,11 @@ private boolean properBrackets(String s) {
      * Removes start and end brace at a string
      * <p>
      * E.g.,
-     * * {Vall{\'e}e Poussin} -> Vall{\'e}e Poussin
-     * * {Vall{\'e}e} {Poussin} -> Vall{\'e}e Poussin
-     * * Vall{\'e}e Poussin -> Vall{\'e}e Poussin
+     * <ul>
+     *     <li>{Vall{\'e}e Poussin} -> Vall{\'e}e Poussin</li>
+     *     <li>{Vall{\'e}e} {Poussin} -> Vall{\'e}e Poussin</li>
+     *     <li>Vall{\'e}e Poussin -> Vall{\'e}e Poussin</li>
+     * </ul>
      */
     private String removeStartAndEndBraces(String name) {
         if (StringUtil.isBlank(name)) {
@@ -263,19 +247,16 @@ public Optional<String> getFirst() {
     }
 
     /**
-     * Returns the abbreviated first name of the author stored in this
-     * object ("F.").
+     * Returns the abbreviated first name of the author stored in this object ("F.").
      *
-     * @return abbreviated first name of the author (may consist of several
-     * tokens)
+     * @return abbreviated first name of the author (may consist of several tokens)
      */
     public Optional<String> getFirstAbbr() {
         return Optional.ofNullable(firstAbbr);
     }
 
     /**
-     * Returns the von part of the author's name stored in this object
-     * ("von").
+     * Returns the von part of the author's name stored in this object ("von").
      *
      * @return von part of the author's name (may consist of several tokens)
      */
@@ -293,20 +274,28 @@ public Optional<String> getLast() {
     }
 
     /**
-     * Returns the junior part of the author's name stored in this object
-     * ("Jr").
+     * Returns the last name of the author stored in this object with resolved latex.
+     *
+     * @return last name of the author (may consist of several tokens)
+     */
+    public Optional<String> getLastLatexFree() {
+        if (latexFreeLastPart == null && lastPart != null) {
+            latexFreeLastPart = LatexToUnicodeAdapter.format(lastPart);
+        }
+        return Optional.ofNullable(latexFreeLastPart);
+    }
+
+    /**
+     * Returns the junior part of the author's name stored in this object ("Jr").
      *
-     * @return junior part of the author's name (may consist of several
-     * tokens) or null if the author does not have a Jr. Part
+     * @return junior part of the author's name (may consist of several tokens) or null if the author does not have a Jr. Part
      */
     public Optional<String> getJr() {
         return Optional.ofNullable(jrPart);
     }
 
     /**
-     * Returns von-part followed by last name ("von Last"). If both fields
-     * were specified as <CODE>null</CODE>, the empty string <CODE>""</CODE>
-     * is returned.
+     * Returns von-part followed by last name ("von Last"). If both fields were specified as <CODE>null</CODE>, the empty string <CODE>""</CODE> is returned.
      *
      * @return 'von Last'
      */
@@ -319,13 +308,10 @@ public String getLastOnly() {
     }
 
     /**
-     * Returns the author's name in form 'von Last, Jr., First' with the
-     * first name full or abbreviated depending on parameter.
+     * Returns the author's name in form 'von Last, Jr., First' with the first name full or abbreviated depending on parameter.
      *
-     * @param abbr <CODE>true</CODE> - abbreviate first name, <CODE>false</CODE> -
-     *             do not abbreviate
-     * @return 'von Last, Jr., First' (if <CODE>abbr==false</CODE>) or
-     * 'von Last, Jr., F.' (if <CODE>abbr==true</CODE>)
+     * @param abbr <CODE>true</CODE> - abbreviate first name, <CODE>false</CODE> - do not abbreviate
+     * @return 'von Last, Jr., First' (if <CODE>abbr==false</CODE>) or 'von Last, Jr., F.' (if <CODE>abbr==true</CODE>)
      */
     public String getLastFirst(boolean abbr) {
         StringBuilder res = new StringBuilder(getLastOnly());
@@ -339,13 +325,10 @@ public String getLastFirst(boolean abbr) {
     }
 
     /**
-     * Returns the author's name in form 'First von Last, Jr.' with the
-     * first name full or abbreviated depending on parameter.
+     * Returns the author's name in form 'First von Last, Jr.' with the first name full or abbreviated depending on parameter.
      *
-     * @param abbr <CODE>true</CODE> - abbreviate first name, <CODE>false</CODE> -
-     *             do not abbreviate
-     * @return 'First von Last, Jr.' (if <CODE>abbr==false</CODE>) or 'F.
-     * von Last, Jr.' (if <CODE>abbr==true</CODE>)
+     * @param abbr <CODE>true</CODE> - abbreviate first name, <CODE>false</CODE> - do not abbreviate
+     * @return 'First von Last, Jr.' (if <CODE>abbr==false</CODE>) or 'F. von Last, Jr.' (if <CODE>abbr==true</CODE>)
      */
     public String getFirstLast(boolean abbr) {
         StringBuilder res = new StringBuilder();
@@ -372,11 +355,9 @@ public String toString() {
     }
 
     /**
-     * Returns the name as "Last, Jr, F." omitting the von-part and removing
-     * starting braces.
+     * Returns the name as "Last, Jr, F." omitting the von-part and removing starting braces.
      *
-     * @return "Last, Jr, F." as described above or "" if all these parts
-     * are empty.
+     * @return "Last, Jr, F." as described above or "" if all these parts are empty.
      */
     public String getNameForAlphabetization() {
         StringBuilder res = new StringBuilder();

src/main/java/org/jabref/model/groups/AutomaticPersonsGroup.java

@@ -1,19 +1,15 @@
 package org.jabref.model.groups;
 
 import java.util.Objects;
-import java.util.Optional;
 import java.util.Set;
 import java.util.stream.Collectors;
 
-import org.jabref.model.entry.Author;
-import org.jabref.model.entry.AuthorList;
 import org.jabref.model.entry.BibEntry;
 import org.jabref.model.entry.field.Field;
-import org.jabref.model.util.OptionalUtil;
 
 public class AutomaticPersonsGroup extends AutomaticGroup {
 
-    private Field field;
+    private final Field field;
 
     public AutomaticPersonsGroup(String name, GroupHierarchyType context, Field field) {
         super(name, context);
@@ -44,16 +40,11 @@ public AbstractGroup deepCopy() {
 
     @Override
     public Set<GroupTreeNode> createSubgroups(BibEntry entry) {
-        Optional<AuthorList> authorList = entry.getLatexFreeField(field)
-                                               .map(AuthorList::parse);
-        return OptionalUtil.flatMap(authorList, AuthorList::getAuthors)
-                           .map(Author::getLast)
-                           .filter(Optional::isPresent)
-                           .map(Optional::get)
-                           .filter(lastName -> !lastName.isEmpty())
-                           .map(lastName -> new WordKeywordGroup(lastName, GroupHierarchyType.INDEPENDENT, field, lastName, true, ' ', true))
-                           .map(GroupTreeNode::new)
-                           .collect(Collectors.toSet());
+        return LastNameGroup.getAsLastNamesLatexFree(field, entry)
+                            .stream()
+                            .map(lastName -> new LastNameGroup(lastName, GroupHierarchyType.INDEPENDENT, field, lastName))
+                            .map(GroupTreeNode::new)
+                            .collect(Collectors.toSet());
     }
 
     public Field getField() {

src/main/java/org/jabref/model/groups/LastNameGroup.java

@@ -0,0 +1,59 @@
+package org.jabref.model.groups;
+
+import java.util.Collections;
+import java.util.List;
+import java.util.Objects;
+import java.util.Optional;
+import java.util.stream.Collectors;
+
+import org.jabref.model.entry.Author;
+import org.jabref.model.entry.AuthorList;
+import org.jabref.model.entry.BibEntry;
+import org.jabref.model.entry.field.Field;
+import org.jabref.model.strings.LatexToUnicodeAdapter;
+
+/**
+ * Matches based on a latex free last name in a specified field. The field is parsed as an author list and the last names are resolved of latex.
+ */
+public class LastNameGroup extends KeywordGroup {
+    public LastNameGroup(String groupName, GroupHierarchyType context, Field searchField, String lastName) {
+        super(groupName, context, searchField, LatexToUnicodeAdapter.format(lastName), true);
+    }
+
+    static List<String> getAsLastNamesLatexFree(Field field, BibEntry bibEntry) {
+        return bibEntry.getField(field)
+                       .map(AuthorList::parse)
+                       .map(AuthorList::getAuthors)
+                       .map(authors ->
+                               authors.stream()
+                                      .map(Author::getLastLatexFree)
+                                      .flatMap(Optional::stream)
+                                      .collect(Collectors.toList()))
+                       .orElse(Collections.emptyList());
+    }
+
+    @Override
+    public boolean contains(BibEntry entry) {
+        return getAsLastNamesLatexFree(getSearchField(), entry).stream().anyMatch(name -> name.equals(getSearchExpression()));
+    }
+
+    @Override
+    public AbstractGroup deepCopy() {
+        return new LastNameGroup(getName(), getHierarchicalContext(), getSearchField(), getSearchExpression());
+    }
+
+    @Override
+    public boolean equals(Object other) {
+        if (super.equals(other)) {
+            LastNameGroup otherGroup = (LastNameGroup) other;
+            return (getSearchField().equals(otherGroup.getSearchField()) &&
+                    getSearchExpression().equals(otherGroup.getSearchExpression()));
+        }
+        return false;
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(super.hashCode(), getSearchField(), getSearchExpression());
+    }
+}

src/test/java/org/jabref/model/groups/AutomaticPersonsGroupTest.java

@@ -0,0 +1,59 @@
+package org.jabref.model.groups;
+
+import java.util.Arrays;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+import org.jabref.model.entry.BibEntry;
+import org.jabref.model.entry.field.StandardField;
+import org.jabref.model.strings.LatexToUnicodeAdapter;
+
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+class AutomaticPersonsGroupTest {
+    private static Set<GroupTreeNode> createPersonSubGroupFrom(String... lastNames) {
+        return Arrays.stream(lastNames)
+                     .distinct()
+                     .map(LatexToUnicodeAdapter::format)
+                     .map(lastName ->
+                             new LastNameGroup(lastName, GroupHierarchyType.INDEPENDENT, StandardField.AUTHOR, lastName))
+                     .map(GroupTreeNode::new)
+                     .collect(Collectors.toSet());
+    }
+
+    @Test
+    void createSubgroupsFromCommaSeparatedLastNames() {
+        BibEntry bibEntry = new BibEntry().withField(StandardField.AUTHOR, "Turing, Alan and Hopper, Grace");
+        var subgroups = new AutomaticPersonsGroup("", GroupHierarchyType.INDEPENDENT, StandardField.AUTHOR).createSubgroups(bibEntry);
+        var expectedSubgroups = createPersonSubGroupFrom("Turing", "Hopper");
+        assertEquals(expectedSubgroups, subgroups);
+    }
+
+    @Test
+    void createSubgroupsContainingCommaSeparatedLastNames() {
+        BibEntry bibEntry = new BibEntry().withField(StandardField.AUTHOR, "Turing, Alan and Hopper, Grace");
+        var subgroups = new AutomaticPersonsGroup("", GroupHierarchyType.INDEPENDENT, StandardField.AUTHOR).createSubgroups(bibEntry);
+        var expectedSubgroups = createPersonSubGroupFrom("Turing", "Hopper");
+        assertEquals(expectedSubgroups, subgroups);
+    }
+
+    @Test
+    void createSubgroupFromLatexAndCheckForUnicodeLastName() {
+        BibEntry bibEntry = new BibEntry().withField(StandardField.AUTHOR, "Kurt G{\\\"{o}}del");
+        BibEntry godelEntry = new BibEntry().withField(StandardField.AUTHOR, "Kurt Gödel");
+        var subgroup = new AutomaticPersonsGroup("", GroupHierarchyType.INDEPENDENT, StandardField.AUTHOR).createSubgroups(bibEntry);
+        var expectedSubgroup = createPersonSubGroupFrom("Gödel");
+        assertEquals(expectedSubgroup, subgroup);
+    }
+
+    @Test
+    void createSubgroupFromUnicodeAndCheckForLatexLastName() {
+        BibEntry bibEntry = new BibEntry().withField(StandardField.AUTHOR, "Kurt Gödel");
+        BibEntry godelEntry = new BibEntry().withField(StandardField.AUTHOR, "Kurt G{\\\"{o}}del");
+        var subgroup = new AutomaticPersonsGroup("", GroupHierarchyType.INDEPENDENT, StandardField.AUTHOR).createSubgroups(bibEntry);
+        var expectedSubgroup = createPersonSubGroupFrom("G{\\\"{o}}del");
+        assertEquals(expectedSubgroup, subgroup);
+    }
+}