Merge pull request #644 from algolia/feat/new-partial-update-operations

Add IncrementSet and IncrementFrom as partial update operations.

Author: VladislavFitz

Sources/AlgoliaSearchClient/Models/Search/Indexing/PartialUpdate.swift

@@ -16,22 +16,34 @@ public struct PartialUpdate: Equatable {
 
 public extension PartialUpdate {
 
+  /// Partially update an object field.
+  /// - Parameter attribute: Attribute name to update
+  /// - Parameter value: Updated value
   static func update(attribute: Attribute, value: JSON) -> Self {
     .init(attribute: attribute, content: .init(value: value, operation: nil))
   }
 
 }
 
 public extension PartialUpdate {
-
+  
+  /// Increment a numeric attribute
+  /// - Parameter attribute: Attribute name to update
+  /// - Parameter value: Value to increment by
   static func increment(attribute: Attribute, value: Int) -> Self {
     .operation(attribute: attribute, operation: .increment, value: .init(value))
   }
 
+  /// Increment a numeric attribute
+  /// - Parameter attribute: Attribute name to update
+  /// - Parameter value: Value to increment by
   static func increment(attribute: Attribute, value: Float) -> Self {
     .operation(attribute: attribute, operation: .increment, value: .init(value))
   }
 
+  /// Increment a numeric attribute
+  /// - Parameter attribute: Attribute name to update
+  /// - Parameter value: Value to increment by
   static func increment(attribute: Attribute, value: Double) -> Self {
     .operation(attribute: attribute, operation: .increment, value: .init(value))
   }
@@ -40,14 +52,58 @@ public extension PartialUpdate {
 
 public extension PartialUpdate {
 
+  /**
+   Increment a numeric integer attribute only if the provided value matches the current value,
+   and otherwise ignore the whole object update.
+   
+   For example, if you pass an IncrementFrom value of 2 for the version attribute,
+   but the current value of the attribute is 1, the engine ignores the update.
+   If the object doesn’t exist, the engine only creates it if you pass an IncrementFrom value of 0.
+   
+   - Parameter attribute: Attribute name to update
+   - Parameter value: Current value to increment
+   */
+  static func incrementFrom(attribute: Attribute, value: Int) -> Self {
+    .operation(attribute: attribute, operation: .incrementFrom, value: .init(value))
+  }
+  
+  /**
+   Increment a numeric integer attribute only if the provided value is greater than the current value,
+   and otherwise ignore the whole object update.
+   
+   For example, if you pass an IncrementSet value of 2 for the version attribute,
+   and the current value of the attribute is 1, the engine updates the object.
+   If the object doesn’t exist yet, the engine only creates it if you pass an IncrementSet value that’s greater than 0.
+   
+   - Parameter attribute: Attribute name to update
+   - Parameter value: Value to set
+   */
+  static func incrementSet(attribute: Attribute, value: Int) -> Self {
+    .operation(attribute: attribute, operation: .incrementSet, value: .init(value))
+  }
+
+}
+
+
+public extension PartialUpdate {
+
+  /// Decrement a numeric attribute
+  /// - Parameter attribute: Attribute name to update
+  /// - Parameter value: Value to decrement by
   static func decrement(attribute: Attribute, value: Int) -> Self {
     .operation(attribute: attribute, operation: .decrement, value: .init(value))
   }
-
+  
+  /// Decrement a numeric attribute
+  /// - Parameter attribute: Attribute name to update
+  /// - Parameter value: Value to decrement by
   static func decrement(attribute: Attribute, value: Float) -> Self {
     .operation(attribute: attribute, operation: .decrement, value: .init(value))
   }
 
+  /// Decrement a numeric attribute
+  /// - Parameter attribute: Attribute name to update
+  /// - Parameter value: Value to decrement by
   static func decrement(attribute: Attribute, value: Double) -> Self {
     .operation(attribute: attribute, operation: .decrement, value: .init(value))
   }
@@ -56,18 +112,34 @@ public extension PartialUpdate {
 
 public extension PartialUpdate {
 
+  /// Append a string element to an array attribute
+  /// - Parameter attribute: Attribute name of an array to update
+  /// - Parameter value: Value to append
+  /// - Parameter unique: If true, append an element only if it’s not already present
   static func add(attribute: Attribute, value: String, unique: Bool) -> Self {
     .operation(attribute: attribute, operation: unique ? .addUnique : .add, value: .init(value))
   }
 
+  /// Append a number element to an array attribute
+  /// - Parameter attribute: Attribute name of an array to update
+  /// - Parameter value: Value to append
+  /// - Parameter unique: If true, append an element only if it’s not already present
   static func add(attribute: Attribute, value: Int, unique: Bool) -> Self {
     .operation(attribute: attribute, operation: unique ? .addUnique : .add, value: .init(value))
   }
 
+  /// Append a number element to an array attribute
+  /// - Parameter attribute: Attribute name of an array to update
+  /// - Parameter value: Value to append
+  /// - Parameter unique: If true, append an element only if it’s not already present
   static func add(attribute: Attribute, value: Float, unique: Bool) -> Self {
     .operation(attribute: attribute, operation: unique ? .addUnique : .add, value: .init(value))
   }
 
+  /// Append a number element to an array attribute
+  /// - Parameter attribute: Attribute name of an array to update
+  /// - Parameter value: Value to append
+  /// - Parameter unique: If true, append an element only if it’s not already present
   static func add(attribute: Attribute, value: Double, unique: Bool) -> Self {
     .operation(attribute: attribute, operation: unique ? .addUnique : .add, value: .init(value))
   }
@@ -76,18 +148,30 @@ public extension PartialUpdate {
 
 public extension PartialUpdate {
 
+  /// Remove all matching string elements from an array attribute
+  /// - Parameter attribute: Attribute name of an array to update
+  /// - Parameter value: Value to remove
   static func remove(attribute: Attribute, value: String) -> Self {
     .operation(attribute: attribute, operation: .remove, value: .init(value))
   }
 
+  /// Remove all matching number elements from an array attribute
+  /// - Parameter attribute: Attribute name of an array to update
+  /// - Parameter value: Value to remove
   static func remove(attribute: Attribute, value: Int) -> Self {
     .operation(attribute: attribute, operation: .remove, value: .init(value))
   }
 
+  /// Remove all matching number elements from an array attribute
+  /// - Parameter attribute: Attribute name of an array to update
+  /// - Parameter value: Value to remove
   static func remove(attribute: Attribute, value: Float) -> Self {
     .operation(attribute: attribute, operation: .remove, value: .init(value))
   }
 
+  /// Remove all matching number elements from an array attribute
+  /// - Parameter attribute: Attribute name of an array to update
+  /// - Parameter value: Value to remove
   static func remove(attribute: Attribute, value: Double) -> Self {
     .operation(attribute: attribute, operation: .remove, value: .init(value))
   }
@@ -122,10 +206,39 @@ extension PartialUpdate: Codable {
 extension PartialUpdate {
 
   enum Operation: String, Codable {
+    /// Increment a numeric attribute
     case increment = "Increment"
+    
+    /**
+     Increment a numeric integer attribute only if the provided value matches the current value,
+     and otherwise ignore the whole object update.
+     
+     For example, if you pass an IncrementFrom value of 2 for the version attribute,
+     but the current value of the attribute is 1, the engine ignores the update.
+     If the object doesn’t exist, the engine only creates it if you pass an IncrementFrom value of 0.
+     */
+    case incrementFrom = "IncrementFrom"
+    
+    /**
+     Increment a numeric integer attribute only if the provided value is greater than the current value,
+     and otherwise ignore the whole object update.
+     
+     For example, if you pass an IncrementSet value of 2 for the version attribute,
+     and the current value of the attribute is 1, the engine updates the object.
+     If the object doesn’t exist yet, the engine only creates it if you pass an IncrementSet value that’s greater than 0.
+     */
+    case incrementSet = "IncrementSet"
+    
+    /// Decrement a numeric attribute
     case decrement = "Decrement"
+    
+    /// Append a number or string element to an array attribute
     case add = "Add"
+    
+    /// Remove all matching number or string elements from an array attribute
     case remove = "Remove"
+    
+    /// Add a number or string element to an array attribute only if it’s not already present
     case addUnique = "AddUnique"
   }
 

Tests/AlgoliaSearchClientTests/Unit/PartialUpdateTests.swift

@@ -12,6 +12,8 @@ class PartialUpdateTests: XCTestCase {
     try AssertEncodeDecode(PartialUpdate.remove(attribute: "attr", value: 2.5), ["attr": ["value": 2.5, "_operation": "Remove"]])
     try AssertEncodeDecode(PartialUpdate.remove(attribute: "attr", value: "stringValue"), ["attr": ["value": "stringValue", "_operation": "Remove"]])
     try AssertEncodeDecode(PartialUpdate.increment(attribute: "attr", value: 2.5), ["attr": ["value": 2.5, "_operation": "Increment"]])
+    try AssertEncodeDecode(PartialUpdate.incrementFrom(attribute: "attr", value: 2), ["attr": ["value": 2, "_operation": "IncrementFrom"]])
+    try AssertEncodeDecode(PartialUpdate.incrementSet(attribute: "attr", value: 2), ["attr": ["value": 2, "_operation": "IncrementSet"]])
     try AssertEncodeDecode(PartialUpdate.decrement(attribute: "attr", value: 2.5), ["attr": ["value": 2.5, "_operation": "Decrement"]])
     try AssertEncodeDecode(PartialUpdate.update(attribute: "attr", value: "string"), ["attr": "string"])
     try AssertEncodeDecode(PartialUpdate.update(attribute: "attr", value: 2.5), ["attr": 2.5])