README done! Welcome to CoreStore 4.0!

2026-03-22 01:19:16 +01:00 · 2017-05-24 12:05:34 +09:00
parent d669569196
commit 35885b40de
11 changed files with 242 additions and 69 deletions
--- a/Sources/CSSQliteStore.swift
+++ b/Sources/CSSQliteStore.swift
@@ -78,7 +78,7 @@ public final class CSSQLiteStore: NSObject, CSLocalStorage, CoreStoreObjectiveCT
    }
    
    /**
-     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 `[CSLocalStorageOptions none]`.
+     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, and `localStorageOptions` set to `[CSLocalStorageOptions none]`.
     
     - Important: Initializing `CSSQLiteStore`s with custom migration mapping models is currently not supported. Create an `SQLiteStore` instance from Swift code and bridge the instance to Objective-C using its `SQLiteStore.bridgeToObjectiveC` property.
     */
--- a/Sources/CSLegacyXcodeDataModelSchema.swift
+++ b/Sources/CSLegacyXcodeDataModelSchema.swift
@@ -1,5 +1,5 @@
 //
-//  CSLegacyXcodeDataModelSchema.swift
+//  CSUnsafeDataModelSchema.swift
 //  CoreStore
 //
 //  Copyright © 2017 John Rommel Estropia
@@ -27,18 +27,18 @@ import CoreData
 import Foundation


-// MARK: - CSLegacyXcodeDataModelSchema
+// MARK: - CSUnsafeDataModelSchema

 /**
- The `CSLegacyXcodeDataModelSchema` serves as the Objective-C bridging type for `LegacyXcodeDataModelSchema`.
+ The `CSUnsafeDataModelSchema` serves as the Objective-C bridging type for `UnsafeDataModelSchema`.
 
- - SeeAlso: `LegacyXcodeDataModelSchema`
+ - SeeAlso: `UnsafeDataModelSchema`
 */
@objc
-public final class CSLegacyXcodeDataModelSchema: NSObject, CSDynamicSchema, CoreStoreObjectiveCType {
+public final class CSUnsafeDataModelSchema: NSObject, CSDynamicSchema, CoreStoreObjectiveCType {
    
    /**
-     Initializes a `CSLegacyXcodeDataModelSchema` from an `NSManagedObjectModel`.
+     Initializes a `CSUnsafeDataModelSchema` from an `NSManagedObjectModel`.
     
     - parameter modelName: the model version, typically the file name of an *.xcdatamodeld file (without the file extension)
     - parameter model: the `NSManagedObjectModel`
@@ -46,7 +46,7 @@ public final class CSLegacyXcodeDataModelSchema: NSObject, CSDynamicSchema, Core
    @objc
    public required init(modelName: ModelVersion, model: NSManagedObjectModel) {
        
-        self.bridgeToSwift = LegacyXcodeDataModelSchema(
+        self.bridgeToSwift = UnsafeDataModelSchema(
            modelName: modelName,
            model: model
        )
@@ -62,7 +62,7 @@ public final class CSLegacyXcodeDataModelSchema: NSObject, CSDynamicSchema, Core
    
    public override func isEqual(_ object: Any?) -> Bool {
        
-        guard let object = object as? CSLegacyXcodeDataModelSchema else {
+        guard let object = object as? CSUnsafeDataModelSchema else {
            
            return false
        }
@@ -92,9 +92,9 @@ public final class CSLegacyXcodeDataModelSchema: NSObject, CSDynamicSchema, Core
    
    // MARK: CoreStoreObjectiveCType
    
-    public let bridgeToSwift: LegacyXcodeDataModelSchema
+    public let bridgeToSwift: UnsafeDataModelSchema
    
-    public required init(_ swiftValue: LegacyXcodeDataModelSchema) {
+    public required init(_ swiftValue: UnsafeDataModelSchema) {
        
        self.bridgeToSwift = swiftValue
        super.init()
@@ -102,14 +102,14 @@ public final class CSLegacyXcodeDataModelSchema: NSObject, CSDynamicSchema, Core
 }


-// MARK: - LegacyXcodeDataModelSchema
+// MARK: - UnsafeDataModelSchema

-extension LegacyXcodeDataModelSchema: CoreStoreSwiftType {
+extension UnsafeDataModelSchema: CoreStoreSwiftType {
    
    // MARK: CoreStoreSwiftType
    
-    public var bridgeToObjectiveC: CSLegacyXcodeDataModelSchema {
+    public var bridgeToObjectiveC: CSUnsafeDataModelSchema {
        
-        return CSLegacyXcodeDataModelSchema(self)
+        return CSUnsafeDataModelSchema(self)
    }
 }
--- a/Sources/CoreStore+CustomDebugStringConvertible.swift
+++ b/Sources/CoreStore+CustomDebugStringConvertible.swift
@@ -374,9 +374,9 @@ extension Into: CustomDebugStringConvertible, CoreStoreDebugStringConvertible {
 }


-// MARK: - LegacyXcodeDataModelSchema
+// MARK: - UnsafeDataModelSchema

-extension LegacyXcodeDataModelSchema: CustomDebugStringConvertible, CoreStoreDebugStringConvertible {
+extension UnsafeDataModelSchema: CustomDebugStringConvertible, CoreStoreDebugStringConvertible {
    
    // MARK: CustomDebugStringConvertible
    
--- a/Sources/DataStack.swift
+++ b/Sources/DataStack.swift
@@ -624,14 +624,14 @@ public final class DataStack: Equatable {
    }
    
    
-    @available(*, deprecated, message: "Use the new DataStack.init(schemaHistory:) initializer passing a LegacyXcodeDataModelSchema instance as argument")
+    @available(*, deprecated, message: "Use the new DataStack.init(schemaHistory:) initializer passing an UnsafeDataModelSchema instance as argument")
    public convenience init(model: NSManagedObjectModel, migrationChain: MigrationChain = nil) {
        
        let modelVersion = migrationChain.leafVersions.first!
        self.init(
            schemaHistory: SchemaHistory(
                allSchema: [
-                    LegacyXcodeDataModelSchema(
+                    UnsafeDataModelSchema(
                        modelName: modelVersion,
                        model: model
                    )
--- a/Sources/DynamicSchema.swift
+++ b/Sources/DynamicSchema.swift
@@ -32,7 +32,7 @@ import Foundation
 /**
 `DynamicSchema` are types that provide `NSManagedObjectModel` instances for a single model version. CoreStore currently supports the following concrete types:
 - `XcodeDataModelSchema`: describes models loaded from a .xcdatamodeld file.
- - `LegacyXcodeDataModelSchema`: describes models loaded directly from an existing `NSManagedObjectModel`. It is not advisable to continue using this model as its metadata are not available to CoreStore.
+ - `UnsafeDataModelSchema`: describes models loaded directly from an existing `NSManagedObjectModel`. It is not advisable to continue using this model as its metadata are not available to CoreStore.
 - `CoreStoreSchema`: describes models written for `CoreStoreObject` Swift class declarations.
 */
 public protocol DynamicSchema {
--- a/Sources/ICloudStore.swift
+++ b/Sources/ICloudStore.swift
@@ -62,7 +62,6 @@ public final class ICloudStore: CloudStorage {
     - parameter ubiquitousContainerID: a container if your app has multiple ubiquity container identifiers in its entitlements
     - parameter ubiquitousPeerToken: a per-application salt to allow multiple apps on the same device to share a Core Data store integrated with iCloud
     - 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 `ubiquitousContentName` explicitly for each of them.
-     - parameter mappingModelBundles: a list of `NSBundle`s from which to search mapping models for migration.
     - parameter cloudStorageOptions: When the `ICloudStore` is passed to the `DataStack`'s `addStorage()` methods, tells the `DataStack` how to setup the persistent store. Defaults to `.None`.
     */
    public required init?(ubiquitousContentName: String, ubiquitousContentTransactionLogsSubdirectory: String, ubiquitousContainerID: String? = nil, ubiquitousPeerToken: String? = nil, configuration: ModelConfiguration = nil, cloudStorageOptions: CloudStorageOptions = nil) {
--- a/Sources/SQLiteStore.swift
+++ b/Sources/SQLiteStore.swift
@@ -70,7 +70,7 @@ public final class SQLiteStore: LocalStorage {
    }
    
    /**
-     Initializes an `SQLiteStore` 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`.
+     Initializes an `SQLiteStore` 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 `migrationMappingProviders` set to empty, and `localStorageOptions` set to `.AllowProgresiveMigration`.
     
     - Warning: The default SQLite file location for the `LegacySQLiteStore` and `SQLiteStore` are different. If the app was depending on CoreStore's default directories prior to 2.0.0, make sure to use the `SQLiteStore.legacy(...)` factory methods to create the `SQLiteStore` instead of using initializers directly.
     */
@@ -103,7 +103,7 @@ public final class SQLiteStore: LocalStorage {
    }
    
    /**
-     Initializes an `LegacySQLiteStore` with an all-default settings: a `fileURL` pointing to a "<Application name>.sqlite" file in the "Application Support" directory (or the "Caches" directory on tvOS), a `nil` `configuration` pertaining to the "Default" configuration, a `mappingModelBundles` set to search all `NSBundle`s, and `localStorageOptions` set to `.AllowProgresiveMigration`.
+     Initializes an `LegacySQLiteStore` with an all-default settings: a `fileURL` pointing to a "<Application name>.sqlite" file in the "Application Support" directory (or the "Caches" directory on tvOS), a `nil` `configuration` pertaining to the "Default" configuration, a `migrationMappingProviders` set to empty, and `localStorageOptions` set to `.AllowProgresiveMigration`.
     
     - Warning: The default SQLite file location for the `LegacySQLiteStore` and `SQLiteStore` are different. If the app was depending on CoreStore's default directories prior to 2.0.0, make sure to use the `SQLiteStore.legacy(...)` factory methods to create the `SQLiteStore` instead of using initializers directly.
     */
--- a/Sources/LegacyXcodeDataModelSchema.swift
+++ b/Sources/LegacyXcodeDataModelSchema.swift
@@ -1,5 +1,5 @@
 //
-//  LegacyXcodeDataModelSchema.swift
+//  UnsafeDataModelSchema.swift
 //  CoreStore
 //
 //  Copyright © 2017 John Rommel Estropia
@@ -27,18 +27,18 @@ import CoreData
 import Foundation


-// MARK: - LegacyXcodeDataModelSchema
+// MARK: - UnsafeDataModelSchema

 /**
- The `LegacyXcodeDataModelSchema` describes models loaded directly from an existing `NSManagedObjectModel`. It is not advisable to continue using this model as its metadata are not available to CoreStore.
+ The `UnsafeDataModelSchema` describes models loaded directly from an existing `NSManagedObjectModel`. It is not advisable to continue using this model as its metadata are not available to CoreStore.
 */
-public final class LegacyXcodeDataModelSchema: DynamicSchema {
+public final class UnsafeDataModelSchema: DynamicSchema {
    
    /**
-     Initializes a `LegacyXcodeDataModelSchema` from an `NSManagedObjectModel`.
+     Initializes a `UnsafeDataModelSchema` from an `NSManagedObjectModel`.
     ```
     CoreStore.defaultStack = DataStack(
-         LegacyXcodeDataModelSchema(modelName: "MyAppV1", model: model)
+         UnsafeDataModelSchema(modelName: "MyAppV1", model: model)
     )
     ```
     - parameter modelName: the model version, typically the file name of an *.xcdatamodeld file (without the file extension)