aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firestore/Swift
diff options
context:
space:
mode:
authorGravatar Gil <mcg@google.com>2018-02-26 08:09:28 -0800
committerGravatar GitHub <noreply@github.com>2018-02-26 08:09:28 -0800
commit13e366738463739f0c21d4cedab4bafbfdb57c6f (patch)
tree1104e714aa00b3c115199863ea38886b56c79f41 /Firestore/Swift
parentf735461070b353f8dc6654eeda2610b87307ef15 (diff)
Add build infrastructure for Codable support in Firestore (#815)
* Add Firestore_SwiftTests_iOS target to Xcode * Add FirebaseFirestoreSwift podspec * Add Firestore_SwiftTests_iOS to the Podfile * Add CodableGeoPoint and tests * Version FirebaseFirestoreSwift separately
Diffstat (limited to 'Firestore/Swift')
-rw-r--r--Firestore/Swift/Source/Codable/CodableGeoPoint.swift62
-rw-r--r--Firestore/Swift/Tests/Codable/CodableGeoPointTests.swift49
-rw-r--r--Firestore/Swift/Tests/Info.plist22
3 files changed, 133 insertions, 0 deletions
diff --git a/Firestore/Swift/Source/Codable/CodableGeoPoint.swift b/Firestore/Swift/Source/Codable/CodableGeoPoint.swift
new file mode 100644
index 0000000..fa56340
--- /dev/null
+++ b/Firestore/Swift/Source/Codable/CodableGeoPoint.swift
@@ -0,0 +1,62 @@
+/*
+ * Copyright 2018 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import FirebaseFirestore
+
+/**
+ * A protocol describing the encodable properties of a GeoPoint.
+ *
+ * Note: this protocol exists as a workaround for the Swift compiler: if the GeoPoint class was
+ * extended directly to conform to Codable, the methods implementing the protcol would be need to be
+ * marked required but that can't be done in an extension. Declaring the extension on the protocol
+ * sidesteps this issue.
+ */
+fileprivate protocol CodableGeoPoint: Codable {
+ var latitude: Double { get }
+ var longitude: Double { get }
+
+ init(latitude: Double, longitude: Double)
+}
+
+/** The keys in a GeoPoint. Must match the properties of CodableGeoPoint. */
+fileprivate enum GeoPointKeys: String, CodingKey {
+ case latitude
+ case longitude
+}
+
+/**
+ * An extension of GeoPoint that implements the behavior of the Codable protocol.
+ *
+ * Note: this is implemented manually here because the Swift compiler can't synthesize these methods
+ * when declaring an extension to conform to Codable.
+ */
+extension CodableGeoPoint {
+ public init(from decoder: Decoder) throws {
+ let container = try decoder.container(keyedBy: GeoPointKeys.self)
+ let latitude = try container.decode(Double.self, forKey: .latitude)
+ let longitude = try container.decode(Double.self, forKey: .longitude)
+ self.init(latitude: latitude, longitude: longitude)
+ }
+
+ public func encode(to encoder: Encoder) throws {
+ var container = encoder.container(keyedBy: GeoPointKeys.self)
+ try container.encode(latitude, forKey: .latitude)
+ try container.encode(longitude, forKey: .longitude)
+ }
+}
+
+/** Extends GeoPoint to conform to Codable. */
+extension GeoPoint: CodableGeoPoint {}
diff --git a/Firestore/Swift/Tests/Codable/CodableGeoPointTests.swift b/Firestore/Swift/Tests/Codable/CodableGeoPointTests.swift
new file mode 100644
index 0000000..6b1dce4
--- /dev/null
+++ b/Firestore/Swift/Tests/Codable/CodableGeoPointTests.swift
@@ -0,0 +1,49 @@
+/*
+ * Copyright 2018 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import FirebaseFirestore
+import FirebaseFirestoreSwift
+import Foundation
+import XCTest
+
+class CodableGeoPointTests: XCTestCase {
+ func testGeoPointEncodes() {
+ let geoPoint = GeoPoint(latitude: 37.77493, longitude: -122.41942)
+
+ let jsonData = try! JSONEncoder().encode(geoPoint)
+ let json = String(data: jsonData, encoding: .utf8)!
+
+ // The ordering of attributes in the JSON output is not guaranteed, nor is the rounding of
+ // the values so just verify that each required property is present and that the value
+ // starts as expected.
+ XCTAssert(json.contains("\"latitude\":37."))
+ XCTAssert(json.contains("\"longitude\":-122."))
+ }
+
+ func testGeoPointDecodes() {
+ let json = """
+ {
+ "latitude": 37.77493,
+ "longitude": -122.41942
+ }
+ """
+ let jsonData: Data = json.data(using: .utf8)!
+
+ let geoPoint = try! JSONDecoder().decode(GeoPoint.self, from: jsonData)
+ XCTAssertEqual(37.77493, geoPoint.latitude, accuracy: 0.0001)
+ XCTAssertEqual(-122.41942, geoPoint.longitude, accuracy: 0.0001)
+ }
+}
diff --git a/Firestore/Swift/Tests/Info.plist b/Firestore/Swift/Tests/Info.plist
new file mode 100644
index 0000000..6c40a6c
--- /dev/null
+++ b/Firestore/Swift/Tests/Info.plist
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+ <key>CFBundleDevelopmentRegion</key>
+ <string>$(DEVELOPMENT_LANGUAGE)</string>
+ <key>CFBundleExecutable</key>
+ <string>$(EXECUTABLE_NAME)</string>
+ <key>CFBundleIdentifier</key>
+ <string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+ <key>CFBundleInfoDictionaryVersion</key>
+ <string>6.0</string>
+ <key>CFBundleName</key>
+ <string>$(PRODUCT_NAME)</string>
+ <key>CFBundlePackageType</key>
+ <string>BNDL</string>
+ <key>CFBundleShortVersionString</key>
+ <string>1.0</string>
+ <key>CFBundleVersion</key>
+ <string>1</string>
+</dict>
+</plist>