Merge pull request #43 from alickbass/support-firtimestamp

Add support for FirTimestamp

Author: Oleksii Dykan

CodableFirebase/FirestoreDecoder.swift

@@ -20,6 +20,11 @@ public protocol GeoPointType: FirestoreDecodable, FirestoreEncodable {
     init(latitude: Double, longitude: Double)
 }
 
+public protocol TimestampType: FirestoreDecodable, FirestoreEncodable {
+    init(date: Date)
+    func dateValue() -> Date
+}
+
 open class FirestoreDecoder {
     public init() {}
 
@@ -76,3 +81,15 @@ extension FirestoreEncodable {
         throw DocumentReferenceError.typeIsNotSupported
     }
 }
+
+extension TimestampType {
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.singleValueContainer()
+        self.init(date: try container.decode(Date.self))
+    }
+  
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.singleValueContainer()
+        try container.encode(self.dateValue())
+    }
+}

CodableFirebaseTests/TestCodableFirebase.swift

@@ -95,6 +95,11 @@ class TestCodableFirebase: XCTestCase {
                        expectedValue: expected,
                        dateEncodingStrategy: .secondsSince1970,
                        dateDecodingStrategy: .secondsSince1970)
+      
+        _testRoundTrip(of: TopLevelWrapper(FirTimestamp(date: Date(timeIntervalSince1970: seconds))),
+                       expectedValue: expected,
+                       dateEncodingStrategy: .secondsSince1970,
+                       dateDecodingStrategy: .secondsSince1970)
 
         _testRoundTrip(of: OptionalTopLevelWrapper(Date(timeIntervalSince1970: seconds)),
                        expectedValue: expected,
@@ -500,6 +505,22 @@ fileprivate struct Timestamp : Codable, Equatable {
     }
 }
 
+fileprivate struct FirTimestamp : TimestampType, Equatable {
+    let date: Date
+  
+    init(date: Date) {
+        self.date = date
+    }
+  
+    func dateValue() -> Date {
+        return date
+    }
+  
+    static func == (_ lhs: FirTimestamp, _ rhs: FirTimestamp) -> Bool {
+        return lhs.date == rhs.date
+    }
+}
+
 /// A simple referential counter type that encodes as a single Int value.
 fileprivate final class Counter : Codable, Equatable {
     var count: Int = 0

CodableFirebaseTests/TestCodableFirestore.swift

@@ -128,7 +128,14 @@ class TestCodableFirestore: XCTestCase {
         XCTAssertEqual((try? FirestoreEncoder().encode(val)) as NSDictionary?, ["value": val.value])
         XCTAssertEqual(try? FirestoreDecoder().decode(TopLevelWrapper<DocumentReference>.self, from: ["value": val.value]), val)
     }
-    
+  
+    func testEncodingTimestamp() {
+        let timestamp = Timestamp(date: Date())
+        let wrapper = TopLevelWrapper(timestamp)
+        XCTAssertEqual((try? FirestoreEncoder().encode(wrapper)) as NSDictionary?, ["value": timestamp])
+        XCTAssertEqual(try? FirestoreDecoder().decode(TopLevelWrapper<Timestamp>.self, from: ["value": timestamp]), wrapper)
+    }
+  
     private func _testEncodeFailure<T : Encodable>(of value: T) {
         do {
             let _ = try FirestoreEncoder().encode(value)
@@ -195,10 +202,29 @@ fileprivate class GeoPoint: NSObject, GeoPointType {
         self.longitude = longitude
     }
 
-    static func == (lhs: Point, rhs: Point) -> Bool {
-        return lhs.latitude == rhs.latitude && lhs.longitude == rhs.longitude
+    override func isEqual(_ object: Any?) -> Bool {
+        guard let other = object.flatMap({ $0 as? GeoPoint }) else { return false }
+        return latitude == other.latitude && longitude == other.longitude
     }
 }
 
 // MARK: - ReferenceType
 fileprivate class DocumentReference: NSObject, DocumentReferenceType {}
+
+// MARK: - Timestamp
+fileprivate class Timestamp: NSObject, TimestampType {
+    let date: Date
+  
+    required init(date: Date) {
+        self.date = date
+    }
+  
+    func dateValue() -> Date {
+        return date
+    }
+  
+    override func isEqual(_ object: Any?) -> Bool {
+        guard let other = object.flatMap({ $0 as? Timestamp }) else { return false }
+        return date == other.date
+    }
+}

README.md

@@ -86,14 +86,15 @@ Firestore.firestore().collection("data").document("one").getDocument { (document
 }
 ```
 
-### How to use `GeoPoint`, `DocumentRefence`, `FieldValue` in Firestore
+### How to use `GeoPoint`, `DocumentRefence`, `FieldValue`, `Timestamp` in Firestore
 
 In order to use these 2 types with `Firestore`, you need to add the following code somewhere in your app:
 
 ```swift
 extension DocumentReference: DocumentReferenceType {}
 extension GeoPoint: GeoPointType {}
 extension FieldValue: FieldValueType {}
+extension Timestamp: TimestampType {}
 ```
 
 and now they become `Codable` and can be used properly with `FirestoreEncoder` and `FirestoreDecoder`.