PUB-2960 Create style guide for Magistrates Adult Court List (#1520)

* Create style guide for Magistrates Adult Court List

* Add routes file changes

* Fixed failing unit tests

* Fixed failing unit tests

* Removed redundant empty line

* Removed doh

* Update following schema changes

* Update code following schema changes

* Revert file change

* Update Magistrates Adult Court List default sensitivity to classified

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: KianKwa

src/main/controllers/style-guide/MagistratesAdultCourtListController.ts

@@ -0,0 +1,63 @@
+import { Response } from 'express';
+import { PipRequest } from '../../models/request/PipRequest';
+import { cloneDeep } from 'lodash';
+import { PublicationService } from '../../service/PublicationService';
+import { LocationService } from '../../service/LocationService';
+import { ListParseHelperService } from '../../service/ListParseHelperService';
+import { HttpStatusCode } from 'axios';
+import { formatMetaDataListType, isUnexpectedListType, isValidList, isValidListType } from '../../helpers/listHelper';
+import { MagistratesAdultCourtListService } from '../../service/listManipulation/MagistratesAdultCourtListService';
+import { formatDate } from '../../helpers/dateTimeHelper';
+
+const publicationService = new PublicationService();
+const courtService = new LocationService();
+const helperService = new ListParseHelperService();
+const magistratesAdultCourtListService = new MagistratesAdultCourtListService();
+
+const listPath = 'magistrates-adult-court-list';
+
+
+export default class MagistratesAdultCourtListController {
+    public async get(req: PipRequest, res: Response, listType: string): Promise<void> {
+        const artefactId = req.query.artefactId as string;
+        const payload = await publicationService.getIndividualPublicationJson(artefactId, req.user?.['userId']);
+        const metadata = await publicationService.getIndividualPublicationMetadata(artefactId, req.user?.['userId']);
+        const metadataListType = formatMetaDataListType(metadata);
+
+        if (isValidList(payload, metadata) && isValidListType(metadataListType, listType)) {
+            const listData = magistratesAdultCourtListService.processPayload(payload as JSON, req.lng);
+            const returnedLocation = await courtService.getLocationById(metadata['locationId']);
+            const locationName = courtService.findCourtName(returnedLocation, req.lng, listPath);
+
+            const printDate = payload['document'].data.job.printdate;
+            const publishedDate = formatDate(MagistratesAdultCourtListController.toIsoDate(printDate), 'dd MMMM yyyy', req.lng);
+
+            const printStartTime = payload['document'].info?.start_time;
+            const publishedTime = printStartTime ? helperService.publicationTimeInUkTime(printStartTime) : '';
+
+            res.render(`style-guide/${listPath}`, {
+                ...cloneDeep(req.i18n.getDataByLanguage(req.lng)[listPath]),
+                ...cloneDeep(req.i18n.getDataByLanguage(req.lng)['list-template']),
+                listData: listData,
+                contentDate: helperService.contentDateInUtcTime(metadata['contentDate'], req.lng),
+                locationName: locationName,
+                provenance: metadata.provenance,
+                publishedDate,
+                publishedTime,
+            });
+        } else if (
+            payload === HttpStatusCode.NotFound ||
+            metadata === HttpStatusCode.NotFound ||
+            isUnexpectedListType(metadataListType, listType)
+        ) {
+            res.render('list-not-found', req.i18n.getDataByLanguage(req.lng)['list-not-found']);
+        } else {
+            res.render('error', req.i18n.getDataByLanguage(req.lng).error);
+        }
+    }
+
+    private static toIsoDate(date: string): string {
+        const dateParts = date.split('/');
+        return new Date(Number(dateParts[2]), Number(dateParts[1]) - 1, Number(dateParts[0])).toISOString();
+    }
+}

src/main/resources/listLookup.json

@@ -909,5 +909,25 @@
         "restrictedProvenances": [],
         "defaultSensitivity": "",
         "isNonStrategic": true
+    },
+    "MAGISTRATES_ADULT_COURT_LIST_DAILY": {
+        "friendlyName": "Magistrates Adult Court List - Daily",
+        "welshFriendlyName": "Rhestr Llys Ynadon Oedolion - Dyddiol",
+        "shortenedFriendlyName": "Magistrates Adult Court List - Daily",
+        "url": "magistrates-adult-court-list-daily",
+        "jurisdictionTypes": ["Magistrates Court"],
+        "restrictedProvenances": [],
+        "defaultSensitivity": "CLASSIFIED",
+        "isNonStrategic": false
+    },
+    "MAGISTRATES_ADULT_COURT_LIST_FUTURE": {
+        "friendlyName": "Magistrates Adult Court List - Future",
+        "welshFriendlyName": "Rhestr Llys Ynadon Oedolion – Dyfodol",
+        "shortenedFriendlyName": "Magistrates Adult Court List - Future",
+        "url": "magistrates-adult-court-list-future",
+        "jurisdictionTypes": ["Magistrates Court"],
+        "restrictedProvenances": [],
+        "defaultSensitivity": "CLASSIFIED",
+        "isNonStrategic": false
     }
 }

src/main/resources/locales/cy/magistrates-adult-court-list.json

@@ -0,0 +1,31 @@
+{
+    "title": "Rhestr Safonol y Llys Ynadon",
+    "heading": "Rhestr Safonol y Llys Ynadon ar gyfer",
+    "listDate": "Rhestr ar gyfer",
+    "listUpdated": "Diweddarwyd diwethaf",
+    "at": "am",
+    "restrictionInformationHeading": "Cyfyngiadau ar gyhoeddi neu ysgrifennu am yr achosion hyn.",
+    "restrictionInformationP1": "Rhaid i chi wirio a oes unrhyw gyfyngiadau riportio yn berthnasol cyn cyhoeddi manylion am unrhyw un o'r achosion a restrir yma, naill ai'n ysgrifenedig, mewn darllediad neu ar y rhyngrwyd, gan gynnwys y cyfryngau cymdeithasol.",
+    "restrictionInformationBoldText": "Byddwch yn euog o ddirmyg llys os byddwch yn cyhoeddi unrhyw wybodaeth sydd wedi'i diogelu gan gyfyngiad riportio. Gallwch gael dirwy, eich dedfrydu i garchar, neu'r ddau.",
+    "restrictionInformationP2": "Bydd cyfyngiadau penodol a orchmynnir gan y llys yn cael eu crybwyll ar yr achosion a restrir yma.",
+    "restrictionInformationP3": "Fodd bynnag, nid yw'r cyfyngiadau bob amser yn cael eu rhestru. Mae rhai yn berthnasol yn awtomatig. Er enghraifft, anhysbysrwydd a roddir i ddioddefwyr rhai troseddau rhywiol.",
+    "restrictionInformationP4": "I ganfod pa gyfyngiadau riportio sy'n berthnasol ar achos penodol, cysylltwch â'r:",
+    "restrictionBulletPoint1": "llys yn uniongyrchol",
+    "restrictionBulletPoint2": "Gwasanaeth Llysoedd a Thribiwnlysoedd EM ar 0330 808 4407",
+    "sittingAt": "Yn eistedd yn",
+    "lja": "LJA:",
+    "sessionStart": "Yn eistedd yn",
+    "tableHeaders": [
+        "Amser Cychwyn y Bloc",
+        "Enw'r Diffynnydd",
+        "Dyddiad Geni",
+        "Cyfeiriad",
+        "Oedran",
+        "Hysbysydd",
+        "Cyfeirnod yr Achos",
+        "Cod y Drosedd",
+        "Teitl y Drosedd",
+        "Crynodeb o’r Drosedd"
+    ],
+    "dataSource": "Data Source: "
+}

src/main/resources/locales/en/magistrates-adult-court-list.json

@@ -0,0 +1,31 @@
+{
+    "title": "Magistrates Standard List",
+    "heading": "Magistrates Standard List for",
+    "listDate": "List for",
+    "listUpdated": "Last updated",
+    "at": "at",
+    "restrictionInformationHeading": "Restrictions on publishing or writing about these cases",
+    "restrictionInformationP1": "You must check if any reporting restrictions apply before publishing details on any of the cases listed here either in writing, in a broadcast or by internet, including social media.",
+    "restrictionInformationBoldText": "You'll be in contempt of court if you publish any information which is protected by a reporting restriction. You could get a fine, prison sentence or both.",
+    "restrictionInformationP2": "Specific restrictions ordered by the court will be mentioned on the cases listed here.",
+    "restrictionInformationP3": "However, restrictions are not always listed. Some apply automatically. For example, anonymity given to the victims of certain sexual offences.",
+    "restrictionInformationP4": "To find out which reporting restrictions apply on a specific case, contact:",
+    "restrictionBulletPoint1": "the court directly",
+    "restrictionBulletPoint2": "HM Courts and Tribunals Service on 0330 808 4407",
+    "sittingAt": "Sitting at",
+    "lja": "LJA:",
+    "sessionStart": "Session start",
+    "tableHeaders": [
+        "Block Start",
+        "Defendant Name",
+        "Date of Birth",
+        "Address",
+        "Age",
+        "Informant",
+        "Case Number",
+        "Offence Code",
+        "Offence Title",
+        "Offence Summary"
+    ],
+    "dataSource": "Data Source: "
+}

src/main/routes/routes.ts

@@ -190,6 +190,10 @@ export default function (app: Application): void {
     app.get('/iac-daily-list-additional-cases', app.locals.container.cradle.iacDailyListController.get);
     app.get('/magistrates-public-list', app.locals.container.cradle.magistratesPublicListController.get);
     app.get('/magistrates-standard-list', app.locals.container.cradle.magistratesStandardListController.get);
+    app.get('/magistrates-adult-court-list-daily', (req, res) =>
+        app.locals.container.cradle.magistratesAdultCourtListController.get(req, res, 'magistrates-adult-court-list-daily'));
+    app.get('/magistrates-adult-court-list-future', (req, res) =>
+        app.locals.container.cradle.magistratesAdultCourtListController.get(req, res, 'magistrates-adult-court-list-future'));
 
     //Non-Strategic Paths
     app.get('/cst-weekly-hearing-list', (req, res) =>

src/main/service/listManipulation/MagistratesAdultCourtListService.ts

@@ -0,0 +1,70 @@
+import { ListParseHelperService } from '../ListParseHelperService';
+
+const helperService = new ListParseHelperService();
+
+export class MagistratesAdultCourtListService {
+    public processPayload(payload: JSON, language: string): any[] {
+        const results = [];
+        payload['document'].data.job.sessions.forEach(sessionNode => {
+            const cases = this.buildCases(sessionNode, language);
+            results.push({
+                lja: sessionNode.lja,
+                courtName: sessionNode.court,
+                courtRoom: sessionNode.room,
+                sessionStartTime: helperService.publicationTimeInUkTime(sessionNode.sstart),
+                cases,
+            });
+        });
+        return results;
+    }
+
+    private buildCases(sessionNode: any, language: string): any[] {
+        const cases = [];
+        sessionNode.blocks.forEach(blockNode => {
+            blockNode.cases.forEach(caseNode => {
+                const caseInfo = {
+                    blockStartTime: helperService.publicationTimeInUkTime(blockNode.bstart),
+                    caseNumber: caseNode.caseno,
+                    defendantName: caseNode.def_name,
+                    defendantDob: caseNode.def_dob ? caseNode.def_dob : '',
+                    defendantAge: caseNode.def_age ? caseNode.def_age : '',
+                    defendantAddress: this.formatDefendantAddress(caseNode.def_addr),
+                    informant: caseNode.inf,
+                    offence: this.processOffences(caseNode.offences, language)
+                }
+                cases.push(caseInfo);
+            });
+        });
+        return cases;
+    }
+
+    private formatDefendantAddress(addressNode: any): string {
+        const formattedAddress = [];
+
+        formattedAddress.push(addressNode.line1 ? addressNode.line1 : '');
+        formattedAddress.push(addressNode.line2 ? addressNode.line2 : '');
+        formattedAddress.push(addressNode.line3 ? addressNode.line3 : '');
+        formattedAddress.push(addressNode.line4 ? addressNode.line4 : '');
+        formattedAddress.push(addressNode.line5 ? addressNode.line5 : '');
+        formattedAddress.push(addressNode.pcode ? addressNode.pcode : '');
+
+        return formattedAddress.filter(line => line.trim().length > 0).join(', ');
+    }
+
+    private processOffences(offencesNode: any, language: string): any {
+        const offenceCodes = [];
+        const offenceTitles = [];
+        const offenceSummaries = [];
+
+        offencesNode.forEach(offenceNode => {
+            offenceCodes.push(offenceNode.code);
+            offenceTitles.push(language === 'cy' && offenceNode.cy_title ? offenceNode.cy_title : offenceNode.title);
+            offenceSummaries.push(language === 'cy' && offenceNode.cy_sum ? offenceNode.cy_sum :offenceNode.sum);
+        });
+        return {
+            offenceCode: offenceCodes.filter(line => line.trim().length > 0).join(', '),
+            offenceTitle: offenceTitles.filter(line => line.trim().length > 0).join(', '),
+            offenceSummary: offenceSummaries.filter(line => line.trim().length > 0).join(', ')
+        }
+    }
+}

src/main/views/style-guide/magistrates-adult-court-list.njk

@@ -0,0 +1,99 @@
+{% from "govuk/components/table/macro.njk" import govukTable as 'govukTable' %}
+{% from "../macros/common-components.njk" import goBack, searchInput %}
+{% from "govuk/components/warning-text/macro.njk" import govukWarningText %}
+
+{% extends "../list-template.njk" %}
+{% block pageTitle %}
+    {{ title }}
+{% endblock %}
+
+{% block beforeContent %}
+    {{ super() }}
+    {{ goBack(text = backButton, cspNonce = cspNonce) }}
+{% endblock %}
+
+{% block content %}
+    <div class="parent-box">
+        <h1 id='page-heading' class="govuk-heading-l">{{ heading }} {{ locationName }}</h1>
+        <p class="govuk-body govuk-!-font-weight-bold govuk-!-margin-bottom-1">{{ listDate }} {{ contentDate }}</p>
+        {% if publishedTime | length %}
+            <p class="govuk-body">{{ listUpdated }} {{ publishedDate }} {{ at }} {{ publishedTime }}</p>
+        {% else %}
+            <p class="govuk-body">{{ listUpdated }} {{ publishedDate }}</p>
+        {% endif %}
+
+        <div class="govuk-grid restriction-list-section govuk-!-margin-bottom-5">
+            <div class="govuk-body">
+                <h3>{{ restrictionInformationHeading }}</h3>
+                <p class="govuk-body">{{ restrictionInformationP1 }}</p>
+                <div class="govuk-warning-text">
+                    <span class="govuk-warning-text__icon align-warning-icon" aria-hidden="true">!</span>
+                    <strong class="govuk-warning-text__text">
+                        <span class="govuk-warning-text__assistive">Warning</span>
+                        {{ restrictionInformationBoldText }}
+                    </strong>
+                </div>
+                <p class="govuk-body">{{ restrictionInformationP2 }}</p>
+                <p class="govuk-body">{{ restrictionInformationP3 }}</p>
+                <p class="govuk-body">{{ restrictionInformationP4 }}</p>
+                <ul class="govuk-list govuk-list--bullet">
+                    <li>{{ restrictionBulletPoint1 }}</li>
+                    <li>{{ restrictionBulletPoint2 }}</li>
+                </ul>
+            </div>
+        </div>
+
+        {{ searchInput(text = searchCases) }}
+        <div class="search-area">
+            {% set listSessionCount = 0 %}
+            <div class="govuk-accordion" data-module="govuk-accordion" id="accordion-default-1">
+                {% for listSession in listData %}
+                    {% set listSessionCount = listSessionCount + 1 %}
+                    <div class="govuk-accordion__section govuk-accordion__section--expanded">
+                        <div class="govuk-accordion__section-header">
+                            <h2 class="govuk-accordion__section-heading">
+                                <span class="govuk-accordion__section-button" id="accordion-default-heading-{{ listSessionCount }}">{{ listSession.courtName }}</span>
+                            </h2>
+                            <p class="govuk-body govuk-!-font-weight-bold govuk-!-margin-bottom-1">{{ sittingAt }} {{ listSession.courtRoom }}</p>
+                            <p class="govuk-body govuk-!-margin-bottom-1">{{ lja }} {{ listSession.lja }}</p>
+                            <p class="govuk-body">{{ sessionStart }} {{ listSession.sessionStartTime }}</p>
+                        </div>
+                        <div id="accordion-default-content-{{ listSessionCount }}" class="govuk-accordion__section-content" aria-labelledby="accordion-default-heading-{{ listSessionCount }}">
+                            <div class="parent-box overflow-table">
+                                <table class="govuk-table overflow-table" data-module="moj-sortable-table">
+                                    <thead class="govuk-table__head">
+                                    <tr class="govuk-table__row">
+                                        {% for header in tableHeaders %}
+                                            <th scope="col" class="govuk-table__header" aria-sort="none">{{ header }}</th>
+                                        {% endfor %}
+                                    </tr>
+                                    </thead>
+                                    <tbody class="govuk-table__body">
+                                        {% for row in listSession.cases %}
+                                            <tr class="govuk-table__row">
+                                                <td class="govuk-table__cell" data-sort-value="{{ row.blockStartTime | timeToSortValue }}">{{ row.blockStartTime }}</td>
+                                                <td class="govuk-table__cell">{{ row.defendantName }}</td>
+                                                <td class="govuk-table__cell" data-sort-value="{{ row.defendantDob | dateToSortValue }}">{{ row.defendantDob }}</td>
+                                                <td class="govuk-table__cell">{{ row.defendantAddress }}</td>
+                                                <td class="govuk-table__cell">{{ row.defendantAge }}</td>
+                                                <td class="govuk-table__cell">{{ row.informant }}</td>
+                                                <td class="govuk-table__cell">{{ row.caseNumber }}</td>
+                                                <td class="govuk-table__cell">{{ row.offence.offenceCode }}</td>
+                                                <td class="govuk-table__cell">{{ row.offence.offenceTitle }}</td>
+                                                <td class="govuk-table__cell">{{ row.offence.offenceSummary }}</td>
+                                            </tr>
+                                        {% endfor %}
+                                    </tbody>
+                                </table>
+                            </div>
+                        </div>
+                    </div>
+                {% endfor %}
+            </div>
+            <p class="govuk-body govuk-!-font-size-14 data-source">{{ dataSource }}: {{ provenance | convertDataSourceName(lng) }}</p>
+            {{ super() }}
+        </div>
+    </div>
+{% endblock %}
+
+

src/test/a11y/tests/style-guide/magistrates-adult-court-list.test.ts

@@ -0,0 +1,37 @@
+import sinon from 'sinon';
+import { PublicationService } from '../../../../main/service/PublicationService';
+import { testAccessibility } from '../../common/pa11yHelper';
+import {
+    MagistratesAdultCourtListService
+} from '../../../../main/service/listManipulation/MagistratesAdultCourtListService';
+import { LocationService } from '../../../../main/service/LocationService';
+import { testArtefactJsonData, testArtefactMetadata, testLocationData } from '../../common/testData';
+
+const userId = '1'
+const urlDailyList = '/magistrates-adult-court-list-daily';
+const urlFutureList = '/magistrates-adult-court-list-future';
+
+const jsonData = testArtefactJsonData('magistratesAdultCourtList.json');
+const metadata = testArtefactMetadata()[0];
+const locationData = testLocationData();
+
+const metadataDailyList = metadata;
+metadataDailyList.listType = 'MAGISTRATES_ADULT_COURT_LIST_DAILY';
+const metadataFutureList = metadata;
+metadataFutureList.listType = 'MAGISTRATES_ADULT_COURT_LIST_FUTURE';
+
+sinon.stub(MagistratesAdultCourtListService.prototype, 'processPayload').resolves(jsonData);
+sinon.stub(LocationService.prototype, 'getLocationById').resolves(locationData);
+sinon.stub(PublicationService.prototype, 'getIndividualPublicationJson').resolves(jsonData);
+
+const metadataStub = sinon.stub(PublicationService.prototype, 'getIndividualPublicationMetadata');
+metadataStub.withArgs('abc', userId).returns(metadataDailyList);
+metadataStub.withArgs('def', userId).returns(metadataFutureList);
+
+describe('Accessibility - Magistrates Adult Court List Daily Page', () => {
+    testAccessibility(`${urlDailyList}?artefactId=abc`);
+});
+
+describe('Accessibility - Magistrates Adult Court List Future Page', () => {
+    testAccessibility(`${urlFutureList}?artefactId=def`);
+});