matchers/coordinates/isValid3DCoordinate.js

  1. const { valid3DCoordinate } = require('../../core/coordinates/valid3DCoordinate')
  3. // eslint-disable-next-line jsdoc/require-returns
  4. /**
  5.  * Verifies a three element coordinate meets WGS-84 and GeoJSON validity requirements.
  6.  *
  7.  * @memberof Matchers.Coordinates
  8.  * @see https://github.com/M-Scott-Lassiter/jest-geojson/issues/2
  9.  * @param {number[]} coordinateArray A three element array of numbers in format [longitude, latitude, altitude].
  10.  * Longitude must be between -180 to 180.
  11.  * Latitude must be between -90 to 90.
  12.  * Altitude must be a number between -Infinity to Infinity.
  13.  * The standard does not specify units altitude represents (i.e. meters, feet, etc.).
  14.  * @example
  15.  * test('Object is valid GeoJSON', () => {
  16.  *      expect([22, 45.733, 20]).isValid3DCoordinate()
  17.  *      expect([180, 90, -10000]).isValid3DCoordinate()
  18.  *  })
  19.  * @example
  20.  * test('Object is NOT valid GeoJSON', () => {
  21.  *      expect([22, 100.56, 0]).not.isValid3DCoordinate() // Latitude out of range
  22.  *      expect([22, 45.733]).isValid3DCoordinate() // 2D coordinate
  23.  *      expect([22, 45.733, '0']).not.isValid3DCoordinate() // Non-numeric altitude
  24.  *      // Nested Arrays
  25.  *      expect([[22, 45.733, 0]]).not.isValid3DCoordinate()
  26.  *      expect([[22, 45.733, 0], [180, 90, 0]]).not.isValid3DCoordinate()
  27.  *  })
  28.  */
  29. function isValid3DCoordinate(coordinateArray) {
  30.     const { printReceived, matcherHint } = this.utils
  31.     const passMessage =
  32.         // eslint-disable-next-line prefer-template
  33.         matcherHint('.not.isValid3DCoordinate', '[longitude, latitude, altitude]', '') +
  34.         '\n\n' +
  35.         `Expected input to not be a three element array with longitude between (-90 to 90), 
  36.         latitude between (-180 to 180), and numeric altitude.\n\n` +
  37.         `Received:  ${printReceived(coordinateArray)}`
  39.     /**
  40.      * Combines a custom error message with built in Jest tools to provide a more descriptive error
  41.      * meessage to the end user.
  42.      *
  43.      * @param {string} errorMessage Error message text to return to the user
  44.      * @returns {string} Concatenated Jest test result string
  45.      */
  46.     function failMessage(errorMessage) {
  47.         return (
  48.             // eslint-disable-next-line prefer-template, no-unused-expressions
  49.             matcherHint('.isValid3DCoordinate', '[longitude, latitude, altitude]', '') +
  50.             '\n\n' +
  51.             `${errorMessage}\n\n` +
  52.             `Received:  ${printReceived(coordinateArray)}`
  53.         )
  54.     }
  56.     try {
  57.         valid3DCoordinate(coordinateArray)
  58.     } catch (err) {
  59.         return { pass: false, message: () => failMessage(err.message) }
  60.     }
  61.     return { pass: true, message: () => passMessage }
  62. }
  64. exports.isValid3DCoordinate = isValid3DCoordinate