matchers/geometries/toBePolygonGeometry.js

  1. const { polygonGeometry } = require('../../core/geometries/polygonGeometry')
  3. // eslint-disable-next-line jsdoc/require-returns
  4. /**
  5.  * Verifies an object is a valid GeoJSON Polygon Geometry. This geometry requires a
  6.  * 'type' property that must equal "Polygon", and a 'coordinates' property that contains
  7.  * an array of linestring arrays. Each point array must contain at least four valid
  8.  * WGS-84 GeoJSON coordinates, and the final coordinate must equal the first.
  9.  *
  10.  * The coordinates may be an empty array, but may not be an array of empty arrays.
  11.  *
  12.  * Foreign members are allowed with the exception of 'geometry', 'properties', or 'features'.
  13.  * If present, bounding boxes must be valid.
  14.  *
  15.  * @memberof Matchers.Geometries
  16.  * @see https://github.com/M-Scott-Lassiter/jest-geojson/issues/13
  17.  * @param {object} geometryObject a GeoJSON Polygon Geometry object
  18.  * @example
  19.  * const polygon = {
  20.  *     "type": "Polygon",
  21.  *     "coordinates": [
  22.  *         [
  23.  *             [100.0, 0.0],
  24.  *             [101.0, 0.0],
  25.  *             [101.0, 1.0],
  26.  *             [100.0, 1.0],
  27.  *             [100.0, 0.0]
  28.  *         ]
  29.  *     ]
  30.  * }
  31.  *
  32.  * test('Object is valid GeoJSON', () => {
  33.  *     expect(polygon).toBePolygonGeometry()
  34.  * })
  35.  * @example
  36.  * const point = {
  37.  *     type: "Point",
  38.  *     coordinates: [100.0, 0.0]
  39.  * }
  40.  * const polygonEndDoesNotEqualStart = {
  41.  *     "type": "Polygon",
  42.  *     "coordinates": [
  43.  *         [
  44.  *             [100.0, 0.0],
  45.  *             [101.0, 0.0],
  46.  *             [101.0, 1.0],
  47.  *             [100.0, 1.0]
  48.  *         ]
  49.  *     ]
  50.  * }
  51.  *
  52.  * test('Object is valid GeoJSON', () => {
  53.  *     expect(point).not.toBePolygonGeometry()
  54.  *     expect(polygonEndDoesNotEqualStart).not.toBePolygonGeometry()
  55.  * })
  56.  */
  57. function toBePolygonGeometry(geometryObject) {
  58.     const { printReceived, matcherHint } = this.utils
  59.     const passMessage =
  60.         // eslint-disable-next-line prefer-template
  61.         matcherHint('.not.toBePolygonGeometry', 'GeometryObject', '') +
  62.         '\n\n' +
  63.         `Expected input to not be a valid GeoJSON Polygon geometry.\n\n` +
  64.         `Received:  ${printReceived(geometryObject)}`
  66.     /**
  67.      * Combines a custom error message with built in Jest tools to provide a more descriptive error
  68.      * meessage to the end user.
  69.      *
  70.      * @param {string} errorMessage Error message text to return to the user
  71.      * @returns {string} Concatenated Jest test result string
  72.      */
  73.     function failMessage(errorMessage) {
  74.         return (
  75.             // eslint-disable-next-line prefer-template, no-unused-expressions
  76.             matcherHint('.toBePolygonGeometry', 'GeometryObject', '') +
  77.             '\n\n' +
  78.             `${errorMessage}\n\n` +
  79.             `Received:  ${printReceived(geometryObject)}`
  80.         )
  81.     }
  83.     try {
  84.         polygonGeometry(geometryObject)
  85.     } catch (err) {
  86.         return { pass: false, message: () => failMessage(err.message) }
  87.     }
  88.     return { pass: true, message: () => passMessage }
  89. }
  91. exports.toBePolygonGeometry = toBePolygonGeometry