From 8ea637ff056a197ea18001e577d0421ebd80d9d8 Mon Sep 17 00:00:00 2001
From: Alexander Capehart <alex@oxycblt.org>
Date: Sun, 19 Mar 2023 13:22:07 -0600
Subject: [PATCH] search: ignore punctuation

Ignore punctuation when searching.

Makes the search experience a bit nicer.

Resolves #378.
---
 CHANGELOG.md                                     |  5 +++--
 .../oxycblt/auxio/music/metadata/TagWorker.kt    | 16 ++++++++++------
 .../org/oxycblt/auxio/search/SearchEngine.kt     |  7 ++++---
 3 files changed, 17 insertions(+), 11 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 2c03ffbe9..55ce844fb 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,12 +7,13 @@
 
 #### What's Improved
 - Accept `REPLAYGAIN_*` adjustment information on OPUS files alongside
-`R128_*` adjustments.
+`R128_*` adjustments
 - List updates are now consistent across the app
 - Fixed jarring header update in detail view
 - Search view now trims search queries
 - Audio effect (equalizer) session is now broadcast when playing/pausing
-rather than on start/stop.
+rather than on start/stop
+- Searching now ignores punctuation
 
 #### What's Fixed
 - Fixed MP4-AAC files not playing due to an accidental audio extractor
diff --git a/app/src/main/java/org/oxycblt/auxio/music/metadata/TagWorker.kt b/app/src/main/java/org/oxycblt/auxio/music/metadata/TagWorker.kt
index f305f4a81..2cf328a92 100644
--- a/app/src/main/java/org/oxycblt/auxio/music/metadata/TagWorker.kt
+++ b/app/src/main/java/org/oxycblt/auxio/music/metadata/TagWorker.kt
@@ -159,11 +159,14 @@ private constructor(private val rawSong: RawSong, private val future: Future<Tra
         textFrames["TCON"]?.let { rawSong.genreNames = it }
 
         // Compilation Flag
-        (textFrames["TCMP"] ?: textFrames["TXXX:compilation"] ?: textFrames["TXXX:itunescompilation"])?.let {
-            if (it.size != 1 || it[0] != "1") return@let
-            rawSong.albumArtistNames = rawSong.albumArtistNames.ifEmpty { COMPILATION_ALBUM_ARTISTS }
-            rawSong.releaseTypes = rawSong.releaseTypes.ifEmpty { COMPILATION_RELEASE_TYPES }
-        }
+        (textFrames["TCMP"]
+                ?: textFrames["TXXX:compilation"] ?: textFrames["TXXX:itunescompilation"])
+            ?.let {
+                if (it.size != 1 || it[0] != "1") return@let
+                rawSong.albumArtistNames =
+                    rawSong.albumArtistNames.ifEmpty { COMPILATION_ALBUM_ARTISTS }
+                rawSong.releaseTypes = rawSong.releaseTypes.ifEmpty { COMPILATION_RELEASE_TYPES }
+            }
     }
 
     /**
@@ -268,7 +271,8 @@ private constructor(private val rawSong: RawSong, private val future: Future<Tra
         // Compilation Flag
         (comments["compilation"] ?: comments["itunescompilation"])?.let {
             if (it.size != 1 || it[0] != "1") return@let
-            rawSong.albumArtistNames = rawSong.albumArtistNames.ifEmpty { COMPILATION_ALBUM_ARTISTS }
+            rawSong.albumArtistNames =
+                rawSong.albumArtistNames.ifEmpty { COMPILATION_ALBUM_ARTISTS }
             rawSong.releaseTypes = rawSong.releaseTypes.ifEmpty { COMPILATION_RELEASE_TYPES }
         }
     }
diff --git a/app/src/main/java/org/oxycblt/auxio/search/SearchEngine.kt b/app/src/main/java/org/oxycblt/auxio/search/SearchEngine.kt
index 6c4db9413..e3733549e 100644
--- a/app/src/main/java/org/oxycblt/auxio/search/SearchEngine.kt
+++ b/app/src/main/java/org/oxycblt/auxio/search/SearchEngine.kt
@@ -102,7 +102,7 @@ class SearchEngineImpl @Inject constructor(@ApplicationContext private val conte
                 // which
                 // could make it match the query.
                 val normalizedName =
-                    NORMALIZATION_SANITIZE_REGEX.replace(
+                    NORMALIZE_POST_PROCESSING_REGEX.replace(
                         Normalizer.normalize(name, Normalizer.Form.NFKD), "")
                 if (normalizedName.contains(query, ignoreCase = true)) {
                     return@filter true
@@ -115,8 +115,9 @@ class SearchEngineImpl @Inject constructor(@ApplicationContext private val conte
     private companion object {
         /**
          * Converts the output of [Normalizer] to remove any junk characters added by it's
-         * replacements.
+         * replacements, alongside punctuation.
          */
-        val NORMALIZATION_SANITIZE_REGEX = Regex("\\p{InCombiningDiacriticalMarks}+")
+        val NORMALIZE_POST_PROCESSING_REGEX =
+            Regex("(\\p{InCombiningDiacriticalMarks}+)|(\\p{Punct})")
     }
 }