Add build infrastructure for Codable support in Firestore #815
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # | ||
| # Be sure to run `pod lib lint FirebaseFirestoreSwift.podspec' to ensure this is a | ||
| # valid spec before submitting. | ||
| # | ||
|
|
||
| Pod::Spec.new do |s| | ||
| s.name = 'FirebaseFirestoreSwift' | ||
| s.version = '0.10.1' | ||
| s.summary = 'Google Cloud Firestore for iOS Swift Extensions' | ||
|
|
||
| s.description = <<-DESC | ||
| Google Cloud Firestore is a NoSQL document database built for automatic scaling, high performance, and ease of application development. | ||
| DESC | ||
|
|
||
| s.homepage = 'https://developers.google.com/' | ||
| s.license = { :type => 'Apache', :file => 'LICENSE' } | ||
| s.authors = 'Google, Inc.' | ||
|
|
||
| s.source = { | ||
| :git => 'https://github.com/Firebase/firebase-ios-sdk.git', | ||
| :tag => s.version.to_s | ||
| } | ||
|
|
||
| s.swift_version = '4.0' | ||
| s.ios.deployment_target = '8.0' | ||
|
|
||
| s.cocoapods_version = '>= 1.4.0' | ||
| s.static_framework = true | ||
| s.prefix_header_file = false | ||
|
|
||
| s.requires_arc = true | ||
| s.source_files = [ | ||
| 'Firestore/Swift/Source/**/*.swift', | ||
| ] | ||
|
|
||
| s.dependency 'FirebaseFirestore', "= #{s.version}" | ||
| end | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 { | ||
|
There was a problem hiding this comment. Once we move to Source builds, hopefully this won't be required! There was a problem hiding this comment. I don't think that's going to matter. This exists because of limitations in the Swift compiler. So long as GeoPoint is implemented in Objective-C and can't implement Codable directly these will be required. |
||
| 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 {} | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
|
There was a problem hiding this comment. " Is this going to be an issue do you think? Or is it just .0001 off like below? There was a problem hiding this comment. The issue here is that we don't control the JSON encoding/decoding and this test doesn't really care about any kind of conformance in that scenario. If users use this serialization and don't like the results they can take it up with the authors of I'm validating that GeoPoint conforms to Codable without any dependency on Firestore or snapshots. |
||
| // 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) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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> |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Might want to explicitly version this separately since it presumably doesn't need to stay in lock step.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.