From ec8a85146144b2d68e969ce1b805b5b74b8998a8 Mon Sep 17 00:00:00 2001
From: Lucas <lucas.march@mail.mcgill.ca>
Date: Mon, 19 Aug 2024 16:46:40 +0000
Subject: [PATCH 1/7] fix(source): fix TypeError on source create page - make
 shelfmark a required field on source create and edit pages

---
 django/cantusdb_project/main_app/forms.py            | 12 ++++++++++--
 .../main_app/templates/source_create.html            |  2 +-
 .../main_app/templates/source_edit.html              |  2 +-
 3 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/django/cantusdb_project/main_app/forms.py b/django/cantusdb_project/main_app/forms.py
index e1f6e11f8..1652e430e 100644
--- a/django/cantusdb_project/main_app/forms.py
+++ b/django/cantusdb_project/main_app/forms.py
@@ -218,7 +218,6 @@ class Meta:
             "holding_institution": autocomplete.ModelSelect2(
                 url="holding-autocomplete"
             ),
-            "shelfmark": TextInputWidget(),
             "provenance": autocomplete.ModelSelect2(url="provenance-autocomplete"),
             "provenance_notes": TextInputWidget(),
             "date": TextInputWidget(),
@@ -254,6 +253,11 @@ class Meta:
             "segment_m2m": CheckboxNameModelMultipleChoiceField,
         }
 
+    shelfmark = forms.CharField(
+        required=True,
+        widget=TextInputWidget,
+    )
+
     TRUE_FALSE_CHOICES_SOURCE = (
         (True, "Full source"),
         (False, "Fragment or Fragmented"),
@@ -410,7 +414,6 @@ class Meta:
             "holding_institution": autocomplete.ModelSelect2(
                 url="holding-autocomplete"
             ),
-            "shelfmark": TextInputWidget(),
             "segment_m2m": CheckboxSelectMultiple(),
             "provenance": autocomplete.ModelSelect2(url="provenance-autocomplete"),
             "provenance_notes": TextInputWidget(),
@@ -447,6 +450,11 @@ class Meta:
             "segment_m2m": CheckboxNameModelMultipleChoiceField,
         }
 
+    shelfmark = forms.CharField(
+        required=True,
+        widget=TextInputWidget,
+    )
+
     CHOICES_FULL_SOURCE = (
         (None, "None"),
         (True, "Full source"),
diff --git a/django/cantusdb_project/main_app/templates/source_create.html b/django/cantusdb_project/main_app/templates/source_create.html
index 541ef7eab..f3a98c67e 100644
--- a/django/cantusdb_project/main_app/templates/source_create.html
+++ b/django/cantusdb_project/main_app/templates/source_create.html
@@ -57,7 +57,7 @@ <h3>Create Source</h3>
                 <div class="form-row">
                     <div class="form-group m-1 col-lg-3">
                         <label for="{{ form.shelfmark.id_for_label }}">
-                            <small>Shelfmark:</small>
+                            <small>Shelfmark:</small><span class="text-danger" title="This field is required">*</span></small>
                         </label>
                         <br>{{ form.shelfmark }}
                         <p class=text-muted>
diff --git a/django/cantusdb_project/main_app/templates/source_edit.html b/django/cantusdb_project/main_app/templates/source_edit.html
index 869a5164b..a5390f112 100644
--- a/django/cantusdb_project/main_app/templates/source_edit.html
+++ b/django/cantusdb_project/main_app/templates/source_edit.html
@@ -59,7 +59,7 @@ <h3>
         <div class="form-row">
             <div class="form-group m-1 col-lg-3">
                 <label for="{{ form.shelfmark.id_for_label }}">
-                    <small>Shelfmark:</small>
+                    <small>Shelfmark:</small><span class="text-danger" title="This field is required">*</span></small>
                 </label>
                 <br>{{ form.shelfmark }}
                 <p class=text-muted>

From c49eb5143a78596459e2182718bfa58522af69ff Mon Sep 17 00:00:00 2001
From: Lucas <lucas.march@mail.mcgill.ca>
Date: Mon, 19 Aug 2024 16:50:26 +0000
Subject: [PATCH 2/7] fix(source): fix TypeError on source create page - make
 shelfmark a required field on source create and edit pages - make shelfmark a
 required field on admin source add form

---
 django/cantusdb_project/main_app/forms.py       | 17 +++++++++++++++--
 .../main_app/templates/source_create.html       |  2 +-
 .../main_app/templates/source_edit.html         |  2 +-
 3 files changed, 17 insertions(+), 4 deletions(-)

diff --git a/django/cantusdb_project/main_app/forms.py b/django/cantusdb_project/main_app/forms.py
index e1f6e11f8..c1cf89745 100644
--- a/django/cantusdb_project/main_app/forms.py
+++ b/django/cantusdb_project/main_app/forms.py
@@ -218,7 +218,6 @@ class Meta:
             "holding_institution": autocomplete.ModelSelect2(
                 url="holding-autocomplete"
             ),
-            "shelfmark": TextInputWidget(),
             "provenance": autocomplete.ModelSelect2(url="provenance-autocomplete"),
             "provenance_notes": TextInputWidget(),
             "date": TextInputWidget(),
@@ -254,6 +253,11 @@ class Meta:
             "segment_m2m": CheckboxNameModelMultipleChoiceField,
         }
 
+    shelfmark = forms.CharField(
+        required=True,
+        widget=TextInputWidget,
+    )
+
     TRUE_FALSE_CHOICES_SOURCE = (
         (True, "Full source"),
         (False, "Fragment or Fragmented"),
@@ -410,7 +414,6 @@ class Meta:
             "holding_institution": autocomplete.ModelSelect2(
                 url="holding-autocomplete"
             ),
-            "shelfmark": TextInputWidget(),
             "segment_m2m": CheckboxSelectMultiple(),
             "provenance": autocomplete.ModelSelect2(url="provenance-autocomplete"),
             "provenance_notes": TextInputWidget(),
@@ -447,6 +450,11 @@ class Meta:
             "segment_m2m": CheckboxNameModelMultipleChoiceField,
         }
 
+    shelfmark = forms.CharField(
+        required=True,
+        widget=TextInputWidget,
+    )
+
     CHOICES_FULL_SOURCE = (
         (None, "None"),
         (True, "Full source"),
@@ -718,6 +726,11 @@ class Meta:
         help_text="RISM-style siglum + Shelf-mark (e.g. GB-Ob 202).",
     )
 
+    shelfmark = forms.CharField(
+        required=True,
+        widget=TextInputWidget,
+    )
+
     provenance = forms.ModelChoiceField(
         queryset=Provenance.objects.all().order_by("name"),
         required=False,
diff --git a/django/cantusdb_project/main_app/templates/source_create.html b/django/cantusdb_project/main_app/templates/source_create.html
index 541ef7eab..f3a98c67e 100644
--- a/django/cantusdb_project/main_app/templates/source_create.html
+++ b/django/cantusdb_project/main_app/templates/source_create.html
@@ -57,7 +57,7 @@ <h3>Create Source</h3>
                 <div class="form-row">
                     <div class="form-group m-1 col-lg-3">
                         <label for="{{ form.shelfmark.id_for_label }}">
-                            <small>Shelfmark:</small>
+                            <small>Shelfmark:</small><span class="text-danger" title="This field is required">*</span></small>
                         </label>
                         <br>{{ form.shelfmark }}
                         <p class=text-muted>
diff --git a/django/cantusdb_project/main_app/templates/source_edit.html b/django/cantusdb_project/main_app/templates/source_edit.html
index 869a5164b..a5390f112 100644
--- a/django/cantusdb_project/main_app/templates/source_edit.html
+++ b/django/cantusdb_project/main_app/templates/source_edit.html
@@ -59,7 +59,7 @@ <h3>
         <div class="form-row">
             <div class="form-group m-1 col-lg-3">
                 <label for="{{ form.shelfmark.id_for_label }}">
-                    <small>Shelfmark:</small>
+                    <small>Shelfmark:</small><span class="text-danger" title="This field is required">*</span></small>
                 </label>
                 <br>{{ form.shelfmark }}
                 <p class=text-muted>

From 5e72103a6a20d6cb65ff2b29e834540d8a773adf Mon Sep 17 00:00:00 2001
From: lucasmarchd01 <lucasmarchd01@gmail.com>
Date: Fri, 23 Aug 2024 18:41:13 +0000
Subject: [PATCH 3/7] fix(source): make holding institution and shelfmark
 fields required - in source model - on the source create and edit forms

---
 django/cantusdb_project/main_app/forms.py     | 24 ++++++++++++++-----
 .../main_app/models/source.py                 |  8 +++----
 2 files changed, 22 insertions(+), 10 deletions(-)

diff --git a/django/cantusdb_project/main_app/forms.py b/django/cantusdb_project/main_app/forms.py
index c1cf89745..81dce3c75 100644
--- a/django/cantusdb_project/main_app/forms.py
+++ b/django/cantusdb_project/main_app/forms.py
@@ -4,6 +4,7 @@
     Chant,
     Service,
     Genre,
+    Institution,
     Notation,
     Feast,
     Source,
@@ -215,9 +216,6 @@ class Meta:
         widgets = {
             # "title": TextInputWidget(),
             # "siglum": TextInputWidget(),
-            "holding_institution": autocomplete.ModelSelect2(
-                url="holding-autocomplete"
-            ),
             "provenance": autocomplete.ModelSelect2(url="provenance-autocomplete"),
             "provenance_notes": TextInputWidget(),
             "date": TextInputWidget(),
@@ -253,6 +251,12 @@ class Meta:
             "segment_m2m": CheckboxNameModelMultipleChoiceField,
         }
 
+    holding_institution = forms.ModelChoiceField(
+        queryset=Institution.objects.all(),
+        required=True,
+        widget=autocomplete.ModelSelect2(url="holding-autocomplete"),
+    )
+
     shelfmark = forms.CharField(
         required=True,
         widget=TextInputWidget,
@@ -411,9 +415,6 @@ class Meta:
             "other_editors",
         ]
         widgets = {
-            "holding_institution": autocomplete.ModelSelect2(
-                url="holding-autocomplete"
-            ),
             "segment_m2m": CheckboxSelectMultiple(),
             "provenance": autocomplete.ModelSelect2(url="provenance-autocomplete"),
             "provenance_notes": TextInputWidget(),
@@ -455,6 +456,12 @@ class Meta:
         widget=TextInputWidget,
     )
 
+    holding_institution = forms.ModelChoiceField(
+        queryset=Institution.objects.all(),
+        required=True,
+        widget=autocomplete.ModelSelect2(url="holding-autocomplete"),
+    )
+
     CHOICES_FULL_SOURCE = (
         (None, "None"),
         (True, "Full source"),
@@ -731,6 +738,11 @@ class Meta:
         widget=TextInputWidget,
     )
 
+    holding_institution = forms.ModelChoiceField(
+        queryset=Institution.objects.all().order_by("name"),
+        required=True,
+    )
+
     provenance = forms.ModelChoiceField(
         queryset=Provenance.objects.all().order_by("name"),
         required=False,
diff --git a/django/cantusdb_project/main_app/models/source.py b/django/cantusdb_project/main_app/models/source.py
index 988942128..919fbac20 100644
--- a/django/cantusdb_project/main_app/models/source.py
+++ b/django/cantusdb_project/main_app/models/source.py
@@ -42,13 +42,13 @@ class Source(BaseModel):
     holding_institution = models.ForeignKey(
         "Institution",
         on_delete=models.PROTECT,
-        null=True,
-        blank=True,
+        null=False,
+        blank=False,
     )
     shelfmark = models.CharField(
         max_length=255,
-        blank=True,
-        null=True,
+        blank=False,
+        null=False,
     )
     provenance = models.ForeignKey(
         "Provenance",

From c7f760c3ccc879d702f531471c30dde337106560 Mon Sep 17 00:00:00 2001
From: lucasmarchd01 <lucasmarchd01@gmail.com>
Date: Fri, 23 Aug 2024 18:42:01 +0000
Subject: [PATCH 4/7] fix(source): change templates to include required fields
 - holding institution and shelfmark fields are now required - fixes incorrect
 use of <small> tag on these fields

---
 .../main_app/templates/source_create.html            | 12 ++++++------
 .../main_app/templates/source_edit.html              | 12 ++++++------
 2 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/django/cantusdb_project/main_app/templates/source_create.html b/django/cantusdb_project/main_app/templates/source_create.html
index f3a98c67e..62a8d50a3 100644
--- a/django/cantusdb_project/main_app/templates/source_create.html
+++ b/django/cantusdb_project/main_app/templates/source_create.html
@@ -45,10 +45,10 @@ <h3>Create Source</h3>
             <form method="post" style="line-height: normal">{% csrf_token %}
                 <div class="form-row">
                     <div class="form-group m-1 col-lg-3">
-                        <label for="{{ form.holding_institution.id_for_label }}">
-                            <small>Holding Institution:</small>
+                        <label for="{{ form.holding_institution.id_for_label }}" class="form-control-sm">
+                            Holding Institution:<span class="text-danger" title="This field is required">*</span>
                         </label>
-                        <br>{{ form.holding_institution }}
+                        {{ form.holding_institution }}
                         <p class=text-muted>
                             <small>{{ form.holding_institution.help_text }}</small>
                         </p>
@@ -56,10 +56,10 @@ <h3>Create Source</h3>
                 </div>
                 <div class="form-row">
                     <div class="form-group m-1 col-lg-3">
-                        <label for="{{ form.shelfmark.id_for_label }}">
-                            <small>Shelfmark:</small><span class="text-danger" title="This field is required">*</span></small>
+                        <label for="{{ form.shelfmark.id_for_label }}" class="form-control-sm">
+                            Shelfmark:<span class="text-danger" title="This field is required">*</span>
                         </label>
-                        <br>{{ form.shelfmark }}
+                        {{ form.shelfmark }}
                         <p class=text-muted>
                             <small>{{ form.shelfmark.help_text }}</small>
                         </p>
diff --git a/django/cantusdb_project/main_app/templates/source_edit.html b/django/cantusdb_project/main_app/templates/source_edit.html
index a5390f112..89d876b07 100644
--- a/django/cantusdb_project/main_app/templates/source_edit.html
+++ b/django/cantusdb_project/main_app/templates/source_edit.html
@@ -47,10 +47,10 @@ <h3>
     <form method="post" style="line-height: normal">{% csrf_token %}
         <div class="form-row">
             <div class="form-group m-1 col-lg-3">
-                <label for="{{ form.holding_institution.id_for_label }}">
-                    <small>Holding Institution:</small>
+                <label for="{{ form.holding_institution.id_for_label }}" class="form-control-sm">
+                    Holding Institution:<span class="text-danger" title="This field is required">*</span>
                 </label>
-                <br>{{ form.holding_institution }}
+                {{ form.holding_institution }}
                 <p class=text-muted>
                     <small>{{ form.holding_institution.help_text }}</small>
                 </p>
@@ -58,10 +58,10 @@ <h3>
         </div>
         <div class="form-row">
             <div class="form-group m-1 col-lg-3">
-                <label for="{{ form.shelfmark.id_for_label }}">
-                    <small>Shelfmark:</small><span class="text-danger" title="This field is required">*</span></small>
+                <label for="{{ form.shelfmark.id_for_label }}" class="form-control-sm">
+                    Shelfmark:<span class="text-danger" title="This field is required">*</span>
                 </label>
-                <br>{{ form.shelfmark }}
+                {{ form.shelfmark }}
                 <p class=text-muted>
                     <small>{{ form.shelfmark.help_text }}</small>
                 </p>

From 86d22c59847871f2e01baec0ff88e37a725b060d Mon Sep 17 00:00:00 2001
From: lucasmarchd01 <lucasmarchd01@gmail.com>
Date: Fri, 23 Aug 2024 18:57:40 +0000
Subject: [PATCH 5/7] test(source): fix failing tests in SourceEditViewTest and
 SourceCreateViewTest - add holding institution required field

---
 django/cantusdb_project/main_app/tests/test_views.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/django/cantusdb_project/main_app/tests/test_views.py b/django/cantusdb_project/main_app/tests/test_views.py
index ae156bede..f4e8aa7e3 100644
--- a/django/cantusdb_project/main_app/tests/test_views.py
+++ b/django/cantusdb_project/main_app/tests/test_views.py
@@ -4679,10 +4679,12 @@ def test_url_and_templates(self):
         self.assertTemplateUsed(response, "source_create.html")
 
     def test_create_source(self):
+        hinst = make_fake_institution(siglum="FA-Ke")
         response = self.client.post(
             reverse("source-create"),
             {
                 "shelfmark": "test-shelfmark",  # shelfmark is a required field
+                "holding_institution": hinst.id, # holding institution is a required field
             },
         )
 
@@ -4729,11 +4731,13 @@ def test_url_and_templates(self):
 
     def test_edit_source(self):
         source = make_fake_source()
+        hinst = make_fake_institution(siglum="FA-Ke")
 
         response = self.client.post(
             reverse("source-edit", args=[source.id]),
             {
                 "shelfmark": "test-shelfmark",  # shelfmark is a required field,
+                "holding_institution": hinst.id, # holding institution is a required field
             },
         )
 

From c69f53a335eb614ffa908c86aec317f208c1fb08 Mon Sep 17 00:00:00 2001
From: Lucas <lucas.march@mail.mcgill.ca>
Date: Fri, 30 Aug 2024 14:11:01 +0000
Subject: [PATCH 6/7] new: add migration script for non-nullable fields

---
 ...ter_source_holding_institution_and_more.py | 32 +++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 django/cantusdb_project/main_app/migrations/0031_alter_source_holding_institution_and_more.py

diff --git a/django/cantusdb_project/main_app/migrations/0031_alter_source_holding_institution_and_more.py b/django/cantusdb_project/main_app/migrations/0031_alter_source_holding_institution_and_more.py
new file mode 100644
index 000000000..e793e3991
--- /dev/null
+++ b/django/cantusdb_project/main_app/migrations/0031_alter_source_holding_institution_and_more.py
@@ -0,0 +1,32 @@
+# Generated by Django 4.2.14 on 2024-08-30 13:58
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("main_app", "0030_institution_is_private_collection"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="source",
+            name="holding_institution",
+            field=models.ForeignKey(
+                default=19,
+                on_delete=django.db.models.deletion.PROTECT,
+                to="main_app.institution",
+            ),
+            preserve_default=False,
+        ),
+        migrations.AlterField(
+            model_name="source",
+            name="shelfmark",
+            field=models.CharField(
+                default="XX-NN",
+                max_length=255,
+            ),
+        ),
+    ]

From d39d486efe6c5b076398915bba4cbf4e5180eb56 Mon Sep 17 00:00:00 2001
From: Lucas <lucas.march@mail.mcgill.ca>
Date: Fri, 30 Aug 2024 14:11:13 +0000
Subject: [PATCH 7/7] style: black formatting changes

---
 django/cantusdb_project/main_app/admin/institution.py | 11 +++++++++--
 .../cantusdb_project/main_app/models/institution.py   |  2 +-
 django/cantusdb_project/main_app/tests/test_views.py  |  4 ++--
 3 files changed, 12 insertions(+), 5 deletions(-)

diff --git a/django/cantusdb_project/main_app/admin/institution.py b/django/cantusdb_project/main_app/admin/institution.py
index d7016ec00..204492079 100644
--- a/django/cantusdb_project/main_app/admin/institution.py
+++ b/django/cantusdb_project/main_app/admin/institution.py
@@ -32,9 +32,16 @@ class InstitutionAdmin(BaseModelAdmin):
         "get_city_region",
         "country",
         "is_private_collector",
-        "is_private_collection"
+        "is_private_collection",
+    )
+    search_fields = (
+        "name",
+        "siglum",
+        "city",
+        "region",
+        "alternate_names",
+        "migrated_identifier",
     )
-    search_fields = ("name", "siglum", "city", "region", "alternate_names", "migrated_identifier")
     readonly_fields = ("migrated_identifier",)
     list_filter = ("is_private_collector", "is_private_collection", "city")
     inlines = (InstitutionIdentifierInline, InstitutionSourceInline)
diff --git a/django/cantusdb_project/main_app/models/institution.py b/django/cantusdb_project/main_app/models/institution.py
index 424bd5dba..e38450d90 100644
--- a/django/cantusdb_project/main_app/models/institution.py
+++ b/django/cantusdb_project/main_app/models/institution.py
@@ -66,7 +66,7 @@ class Meta:
         max_length=64,
         blank=True,
         null=True,
-        help_text="Former Cantus identifier. Should not be used for new records."
+        help_text="Former Cantus identifier. Should not be used for new records.",
     )
 
     def __str__(self) -> str:
diff --git a/django/cantusdb_project/main_app/tests/test_views.py b/django/cantusdb_project/main_app/tests/test_views.py
index 6515c45ae..4beb96e22 100644
--- a/django/cantusdb_project/main_app/tests/test_views.py
+++ b/django/cantusdb_project/main_app/tests/test_views.py
@@ -4724,7 +4724,7 @@ def test_create_source(self):
             reverse("source-create"),
             {
                 "shelfmark": "test-shelfmark",  # shelfmark is a required field
-                "holding_institution": hinst.id, # holding institution is a required field
+                "holding_institution": hinst.id,  # holding institution is a required field
             },
         )
 
@@ -4777,7 +4777,7 @@ def test_edit_source(self):
             reverse("source-edit", args=[source.id]),
             {
                 "shelfmark": "test-shelfmark",  # shelfmark is a required field,
-                "holding_institution": hinst.id, # holding institution is a required field
+                "holding_institution": hinst.id,  # holding institution is a required field
             },
         )