Create abstract classes for Position and PositionPayPeriods

payroll/migrations/0013_vacancy_fte_alter_vacancy_grade_vacancypayperiods_and_more.py

@@ -0,0 +1,84 @@
+# Generated by Django 4.2.16 on 2024-11-19 16:21
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        (
+            "gifthospitality",
+            "0006_alter_simplehistorygiftandhospitality_options_and_more",
+        ),
+        ("core", "0013_alter_historicalgroup_options_and_more"),
+        ("payroll", "0012_employee_assignment_status_employee_fte_and_more"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="vacancy",
+            name="fte",
+            field=models.FloatField(default=1.0),
+        ),
+        migrations.AlterField(
+            model_name="vacancy",
+            name="grade",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.PROTECT,
+                to="gifthospitality.grade",
+            ),
+        ),
+        migrations.CreateModel(
+            name="VacancyPayPeriods",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("period_1", models.BooleanField(default=True)),
+                ("period_2", models.BooleanField(default=True)),
+                ("period_3", models.BooleanField(default=True)),
+                ("period_4", models.BooleanField(default=True)),
+                ("period_5", models.BooleanField(default=True)),
+                ("period_6", models.BooleanField(default=True)),
+                ("period_7", models.BooleanField(default=True)),
+                ("period_8", models.BooleanField(default=True)),
+                ("period_9", models.BooleanField(default=True)),
+                ("period_10", models.BooleanField(default=True)),
+                ("period_11", models.BooleanField(default=True)),
+                ("period_12", models.BooleanField(default=True)),
+                (
+                    "vacancy",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.PROTECT,
+                        related_name="pay_periods",
+                        to="payroll.vacancy",
+                    ),
+                ),
+                (
+                    "year",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.PROTECT,
+                        to="core.financialyear",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name_plural": "vacancy pay periods",
+            },
+        ),
+        migrations.AddConstraint(
+            model_name="vacancypayperiods",
+            constraint=models.UniqueConstraint(
+                fields=("vacancy", "year"), name="unique_vacancy_pay_periods"
+            ),
+        ),
+    ]

payroll/models.py

@@ -18,55 +18,31 @@ def with_basic_pay(self):
         )
 
 
-class Employee(models.Model):
+class Position(models.Model):
+    class Meta:
+        abstract = True
+
     cost_centre = models.ForeignKey(
         "costcentre.CostCentre",
         models.PROTECT,
     )
-    # I've been informed that an employee should only be associated to a single
-    # programme code. However, programme codes are actually assigned on a per pay
-    # element basis and in some cases an employee can be associated to multiple. This is
-    # seen as an edge case and we want to model it such that an employee only has a
-    # single programme code. We will have to handle this discrepancy somewhere.
     programme_code = models.ForeignKey(
         "chartofaccountDIT.ProgrammeCode",
         models.PROTECT,
     )
-    employee_no = models.CharField(max_length=8, unique=True)
-    first_name = models.CharField(max_length=32)
-    last_name = models.CharField(max_length=32)
     grade = models.ForeignKey(
         to="gifthospitality.Grade",
         on_delete=models.PROTECT,
         null=True,
         blank=True,
     )
     fte = models.FloatField(default=1.0)
-    assignment_status = models.CharField(max_length=32)
 
-    # TODO: Missing fields from Admin Tool which aren't required yet.
-    # EU/Non-EU (from programme code model)
-
-    objects = EmployeeQuerySet.as_manager()
 
-    def __str__(self) -> str:
-        return f"{self.employee_no} - {self.first_name} {self.last_name}"
-
-    def get_full_name(self) -> str:
-        return f"{self.first_name} {self.last_name}"
-
-
-class EmployeePayPeriods(models.Model):
+class PositionPayPeriods(models.Model):
     class Meta:
-        verbose_name_plural = "employee pay periods"
-        constraints = [
-            models.UniqueConstraint(
-                fields=("employee", "year"),
-                name="unique_employee_pay_periods",
-            )
-        ]
+        abstract = True
 
-    employee = models.ForeignKey(Employee, models.PROTECT, related_name="pay_periods")
     year = models.ForeignKey("core.FinancialYear", models.PROTECT)
     # period 1 = apr, period 2 = may, etc...
     # period 1 -> 12 = apr -> mar
@@ -96,11 +72,6 @@ class Meta:
     period_11 = models.BooleanField(default=True)
     period_12 = models.BooleanField(default=True)
 
-    # TODO: Missing fields from Admin Tool which aren't required yet.
-    # capital (Real colour of money)
-    # recharge = models.CharField(max_length=50, null=True, blank=True)
-    # recharge_reason = models.CharField(max_length=100, null=True, blank=True)
-
     @property
     def periods(self) -> list[bool]:
         return [getattr(self, f"period_{i + 1}") for i in range(12)]
@@ -111,6 +82,42 @@ def periods(self, value: list[bool]) -> None:
             setattr(self, f"period_{i + 1}", enabled)
 
 
+class Employee(Position):
+    employee_no = models.CharField(max_length=8, unique=True)
+    first_name = models.CharField(max_length=32)
+    last_name = models.CharField(max_length=32)
+    assignment_status = models.CharField(max_length=32)
+
+    # TODO: Missing fields from Admin Tool which aren't required yet.
+    # EU/Non-EU (from programme code model)
+
+    objects = EmployeeQuerySet.as_manager()
+
+    def __str__(self) -> str:
+        return f"{self.employee_no} - {self.first_name} {self.last_name}"
+
+    def get_full_name(self) -> str:
+        return f"{self.first_name} {self.last_name}"
+
+
+class EmployeePayPeriods(PositionPayPeriods):
+    class Meta:
+        verbose_name_plural = "employee pay periods"
+        constraints = [
+            models.UniqueConstraint(
+                fields=("employee", "year"),
+                name="unique_employee_pay_periods",
+            )
+        ]
+
+    employee = models.ForeignKey(Employee, models.PROTECT, related_name="pay_periods")
+
+    # TODO: Missing fields from Admin Tool which aren't required yet.
+    # capital (Real colour of money)
+    # recharge = models.CharField(max_length=50, null=True, blank=True)
+    # recharge_reason = models.CharField(max_length=100, null=True, blank=True)
+
+
 # aka "ToolTypePayment"
 class PayElementTypeGroup(models.Model):
     name = models.CharField(max_length=32, unique=True)
@@ -170,16 +177,10 @@ class RecruitmentStage(models.IntegerChoices):
     NOT_REQUIRED = 8, "Not required"
 
 
-class Vacancy(models.Model):
+class Vacancy(Position):
     class Meta:
         verbose_name_plural = "Vacancies"
 
-    cost_centre = models.ForeignKey("costcentre.CostCentre", models.PROTECT)
-
-    grade = models.ForeignKey("gifthospitality.Grade", models.PROTECT)
-    programme_code = models.ForeignKey(
-        "chartofaccountDIT.ProgrammeCode", models.PROTECT
-    )
     recruitment_type = models.CharField(
         max_length=29,
         choices=RecruitmentType.choices,
@@ -222,3 +223,16 @@ class Meta:
             )
         ],
     )
+
+
+class VacancyPayPeriods(PositionPayPeriods):
+    class Meta:
+        verbose_name_plural = "vacancy pay periods"
+        constraints = [
+            models.UniqueConstraint(
+                fields=("vacancy", "year"),
+                name="unique_vacancy_pay_periods",
+            )
+        ]
+
+    vacancy = models.ForeignKey(Vacancy, models.PROTECT, related_name="pay_periods")