feat: add isDirtyForKey method for ParseObjects (#9)

* feat: add isDirtyForKey method for ParseObjects

* doc nits

* update ci macOS images

Author: cbaker6

.github/workflows/ci.yml

@@ -4,14 +4,19 @@ on:
     branches: [ main ]
   pull_request:
     branches: '*'
+
 env:
   CI_XCODE_OLDEST: '/Applications/Xcode_12.5.1.app/Contents/Developer'
   CI_XCODE_13: '/Applications/Xcode_13.4.1.app/Contents/Developer'
   CI_XCODE_LATEST: '/Applications/Xcode_14.0.1.app/Contents/Developer'
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   xcode-test-ios:
-    runs-on: macos-12
+    runs-on: macos-latest
     steps:
     - uses: actions/checkout@v3
     - name: Use multiple cores
@@ -38,7 +43,7 @@ jobs:
           DEVELOPER_DIR: ${{ env.CI_XCODE_LATEST }}
 
   xcode-test-macos:
-    runs-on: macos-12
+    runs-on: macos-latest
     steps:
     - uses: actions/checkout@v3
     - name: Create and set the default keychain
@@ -71,7 +76,7 @@ jobs:
           DEVELOPER_DIR: ${{ env.CI_XCODE_LATEST }}
 
   xcode-test-tvos:
-    runs-on: macos-12
+    runs-on: macos-latest
     steps:
     - uses: actions/checkout@v3
     - name: Use multiple cores
@@ -98,7 +103,7 @@ jobs:
           DEVELOPER_DIR: ${{ env.CI_XCODE_LATEST }}
 
   xcode-build-watchos:
-    runs-on: macos-12
+    runs-on: macos-latest
     steps:
     - uses: actions/checkout@v3
     - name: Use multiple cores
@@ -115,7 +120,7 @@ jobs:
           DEVELOPER_DIR: ${{ env.CI_XCODE_LATEST }}
 
   spm-test:
-    runs-on: macos-12
+    runs-on: macos-latest
     steps:
     - uses: actions/checkout@v3
     - name: Create and set the default keychain
@@ -149,7 +154,7 @@ jobs:
 
   xcode-test-ios-5_3:
     needs: xcode-build-watchos
-    runs-on: macos-latest
+    runs-on: macos-11
     steps:
     - uses: actions/checkout@v3
     - name: Build-Test
@@ -226,7 +231,7 @@ jobs:
 
   docs:
     needs: xcode-build-watchos
-    runs-on: macos-12
+    runs-on: macos-latest
     steps:
       - uses: actions/checkout@v3
       - name: Use multiple cores
@@ -238,7 +243,7 @@ jobs:
 
   carthage:
    needs: xcode-build-watchos
-   runs-on: macos-12
+   runs-on: macos-latest
    steps:
      - uses: actions/checkout@v3
      - name: Use multiple cores

.github/workflows/release.yml

@@ -8,7 +8,7 @@ env:
 
 jobs:
   docs:
-    runs-on: macos-12
+    runs-on: macos-latest
     steps:
       - uses: actions/checkout@v3
       - name: Get release version

CHANGELOG.md

@@ -4,6 +4,9 @@
 [Full Changelog](https://github.com/netreconlab/Parse-Swift/compare/4.15.2...main), [Documentation](https://swiftpackageindex.com/netreconlab/Parse-Swift/main/documentation/parseswift)
 * _Contributing to this repo? Add info about your change here to be included in the next release_
 
+__New features__
+- Added the ability to check if a `ParseObject` key is dirty ([#9](https://github.com/netreconlab/Parse-Swift/pull/9)), thanks to [Corey Baker](https://github.com/cbaker6).
+
 ### 4.15.2
 [Full Changelog](https://github.com/netreconlab/Parse-Swift/compare/4.15.1...4.15.2), [Documentation](https://swiftpackageindex.com/netreconlab/Parse-Swift/4.15.2/documentation/parseswift)
 

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

@@ -128,10 +128,10 @@ score.save { result in
 
         /*:
          To modify, you need to make it a var as the value type
-         was initialized as immutable. Using `mergeable`
+         was initialized as immutable. Using `.mergeable`
          allows you to only send the updated keys to the
          parse server as opposed to the whole object. Make sure
-         to call `mergeable` before you begin
+         to call `.mergeable` before you begin
          your first mutation of your `ParseObject`.
         */
         var changedScore = savedScore.mergeable
@@ -221,10 +221,10 @@ assert(savedScore?.points == 10)
 
 /*:
  To modify, you need to make a mutable copy of `savedScore`.
- Instead of using `mergeable` this time, we will use the `set()`
+ Instead of using `.mergeable` this time, we will use the `set()`
  method which allows us to accomplish the same thing
- as `mergeable`. You can choose to use `set()` or
- `mergeable` as long as you use either before you begin
+ as `.mergeable`. You can choose to use `.set()` or
+ `.mergeable` as long as you use either before you begin
  your first mutation of your `ParseObject`.
 */
 guard var changedScore = savedScore else {

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

@@ -165,10 +165,6 @@ extension GameScore {
     init(points: Int) {
         self.points = points
     }
-
-    init(objectId: String?) {
-        self.objectId = objectId
-    }
 }
 
 //: Define a GameScore.

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

@@ -105,10 +105,6 @@ extension GameScore {
     init(points: Int) {
         self.points = points
     }
-
-    init(objectId: String?) {
-        self.objectId = objectId
-    }
 }
 
 //: Roles can provide additional access/security to your apps.

ParseSwift.playground/Pages/13 - Operations.xcplaygroundpage/Contents.swift

@@ -50,10 +50,6 @@ extension GameScore {
     init(points: Int) {
         self.points = points
     }
-
-    init(objectId: String?) {
-        self.objectId = objectId
-    }
 }
 
 //: You can have the server do operations on your `ParseObject`'s for you.

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

@@ -56,10 +56,6 @@ extension GameScore {
         self.objectId = objectId
         self.points = points
     }
-
-    init(objectId: String) {
-        self.objectId = objectId
-    }
 }
 
 //: Define initial GameScore this time with custom `objectId`.

ParseSwift.playground/Pages/20 - Cloud Schemas.xcplaygroundpage/Contents.swift

@@ -92,21 +92,6 @@ struct GameScore2: ParseObject {
     }
 }
 
-/*:
- It's recommended to place custom initializers in an extension
- to preserve the memberwise initializer.
- */
-extension GameScore2 {
-
-    init(points: Int) {
-        self.points = points
-    }
-
-    init(objectId: String?) {
-        self.objectId = objectId
-    }
-}
-
 //: First lets create a new CLP for the new schema.
 let clp = ParseCLP(requiresAuthentication: true, publicAccess: false)
     .setAccessPublic(true, on: .get)

ParseSwift.playground/Pages/23 - Cloud Hook Triggers.xcplaygroundpage/Contents.swift

@@ -39,19 +39,6 @@ struct GameScore: ParseObject {
     }
 }
 
-//: It's recommended to place custom initializers in an extension
-//: to preserve the memberwise initializer.
-extension GameScore {
-
-    init(points: Int) {
-        self.points = points
-    }
-
-    init(objectId: String?) {
-        self.objectId = objectId
-    }
-}
-
 /*:
  Parse Hook Triggers can be created by conforming to
  `ParseHookFunctionable`.