feat: Add Set operation to allow for single key updates

CHANGELOG.md

@@ -1,9 +1,15 @@
 # Parse-Swift Changelog
 
 ### main
-[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/1.10.4...main)
+[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/1.11.0...main)
 * _Contributing to this repo? Add info about your change here to be included in the next release_
 
+### 1.11.0
+[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/1.10.4...1.11.0)
+
+__Improvements__
+- Added `operation` for `set` and `forceSet`, used for single key updates ([#248](https://github.com/parse-community/Parse-Swift/pull/248)), thanks to [Daniel Blyth](https://github.com/dblythy) and [Corey Baker](https://github.com/cbaker6).
+
 ### 1.10.4
 [Full Changelog](https://github.com/parse-community/Parse-Swift/compare/1.10.3...1.10.4)
 

Sources/ParseSwift/Operations/ParseOperation.swift

@@ -25,11 +25,53 @@ public struct ParseOperation<T>: Savable where T: ParseObject {
         self.target = target
     }
 
+    /**
+     An operation that sets a field's value if it has changed from its previous value.
+     - Parameters:
+        - key: A tuple consisting of the key and the respective KeyPath of the object.
+        - value: The value to set it to.
+        - returns: The updated operations.
+     */
+    public func set<W>(_ key: (String, WritableKeyPath<T, W>),
+                       value: W) throws -> Self where W: Encodable {
+        var mutableOperation = self
+        guard let target = self.target else {
+            throw ParseError(code: .unknownError, message: "Target shouldn't be nil")
+        }
+        if let currentValue = target[keyPath: key.1] as? NSObject,
+           let updatedValue = value as? NSObject {
+           if currentValue != updatedValue {
+               mutableOperation.operations[key.0] = value
+               mutableOperation.target?[keyPath: key.1] = value
+           }
+        } else {
+            mutableOperation.operations[key.0] = value
+            mutableOperation.target?[keyPath: key.1] = value
+        }
+        return mutableOperation
+    }
+
+    /**
+     An operation that force sets a field's value.
+     - Parameters:
+        - key: A tuple consisting of the key and the respective KeyPath of the object.
+        - value: The value to set it to.
+        - returns: The updated operations.
+     */
+    public func forceSet<W>(_ key: (String, WritableKeyPath<T, W>),
+                            value: W) throws -> Self where W: Encodable {
+        var mutableOperation = self
+        mutableOperation.operations[key.0] = value
+        mutableOperation.target?[keyPath: key.1] = value
+        return mutableOperation
+    }
+
     /**
      An operation that increases a numeric field's value by a given amount.
      - Parameters:
         - key: The key of the object.
         - amount: How much to increment by.
+        - returns: The updated operations.
      */
     public func increment(_ key: String, by amount: Int) -> Self {
         var mutableOperation = self
@@ -43,6 +85,7 @@ public struct ParseOperation<T>: Savable where T: ParseObject {
      - Parameters:
         - key: The key of the object.
         - objects: The field of objects.
+        - returns: The updated operations.
      */
     public func addUnique<W>(_ key: String, objects: [W]) -> Self where W: Encodable, W: Hashable {
         var mutableOperation = self
@@ -54,8 +97,9 @@ public struct ParseOperation<T>: Savable where T: ParseObject {
      An operation that adds a new element to an array field,
      only if it wasn't already present.
      - Parameters:
-        - key: A tuple consisting of the key and KeyPath of the object.
+        - key: A tuple consisting of the key and the respective KeyPath of the object.
         - objects: The field of objects.
+        - returns: The updated operations.
      */
     public func addUnique<V>(_ key: (String, WritableKeyPath<T, [V]>),
                              objects: [V]) throws -> Self where V: Encodable, V: Hashable {
@@ -74,8 +118,9 @@ public struct ParseOperation<T>: Savable where T: ParseObject {
      An operation that adds a new element to an array field,
      only if it wasn't already present.
      - Parameters:
-        - key: A tuple consisting of the key and KeyPath of the object.
+        - key: A tuple consisting of the key and the respective KeyPath of the object.
         - objects: The field of objects.
+        - returns: The updated operations.
      */
     public func addUnique<V>(_ key: (String, WritableKeyPath<T, [V]?>),
                              objects: [V]) throws -> Self where V: Encodable, V: Hashable {
@@ -95,6 +140,7 @@ public struct ParseOperation<T>: Savable where T: ParseObject {
      - Parameters:
         - key: The key of the object.
         - objects: The field of objects.
+        - returns: The updated operations.
      */
     public func add<W>(_ key: String, objects: [W]) -> Self where W: Encodable {
         var mutableOperation = self
@@ -105,8 +151,9 @@ public struct ParseOperation<T>: Savable where T: ParseObject {
     /**
      An operation that adds a new element to an array field.
      - Parameters:
-        - key: A tuple consisting of the key and KeyPath of the object.
+        - key: A tuple consisting of the key and the respective KeyPath of the object.
         - objects: The field of objects.
+        - returns: The updated operations.
      */
     public func add<V>(_ key: (String, WritableKeyPath<T, [V]>),
                        objects: [V]) throws -> Self where V: Encodable {
@@ -124,8 +171,9 @@ public struct ParseOperation<T>: Savable where T: ParseObject {
     /**
      An operation that adds a new element to an array field.
      - Parameters:
-        - key: A tuple consisting of the key and KeyPath of the object.
+        - key: A tuple consisting of the key and the respective KeyPath of the object.
         - objects: The field of objects.
+        - returns: The updated operations.
      */
     public func add<V>(_ key: (String, WritableKeyPath<T, [V]?>),
                        objects: [V]) throws -> Self where V: Encodable {
@@ -145,6 +193,7 @@ public struct ParseOperation<T>: Savable where T: ParseObject {
      - Parameters:
         - key: The key of the object.
         - objects: The field of objects.
+        - returns: The updated operations.
      */
     public func addRelation<W>(_ key: String, objects: [W]) throws -> Self where W: ParseObject {
         var mutableOperation = self
@@ -155,8 +204,9 @@ public struct ParseOperation<T>: Savable where T: ParseObject {
     /**
      An operation that adds a new relation to an array field.
      - Parameters:
-        - key: A tuple consisting of the key and KeyPath of the object.
+        - key: A tuple consisting of the key and the respective KeyPath of the object.
         - objects: The field of objects.
+        - returns: The updated operations.
      */
     public func addRelation<V>(_ key: (String, WritableKeyPath<T, [V]>),
                                objects: [V]) throws -> Self where V: ParseObject {
@@ -174,8 +224,9 @@ public struct ParseOperation<T>: Savable where T: ParseObject {
     /**
      An operation that adds a new relation to an array field.
      - Parameters:
-        - key: A tuple consisting of the key and KeyPath of the object.
+        - key: A tuple consisting of the key and the respective KeyPath of the object.
         - objects: The field of objects.
+        - returns: The updated operations.
      */
     public func addRelation<V>(_ key: (String, WritableKeyPath<T, [V]?>),
                                objects: [V]) throws -> Self where V: ParseObject {
@@ -196,6 +247,7 @@ public struct ParseOperation<T>: Savable where T: ParseObject {
      - Parameters:
         - key: The key of the object.
         - objects: The field of objects.
+        - returns: The updated operations.
      */
     public func remove<W>(_ key: String, objects: [W]) -> Self where W: Encodable {
         var mutableOperation = self
@@ -207,8 +259,9 @@ public struct ParseOperation<T>: Savable where T: ParseObject {
      An operation that removes every instance of an element from
      an array field.
      - Parameters:
-        - key: A tuple consisting of the key and KeyPath of the object.
+        - key: A tuple consisting of the key and the respective KeyPath of the object.
         - objects: The field of objects.
+        - returns: The updated operations.
      */
     public func remove<V>(_ key: (String, WritableKeyPath<T, [V]>),
                           objects: [V]) throws -> Self where V: Encodable, V: Hashable {
@@ -230,8 +283,9 @@ public struct ParseOperation<T>: Savable where T: ParseObject {
      An operation that removes every instance of an element from
      an array field.
      - Parameters:
-        - key: A tuple consisting of the key and KeyPath of the object.
+        - key: A tuple consisting of the key and the respective KeyPath of the object.
         - objects: The field of objects.
+        - returns: The updated operations.
      */
     public func remove<V>(_ key: (String, WritableKeyPath<T, [V]?>),
                           objects: [V]) throws -> Self where V: Encodable, V: Hashable {
@@ -255,6 +309,7 @@ public struct ParseOperation<T>: Savable where T: ParseObject {
      - Parameters:
         - key: The key of the object.
         - objects: The field of objects.
+        - returns: The updated operations.
      */
     public func removeRelation<W>(_ key: String, objects: [W]) throws -> Self where W: ParseObject {
         var mutableOperation = self
@@ -266,8 +321,9 @@ public struct ParseOperation<T>: Savable where T: ParseObject {
      An operation that removes every instance of a relation from
      an array field.
      - Parameters:
-        - key: A tuple consisting of the key and KeyPath of the object.
+        - key: A tuple consisting of the key and the respective KeyPath of the object.
         - objects: The field of objects.
+        - returns: The updated operations.
      */
     public func removeRelation<V>(_ key: (String, WritableKeyPath<T, [V]>),
                                   objects: [V]) throws -> Self where V: ParseObject {
@@ -289,8 +345,9 @@ public struct ParseOperation<T>: Savable where T: ParseObject {
      An operation that removes every instance of a relation from
      an array field.
      - Parameters:
-        - key: A tuple consisting of the key and KeyPath of the object.
+        - key: A tuple consisting of the key and the respective KeyPath of the object.
         - objects: The field of objects.
+        - returns: The updated operations.
      */
     public func removeRelation<V>(_ key: (String, WritableKeyPath<T, [V]?>),
                                   objects: [V]) throws -> Self where V: ParseObject {
@@ -311,6 +368,7 @@ public struct ParseOperation<T>: Savable where T: ParseObject {
     /**
      An operation where a field is deleted from the object.
      - parameter key: The key of the object.
+     - returns: The updated operations.
      */
     public func unset(_ key: String) -> Self {
         var mutableOperation = self
@@ -321,7 +379,8 @@ public struct ParseOperation<T>: Savable where T: ParseObject {
     /**
      An operation where a field is deleted from the object.
      - Parameters:
-        - key: A tuple consisting of the key and KeyPath of the object.
+        - key: A tuple consisting of the key and the respective KeyPath of the object.
+        - returns: The updated operations.
      */
     public func unset<V>(_ key: (String, WritableKeyPath<T, V?>)) -> Self where V: Encodable {
         var mutableOperation = self

Sources/ParseSwift/ParseConstants.swift

@@ -10,7 +10,7 @@ import Foundation
 
 enum ParseConstants {
     static let sdk = "swift"
-    static let version = "1.10.4"
+    static let version = "1.11.0"
     static let fileManagementDirectory = "parse/"
     static let fileManagementPrivateDocumentsDirectory = "Private Documents/"
     static let fileManagementLibraryDirectory = "Library/"