OKRS24-217 Updated filters.

Author: dmytrotsko

src/datasources/admin.py

@@ -12,7 +12,7 @@ class SourceSubdivisionAdmin(ImportExportModelAdmin):
     """
     Admin interface for managing source subdivision objects.
     """
-    list_display: tuple[Literal['name'], Literal['db_source']] = ('name', 'db_source')
+    list_display: tuple[Literal['name'], Literal['db_source'], Literal['external_name']] = ('name', 'db_source', 'external_name')
     search_fields: tuple[Literal['name'], Literal['db_source']] = ('name', 'db_source')
     resource_classes: list[type[SourceSubdivisionResource]] = [SourceSubdivisionResource]
 

src/fixtures/available_geography.json

@@ -4,6 +4,7 @@
       "pk": 1,
       "fields": {
         "name": "county",
+        "display_name": "L2 division (e.g. U.S. counties)",
         "created": "2023-08-09T19:23:22.597131",
         "modified": "2023-08-09T19:23:22.597131"
       }
@@ -13,6 +14,7 @@
       "pk": 2,
       "fields": {
         "name": "hhs",
+        "display_name": "HHS Regions",
         "created": "2023-08-09T19:23:22.597131",
         "modified": "2023-08-09T19:23:22.597131"
       }
@@ -22,6 +24,7 @@
       "pk": 3,
       "fields": {
         "name": "hrr",
+        "display_name": "Hospital Referral Regions (HRAs)",
         "created": "2023-08-09T19:23:22.597131",
         "modified": "2023-08-09T19:23:22.597131"
       }
@@ -31,6 +34,7 @@
       "pk": 4,
       "fields": {
         "name": "msa",
+        "display_name": "Metropolitan Statistical Areas (MSAs)",
         "created": "2023-08-09T19:23:22.597131",
         "modified": "2023-08-09T19:23:22.597131"
       }
@@ -40,6 +44,7 @@
       "pk": 5,
       "fields": {
         "name": "nation",
+        "display_name": "National",
         "created": "2023-08-09T19:23:22.597131",
         "modified": "2023-08-09T19:23:22.597131"
       }
@@ -49,6 +54,7 @@
       "pk": 6,
       "fields": {
         "name": "state",
+        "display_name": "L1 division (e.g. U.S. states)",
         "created": "2023-08-09T19:23:22.597131",
         "modified": "2023-08-09T19:23:22.597131"
       }
@@ -58,6 +64,7 @@
       "pk": 7,
       "fields": {
         "name": "dma",
+        "display_name": "Designated Market Areas (DMAs)",
         "created": "2023-08-09T19:23:22.597131",
         "modified": "2023-08-09T19:23:22.597131"
       }

src/signals/filters.py

@@ -16,6 +16,7 @@
     Signal,
     TimeTypeChoices,
     GeographicScope,
+    SeverityPyramidRungsChoices,
 )
 
 
@@ -42,6 +43,7 @@ class SignalFilter(django_filters.FilterSet):
         )
     )
     format_type = django_filters.MultipleChoiceFilter(choices=FormatChoices.choices)
+    severenity_pyramid_rungs = django_filters.MultipleChoiceFilter(choices=SeverityPyramidRungsChoices.choices)
     source = django_filters.ModelMultipleChoiceFilter(queryset=SourceSubdivision.objects.all())
     time_type = django_filters.MultipleChoiceFilter(choices=TimeTypeChoices.choices)
     base_signal = django_filters.BooleanFilter(lookup_expr='isnull', field_name='base_for')
@@ -59,7 +61,7 @@ class Meta:
             'pathogen',
             'active',
             'available_geography',
-            'signal_type',
+            'severenity_pyramid_rungs',
             'category',
             'geographic_scope',
             'source',

src/signals/forms.py

@@ -8,6 +8,7 @@
     Signal,
     TimeTypeChoices,
     GeographicScope,
+    SeverityPyramidRungsChoices,
 )
 
 
@@ -31,6 +32,7 @@ class SignalFilterForm(forms.ModelForm):
     time_type = forms.ChoiceField(choices=TimeTypeChoices.choices, widget=forms.CheckboxSelectMultiple())
     base_signal = forms.ChoiceField(choices=[('', _('All')), (True, _('Yes')), (False, _('No'))], required=False, widget=forms.RadioSelect())
     geographic_scope = forms.ModelMultipleChoiceField(queryset=GeographicScope.objects.all(), widget=forms.CheckboxSelectMultiple())
+    severenity_pyramid_rungs = forms.ChoiceField(choices=SeverityPyramidRungsChoices.choices, widget=forms.CheckboxSelectMultiple())
 
     class Meta:
         model = Signal
@@ -41,7 +43,7 @@ class Meta:
             'pathogen',
             'active',
             'available_geography',
-            'signal_type',
+            'severenity_pyramid_rungs',
             'source',
             'time_type',
             'geographic_scope',
@@ -59,11 +61,6 @@ class Meta:
                 'data-bs-toggle': 'tooltip',
                 'data-bs-placement': 'bottom',
             }),
-            'signal_type': forms.CheckboxSelectMultiple(attrs={
-                'class': 'form-select',
-                'data-bs-toggle': 'tooltip',
-                'data-bs-placement': 'bottom',
-            }),
             'source': forms.CheckboxSelectMultiple(attrs={
                 'class': 'form-select',
                 'data-bs-toggle': 'tooltip',

src/signals/migrations/0017_geography_display_name.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.10 on 2024-06-11 14:17
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('signals', '0016_remove_signal_geographic_scope_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='geography',
+            name='display_name',
+            field=models.CharField(blank=True, help_text='Display Name', max_length=128, null=True),
+        ),
+    ]

src/signals/models.py

@@ -153,6 +153,13 @@ class Geography(TimeStampedModel):
         unique=True
     )
 
+    display_name: models.CharField = models.CharField(
+        help_text=_('Display Name'),
+        max_length=128,
+        null=True,
+        blank=True
+    )
+
     class Meta:
         verbose_name_plural: str = "geographies"
         ordering: list[str] = ["name"]
@@ -164,7 +171,7 @@ def __str__(self) -> str:
         :return: The name of the available geography as a string.
         :rtype: str
         """
-        return str(self.name)
+        return str(self.display_name)
 
 
 class GeographySignal(models.Model):

src/signals/views.py

@@ -45,8 +45,8 @@ def get_url_params(self):
             ]
             if self.request.GET.get("available_geography")
             else None,
-            "signal_type": [int(el) for el in self.request.GET.getlist("signal_type")]
-            if self.request.GET.get("signal_type")
+            "severenity_pyramid_rungs": [el for el in self.request.GET.getlist("severenity_pyramid_rungs")]
+            if self.request.GET.get("severenity_pyramid_rungs")
             else None,
             "geographic_scope": [el for el in self.request.GET.getlist("geographic_scope")]
             if self.request.GET.get("geographic_scope")
@@ -121,7 +121,7 @@ class SignalsListApiView(ListAPIView):
         "display_name",
         "pathogen__name",
         "available_geography__name",
-        "signal_type__name",
+        "severenity_pyramid_rungs",
         "base",
         "source__name",
         "time_label",

src/templates/signals/signals.html

@@ -85,10 +85,10 @@ <h2 class="accordion-header" id="active-heading">
                                 </div>
                             </div>
                             <div class="accordion-item">
-                                <h2 class="accordion-header" id="severity_pyramid-heading">
+                                <h2 class="accordion-header" id="severenity_pyramid_rungs-heading">
                                     <button class="accordion-button collapsed" type="button" data-bs-toggle="collapse"
-                                    data-bs-target="#severity_pyramid-collapse" aria-expanded="false" aria-controls="active-collapse">
-                                        <label for="id_severity_pyramid" class="form-label">
+                                    data-bs-target="#severenity_pyramid_rungs-collapse" aria-expanded="false" aria-controls="active-collapse">
+                                        <label for="id_severenity_pyramid_rungs" class="form-label">
                                             Severity Pyramid
                                             <a tabindex="0" role="button" class="info-button" data-bs-toggle="popover"
                                             data-bs-title="Severity Pyramid"
@@ -98,17 +98,17 @@ <h2 class="accordion-header" id="severity_pyramid-heading">
                                         </label>
                                     </button>
                                 </h2>
-                                {% if form.signal_type.value %}
-                                <div id="signal_type-collapse" class="accordion-collapse" aria-labelledby="signal_type-heading">
+                                {% if form.severenity_pyramid_rungs.value %}
+                                <div id="severenity_pyramid_rungs-collapse" class="accordion-collapse" aria-labelledby="severenity_pyramid_rungs-heading">
                                 {% else %}
-                                <div id="signal_type-collapse" class="accordion-collapse collapse" aria-labelledby="signal_type-heading">
+                                <div id="severenity_pyramid_rungs-collapse" class="accordion-collapse collapse" aria-labelledby="severenity_pyramid_rungs-heading">
                                 {% endif %}
                                     <div class="accordion-body">
                                         <div class="bulk-select form-check">
                                             <input type="checkbox" class="form-check-input" id="select-all">
                                             <label class="form-check-label" for="select-all">Select all</label>
                                         </div>
-                                        {{ form.signal_type|as_crispy_field }}
+                                        {{ form.severenity_pyramid_rungs|as_crispy_field }}
                                     </div>
                                 </div>
                             </div>
@@ -142,7 +142,7 @@ <h2 class="accordion-header" id="source-heading">
                                     <button class="accordion-button collapsed" type="button" data-bs-toggle="collapse"
                                     data-bs-target="#source-collapse" aria-expanded="false" aria-controls="active-collapse">
                                         <label for="id_source" class="form-label">
-                                            Source
+                                            Data Source
                                             <a tabindex="0" role="button" class="info-button" data-bs-toggle="popover"
                                             data-bs-title="Source"
                                             data-bs-content="{{ filters_descriptions.SignalFilter.source }}">
@@ -170,9 +170,9 @@ <h2 class="accordion-header" id="time_type-heading">
                                     <button class="accordion-button collapsed" type="button" data-bs-toggle="collapse"
                                     data-bs-target="#time_type-collapse" aria-expanded="false" aria-controls="active-collapse">
                                         <label for="id_time_type" class="form-label">
-                                            Time Type
+                                            Temporal Granularity
                                             <a tabindex="0" role="button" class="info-button" data-bs-toggle="popover"
-                                            data-bs-title="Time Label"
+                                            data-bs-title="Temporal Granularity"
                                             data-bs-content="{{ filters_descriptions.SignalFilter.time_type }}">
                                                 <i class="bi bi-info-circle"></i>
                                             </a>