Added NSPredicate to searchFiles method

- public functions became open, now is overridable
- fixed urlCache documentation

.travis.yml

@@ -77,4 +77,4 @@ deploy:
   on:
     repo: amosavian/$PROJECTNAME
     tags: true
-    comdition: "$CARTHAGEDEPLOY = YES"
+    condition: "$CARTHAGEDEPLOY = YES"

FileProvider.podspec

@@ -16,7 +16,7 @@ Pod::Spec.new do |s|
   #
 
   s.name         = "FileProvider"
-  s.version      = "0.12.8"
+  s.version      = "0.14.0"
   s.summary      = "FileManager replacement for Local and Remote (WebDAV/Dropbox/OneDrive/SMB2) files on iOS and macOS."
 
   # This description is used to generate tags and improve search results.

FileProvider.xcodeproj/project.pbxproj

@@ -597,7 +597,7 @@
 		799396601D48B7BF00086753 /* Debug */ = {
 			isa = XCBuildConfiguration;
 			buildSettings = {
-				BUNDLE_VERSION_STRING = 0.12.8;
+				BUNDLE_VERSION_STRING = 0.14.0;
 				CLANG_WARN_BOOL_CONVERSION = YES;
 				CLANG_WARN_CONSTANT_CONVERSION = YES;
 				CLANG_WARN_EMPTY_BODY = YES;
@@ -627,7 +627,7 @@
 		799396611D48B7BF00086753 /* Release */ = {
 			isa = XCBuildConfiguration;
 			buildSettings = {
-				BUNDLE_VERSION_STRING = 0.12.8;
+				BUNDLE_VERSION_STRING = 0.14.0;
 				CLANG_WARN_BOOL_CONVERSION = YES;
 				CLANG_WARN_CONSTANT_CONVERSION = YES;
 				CLANG_WARN_EMPTY_BODY = YES;

README.md

@@ -42,7 +42,7 @@ All functions are async calls and it wont block your main thread.
 
 ## Requirements
 
-- **Swift 3**
+- **Swift 3.0 +**
 - iOS 8.0 , OSX 10.10
 - XCode 8.0
 
@@ -93,7 +93,7 @@ Then you can do either:
 
 * Copy Source folder to your project and Voila!
 
-* Drop FileProvider.xcodeproj to you Xcode workspace and add the framework to your Embeded Binaries in target.
+* Drop `FileProvider.xcodeproj` to you Xcode workspace and add the framework to your Embeded Binaries in target.
 
 ## Usage
 
@@ -118,7 +118,7 @@ Also for using group shared container:
 
 ```swift
 let documentsProvider = LocalFileProvider(sharedContainerId: "group.yourcompany.appContainer")
-// Replace your group identifier with string above
+// Replace your group identifier
 ```
 
 You can't change the base url later. and all paths are related to this base url by default.
@@ -158,7 +158,7 @@ override func viewDidLoad() {
 	documentsProvider.delegate = self as FileProviderDelegate
 }
 	
-func fileproviderSucceed(_ fileProvider: FileProviderOperations, operation: FileOperation) {
+func fileproviderSucceed(_ fileProvider: FileProviderOperations, operation: FileOperationType) {
 	switch operation {
 	case .copy(source: let source, destination: let dest):
 		print("\(source) copied to \(dest).")
@@ -169,7 +169,7 @@ func fileproviderSucceed(_ fileProvider: FileProviderOperations, operation: File
 	}
 }
 
-func fileproviderFailed(_ fileProvider: FileProviderOperations, operation: FileOperation) {
+func fileproviderFailed(_ fileProvider: FileProviderOperations, operation: FileOperationType) {
     switch operation {
 	case .copy(source: let source, destination: let dest):
 		print("copy of \(source) failed.")
@@ -180,7 +180,7 @@ func fileproviderFailed(_ fileProvider: FileProviderOperations, operation: FileO
 	}
 }
 	
-func fileproviderProgress(_ fileProvider: FileProviderOperations, operation: FileOperation, progress: Float) {
+func fileproviderProgress(_ fileProvider: FileProviderOperations, operation: FileOperationType, progress: Float) {
 	switch operation {
 	case .copy(source: let source, destination: let dest):
 		print("Copy\(source) to \(dest): \(progress * 100) completed.")
@@ -439,6 +439,12 @@ if documentsProvider..propertiesOfFile(path: file.path, completionHandler: { (pr
 
 We would love for you to contribute to **FileProvider**, check the `LICENSE` file for more info.
 
+Things to do:
+
+- [ ] Implement Test-case (XCTest)
+- [ ] Add Sample project for iOS
+- [ ] Add Sample project for macOS
+
 ## Projects in use
 
 * [EDM - Browse and Receive Files](https://itunes.apple.com/us/app/edm-browse-and-receive-files/id948397575?ls=1&mt=8)

Sources/CloudFileProvider.swift

@@ -8,7 +8,15 @@
 
 import Foundation
 
+/**
+ Allows accessing to iCloud Drive stored files. Determine scope when initializing, to either access
+ to public documents folder or files stored as data.
+ 
+ To setup a functional iCloud container, please
+ [read this page](https://medium.com/ios-os-x-development/icloud-drive-documents-1a46b5706fe1).
+ */
 open class CloudFileProvider: LocalFileProvider {
+    /// An string to identify type of provider.
     open override class var type: String { return "iCloudDrive" }
     
     /// Forces file operations to use `NSFileCoordinating`,
@@ -79,7 +87,7 @@ open class CloudFileProvider: LocalFileProvider {
      If the directory contains no entries or an error is occured, this method will return the empty array.
      
      - Parameter path: path to target directory. If empty, `currentPath` value will be used.
-     - Parameter completionHandler: a block with result of directory entries or error.
+     - Parameter completionHandler: a closure with result of directory entries or error.
          `contents`: An array of `FileObject` identifying the the directory entries.
          `error`: Error returned by system.
      */
@@ -148,7 +156,7 @@ open class CloudFileProvider: LocalFileProvider {
      If the directory contains no entries or an error is occured, this method will return the empty `FileObject`.
      
      - Parameter path: path to target directory. If empty, `currentPath` value will be used.
-     - Parameter completionHandler: a block with result of directory entries or error.
+     - Parameter completionHandler: a closure with result of directory entries or error.
          `attributes`: A `FileObject` containing the attributes of the item.
          `error`: Error returned by system.
      */
@@ -197,6 +205,130 @@ open class CloudFileProvider: LocalFileProvider {
         }
     }
     
+    /**
+     Search files inside directory using query asynchronously.
+     
+     - Note: For now only it's limited to file names. `query` parameter may take `NSPredicate` format in near future.
+     
+     - Parameters:
+     - path: location of directory to start search
+     - recursive: Searching subdirectories of path
+     - query: Simple string of file name to be search (for now).
+     - foundItemHandler: Closure which is called when a file is found
+     - completionHandler: Closure which will be called after finishing search. Returns an arry of `FileObject` or error if occured.
+     */
+    open override func searchFiles(path: String, recursive: Bool, query: NSPredicate, foundItemHandler: ((FileObject) -> Void)?, completionHandler: @escaping ((_ files: [FileObject], _ error: Error?) -> Void)) {
+        
+        let mapDict: [String: String] = ["url": NSMetadataItemURLKey, "name": NSMetadataItemFSNameKey, "path": NSMetadataItemPathKey, "filesize": NSMetadataItemFSSizeKey, "modifiedDate": NSMetadataItemFSContentChangeDateKey, "creationDate": NSMetadataItemFSCreationDateKey, "contentType": NSMetadataItemContentTypeKey]
+        
+        func updateQueryKeys(_ queryComponent: NSPredicate) -> NSPredicate {
+            if let cQuery = queryComponent as? NSCompoundPredicate {
+                let newSub = cQuery.subpredicates.map { updateQueryKeys($0 as! NSPredicate) }
+                switch cQuery.compoundPredicateType {
+                case .and: return NSCompoundPredicate(andPredicateWithSubpredicates: newSub)
+                case .not: return NSCompoundPredicate(notPredicateWithSubpredicate: newSub[0])
+                case .or:  return NSCompoundPredicate(orPredicateWithSubpredicates: newSub)
+                }
+            } else if let cQuery = queryComponent as? NSComparisonPredicate {
+                var newLeft = cQuery.leftExpression
+                var newRight = cQuery.rightExpression
+                if newLeft.expressionType == .keyPath, let newKey = mapDict[newLeft.keyPath] {
+                    newLeft = NSExpression(forKeyPath: newKey)
+                }
+                if newRight.expressionType == .keyPath, let newKey = mapDict[newRight.keyPath] {
+                    newRight = NSExpression(forKeyPath: newKey)
+                }
+                if newLeft.expressionType == .keyPath, newLeft.keyPath == "type" {
+                    newRight = NSExpression(forConstantValue: newRight.constantValue as? String == "directory" ? "public.directory": "public.data")
+                }
+                if newRight.expressionType == .keyPath, newRight.keyPath == "type" {
+                    newLeft = NSExpression(forConstantValue: newLeft.constantValue as? String == "directory" ? "public.directory": "public.data")
+                }
+                return NSComparisonPredicate(leftExpression: newLeft, rightExpression: newRight, modifier: cQuery.comparisonPredicateModifier, type: cQuery.predicateOperatorType, options: cQuery.options)
+            } else {
+                return queryComponent
+            }
+        }
+        
+        dispatch_queue.async {
+            let pathURL = self.url(of: path)
+            let mdquery = NSMetadataQuery()
+            mdquery.predicate = NSPredicate(format: "(%K BEGINSWITH %@) && (\(updateQueryKeys(query).predicateFormat))", NSMetadataItemPathKey, pathURL.path)
+            mdquery.searchScopes = [self.scope.rawValue]
+            
+            var lastReportedCount = 0
+            
+            if let foundItemHandler = foundItemHandler {
+                var updateObserver: NSObjectProtocol?
+                
+                // FIXME: Remove this section as it won't work as expected on iCloud
+                updateObserver = NotificationCenter.default.addObserver(forName: .NSMetadataQueryGatheringProgress, object: mdquery, queue: nil, using: { (notification) in
+                    
+                    mdquery.disableUpdates()
+                    
+                    guard mdquery.resultCount > lastReportedCount else { return }
+                    
+                    for index in lastReportedCount..<mdquery.resultCount {
+                        guard let attribs = (mdquery.result(at: index) as? NSMetadataItem)?.values(forAttributes: [NSMetadataItemURLKey, NSMetadataItemFSNameKey, NSMetadataItemPathKey, NSMetadataItemFSSizeKey, NSMetadataItemContentTypeTreeKey, NSMetadataItemFSCreationDateKey, NSMetadataItemFSContentChangeDateKey]) else {
+                            continue
+                        }
+                        
+                        guard let url = (attribs[NSMetadataItemURLKey] as? URL)?.standardized, recursive || url.deletingLastPathComponent().path.trimmingCharacters(in: pathTrimSet) == pathURL.path.trimmingCharacters(in: pathTrimSet) else {
+                            continue
+                        }
+                        
+                        if let file = self.mapFileObject(attributes: attribs) {
+                            foundItemHandler(file)
+                        }
+                    }
+                    lastReportedCount = mdquery.resultCount
+                    
+                    mdquery.enableUpdates()
+                })
+            }
+            
+            var finishObserver: NSObjectProtocol?
+            finishObserver = NotificationCenter.default.addObserver(forName: .NSMetadataQueryDidFinishGathering, object: mdquery, queue: nil, using: { (notification) in
+                defer {
+                    mdquery.stop()
+                    NotificationCenter.default.removeObserver(finishObserver!)
+                }
+                
+                guard let results = mdquery.results as? [NSMetadataItem] else {
+                    return
+                }
+                
+                mdquery.disableUpdates()
+                
+                var contents = [FileObject]()
+                for result in results {
+                    guard let attribs = result.values(forAttributes: [NSMetadataItemURLKey, NSMetadataItemFSNameKey, NSMetadataItemPathKey, NSMetadataItemFSSizeKey, NSMetadataItemContentTypeTreeKey, NSMetadataItemFSCreationDateKey, NSMetadataItemFSContentChangeDateKey]) else {
+                        continue
+                    }
+                    
+                    guard let url = (attribs[NSMetadataItemURLKey] as? URL)?.standardized, recursive || url.deletingLastPathComponent().path.trimmingCharacters(in: pathTrimSet) == pathURL.path.trimmingCharacters(in: pathTrimSet) else {
+                        continue
+                    }
+                    
+                    if let file = self.mapFileObject(attributes: attribs) {
+                        contents.append(file)
+                    }
+                }
+                self.dispatch_queue.async {
+                    completionHandler(contents, nil)
+                }
+            })
+            
+            DispatchQueue.main.async {
+                if !mdquery.start() {
+                    self.dispatch_queue.async {
+                        completionHandler([], self.throwError(path, code: CocoaError.fileReadNoPermission))
+                    }
+                }
+            }
+        }
+    }
+    
     open override func isReachable(completionHandler: @escaping (Bool) -> Void) {
         dispatch_queue.async {
             completionHandler(self.fileManager.ubiquityIdentityToken != nil)
@@ -370,7 +502,7 @@ open class CloudFileProvider: LocalFileProvider {
      
      - Parameters:
        - path: Path of file.
-       - completionHandler: a block with result of file contents or error.
+       - completionHandler: a closure with result of file contents or error.
          `contents`: contents of file in a `Data` object.
          `error`: Error returned by system.
      - Returns: An `OperationHandle` to get progress or cancel progress.
@@ -389,7 +521,7 @@ open class CloudFileProvider: LocalFileProvider {
        - path: Path of file.
        - offset: First byte index which should be read. **Starts from 0.**
        - length: Bytes count of data. Pass `-1` to read until the end of file.
-       - completionHandler: a block with result of file contents or error.
+       - completionHandler: a closure with result of file contents or error.
          `contents`: contents of file in a `Data` object.
          `error`: Error returned by system.
      - Returns: An `OperationHandle` to get progress or cancel progress.
@@ -417,98 +549,6 @@ open class CloudFileProvider: LocalFileProvider {
         return CloudOperationHandle(operationType: r.operationType, baseURL: self.baseURL)
     }
     
-    /**
-     Search files inside directory using query asynchronously.
-     
-     - Note: For now only it's limited to file names. `query` parameter may take `NSPredicate` format in near future.
-     
-     - Parameters:
-       - path: location of directory to start search
-       - recursive: Searching subdirectories of path
-       - query: Simple string of file name to be search (for now).
-       - foundItemHandler: Block which is called when a file is found
-     - completionHandler: Block which will be called after finishing search. Returns an arry of `FileObject` or error if occured.
-     */
-    open override func searchFiles(path: String, recursive: Bool, query: String, foundItemHandler: ((FileObject) -> Void)?, completionHandler: @escaping ((_ files: [FileObject], _ error: Error?) -> Void)) {
-        dispatch_queue.async {
-            let pathURL = self.url(of: path)
-            let query = NSMetadataQuery()
-            query.predicate = NSPredicate(format: "(%K BEGINSWITH %@) && (%K LIKE %@)", NSMetadataItemPathKey, pathURL.path, NSMetadataItemFSNameKey, query)
-            query.searchScopes = [self.scope.rawValue]
-            
-            var lastReportedCount = 0
-            
-            if let foundItemHandler = foundItemHandler {
-                var updateObserver: NSObjectProtocol?
-                
-                // FIXME: Remove this section as it won't work as expected on iCloud
-                updateObserver = NotificationCenter.default.addObserver(forName: .NSMetadataQueryGatheringProgress, object: query, queue: nil, using: { (notification) in
-                    
-                    query.disableUpdates()
-                    
-                    guard query.resultCount > lastReportedCount else { return }
-                    
-                    for index in lastReportedCount..<query.resultCount {
-                        guard let attribs = (query.result(at: index) as? NSMetadataItem)?.values(forAttributes: [NSMetadataItemURLKey, NSMetadataItemFSNameKey, NSMetadataItemPathKey, NSMetadataItemFSSizeKey, NSMetadataItemContentTypeTreeKey, NSMetadataItemFSCreationDateKey, NSMetadataItemFSContentChangeDateKey]) else {
-                            continue
-                        }
-                        
-                        guard let url = (attribs[NSMetadataItemURLKey] as? URL)?.standardized, recursive || url.deletingLastPathComponent().path.trimmingCharacters(in: pathTrimSet) == pathURL.path.trimmingCharacters(in: pathTrimSet) else {
-                            continue
-                        }
-                        
-                        if let file = self.mapFileObject(attributes: attribs) {
-                            foundItemHandler(file)
-                        }
-                    }
-                    lastReportedCount = query.resultCount
-                    
-                    query.enableUpdates()
-                })
-            }
-            
-            var finishObserver: NSObjectProtocol?
-            finishObserver = NotificationCenter.default.addObserver(forName: .NSMetadataQueryDidFinishGathering, object: query, queue: nil, using: { (notification) in
-                defer {
-                    query.stop()
-                    NotificationCenter.default.removeObserver(finishObserver!)
-                }
-                
-                guard let results = query.results as? [NSMetadataItem] else {
-                    return
-                }
-                
-                query.disableUpdates()
-                
-                var contents = [FileObject]()
-                for result in results {
-                    guard let attribs = result.values(forAttributes: [NSMetadataItemURLKey, NSMetadataItemFSNameKey, NSMetadataItemPathKey, NSMetadataItemFSSizeKey, NSMetadataItemContentTypeTreeKey, NSMetadataItemFSCreationDateKey, NSMetadataItemFSContentChangeDateKey]) else {
-                        continue
-                    }
-                    
-                    guard let url = (attribs[NSMetadataItemURLKey] as? URL)?.standardized, recursive || url.deletingLastPathComponent().path.trimmingCharacters(in: pathTrimSet) == pathURL.path.trimmingCharacters(in: pathTrimSet) else {
-                        continue
-                    }
-                    
-                    if let file = self.mapFileObject(attributes: attribs) {
-                        contents.append(file)
-                    }
-                }
-                self.dispatch_queue.async {
-                   completionHandler(contents, nil)
-                }
-            })
-            
-            DispatchQueue.main.async {
-                if !query.start() {
-                    self.dispatch_queue.async {
-                        completionHandler([], self.throwError(path, code: CocoaError.fileReadNoPermission))
-                    }
-                }
-            }
-        }
-    }
-    
     fileprivate var monitors = [String: (NSMetadataQuery, NSObjectProtocol)]()
     
     /**
@@ -524,7 +564,7 @@ open class CloudFileProvider: LocalFileProvider {
      
      - Parameters:
        - path: path of directory.
-       - eventHandler: Block executed after change, on a secondary thread.
+       - eventHandler: Closure executed after change, on a secondary thread.
      */
     open override func registerNotifcation(path: String, eventHandler: @escaping (() -> Void)) {
         self.unregisterNotifcation(path: path)
@@ -614,7 +654,19 @@ open class CloudFileProvider: LocalFileProvider {
         }
     }
     
-    /// Returns a pulic url with expiration date, can be shared with other people.
+    /**
+     Genrates a public url to a file to be shared with other users and can be downloaded without authentication.
+     
+     - Important: URL will be available for a limitied time, determined in `expiration` argument.
+     
+     - Parameters:
+     - to: path of file, including file/directory name.
+     - completionHandler: a closure with result of directory entries or error.
+     `link`: a url returned by Dropbox to share.
+     `attribute`: a `FileObject` containing the attributes of the item.
+     `expiration`: a `Date` object, determines when the public url will expires.
+     `error`: Error returned by Dropbox.
+     */
     open func publicLink(to path: String, completionHandler: @escaping ((_ link: URL?, _ attribute: FileObject?, _ expiration: Date?, _ error: Error?) -> Void)) {
         operation_queue.addOperation {
             do {

Sources/DropboxFileProvider.swift

@@ -10,6 +10,12 @@
 import Foundation
 import CoreGraphics
 
+/**
+ Allows accessing to Dropbox stored files. This provider doesn't cache or save files internally, however you can
+ set `useCache` and `cache` properties to use Foundation `NSURLCache` system.
+ 
+ - Note: Uploading files and data are limited to 150MB, for now.
+ */
 open class DropboxFileProvider: FileProviderBasicRemote {
     open class var type: String { return "DropBox" }
     open let isPathRelative: Bool
@@ -55,7 +61,7 @@ open class DropboxFileProvider: FileProviderBasicRemote {
      The latter is easier to use and prefered. Also you can use [auth0/Lock](https://github.com/auth0/Lock.iOS-OSX) which provides graphical user interface.
      
      - Parameter credential: a `URLCredential` object with Client ID set as `user` and Token set as `password`.
-     - Parameter cache: A URLCache to cache downloaded files and contents. If set to nil, URLCache.shared object will be used.
+     - Parameter cache: A URLCache to cache downloaded files and contents.
     */
     public init(credential: URLCredential?, cache: URLCache? = nil) {
         self.baseURL = nil
@@ -129,6 +135,19 @@ open class DropboxFileProvider: FileProviderBasicRemote {
         task.resume()
     }
     
+    open func searchFiles(path: String, recursive: Bool, query: NSPredicate, foundItemHandler: ((FileObject) -> Void)?, completionHandler: @escaping ((_ files: [FileObject], _ error: Error?) -> Void)) {
+        var foundFiles = [DropboxFileObject]()
+        guard let queryStr = self.findNameQuery(query, key: "name") as? String else { return }
+        search(path, query: queryStr, foundItem: { (file) in
+            if query.evaluate(with: file.mapPredicate()) {
+                foundFiles.append(file)
+                foundItemHandler?(file)
+            }
+        }, completionHandler: { (error) in
+            completionHandler(foundFiles, error)
+        })
+    }
+    
     open func isReachable(completionHandler: @escaping (Bool) -> Void) {
         self.storageProperties { total, _ in
             completionHandler(total > 0)
@@ -139,25 +158,25 @@ open class DropboxFileProvider: FileProviderBasicRemote {
 }
 
 extension DropboxFileProvider: FileProviderOperations {
-    public func create(folder folderName: String, at atPath: String, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
+    open func create(folder folderName: String, at atPath: String, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
         let path = (atPath as NSString).appendingPathComponent(folderName) + "/"
         return doOperation(.create(path: path), completionHandler: completionHandler)
     }
     
-    public func create(file fileName: String, at path: String, contents data: Data?, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
+    open func create(file fileName: String, at path: String, contents data: Data?, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
         let filePath = (path as NSString).appendingPathComponent(fileName)
         return self.writeContents(path: filePath, contents: data ?? Data(), completionHandler: completionHandler)
     }
     
-    public func moveItem(path: String, to toPath: String, overwrite: Bool, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
+    open func moveItem(path: String, to toPath: String, overwrite: Bool, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
         return doOperation(.move(source: path, destination: toPath), completionHandler: completionHandler)
     }
     
-    public func copyItem(path: String, to toPath: String, overwrite: Bool, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
+    open func copyItem(path: String, to toPath: String, overwrite: Bool, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
         return doOperation(.copy(source: path, destination: toPath), completionHandler: completionHandler)
     }
     
-    public func removeItem(path: String, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
+    open func removeItem(path: String, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
         return doOperation(.remove(path: path), completionHandler: completionHandler)
     }
     
@@ -205,7 +224,7 @@ extension DropboxFileProvider: FileProviderOperations {
         return RemoteOperationHandle(operationType: operation, tasks: [task])
     }
     
-    public func copyItem(localFile: URL, to toPath: String, overwrite: Bool, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
+    open func copyItem(localFile: URL, to toPath: String, overwrite: Bool, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
         let opType = FileOperationType.copy(source: localFile.absoluteString, destination: toPath)
         guard fileOperationDelegate?.fileProvider(self, shouldDoOperation: opType) ?? true == true else {
             return nil
@@ -213,7 +232,7 @@ extension DropboxFileProvider: FileProviderOperations {
         return upload_simple(toPath, localFile: localFile, overwrite: overwrite, operation: opType, completionHandler: completionHandler)
     }
     
-    public func copyItem(path: String, toLocalURL destURL: URL, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
+    open func copyItem(path: String, toLocalURL destURL: URL, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
         let opType = FileOperationType.copy(source: path, destination: destURL.absoluteString)
         guard fileOperationDelegate?.fileProvider(self, shouldDoOperation: opType) ?? true == true else {
             return nil
@@ -247,7 +266,7 @@ extension DropboxFileProvider: FileProviderOperations {
 }
 
 extension DropboxFileProvider: FileProviderReadWrite {
-    public func contents(path: String, offset: Int64, length: Int, completionHandler: @escaping ((_ contents: Data?, _ error: Error?) -> Void)) -> OperationHandle? {
+    open func contents(path: String, offset: Int64, length: Int, completionHandler: @escaping ((_ contents: Data?, _ error: Error?) -> Void)) -> OperationHandle? {
         if length == 0 || offset < 0 {
             dispatch_queue.async {
                 completionHandler(Data(), nil)
@@ -289,16 +308,7 @@ extension DropboxFileProvider: FileProviderReadWrite {
         return upload_simple(path, data: data, overwrite: overwrite, operation: opType, completionHandler: completionHandler)
     }
     
-    public func searchFiles(path: String, recursive: Bool, query: String, foundItemHandler: ((FileObject) -> Void)?, completionHandler: @escaping ((_ files: [FileObject], _ error: Error?) -> Void)) {
-        var foundFiles = [DropboxFileObject]()
-        search(path, query: query, foundItem: { (file) in
-            foundFiles.append(file)
-            foundItemHandler?(file)
-            }, completionHandler: { (error) in
-                completionHandler(foundFiles, error)
-        })
-    }
-    
+    /*
     fileprivate func registerNotifcation(path: String, eventHandler: (() -> Void)) {
         /* There is two ways to monitor folders changing in Dropbox. Either using webooks
          * which means you have to implement a server to translate it to push notifications
@@ -311,7 +321,7 @@ extension DropboxFileProvider: FileProviderReadWrite {
     fileprivate func unregisterNotifcation(path: String) {
         NotImplemented()
     }
-    
+    */
     // TODO: Implement /get_account & /get_current_account
 }
 
@@ -339,7 +349,7 @@ extension DropboxFileProvider {
      
      - Parameters:
        - to: path of file, including file/directory name.
-       - completionHandler: a block with result of directory entries or error.
+       - completionHandler: a closure with result of directory entries or error.
          `link`: a url returned by Dropbox to share.
          `attribute`: a `FileObject` containing the attributes of the item.
          `expiration`: a `Date` object, determines when the public url will expires.
@@ -382,7 +392,7 @@ extension DropboxFileProvider {
      - Parameters:
        - remoteURL: a valid remote url to file.
        - to: Destination path of file, including file/directory name.
-       - completionHandler: a block with result of directory entries or error.
+       - completionHandler: a closure with result of directory entries or error.
          `jobId`: Job ID returned by Dropbox to monitor the copy/download progress.
          `attribute`: A `FileObject` containing the attributes of the item.
          `error`: Error returned by Dropbox.
@@ -447,7 +457,7 @@ extension DropboxFileProvider {
 }
 
 extension DropboxFileProvider: ExtendedFileProvider {
-    public func thumbnailOfFileSupported(path: String) -> Bool {
+    open func thumbnailOfFileSupported(path: String) -> Bool {
         switch (path as NSString).pathExtension.lowercased() {
         case "jpg", "jpeg", "gif", "bmp", "png", "tif", "tiff":
             return true
@@ -462,7 +472,7 @@ extension DropboxFileProvider: ExtendedFileProvider {
         }
     }
     
-    public func propertiesOfFileSupported(path: String) -> Bool {
+    open func propertiesOfFileSupported(path: String) -> Bool {
         let fileExt = (path as NSString).pathExtension.lowercased()
         switch fileExt {
         case "jpg", "jpeg", "bmp", "gif", "png", "tif", "tiff":
@@ -477,7 +487,7 @@ extension DropboxFileProvider: ExtendedFileProvider {
     }
         
     /// Default value for dimension is 64x64, according to Dropbox documentation
-    public func thumbnailOfFile(path: String, dimension: CGSize?, completionHandler: @escaping ((_ image: ImageClass?, _ error: Error?) -> Void)) {
+    open func thumbnailOfFile(path: String, dimension: CGSize?, completionHandler: @escaping ((_ image: ImageClass?, _ error: Error?) -> Void)) {
         let url: URL
         switch (path as NSString).pathExtension.lowercased() {
         case "jpg", "jpeg", "gif", "bmp", "png", "tif", "tiff":
@@ -520,7 +530,7 @@ extension DropboxFileProvider: ExtendedFileProvider {
         task.resume()
     }
     
-    public func propertiesOfFile(path: String, completionHandler: @escaping ((_ propertiesDictionary: [String : Any], _ keys: [String], _ error: Error?) -> Void)) {
+    open func propertiesOfFile(path: String, completionHandler: @escaping ((_ propertiesDictionary: [String : Any], _ keys: [String], _ error: Error?) -> Void)) {
         let url = URL(string: "files/get_metadata", relativeTo: apiURL)!
         var request = URLRequest(url: url)
         request.httpMethod = "POST"

Sources/DropboxHelper.swift

@@ -8,12 +8,14 @@
 
 import Foundation
 
+/// Error returned by Dropbox server when trying to access or do operations on a file or folder.
 public struct FileProviderDropboxError: FileProviderHTTPError {
     public let code: FileProviderHTTPErrorCode
     public let path: String
     public let errorDescription: String?
 }
 
+/// Containts path, url and attributes of a Dropbox file or resource.
 public final class DropboxFileObject: FileObject {
     internal init(name: String, path: String) {
         super.init(url: URL(string: path) ?? URL(string: "/")!, name: name, path: path)
@@ -37,6 +39,7 @@ public final class DropboxFileObject: FileObject {
         self.rev = json["rev"] as? String
     }
     
+    /// The time contents of file has been modified on server, returns nil if not set
     open internal(set) var serverTime: Date? {
         get {
             return allValues[.serverDate] as? Date
@@ -46,6 +49,9 @@ public final class DropboxFileObject: FileObject {
         }
     }
     
+    /// The document identifier is a value assigned by the Dropbox to a file.
+    /// This value is used to identify the document regardless of where it is moved on a volume.
+    /// The identifier persists across system restarts.
     open internal(set) var id: String? {
         get {
             return allValues[.documentIdentifierKey] as? String
@@ -55,6 +61,8 @@ public final class DropboxFileObject: FileObject {
         }
     }
     
+    /// The revision of file, which changes when a file contents are modified.
+    /// Changes to attributes or other file metadata do not change the identifier.
     open internal(set) var rev: String? {
         get {
             return allValues[.generationIdentifierKey] as? String

Sources/ExtendedLocalFileProvider.swift

@@ -10,11 +10,6 @@ import Foundation
 import ImageIO
 import CoreGraphics
 import AVFoundation
-#if os(iOS) || os(tvOS)
-import UIKit
-#elseif os(macOS)
-import Cocoa
-#endif
 
 extension LocalFileProvider: ExtendedFileProvider {
     public func thumbnailOfFileSupported(path: String) -> Bool {

Sources/FPSStreamTask.swift

@@ -13,8 +13,7 @@ private var lasttaskIdAssociated = 1_000_000_000
 
 /// This class is a replica of NSURLSessionStreamTask with same api for iOS 7/8
 /// while it will fallback to NSURLSessionStreamTask in iOS 9.
-@objc
-open class FPSStreamTask: URLSessionTask, StreamDelegate {
+internal class FPSStreamTask: URLSessionTask, StreamDelegate {
     fileprivate var inputStream: InputStream?
     fileprivate var outputStream: OutputStream?
     
@@ -449,23 +448,23 @@ open class FPSStreamTask: URLSessionTask, StreamDelegate {
     }
 }
 
-extension URLSession {
+internal extension URLSession {
     /* Creates a bidirectional stream task to a given host and port.
      */
-    public func fpstreamTaskWithHostName(_ hostname: String, port: Int) -> FPSStreamTask {
+    func fpstreamTaskWithHostName(_ hostname: String, port: Int) -> FPSStreamTask {
         return FPSStreamTask(session: self, host: hostname, port: port)
     }
     
     /* Creates a bidirectional stream task with an NSNetService to identify the endpoint.
      * The NSNetService will be resolved before any IO completes.
      */
-    public func fpstreamTaskWithNetService(_ service: NetService) -> FPSStreamTask {
+    func fpstreamTaskWithNetService(_ service: NetService) -> FPSStreamTask {
         return fpstreamTaskWithNetService(service)
     }
 }
 
 @objc
-public protocol FPSStreamDelegate : URLSessionTaskDelegate {
+internal protocol FPSStreamDelegate : URLSessionTaskDelegate {
     
     
     /* Indiciates that the read side of a connection has been closed.  Any

Sources/FileObject.swift

@@ -8,7 +8,7 @@
 
 import Foundation
 
-/// Containts path and attributes of a file or resource.
+/// Containts path, url and attributes of a file or resource.
 open class FileObject: Equatable {
     /// A `Dictionary` contains file information,  using `URLResourceKey` keys.
     open internal(set) var allValues: [URLResourceKey: Any]
@@ -143,6 +143,7 @@ open class FileObject: Equatable {
         return self.type == .symbolicLink
     }
     
+    /// Check `FileObject` equality
     public static func ==(lhs: FileObject, rhs: FileObject) -> Bool {
         if rhs === lhs {
             return true
@@ -155,6 +156,25 @@ open class FileObject: Equatable {
         }
         return rhs.path == lhs.path && rhs.size == lhs.size && rhs.modifiedDate == lhs.modifiedDate
     }
+    
+    internal  func mapPredicate() -> [String: Any] {
+        let mapDict: [URLResourceKey: String] = [.fileURL: "url", .nameKey: "name", .pathKey: "path", .fileSizeKey: "filesize", .creationDateKey: "creationDate",
+                                                 .contentModificationDateKey: "modifiedDate", .isHiddenKey: "isHidden", .isWritableKey: "isWritable", .serverDate: "serverDate", .entryTag: "entryTag", .mimeType: "mimeType"]
+        let typeDict: [URLFileResourceType: String] = [.directory: "directory", .regular: "regular", .symbolicLink: "symbolicLink", .unknown: "unknown"]
+        var result = [String: Any]()
+        for (key, value) in allValues {
+            if let convertkey = mapDict[key] {
+                result[convertkey] = value
+            }
+        }
+        result["eTag"] = result["entryTag"]
+        result["isReadOnly"] = self.isReadOnly
+        result["isDirectory"] = self.isDirectory
+        result["isRegularFile"] = self.isRegularFile
+        result["isSymLink"] = self.isSymLink
+        result["type"] = typeDict[self.type ?? .unknown] ?? "unknown"
+        return result
+    }
 }
 
 internal func resolve(dateString: String) -> Date? {
@@ -295,6 +315,7 @@ extension Array where Element: FileObject {
 }
 
 extension URLFileResourceType {
+    /// Returns corresponding `URLFileResourceType` of a `FileAttributeType` value
     public init(fileTypeValue: FileAttributeType) {
         switch fileTypeValue {
         case FileAttributeType.typeCharacterSpecial: self = .characterSpecial

Sources/FileProvider.swift

@@ -15,8 +15,10 @@ import Cocoa
 public typealias ImageClass = NSImage
 #endif
 
+/// Completion handler type with an error argument
 public typealias SimpleCompletionHandler = ((_ error: Error?) -> Void)?
 
+/// This protocol defines FileProvider neccesary functions and properties to connect and get contents list
 public protocol FileProviderBasic: class {
     /// An string to identify type of provider.
     static var type: String { get }
@@ -66,7 +68,7 @@ public protocol FileProviderBasic: class {
      If the directory contains no entries or an error is occured, this method will return the empty array.
      
      - Parameter path: path to target directory. If empty, `currentPath` value will be used.
-     - Parameter completionHandler: a block with result of directory entries or error.
+     - Parameter completionHandler: a closure with result of directory entries or error.
         `contents`: An array of `FileObject` identifying the the directory entries.
         `error`: Error returned by system.
      */
@@ -78,7 +80,7 @@ public protocol FileProviderBasic: class {
      If the directory contains no entries or an error is occured, this method will return the empty `FileObject`.
      
      - Parameter path: path to target directory. If empty, `currentPath` value will be used.
-     - Parameter completionHandler: a block with result of directory entries or error.
+     - Parameter completionHandler: a closure with result of directory entries or error.
         `attributes`: A `FileObject` containing the attributes of the item.
         `error`: Error returned by system.
      */
@@ -88,6 +90,41 @@ public protocol FileProviderBasic: class {
     /// Returns total and used capacity in provider container asynchronously.
     func storageProperties(completionHandler: @escaping ((_ total: Int64, _ used: Int64) -> Void))
     
+    /**
+     Search files inside directory using query asynchronously.
+     
+     - Note: Query string is limited to file name, to search based on other file properties, use NSPredicate version.
+     
+     - Parameters:
+       - path: location of directory to start search
+       - recursive: Searching subdirectories of path
+       - query: Simple string that file name contains to be search, case-insensitive.
+       - foundItemHandler: Closure which is called when a file is found
+       - completionHandler: Closure which will be called after finishing search. Returns an arry of `FileObject` or error if occured.
+     */
+    func searchFiles(path: String, recursive: Bool, query: String, foundItemHandler: ((FileObject) -> Void)?, completionHandler: @escaping ((_ files: [FileObject], _ error: Error?) -> Void))
+    
+    /**
+     Search files inside directory using query asynchronously.
+     
+     Sample predicates:
+     ```
+     NSPredicate(format: "(name CONTAINS[c] 'hello') && (filesize >= 10000)")
+     NSPredicate(format: "(modifiedDate >= %@)", Date())
+     NSPredicate(format: "(path BEGINSWITH %@)", "folder/child folder")
+     ```
+     
+     - Note: Don't pass Spotlight predicates to this method directly, use `FileProvider.convertSpotlightPredicateTo()` method to get usable predicate.
+     
+     - Parameters:
+       - path: location of directory to start search
+       - recursive: Searching subdirectories of path
+       - query: An `NSPredicate` object with keys like `FileObject` members, except `size` which becomes `filesize`.
+       - foundItemHandler: Closure which is called when a file is found
+       - completionHandler: Closure which will be called after finishing search. Returns an arry of `FileObject` or error if occured.
+     */
+    func searchFiles(path: String, recursive: Bool, query: NSPredicate, foundItemHandler: ((FileObject) -> Void)?, completionHandler: @escaping ((_ files: [FileObject], _ error: Error?) -> Void))
+    
     /**
      Returns an independent url to access the file. Some providers like `Dropbox` due to their nature.
      don't return an absolute url to be used to access file directly.
@@ -101,6 +138,39 @@ public protocol FileProviderBasic: class {
 }
 
 extension FileProviderBasic {
+    public func searchFiles(path: String, recursive: Bool, query: String, foundItemHandler: ((FileObject) -> Void)?, completionHandler: @escaping ((_ files: [FileObject], _ error: Error?) -> Void)) {
+        let predicate = NSPredicate(format: "name CONTAINS[c] %@", query)
+        self.searchFiles(path: path, recursive: recursive, query: predicate, foundItemHandler: foundItemHandler, completionHandler: completionHandler)
+    }
+    
+    /// Converts Spotlight search predicate to `FileProvider.searchFiles()` method usable predicate.
+    public func convertSpotlightPredicateTo(_ query: NSPredicate) -> NSPredicate {
+        let mapDict: [String: URLResourceKey] = [NSMetadataItemURLKey: .fileURL, NSMetadataItemFSNameKey: .nameKey, NSMetadataItemPathKey: .pathKey,
+                                                 NSMetadataItemFSSizeKey: .fileSizeKey, NSMetadataItemFSCreationDateKey: .creationDateKey,
+                                                 NSMetadataItemFSContentChangeDateKey: .contentModificationDateKey, "kMDItemFSInvisible": .isHiddenKey, "kMDItemFSIsWriteable": .isWritableKey, "kMDItemKind": .mimeType]
+        
+        if let cQuery = query as? NSCompoundPredicate {
+            let newSub = cQuery.subpredicates.map { convertSpotlightPredicateTo($0 as! NSPredicate) }
+            switch cQuery.compoundPredicateType {
+            case .and: return NSCompoundPredicate(andPredicateWithSubpredicates: newSub)
+            case .not: return NSCompoundPredicate(notPredicateWithSubpredicate: newSub[0])
+            case .or:  return NSCompoundPredicate(orPredicateWithSubpredicates: newSub)
+            }
+        } else if let cQuery = query as? NSComparisonPredicate {
+            var newLeft = cQuery.leftExpression
+            var newRight = cQuery.rightExpression
+            if newLeft.expressionType == .keyPath, let newKey = mapDict[newLeft.keyPath] {
+                newLeft = NSExpression(forKeyPath: newKey.rawValue)
+            }
+            if newRight.expressionType == .keyPath, let newKey = mapDict[newRight.keyPath] {
+                newRight = NSExpression(forKeyPath: newKey.rawValue)
+            }
+            return NSComparisonPredicate(leftExpression: newLeft, rightExpression: newRight, modifier: cQuery.comparisonPredicateModifier, type: cQuery.predicateOperatorType, options: cQuery.options)
+        } else {
+            return query
+        }
+    }
+    
     /// The maximum number of queued operations that can execute at the same time.
     ///
     /// The default value of this property is `OperationQueue.defaultMaxConcurrentOperationCount`.
@@ -112,8 +182,29 @@ extension FileProviderBasic {
             operation_queue.maxConcurrentOperationCount = newValue
         }
     }
+    
+    internal func findNameQuery(_ query: NSPredicate, key: String?) -> Any? {
+        if let cQuery = query as? NSCompoundPredicate {
+            let find = cQuery.subpredicates.flatMap { findNameQuery($0 as! NSPredicate, key: key) }
+            if find.count > 0 {
+                return find[0]
+            }
+            return nil
+        } else if let cQuery = query as? NSComparisonPredicate {
+            if cQuery.leftExpression.expressionType == .keyPath, key == nil || cQuery.leftExpression.keyPath == key! {
+                return cQuery.rightExpression.constantValue
+            }
+            if cQuery.rightExpression.expressionType == .keyPath, key == nil || cQuery.rightExpression.keyPath == key! {
+                return cQuery.leftExpression.constantValue
+            }
+            return nil
+        } else {
+            return nil
+        }
+    }
 }
 
+/// Checking equality of two file provider, regardless of current path queues and delegates.
 public func ==(lhs: FileProviderBasic, rhs: FileProviderBasic) -> Bool {
     if lhs === rhs { return true }
     if type(of: lhs) != type(of: rhs) {
@@ -125,14 +216,23 @@ public func ==(lhs: FileProviderBasic, rhs: FileProviderBasic) -> Bool {
 /// Cancels all active underlying tasks
 public var fileProviderCancelTasksOnInvalidating = true
 
+/// Extending `FileProviderBasic` for web-based file providers
 public protocol FileProviderBasicRemote: FileProviderBasic {
     /// Underlying URLSession instance used for HTTP/S requests
     var session: URLSession { get }
     
-    /// A `URLCache` to cache downloaded files and contents.
-    ///
-    /// If set to nil, `URLCache.shared` object will be used.
-    /// - Note: It has no effect unless setting `useCache` property to `true`.
+    /**
+     A `URLCache` to cache downloaded files and contents.
+     
+     - Note: It has no effect unless setting `useCache` property to `true`.
+     
+     - Warning: FileProvider doesn't manage/free `URLCache` object in a memory pressure scenario. It's upon you to clear
+     cache memory when receiving `didReceiveMemoryWarning` or via observing `.UIApplicationDidReceiveMemoryWarning` notification.
+     To clear memory usage use this code:
+     ```
+     provider.cache?.removeAllCachedResponses()
+     ```
+     */
     var cache: URLCache? { get }
     
     /// Determine to use `cache` property to cache downloaded file objects. Doesn't have effect on query type methods.
@@ -190,6 +290,7 @@ internal extension FileProviderBasicRemote {
     }
 }
 
+/// Defines methods for common file operaions including create, copy/move and delete
 public protocol FileProviderOperations: FileProviderBasic {
     /// Delgate for managing operations involving the copying, moving, linking, or removal of files and directories. When you use an FileManager object to initiate a copy, move, link, or remove operation, the file provider asks its delegate whether the operation should begin at all and whether it should proceed when an error occurs.
     var fileOperationDelegate : FileOperationDelegate? { get set }
@@ -219,7 +320,6 @@ public protocol FileProviderOperations: FileProviderBasic {
      - Returns: An `OperationHandle` to get progress or cancel progress. Doesn't work on `LocalFileProvider`.
      */
     @discardableResult
-    
     func create(file: String, at: String, contents data: Data?, completionHandler: SimpleCompletionHandler) -> OperationHandle?
     
     /**
@@ -350,6 +450,7 @@ extension FileProviderOperations {
     }
 }
 
+/// Defines method for fetching and modifying file contents
 public protocol FileProviderReadWrite: FileProviderBasic {
     /**
      Retreives a `Data` object with the contents of the file asynchronously vis contents argument of completion handler.
@@ -357,7 +458,7 @@ public protocol FileProviderReadWrite: FileProviderBasic {
      
      - Parameters:
        - path: Path of file.
-       - completionHandler: a block with result of file contents or error.
+       - completionHandler: a closure with result of file contents or error.
          `contents`: contents of file in a `Data` object.
          `error`: Error returned by system.
      - Returns: An `OperationHandle` to get progress or cancel progress. Doesn't work on `LocalFileProvider`.
@@ -373,7 +474,7 @@ public protocol FileProviderReadWrite: FileProviderBasic {
        - path: Path of file.
        - offset: First byte index which should be read. **Starts from 0.**
        - length: Bytes count of data. Pass `-1` to read until the end of file.
-       - completionHandler: a block with result of file contents or error.
+       - completionHandler: a closure with result of file contents or error.
          `contents`: contents of file in a `Data` object.
          `error`: Error returned by system.
      - Returns: An `OperationHandle` to get progress or cancel progress. Doesn't work on `LocalFileProvider`.
@@ -436,20 +537,6 @@ public protocol FileProviderReadWrite: FileProviderBasic {
      */
     @discardableResult
     func writeContents(path: String, contents: Data, atomically: Bool, overwrite: Bool, completionHandler: SimpleCompletionHandler) -> OperationHandle?
-    
-    /**
-     Search files inside directory using query asynchronously.
-     
-     - Note: For now only it's limited to file names. `query` parameter may take `NSPredicate` format in near future.
-     
-     - Parameters:
-       - path: location of directory to start search
-       - recursive: Searching subdirectories of path
-       - query: Simple string of file name to be search (for now).
-       - foundItemHandler: Block which is called when a file is found
-       - completionHandler: Block which will be called after finishing search. Returns an arry of `FileObject` or error if occured.
-     */
-    func searchFiles(path: String, recursive: Bool, query: String, foundItemHandler: ((FileObject) -> Void)?, completionHandler: @escaping ((_ files: [FileObject], _ error: Error?) -> Void))
 }
 
 extension FileProviderReadWrite {
@@ -474,6 +561,7 @@ extension FileProviderReadWrite {
     }
 }
 
+/// Allows a file provider to notify changes occured
 public protocol FileProviderMonitor: FileProviderBasic {
     
     /**
@@ -489,7 +577,7 @@ public protocol FileProviderMonitor: FileProviderBasic {
     
      - Parameters:
        - path: path of directory.
-       - eventHandler: Block executed after change, on a secondary thread.
+       - eventHandler: Closure executed after change, on a secondary thread.
      */
     func registerNotifcation(path: String, eventHandler: @escaping (() -> Void))
     
@@ -505,6 +593,7 @@ public protocol FileProviderMonitor: FileProviderBasic {
     func isRegisteredForNotification(path: String) -> Bool
 }
 
+/// Allows undo file operations done by provider
 public protocol FileProvideUndoable: FileProviderOperations {
     /// To initialize undo manager either call `setupUndoManager()` or set it manually.
     ///
@@ -554,6 +643,7 @@ public extension FileProvideUndoable {
     }
 }
 
+/// Defines protocol for provider allows all common operations.
 public protocol FileProvider: FileProviderBasic, FileProviderOperations, FileProviderReadWrite, NSCopying {
 }
 
@@ -605,7 +695,7 @@ extension FileProviderBasic {
     /// - Returns: A `String` contains relative path of url against base url.
     public func relativePathOf(url: URL) -> String {
         // check if url derieved from current base url
-        if url.relativeString.isEmpty, url.baseURL == self.baseURL {
+        if !url.relativePath.isEmpty, url.baseURL == self.baseURL {
             return url.relativePath.removingPercentEncoding!
         }
         
@@ -658,7 +748,7 @@ extension FileProviderBasic {
             }
             group.leave()
         }
-        _ = group.wait(timeout: DispatchTime.now() + 0.5)
+        _ = group.wait(timeout: DispatchTime.now() + 5)
         let finalFile = result + (!fileExt.isEmpty ? "." + fileExt : "")
         return (dirPath as NSString).appendingPathComponent(finalFile)
     }
@@ -680,6 +770,7 @@ extension FileProviderBasic {
     }
 }
 
+/// Define methods to get preview and thumbnail for files or folders
 public protocol ExtendedFileProvider: FileProviderBasic {
     /// Returuns true if thumbnail preview is supported by provider and file type accordingly.
     ///
@@ -700,7 +791,7 @@ public protocol ExtendedFileProvider: FileProviderBasic {
      
      - Parameters:
        - path: path of file.
-       - completionHandler: a block with result of preview image or error.
+       - completionHandler: a closure with result of preview image or error.
          `image`: `NSImage`/`UIImage` object contains preview.
          `error`: Error returned by system.
     */
@@ -716,7 +807,7 @@ public protocol ExtendedFileProvider: FileProviderBasic {
      - Parameters:
        - path: path of file.
        - dimension: width and height of result preview image.
-       - completionHandler: a block with result of preview image or error.
+       - completionHandler: a closure with result of preview image or error.
          `image`: `NSImage`/`UIImage` object contains preview.
      `error`: Error returned by system.
      */
@@ -731,7 +822,7 @@ public protocol ExtendedFileProvider: FileProviderBasic {
      
      - Parameters:
        - path: path of file.
-       - completionHandler: a block with result of preview image or error.
+       - completionHandler: a closure with result of preview image or error.
          `propertiesDictionary`: A `Dictionary` of proprty keys and values.
          `keys`: An `Array` contains ordering of keys.
          `error`: Error returned by system.
@@ -923,7 +1014,7 @@ public enum FileOperationType: CustomStringConvertible {
     }
 }
 
-
+/// Allows to get progress or cancel an in-progress operation, useful for remote providers
 public protocol OperationHandle {
     /// Operation supposed to be done on files. Contains file paths as associated value.
     var operationType: FileOperationType { get }
@@ -952,6 +1043,9 @@ public extension OperationHandle {
     }
 }
 
+/// Delegate methods for reporting provider's operation result and progress, when it's ready to update
+/// user interface.
+/// All methods are called in main thread to avoids UI bugs.
 public protocol FileProviderDelegate: class {
     /// fileproviderSucceed(_:operation:) gives delegate a notification when an operation finished with success.
     /// This method is called in main thread to avoids UI bugs.
@@ -965,6 +1059,7 @@ public protocol FileProviderDelegate: class {
     func fileproviderProgress(_ fileProvider: FileProviderOperations, operation: FileOperationType, progress: Float)
 }
 
+/// The `FileOperationDelegate` protocol defines methods for managing operations involving the copying, moving, linking, or removal of files and directories. When you use an `FileProvider` object to initiate a copy, move, link, or remove operation, the file provider asks its delegate whether the operation should begin at all and whether it should proceed when an error occurs.
 public protocol FileOperationDelegate: class {
     
     /// fileProvider(_:shouldOperate:) gives the delegate an opportunity to filter the file operation. Returning true from this method will allow the copy to happen. Returning false from this method causes the item in question to be skipped. If the item skipped was a directory, no children of that directory will be subject of the operation, nor will the delegate be notified of those children.
@@ -981,6 +1076,7 @@ internal class Weak<T: AnyObject> {
     }
 }
 
+/// For internal use in `FileProvider` framework
 public protocol FoundationErrorEnum {
     init? (rawValue: Int)
     var rawValue: Int { get }

Sources/LocalFileProvider.swift

@@ -8,6 +8,12 @@
 
 import Foundation
 
+/**
+ This provider class allows interacting with local files placed in user disk. It also allows an
+ easy way to use `NSFileCoordintaing` to coordinate read and write when neccessary.
+ 
+ it uses `FileManager` foundation class with some additions like searching and reading a portion of file.
+ */
 open class LocalFileProvider: FileProvider, FileProviderMonitor, FileProvideUndoable {
     open class var type: String { return "Local" }
     open var isPathRelative: Bool
@@ -17,8 +23,10 @@ open class LocalFileProvider: FileProvider, FileProviderMonitor, FileProvideUndo
     open var operation_queue: OperationQueue
     open weak var delegate: FileProviderDelegate?
     open internal(set) var credential: URLCredential?
-        
+    
+    /// Underlying `FileManager` object for listing and metadata fetching.
     open private(set) var fileManager = FileManager()
+    /// Underlying `FileManager` object for operationa like copying, moving, etc.
     open private(set) var opFileManager = FileManager()
     fileprivate var fileProviderManagerDelegate: LocalFileProviderManagerDelegate? = nil
     
@@ -55,7 +63,7 @@ open class LocalFileProvider: FileProvider, FileProviderMonitor, FileProvideUndo
      default values are `directory: .documentDirectory`.
     
      - Parameters:
-       - sharedContainerId: Same  with `App Group` identifier defined in project settings.
+       - sharedContainerId: Same with `App Group` identifier defined in project settings.
        - directory: The search path directory. The supported values are described in `FileManager.SearchPathDirectory`.
     */
     public convenience init? (sharedContainerId: String, directory: FileManager.SearchPathDirectory = .documentDirectory) {
@@ -79,6 +87,7 @@ open class LocalFileProvider: FileProvider, FileProviderMonitor, FileProvideUndo
         }
         
         self.init(baseURL: finalBaseURL)
+        self.isCoorinating = true
         
         try? fileManager.createDirectory(at: finalBaseURL, withIntermediateDirectories: true)
     }
@@ -126,6 +135,12 @@ open class LocalFileProvider: FileProvider, FileProviderMonitor, FileProvideUndo
         }
     }
     
+    open func attributesOfItem(path: String, completionHandler: @escaping ((_ attributes: FileObject?, _ error: Error?) -> Void)) {
+        dispatch_queue.async {
+            completionHandler(LocalFileObject(fileWithPath: path, relativeTo: self.baseURL), nil)
+        }
+    }
+    
     open func storageProperties(completionHandler: (@escaping (_ total: Int64, _ used: Int64) -> Void)) {
         let values = try? baseURL?.resourceValues(forKeys: [.volumeTotalCapacityKey, .volumeAvailableCapacityKey])
         let totalSize = Int64(values??.volumeTotalCapacity ?? -1)
@@ -133,9 +148,21 @@ open class LocalFileProvider: FileProvider, FileProviderMonitor, FileProvideUndo
         completionHandler(totalSize, totalSize - freeSize)
     }
     
-    open func attributesOfItem(path: String, completionHandler: @escaping ((_ attributes: FileObject?, _ error: Error?) -> Void)) {
+    open func searchFiles(path: String, recursive: Bool, query: NSPredicate, foundItemHandler: ((FileObject) -> Void)?, completionHandler: @escaping ((_ files: [FileObject], _ error: Error?) -> Void)) {
         dispatch_queue.async {
-            completionHandler(LocalFileObject(fileWithPath: path, relativeTo: self.baseURL), nil)
+            let iterator = self.fileManager.enumerator(at: self.url(of: path), includingPropertiesForKeys: nil, options: recursive ? [] : [.skipsSubdirectoryDescendants, .skipsPackageDescendants]) { (url, e) -> Bool in
+                completionHandler([], e)
+                return true
+            }
+            var result = [LocalFileObject]()
+            while let fileURL = iterator?.nextObject() as? URL {
+                let path = self.relativePathOf(url: fileURL)
+                if let fileObject = LocalFileObject(fileWithPath: path, relativeTo: self.baseURL), query.evaluate(with: fileObject.mapPredicate()) {
+                    result.append(fileObject)
+                    foundItemHandler?(fileObject)
+                }
+            }
+            completionHandler(result, nil)
         }
     }
     
@@ -221,26 +248,24 @@ open class LocalFileProvider: FileProvider, FileProviderMonitor, FileProvideUndo
     
     @discardableResult
     fileprivate func doOperation(_ opType: FileOperationType, data: Data? = nil, atomically: Bool = false, forUploading: Bool = false, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
+        
+        func urlofpath(path: String) -> URL {
+            if path.hasPrefix("file://") {
+                let removedSchemePath = path.replacingOccurrences(of: "file://", with: "", options: .anchored)
+                let pDecodedPath = removedSchemePath.removingPercentEncoding ?? removedSchemePath
+                return URL(fileURLWithPath: pDecodedPath)
+            } else {
+                return self.url(of: path)
+            }
+        }
+        
         guard let sourcePath = opType.source else { return nil }
         let destPath = opType.destination
-        let source: URL
-        if sourcePath.hasPrefix("file://") {
-            let removedSchemePath = sourcePath.replacingOccurrences(of: "file://", with: "", options: .anchored)
-            let pDecodedPath = removedSchemePath.removingPercentEncoding ?? removedSchemePath
-            source = URL(fileURLWithPath: pDecodedPath)
-        } else {
-            source = self.url(of: sourcePath)
-        }
+        let source: URL = urlofpath(path: sourcePath)
         
         let dest: URL?
         if let destPath = destPath {
-            if destPath.hasPrefix("file://") {
-                let removedSchemePath = destPath.replacingOccurrences(of: "file://", with: "", options: .anchored)
-                let pDecodedPath = removedSchemePath.removingPercentEncoding ?? removedSchemePath
-                dest = URL(fileURLWithPath: pDecodedPath)
-            } else {
-                dest = self.url(of: destPath)
-            }
+            dest = urlofpath(path: destPath)
         } else {
             dest = nil
         }
@@ -301,8 +326,8 @@ open class LocalFileProvider: FileProvider, FileProviderMonitor, FileProvideUndo
         }
         
         if isCoorinating {
-            var intents = [NSFileAccessIntent]()
             successfulSecurityScopedResourceAccess = source.startAccessingSecurityScopedResource()
+            var intents = [NSFileAccessIntent]()
             switch opType {
             case .create, .modify:
                 intents.append(NSFileAccessIntent.writingIntent(with: source, options: .forReplacing))
@@ -446,26 +471,6 @@ open class LocalFileProvider: FileProvider, FileProviderMonitor, FileProvideUndo
         return self.doOperation(opType, data: data, atomically: atomically, completionHandler: completionHandler)
     }
     
-    open func searchFiles(path: String, recursive: Bool, query: String, foundItemHandler: ((FileObject) -> Void)?, completionHandler: @escaping ((_ files: [FileObject], _ error: Error?) -> Void)) {
-        dispatch_queue.async { 
-            let iterator = self.fileManager.enumerator(at: self.url(of: path), includingPropertiesForKeys: nil, options: recursive ? [] : [.skipsSubdirectoryDescendants, .skipsPackageDescendants]) { (url, e) -> Bool in
-                completionHandler([], e)
-                return true
-            }
-            var result = [LocalFileObject]()
-            while let fileURL = iterator?.nextObject() as? URL {
-                if fileURL.lastPathComponent.lowercased().contains(query.lowercased()) {
-                    let path = self.relativePathOf(url: fileURL)
-                    if let fileObject = LocalFileObject(fileWithPath: path, relativeTo: self.baseURL) {
-                        result.append(fileObject)
-                        foundItemHandler?(fileObject)
-                    }
-                }
-            }
-            completionHandler(result, nil)
-        }
-    }
-    
     fileprivate var monitors = [LocalFolderMonitor]()
     
     open func registerNotifcation(path: String, eventHandler: @escaping (() -> Void)) {
@@ -494,7 +499,7 @@ open class LocalFileProvider: FileProvider, FileProviderMonitor, FileProvideUndo
     }
     
     open func isRegisteredForNotification(path: String) -> Bool {
-        return monitors.map( { self.relativePathOf(url: $0.url) } ).contains(path)
+        return monitors.map( { self.relativePathOf(url: $0.url) } ).contains(path.trimmingCharacters(in: CharacterSet(charactersIn: "/")))
     }
     
     open func copy(with zone: NSZone? = nil) -> Any {

Sources/LocalHelper.swift

@@ -8,15 +8,17 @@
 
 import Foundation
 
+/// Containts path, url and attributes of a local file or resource.
 public final class LocalFileObject: FileObject {
     internal override init(url: URL, name: String, path: String) {
         super.init(url: url, name: name, path: path)
     }
     
+    /// Initiates a `LocalFileObject` with attributes of file in path.
     public convenience init? (fileWithPath path: String, relativeTo relativeURL: URL?) {
         var fileURL: URL?
         var rpath = path.replacingOccurrences(of: relativeURL?.path ?? "", with: "", options: .anchored)
-        if path.hasPrefix("/") {
+        if relativeURL != nil && rpath.hasPrefix("/") {
             rpath.remove(at: rpath.startIndex)
         }
         if rpath.isEmpty {
@@ -35,6 +37,7 @@ public final class LocalFileObject: FileObject {
         }
     }
     
+    /// Initiates a `LocalFileObject` with attributes of file in url.
     public convenience init?(fileWithURL fileURL: URL) {
         do {
             let values = try fileURL.resourceValues(forKeys: [.nameKey, .fileSizeKey, .fileAllocatedSizeKey, .creationDateKey, .contentModificationDateKey, .fileResourceTypeKey, .isHiddenKey, .isWritableKey, .typeIdentifierKey, .generationIdentifierKey, .documentIdentifierKey])
@@ -49,6 +52,7 @@ public final class LocalFileObject: FileObject {
         }
     }
     
+    /// The total size allocated on disk for the file
     open internal(set) var allocatedSize: Int64 {
         get {
             return allValues[.fileAllocatedSizeKey] as? Int64 ?? 0
@@ -58,6 +62,9 @@ public final class LocalFileObject: FileObject {
         }
     }
     
+    /// The document identifier is a value assigned by the kernel/system to a file or directory. 
+    /// This value is used to identify the document regardless of where it is moved on a volume. 
+    /// The identifier persists across system restarts.
     open internal(set) var id: Int? {
         get {
             return allValues[.documentIdentifierKey] as? Int
@@ -67,6 +74,8 @@ public final class LocalFileObject: FileObject {
         }
     }
     
+    /// The revision of file, which changes when a file contents are modified. 
+    /// Changes to attributes or other file metadata do not change the identifier.
     open var rev: String? {
         get {
             let data = allValues[.generationIdentifierKey] as? Data
@@ -207,6 +216,7 @@ internal class LocalFileProviderManagerDelegate: NSObject, FileManagerDelegate {
     }
 }
 
+/// Local operation handling is limited. Please don't use as much as possible.
 open class LocalOperationHandle: OperationHandle {
     public let baseURL: URL
     public let operationType: FileOperationType

Sources/OneDriveFileProvide.swift

@@ -10,6 +10,13 @@
 import Foundation
 import CoreGraphics
 
+/**
+ Allows accessing to OneDrive stored files, either hosted on Microsoft servers or business coprporate one.
+ This provider doesn't cache or save files internally, however you can set `useCache` and `cache` properties
+ to use Foundation `NSURLCache` system.
+ 
+ - Note: Uploading files and data are limited to 100MB, for now.
+ */
 open class OneDriveFileProvider: FileProviderBasicRemote {
     open class var type: String { return "OneDrive" }
     open let isPathRelative: Bool
@@ -64,7 +71,7 @@ open class OneDriveFileProvider: FileProviderBasicRemote {
        - serverURL: server url, Set it if you are trying to connect OneDrive Business server, otherwise leave it
          `nil` to connect to OneDrive Personal uses.
        - drive: drive name for user on server, default value is `root`.
-       - cache: A URLCache to cache downloaded files and contents. If set to nil, URLCache.shared object will be used.
+       - cache: A URLCache to cache downloaded files and contents.
      */
     public init(credential: URLCredential?, serverURL: URL? = nil, drive: String = "root", cache: URLCache? = nil) {
         let baseURL = serverURL ?? URL(string: "https://api.onedrive.com/")!
@@ -132,6 +139,21 @@ open class OneDriveFileProvider: FileProviderBasicRemote {
         task.resume()
     }
     
+    open func searchFiles(path: String, recursive: Bool, query: NSPredicate, foundItemHandler: ((FileObject) -> Void)?, completionHandler: @escaping ((_ files: [FileObject], _ error: Error?) -> Void)) {
+        var foundFiles = [OneDriveFileObject]()
+        var queryStr: String?
+        queryStr = self.findNameQuery(query, key: "name") as? String ?? self.findNameQuery(query, key: nil) as? String
+        guard let finalQueryStr = queryStr else { return }
+        search(path, query: finalQueryStr, foundItem: { (file) in
+            if query.evaluate(with: file.mapPredicate()) {
+                foundFiles.append(file)
+                foundItemHandler?(file)
+            }
+        }, completionHandler: { (error) in
+            completionHandler(foundFiles, error)
+        })
+    }
+    
     open func isReachable(completionHandler: @escaping (Bool) -> Void) {
         let url = URL(string: "/drive/root", relativeTo: baseURL)!
         var request = URLRequest(url: url)
@@ -150,25 +172,25 @@ open class OneDriveFileProvider: FileProviderBasicRemote {
 extension OneDriveFileProvider: FileProviderOperations {
     
     
-    public func create(folder folderName: String, at atPath: String, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
+    open func create(folder folderName: String, at atPath: String, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
         let path = (atPath as NSString).appendingPathComponent(folderName) + "/"
         return doOperation(.create(path: path), completionHandler: completionHandler)
     }
     
-    public func create(file fileName: String, at path: String, contents data: Data?, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
+    open func create(file fileName: String, at path: String, contents data: Data?, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
         let filePath = (path as NSString).appendingPathComponent(fileName)
         return self.writeContents(path: filePath, contents: data ?? Data(), completionHandler: completionHandler)
     }
     
-    public func moveItem(path: String, to toPath: String, overwrite: Bool, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
+    open func moveItem(path: String, to toPath: String, overwrite: Bool, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
         return doOperation(.move(source: path, destination: toPath), completionHandler: completionHandler)
     }
     
-    public func copyItem(path: String, to toPath: String, overwrite: Bool, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
+    open func copyItem(path: String, to toPath: String, overwrite: Bool, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
         return doOperation(.copy(source: path, destination: toPath), completionHandler: completionHandler)
     }
     
-    public func removeItem(path: String, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
+    open func removeItem(path: String, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
         return doOperation(.remove(path: path), completionHandler: completionHandler)
     }
     
@@ -213,7 +235,7 @@ extension OneDriveFileProvider: FileProviderOperations {
         return RemoteOperationHandle(operationType: operation, tasks: [task])
     }
     
-    public func copyItem(localFile: URL, to toPath: String, overwrite: Bool, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
+    open func copyItem(localFile: URL, to toPath: String, overwrite: Bool, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
         let opType = FileOperationType.copy(source: localFile.absoluteString, destination: toPath)
         guard fileOperationDelegate?.fileProvider(self, shouldDoOperation: opType) ?? true == true else {
             return nil
@@ -221,7 +243,7 @@ extension OneDriveFileProvider: FileProviderOperations {
         return upload_simple(toPath, localFile: localFile, overwrite: overwrite, operation: opType, completionHandler: completionHandler)
     }
     
-    public func copyItem(path: String, toLocalURL destURL: URL, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
+    open func copyItem(path: String, toLocalURL destURL: URL, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
         let opType = FileOperationType.copy(source: path, destination: destURL.absoluteString)
         guard fileOperationDelegate?.fileProvider(self, shouldDoOperation: opType) ?? true == true else {
             return nil
@@ -252,7 +274,7 @@ extension OneDriveFileProvider: FileProviderOperations {
 }
 
 extension OneDriveFileProvider: FileProviderReadWrite {
-    public func contents(path: String, offset: Int64, length: Int, completionHandler: @escaping ((_ contents: Data?, _ error: Error?) -> Void)) -> OperationHandle? {
+    open func contents(path: String, offset: Int64, length: Int, completionHandler: @escaping ((_ contents: Data?, _ error: Error?) -> Void)) -> OperationHandle? {
         if length == 0 || offset < 0 {
             dispatch_queue.async {
                 completionHandler(Data(), nil)
@@ -283,7 +305,7 @@ extension OneDriveFileProvider: FileProviderReadWrite {
         return RemoteOperationHandle(operationType: opType, tasks: [task])
     }
     
-    public func writeContents(path: String, contents data: Data, atomically: Bool, overwrite: Bool, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
+    open func writeContents(path: String, contents data: Data, atomically: Bool, overwrite: Bool, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
         let opType = FileOperationType.modify(path: path)
         guard fileOperationDelegate?.fileProvider(self, shouldDoOperation: opType) ?? true == true else {
             return nil
@@ -292,16 +314,6 @@ extension OneDriveFileProvider: FileProviderReadWrite {
         return upload_simple(path, data: data, overwrite: overwrite, operation: opType, completionHandler: completionHandler)
     }
     
-    public func searchFiles(path: String, recursive: Bool, query: String, foundItemHandler: ((FileObject) -> Void)?, completionHandler: @escaping ((_ files: [FileObject], _ error: Error?) -> Void)) {
-        var foundFiles = [OneDriveFileObject]()
-        search(path, query: query, foundItem: { (file) in
-            foundFiles.append(file)
-            foundItemHandler?(file)
-            }, completionHandler: { (error) in
-                completionHandler(foundFiles, error)
-        })
-    }
-    
     fileprivate func registerNotifcation(path: String, eventHandler: (() -> Void)) {
         /* There is two ways to monitor folders changing in OneDrive. Either using webooks
          * which means you have to implement a server to translate it to push notifications
@@ -320,7 +332,7 @@ extension OneDriveFileProvider: FileProviderReadWrite {
      
      - Parameters:
        - to: path of file, including file/directory name.
-       - completionHandler: a block with result of directory entries or error.
+       - completionHandler: a closure with result of directory entries or error.
          `link`: a url returned by OneDrive to share.
          `attribute`: `nil` for OneDrive.
          `expiration`: `nil` for OneDrive, as it doesn't expires.
@@ -353,11 +365,11 @@ extension OneDriveFileProvider: FileProviderReadWrite {
 
 
 extension OneDriveFileProvider: ExtendedFileProvider {
-    public func thumbnailOfFileSupported(path: String) -> Bool {
+    open func thumbnailOfFileSupported(path: String) -> Bool {
         return true
     }
     
-    public func propertiesOfFileSupported(path: String) -> Bool {
+    open func propertiesOfFileSupported(path: String) -> Bool {
         let fileExt = (path as NSString).pathExtension.lowercased()
         switch fileExt {
         case "jpg", "jpeg", "bmp", "gif", "png", "tif", "tiff":
@@ -371,7 +383,7 @@ extension OneDriveFileProvider: ExtendedFileProvider {
         }
     }
     
-    public func thumbnailOfFile(path: String, dimension: CGSize?, completionHandler: @escaping ((_ image: ImageClass?, _ error: Error?) -> Void)) {
+    open func thumbnailOfFile(path: String, dimension: CGSize?, completionHandler: @escaping ((_ image: ImageClass?, _ error: Error?) -> Void)) {
         let url: URL
         if let dimension = dimension {
             url = URL(string: escaped(path: path) + ":/thumbnails/0/=c\(dimension.width)x\(dimension.height)/content", relativeTo: driveURL)!
@@ -396,7 +408,7 @@ extension OneDriveFileProvider: ExtendedFileProvider {
         task.resume()
     }
     
-    public func propertiesOfFile(path: String, completionHandler: @escaping ((_ propertiesDictionary: [String : Any], _ keys: [String], _ error: Error?) -> Void)) {
+    open func propertiesOfFile(path: String, completionHandler: @escaping ((_ propertiesDictionary: [String : Any], _ keys: [String], _ error: Error?) -> Void)) {
         let url = URL(string: escaped(path: path), relativeTo: driveURL)!
         var request = URLRequest(url: url)
         request.httpMethod = "GET"

Sources/OneDriveHelper.swift

@@ -8,12 +8,14 @@
 
 import Foundation
 
+/// Error returned by OneDrive server when trying to access or do operations on a file or folder.
 public struct FileProviderOneDriveError: FileProviderHTTPError {
     public let code: FileProviderHTTPErrorCode
     public let path: String
     public let errorDescription: String?
 }
 
+/// Containts path, url and attributes of a OneDrive file or resource.
 public final class OneDriveFileObject: FileObject {
     internal init(baseURL: URL?, name: String, path: String) {
         var rpath = path
@@ -42,6 +44,9 @@ public final class OneDriveFileObject: FileObject {
         self.entryTag = json["eTag"] as? String
     }
     
+    /// The document identifier is a value assigned by the OneDrive to a file.
+    /// This value is used to identify the document regardless of where it is moved on a volume.
+    /// The identifier persists across system restarts.
     open internal(set) var id: String? {
         get {
             return allValues[.documentIdentifierKey] as? String
@@ -51,6 +56,7 @@ public final class OneDriveFileObject: FileObject {
         }
     }
     
+    /// MIME type of file contents returned by OneDrive server.
     open internal(set) var contentType: String {
         get {
             return allValues[.mimeType] as? String ?? ""
@@ -60,6 +66,7 @@ public final class OneDriveFileObject: FileObject {
         }
     }
     
+    /// HTTP E-Tag, can be used to mark changed files.
     open internal(set) var entryTag: String? {
         get {
             return allValues[.entryTag] as? String

Sources/RemoteSession.swift

@@ -8,6 +8,7 @@
 
 import Foundation
 
+/// Allows to get progress or cancel an in-progress operation, for remote, `URLSession` based providers.
 open class RemoteOperationHandle: OperationHandle {
     
     internal var tasks: [Weak<URLSessionTask>]
@@ -42,7 +43,7 @@ open class RemoteOperationHandle: OperationHandle {
             if let task = $1.value as? URLSessionUploadTask {
                 return $0 + task.countOfBytesExpectedToSend
             } else {
-                return $0 + ($1.value?.countOfBytesExpectedToSend ?? 0)
+                return $0 + ($1.value?.countOfBytesExpectedToReceive ?? 0)
             }
         }
     }
@@ -61,12 +62,15 @@ open class RemoteOperationHandle: OperationHandle {
     }
 }
 
+/// A protocol defines properties for errors returned by HTTP/S based providers.
+/// Including Dropbox, OneDrive and WebDAV.
 public protocol FileProviderHTTPError: Error, CustomStringConvertible {
+    /// HTTP status code returned for error by server.
     var code: FileProviderHTTPErrorCode { get }
+    /// Path of file/folder casued that error
     var path: String { get }
+    /// Contents returned by server as error description
     var errorDescription: String? { get }
-    
-    var description: String { get }
 }
 
 extension FileProviderHTTPError {
@@ -152,67 +156,129 @@ class SessionDelegate: NSObject, URLSessionDataDelegate, URLSessionDownloadDeleg
     }
 }
 
-public enum FileProviderHTTPErrorCode: Int {
+/// HTTP status codes as an enum.
+public enum FileProviderHTTPErrorCode: Int, CustomStringConvertible {
+    /// `Continue` informational status with HTTP code 100
     case `continue` = 100
+    /// `Switching Protocols` informational status with HTTP code 101
     case switchingProtocols = 101
+    /// `Processing` informational status with HTTP code 102
     case processing = 102
+    /// `OK` success status with HTTP code 200
     case ok = 200
+    /// `Created` success status with HTTP code 201
     case created = 201
+    /// `Accepted` success status with HTTP code 202
     case accepted = 202
+    /// `Non Authoritative Information` success status with HTTP code 203
     case nonAuthoritativeInformation = 203
+    /// `No Content` success status with HTTP code 204
     case noContent = 204
+    /// `ResetcContent` success status with HTTP code 205
     case resetContent = 205
+    /// `Partial Content` success status with HTTP code 206
     case partialContent = 206
+    /// `Multi Status` success status with HTTP code 207
     case multiStatus = 207
+    /// `Already Reported` success status with HTTP code 208
     case alreadyReported = 208
+    /// `IM Used` success status with HTTP code 226
     case imUsed = 226
+    /// `Multiple Choices` redirection status with HTTP code 300
     case multipleChoices = 300
+    /// `Moved Permanently` redirection status with HTTP code 301
     case movedPermanently = 301
+    /// `Found` redirection status with HTTP code 302
     case found = 302
+    /// `See Other` redirection status with HTTP code 303
     case seeOther = 303
+    /// `Not Modified` redirection status with HTTP code 304
     case notModified = 304
+    /// `Use Proxy` redirection status with HTTP code 305
     case useProxy = 305
+    /// `Switch Proxy` redirection status with HTTP code 306
     case switchProxy = 306
+    /// `Temporary Redirect` redirection status with HTTP code 307
     case temporaryRedirect = 307
+    /// `Permanent Redirect` redirection status with HTTP code 308
     case permanentRedirect = 308
+    /// `Bad Request` client error status with HTTP code 400
     case badRequest = 400
+    /// `Unauthorized` client error status with HTTP code 401
     case unauthorized = 401
+    /// `Payment Required` client error status with HTTP code 402
     case paymentRequired = 402
+    /// `Forbidden` client error status with HTTP code 403
     case forbidden = 403
+    /// `Not Found` client error status with HTTP code 404
     case notFound = 404
+    /// `Method Not Allowed` client error status with HTTP code 405
     case methodNotAllowed = 405
+    /// `Not Acceptable` client error status with HTTP code 406
     case notAcceptable = 406
+    /// `Proxy Authentication Required` client error status with HTTP code 407
     case proxyAuthenticationRequired = 407
+    /// `Request Timeout` client error status with HTTP code 408
     case requestTimeout = 408
+    /// `Conflict` client error status with HTTP code 409
     case conflict = 409
+    /// `Gone` client error status with HTTP code 410
     case gone = 410
+    /// `Length Required` client error status with HTTP code 411
     case lengthRequired = 411
+    /// `Precondition Failed` client error status with HTTP code 412
     case preconditionFailed = 412
+    /// `Payload Too Large` client error status with HTTP code 413
     case payloadTooLarge = 413
+    /// `URI Too Long` client error status with HTTP code 414
     case uriTooLong = 414
+    /// `Unsupported Media Type` status with HTTP code 415
     case unsupportedMediaType = 415
+    /// `Range Not Satisfiable` client error status with HTTP code 416
     case rangeNotSatisfiable = 416
+    /// `Expectation Failed` client error status with HTTP code 417
     case expectationFailed = 417
+    /// `Misdirected Request` client error status with HTTP code 421
     case misdirectedRequest = 421
+    /// `Unprocessable Entity` client error status with HTTP code 422
     case unprocessableEntity = 422
+    /// `Locked` client error status with HTTP code 423
     case locked = 423
+    /// `Failed Dependency` client error status with HTTP code 424
     case failedDependency = 424
+    /// `Unordered Collection` client error status with HTTP code 425
     case unorderedCollection = 425
+    /// `Upgrade Required` client error status with HTTP code 426
     case upgradeRequired = 426
+    /// `Precondition Required` client error status with HTTP code 428
     case preconditionRequired = 428
+    /// `Too Many Requests` client error status with HTTP code 429
     case tooManyRequests = 429
+    /// `Request Header Fields Too Large` client error status with HTTP code 431
     case requestHeaderFieldsTooLarge = 431
+    /// `Unavailable For Legal Reasons` client error status with HTTP code 451
     case unavailableForLegalReasons = 451
+    /// `Internal Server Error` server error status with HTTP code 500
     case internalServerError = 500
+    /// `Bad Gateway` server error status with HTTP code 502
     case badGateway = 502
+    /// `Service Unavailable` server error status with HTTP code 503
     case serviceUnavailable = 503
+    /// `Gateway Timeout` server error status with HTTP code 504
     case gatewayTimeout = 504
+    /// `HTTP Version Not Supported` server error status with HTTP code 505
     case httpVersionNotSupported = 505
-    case variantlsoNegotiates = 506
+    /// `Variant Also Negotiates` server error status with HTTP code 506
+    case variantAlsoNegotiates = 506
+    /// `Insufficient Storage` server error status with HTTP code 507
     case insufficientStorage = 507
+    /// `Loop Detected` server error status with HTTP code 508
     case loopDetected = 508
+    /// `Bandwidth Limit Exceeded` server error status with HTTP code 509
     case bandwidthLimitExceeded = 509
+    /// `Not Extended` server error status with HTTP code 510
     case notExtended = 510
+    /// `Network Authentication Required` server error status with HTTP code 511
     case networkAuthenticationRequired = 511
     
     fileprivate static let status1xx: [Int: String] = [100: "Continue", 101: "Switching Protocols", 102: "Processing"]
@@ -233,6 +299,7 @@ public enum FileProviderHTTPErrorCode: Int {
         }
     }
     
+    /// Description of status based on first digit which indicated fail or success.
     public var typeDescription: String {
         switch self.rawValue {
         case 100...199: return "Informational"
@@ -240,7 +307,7 @@ public enum FileProviderHTTPErrorCode: Int {
         case 300...399: return "Redirection"
         case 400...499: return "Client Error"
         case 500...599: return "Server Error"
-        default: return "Server Error"
+        default: return "Unknown Error"
         }
     }
 }

Sources/SMBFileProvider.swift

@@ -100,7 +100,7 @@ class SMBFileProvider: FileProvider, FileProviderMonitor {
         return nil
     }
     
-    open func searchFiles(path: String, recursive: Bool, query: String, foundItemHandler:((FileObjectClass) -> Void)?, completionHandler: @escaping ((_ files: [FileObjectClass], _ error: Error?) -> Void)) {
+    open func searchFiles(path: String, recursive: Bool, query: NSPredicate, foundItemHandler:((FileObjectClass) -> Void)?, completionHandler: @escaping ((_ files: [FileObjectClass], _ error: Error?) -> Void)) {
         NotImplemented()
     }
     
@@ -126,7 +126,7 @@ class SMBFileProvider: FileProvider, FileProviderMonitor {
 }
 
 // MARK: basic CIFS interactivity
-public enum SMBFileProviderError: Int, Error, CustomStringConvertible {
+enum SMBFileProviderError: Int, Error, CustomStringConvertible {
     case badHeader
     case incompatibleHeader
     case incorrectParamsLength

Sources/WebDAVFileProvider.swift

@@ -8,9 +8,17 @@
 
 import Foundation
 
-/// Because this class uses NSURLSession, it's necessary to disable App Transport Security
-/// in case of using this class with unencrypted HTTP connection.
-
+/**
+ Allows accessing to WebDAV server files. This provider doesn't cache or save files internally, however you can
+ set `useCache` and `cache` properties to use Foundation `NSURLCache` system.
+ 
+ WebDAV system supported by many cloud services including [Box.net](https://www.box.com/home) 
+ and [Yandex disk](https://disk.yandex.com) and [ownCloud](https://owncloud.org).
+ 
+ - Important: Because this class uses `URLSession`, it's necessary to disable App Transport Security
+     in case of using this class with unencrypted HTTP connection.
+     [Read this to know how](http://iosdevtips.co/post/121756573323/ios-9-xcode-7-http-connect-server-error).
+*/
 open class WebDAVFileProvider: FileProviderBasicRemote {
     open class var type: String { return "WebDAV" }
     open let isPathRelative: Bool
@@ -51,7 +59,7 @@ open class WebDAVFileProvider: FileProviderBasicRemote {
      - Parameters:
        - baseURL: Location of WebDAV server.
        - credential: An `URLCredential` object with `user` and `password`.
-       - cache: A URLCache to cache downloaded files and contents. If set to nil, URLCache.shared object will be used.
+       - cache: A URLCache to cache downloaded files and contents.
     */
     public init? (baseURL: URL, credential: URLCredential?, cache: URLCache? = nil) {
         if  !["http", "https"].contains(baseURL.uw_scheme.lowercased()) {
@@ -156,6 +164,38 @@ open class WebDAVFileProvider: FileProviderBasicRemote {
         })
     }
     
+    open func searchFiles(path: String, recursive: Bool, query: NSPredicate, foundItemHandler: ((FileObject) -> Void)?, completionHandler: @escaping ((_ files: [FileObject], _ error: Error?) -> Void)) {
+        let url = self.url(of: path)
+        var request = URLRequest(url: url)
+        request.httpMethod = "PROPFIND"
+        //request.setValue("1", forHTTPHeaderField: "Depth")
+        request.setValue("text/xml; charset=\"utf-8\"", forHTTPHeaderField: "Content-Type")
+        request.httpBody = "<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n<D:propfind xmlns:D=\"DAV:\">\n<D:allprop/></D:propfind>".data(using: .utf8)
+        runDataTask(with: request, completionHandler: { (data, response, error) in
+            // FIXME: paginating results
+            var responseError: FileProviderWebDavError?
+            if let code = (response as? HTTPURLResponse)?.statusCode , code >= 300, let rCode = FileProviderHTTPErrorCode(rawValue: code) {
+                responseError = FileProviderWebDavError(code: rCode, path: path, errorDescription: String(data: data ?? Data(), encoding: .utf8), url: url)
+            }
+            if let data = data {
+                let xresponse = DavResponse.parse(xmlResponse: data, baseURL: self.baseURL)
+                var fileObjects = [WebDavFileObject]()
+                for attr in xresponse {
+                    let fileObject = WebDavFileObject(attr)
+                    if !query.evaluate(with: fileObject.mapPredicate()) {
+                        continue
+                    }
+                    
+                    fileObjects.append(fileObject)
+                    foundItemHandler?(fileObject)
+                }
+                completionHandler(fileObjects, responseError ?? error)
+                return
+            }
+            completionHandler([], responseError ?? error)
+        })
+    }
+    
     open func isReachable(completionHandler: @escaping (Bool) -> Void) {
         var request = URLRequest(url: baseURL!)
         request.httpMethod = "PROPFIND"
@@ -174,7 +214,7 @@ open class WebDAVFileProvider: FileProviderBasicRemote {
 
 extension WebDAVFileProvider: FileProviderOperations {
     @discardableResult
-    public func create(folder folderName: String, at atPath: String, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
+    open func create(folder folderName: String, at atPath: String, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
         let opType = FileOperationType.create(path: (atPath as NSString).appendingPathComponent(folderName) + "/")
         guard fileOperationDelegate?.fileProvider(self, shouldDoOperation: opType) ?? true == true else {
             return nil
@@ -196,7 +236,7 @@ extension WebDAVFileProvider: FileProviderOperations {
     }
     
     @discardableResult
-    public func create(file fileName: String, at path: String, contents data: Data?, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
+    open func create(file fileName: String, at path: String, contents data: Data?, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
         let opType = FileOperationType.create(path: (path as NSString).appendingPathComponent(fileName))
         guard fileOperationDelegate?.fileProvider(self, shouldDoOperation: opType) ?? true == true else {
             return nil
@@ -218,7 +258,7 @@ extension WebDAVFileProvider: FileProviderOperations {
     }
     
     @discardableResult
-    public func moveItem(path: String, to toPath: String, overwrite: Bool = false, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
+    open func moveItem(path: String, to toPath: String, overwrite: Bool = false, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
         let opType = FileOperationType.move(source: path, destination: toPath)
         guard fileOperationDelegate?.fileProvider(self, shouldDoOperation: opType) ?? true == true else {
             return nil
@@ -227,7 +267,7 @@ extension WebDAVFileProvider: FileProviderOperations {
     }
     
     @discardableResult
-    public func copyItem(path: String, to toPath: String, overwrite: Bool = false, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
+    open func copyItem(path: String, to toPath: String, overwrite: Bool = false, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
         let opType = FileOperationType.copy(source: path, destination: toPath)
         guard fileOperationDelegate?.fileProvider(self, shouldDoOperation: opType) ?? true == true else {
             return nil
@@ -236,7 +276,7 @@ extension WebDAVFileProvider: FileProviderOperations {
     }
     
     @discardableResult
-    public func removeItem(path: String, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
+    open func removeItem(path: String, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
         let opType = FileOperationType.remove(path: path)
         guard fileOperationDelegate?.fileProvider(self, shouldDoOperation: opType) ?? true == true else {
             return nil
@@ -291,7 +331,7 @@ extension WebDAVFileProvider: FileProviderOperations {
     }
     
     @discardableResult
-    public func copyItem(localFile: URL, to toPath: String, overwrite: Bool, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
+    open func copyItem(localFile: URL, to toPath: String, overwrite: Bool, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
         let opType = FileOperationType.copy(source: localFile.absoluteString, destination: toPath)
         guard fileOperationDelegate?.fileProvider(self, shouldDoOperation: opType) ?? true == true else {
             return nil
@@ -316,7 +356,7 @@ extension WebDAVFileProvider: FileProviderOperations {
     }
     
     @discardableResult
-    public func copyItem(path: String, toLocalURL: URL, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
+    open func copyItem(path: String, toLocalURL: URL, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
         let opType = FileOperationType.copy(source: path, destination: toLocalURL.absoluteString)
         guard fileOperationDelegate?.fileProvider(self, shouldDoOperation: opType) ?? true == true else {
             return nil
@@ -347,7 +387,7 @@ extension WebDAVFileProvider: FileProviderOperations {
 
 extension WebDAVFileProvider: FileProviderReadWrite {
     @discardableResult
-    public func contents(path: String, offset: Int64, length: Int, completionHandler: @escaping ((_ contents: Data?, _ error: Error?) -> Void)) -> OperationHandle? {
+    open func contents(path: String, offset: Int64, length: Int, completionHandler: @escaping ((_ contents: Data?, _ error: Error?) -> Void)) -> OperationHandle? {
         if length == 0 || offset < 0 {
             dispatch_queue.async {
                 completionHandler(Data(), nil)
@@ -376,7 +416,7 @@ extension WebDAVFileProvider: FileProviderReadWrite {
     }
     
     @discardableResult
-    public func writeContents(path: String, contents data: Data, atomically: Bool, overwrite: Bool, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
+    open func writeContents(path: String, contents data: Data, atomically: Bool, overwrite: Bool, completionHandler: SimpleCompletionHandler) -> OperationHandle? {
         let opType = FileOperationType.modify(path: path)
         guard fileOperationDelegate?.fileProvider(self, shouldDoOperation: opType) ?? true == true else {
             return nil
@@ -409,38 +449,7 @@ extension WebDAVFileProvider: FileProviderReadWrite {
         return RemoteOperationHandle(operationType: opType, tasks: [task])
     }
     
-    public func searchFiles(path: String, recursive: Bool, query: String, foundItemHandler: ((FileObject) -> Void)?, completionHandler: @escaping ((_ files: [FileObject], _ error: Error?) -> Void)) {
-        let url = self.url(of: path)
-        var request = URLRequest(url: url)
-        request.httpMethod = "PROPFIND"
-        //request.setValue("1", forHTTPHeaderField: "Depth")
-        request.setValue("text/xml; charset=\"utf-8\"", forHTTPHeaderField: "Content-Type")
-        request.httpBody = "<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n<D:propfind xmlns:D=\"DAV:\">\n<D:allprop/></D:propfind>".data(using: .utf8)
-        runDataTask(with: request, completionHandler: { (data, response, error) in
-            // FIXME: paginating results
-            var responseError: FileProviderWebDavError?
-            if let code = (response as? HTTPURLResponse)?.statusCode , code >= 300, let rCode = FileProviderHTTPErrorCode(rawValue: code) {
-                responseError = FileProviderWebDavError(code: rCode, path: path, errorDescription: String(data: data ?? Data(), encoding: .utf8), url: url)
-            }
-            if let data = data {
-                let xresponse = DavResponse.parse(xmlResponse: data, baseURL: self.baseURL)
-                var fileObjects = [WebDavFileObject]()
-                for attr in xresponse {
-                    let path = attr.href.path
-                    if !((path as NSString).lastPathComponent.contains(query)) {
-                        continue
-                    }
-                    let fileObject = WebDavFileObject(attr)
-                    fileObjects.append(fileObject)
-                    foundItemHandler?(fileObject)
-                }
-                completionHandler(fileObjects, responseError ?? error)
-                return
-            }
-            completionHandler([], responseError ?? error)
-        })
-    }
-    
+    /*
     fileprivate func registerNotifcation(path: String, eventHandler: (() -> Void)) {
         /* There is no unified api for monitoring WebDAV server content change/update
          * Microsoft Exchange uses SUBSCRIBE method, Apple uses push notification system.
@@ -452,7 +461,7 @@ extension WebDAVFileProvider: FileProviderReadWrite {
     }
     fileprivate func unregisterNotifcation(path: String) {
         NotImplemented()
-    }
+    }*/
     // TODO: implements methods for lock mechanism
 }
 
@@ -580,6 +589,7 @@ struct DavResponse {
     }
 }
 
+/// Containts path, url and attributes of a WebDAV file or resource.
 public final class WebDavFileObject: FileObject {
     internal init(_ davResponse: DavResponse) {
         let href = davResponse.href
@@ -596,7 +606,7 @@ public final class WebDavFileObject: FileObject {
         self.entryTag = davResponse.prop["getetag"]
     }
     
-    /// MIME type of the file
+    /// MIME type of the file.
     open internal(set) var contentType: String {
         get {
             return allValues[.mimeType] as? String ?? ""
@@ -606,7 +616,7 @@ public final class WebDavFileObject: FileObject {
         }
     }
     
-    /// HTTP E-Tag, can be used to mark changed files
+    /// HTTP E-Tag, can be used to mark changed files.
     open internal(set) var entryTag: String? {
         get {
             return allValues[.entryTag] as? String
@@ -617,9 +627,11 @@ public final class WebDavFileObject: FileObject {
     }
 }
 
+/// Error returned by WebDAV server when trying to access or do operations on a file or folder.
 public struct FileProviderWebDavError: FileProviderHTTPError {
     public let code: FileProviderHTTPErrorCode
     public let path: String
     public let errorDescription: String?
+    /// URL of resource caused error.
     public let url: URL
 }