Sprint 48 into main

.env.ci

@@ -10,3 +10,4 @@ AUTHBROKER_URL=
 SENTRY_ENVIRONMENT=ci
 SENTRY_DSN=
 CSP_REPORT_URI=
+PAYROLL={"BASIC_PAY_NAC": "71111001", "PENSION_NAC": "71111002", "ERNIC_NAC": "71111003", "VACANCY_NAC": "71111001"}

.env.example

@@ -32,6 +32,8 @@ CSP_REPORT_URI=
 # Vite
 VITE_DEV=True
 
+PAYROLL={"BASIC_PAY_NAC": "71111001", "PENSION_NAC": "71111002", "ERNIC_NAC": "71111003", "VACANCY_NAC": "71111001"}
+
 # Not documented (needed?)
 # RESTRICT_ADMIN=True
 # PUBLIC_PATH="http://localhost:8000"

config/settings/base.py

@@ -11,6 +11,7 @@
 """
 
 import os
+from dataclasses import dataclass
 from pathlib import Path
 
 import dj_database_url
@@ -414,3 +415,16 @@ def FILTERS_VERBOSE_LOOKUPS():
 
 CSP_REPORT_ONLY = True
 CSP_REPORT_URI = env.str("CSP_REPORT_URI", default=None)
+
+
+# Payroll
+@dataclass
+class Payroll:
+    BASIC_PAY_NAC: str | None = None
+    PENSION_NAC: str | None = None
+    ERNIC_NAC: str | None = None
+    VACANCY_NAC: str | None = None
+    AVERAGE_SALARY_THRESHOLD: int = 2
+
+
+PAYROLL: Payroll = Payroll(**env.json("PAYROLL", default={}))

config/settings/ci.py

@@ -13,3 +13,7 @@
 AXES_ENABLED = False
 
 STORAGES["default"]["BACKEND"] = "django.core.files.storage.FileSystemStorage"
+
+# I'm not aware of any case where we need the history whilst running tests. This should
+# hopefully speed up the tests a little bit.
+SIMPLE_HISTORY_ENABLED = False

core/admin.py

@@ -12,7 +12,7 @@
 from django.views.decorators.csrf import csrf_exempt
 
 from core.export_data import export_logentry_iterator
-from core.models import CommandLog, FinancialYear
+from core.models import CommandLog, FinancialYear, PayUplift
 from core.utils.export_helpers import (
     export_csv_from_import,
     export_to_csv,
@@ -368,6 +368,25 @@ def has_delete_permission(self, request, obj=None):
         return False
 
 
+class PayUpliftAdmin(admin.ModelAdmin):
+    list_display = (
+        "financial_year",
+        "apr",
+        "may",
+        "jun",
+        "jul",
+        "aug",
+        "sep",
+        "oct",
+        "nov",
+        "dec",
+        "jan",
+        "feb",
+        "mar",
+    )
+
+
 admin.site.register(LogEntry, LogEntryAdmin)
 admin.site.register(FinancialYear, FinancialYearAdmin)
 admin.site.register(CommandLog, CustomLogModelAdmin)
+admin.site.register(PayUplift, PayUpliftAdmin)

core/constants.py

@@ -0,0 +1,17 @@
+from .types import Months
+
+
+MONTHS: Months = (
+    "apr",
+    "may",
+    "jun",
+    "jul",
+    "aug",
+    "sep",
+    "oct",
+    "nov",
+    "dec",
+    "jan",
+    "feb",
+    "mar",
+)

core/migrations/0014_payuplift.py

@@ -0,0 +1,47 @@
+# Generated by Django 5.1.3 on 2024-12-06 15:33
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("core", "0013_alter_historicalgroup_options_and_more"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="PayUplift",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("apr", models.FloatField(default=1.0)),
+                ("may", models.FloatField(default=1.0)),
+                ("jun", models.FloatField(default=1.0)),
+                ("jul", models.FloatField(default=1.0)),
+                ("aug", models.FloatField(default=1.0)),
+                ("sep", models.FloatField(default=1.0)),
+                ("oct", models.FloatField(default=1.0)),
+                ("nov", models.FloatField(default=1.0)),
+                ("dec", models.FloatField(default=1.0)),
+                ("jan", models.FloatField(default=1.0)),
+                ("feb", models.FloatField(default=1.0)),
+                ("mar", models.FloatField(default=1.0)),
+                (
+                    "financial_year",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.PROTECT,
+                        to="core.financialyear",
+                    ),
+                ),
+            ],
+        ),
+    ]

core/models.py

@@ -3,6 +3,8 @@
 from django.db import models
 from simple_history import register
 
+from core.constants import MONTHS
+
 from .metamodels import BaseModel
 
 
@@ -87,6 +89,29 @@ def __str__(self):
         return str(self.financial_year_display)
 
 
+class PayUplift(models.Model):
+    @property
+    def periods(self) -> list[float]:
+        return [getattr(self, month) for month in MONTHS]
+
+    financial_year = models.ForeignKey(
+        FinancialYear,
+        on_delete=models.PROTECT,
+    )
+    apr = models.FloatField(default=1.0)
+    may = models.FloatField(default=1.0)
+    jun = models.FloatField(default=1.0)
+    jul = models.FloatField(default=1.0)
+    aug = models.FloatField(default=1.0)
+    sep = models.FloatField(default=1.0)
+    oct = models.FloatField(default=1.0)
+    nov = models.FloatField(default=1.0)
+    dec = models.FloatField(default=1.0)
+    jan = models.FloatField(default=1.0)
+    feb = models.FloatField(default=1.0)
+    mar = models.FloatField(default=1.0)
+
+
 # Track changes to permissions
 register(Permission, app=__package__, inherit=True)
 register(get_user_model(), app=__package__, inherit=True)

core/templates/base_generic.html

@@ -1,6 +1,7 @@
 {% load util %}
 {% load breadcrumbs %}
 {% load forecast_permissions %}
+{% load payroll_permissions %}
 {% load upload_permissions %}
 {% load download_permissions %}
 {% load upload_percentage_permissions %}
@@ -128,16 +129,26 @@
                     </a>
                 </li>
 
+                {% can_edit_payroll user as can_edit_payroll %}
+                {% if can_edit_payroll %}
+                    <li class="internal-header__navigation__item">
+                        <a class="internal-header__navigation__item__link {% if request.path|startswith:'/payroll/edit/' %}internal-header__navigation__item__link--active{% endif %}"
+                            href="{% url 'payroll:choose_cost_centre' %}">
+                            Edit payroll
+                        </a>
+                    </li>
+                {% endif %}
+
                 {% is_forecast_user user as is_forecast_user %}
-                {% if is_forecast_user == True %}
+                {% if is_forecast_user %}
                     <li class="internal-header__navigation__item">
                         <a class="internal-header__navigation__item__link {% if request.path|startswith:'/forecast/view/' %}internal-header__navigation__item__link--active{% endif %}"
                            href="{% url 'forecast_dit' 0 %}">
                             View forecast/historical outturn
                         </a>
                     </li>
                     {% can_edit_at_least_one_cost_centre user as can_edit_at_least_one_cost_centre %}
-                    {% if can_edit_at_least_one_cost_centre == True %}
+                    {% if can_edit_at_least_one_cost_centre %}
                         <li class="internal-header__navigation__item">
                             <a class="internal-header__navigation__item__link {% if request.path|startswith:'/forecast/edit/' %}internal-header__navigation__item__link--active{% endif %}"
                                href="{% url 'choose_cost_centre' %}">
@@ -146,7 +157,7 @@
                         </li>
                     {% endif %}
                     {% has_mi_report_download_permission user as has_mi_report_download_permission %}
-                    {% if has_mi_report_download_permission == True %}
+                    {% if has_mi_report_download_permission %}
                         <li class="internal-header__navigation__item {% if request.path == '/download/oscar-return/' %}govuk-header__navigation-item--active{% endif %}">
                             <a class="internal-header__navigation__item__link"
                                href="/download_file/download_mi_report/">
@@ -156,7 +167,7 @@
                     {% endif %}
 
                     {% has_oscar_download_permission user as has_oscar_download_permission %}
-                    {% if has_oscar_download_permission == True %}
+                    {% if has_oscar_download_permission %}
                         <li class="internal-header__navigation__item {% if request.path == '/download/mi-report/' %}govuk-header__navigation-item--active{% endif %}">
                             <a class="internal-header__navigation__item__link"
                                href="/download_file/download_oscar_report/">
@@ -165,7 +176,7 @@
                         </li>
                     {% endif %}
                     {% has_upload_permission user as has_upload_permission %}
-                    {% if has_upload_permission == True %}
+                    {% if has_upload_permission %}
                         <li class="internal-header__navigation__item">
                             <a class="internal-header__navigation__item__link  {% if request.path|startswith:'/upload/' %}internal-header__navigation__item__link--active{% endif %}"
                                href="{% url 'uploaded_files' %}">
@@ -175,7 +186,7 @@
                     {% endif %}
                 {% endif %}
                 {% has_project_percentage_permission user as has_project_percentage_permission %}
-                {% if has_project_percentage_permission == True %}
+                {% if has_project_percentage_permission %}
                     <li class="internal-header__navigation__item
                     {% if request.path == '/upload_split_file/project_percentage/' %}govuk-header__navigation-item--active{% endif %}">
                         <a id="split_project"  class="internal-header__navigation__item__link"
@@ -186,7 +197,7 @@
                 {% endif %}
 
                 {% has_end_of_month_archive_permissions request.user as has_end_of_month_archive_permissions %}
-                {% if has_end_of_month_archive_permissions == True %}
+                {% if has_end_of_month_archive_permissions %}
                     <li class="internal-header__navigation__item">
                         <a id="end_of_month" class="internal-header__navigation__item__link"
                            href="{% url 'end_of_month' %}">

core/types.py

@@ -0,0 +1,46 @@
+from typing import Literal, TypedDict
+
+
+Month = Literal[
+    "apr",
+    "may",
+    "jun",
+    "jul",
+    "aug",
+    "sep",
+    "oct",
+    "nov",
+    "dec",
+    "jan",
+    "feb",
+    "mar",
+]
+Months = tuple[
+    Literal["apr"],
+    Literal["may"],
+    Literal["jun"],
+    Literal["jul"],
+    Literal["aug"],
+    Literal["sep"],
+    Literal["oct"],
+    Literal["nov"],
+    Literal["dec"],
+    Literal["jan"],
+    Literal["feb"],
+    Literal["mar"],
+]
+
+
+class MonthsDict[T](TypedDict):
+    apr: T
+    may: T
+    jun: T
+    jul: T
+    aug: T
+    sep: T
+    oct: T
+    nov: T
+    dec: T
+    jan: T
+    feb: T
+    mar: T

forecast/templates/forecast/edit/edit.html

@@ -1,4 +1,5 @@
 {% extends "forecast/edit/forecast_base.html" %}
+{% load payroll_permissions %}
 {% load util vite %}
 {% load breadcrumbs %}
 
@@ -41,14 +42,15 @@
     {% endblock %}
     {% block scripts %}
     {{ view.get_payroll_forecast_report|json_script:'payroll_forecast_data' }}
+    {% can_edit_payroll user as can_edit_payroll %}
     <script>
         window.actuals = {{ actuals|safe }};
         window.period_display = {{ period_display|safe }};
         window.table_data = {{ forecast_dump|safe }};
         window.cost_centre = {{ view.cost_centre_details.cost_centre_code|safe }};
         window.financial_year = {{ view.financial_year|safe }};
         window.payroll_forecast_data = JSON.parse(document.getElementById("payroll_forecast_data").textContent);
-        window.can_toggle_payroll = "{{ can_toggle_payroll }}";
+        window.can_edit_payroll = "{{ can_edit_payroll }}";
     </script>
     {% vite_dev_client %}
     {% vite_js 'src/index.jsx' %}

forecast/templatetags/forecast_format.py

@@ -37,6 +37,19 @@
 ]
 
 
+@register.filter
+def format_money(value: float) -> str:
+    """Format as a monetary value.
+
+    `value` is expected to be in pence and will be divided by 100.
+
+    Examples:
+        >>> format_money(1024312)
+        '10,243.12'
+    """
+    return f"{value / 100:,.2f}"
+
+
 @register.filter()
 def is_forecast_figure(_, column):
     if str(column) in forecast_figure_cols:

forecast/views/edit_forecast.py

@@ -528,7 +528,6 @@ def get_context_data(self, **kwargs):
         context["forecast_dump"] = forecast_dump
         context["actuals"] = actual_data
         context["period_display"] = period_display
-        context["can_toggle_payroll"] = self.request.user.is_superuser
 
         return context