Updated documentation and associated test.

mapbox · Nov 26, 2018 · 58b1dc7 · 58b1dc7
1 parent 2fdcf17
commit 58b1dc7
Show file tree

Hide file tree

Showing 2 changed files with 64 additions and 3 deletions.
diff --git a/platform/darwin/src/MGLCluster.h b/platform/darwin/src/MGLCluster.h
@@ -21,9 +21,18 @@ FOUNDATION_EXTERN MGL_EXPORT const NSUInteger MGLClusterIdentifierInvalid;
  example:
  
  ```swift
- if let cluster = feature as? MGLCluster {
-    ...
+ let shape = try! MGLShape(data: clusterShapeData, encoding: String.Encoding.utf8.rawValue)
+ 
+ guard let pointFeature = shape as? MGLPointFeature else {
+ throw ExampleError.unexpectedFeatureType
+ }
+ 
+ // Check for cluster conformance
+ guard let cluster = pointFeature as? MGLCluster else {
+ throw ExampleError.featureIsNotACluster
  }
+ 
+ print("Approximate number of points in cluster: \(cluster.clusterPointCountAbbreviation)")
  ```
  */
 MGL_EXPORT

diff --git a/platform/darwin/test/MGLDocumentationExampleTests.swift b/platform/darwin/test/MGLDocumentationExampleTests.swift
@@ -374,7 +374,7 @@ class MGLDocumentationExampleTests: XCTestCase, MGLMapViewDelegate {
                 return MGLDocumentationExampleTests.styleURL
             }
         }
-
+               
         //#-example-code
         let camera = MGLMapCamera(lookingAtCenter: CLLocationCoordinate2D(latitude: 37.7184, longitude: -122.4365), altitude: 100, pitch: 20, heading: 0)
 
@@ -394,6 +394,58 @@ class MGLDocumentationExampleTests: XCTestCase, MGLMapViewDelegate {
         wait(for: [expectation], timeout: 5)
     }
 
+    func testMGLCluster() {
+
+        enum ExampleError: Error {
+            case unexpectedFeatureType
+            case featureIsNotACluster
+        }
+
+        let geoJSON: [String: Any] = [
+            "type" : "Feature",
+            "geometry" : [
+                "coordinates" : [
+                    -77.00896639534831,
+                    38.87031006108791,
+                    0.0
+                ],
+                "type" : "Point"
+            ],
+            "properties" : [
+                "cluster" : true,
+                "cluster_id" : 123,
+                "point_count" : 4567,
+                "point_count_abbreviated" : "4.5k"
+            ]
+        ]
+
+        let clusterShapeData = try! JSONSerialization.data(withJSONObject: geoJSON, options: [])
+
+        do {
+            //#-example-code
+            let shape = try! MGLShape(data: clusterShapeData, encoding: String.Encoding.utf8.rawValue)
+
+            guard let pointFeature = shape as? MGLPointFeature else {
+                throw ExampleError.unexpectedFeatureType
+            }
+
+            // Check for cluster conformance
+            guard let cluster = pointFeature as? MGLCluster else {
+                throw ExampleError.featureIsNotACluster
+            }
+
+            print("Approximate number of points in cluster: \(cluster.clusterPointCountAbbreviation)")
+
+            //#-end-example-code
+
+            XCTAssert(cluster.clusterIdentifier == 123)
+            XCTAssert(cluster.clusterPointCount == 4567)
+        }
+        catch let error {
+            XCTFail("Example failed with thrown error: \(error)")
+        }            
+    }
+
     // For testMGLMapView().
     func myCustomFunction() {}
 }