Add slug field for Event (#60)

Author: Palwisha-18

events/admin.py

@@ -52,9 +52,9 @@ class EventAdmin(admin.ModelAdmin):
 
     fieldsets = (
         (None, {
-            'fields': ('creator', 'title', 'description', 'event_time',
+            'fields': ('creator', 'title', 'slug', 'description', 'event_time',
                        'event_type', 'status', 'is_featured',
-                       'tags', 'playlists', 'videoasset')
+                       'tags', 'playlists', 'videoasset',)
         }),
     )
 

events/apps.py

@@ -5,3 +5,6 @@ class EventsConfig(AppConfig):
     """ Configuration for the events app """
     default_auto_field = 'django.db.models.BigAutoField'
     name = 'events'
+
+    def ready(self):
+        import events.signals  # pylint: disable=import-outside-toplevel, unused-import

events/forms.py

@@ -53,8 +53,16 @@ class Meta:
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-
         current_event = self.instance
+
+        # Disable slug field if the instance is new
+        if current_event and current_event.pk:
+            self.fields['slug'].disabled = False
+        else:
+            self.fields['slug'].disabled = True
+
+        # Populate videoasset queryset based on the current event
+        # If the event is new, show all video assets without an event
         qs = VideoAsset.objects.filter(event__isnull=True)
 
         if current_event.pk:

events/migrations/0009_event_slug.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.16 on 2025-06-10 01:47
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('events', '0008_alter_event_tags'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='event',
+            name='slug',
+            field=models.SlugField(blank=True, max_length=255, null=True),
+        ),
+    ]

events/migrations/0010_populate_event_slugs.py

@@ -0,0 +1,35 @@
+# Generated by Django 4.2.16 on 2025-06-10 02:02
+
+from django.db import migrations
+from django.utils.text import slugify
+
+def populate_event_slugs(apps, schema_editor):
+    Event = apps.get_model('events', 'Event')
+
+    titles_seen = {}
+
+    for event in Event.objects.all().order_by('id'):
+        if not event.slug:
+            base_slug = slugify(event.title)
+
+            if base_slug in titles_seen:
+                event.slug = f"{base_slug}-{event.id}"
+            else:
+                if Event.objects.filter(title=event.title).exclude(pk=event.pk).exists():
+                    event.slug = f"{base_slug}-{event.id}"
+                else:
+                    event.slug = base_slug
+
+                titles_seen[base_slug] = event.id
+
+            event.save(update_fields=['slug'])
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('events', '0009_event_slug'),
+    ]
+
+    operations = [
+        migrations.RunPython(populate_event_slugs, reverse_code=migrations.RunPython.noop),
+    ]

events/models.py

@@ -59,6 +59,7 @@ class EventStatus(models.TextChoices):
 
     creator = models.ForeignKey(User, on_delete=models.DO_NOTHING, related_name='events')
     title = models.CharField(max_length=255)
+    slug = models.SlugField(max_length=255, blank=True, null=True)
     description = models.TextField()
     event_time = models.DateTimeField()
     event_type = models.CharField(max_length=20, choices=EventType.choices, default=EventType.SESSION)

events/signals.py

@@ -0,0 +1,24 @@
+from django.db.models.signals import post_save
+from django.dispatch import receiver
+from django.utils.text import slugify
+
+from events.models import Event
+
+
+@receiver(post_save, sender=Event)
+def set_slug_on_create(_sender, instance, created, **kwargs):
+    """
+    Set a slug for the event instance if it is created and does not have a slug.
+    The slug is generated from the title and includes the event ID to ensure uniqueness.
+    """
+    if created and not instance.slug:
+        base_slug = slugify(instance.title)
+        exists_with_title = Event.objects.filter(title=instance.title).exclude(pk=instance.pk).exists()
+
+        if exists_with_title:
+            slug = f"{base_slug}-{instance.id}"
+        else:
+            slug = base_slug
+
+        instance.slug = slug
+        instance.save(update_fields=['slug'])

events/tests/conftest.py

@@ -0,0 +1,14 @@
+import pytest
+
+from django.db.models.signals import post_save
+
+from events.models import Event
+from events.signals import set_slug_on_create
+
+
+@pytest.fixture(autouse=True)
+def disable_event_signals():
+    """ Disable the post_save signal for Event during tests """
+    post_save.disconnect(set_slug_on_create, sender=Event)
+    yield
+    post_save.connect(set_slug_on_create, sender=Event)

events/v1/serializers.py

@@ -41,7 +41,7 @@ class EventSerializer(serializers.ModelSerializer):
     class Meta:
         model = Event
         fields = (
-            'id', 'title', 'description', 'publisher', 'event_time',
+            'id', 'title', 'slug', 'description', 'publisher', 'event_time',
             'event_type', 'status', 'is_featured', 'tags',
             'thumbnail', 'video_duration', 'presenters', 'playlists',
             'video_file'