Support restrictHighlightAndSnippetArrays search parameter

Author: spinach

Source/Query.swift

@@ -475,6 +475,13 @@ open class Query : AbstractQuery {
         set { self["snippetEllipsisText"] = newValue }
     }
 
+    /// Restrict arrays in highlight and snippet results to items that matched the query. (defaults to `false`).
+    /// When `false`, all array items are highlighted/snippeted. When `true`, only array items that matched at least partially are highlighted/snippeted.
+    public var restrictHighlightAndSnippetArrays: Bool? {
+        get { return Query.parseBool(self["restrictHighlightAndSnippetArrays"]) }
+        set { self["restrictHighlightAndSnippetArrays"] = Query.buildBool(newValue) }
+    }
+    
     // MARK: Numeric search parameters
 
     /// Filter on numeric attributes.
@@ -962,6 +969,12 @@ open class Query : AbstractQuery {
         get { return AbstractQuery.toNumber(self.getRankingInfo) }
         set { self.getRankingInfo = newValue?.boolValue }
     }
+    
+    @objc(restrictHighlightAndSnippetArrays)
+    public var z_objc_restrictHighlightAndSnippetArrays: NSNumber? {
+        get { return AbstractQuery.toNumber(self.restrictHighlightAndSnippetArrays) }
+        set { self.restrictHighlightAndSnippetArrays = newValue?.boolValue }
+    }
 
     @objc(distinct)
     public var z_objc_distinct: NSNumber? {

Tests/ObjectiveCBridging.m

@@ -103,6 +103,7 @@ - (void)testQuery {
     query.highlightPreTag = @"<mark>";
     query.highlightPostTag = @"</mark>";
     query.snippetEllipsisText = @"...";
+    query.restrictHighlightAndSnippetArrays = false;
     query.numericFilters = @[ @"foo > 0", @"baz < 1000" ];
     query.tagFilters = @[ @"foo", @"bar" ];
     query.distinct = [NSNumber numberWithInt:6];
@@ -524,6 +525,17 @@ - (void)test_getRankingInfo {
     XCTAssertEqualObjects(query2.getRankingInfo, value);
 }
 
+- (void)test_restrictHighlightAndSnippetArrays {
+    Query* query1 = [Query new];
+    XCTAssertNil(query1.restrictHighlightAndSnippetArrays);
+    
+    NSNumber* value = [NSNumber numberWithBool:FALSE];
+    query1.restrictHighlightAndSnippetArrays = value;
+    XCTAssertEqualObjects(query1[@"restrictHighlightAndSnippetArrays"], @"false");
+    Query* query2 = [Query parse:[query1 build]];
+    XCTAssertEqualObjects(query2.restrictHighlightAndSnippetArrays, value);
+}
+
 - (void)test_distinct {
     Query* query1 = [Query new];
     XCTAssertNil(query1.distinct);

Tests/QueryTests.swift

@@ -435,6 +435,16 @@ class QueryTests: XCTestCase {
         XCTAssertEqual(query2.snippetEllipsisText, "…")
     }
 
+    func test_restrictHighlightAndSnippetArrays() {
+        let query1 = Query()
+        XCTAssertNil(query1.restrictHighlightAndSnippetArrays)
+        query1.restrictHighlightAndSnippetArrays = false
+        XCTAssertEqual(query1.restrictHighlightAndSnippetArrays, false)
+        XCTAssertEqual(query1["restrictHighlightAndSnippetArrays"], "false")
+        let query2 = Query.parse(query1.build())
+        XCTAssertEqual(query2.restrictHighlightAndSnippetArrays, false)
+    }
+    
     func test_analyticsTags() {
         let query1 = Query()
         XCTAssertNil(query1.analyticsTags)