compare-geojson

Compare-GeoJSON

Compare functions take as inputs the following:

1. oldVersion - GeoJSON of the feature's old version
2. newVersion - GeoJSON of the feature's new version
3. callback - A function to call after processing.

Compare functions output the following:

1. error - Error if any during processing or null.
2. result - Object containing key value pairs representing findings of the compare function or an empty object.

Versioning

The version of the compare function is returned as part of the result as cfVersion. Every time a compare function is modified, we increment the cfVersion.

A sample compare function would look something like this:

function place_removed(newVersion, oldVersion, callback) {

  var cfVersion = 2;

  var oldProps = oldVersion.properties;
  var newProps = newVersion.properties;
  var placeRemoved = false;
  if (oldProps.hasOwnProperty('place') && !newProps.hasOwnProperty('place')) {
    placeRemoved = true;
  }
  return callback(null, {'result:place_removed': {
    'cfVersion': cfVersion,
    'placeRemoved': placeRemoved
  }});
}

How do I create a compare function?

• Clone this repository with git clone https://github.com/mapbox/compare-geojson
• cd compare-geojson
• npm install
• Check if all tests pass before making your changes with npm test
• Fetch the landmarks database with:

curl -s https://s3.amazonaws.com/vandalism-dynamosm-support/landmarks.spatialite -o landmarks.spatialite

• Create a new test fixture in the directory tests/fixtures/
• Create a new compare function in the directory comparators/
• Test your new compare function with npm test

Changelog

[3.2.1] - 2016-05-23

Fixed

• Corrected typo from dirty_words to dirty_word.