Merge pull request #428 from hburgund/speaker-relationships

Speaker relationships for looping recording and playback projects

Author: hburgund

roundware/api2/filters.py

@@ -242,10 +242,14 @@ class Meta:
 class SpeakerFilterSet(django_filters.FilterSet):
     activeyn = django_filters.TypedChoiceFilter(choices=BOOLEAN_CHOICES, coerce=strtobool)
     project_id = django_filters.NumberFilter()
+    parent_ids_or = IntegerListFilter(field_name='parents', lookup_expr='in') # performs OR filtering
+    parent_ids = IntegerListAndFilter(field_name='parents__id') # performs AND filtering
+    children_ids_or = IntegerListFilter(field_name='children', lookup_expr='in') # performs OR filtering
+    children_ids = IntegerListAndFilter(field_name='children__id') # performs AND filtering 
 
     class Meta:
         model = Speaker
-        fields = ["activeyn", "project_id"]
+        fields = ["activeyn", "project_id", "parents", "children"]
 
 
 class TagFilterSet(django_filters.FilterSet):

roundware/api2/serializers.py

@@ -342,10 +342,17 @@ def to_representation(self, obj):
 
 
 class SpeakerSerializer(serializers.ModelSerializer):
+    children = serializers.SerializerMethodField()
+
     class Meta:
         model = Speaker
         fields = "__all__"
 
+    def get_children(self, obj):
+        # Access the reverse relationship via `children`
+        return obj.children.values_list('id', flat=True)  # Return IDs of children
+    
+
     def to_representation(self, obj):
         result = super(SpeakerSerializer, self).to_representation(obj)
         result["project_id"] = result["project"]

roundware/api2/views.py

@@ -1215,8 +1215,8 @@ class SpeakerViewSet(viewsets.ViewSet):
     API V2: api/2/speakers/
             api/2/speakers/:id/
     """
-    queryset = Speaker.objects.all()
-    permission_classes = (IsAuthenticated,)
+    queryset = Speaker.objects.prefetch_related('children', 'parents')
+    permission_classes = (IsAuthenticated, )
 
     def get_object(self, pk):
         try:

roundware/rw/admin.py

@@ -493,14 +493,15 @@ class SpeakerAdmin(LeafletGeoAdmin, ProjectProtectedModelAdmin):
     list_display = ('id', 'activeyn', 'code', 'project', 'maxvolume', 'minvolume', 'shape', 'uri')
     list_filter = ('project', 'activeyn')
     list_editable = ('activeyn', 'maxvolume', 'minvolume', 'shape')
+    filter_horizontal = ('parents', )
     ordering = ['id']
     save_as = True
     save_on_top = True
     map_width = "400px"
 
     fieldsets = (
         (None, {
-            'fields': ('activeyn', 'code', 'project', 'maxvolume', 'minvolume', 'uri', )
+            'fields': ('activeyn', 'code', 'project', 'maxvolume', 'minvolume', 'uri', 'parents' )
         }),
         ('Geographical Data', {
             'fields': ('shape', 'attenuation_distance'),

roundware/rw/migrations/0040_speaker_parents.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.0 on 2024-11-16 12:30
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('rw', '0039_uiitem_filter_remove_validation'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='speaker',
+            name='parents',
+            field=models.ManyToManyField(blank=True, related_name='children', to='rw.Speaker'),
+        ),
+    ]

roundware/rw/models.py

@@ -546,6 +546,8 @@ def __init__(self, *args, **kwargs):
     attenuation_distance = models.IntegerField()
     attenuation_border = models.GeometryField(geography=True, null=True, editable=False)
 
+    parents = models.ManyToManyField('Speaker', related_name='children', symmetrical=False, blank=True)
+
     objects = GeoManager()
 
     def __str__(self):

roundware/rw/tests/test_models.py

@@ -107,3 +107,19 @@ def test_get_flags(self):
 
     def test_distance(self):
         distance = self.asset1.distance({'latitude': 0, 'longitude': 0})
+
+class TestSpeaker(RWTestCase):
+
+    def setUp(self):
+        super().setUp()
+
+        self.project = baker.make('rw.Project')
+        self.speaker1 = baker.make('rw.Speaker', project=self.project)
+        self.speaker2 = baker.make('rw.Speaker', project=self.project, parents=[self.speaker1])
+       
+    def test_speaker_children(self):
+        self.assertEqual(self.speaker1.parents.count(), 0)
+        self.assertEqual(self.speaker2.parents.count(), 1)
+        self.assertEqual(self.speaker1.children.count(), 1)
+        self.assertEqual(self.speaker2.children.count(), 0)
+