Permit geometry field on feature objects to be null.

Fixes #42.
georust · May 10, 2016 · c4b32cd · c4b32cd
1 parent a077ac9
commit c4b32cd
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 10 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -0,0 +1,5 @@
+# Changes
+
+## 0.3.0
+
+* [Permit `geometry` field on `feature` objects to be `null`](https://github.com/georust/rust-geojson/issues/42)
diff --git a/Cargo.toml b/Cargo.toml
@@ -2,7 +2,7 @@
 
 name = "geojson"
 description = "Library for serializing the GeoJSON vector GIS file format"
-version = "0.2.1"
+version = "0.3.0"
 authors = ["Corey Farwell <coreyf@rwell.org>",
            "Blake Grotewold <hello@grotewold.me>"]
 license = "MIT/Apache-2.0"

diff --git a/README.md b/README.md
@@ -51,7 +51,7 @@ properties.insert(
 let geojson = GeoJson::Feature(Feature {
     crs: None,
     bbox: None,
-    geometry: geometry,
+    geometry: Some(geometry),
     id: None,
     properties: Some(properties),
 });

diff --git a/src/feature.rs b/src/feature.rs
@@ -31,7 +31,7 @@ use ::{Bbox, Crs, Error, FromObject, Geometry, util};
 pub struct Feature {
     pub bbox: Option<Bbox>,
     pub crs: Option<Crs>,
-    pub geometry: Geometry,
+    pub geometry: Option<Geometry>,
     pub id: Option<JsonValue>,
     pub properties: Option<JsonObject>,
 }
@@ -105,7 +105,7 @@ impl Deserialize for Feature {
 
 #[cfg(test)]
 mod tests {
-    use ::{Feature, Geometry, Value, GeoJson};
+    use ::{Error, Feature, Geometry, Value, GeoJson};
 
     fn feature_json_str() -> &'static str {
         "{\"geometry\":{\"coordinates\":[1.1,2.1],\"type\":\"Point\"},\"properties\":{},\"type\":\"Feature\"}"
@@ -124,11 +124,11 @@ mod tests {
 
     fn feature() -> Feature {
         ::Feature {
-            geometry: Geometry {
+            geometry: Some(Geometry {
                 value: Value::Point(vec![1.1, 2.1]),
                 crs: None,
                 bbox: None,
-            },
+            }),
             properties: properties(),
             crs: None,
             bbox: None,
@@ -173,4 +173,23 @@ mod tests {
         };
         assert_eq!(decoded_feature, feature);
     }
+
+    #[test]
+    fn feature_json_null_geometry() {
+        let geojson_str = r#"{
+            "geometry": null,
+            "properties":{},
+            "type":"Feature"
+        }"#;
+        assert!(geojson_str.parse::<GeoJson>().is_ok());
+    }
+
+    #[test]
+    fn feature_json_invalid_geometry() {
+        let geojson_str = r#"{"geometry":3.14,"properties":{},"type":"Feature"}"#;
+        match geojson_str.parse::<GeoJson>().unwrap_err() {
+            Error::FeatureInvalidGeometryValue => (),
+            _ => unreachable!(),
+        }
+    }
 }
diff --git a/src/lib.rs b/src/lib.rs
@@ -108,7 +108,7 @@
 //! let geojson = GeoJson::Feature(Feature {
 //!     crs: None,
 //!     bbox: None,
-//!     geometry: geometry,
+//!     geometry: Some(geometry),
 //!     id: None,
 //!     properties: Some(properties),
 //! });
@@ -171,6 +171,7 @@ pub enum Error {
     GeometryUnknownType,
     MalformedJson,
     PropertiesExpectedObjectOrNull,
+    FeatureInvalidGeometryValue,
 
     // FIXME: make these types more specific
     ExpectedStringValue,
@@ -209,6 +210,10 @@ impl std::fmt::Display for Error {
                 // FIXME: inform what type we actually found
                 write!(f, "Encountered neither object type nor null type for \
                            'properties' object."),
+            Error::FeatureInvalidGeometryValue =>
+                // FIXME: inform what type we actually found
+                write!(f, "Encountered neither object type nor null type for \
+                           'geometry' field on 'feature' object."),
             Error::ExpectedStringValue =>
                 write!(f, "Expected a string value."),
             Error::ExpectedProperty =>
@@ -236,6 +241,8 @@ impl std::error::Error for Error {
             Error::MalformedJson => "malformed JSON",
             Error::PropertiesExpectedObjectOrNull =>
                 "neither object type nor null type for properties' object.",
+            Error::FeatureInvalidGeometryValue =>
+                "neither object type nor null type for 'geometry' field on 'feature' object.",
             Error::ExpectedStringValue => "expected a string value",
             Error::ExpectedProperty => "expected a GeoJSON 'property'",
             Error::ExpectedF64Value => "expected a floating-point value",

diff --git a/src/util.rs b/src/util.rs
@@ -120,9 +120,16 @@ pub fn get_id(object: &JsonObject) -> Result<Option<JsonValue>, Error> {
 }
 
 /// Used by Feature
-pub fn get_geometry(object: &JsonObject) -> Result<Geometry, Error> {
-    let geometry = expect_object!(expect_property!(object, "geometry", "Missing 'geometry' field"));
-    return Geometry::from_object(geometry);
+pub fn get_geometry(object: &JsonObject) -> Result<Option<Geometry>, Error> {
+    let geometry = expect_property!(object, "geometry", "Missing 'geometry' field");
+    match *geometry {
+        JsonValue::Object(ref x) => {
+            let geometry_object = try!(Geometry::from_object(x));
+            Ok(Some(geometry_object))
+        },
+        JsonValue::Null => Ok(None),
+        _ => Err(Error::FeatureInvalidGeometryValue),
+    }
 }
 
 /// Used by FeatureCollection