Merge pull request #124 from fpdcc/patch/survey-fieldname

Change survey "job number" field display to "control number"

Author: xmedr

docsearch/migrations/0016_auto_20250520_0947.py

@@ -0,0 +1,21 @@
+# Generated by Django 2.2.13 on 2025-05-20 14:47
+
+import django.contrib.postgres.fields
+from django.db import migrations, models
+import docsearch.models
+import docsearch.validators
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('docsearch', '0015_auto_20230829_0939'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='survey',
+            name='job_number',
+            field=models.CharField(blank=True, max_length=255, null=True, verbose_name='control number'),
+        ),
+    ]

docsearch/models.py

@@ -376,7 +376,7 @@ class Survey(BaseDocumentModel):
     map_number = models.CharField(max_length=255, null=True, blank=True)
     location = models.TextField(blank=True, null=True)
     description = models.TextField(blank=True, null=True)
-    job_number = models.CharField(max_length=255, blank=True, null=True)
+    job_number = models.CharField(max_length=255, blank=True, null=True, verbose_name="control number")
     number_of_sheets = models.CharField(max_length=255, blank=True, null=True, validators=[validate_positive_int])
     date = models.CharField(max_length=255, blank=True, null=True, validators=[validate_date], help_text=DATE_FIELD_HELP_TEXT)
     cross_ref_area = models.PositiveIntegerField(blank=True, null=True, validators=[validate_int_btwn(1, 33)])

docsearch/templates/docsearch/base_search.html

@@ -182,7 +182,7 @@ <h5 class="mb-0">
             <h6 class="float-lg-right">
               Sort by:
               <select class="sort-select">
-                <option value=""></option>
+                <option value="">---</option>
                 {% for sort_option in view.get_sort_options %}
                   <option
                     value="?{% set_param parameters 'sort' sort_option.value %}"

docsearch/views/base.py

@@ -191,16 +191,21 @@ def get_sort_options(self):
         # the values and labels of sort fields, but for now the
         # conversion rule is pretty simple
         sort_options = []
-        for sort_field in self.sort_fields:
-            label = sort_field
-            replacements = [
+        replacements = [
                 ('_exact$', ''),
                 ('_arr$', ''),
                 ('_', ' ')
             ]
+
+        # There is one exception with this renamed field
+        if self.model == models.Survey:
+            replacements.append(('job number', 'control number'))
+
+        for sort_field in self.sort_fields:
+            label = sort_field
             for pattern, new_pattern in replacements:
                 label = re.sub(pattern, new_pattern, label)
-            sort_options.append({'value': sort_field, 'label': label})
+            sort_options.append({'value': sort_field, 'label': label.capitalize()})
         return sort_options