compare-geojson - npm Package Compare versions

Comparing version 2.3.1 to 3.0.0

comparators/compare_geometries.js

@@ -30,2 +30,4 @@ 'use strict';
 
+  var cfVersion = 2;
+
   if (!newVersion || !oldVersion) {
@@ -53,2 +55,3 @@ return callback(null, {});
     'result:compare_geometries': {
+      'cfVersion': cfVersion,
       'areaDelta': areaDelta,
@@ -55,0 +58,0 @@ 'centroidDisplacement': centroidDisplacement,

comparators/feature_version.js

@@ -13,2 +13,5 @@ 'use strict';
 function feature_version(newVersion, oldVersion, callback) {
+
+  var cfVersion = 2;
+
   var version = -1;
@@ -18,7 +21,17 @@ var result = {};
     version = newVersion.properties ? newVersion.properties['osm:version'] : newVersion['version'];
-    result = {'result:feature_version': version};
+    result = {
+      'result:feature_version': {
+        'cfVersion': cfVersion,
+        'version': version
+      }
+    };
     return callback(null, result);
   } else if (oldVersion) {
     version = oldVersion.properties ? oldVersion.properties['osm:version'] : oldVersion['version'];
-    result = {'result:feature_version': version};
+    result = {
+      'result:feature_version': {
+        'cfVersion': cfVersion,
+        'version': version
+      }
+    };
     return callback(null, result);
@@ -25,0 +38,0 @@ } else {

comparators/low_zoom_features.js

@@ -16,2 +16,4 @@ 'use strict';
 
+  var cfVersion = 2;
+
   if (!newVersion || !newVersion.properties) {
@@ -39,2 +41,3 @@ return callback(null, {});
     'result:low_zoom_features': {
+      'cfVersion': cfVersion,
       'lowZoomCount': lowZoomCount,
@@ -41,0 +44,0 @@ 'lowZoomFeatures': lowZoomFeatures

comparators/new_mapper.js

@@ -12,2 +12,5 @@ 'use strict';
 function new_mapper(newVersion, oldVersion, callback) {
+
+  var cfVersion = 2;
+
   /*
@@ -28,2 +31,3 @@ User IDs on OpenStreetMap are in serial order.
   var result = {'result:new_mapper': {
+    'cfVersion': cfVersion,
     'newMapper': uid > vidhatri
@@ -30,0 +34,0 @@ }};

comparators/uncommon_tags.js

@@ -15,2 +15,5 @@ 'use strict';
 function uncommon_tags(newVersion, oldVersion, callback) {
+
+  var cfVersion = 2;
+
   if (!newVersion || !newVersion.properties) {
@@ -38,2 +41,3 @@ return callback(null, {});
     'result:uncommon_tags': {
+      'cfVersion': cfVersion,
       'uncommonCount': uncommonCount,
@@ -40,0 +44,0 @@ 'uncommonTags': uncommonTags

index.js

@@ -12,3 +12,3 @@ 'use strict';
   'delete_create': require('./comparators/delete_create'),
-  'landmark': require('./comparators/landmark'),
+  'landmark_score': require('./comparators/landmark_score'),
   'city_deleted': require('./comparators/city_deleted'),
@@ -21,3 +21,4 @@ 'compare_properties': require('./comparators/compare_properties'),
   'uncommon_tags': require('./comparators/uncommon_tags'),
-  'low_zoom_features': require('./comparators/low_zoom_features')
+  'low_zoom_features': require('./comparators/low_zoom_features'),
+  'user_blocks': require('./comparators/user_blocks')
 };

lib/compare_all.js

@@ -9,3 +9,3 @@ 'use strict';
 var deleteCreate = require('../comparators/delete_create');
-var landmark = require('../comparators/landmark.js');
+var landmarkScore = require('../comparators/landmark_score.js');
 var cityDeleted = require('../comparators/city_deleted');
@@ -35,3 +35,3 @@ var compareProperties = require('../comparators/compare_properties');
     deleteCreate,
-    landmark,
+    landmarkScore,
     cityDeleted,
@@ -38,0 +38,0 @@ compareProperties,

package.json

 {
   "name": "compare-geojson",
-  "version": "2.3.1",
+  "version": "3.0.0",
   "description": "Compare a features new and old versions in GeoJSON",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -19,14 +19,23 @@ # Compare-GeoJSON
 
+#### 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 checkPlaceRemoval(newVersion, oldVersion, callback) {
-    var oldProps = oldVersion.properties;
-    var newProps = newVersion.properties;
-    var result = {};
-    if (oldProps.hasOwnProperty('place') && !newProps.hasOwnProperty('place')) {
-        result['result:place_removed'] = true;
-    }
-    return callback(null, result);
+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
+  }});
 }
 ```

tests/fixtures/compare_geometries.json

@@ -10,3 +10,4 @@ {
           "centroidDisplacement": 0,
-          "geometryTransformation": -19358224.42068947
+          "geometryTransformation": -19358224.42068947,
+          "cfVersion": 2
         }
@@ -13,0 +14,0 @@ },

tests/fixtures/feature_version.json

@@ -7,3 +7,6 @@ {
       "expectedResult": {
-        "result:feature_version": 1
+        "result:feature_version": {
+          "cfVersion": 2,
+          "version": 1
+        }
       },
@@ -38,3 +41,6 @@ "newVersion": null,
       "expectedResult": {
-        "result:feature_version": 13
+        "result:feature_version": {
+          "cfVersion": 2,
+          "version": 13
+        }
       },
@@ -96,3 +102,6 @@ "newVersion": {
       "expectedResult": {
-        "result:feature_version": 1
+        "result:feature_version": {
+          "cfVersion": 2,
+          "version": 1
+        }
       },
@@ -127,3 +136,7 @@ "newVersion": {
       "expectedResult": {
-        "result:feature_version": 17
+        "result:feature_version": {
+          "cfVersion": 2,
+          "version": 17
+        }
+
       },
@@ -130,0 +143,0 @@ "newVersion": {

tests/fixtures/features/node-268436671-13.json

@@ -6,3 +6,6 @@ {
     "result:significant_place": 195,
-    "result:wikipedia_score": 3.4
+    "result:landmark_score": {
+      "cfVersion": 2,
+      "score": 3.4
+    }
   },
@@ -9,0 +12,0 @@ "features": [

tests/fixtures/features/way-67715300-10.json

 {
   "type": "FeatureCollection",
   "properties": {
-    "result:wikipedia_score": 2.9
+    "result:landmark_score": {
+      "cfVersion": 2,
+      "score": 2.9
+    }
   },
@@ -38,2 +41,2 @@ "features": [
   ]
-}
+}

tests/fixtures/low_zoom_features.json

@@ -8,2 +8,3 @@ {
         "result:low_zoom_features": {
+          "cfVersion": 2,
           "lowZoomCount": 1,
@@ -10,0 +11,0 @@ "lowZoomFeatures": {

tests/fixtures/new_mapper.json

@@ -8,2 +8,3 @@ {
         "result:new_mapper": {
+          "cfVersion": 2,
           "newMapper": true
@@ -41,2 +42,3 @@ }
         "result:new_mapper": {
+          "cfVersion": 2,
           "newMapper": false
@@ -43,0 +45,0 @@ }

tests/fixtures/uncommon_tags.json

@@ -8,2 +8,3 @@ {
         "result:uncommon_tags": {
+          "cfVersion": 2,
           "uncommonCount": 0,
@@ -10,0 +11,0 @@ "uncommonTags": {}

tests/index.js

@@ -49,5 +49,5 @@ /* eslint global-require: [0] */
     }
-    assert.deepEqual(fixture.expectedResult, result, fixture.description);
+    assert.deepEqual(result, fixture.expectedResult, fixture.description);
     callback();
   });
 }

tests/test-with-features.js

@@ -34,3 +34,3 @@ 'use strict';
     for (var prop in expectedProperties) {
-      assert.equal(result[prop], expectedProperties[prop], prop + ' as expected');
+      assert.deepEqual(result[prop], expectedProperties[prop], prop + ' as expected');
     }
@@ -37,0 +37,0 @@ callback(null, null);

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

66110200

increased by0.09%

Number of package files

58

increased by7.41%

Lines of code

15416

increased by2.99%

Number of lines in readme file

41

increased by28.13%

Worsened metrics

Number of low supply chain risk alerts

7

increased by16.67%

No dependency changes