implement hide remaster (#132)

Author: afahey03

api/templates/callback.html.j2

@@ -105,6 +105,12 @@
             <span>Censor Profanity</span>
           </label>
         </div>
+        <div class="col s12 m3">
+          <label class="row">
+            <input type="checkbox" class="filled-in" id="hide-remaster-checkbox" />
+            <span>Hide Remaster</span>
+          </label>
+        </div>
       </div>
 
       <div class="row center">
@@ -237,7 +243,8 @@
       show_offline: false,
       background_color: "121212",
       interchange:false,
-      profanity: false
+      profanity: false,
+      hide_remaster: false
     };
     var openSong = false;
 
@@ -288,6 +295,11 @@
       updateUrl();
     });
 
+    $("#hide-remaster-checkbox").change(function() {
+      urlParams.hide_remaster = this.checked;
+      updateUrl();
+    });
+
     $('#theme-select').change(function() {
       // Reset visibility defaults
       $('.bar-color').show();

api/view.py

@@ -4,6 +4,7 @@
 
 from util.firestore import get_firestore_db
 from util.profanity import profanity_check
+from util.remaster import remove_remaster
 
 load_dotenv(find_dotenv())
 
@@ -352,6 +353,7 @@ def catch_all(path):
     interchange = request.args.get("interchange", default="false") == "true"
     mode = request.args.get("mode", default="light")
     is_enable_profanity = request.args.get("profanity", default="false") == "true"
+    hide_remaster = request.args.get("hide_remaster", default="false") == "true"
 
     # Handle invalid request
     if not uid:
@@ -454,6 +456,10 @@ def catch_all(path):
         artist_name = profanity_check(artist_name)
         song_name = profanity_check(song_name)
 
+    # Strip remaster annotations from song title
+    if hide_remaster:
+        song_name = remove_remaster(song_name)
+
     if interchange:
         x = artist_name
         artist_name = song_name

tests/test_util_remaster.py

@@ -0,0 +1,44 @@
+import sys
+import os
+
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), ".."))
+
+from util.remaster import remove_remaster
+
+
+def test_no_remaster_unchanged():
+    assert remove_remaster("Hotel California") == "Hotel California"
+
+
+def test_remaster_suffix_dash():
+    assert remove_remaster("Hotel California - 2013 Remaster") == "Hotel California"
+
+
+def test_remaster_suffix_parens():
+    assert remove_remaster("Come Together (Remastered)") == "Come Together"
+
+
+def test_remastered_with_year_parens():
+    assert remove_remaster("Roxanne (Remastered 2003)") == "Roxanne"
+
+
+def test_remaster_year_before_keyword():
+    assert remove_remaster("Starman - 2012 Remaster") == "Starman"
+
+
+def test_remastered_version():
+    assert remove_remaster("Heroes - Remastered Version") == "Heroes"
+
+
+def test_remastered_year_version():
+    assert remove_remaster("Life On Mars? (2015 Remastered Version)") == "Life On Mars?"
+
+
+def test_case_insensitive():
+    assert remove_remaster("Song Title - REMASTERED") == "Song Title"
+
+
+def test_remaster_not_mid_title():
+    """Remaster text in the middle of a title must not be removed."""
+    title = "Remastered Soul"
+    assert remove_remaster(title) == "Remastered Soul"

util/remaster.py

@@ -0,0 +1,27 @@
+import re
+
+# Matches common "Remaster" / "Remastered" suffixes appended to song titles.
+# Examples handled:
+#   "Song Title - 2020 Remaster"
+#   "Song Title (2020 Remaster)"
+#   "Song Title (Remastered)"
+#   "Song Title - Remastered 2020"
+#   "Song Title (Remastered 2020 Version)"
+_REMASTER_RE = re.compile(
+    r"""
+    [\s\-–]+            # separator: whitespace and/or dash
+    [\(\[]?             # optional opening bracket
+    (?:\d{4}\s+)?       # optional year before keyword
+    Remaster(?:ed)?     # "Remaster" or "Remastered"
+    (?:\s+\d{4})?       # optional year after keyword
+    (?:\s+Version)?     # optional trailing "Version"
+    [\)\]]?             # optional closing bracket
+    \s*$                # up to end of string
+    """,
+    re.IGNORECASE | re.VERBOSE,
+)
+
+
+def remove_remaster(name: str) -> str:
+    """Return *name* with any remaster annotation stripped from the end."""
+    return _REMASTER_RE.sub("", name).strip()