Merge pull request #128 from UNLV-CS472-672/calendar_events_model

4th PR: Calendar Events Model

Author: aviendha-andrus

backend/apps/planner/__init__.py

@@ -0,0 +1,7 @@
+from django.contrib import admin
+from .models import CalendarEvent
+
+@admin.register(CalendarEvent)
+class CalendarEventAdmin(admin.ModelAdmin):
+    list_display = ("title", "date", "start_time", "end_time", "event_type", "related_task")
+    

backend/apps/planner/admin.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+class PlannerConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'apps.planner'

backend/apps/planner/apps.py

@@ -0,0 +1,20 @@
+from django.db import models
+from django.apps import apps
+from django.utils import timezone
+
+class CalendarEventManager(models.Manager):
+    def upcoming_events(self):
+        """Get events that occur in the future."""
+        return self.filter(date__gte=timezone.now().date())
+
+    def past_events(self):
+        """Get events that have already occurred."""
+        return self.filter(date__lt=timezone.now().date())
+
+    def events_for_date(self, date):
+        """Get events for a specific date."""
+        return self.filter(date=date)
+
+    def events_by_type(self, event_type):
+        """Get events by event type."""
+        return self.filter(event_type=event_type)

backend/apps/planner/managers.py

@@ -0,0 +1,33 @@
+# Generated by Django 5.1.6 on 2025-04-06 22:53
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('lessons', '0006_assignment_upload_record'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='CalendarEvent',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('title', models.CharField(max_length=63)),
+                ('date', models.DateField()),
+                ('start_time', models.TimeField()),
+                ('end_time', models.TimeField()),
+                ('description', models.TextField(blank=True, null=True)),
+                ('event_type', models.CharField(blank=True, choices=[('lesson', 'Lesson'), ('meeting', 'Meeting'), ('reminder', 'Reminder'), ('practice', 'Practice')], default='lesson', max_length=20, null=True)),
+                ('related_task', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to='lessons.assignment')),
+            ],
+            options={
+                'verbose_name': 'Calendar Event',
+                'verbose_name_plural': 'Calendar Events',
+            },
+        ),
+    ]

backend/apps/planner/migrations/0001_initial.py

@@ -0,0 +1,28 @@
+# Generated by Django 5.1.6 on 2025-04-09 05:40
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('planner', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='calendarevent',
+            name='location',
+            field=models.TextField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='calendarevent',
+            name='virtual',
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AlterField(
+            model_name='calendarevent',
+            name='event_type',
+            field=models.CharField(choices=[('lesson', 'Lesson'), ('meeting', 'Meeting'), ('reminder', 'Reminder'), ('practice', 'Practice')], default='lesson', max_length=20),
+        ),
+    ]

backend/apps/planner/migrations/0002_calendarevent_location_calendarevent_virtual_and_more.py

@@ -0,0 +1,71 @@
+from django.db import models
+from django.utils import timezone
+from django.core.exceptions import ValidationError
+from apps.planner.managers import CalendarEventManager
+
+class CalendarEvent(models.Model):
+    # Constants for event type choices
+    LESSON = 'lesson'
+    MEETING = 'meeting'
+    REMINDER = 'reminder'
+    PRACTICE = 'practice'
+
+    EVENT_TYPES = [
+        (LESSON, 'Lesson'),
+        (MEETING, 'Meeting'),
+        (REMINDER, 'Reminder'),
+        (PRACTICE, 'Practice')
+    ]
+
+    # Calendar event fields 
+    title = models.CharField(max_length=63)
+    date = models.DateField(blank=False, null=False)
+    start_time = models.TimeField(blank=False, null=False)
+    end_time = models.TimeField(blank=False, null=False)
+    description = models.TextField(blank=True, null=True) 
+    # related_unscheduled_task = models.ForeignKey(UnscheduledTask, on_delete=models.CASCADE, blank=True, null=True)
+    related_task = models.ForeignKey(
+        'lessons.Assignment', 
+        on_delete=models.CASCADE, 
+        blank=True,
+        null=True
+    )
+    event_type = models.CharField(
+        max_length=20,
+        choices=EVENT_TYPES,
+        default=LESSON
+    )
+    location = models.TextField(blank=True, null=True) 
+    virtual = models.BooleanField(default=False)
+
+    objects = CalendarEventManager()
+
+    class Meta:
+        # For human readability and clarity
+        verbose_name = "Calendar Event"
+        verbose_name_plural = "Calendar Events"
+    
+    def __str__(self):
+        # To assist with debuging 
+        return (
+            f"{self.title} ({self.get_event_type_display()}) "
+            f"on {self.date} from {self.start_time} to {self.end_time}"
+        )
+
+    def clean(self):
+        # Ensure that the start_time is before the end_time
+        if self.start_time and self.end_time: # Not null 
+            if self.start_time >= self.end_time:
+                raise ValidationError("End time must be after the start time.")
+        # Ensure that both start and end time are provided
+        elif self.start_time or self.end_time:
+            raise ValidationError("Both start time and end time must be provided.")
+        
+        # Ensure the event is not scheduled in the past
+        if self.start_time and self.end_time: # not null 
+            if self.date < timezone.now().date():
+                raise ValidationError("The event date cannot be in the past.")
+            elif self.date == timezone.now().date() and self.start_time < timezone.now().time():
+                raise ValidationError("The event start time cannot be in the past.")
+        elif self.start_time or self.end_time:
+            raise ValidationError("Both start time and end time must be provided.")

backend/apps/planner/migrations/__init__.py

@@ -0,0 +1,8 @@
+from rest_framework import serializers
+from .models import CalendarEvent
+
+class CalendarEventSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = CalendarEvent
+        fields = '__all__'
+

backend/apps/planner/models.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.