-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Firestore swift Codable support (#3198)
FirestoreEncoder/Decoder and Timestamp/GeoPoint codable support.
- Loading branch information
Hui-Wu
authored
Jun 19, 2019
1 parent
0c11224
commit 1de21a8
Showing
13 changed files
with
2,352 additions
and
9 deletions.
There are no files selected for viewing
This file contains 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 |
|---|---|---|
|
|
@@ -85,6 +85,9 @@ Ninja | |
| # Visual Studio | ||
| /.vs | ||
|
|
||
| # Visual Studio Code | ||
| /.vscode | ||
|
|
||
| # CocoaPods generate | ||
| gen/ | ||
|
|
||
|
|
||
This file contains 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 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,23 @@ | ||
| /* | ||
| * Copyright 2019 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. | ||
| */ | ||
|
|
||
| public enum FirestoreDecodingError: Error { | ||
| case decodingIsNotSupported | ||
| } | ||
|
|
||
| public enum FirestoreEncodingError: Error { | ||
| case encodingIsNotSupported | ||
| } |
24 changes: 24 additions & 0 deletions
24
Firestore/Swift/Source/Codable/CodablePassThroughTypes.swift
This file contains 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,24 @@ | ||
| /* | ||
| * Copyright 2019 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 Foundation | ||
| import FirebaseFirestore | ||
|
|
||
| internal func isFirestorePassthroughType<T: Any>(_ value: T) -> Bool { | ||
| return | ||
| T.self == GeoPoint.self || | ||
| T.self == Timestamp.self | ||
| } |
This file contains 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 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 2019 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 Timestamp. | ||
| * | ||
| * Note: this protocol exists as a workaround for the Swift compiler: if the Timestamp class | ||
| * was extended directly to conform to Codable, the methods implementing the protocol 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. | ||
| */ | ||
| private protocol CodableTimestamp: Codable { | ||
| var seconds: Int64 { get } | ||
| var nanoseconds: Int32 { get } | ||
|
|
||
| init(seconds: Int64, nanoseconds: Int32) | ||
| } | ||
|
|
||
| /** The keys in a Timestamp. Must match the properties of CodableTimestamp. */ | ||
| private enum TimestampKeys: String, CodingKey { | ||
| case seconds | ||
| case nanoseconds | ||
| } | ||
|
|
||
| /** | ||
| * An extension of Timestamp 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 CodableTimestamp { | ||
| public init(from decoder: Decoder) throws { | ||
| let container = try decoder.container(keyedBy: TimestampKeys.self) | ||
| let seconds = try container.decode(Int64.self, forKey: .seconds) | ||
| let nanoseconds = try container.decode(Int32.self, forKey: .nanoseconds) | ||
| self.init(seconds: seconds, nanoseconds: nanoseconds) | ||
| } | ||
|
|
||
| public func encode(to encoder: Encoder) throws { | ||
| var container = encoder.container(keyedBy: TimestampKeys.self) | ||
| try container.encode(seconds, forKey: .seconds) | ||
| try container.encode(nanoseconds, forKey: .nanoseconds) | ||
| } | ||
| } | ||
|
|
||
| /** Extends Timestamp to conform to Codable. */ | ||
| extension Timestamp: CodableTimestamp {} |
Oops, something went wrong.