Merge pull request #1576 from lucasmarchd01/issue-843

Add indexing notes search to chant search page

django/cantusdb_project/main_app/templates/chant_search.html

@@ -95,9 +95,27 @@ <h3>Search Chants</h3>
                 </select>
             </div>
         </div>
+        {% if source %}
+            <div class="form-row align-items-end">
+                <div class="form-group m-1 col-12">
+                    <label for="indexingNotesSearch"><small>Indexing notes search</small></label>
+                </div>
+            </div>
+            <div class="form-row align-items-end">
+                <div class="form-group m-1 col-lg-3 col-sm-3 col-3">
+                    <select class="form-control custom-select custom-select-sm" id="indexingNotesOp" name="indexing_notes_op">
+                        <option selected value="contains">Contains</option>
+                        <option value="starts_with">Starts with</option>
+                    </select>
+                </div>
+                <div class="form-group m-1 col-lg col-sm col-">
+                    <input type="text" class="form-control form-control-sm"  id="indexingNotesSearch" name="indexing_notes" value="{{ request.GET.indexing_notes }}" />
+                </div>
+            </div>
+        {% endif %}
 
         <div class="form-row align-items-end">
-            <div class="form-group m-1 col-lg">
+            <div class="form-group m-2 col-lg">
                 <button type="submit" class="btn btn-dark btn-sm" id="btn-submit"> Apply </button>
             </div>
         </div>

django/cantusdb_project/main_app/tests/make_fakes.py

@@ -154,6 +154,7 @@ def make_fake_chant(
     next_chant=None,
     differentia=None,
     project=None,
+    indexing_notes=None,
 ) -> Chant:
     """Generates a fake Chant object."""
     if source is None:
@@ -193,6 +194,8 @@ def make_fake_chant(
         differentia = make_random_string(2)
     if project is None:
         project = make_fake_project()
+    if indexing_notes is None:
+        indexing_notes = faker.sentence()
 
     chant = Chant.objects.create(
         source=source,
@@ -224,7 +227,7 @@ def make_fake_chant(
         cao_concordances=make_random_string(12, "ABCDEFGHIJKLMNOPQRSTUVWXYZ  "),
         melody_id="m" + make_random_string(8, "0123456789."),
         manuscript_syllabized_full_text=manuscript_syllabized_full_text,
-        indexing_notes=faker.sentence(),
+        indexing_notes=indexing_notes,
         json_info=None,
         next_chant=next_chant,
         project=project,

django/cantusdb_project/main_app/tests/test_views.py

@@ -2363,6 +2363,55 @@ def test_keyword_search_contains(self):
         second_context_chant_id = response.context["chants"][1].id
         self.assertEqual(chant_3.id, second_context_chant_id)
 
+    def test_indexing_notes_search_starts_with(self):
+        source = make_fake_source()
+        search_term = "quick"
+
+        # We have three chants to make sure the result is only chant 1 where quick is the first word
+        chant_1 = make_fake_chant(
+            source=source,
+            indexing_notes="quick brown fox jumps over the lazy dog",
+        )
+        chant_2 = make_fake_chant(
+            source=source,
+            indexing_notes="brown fox jumps over the lazy dog",
+        )
+        chant_3 = make_fake_chant(
+            source=source,
+            indexing_notes="lazy brown fox jumps quick over the dog",
+        )
+        response = self.client.get(
+            reverse("chant-search-ms", args=[source.id]),
+            {"indexing_notes": search_term, "indexing_notes_op": "starts_with"},
+        )
+        self.assertEqual(len(response.context["chants"]), 1)
+        context_chant_id = response.context["chants"][0].id
+        self.assertEqual(chant_1.id, context_chant_id)
+
+    def test_indexing_notes_search_contains(self):
+        source = make_fake_source()
+        search_term = "quick"
+        chant_1 = make_fake_chant(
+            source=source,
+            indexing_notes="Quick brown fox jumps over the lazy dog",
+        )
+        chant_2 = make_fake_chant(
+            source=source,
+            indexing_notes="brown fox jumps over the lazy dog",
+        )
+        chant_3 = make_fake_chant(
+            source=source,
+            indexing_notes="lazy brown fox jumps quickly over the dog",
+        )
+        response = self.client.get(
+            reverse("chant-search-ms", args=[source.id]),
+            {"indexing_notes": search_term, "indexing_notes_op": "contains"},
+        )
+        first_context_chant_id = response.context["chants"][0].id
+        self.assertEqual(chant_1.id, first_context_chant_id)
+        second_context_chant_id = response.context["chants"][1].id
+        self.assertEqual(chant_3.id, second_context_chant_id)
+
     def test_keyword_search_searching_all_fields(self):
         search_term = "brevity"
         includes_search_term = "brevity is the soul of wit"

django/cantusdb_project/main_app/views/chant.py

@@ -629,6 +629,12 @@ def get_context_data(self, **kwargs):
         search_melodies = self.request.GET.get("melodies")
         if search_melodies:
             search_parameters.append(f"melodies={search_melodies}")
+        search_indexing_notes_op = self.request.GET.get("indexing_notes_op")
+        if search_indexing_notes_op:
+            search_parameters.append(f"indexing_notes_op={search_indexing_notes_op}")
+        search_indexing_notes = self.request.GET.get("indexing_notes")
+        if search_indexing_notes:
+            search_parameters.append(f"indexing_notes={search_indexing_notes}")
 
         if search_parameters:
             joined_search_parameters = "&".join(search_parameters)
@@ -724,6 +730,14 @@ def get_queryset(self) -> QuerySet:
 
             keyword_filter = ms_spelling_filter | std_spelling_filter | incipit_filter
             queryset = queryset.filter(keyword_filter)
+        if notes := self.request.GET.get("indexing_notes"):
+            operation = self.request.GET.get("indexing_notes_op")
+            # the operation parameter can be "contains" or "starts_with"
+            if operation == "contains":
+                indexing_notes_filter = Q(indexing_notes__icontains=notes)
+            else:
+                indexing_notes_filter = Q(indexing_notes__istartswith=notes)
+            queryset = queryset.filter(indexing_notes_filter)
         # ordering with the folio string gives wrong order
         # old cantus is also not strictly ordered by folio (there are outliers)
         # so we order by id for now, which is the order that the chants are entered into the DB

django/cantusdb_project/static/js/chant_search.js

@@ -11,6 +11,7 @@ window.addEventListener("load", function () {
     const melodiesFilter = document.getElementById("melodiesFilter");
     const keywordField = document.getElementById("keywordSearch");
     const cantusIDField = document.getElementById("cantus_id");
+    const indexingNotesOp = document.getElementById("indexingNotesOp");
 
     const urlParams = new URLSearchParams(window.location.search);
     if (urlParams.has("op")) {
@@ -25,6 +26,9 @@ window.addEventListener("load", function () {
     if (urlParams.has("melodies")) {
         melodiesFilter.value = urlParams.get("melodies");
     }
+    if (urlParams.has("indexing_notes_op")) {
+        indexingNotesOp.value = urlParams.get("indexing_notes_op")
+    }
     if (urlParams.has("search_bar")) {
         let search_term = urlParams.get("search_bar");
         if (containsNoNumerals(search_term)) {