Migrate abstraction details view page

app/controllers/licences.controller.js

@@ -15,6 +15,7 @@ const ViewLicenceCommunicationsService = require('../services/licences/view-lice
 const ViewLicenceContactDetailsService = require('../services/licences/view-licence-contact-details.service.js')
 const ViewLicenceContactsService = require('../services/licences/view-licence-contacts.service.js')
 const ViewLicenceHistoryService = require('../services/licences/view-licence-history.service.js')
+const ViewLicencePurposesService = require('../services/licences/view-licence-purposes.service.js')
 const ViewLicenceReturnsService = require('../services/licences/view-licence-returns.service.js')
 const ViewLicenceSetUpService = require('../services/licences/view-licence-set-up.service.js')
 const ViewLicenceSummaryService = require('../services/licences/view-licence-summary.service.js')
@@ -122,6 +123,16 @@ async function viewLicenceContacts (request, h) {
  })
 }
 
+async function viewLicencePurposes (request, h) {
+ const { id: licenceId } = request.params
+
+ const pageData = await ViewLicencePurposesService.go(licenceId)
+
+ return h.view('licences/purposes.njk', {
+ ...pageData
+ })
+}
+
 async function viewHistory (request, h) {
  const { params: { id }, auth } = request
 
@@ -174,6 +185,7 @@ module.exports = {
  viewLicenceContacts,
  viewHistory,
  viewLicenceContactDetails,
+ viewLicencePurposes,
  viewReturns,
  viewSetUp,
  viewSummary

app/presenters/licences/view-licence-purposes.presenter.js

@@ -0,0 +1,83 @@
+'use strict'
+
+/**
+ * Formats the licence purposes data for the view licence purposes page
+ * @module ViewLicencePurposesPresenter
+ */
+
+const { formatAbstractionPeriod } = require('../base.presenter.js')
+
+/**
+ * Formats the licence purposes data for the view licence purposes page
+ *
+ * @param {module:LicenceModel} licence - The licence and related licenceVersionPurposes data returned by
+ * `FetchLicencePurposesService`
+ *
+ * @returns {object} licence and licenceVersionPurposes data needed by the view template
+ */
+function go (licence) {
+ return {
+ id: licence.id,
+ licenceRef: licence.licenceRef,
+ licencePurposes: _formatLicencePurposes(licence.licenceVersions[0].licenceVersionPurposes),
+ pageTitle: 'Licence purpose details'
+ }
+}
+
+function _formatLicencePurposes (licenceVersionPurposes) {
+ return licenceVersionPurposes.map((licenceVersionPurpose) => {
+ return {
+ abstractionAmounts: _formatAbstractionAmounts(licenceVersionPurpose),
+ abstractionPeriod: _abstractionPeriod(licenceVersionPurpose),
+ abstractionPoints: _formatAbstractionPoints(licenceVersionPurpose.points),
+ purposeDescription: licenceVersionPurpose.purpose.description ? licenceVersionPurpose.purpose.description : ''
+ }
+ })
+}
+
+function _abstractionPeriod (licenceVersionPurpose) {
+ const startDay = licenceVersionPurpose.abstractionPeriodStartDay
+ const startMonth = licenceVersionPurpose.abstractionPeriodStartMonth
+ const endDay = licenceVersionPurpose.abstractionPeriodEndDay
+ const endMonth = licenceVersionPurpose.abstractionPeriodEndMonth
+
+ return formatAbstractionPeriod(startDay, startMonth, endDay, endMonth)
+}
+
+function _formatAbstractionPoints (points) {
+ return points.map((point) => {
+ return point.$describe()
+ })
+}
+
+function _formatAbstractionAmounts (licenceVersionPurpose) {
+ const details = []
+
+ if (!licenceVersionPurpose) {
+ return details
+ }
+
+ const { annualQuantity, dailyQuantity, hourlyQuantity, instantQuantity } = licenceVersionPurpose
+
+ if (annualQuantity) {
+ details.push(`${parseFloat(annualQuantity).toFixed(2)} cubic metres per year`)
+ }
+
+ if (dailyQuantity) {
+ details.push(`${parseFloat(dailyQuantity).toFixed(2)} cubic metres per day`)
+ }
+
+ if (hourlyQuantity) {
+ details.push(`${parseFloat(hourlyQuantity).toFixed(2)} cubic metres per hour`)
+ }
+
+ if (instantQuantity) {
+ details.push(`${parseFloat(instantQuantity).toFixed(2)} cubic metres per second (Instantaneous Quantity)`)
+ }
+
+ return details
+}
+
+module.exports = {
+ go
+}

app/routes/licence.routes.js

@@ -42,6 +42,13 @@ const routes = [
  }
  }
  },
+ {
+ method: 'GET',
+ path: '/licences/{id}/purposes',
+ options: {
+ handler: LicencesController.viewLicencePurposes
+ }
+ },
  {
  method: 'GET',
  path: '/licences/{id}/set-up',

app/services/licences/fetch-licence-purposes.service.js

@@ -0,0 +1,74 @@
+'use strict'
+
+/**
+ * Fetches the licence purposes needed for the view monitoring-station page
+ * @module FetchLicencePurposesService
+ */
+
+const LicenceModel = require('../../models/licence.model.js')
+
+/**
+ * Fetches the licence purposes needed for the view monitoring-station page
+ *
+ * @param {string} licenceId - The UUID of the licence
+ *
+ * @returns {Promise<module:LicenceModel>} the licence and related licence purposes data needed for the view licence
+ * purposes page
+ */
+async function go (licenceId) {
+ return _fetchLicencePurposes(licenceId)
+}
+
+async function _fetchLicencePurposes (licenceId) {
+ return LicenceModel.query()
+ .findById(licenceId)
+ .select([
+ 'id',
+ 'licenceRef'
+ ])
+ .modify('currentVersion')
+ .withGraphFetched('licenceVersions.licenceVersionPurposes')
+ .modifyGraph('licenceVersions.licenceVersionPurposes', (builder) => {
+ builder.select([
+ 'abstractionPeriodStartDay',
+ 'abstractionPeriodStartMonth',
+ 'abstractionPeriodEndDay',
+ 'abstractionPeriodEndMonth',
+ 'annualQuantity',
+ 'dailyQuantity',
+ 'hourlyQuantity',
+ 'instantQuantity'
+ ])
+ .orderBy('licenceVersionPurposes.createdAt', 'asc')
+ })
+ .withGraphFetched('licenceVersions.licenceVersionPurposes.points')
+ .modifyGraph('licenceVersions.licenceVersionPurposes.points', (builder) => {
+ builder.select([
+ 'points.description',
+ 'points.id',
+ 'points.ngr1',
+ 'points.ngr2',
+ 'points.ngr3',
+ 'points.ngr4'
+ ])
+ .orderBy('points.externalId', 'asc')
+ })
+ .withGraphFetched('licenceVersions.licenceVersionPurposes.points.source')
+ .modifyGraph('licenceVersions.licenceVersionPurposes.points.source', (builder) => {
+ builder.select([
+ 'sources.description',
+ 'sources.id'
+ ])
+ })
+ .withGraphFetched('licenceVersions.licenceVersionPurposes.purpose')
+ .modifyGraph('licenceVersions.licenceVersionPurposes.purpose', (builder) => {
+ builder.select([
+ 'id',
+ 'description'
+ ])
+ })
+}
+
+module.exports = {
+ go
+}

app/services/licences/view-licence-purposes.service.js

@@ -0,0 +1,30 @@
+'use strict'
+
+/**
+ * Orchestrates fetching and presenting the data needed for the licence purposes page
+ * @module ViewLicencePurposesService
+ */
+
+const FetchLicencePurposesService = require('../licences/fetch-licence-purposes.service.js')
+const ViewLicencePurposesPresenter = require('../../presenters/licences/view-licence-purposes.presenter.js')
+
+/**
+ * Orchestrates fetching and presenting the data needed for the licence purposes page
+ *
+ * @param {string} licenceId - The UUID of the licence
+ *
+ * @returns {Promise<object>} an object representing the `pageData` needed by the licence purposes template
+ */
+async function go (licenceId) {
+ const licencePurposes = await FetchLicencePurposesService.go(licenceId)
+
+ const pageData = ViewLicencePurposesPresenter.go(licencePurposes)
+
+ return {
+ ...pageData
+ }
+}
+
+module.exports = {
+ go
+}

app/views/licences/purposes.njk

@@ -0,0 +1,105 @@
+{% extends 'layout.njk' %}
+{% from "govuk/components/back-link/macro.njk" import govukBackLink %}
+{% from "govuk/components/details/macro.njk" import govukDetails %}
+{% from "govuk/components/table/macro.njk" import govukTable %}
+
+{% macro abstractionPointCell(array, purposeDescription) %}
+ {% set abstractionPoints %}
+ {% for item in array %}
+ {% if loop.last %}
+ <div class="govuk-!-padding-top-1">{{ item }}</div>
+ {% else %}
+ <div class="govuk-!-padding-top-1 govuk-!-padding-bottom-1">{{ item }}</div>
+ <div class="govuk-!-margin-bottom-1 govuk-section-break govuk-section-break--visible"></div>
+ {% endif %}
+ {% endfor %}
+ {% endset %}
+
+ {% if array.length > 5 %}
+ {{ govukDetails({
+ summaryText: "View your " + array.length + " abstraction points for " + purposeDescription | lower,
+ html: abstractionPoints | safe,
+ classes: "govuk-!-margin-bottom-0"
+ }) }}
+ {% else %}
+ {{ abstractionPoints | safe }}
+ {% endif %}
+{% endmacro %}
+
+{% block breadcrumbs %}
+ {{ govukBackLink({
+ text: 'Go back to summary',
+ href: '/system/licences/' + id + '/summary'
+ }) }}
+{% endblock %}
+
+{% block content %}
+ <h1 class="govuk-heading-l">
+ <span class="govuk-caption-l">Licence {{ licenceRef }}</span>
+ {{ pageTitle }}
+ </h1>
+
+ {% for licencePurpose in licencePurposes %}
+ {# Set an easier to use index. #}
+ {% set rowIndex = loop.index0 %}
+
+ {% set tableRows = [] %}
+
+ {# Abstraction points cell #}
+ {% if licencePurpose.abstractionPoints.length > 1 %}
+ {% set abstractionPointRowTitle = 'Abstraction points' %}
+ {% else %}
+ {% set abstractionPointRowTitle = 'Abstraction point' %}
+ {% endif %}
+
+ {% set abstractionPointsRow = [
+ {
+ text: abstractionPointRowTitle,
+ attributes: { 'data-test': 'abstraction-point-title-' + rowIndex },
+ classes: "govuk-!-width-one-third"
+ },
+ {
+ html: abstractionPointCell(licencePurpose.abstractionPoints, licencePurpose.purposeDescription),
+ attributes: { 'data-test': 'abstraction-points-' + rowIndex }
+ }
+ ] %}
+
+ {% set tableRows = (tableRows.push(abstractionPointsRow), tableRows) %}
+
+ {# Period of abstraction cell #}
+ {% set abstractionPeriodRow = [
+ {
+ text: 'Period of abstraction',
+ attributes: { 'data-test': 'abstraction-period-title-' + rowIndex }
+ },
+ {
+ text: licencePurpose.abstractionPeriod,
+ attributes: { 'data-test': 'abstraction-period-' + rowIndex }
+ }
+ ] %}
+
+ {% set tableRows = (tableRows.push(abstractionPeriodRow), tableRows) %}
+
+ {# Abstraction amount cell #}
+ {% for abstractionAmount in licencePurpose.abstractionAmounts %}
+ {% set abstractionPeriodRow = [
+ {
+ text: 'Abstraction amount',
+ attributes: { 'data-test': 'abstraction-amount-title-' + rowIndex }
+ },
+ {
+ text: abstractionAmount,
+ attributes: { 'data-test': 'abstraction-amount-' + rowIndex }
+ }
+ ] %}
+
+ {% set tableRows = (tableRows.push(abstractionPeriodRow), tableRows) %}
+ {% endfor %}
+
+ {{ govukTable({
+ caption: licencePurpose.purposeDescription,
+ captionClasses: "govuk-table__caption--m govuk-!-padding-bottom-3 govuk-!-margin-bottom-0 govuk-section-break govuk-section-break--visible",
+ rows: tableRows
+ }) }}
+ {% endfor %}
+{% endblock %}