full inline sourcecode documentation

HardcoreData/Fetching and Querying/Concrete Clauses/Tweak.swift

@@ -0,0 +1,69 @@
+//
+//  Tweak.swift
+//  HardcoreData
+//
+//  Copyright (c) 2015 John Rommel Estropia
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in all
+//  copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+//  SOFTWARE.
+//
+
+import Foundation
+import CoreData
+
+
+// MARK: - Tweak
+
+/**
+The `Tweak` clause allows fine-tuning the `NSFetchRequest` for a fetch or query.
+
+Sample usage:
+
+    let employees = transaction.fetchAll(
+        From(MyPersonEntity),
+        Tweak { (fetchRequest) -> Void in
+            fetchRequest.includesPendingChanges = false
+            fetchRequest.fetchLimit = 5
+        }
+    )
+*/
+public struct Tweak: FetchClause, QueryClause, DeleteClause {
+    
+    // MARK: Public
+    
+    /**
+    Initializes a `Tweak` clause with a closure where the `NSFetchRequest` may be configured.
+    
+    :param: customization a list of key path strings to group results with
+    */
+    public init(_ customization: (fetchRequest: NSFetchRequest) -> Void) {
+        
+        self.customization = customization
+    }
+    
+    
+    // MARK: FetchClause, QueryClause, DeleteClause
+    
+    public func applyToFetchRequest(fetchRequest: NSFetchRequest) {
+        
+        self.customization(fetchRequest: fetchRequest)
+    }
+    
+    
+    private let customization: (fetchRequest: NSFetchRequest) -> Void
+}