Add base point model with a describe helper

app/lib/general.lib.js

@@ -152,45 +152,6 @@ function generateAbstractionPointDetail (pointDetail) {
   return abstractionPoint
 }
 
-/**
- * Generate a string that represents an abstraction point based on the assumption the points have already been merged
- *
- * When abstracting water the point at which this is done can be described in several ways depending on the number of
- * Nation Grid References are saved against the abstraction point. This function checks for these references and builds
- * a string that defines the details of the abstraction point.
- *
- * This follows the same out put as generateAbstractionPointDetail but the points have already been merged
- *
- * @param {object} pointDetail - Object containing all the details for the point
- *
- * @returns {string} a description of the abstraction point
- */
-function generatePointDetail (pointDetail) {
-  let abstractionPoint = null
-
-  if (pointDetail.ngr4) {
-    const point1 = pointDetail.ngr1
-    const point2 = pointDetail.ngr2
-    const point3 = pointDetail.ngr3
-    const point4 = pointDetail.ngr4
-
-    abstractionPoint = `Within the area formed by the straight lines running between National Grid References ${point1} ${point2} ${point3} and ${point4}`
-  } else if (pointDetail.ngr2) {
-    const point1 = pointDetail.ngr1
-    const point2 = pointDetail.ngr2
-
-    abstractionPoint = `Between National Grid References ${point1} and ${point2}`
-  } else {
-    const point1 = pointDetail.ngr1
-
-    abstractionPoint = `At National Grid Reference ${point1}`
-  }
-
-  abstractionPoint += pointDetail.description !== undefined ? ` (${pointDetail.description})` : ''
-
-  return abstractionPoint
-}
-
 /**
  * Generate a Universally Unique Identifier (UUID)
  *
@@ -334,7 +295,6 @@ module.exports = {
   determineCurrentFinancialYear,
   flashNotification,
   generateAbstractionPointDetail,
-  generatePointDetail,
   generateUUID,
   periodsOverlap,
   timestampForPostgres,

app/models/base-point.model.js

@@ -0,0 +1,48 @@
+'use strict'
+
+/**
+ * @module BasePointModel
+ */
+
+const BaseModel = require('./base.model.js')
+
+/**
+ * Base class for all 'point' based models, for example, `ReturnRequirementPointModel`
+ */
+class BasePointModel extends BaseModel {
+  /**
+   * Generate a string that describes this abstraction point
+   *
+   * When abstracting water the point at which this is done can be described in several ways depending on the number of
+   * Nation Grid References saved against the abstraction point.
+   *
+   * - 'point' - A single point grid reference
+   * - 'reach' - Two grid references defining a 'reach' or line along which water will be abstracted
+   * - 'area' - Four grid references defining the area water will be abstracted
+   *
+   * Finally, when the point is added to the system the user can add a supplementary description. If this exists the
+   * description returned combines the point description and the supplementary one.
+   *
+   * @returns {string} the description of this abstraction point
+   */
+  $describe () {
+    let abstractionPoint
+
+    // If ng4 is populated then we know this point is an 'area'
+    if (this.ngr4) {
+      abstractionPoint = `Within the area formed by the straight lines running between National Grid References ${this.ngr1} ${this.ngr2} ${this.ngr3} and ${this.ngr4}`
+    } else if (this.ngr2) {
+      // If ng2 is populated then we know this point is a 'reach'
+      abstractionPoint = `Between National Grid References ${this.ngr1} and ${this.ngr2}`
+    } else {
+      // Else this point must be ... a point!
+      abstractionPoint = `At National Grid Reference ${this.ngr1}`
+    }
+
+    abstractionPoint = this.description ? `${abstractionPoint} (${this.description})` : abstractionPoint
+
+    return abstractionPoint
+  }
+}
+
+module.exports = BasePointModel

app/models/licence-version-purpose-point.model.js

@@ -7,9 +7,9 @@
 
 const { Model } = require('objection')
 
-const BaseModel = require('./base.model.js')
+const BasePointModel = require('./base-point.model.js')
 
-class LicenceVersionPurposePointModel extends BaseModel {
+class LicenceVersionPurposePointModel extends BasePointModel {
   static get tableName () {
     return 'licenceVersionPurposePoints'
   }

app/models/return-requirement-point.model.js

@@ -7,9 +7,9 @@
 
 const { Model } = require('objection')
 
-const BaseModel = require('./base.model.js')
+const BasePointModel = require('./base-point.model.js')
 
-class ReturnRequirementPointModel extends BaseModel {
+class ReturnRequirementPointModel extends BasePointModel {
   static get tableName () {
     return 'returnRequirementPoints'
   }

app/presenters/return-requirements/view.presenter.js

@@ -7,7 +7,6 @@
 
 const { formatAbstractionDate } = require('../base.presenter.js')
 const { formatLongDate } = require('../base.presenter.js')
-const { generatePointDetail } = require('../../lib/general.lib.js')
 const { returnRequirementReasons, returnRequirementFrequencies } = require('../../lib/static-lookups.lib.js')
 
 /**
@@ -18,7 +17,6 @@ const { returnRequirementReasons, returnRequirementFrequencies } = require('../.
  *
  * @returns {object} requirements for returns data needed by the view template
  */
-
 function go (returnVersion) {
   const { licence, multipleUpload, returnRequirements, startDate, status } =
     returnVersion
@@ -133,7 +131,7 @@ function _purposes (returnRequirementPurposes) {
 
 function _points (returnRequirementPoints) {
   return returnRequirementPoints.map((returnRequirementPoint) => {
-    return generatePointDetail(returnRequirementPoint)
+    return returnRequirementPoint.$describe()
   })
 }
 

test/models/base-point.model.test.js

@@ -0,0 +1,97 @@
+'use strict'
+
+// Test framework dependencies
+const Lab = require('@hapi/lab')
+const Code = require('@hapi/code')
+
+const { describe, it, beforeEach } = exports.lab = Lab.script()
+const { expect } = Code
+
+// Thing under test
+const BasePointModel = require('../../app/models/base-point.model.js')
+
+describe('Base Point model', () => {
+  let testRecord
+
+  describe('$describe', () => {
+    describe('when the instance represents a "point" (1 grid reference)', () => {
+      beforeEach(() => {
+        testRecord = BasePointModel.fromJson({ ngr1: 'ST 58212 72697' })
+      })
+
+      describe('and it has a supplementary description', () => {
+        beforeEach(() => {
+          testRecord.description = 'Head office'
+        })
+
+        it('returns a "point" description including the supplementary', () => {
+          const result = testRecord.$describe()
+
+          expect(result).to.equal('At National Grid Reference ST 58212 72697 (Head office)')
+        })
+      })
+
+      describe('and it does not have a supplementary description', () => {
+        it('returns just the "point" description', () => {
+          const result = testRecord.$describe()
+
+          expect(result).to.equal('At National Grid Reference ST 58212 72697')
+        })
+      })
+    })
+
+    describe('when the instance represents a "reach" (2 grid references)', () => {
+      beforeEach(() => {
+        testRecord = BasePointModel.fromJson({ ngr1: 'ST 58212 72697', ngr2: 'ST 58151 72683' })
+      })
+
+      describe('and it has a supplementary description', () => {
+        beforeEach(() => {
+          testRecord.description = 'Head office'
+        })
+
+        it('returns a "reach" description including the supplementary', () => {
+          const result = testRecord.$describe()
+
+          expect(result).to.equal('Between National Grid References ST 58212 72697 and ST 58151 72683 (Head office)')
+        })
+      })
+
+      describe('and it does not have a supplementary description', () => {
+        it('returns just the "reach" description', () => {
+          const result = testRecord.$describe()
+
+          expect(result).to.equal('Between National Grid References ST 58212 72697 and ST 58151 72683')
+        })
+      })
+    })
+
+    describe('when the instance represents an "area" (4 grid references)', () => {
+      beforeEach(() => {
+        testRecord = BasePointModel.fromJson({
+          ngr1: 'ST 58212 72697', ngr2: 'ST 58151 72683', ngr3: 'ST 58145 72727', ngr4: 'ST 58222 72744'
+        })
+      })
+
+      describe('and it has a supplementary description', () => {
+        beforeEach(() => {
+          testRecord.description = 'Head office'
+        })
+
+        it('returns an "area" description including the supplementary', () => {
+          const result = testRecord.$describe()
+
+          expect(result).to.equal('Within the area formed by the straight lines running between National Grid References ST 58212 72697 ST 58151 72683 ST 58145 72727 and ST 58222 72744 (Head office)')
+        })
+      })
+
+      describe('and it does not have a supplementary description', () => {
+        it('returns just the "area" description', () => {
+          const result = testRecord.$describe()
+
+          expect(result).to.equal('Within the area formed by the straight lines running between National Grid References ST 58212 72697 ST 58151 72683 ST 58145 72727 and ST 58222 72744')
+        })
+      })
+    })
+  })
+})