Flatten file directories (fixes #159)

Sources/CSSQliteStore.swift

@@ -0,0 +1,210 @@
+//
+//  CSSQLiteStore.swift
+//  CoreStore
+//
+//  Copyright © 2016 John Rommel Estropia
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in all
+//  copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+//  SOFTWARE.
+//
+
+import Foundation
+import CoreData
+
+
+// MARK: - CSSQLiteStore
+
+/**
+ The `CSSQLiteStore` serves as the Objective-C bridging type for `SQLiteStore`.
+ 
+ - SeeAlso: `SQLiteStore`
+ */
+@objc
+public final class CSSQLiteStore: NSObject, CSLocalStorage, CoreStoreObjectiveCType {
+    
+    /**
+     Initializes an SQLite store interface from the given SQLite file URL. When this instance is passed to the `CSDataStack`'s `-addStorage*:` methods, a new SQLite file will be created if it does not exist.
+     
+     - parameter fileURL: the local file URL for the target SQLite persistent store. Note that if you have multiple configurations, you will need to specify a different `fileURL` explicitly for each of them.
+     - parameter configuration: an optional configuration name from the model file. If not specified, defaults to `nil`, the "Default" configuration. Note that if you have multiple configurations, you will need to specify a different `fileURL` explicitly for each of them.
+     - parameter mappingModelBundles: a list of `NSBundle`s from which to search mapping models for migration.
+     - parameter localStorageOptions: When the `CSSQLiteStore` is passed to the `CSDataStack`'s `addStorage()` methods, tells the `CSDataStack` how to setup the persistent store. Defaults to `CSLocalStorageOptionsNone`.
+     */
+    @objc
+    public convenience init(fileURL: URL, configuration: String?, mappingModelBundles: [Bundle]?, localStorageOptions: Int) {
+        
+        self.init(
+            SQLiteStore(
+                fileURL: fileURL,
+                configuration: configuration,
+                mappingModelBundles: mappingModelBundles ?? Bundle.allBundles,
+                localStorageOptions: LocalStorageOptions(rawValue: localStorageOptions)
+            )
+        )
+    }
+    
+    /**
+     Initializes an SQLite store interface from the given SQLite file name. When this instance is passed to the `CSDataStack`'s `-addStorage*:` methods, a new SQLite file will be created if it does not exist.
+     
+     - Warning: The default SQLite file location for the `CSLegacySQLiteStore` and `CSSQLiteStore` are different. If the app was depending on CoreStore's default directories prior to 2.0.0, make sure to use `CSLegacySQLiteStore` instead of `CSSQLiteStore`.
+     - parameter fileName: the local filename for the SQLite persistent store in the "Application Support/<bundle id>" directory (or the "Caches/<bundle id>" directory on tvOS). Note that if you have multiple configurations, you will need to specify a different `fileName` explicitly for each of them.
+     - parameter configuration: an optional configuration name from the model file. If not specified, defaults to `nil`, the "Default" configuration. Note that if you have multiple configurations, you will need to specify a different `fileName` explicitly for each of them.
+     - parameter mappingModelBundles: a list of `NSBundle`s from which to search mapping models for migration
+     - parameter localStorageOptions: When the `CSSQLiteStore` is passed to the `CSDataStack`'s `addStorage()` methods, tells the `CSDataStack` how to setup the persistent store. Defaults to `[CSLocalStorageOptions none]`.
+     */
+    @objc
+    public convenience init(fileName: String, configuration: String?, mappingModelBundles: [Bundle]?, localStorageOptions: Int) {
+        
+        self.init(
+            SQLiteStore(
+                fileName: fileName,
+                configuration: configuration,
+                mappingModelBundles: mappingModelBundles ?? Bundle.allBundles,
+                localStorageOptions: LocalStorageOptions(rawValue: localStorageOptions)
+            )
+        )
+    }
+    
+    /**
+     Initializes an `CSSQLiteStore` with an all-default settings: a `fileURL` pointing to a "<Application name>.sqlite" file in the "Application Support/<bundle id>" directory (or the "Caches/<bundle id>" directory on tvOS), a `nil` `configuration` pertaining to the "Default" configuration, a `mappingModelBundles` set to search all `NSBundle`s, and `localStorageOptions` set to `.AllowProgresiveMigration`.
+     
+     - Warning: The default SQLite file location for the `CSLegacySQLiteStore` and `CSSQLiteStore` are different. If the app was depending on CoreStore's default directories prior to 2.0.0, make sure to use `CSLegacySQLiteStore` instead of `CSSQLiteStore`.
+     */
+    @objc
+    public convenience override init() {
+        
+        self.init(SQLiteStore())
+    }
+    
+    
+    // MAKR: CSLocalStorage
+    
+    /**
+     The `NSURL` that points to the SQLite file
+     */
+    @objc
+    public var fileURL: URL {
+     
+        return self.bridgeToSwift.fileURL as URL
+    }
+    
+    /**
+     The `NSBundle`s from which to search mapping models for migrations
+     */
+    @objc
+    public var mappingModelBundles: [Bundle] {
+        
+        return self.bridgeToSwift.mappingModelBundles
+    }
+    
+    /**
+     Options that tell the `CSDataStack` how to setup the persistent store
+     */
+    @objc
+    public var localStorageOptions: Int {
+        
+        return self.bridgeToSwift.localStorageOptions.rawValue
+    }
+    
+    
+    // MARK: CSStorageInterface
+    
+    /**
+     The string identifier for the `NSPersistentStore`'s `type` property. For `CSSQLiteStore`s, this is always set to `NSSQLiteStoreType`.
+     */
+    @objc
+    public static let storeType = NSSQLiteStoreType
+    
+    /**
+     The configuration name in the model file
+     */
+    public var configuration: String? {
+        
+        return self.bridgeToSwift.configuration
+    }
+    
+    /**
+     The options dictionary for the `NSPersistentStore`. For `CSSQLiteStore`s, this is always set to
+     ```
+     [NSSQLitePragmasOption: ["journal_mode": "WAL"]]
+     ```
+     */
+    @objc
+    public var storeOptions: [AnyHashable: Any]? {
+        
+        return self.bridgeToSwift.storeOptions
+    }
+    
+    /**
+     Called by the `CSDataStack` to perform actual deletion of the store file from disk. Do not call directly! The `sourceModel` argument is a hint for the existing store's model version. For `CSSQLiteStore`, this converts the database's WAL journaling mode to DELETE before deleting the file.
+     */
+    @objc
+    public func eraseStorageAndWait(metadata: NSDictionary, soureModelHint: NSManagedObjectModel?, error: NSErrorPointer) -> Bool {
+        
+        return bridge(error) {
+            
+            try self.bridgeToSwift.eraseStorageAndWait(metadata: metadata as! [String: Any], soureModelHint: soureModelHint)
+        }
+    }
+    
+    
+    // MARK: NSObject
+    
+    public override var hash: Int {
+        
+        return ObjectIdentifier(self.bridgeToSwift).hashValue
+    }
+    
+    public override func isEqual(_ object: Any?) -> Bool {
+        
+        guard let object = object as? CSSQLiteStore else {
+            
+            return false
+        }
+        return self.bridgeToSwift === object.bridgeToSwift
+    }
+    
+    public override var description: String {
+        
+        return "(\(String(reflecting: type(of: self)))) \(self.bridgeToSwift.coreStoreDumpString)"
+    }
+    
+    
+    // MARK: CoreStoreObjectiveCType
+    
+    public let bridgeToSwift: SQLiteStore
+    
+    public required init(_ swiftValue: SQLiteStore) {
+        
+        self.bridgeToSwift = swiftValue
+        super.init()
+    }
+}
+
+
+// MARK: - SQLiteStore
+
+extension SQLiteStore: CoreStoreSwiftType {
+    
+    // MARK: CoreStoreSwiftType
+    
+    public var bridgeToObjectiveC: CSSQLiteStore {
+        
+        return CSSQLiteStore(self)
+    }
+}