support synonyms recognizing pantry items

src/main/java/com/brennaswitzer/cookbook/domain/Named.java

@@ -3,5 +3,13 @@
 public interface Named {
 
     String getName();
+
+    /**
+     * Whether this Named answers to the given name. The default implementation
+     * simply checks case-insensitive equality. No Named ever answers to null.
+     */
+    default boolean answersToName(String name) {
+        return name != null && name.equalsIgnoreCase(getName());
+    }
 
 }

src/main/java/com/brennaswitzer/cookbook/domain/PantryItem.java

@@ -92,6 +92,12 @@ public void setName(String name) {
         super.setName(name);
     }
 
+    @Override
+    public boolean answersToName(String name) {
+        return super.answersToName(name)
+                || hasSynonym(name);
+    }
+
     public boolean hasSynonym(String synonym) {
         if (synonyms == null) return false;
         if (synonym == null || synonym.isBlank()) return false;

src/main/java/com/brennaswitzer/cookbook/repositories/PantryItemRepository.java

@@ -1,15 +1,32 @@
 package com.brennaswitzer.cookbook.repositories;
 
 import com.brennaswitzer.cookbook.domain.PantryItem;
+import org.springframework.data.jpa.repository.Query;
 import org.springframework.data.repository.CrudRepository;
 
 import java.time.Instant;
 import java.util.List;
 
 public interface PantryItemRepository extends CrudRepository<PantryItem, Long> {
 
+    @Query("""
+            select item
+            from PantryItem item
+               left join item.synonyms syn
+            where upper(item.name) = upper(:name)
+               or upper(syn) = upper(:name)
+            order by item.id
+            """)
     List<PantryItem> findByNameIgnoreCaseOrderById(String name);
 
+    @Query("""
+            select item
+            from PantryItem item
+               left join item.synonyms syn
+            where upper(item.name) like upper('%' || :name || '%') escape '\\'
+               or upper(syn) like upper('%' || :name || '%') escape '\\'
+            order by item.id
+            """)
     List<PantryItem> findAllByNameIgnoreCaseContainingOrderById(String name);
 
     List<PantryItem> findAllByUpdatedAtIsAfter(Instant cutoff);

src/main/java/com/brennaswitzer/cookbook/services/IngredientService.java

@@ -13,7 +13,6 @@
 import org.springframework.transaction.annotation.Transactional;
 
 import java.util.ArrayList;
-import java.util.Collection;
 import java.util.List;
 import java.util.Optional;
 
@@ -39,7 +38,7 @@ public Ingredient ensureIngredientByName(String name) {
         return pantryItemRepository.save(new PantryItem(EnglishUtils.unpluralize(name)));
     }
 
-    public Iterable<Ingredient> findAllIngredientsByNameContaining(String name) {
+    public List<Ingredient> findAllIngredientsByNameContaining(String name) {
         String unpluralized = EnglishUtils.unpluralize(name);
         List<PantryItem> pantryItems = pantryItemRepository.findAllByNameIgnoreCaseContainingOrderById(unpluralized);
         List<Ingredient> result = new ArrayList<>(pantryItems);
@@ -77,7 +76,7 @@ public Optional<? extends Ingredient> findIngredientByName(String name) {
     public Iterable<Ingredient> findAllIngredientsByNamesContaining(List<String> names) {
         List<Ingredient> results = new ArrayList<>();
         for (String name : names) {
-            results.addAll((Collection<? extends Ingredient>) findAllIngredientsByNameContaining(name));
+            results.addAll(findAllIngredientsByNameContaining(name));
         }
         return results;
     }

src/main/java/com/brennaswitzer/cookbook/services/ItemService.java

@@ -267,8 +267,8 @@ public Optional<RecognizedRange> multiPass(Iterable<RecognizedRange> ranges, Str
 
         for (Phrase phrase : phrases) {
             for (Ingredient opt : options) {
-                if (phrase.getCanonical().equals(opt.getName())
-                        || phrase.getOriginal().equalsIgnoreCase(opt.getName())) {
+                if (opt.answersToName(phrase.getCanonical())
+                        || opt.answersToName(phrase.getOriginal())) {
                     Phrase match = phrase.of(RecognizedRangeType.ITEM)
                             .withId(opt.getId());
                     if (best == null || Phrase.BY_LENGTH.compare(match, best) > 0) {

src/test/java/com/brennaswitzer/cookbook/domain/PantryItemTest.java

@@ -34,4 +34,18 @@ void synonyms() {
         assertTrue(it.hasSynonym("stilton")); // ignore case
     }
 
+    @Test
+    void answersToName() {
+        val it = new PantryItem("the curd-y stuff");
+        it.addSynonyms("cheese", "Cheez", "CHEEZE");
+
+        assertFalse(it.answersToName("curd-y stuff"));
+        assertTrue(it.answersToName("THE curd-y STUFF"));
+
+        assertTrue(it.answersToName("cheese"));
+        assertTrue(it.answersToName("cheeze"));
+        assertTrue(it.answersToName("CHEEZ"));
+        assertFalse(it.answersToName("cheese stick"));
+    }
+
 }

src/test/java/com/brennaswitzer/cookbook/services/ItemServiceTest.java

@@ -56,6 +56,39 @@ public void recognizeItem() {
         assertFalse(ri.hasNext());
     }
 
+    @Test
+    public void recognizeImplicitSynonym() {
+        RecipeBox box = new RecipeBox();
+        box.persist(entityManager, principalAccess.getUser());
+
+        final String RAW = "sea nacl, ground fine";
+        RecognizedItem el = recognizeItem(RAW);
+        System.out.println(el);
+
+        assertEquals(RAW, el.getRaw());
+        Iterator<RecognizedRange> ri = el.getRanges().iterator();
+        RecognizedRange saltRange = ri.next();
+        assertEquals(new RecognizedRange(4, 8, RecognizedRangeType.ITEM), saltRange);
+        assertEquals(box.salt.getId(), saltRange.getId());
+        assertFalse(ri.hasNext());
+    }
+
+    @Test
+    public void recognizeExplicitSynonym() {
+        RecipeBox box = new RecipeBox();
+        box.persist(entityManager, principalAccess.getUser());
+
+        final String RAW = "sea \"nacl\", ground fine";
+        RecognizedItem el = recognizeItem(RAW);
+        System.out.println(el);
+
+        assertEquals(RAW, el.getRaw());
+        Iterator<RecognizedRange> ri = el.getRanges().iterator();
+        RecognizedRange saltRange = ri.next();
+        assertEquals(box.salt.getId(), saltRange.getId());
+        assertFalse(ri.hasNext());
+    }
+
     @Test
     public void recognizeItemMultipleNoCase() {
         RecipeBox box = new RecipeBox();
@@ -262,7 +295,6 @@ public void buildMultiwordPhrases() {
         //noinspection OptionalGetWithoutIsPresent
         RecognizedRange ing = ri.filter(it -> it.getType() == RecognizedRangeType.ITEM).findFirst().get();
         assertEquals(new RecognizedRange(0, 18, RecognizedRangeType.ITEM), ing);
-
     }
 
     private RecognizedItem recognizeItem(String raw) {

src/test/resources/application-test.yml

@@ -2,6 +2,7 @@ spring:
   datasource:
     # This is the PostgreSQL version we target. Keep it in sync.
     url: jdbc:tc:postgresql:15.6:///postgres
+  jpa.show-sql: true
 app:
   aws:
     access-key: oh-my-its-so-glergy