Add query and cloud code view models for SwiftUI (#183)

* Add QueryViewModel. Switch ParseSubscription to QuerySubscribable

* Update playgrounds

* Playground nits

* Add test cases

* Fix link in change log

* Fix min version in README

* nits

* Improve Playgrounds by moving SwiftUI to new pages

* Add required initializer

* Update Changelog

* Playground nits

* Update build script name to SwiftLint

* Update change log

* Remove unused constant

* document nits

* Fix printing error in playgrounds

* Update changelog

* Fix badge in readme

* Add changelog

* Update changelog

* nits

* Update change log

* Add view model for Cloud Code

* Switch CloudViewModel return type to optional

* test removal of internal(set) on viewModels

* allow properties of ViewModels to be overriden when subclassed

* Update changelog

* Update uniquePointer in encoder

* Fix cycle detection

* nits

* nits

* Update changelog

* Fix viewModel publishers

* Update changelog

* Make subscribe public for LiveQuery

* Update caching directories

* Fix cache directories

* Use original cache method

* Use cache directly from URLSession only. Other way causes random errors

* Attempt to use new cache method again

Author: cbaker6

.codecov.yml

@@ -4,7 +4,7 @@ coverage:
   status:
     patch:
       default:
-        target: 71
+        target: auto
     changes: false
     project:
       default:

CHANGELOG.md

@@ -1,9 +1,32 @@
 # Parse-Swift Changelog
 
 ### main
-[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/1.8.6...main)
+[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/1.9.0...main)
 * _Contributing to this repo? Add info about your change here to be included in the next release_
 
+### 1.9.0
+[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/1.8.6...1.9.0)
+
+__New features__
+- (Breaking Change) Added a new type, QueryViewModel which conforms to ObservableObject. The new type serves as a view model property for any Parse Query. Simply call query.viewModel to use the view model with any SwiftUI view. QueryViewModel can be subclassed for customization. In addition, developers can create their own view models for queries by conforming to QueryObservable. LiveQuery Subscription's inherrit from QueryViewModel meaning instances of Subscription provides a single view model that publishes updates from LiveQuery events and traditional find, first, count, and aggregate queries. A breaking change is introduced for those use custom subscriptions as ParseSubscription has been renamed to QuerySubscribable ([#183](https://github.com/parse-community/Parse-Swift/pull/183)), thanks to [Corey Baker](https://github.com/cbaker6).
+- Added a new type, CloudViewModel which conforms to ObservableObject. The new type serves as a view model property for any Cloud Code. Simply call cloud.viewModel to use the view model with any SwiftUI view. CloudViewModel can be subclassed for customization. In addition, developers can create their own view models for queries by conforming to CloudObservable ([#183](https://github.com/parse-community/Parse-Swift/pull/183)), thanks to [Corey Baker](https://github.com/cbaker6).
+- Added two missing Parse types, ParseBytes and ParsePolygon ([#190](https://github.com/parse-community/Parse-Swift/pull/190)), thanks to [Corey Baker](https://github.com/cbaker6).
+- Added caching of http requests along with adding additional headers. Caching and additional headers can be set when initializing the SDK. Caching can also be set per request using API.Options. ([#196](https://github.com/parse-community/Parse-Swift/pull/196)), thanks to [Corey Baker](https://github.com/cbaker6).
+
+__Improvements__
+- Removed CommonCrypto and now uses encoded string as a hash for child ParseObjects across all OS's ([#184](https://github.com/parse-community/Parse-Swift/pull/184)), thanks to [Corey Baker](https://github.com/cbaker6).
+- All types now conform to CustomStringConvertible ([#185](https://github.com/parse-community/Parse-Swift/pull/185)), thanks to [Corey Baker](https://github.com/cbaker6).
+- Setting limit = 0 of a query doesn't query the server and instead just returns empty or no results depending on the query ([#189](https://github.com/parse-community/Parse-Swift/pull/189)), thanks to [Corey Baker](https://github.com/cbaker6).
+- ParseGeoPoint initializer now throws if geopoints are out-of-bounds instead of asserting ([#190](https://github.com/parse-community/Parse-Swift/pull/190)), thanks to [Corey Baker](https://github.com/cbaker6).
+- Persist all properties of ParseUser and ParseInstallation to keychain so they can be accessed via current. Developers don't have to fetch the ParseUser or ParseInstlation after app restart anymore ([#191](https://github.com/parse-community/Parse-Swift/pull/191)), thanks to [Corey Baker](https://github.com/cbaker6).
+
+__Fixes__
+- Fixed a bug when signing up from a ParseUser instance resulted in custom keys not being persisted to the keychain ([#187](https://github.com/parse-community/Parse-Swift/pull/187)), thanks to [Corey Baker](https://github.com/cbaker6).
+- Fixed a bug where countExplain query result wasn't returned as an array  ([#189](https://github.com/parse-community/Parse-Swift/pull/189)), thanks to [Corey Baker](https://github.com/cbaker6).
+- The query withinPolygon(key: String, points: [ParseGeoPoint]) now works correctly and sends an array of doubles instead of an array of GeoPoint's ([#190](https://github.com/parse-community/Parse-Swift/pull/190)), thanks to [Corey Baker](https://github.com/cbaker6).
+- Fixed a bug where the ParseEncoder incorrectly detects a circular dependency when two child objects are the same ([#194](https://github.com/parse-community/Parse-Swift/pull/194)), thanks to [Corey Baker](https://github.com/cbaker6).
+- Make sure all LiveQuery socket changes are received on the correct queue to prevent threading issues ([#195](https://github.com/parse-community/Parse-Swift/pull/195)), thanks to [Corey Baker](https://github.com/cbaker6).
+
 ### 1.8.6
 [Full Changelog](https://github.com/parse-community/Parse-Swift/compare/1.8.5...1.8.6)
 

ParseSwift.playground/Pages/1 - Your first Object.xcplaygroundpage/Contents.swift

@@ -346,5 +346,4 @@ do {
 }
 
 PlaygroundPage.current.finishExecution()
-
 //: [Next](@next)

ParseSwift.playground/Pages/10 - Cloud Code.xcplaygroundpage/Contents.swift

@@ -113,5 +113,4 @@ score.save(options: [.context(["hello": "world"])]) { result in
 }
 
 PlaygroundPage.current.finishExecution()
-
 //: [Next](@next)

ParseSwift.playground/Pages/11 - LiveQuery.xcplaygroundpage/Contents.swift

@@ -1,21 +1,10 @@
 //: [Previous](@previous)
 
-//: For this page, make sure your build target is set to ParseSwift (iOS) and targeting
-//: an iPhone, iPod, or iPad. Also be sure your `Playground Settings`
-//: in the `File Inspector` is `Platform = iOS`. This is because
-//: SwiftUI in macOS Playgrounds doesn't seem to build correctly
-//: Be sure to switch your target and `Playground Settings` back to
-//: macOS after leaving this page.
-
 import PlaygroundSupport
 import Foundation
 import ParseSwift
-#if canImport(SwiftUI)
 import SwiftUI
-#if canImport(Combine)
-import Combine
-#endif
-#endif
+
 PlaygroundPage.current.needsIndefiniteExecution = true
 
 initializeParse()
@@ -45,62 +34,6 @@ struct GameScore: ParseObject {
 //: Create a query just as you normally would.
 var query = GameScore.query("score" < 11)
 
-#if canImport(SwiftUI)
-//: To use subscriptions inside of SwiftUI
-struct ContentView: View {
-
-    //: A LiveQuery subscription can be used as a view model in SwiftUI
-    @ObservedObject var subscription = query.subscribe!
-
-    var body: some View {
-        VStack {
-
-            if subscription.subscribed != nil {
-                Text("Subscribed to query!")
-            } else if subscription.unsubscribed != nil {
-                Text("Unsubscribed from query!")
-            } else if let event = subscription.event {
-
-                //: This is how you register to receive notifications of events related to your LiveQuery.
-                switch event.event {
-
-                case .entered(let object):
-                    Text("Entered with score: \(object.score)")
-                case .left(let object):
-                    Text("Left with score: \(object.score)")
-                case .created(let object):
-                    Text("Created with score: \(object.score)")
-                case .updated(let object):
-                    Text("Updated with score: \(object.score)")
-                case .deleted(let object):
-                    Text("Deleted with score: \(object.score)")
-                }
-            } else {
-                Text("Not subscribed to a query")
-            }
-
-            Spacer()
-
-            Text("Update GameScore in Parse Dashboard to see changes here")
-
-            Button(action: {
-                try? query.unsubscribe()
-            }, label: {
-                Text("Unsubscribe")
-                    .font(.headline)
-                    .background(Color.red)
-                    .foregroundColor(.white)
-                    .padding()
-                    .cornerRadius(20.0)
-                    .frame(width: 300, height: 50)
-            })
-        }
-    }
-}
-
-PlaygroundPage.current.setLiveView(ContentView())
-#endif
-
 //: This is how you subscribe to your created query using callbacks.
 let subscription = query.subscribeCallback!
 

ParseSwift.playground/Pages/12 - Roles and Relations.xcplaygroundpage/Contents.swift

@@ -229,5 +229,4 @@ let relation = User.current!.relation
 //: similar to `users` and `roles`.
 
 PlaygroundPage.current.finishExecution()
-
 //: [Next](@next)

ParseSwift.playground/Pages/14 - Config.xcplaygroundpage/Contents.swift

@@ -69,5 +69,4 @@ config.fetch { result in
 print(Config.current ?? "No config")
 
 PlaygroundPage.current.finishExecution()
-
 //: [Next](@next)

ParseSwift.playground/Pages/15 - Custom ObjectId.xcplaygroundpage/Contents.swift

@@ -118,4 +118,5 @@ scoreToFetch.fetch { result in
     }
 }
 
+PlaygroundPage.current.finishExecution()
 //: [Next](@next)

ParseSwift.playground/Pages/16 - Analytics.xcplaygroundpage/Contents.swift

@@ -36,5 +36,4 @@ friendEvent.track(dimensions: ["more": "info"]) { result in
 }
 
 PlaygroundPage.current.finishExecution()
-
 //: [Next](@next)

ParseSwift.playground/Pages/17 - SwiftUI - Finding Objects.xcplaygroundpage/Contents.swift

@@ -1,20 +1,17 @@
 //: [Previous](@previous)
 
+//: If you are using Xcode 13+, ignore the comments below:
 //: For this page, make sure your build target is set to ParseSwift (iOS) and targeting
 //: an iPhone, iPod, or iPad. Also be sure your `Playground Settings`
 //: in the `File Inspector` is `Platform = iOS`. This is because
 //: SwiftUI in macOS Playgrounds doesn't seem to build correctly
 //: Be sure to switch your target and `Playground Settings` back to
 //: macOS after leaving this page.
 
-#if canImport(SwiftUI)
 import PlaygroundSupport
 import Foundation
 import ParseSwift
 import SwiftUI
-#if canImport(Combine)
-import Combine
-#endif
 
 PlaygroundPage.current.needsIndefiniteExecution = true
 
@@ -25,11 +22,10 @@ struct GameScore: ParseObject, Identifiable {
 
     //: Conform to Identifiable for iOS13+
     var id: String { // swiftlint:disable:this identifier_name
-        if let objectId = self.objectId {
-            return objectId
-        } else {
+        guard let objectId = self.objectId else {
             return UUID().uuidString
         }
+        return objectId
     }
 
     //: These are required for any Object.
@@ -52,68 +48,38 @@ struct GameScore: ParseObject, Identifiable {
 
 //: To use queries with SwiftUI
 
-//: Create a custom view model that queries GameScore's.
-class ViewModel: ObservableObject {
-    @Published var objects = [GameScore]()
-    @Published var error: ParseError?
-
-    private var subscriptions = Set<AnyCancellable>()
-
-    init() {
-        fetchScores()
-    }
-
-    func fetchScores() {
-        let query = GameScore.query("score" > 2)
-            .order([.descending("score")])
-        let publisher = query
-            .findPublisher()
-            .sink(receiveCompletion: { result in
-                switch result {
-                case .failure(let error):
-                    // Publish error.
-                    self.error = error
-                case .finished:
-                    print("Successfully queried data")
-                }
-            },
-            receiveValue: {
-                // Publish found objects
-                self.objects = $0
-                print("Found \(self.objects.count), objects: \(self.objects)")
-            })
-        publisher.store(in: &subscriptions)
-    }
-}
-
 //: Create a SwiftUI view.
 struct ContentView: View {
 
     //: A view model in SwiftUI
-    @ObservedObject var viewModel = ViewModel()
+    @ObservedObject var viewModel = GameScore.query("score" > 2)
+        .order([.descending("score")])
+        .viewModel
 
     var body: some View {
         NavigationView {
             if let error = viewModel.error {
-                Text(error.debugDescription)
+                Text(error.description)
             } else {
                 //: Warning - List seems to only work in Playgrounds Xcode 13+.
-                List(viewModel.objects, id: \.objectId) { object in
+                List(viewModel.results, id: \.id) { result in
                     VStack(alignment: .leading) {
-                        Text("Score: \(object.score)")
+                        Text("Score: \(result.score)")
                             .font(.headline)
-                        if let createdAt = object.createdAt {
+                        if let createdAt = result.createdAt {
                             Text("\(createdAt.description)")
                         }
                     }
                 }
             }
             Spacer()
-        }
+        }.onAppear(perform: {
+            viewModel.find()
+        })
     }
 }
 
 PlaygroundPage.current.setLiveView(ContentView())
-#endif
 
+PlaygroundPage.current.finishExecution()
 //: [Next](@next)