The changes made in this commit include:

- Added `src/signals/migrations/0004_rename_format_signal_format_type.py`
- Modified `src/signals/admin.py` to change `format` to `format_type`
- Modified `src/signals/filters.py` to change `format` to `format_type`
- Modified `src/signals/models.py` to change `format` to `format_type`
- Modified `src/signals/tests/factories.py` to change `format` to `format_type`
- Added `src/signals/tests/test_api.py` to test the API view for the signal list
- Modified `src/signals/views.py` to change `format` to `format_type`
- Modified `src/templates/signals/signal_detail.html` to change `signal.format` to `signal.format_type`
- Modified `src/templates/signals/signal_list.html` to change `filter.form.format` to `filter.form.format_type`

Author: BrainIsDead

src/signals/admin.py

@@ -57,13 +57,13 @@ class SignalAdmin(ImportExportModelAdmin):
     list_display: tuple[Literal['name']] = ('name',)
     search_fields: tuple[Literal['name'], Literal['description'], Literal['short_description']]
     search_fields = ('name', 'description', 'short_description')
-    list_filter: tuple[Literal['pathogen'], Literal['available_geography'], Literal['signal_type'], Literal['format'],
+    list_filter: tuple[Literal['pathogen'], Literal['available_geography'], Literal['signal_type'], Literal['format_type'],
                        Literal['is_smoothed'], Literal['is_weighted'], Literal['is_cumulative'], Literal['has_stderr'], Literal['has_sample_size']]
     list_filter = (
         'pathogen',
         'available_geography',
         'signal_type',
-        'format',
+        'format_type',
         'is_smoothed',
         'is_weighted',
         'is_cumulative',

src/signals/filters.py

@@ -22,7 +22,7 @@ class Meta:
             'available_geography',
             'signal_type',
             'category',
-            'format',
+            'format_type',
             'source',
             'time_label',
         ]

src/signals/migrations/0004_rename_format_signal_format_type.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.6 on 2023-11-01 16:40
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('signals', '0003_alter_signal_options'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='signal',
+            old_name='format',
+            new_name='format_type',
+        ),
+    ]

src/signals/models.py

@@ -177,7 +177,7 @@ class Signal(TimeStampedModel):
         null=True,
         blank=True
     )
-    format = models.CharField(
+    format_type = models.CharField(
         help_text=_('Format'),
         max_length=128,
         choices=FormatChoices.choices

src/signals/tests/factories.py

@@ -71,7 +71,7 @@ class SignalFactory(DjangoModelFactory):
     active = fake.boolean()
     short_description = fake.text(max_nb_chars=500)
     description = fake.text(max_nb_chars=500)
-    format = fake.random_element(FormatChoices.values)
+    format_type = fake.random_element(FormatChoices.values)
     time_type = fake.random_element(TimeTypeChoices.values)
     time_label = fake.random_element(TimeLabelChoices.values)
     category = SubFactory(SignalCategoryFactory)

src/signals/tests/test_api.py

@@ -0,0 +1,52 @@
+from django.urls import reverse
+from faker import Faker
+from rest_framework.test import APITestCase
+
+from signals.models import Signal
+from signals.tests.factories import SignalFactory
+
+fake = Faker()
+
+
+class SignalListApiViewTest(APITestCase):
+
+    def setUp(self):
+        for i in range(fake.random_int(min=1, max=100)):
+            SignalFactory()
+
+    def test_signal_list_api_view(self):
+        response = self.client.get(reverse('signals_api'))
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.data['count'], Signal.objects.count())
+
+    def test_signal_list_api_view_filters(self):
+        signal = Signal.objects.order_by("?").first()
+        signal.base = signal
+        signal.save()
+        response = self.client.get(reverse('signals_api'), {'name': signal.name})
+        for result in response.json()['results']:
+            self.assertEqual(signal.name, result['name'])
+        response = self.client.get(reverse('signals_api'), {'pathogen__name': signal.pathogen.first().name})
+        for result in response.json()['results']:
+            self.assertTrue(signal.pathogen.first().name in result['pathogen'])
+        response = self.client.get(reverse('signals_api'), {'available_geography__name': signal.available_geography.first().name})
+        for result in response.json()['results']:
+            self.assertTrue(signal.available_geography.first().name in result['available_geography'])
+        response = self.client.get(reverse('signals_api'), {'signal_type__name': signal.signal_type.first().name})
+        for result in response.json()['results']:
+            self.assertTrue(signal.signal_type.first().name in result['signal_type'])
+        response = self.client.get(reverse('signals_api'), {'category__name': signal.category.name})
+        for result in response.json()['results']:
+            self.assertTrue(signal.category.name in result['category'])
+        response = self.client.get(reverse('signals_api'), {'source__name': signal.source.name})
+        for result in response.json()['results']:
+            self.assertTrue(signal.source.name in result['source'])
+        response = self.client.get(reverse('signals_api'), {'time_label': signal.time_label})
+        for result in response.json()['results']:
+            self.assertEqual(signal.time_label, result['time_label'])
+        response = self.client.get(reverse('signals_api'), {'format_type': signal.format_type})
+        for result in response.json()['results']:
+            self.assertEqual(signal.format_type, result['format_type'])
+        response = self.client.get(reverse('signals_api'), {'base': signal.base.id})
+        for result in response.json()['results']:
+            self.assertEqual(signal.base.id, result['base']['id'])

src/signals/views.py

@@ -77,7 +77,7 @@ class SignalsListApiView(ListAPIView):
         'available_geography__name',
         'signal_type__name',
         'category__name',
-        'format',
+        'format_type',
         'base',
         'source__name',
         'time_label',

src/templates/signals/signal_detail.html

@@ -72,7 +72,7 @@ <h5 class="card-title">Details</h5>
 
                   <div class="row">
                     <div class="col-lg-3 col-md-4 label">Format:</div>
-                    <div class="col-lg-9 col-md-8">{{ signal.format|title }}</div>
+                    <div class="col-lg-9 col-md-8">{{ signal.format_type|title }}</div>
                   </div>
 
                   <br>

src/templates/signals/signal_list.html

@@ -152,9 +152,9 @@ <h5 class="card-title">{{ filter.form.category.label }}</h5>
           </div>
           <div class="form-group">
             <div class="card-body">
-              <h5 class="card-title">{{ filter.form.format.label }}</h5>
-              <select name="{{ filter.form.format.name }}" class="form-select">
-                {% for choice in filter.form.format.field.choices %}
+              <h5 class="card-title">{{ filter.form.format_type.label }}</h5>
+              <select name="{{ filter.form.format_type.name }}" class="form-select">
+                {% for choice in filter.form.format_type.field.choices %}
                   <option value="{{ choice.0 }}">{{ choice.1 }}</option>
                 {% endfor %}
               </select>