Break CRUD routes

backend/courses/migrations/0066_meeting_associated_break_alter_meeting_section.py

@@ -0,0 +1,37 @@
+# Generated by Django 5.0.2 on 2025-01-26 19:34
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("courses", "0065_topic_historical_probabilities_fall_and_more"),
+        ("plan", "0010_break"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="meeting",
+            name="associated_break",
+            field=models.ForeignKey(
+                help_text="The Section object to which this class meeting belongs.",
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="meetings",
+                to="plan.break",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="meeting",
+            name="section",
+            field=models.ForeignKey(
+                help_text="The Section object to which this class meeting belongs.",
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="meetings",
+                to="courses.section",
+            ),
+        ),
+    ]

backend/courses/migrations/0067_alter_meeting_associated_break_and_more.py

@@ -0,0 +1,46 @@
+# Generated by Django 5.0.2 on 2025-02-16 23:31
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("courses", "0066_meeting_associated_break_alter_meeting_section"),
+        ("plan", "0014_break_unique_break_meeting_times_per_person"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="meeting",
+            name="associated_break",
+            field=models.ForeignKey(
+                help_text="The Break object to which this meeting object belongs.",
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="meetings",
+                to="plan.break",
+            ),
+        ),
+        migrations.AddConstraint(
+            model_name="meeting",
+            constraint=models.UniqueConstraint(
+                condition=models.Q(
+                    ("section__isnull", True), ("associated_break__isnull", True), _connector="OR"
+                ),
+                fields=("section", "associated_break"),
+                name="unique_meeting_either_section_or_break",
+            ),
+        ),
+        migrations.AddConstraint(
+            model_name="meeting",
+            constraint=models.UniqueConstraint(
+                condition=models.Q(
+                    ("section__isnull", True), ("associated_break__isnull", True), _negated=True
+                ),
+                fields=("section", "associated_break"),
+                name="meeting_must_have_section_or_break",
+            ),
+        ),
+    ]

backend/courses/models.py

@@ -7,7 +7,7 @@
 from django.core.exceptions import ValidationError
 from django.core.validators import MaxValueValidator, MinValueValidator
 from django.db import models, transaction
-from django.db.models import OuterRef, Q, Subquery
+from django.db.models import OuterRef, Q, Subquery, UniqueConstraint
 from django.db.models.signals import post_save
 from django.dispatch import receiver
 from django.utils import timezone
@@ -1126,10 +1126,20 @@ class Meeting(models.Model):
 
     section = models.ForeignKey(
         Section,
+        null=True,
         on_delete=models.CASCADE,
         related_name="meetings",
         help_text="The Section object to which this class meeting belongs.",
     )
+
+    associated_break = models.ForeignKey(
+        "plan.Break",
+        null=True,
+        on_delete=models.CASCADE,
+        related_name="meetings",
+        help_text="The Break object to which this meeting object belongs.",
+    )
+
     day = models.CharField(
         max_length=1,
         help_text="The single day on which the meeting takes place (one of M, T, W, R, or F).",
@@ -1180,8 +1190,26 @@ class Meeting(models.Model):
         ),
     )
 
+    def save(self, *args, **kwargs):
+        self.clean()
+        super().save(*args, **kwargs)
+
     class Meta:
         unique_together = (("section", "day", "start", "end", "room"),)
+        constraints = [
+            # Ensure that a meeting has either a section or an associated_break, but not both
+            UniqueConstraint(
+                fields=["section", "associated_break"],
+                condition=Q(section__isnull=True) | Q(associated_break__isnull=True),
+                name="unique_meeting_either_section_or_break",
+            ),
+            # Ensure that a meeting must have at least one (not both null)
+            UniqueConstraint(
+                fields=["section", "associated_break"],
+                condition=~(Q(section__isnull=True) & Q(associated_break__isnull=True)),
+                name="meeting_must_have_section_or_break",
+            ),
+        ]
 
     @staticmethod
     def int_to_time(time):

backend/courses/util.py

@@ -29,6 +29,7 @@
     StatusUpdate,
     User,
 )
+from plan.models import Break
 from review.management.commands.mergeinstructors import resolve_duplicates
 
 
@@ -465,17 +466,17 @@ def clean_meetings(meetings):
     }.values()
 
 
-def set_meetings(section, meetings):
+def set_meetings(obj, meetings):
     meetings = clean_meetings(meetings)
 
     for meeting in meetings:
         meeting["days"] = "".join(sorted(list(set(meeting["days"]))))
     meeting_times = [
         f"{meeting['days']} {meeting['begin_time']} - {meeting['end_time']}" for meeting in meetings
     ]
-    section.meeting_times = json.dumps(meeting_times)
+    obj.meeting_times = json.dumps(meeting_times)
 
-    section.meetings.all().delete()
+    obj.meetings.all().delete()
     for meeting in meetings:
         online = (
             not meeting["building_code"]
@@ -492,8 +493,10 @@ def set_meetings(section, meetings):
         start_date = extract_date(meeting.get("start_date"))
         end_date = extract_date(meeting.get("end_date"))
         for day in list(meeting["days"]):
+
             meeting = Meeting.objects.update_or_create(
-                section=section,
+                section=obj if isinstance(obj, Section) else None,
+                associated_break=obj if isinstance(obj, Break) else None,
                 day=day,
                 start=start_time,
                 end=end_time,

backend/plan/migrations/0010_break.py

@@ -0,0 +1,60 @@
+# Generated by Django 5.0.2 on 2025-01-26 19:34
+
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("plan", "0009_alter_schedule_sections"),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Break",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True, primary_key=True, serialize=False, verbose_name="ID"
+                    ),
+                ),
+                (
+                    "location_string",
+                    models.CharField(
+                        help_text="\nThis represents the location that the user can input themselves. \nWill use a building object from a drop down or have it validated or something so it can interact with map.\nDidn't want to run into issue of users creating arbitrary Room objects, so just using a char field\n",
+                        max_length=80,
+                        null=True,
+                    ),
+                ),
+                (
+                    "name",
+                    models.CharField(
+                        help_text="\nThe user's name for the break. No two breaks can match in all of the fields\n`[name, person]`\n",
+                        max_length=255,
+                    ),
+                ),
+                (
+                    "meeting_times",
+                    models.TextField(
+                        blank=True,
+                        help_text='\nA JSON-stringified list of meeting times of the form\n`{days code} {start time} - {end time}`, e.g.\n`["MWF 09:00 AM - 10:00 AM","F 11:00 AM - 12:00 PM","T 05:00 PM - 06:00 PM"]` for\nPHYS-151-001 (2020A). Each letter of the days code is of the form M, T, W, R, F for each\nday of the work week, respectively (and multiple days are combined with concatenation).\nTo access the Meeting objects for this section, the related field `meetings` can be used.\n',
+                    ),
+                ),
+                (
+                    "person",
+                    models.ForeignKey(
+                        help_text="The person (user) who created this break.",
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+            ],
+            options={
+                "unique_together": {("name", "person")},
+            },
+        ),
+    ]

backend/plan/migrations/0011_alter_break_unique_together_and_more.py

@@ -0,0 +1,28 @@
+# Generated by Django 5.0.2 on 2025-02-16 17:38
+
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("plan", "0010_break"),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.AlterUniqueTogether(
+            name="break",
+            unique_together={("person",)},
+        ),
+        migrations.AlterField(
+            model_name="break",
+            name="location_string",
+            field=models.CharField(
+                help_text="\nThis represents the location that the user can input themselves.\nWill use a building object from a drop down or have it validated\nor something so it can interact with map.\nDidn't want to run into issue of users creating arbitrary\nRoom objects, so just using a char field\n",
+                max_length=80,
+                null=True,
+            ),
+        ),
+    ]

backend/plan/migrations/0012_alter_break_unique_together.py

@@ -0,0 +1,19 @@
+# Generated by Django 5.0.2 on 2025-02-16 18:01
+
+from django.conf import settings
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("plan", "0011_alter_break_unique_together_and_more"),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.AlterUniqueTogether(
+            name="break",
+            unique_together={("person", "meeting_times")},
+        ),
+    ]

backend/plan/migrations/0013_alter_break_unique_together.py

@@ -0,0 +1,17 @@
+# Generated by Django 5.0.2 on 2025-02-16 18:05
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("plan", "0012_alter_break_unique_together"),
+    ]
+
+    operations = [
+        migrations.AlterUniqueTogether(
+            name="break",
+            unique_together=set(),
+        ),
+    ]

backend/plan/migrations/0014_break_unique_break_meeting_times_per_person.py

@@ -0,0 +1,25 @@
+# Generated by Django 5.0.2 on 2025-02-16 18:10
+
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("plan", "0013_alter_break_unique_together"),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.AddConstraint(
+            model_name="break",
+            constraint=models.UniqueConstraint(
+                condition=models.Q(
+                    ("meeting_times__isnull", False), models.Q(("meeting_times", ""), _negated=True)
+                ),
+                fields=("person", "meeting_times"),
+                name="unique_break_meeting_times_per_person",
+            ),
+        ),
+    ]