Support Null geometries #866

DenisCarriere · 2017-07-26T14:59:40Z

Adds null geometry support.

Ref: #853

Modified

Implementation Discussions

Callbacks Feature/Geometry with null geometry

geomEach
flattenEach
featureEach

Does NOT return any Coordinate/Segment

coordEach
segmentEach

Tested

stebogit

@DenisCarriere I believe we should allow/hande only the geometry: null case; a type member must be defined to have a valid GeoJSON object (see specs), so null or an object with type:null are not valid inputs.

stebogit · 2017-07-26T15:27:33Z

packages/turf-invariant/test.js

+        properties: {},
+        geometry: null
+    }
+    t.equal(invariant.getGeom(null), null);


@DenisCarriere why supporting null values? Reading the specs it seems the GeoJSON objects is an object and has to have a type member (which in my understanding is the only requirement to be a valid GeoJSON object)

stebogit · 2017-07-26T15:29:49Z

packages/turf-meta/index.js


-            if (geometry.type === 'Point') {
+            switch (geomType) {
+            case null:


@DenisCarriere same here, from the specs:

A GeoJSON object has a member with the name "type". The value of
the member MUST be one of the GeoJSON types.

I guess the geometry attribute might be null, but the type must be a valid string

This section is more internal and doesn't need to reflect the exact spec. Only way to iterate over a FeatureCollection (containing valid null geometries) with coordEach is to not throw an error Unknown Geometry Type since we know that null is a valid geometry.

var geomType = (geometry === null) ? null : geometry.type; switch (geomType) { case null: return;

Simply breaks the loop and moves on to the next valid geometry.

DenisCarriere · 2017-07-26T16:52:11Z

Thanks for looking to this @stebogit , I wasn't too sure how to handle this for the invariant module.

I believe we should allow/hande only the geometry: null case; a type member must be defined to have a valid GeoJSON object (see specs), so null or an object with type:null are not valid inputs.

👍 Yep, we should only handle the geometry: null case.

https://github.com/Turfjs/turf/pull/866\#pullrequestreview-52398355

DenisCarriere · 2017-07-26T17:30:37Z

@stebogit ❓ Question for you: When we're using geomEach or flattenEach and a FeatureCollection contains Features with null geometry, these should be excluded from the iterating process, correct?

stebogit · 2017-07-27T06:33:57Z

When we're using geomEach or flattenEach and a FeatureCollection contains Features with null geometry, these should be excluded from the iterating process

Good question @DenisCarriere... 🤔
I would not exclude them, for we confirmed they are 100% valid GeoJSON features.
What if you actually need to iterate through them to actually check and populate the geometry field?

DenisCarriere · 2017-07-27T13:51:48Z

we confirmed they are 100% valid GeoJSON features.

Agreed they are valid GeoJSON features, however geomEach is meant to return valid GeometryObjects which null isn't since it doesn't have a type (that's my reason why we should exclude them?).

We could return a null Feature for flattenEach since that is "valid" GeoJSON Feature.

🤔 still thinking how we should approach this one...

DenisCarriere · 2017-07-27T14:07:04Z

🤔 flattenEach uses geomEach...

function flattenEach(geojson, callback) {
    geomEach(geojson, function (geometry, index, properties) {

So the options are, we callback both null geometries, or we exclude both...

DenisCarriere · 2017-07-27T14:20:58Z

@stebogit Chose to preserve null geometries for flattenEach & geomEach.

What if you actually need to iterate through them to actually check and populate the geometry field?

👍 Good point.

DenisCarriere · 2017-07-27T15:02:21Z

@stebogit Have a glance at this one last time, I'm 👍 to merge this.

stebogit

@DenisCarriere I added a couple of comments here, hopefully helpful

stebogit · 2017-07-27T15:23:46Z

packages/turf-helpers/index.js

@@ -248,6 +248,7 @@ function multiPolygon(coordinates, properties) {
 */
 function geometryCollection(geometries, properties) {
    if (!geometries) throw new Error('geometries is required');


@DenisCarriere just being very fussy here, but from specs geometryCollections can have an empty geometries array.
But (!geometries) would exclude that, right?

Same goes actually for FeatureCollection, which I'm noticing has the same check.

We can add those in the tests, but !geometries would not exclude empty geometries inside, it would only exclude geometries: null or undefined.

lets add them to the tests and see what happens from there :) lol

(!geometries) would not throw an error if you provide an empty Array.

$ node > ![1,2,3] false > ![] false > !undefined true > !null true

Added tests for this case: c1edd39

ah! 👍 sorry, PHP confusion! 😄

lol! Everything language has their quirks

stebogit · 2017-07-27T15:36:33Z

packages/turf-meta/index.js

@@ -32,64 +32,73 @@ function coordEach(geojson, callback, excludeWrapCoord) {
        wrapShrink = 0,
        currentIndex = 0,
        isGeometryCollection,
-        isFeatureCollection = geojson.type === 'FeatureCollection',
-        isFeature = geojson.type === 'Feature',
+        type = (geojson) ? geojson.type : null,


@DenisCarriere isn't geojson required here? I mean, shouldn't this actually throw an error if !geojson?
~~Then type = geojson.type any time, as geojson.type can be null~~
Sorry, type can NOT be null, it would be an invalid GeoJSON.

Well since a Geometry can be passed to coordEach, we need to handle null somehow.

Maybe its' best to add the null handling at the very top of the function.

if (geojson === null) return;

That way the rest of the code can remain unchanged.

@stebogit

CC: @stebogit #866 (comment)

DenisCarriere added 2 commits July 26, 2017 09:51

Support Null geometries

e6b4004

Add coordEach & coordReduce to null geometry support

25ca919

DenisCarriere added the bug label Jul 26, 2017

DenisCarriere added this to the 4.6.0 milestone Jul 26, 2017

DenisCarriere self-assigned this Jul 26, 2017

DenisCarriere added 2 commits July 26, 2017 11:24

Add null geometry tests for @turf/bbox

11fb27a

Merge branch 'master' into null-geometry

dc07802

stebogit reviewed Jul 26, 2017

View reviewed changes

DenisCarriere added 3 commits July 26, 2017 13:02

Throw error if null is input

060df66

https://github.com/Turfjs/turf/pull/866\#pullrequestreview-52398355

Add getCoord & getCoords tests

2b4fb44

Update JSDocs

d972c1f

DenisCarriere added 3 commits July 26, 2017 13:51

Add more Meta null testing

42f837c

Merge branch 'master' into null-geometry

9f1ba47

fix tests

72f2191

DenisCarriere added 2 commits July 27, 2017 10:16

do NOT exclude null geometries from geomEach & flattenEach

d653e8f

Merge branch 'master' into null-geometry

70ff401

DenisCarriere added 2 commits July 27, 2017 10:58

Add tests for bbox-clip

8fbee2f

Refactor tests to ES6 bbox-polygon

e1714d9

DenisCarriere requested a review from stebogit July 27, 2017 15:01

DenisCarriere added the need-review label Jul 27, 2017

stebogit reviewed Jul 27, 2017

View reviewed changes

DenisCarriere added 2 commits July 27, 2017 12:03

Extract null Geometry handling from @turf/meta

b2a99a5

Add tests for GeometryCollection

c1edd39

CC: @stebogit #866 (comment)

stebogit approved these changes Jul 27, 2017

View reviewed changes

DenisCarriere merged commit 4e479e7 into master Jul 27, 2017

DenisCarriere deleted the null-geometry branch July 27, 2017 16:39

DenisCarriere added enhancement and removed need-review labels Jul 27, 2017

stebogit mentioned this pull request Jul 29, 2017

Geometry null and bbox #853

Closed

fxi mentioned this pull request Jul 30, 2017

Issue: Failed to upload either a geojson or a .zip with shape file unep-grid/mapx#44

Closed

DenisCarriere mentioned this pull request Aug 2, 2017

New minor release! Turf 4.6.0 🎉 #884

Closed

stebogit mentioned this pull request Sep 14, 2017

updating @turf/inside or @turf/within from v4.1 to v4.2 causes "coordinates must only contain numbers" error #940

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support Null geometries #866

Support Null geometries #866

DenisCarriere commented Jul 26, 2017 •

edited

Loading

stebogit left a comment •

edited

Loading

stebogit Jul 26, 2017

stebogit Jul 26, 2017

DenisCarriere Jul 26, 2017 •

edited

Loading

DenisCarriere commented Jul 26, 2017

DenisCarriere commented Jul 26, 2017

stebogit commented Jul 27, 2017

DenisCarriere commented Jul 27, 2017 •

edited

Loading

DenisCarriere commented Jul 27, 2017

DenisCarriere commented Jul 27, 2017

DenisCarriere commented Jul 27, 2017

stebogit left a comment

stebogit Jul 27, 2017

DenisCarriere Jul 27, 2017 •

edited

Loading

DenisCarriere Jul 27, 2017

DenisCarriere Jul 27, 2017

stebogit Jul 27, 2017

DenisCarriere Jul 27, 2017

stebogit Jul 27, 2017

DenisCarriere Jul 27, 2017

Support Null geometries #866

Support Null geometries #866

Conversation

DenisCarriere commented Jul 26, 2017 • edited Loading

Modified

Implementation Discussions

Tested

stebogit left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DenisCarriere Jul 26, 2017 • edited Loading

Choose a reason for hiding this comment

DenisCarriere commented Jul 26, 2017

DenisCarriere commented Jul 26, 2017

stebogit commented Jul 27, 2017

DenisCarriere commented Jul 27, 2017 • edited Loading

DenisCarriere commented Jul 27, 2017

DenisCarriere commented Jul 27, 2017

DenisCarriere commented Jul 27, 2017

stebogit left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DenisCarriere Jul 27, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DenisCarriere commented Jul 26, 2017 •

edited

Loading

stebogit left a comment •

edited

Loading

DenisCarriere Jul 26, 2017 •

edited

Loading

DenisCarriere commented Jul 27, 2017 •

edited

Loading

DenisCarriere Jul 27, 2017 •

edited

Loading