server/spec/fixtures/location.js

  1. /**
  2.  * Test utilities to generate location-related data.
  3.  *
  4.  * @module server/spec/fixtures/location
  5.  */
  6. const chance = require('chance').Chance();
  7. const _ = require('lodash');
  8. const { unique: uniqueGenerator } = require('test-value-generator');
  10. const Location = require('../../models/location');
  11. const { createRecord } = require('../utils');
  12. const geoJsonFixtures = require('./geojson');
  14. /**
  15.  * Generates a random location record and saves it to the database.
  16.  *
  17.  * All of the generated location's properties are assigned random values unless
  18.  * changed with the `data` argument.
  19.  *
  20.  *     const locationFixtures = require('../spec/fixtures/location');
  21.  *
  22.  *     const location = await locationFixtures.location({
  23.  *       name: 'Custom name'
  24.  *     });
  25.  *
  26.  *     console.log(location.get('name'));        // "Custom name"
  27.  *     console.log(location.get('short_name'));  // "Lorem ipsum"
  28.  *
  29.  * @function
  30.  * @param {object} [data={}] - Custom location data.
  31.  * @param {object} [data.bbox] - A bounding box within which the generated location should be
  32.  * @param {number[]} data.bbox.southWest - A longitude/latitude pair indicating the south-west corner of the bounding box
  33.  * @param {number[]} data.bbox.northEast - A longitude/latitude pair indicating the north-east corner of the bounding box
  34.  * @param {string} [data.name]
  35.  * @param {string} [data.shortName] - Set to `null` to create a location without a short name.
  36.  * @param {string} [data.description]
  37.  * @param {string} [data.phone]
  38.  * @param {string} [data.photoUrl]
  39.  * @param {string} [data.siteUrl]
  40.  * @param {object} [data.geometry]
  41.  * @param {object} [data.properties={}]
  42.  * @param {object} [data.address]
  43.  * @param {string} [data.address.street]
  44.  * @param {string} [data.address.number] - Set to `null` to create an address without a number
  45.  * @param {string} [data.address.zipCode]
  46.  * @param {string} [data.address.city]
  47.  * @param {string} [data.address.state]
  48.  * @returns {Promise<Location>} A promise that will be resolved with the saved location.
  49.  */
  50. exports.location = function(data = {}) {
  51.   return createRecord(Location, {
  52.     name: data.name || exports.name(),
  53.     short_name: _.has(data, 'shortName') ? data.shortName : exports.shortName(),
  54.     description: data.description || chance.paragraph(),
  55.     phone: data.phone || chance.phone(),
  56.     photo_url: data.phoneUrl || chance.url({ domain: 'example.com', extensions: [ 'jpg' ] }),
  57.     site_url: data.siteUrl || chance.url({ domain: 'example.com' }),
  58.     geometry: data.geometry || geoJsonFixtures.point(_.pick(data, 'bbox')),
  59.     properties: data.properties || {},
  60.     address_street: _.get(data, 'address.street', chance.street()),
  61.     address_number: _.get(data, 'address.number', chance.integer({ min: 1, max: 100 }).toString()),
  62.     address_zip_code: _.get(data, 'address.zipCode', chance.zip()),
  63.     address_city: _.get(data, 'address.city', chance.city()),
  64.     address_state: _.get(data, 'address.state', chance.state()),
  65.     created_at: data.createdAt,
  66.     updated_at: data.updatedAt
  67.   });
  68. };
  70. /**
  71.  * Generates a unique random location name.
  72.  *
  73.  *     const locationFixtures = require('../spec/fixtures/location');
  74.  *
  75.  *     locationFixtures.name();  // "Lorem ipsum aute ad dolor exercitation labore amet"
  76.  *
  77.  * @function
  78.  * @returns {string} A name for a location.
  79.  */
  80. exports.name = uniqueGenerator(function() {
  81.   return chance.sentence();
  82. });
  84. /**
  85.  * Generates a unique random location short name.
  86.  *
  87.  *     const locationFixtures = require('../spec/fixtures/location');
  88.  *
  89.  *     locationFixtures.shortName();  // "Lorem"
  90.  *
  91.  * @function
  92.  * @returns {string} A short name for a location.
  93.  */
  94. exports.shortName = uniqueGenerator(function() {
  95.   const word = chance.word();
  96.   return word[0].toUpperCase() + word.slice(1);
  97. })