fix: overload QueryConstraint to accept Pointer<ParseObject> (#281)

* fix: overload QueryConstraint to accept Pointer<ParseObject> * Compile for Windows
parse-community · Nov 16, 2021 · a121bde · a121bde
1 parent 25b70d9
commit a121bde
Show file tree

Hide file tree

Showing 92 changed files with 315 additions and 239 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,9 +2,16 @@
 
 ### main
 
-[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/2.2.4...main)
+[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/2.2.5...main)
 * _Contributing to this repo? Add info about your change here to be included in the next release_
 
+### 2.2.5
+[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/2.2.4...2.2.5)
+
+__Fixes__
+- Overload QueryConstraint to accept Pointer<ParseObject> ([#281](https://github.com/parse-community/Parse-Swift/pull/281)), thanks to [Corey Baker](https://github.com/cbaker6).
+- Add checks to build for Windows ([#281](https://github.com/parse-community/Parse-Swift/pull/281)), thanks to [Corey Baker](https://github.com/cbaker6).
+
 ### 2.2.4
 [Full Changelog](https://github.com/parse-community/Parse-Swift/compare/2.2.3...2.2.4)
 

diff --git a/Sources/ParseSwift/Extensions/URLCache.swift b/Sources/ParseSwift/Extensions/URLCache.swift
@@ -21,7 +21,7 @@ internal extension URLCache {
         let parseCacheDirectory = "ParseCache"
         let diskURL = cacheURL.appendingPathComponent(parseCacheDirectory, isDirectory: true)
         if #available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *) {
-            #if !os(Linux) && !os(Android)
+            #if !os(Linux) && !os(Android) && !os(Windows)
             return URLCache(memoryCapacity: ParseSwift.configuration.cacheMemoryCapacity,
                          diskCapacity: ParseSwift.configuration.cacheDiskCapacity,
                          directory: diskURL)

diff --git a/Sources/ParseSwift/InternalObjects/BaseParseInstallation.swift b/Sources/ParseSwift/InternalObjects/BaseParseInstallation.swift
@@ -29,7 +29,7 @@ internal struct BaseParseInstallation: ParseInstallation {
         guard let installationId = Self.currentContainer.installationId,
               Self.currentContainer.currentInstallation?.installationId == installationId else {
             try? ParseStorage.shared.delete(valueFor: ParseStorage.Keys.currentInstallation)
-            #if !os(Linux) && !os(Android)
+            #if !os(Linux) && !os(Android) && !os(Windows)
             try? KeychainStore.shared.delete(valueFor: ParseStorage.Keys.currentInstallation)
             #endif
             _ = Self.currentContainer

diff --git a/Sources/ParseSwift/LiveQuery/LiveQuerySocket.swift b/Sources/ParseSwift/LiveQuery/LiveQuerySocket.swift
@@ -5,7 +5,7 @@
 //  Created by Corey Baker on 12/31/20.
 //  Copyright © 2020 Parse Community. All rights reserved.
 //
-#if !os(Linux) && !os(Android)
+#if !os(Linux) && !os(Android) && !os(Windows)
 import Foundation
 #if canImport(FoundationNetworking)
 import FoundationNetworking

diff --git a/Sources/ParseSwift/LiveQuery/ParseLiveQuery+async.swift b/Sources/ParseSwift/LiveQuery/ParseLiveQuery+async.swift
@@ -6,7 +6,7 @@
 //  Copyright © 2021 Parse Community. All rights reserved.
 //
 
-#if swift(>=5.5) && canImport(_Concurrency) && !os(Linux) && !os(Android)
+#if swift(>=5.5) && canImport(_Concurrency) && !os(Linux) && !os(Android) && !os(Windows)
 import Foundation
 
 @available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)

diff --git a/Sources/ParseSwift/LiveQuery/ParseLiveQuery.swift b/Sources/ParseSwift/LiveQuery/ParseLiveQuery.swift
@@ -5,7 +5,7 @@
 //  Created by Corey Baker on 1/2/21.
 //  Copyright © 2021 Parse Community. All rights reserved.
 //
-#if !os(Linux) && !os(Android)
+#if !os(Linux) && !os(Android) && !os(Windows)
 import Foundation
 #if canImport(FoundationNetworking)
 import FoundationNetworking

diff --git a/Sources/ParseSwift/LiveQuery/Protocols/LiveQuerySocketDelegate.swift b/Sources/ParseSwift/LiveQuery/Protocols/LiveQuerySocketDelegate.swift
@@ -5,7 +5,7 @@
 //  Created by Corey Baker on 1/4/21.
 //  Copyright © 2021 Parse Community. All rights reserved.
 //
-#if !os(Linux) && !os(Android)
+#if !os(Linux) && !os(Android) && !os(Windows)
 import Foundation
 #if canImport(FoundationNetworking)
 import FoundationNetworking

diff --git a/Sources/ParseSwift/LiveQuery/Protocols/ParseLiveQueryDelegate.swift b/Sources/ParseSwift/LiveQuery/Protocols/ParseLiveQueryDelegate.swift
@@ -5,7 +5,7 @@
 //  Created by Corey Baker on 1/4/21.
 //  Copyright © 2021 Parse Community. All rights reserved.
 //
-#if !os(Linux) && !os(Android)
+#if !os(Linux) && !os(Android) && !os(Windows)
 import Foundation
 #if canImport(FoundationNetworking)
 import FoundationNetworking

diff --git a/Sources/ParseSwift/Objects/ParseInstallation.swift b/Sources/ParseSwift/Objects/ParseInstallation.swift
@@ -128,7 +128,7 @@ public extension ParseInstallation {
         get {
             guard let installationInMemory: CurrentInstallationContainer<Self> =
                     try? ParseStorage.shared.get(valueFor: ParseStorage.Keys.currentInstallation) else {
-                #if !os(Linux) && !os(Android)
+                #if !os(Linux) && !os(Android) && !os(Windows)
                 guard let installationFromKeyChain: CurrentInstallationContainer<Self> =
                         try? KeychainStore.shared.get(valueFor: ParseStorage.Keys.currentInstallation)
                 else {
@@ -191,14 +191,14 @@ public extension ParseInstallation {
     }
 
     internal static func saveCurrentContainerToKeychain() {
-        #if !os(Linux) && !os(Android)
+        #if !os(Linux) && !os(Android) && !os(Windows)
         try? KeychainStore.shared.set(Self.currentContainer, for: ParseStorage.Keys.currentInstallation)
         #endif
     }
 
     internal static func deleteCurrentContainerFromKeychain() {
         try? ParseStorage.shared.delete(valueFor: ParseStorage.Keys.currentInstallation)
-        #if !os(Linux) && !os(Android)
+        #if !os(Linux) && !os(Android) && !os(Windows)
         try? KeychainStore.shared.delete(valueFor: ParseStorage.Keys.currentInstallation)
         #endif
         //Prepare new installation
@@ -253,7 +253,7 @@ extension ParseInstallation {
         guard let appInfo = Bundle.main.infoDictionary else {
             return
         }
-        #if !os(Linux) && !os(Android)
+        #if !os(Linux) && !os(Android) && !os(Windows)
         #if TARGET_OS_MACCATALYST
         // If using an Xcode new enough to know about Mac Catalyst:
         // Mac Catalyst Apps use a prefix to the bundle ID. This should not be transmitted

diff --git a/Sources/ParseSwift/Objects/ParseUser.swift b/Sources/ParseSwift/Objects/ParseUser.swift
@@ -103,7 +103,7 @@ public extension ParseUser {
         get {
             guard let currentUserInMemory: CurrentUserContainer<Self>
                 = try? ParseStorage.shared.get(valueFor: ParseStorage.Keys.currentUser) else {
-                #if !os(Linux) && !os(Android)
+                #if !os(Linux) && !os(Android) && !os(Windows)
                 return try? KeychainStore.shared.get(valueFor: ParseStorage.Keys.currentUser)
                 #else
                 return nil
@@ -115,14 +115,14 @@ public extension ParseUser {
     }
 
     internal static func saveCurrentContainerToKeychain() {
-        #if !os(Linux) && !os(Android)
+        #if !os(Linux) && !os(Android) && !os(Windows)
         try? KeychainStore.shared.set(Self.currentContainer, for: ParseStorage.Keys.currentUser)
         #endif
     }
 
     internal static func deleteCurrentContainerFromKeychain() {
         try? ParseStorage.shared.delete(valueFor: ParseStorage.Keys.currentUser)
-        #if !os(Linux) && !os(Android)
+        #if !os(Linux) && !os(Android) && !os(Windows)
         if #available(macOS 10.15, iOS 13.0, macCatalyst 13.0, watchOS 6.0, tvOS 13.0, *) {
             URLSession.liveQuery.closeAll()
         }
@@ -992,7 +992,7 @@ extension ParseUser {
         var mutableSelf = self
         if let currentUser = Self.current,
            currentUser.hasSameObjectId(as: mutableSelf) == true {
-            #if !os(Linux) && !os(Android)
+            #if !os(Linux) && !os(Android) && !os(Windows)
             // swiftlint:disable:next line_length
             if let currentUserContainerInKeychain: CurrentUserContainer<BaseParseUser> = try? KeychainStore.shared.get(valueFor: ParseStorage.Keys.currentUser),
                currentUserContainerInKeychain.currentUser?.email == mutableSelf.email {

diff --git a/Sources/ParseSwift/Parse.swift b/Sources/ParseSwift/Parse.swift
@@ -158,7 +158,7 @@ public struct ParseSwift {
             let oneNineEightSDKVersion = try ParseVersion("1.9.8")
 
             // All migrations from previous versions to current should occur here:
-            #if !os(Linux) && !os(Android)
+            #if !os(Linux) && !os(Android) && !os(Windows)
             if previousSDKVersion < oneNineEightSDKVersion {
                 // Old macOS Keychain can't be used because it's global to all apps.
                 _ = KeychainStore.old
@@ -200,7 +200,7 @@ public struct ParseSwift {
         }
         BaseParseInstallation.createNewInstallationIfNeeded()
 
-        #if !os(Linux) && !os(Android)
+        #if !os(Linux) && !os(Android) && !os(Windows)
         if configuration.migrateFromObjcSDK {
             if let identifier = Bundle.main.bundleIdentifier {
                 let objcParseKeychain = KeychainStore(service: "\(identifier).com.parse.sdk")
@@ -326,7 +326,7 @@ public struct ParseSwift {
     }
 
     static internal func deleteKeychainIfNeeded() {
-        #if !os(Linux) && !os(Android)
+        #if !os(Linux) && !os(Android) && !os(Windows)
         // Clear items out of the Keychain on app first run.
         if UserDefaults.standard.object(forKey: ParseConstants.bundlePrefix) == nil {
             if Self.configuration.deleteKeychainIfNeeded == true {
@@ -357,7 +357,7 @@ public struct ParseSwift {
                                                        authentication: authentication)
     }
 
-    #if !os(Linux) && !os(Android)
+    #if !os(Linux) && !os(Android) && !os(Windows)
     /**
      Delete the Parse iOS Objective-C SDK Keychain from the device.
      - note: ParseSwift uses a different Keychain. After migration, the iOS Objective-C SDK Keychain is no longer needed.

diff --git a/Sources/ParseSwift/ParseConstants.swift b/Sources/ParseSwift/ParseConstants.swift
@@ -10,7 +10,7 @@ import Foundation
 
 enum ParseConstants {
     static let sdk = "swift"
-    static let version = "2.2.4"
+    static let version = "2.2.5"
     static let fileManagementDirectory = "parse/"
     static let fileManagementPrivateDocumentsDirectory = "Private Documents/"
     static let fileManagementLibraryDirectory = "Library/"
@@ -29,5 +29,7 @@ enum ParseConstants {
     static let deviceType = "linux"
     #elseif os(Android)
     static let deviceType = "android"
+    #elseif os(Windows)
+    static let deviceType = "windows"
     #endif
 }
diff --git a/Sources/ParseSwift/Storage/KeychainStore.swift b/Sources/ParseSwift/Storage/KeychainStore.swift
@@ -11,7 +11,7 @@ import Foundation
 import Security
 #endif
 
-#if !os(Linux) && !os(Android)
+#if !os(Linux) && !os(Android) && !os(Windows)
 
 func getKeychainQueryTemplate(forService service: String) -> [String: String] {
     var query = [String: String]()

diff --git a/Sources/ParseSwift/Storage/ParseFileManager.swift b/Sources/ParseSwift/Storage/ParseFileManager.swift
@@ -12,7 +12,7 @@ import Foundation
 public struct ParseFileManager {
 
     private var defaultDirectoryAttributes: [FileAttributeKey: Any]? {
-        #if os(macOS) || os(Linux) || os(Android)
+        #if os(macOS) || os(Linux) || os(Android) || os(Windows)
         return nil
         #else
         return [.protectionKey: FileProtectionType.completeUntilFirstUserAuthentication]
@@ -21,14 +21,14 @@ public struct ParseFileManager {
 
     private var defaultDataWritingOptions: Data.WritingOptions {
         var options = Data.WritingOptions.atomic
-        #if !os(macOS) && !os(Linux) && !os(Android)
+        #if !os(macOS) && !os(Linux) && !os(Android) && !os(Windows)
             options.insert(.completeFileProtectionUntilFirstUserAuthentication)
         #endif
         return options
     }
 
     private var localSandBoxDataDirectoryPath: URL? {
-        #if os(macOS) || os(Linux) || os(Android)
+        #if os(macOS) || os(Linux) || os(Android) || os(Windows)
         return self.defaultDataDirectoryPath
         #else
         // swiftlint:disable:next line_length
@@ -51,7 +51,7 @@ public struct ParseFileManager {
 
     /// The default directory for storing Parse files.
     public var defaultDataDirectoryPath: URL? {
-        #if os(macOS) || os(Linux) || os(Android)
+        #if os(macOS) || os(Linux) || os(Android) || os(Windows)
         var directoryPath: String!
         let paths = NSSearchPathForDirectoriesInDomains(.applicationSupportDirectory, .userDomainMask, true)
         guard let directory = paths.first else {
@@ -87,7 +87,7 @@ public struct ParseFileManager {
     /// Creates an instance of `ParseFileManager`.
     /// - returns: If an instance can't be created, nil is returned.
     public init?() {
-        #if os(Linux) || os(Android)
+        #if os(Linux) || os(Android) || os(Windows)
         let applicationId = ParseSwift.configuration.applicationId
         applicationIdentifier = "\(ParseConstants.bundlePrefix).\(applicationId)"
         #else

diff --git a/Sources/ParseSwift/Storage/ParseKeyValueStore.swift b/Sources/ParseSwift/Storage/ParseKeyValueStore.swift
@@ -55,7 +55,7 @@ struct InMemoryKeyValueStore: ParseKeyValueStore {
     }
 }
 
-#if !os(Linux) && !os(Android)
+#if !os(Linux) && !os(Android) && !os(Windows)
 
 // MARK: KeychainStore + ParseKeyValueStore
 extension KeychainStore: ParseKeyValueStore {

diff --git a/Sources/ParseSwift/Types/ParseACL.swift b/Sources/ParseSwift/Types/ParseACL.swift
@@ -305,7 +305,7 @@ extension ParseACL {
 
         let aclController: DefaultACL?
 
-        #if !os(Linux) && !os(Android)
+        #if !os(Linux) && !os(Android) && !os(Windows)
         aclController = try? KeychainStore.shared.get(valueFor: ParseStorage.Keys.defaultACL)
         #else
         aclController = try? ParseStorage.shared.get(valueFor: ParseStorage.Keys.defaultACL)
@@ -385,7 +385,7 @@ extension ParseACL {
                            useCurrentUser: withAccessForCurrentUser)
         }
 
-        #if !os(Linux) && !os(Android)
+        #if !os(Linux) && !os(Android) && !os(Windows)
         try KeychainStore.shared.set(aclController, for: ParseStorage.Keys.defaultACL)
         #else
         try ParseStorage.shared.set(aclController, for: ParseStorage.Keys.defaultACL)

diff --git a/Sources/ParseSwift/Types/ParseConfig.swift b/Sources/ParseSwift/Types/ParseConfig.swift
@@ -137,7 +137,7 @@ public extension ParseConfig {
         get {
             guard let configInMemory: CurrentConfigContainer<Self> =
                 try? ParseStorage.shared.get(valueFor: ParseStorage.Keys.currentConfig) else {
-                #if !os(Linux) && !os(Android)
+                #if !os(Linux) && !os(Android) && !os(Windows)
                     return try? KeychainStore.shared.get(valueFor: ParseStorage.Keys.currentConfig)
                 #else
                     return nil
@@ -160,14 +160,14 @@ public extension ParseConfig {
     }
 
     internal static func saveCurrentContainerToKeychain() {
-        #if !os(Linux) && !os(Android)
+        #if !os(Linux) && !os(Android) && !os(Windows)
         try? KeychainStore.shared.set(Self.currentContainer, for: ParseStorage.Keys.currentConfig)
         #endif
     }
 
     internal static func deleteCurrentContainerFromKeychain() {
         try? ParseStorage.shared.delete(valueFor: ParseStorage.Keys.currentConfig)
-        #if !os(Linux) && !os(Android)
+        #if !os(Linux) && !os(Android) && !os(Windows)
         try? KeychainStore.shared.delete(valueFor: ParseStorage.Keys.currentConfig)
         #endif
     }

diff --git a/Sources/ParseSwift/Types/ParseVersion.swift b/Sources/ParseSwift/Types/ParseVersion.swift
@@ -18,7 +18,7 @@ public struct ParseVersion: Encodable {
         get {
             guard let versionInMemory: String =
                 try? ParseStorage.shared.get(valueFor: ParseStorage.Keys.currentVersion) else {
-                #if !os(Linux) && !os(Android)
+                #if !os(Linux) && !os(Android) && !os(Windows)
                     guard let versionFromKeyChain: String =
                         try? KeychainStore.shared.get(valueFor: ParseStorage.Keys.currentVersion)
                          else {
@@ -39,7 +39,7 @@ public struct ParseVersion: Encodable {
         }
         set {
             try? ParseStorage.shared.set(newValue, for: ParseStorage.Keys.currentVersion)
-            #if !os(Linux) && !os(Android)
+            #if !os(Linux) && !os(Android) && !os(Windows)
             try? KeychainStore.shared.set(newValue, for: ParseStorage.Keys.currentVersion)
             #endif
         }

diff --git a/Sources/ParseSwift/Types/Query.swift b/Sources/ParseSwift/Types/Query.swift
@@ -126,19 +126,20 @@ public func == <T>(key: String, value: T) -> QueryConstraint where T: Encodable
  - parameter key: The key that the value is stored in.
  - parameter value: The `ParseObject` to compare.
  - returns: The same instance of `QueryConstraint` as the receiver.
+ - throws: An error of type `ParseError`.
  */
 public func == <T>(key: String, value: T) throws -> QueryConstraint where T: ParseObject {
-    let constraint: QueryConstraint!
-    do {
-        constraint = try QueryConstraint(key: key, value: value.toPointer())
-    } catch {
-        guard let parseError = error as? ParseError else {
-            throw ParseError(code: .unknownError,
-                             message: error.localizedDescription)
-        }
-        throw parseError
-    }
-    return constraint
+    try QueryConstraint(key: key, value: value.toPointer())
+}
+
+/**
+ Add a constraint that requires that a key is equal to a `Pointer`.
+ - parameter key: The key that the value is stored in.
+ - parameter value: The `Pointer` to compare.
+ - returns: The same instance of `QueryConstraint` as the receiver.
+ */
+public func == <T>(key: String, value: Pointer<T>) -> QueryConstraint where T: ParseObject {
+    QueryConstraint(key: key, value: value)
 }
 
 /**
@@ -587,6 +588,19 @@ internal struct RelatedCondition <T>: Encodable where T: ParseObject {
   - parameter key: The key that should be related.
   - parameter object: The object that should be related.
   - returns: The same instance of `Query` as the receiver.
+  - throws: An error of type `ParseError`.
+ */
+public func related <T>(key: String, object: T) throws -> QueryConstraint where T: ParseObject {
+    let pointer = try object.toPointer()
+    let condition = RelatedCondition(object: pointer, key: key)
+    return .init(key: QueryConstraint.Comparator.relatedTo.rawValue, value: condition)
+}
+
+/**
+  Add a constraint that requires a key is related.
+  - parameter key: The key that should be related.
+  - parameter object: The pointer object that should be related.
+  - returns: The same instance of `Query` as the receiver.
  */
 public func related <T>(key: String, object: Pointer<T>) -> QueryConstraint where T: ParseObject {
     let condition = RelatedCondition(object: object, key: key)

diff --git a/Tests/ParseSwiftTests/APICommandTests.swift b/Tests/ParseSwiftTests/APICommandTests.swift
@@ -40,7 +40,7 @@ class APICommandTests: XCTestCase {
     override func tearDownWithError() throws {
         try super.tearDownWithError()
         MockURLProtocol.removeAll()
-        #if !os(Linux) && !os(Android)
+        #if !os(Linux) && !os(Android) && !os(Windows)
         try KeychainStore.shared.deleteAll()
         #endif
         try ParseStorage.shared.deleteAll()

diff --git a/Tests/ParseSwiftTests/AnyCodableTests/AnyCodableTests.swift b/Tests/ParseSwiftTests/AnyCodableTests/AnyCodableTests.swift
@@ -40,7 +40,7 @@ class AnyCodableTests: XCTestCase {
     }
 
     //Test has objective-c
-    #if !os(Linux) && !os(Android)
+    #if !os(Linux) && !os(Android) && !os(Windows)
     func testJSONEncoding() {
         let dictionary: [String: AnyCodable] = [
             "boolean": true,