WIP: Updating README and other docs. Some minor fixes

Sources/CSDataStack.swift

@@ -49,41 +49,22 @@ public final class CSDataStack: NSObject, CoreStoreObjectiveCType {
     /**
      Initializes a `CSDataStack` from the model with the specified `modelName` in the specified `bundle`.
      
-     - parameter modelName: the name of the (.xcdatamodeld) model file. If not specified, the application name (CFBundleName) will be used if it exists, or "CoreData" if it the bundle name was not set.
+     - parameter xcodeModelName: the name of the (.xcdatamodeld) model file. If not specified, the application name (CFBundleName) will be used if it exists, or "CoreData" if it the bundle name was not set.
      - parameter bundle: an optional bundle to load models from. If not specified, the main bundle will be used.
      - parameter versionChain: the version strings that indicate the sequence of model versions to be used as the order for progressive migrations. If not specified, will default to a non-migrating data stack.
      */
     @objc
-    public convenience init(modelName: XcodeDataModelFileName?, bundle: Bundle?, versionChain: [String]?) {
+    public convenience init(xcodeModelName: XcodeDataModelFileName?, bundle: Bundle?, versionChain: [String]?) {
         
         self.init(
             DataStack(
-                modelName: modelName ?? DataStack.applicationName,
+                xcodeModelName: xcodeModelName ?? DataStack.applicationName,
                 bundle: bundle ?? Bundle.main,
                 migrationChain: versionChain.flatMap { MigrationChain($0) } ?? nil
             )
         )
     }
     
-    /**
-     Initializes a `CSDataStack` from the model with the specified `modelName` in the specified `bundle`.
-     
-     - parameter modelName: the name of the (.xcdatamodeld) model file. If not specified, the application name (CFBundleName) will be used if it exists, or "CoreData" if it the bundle name was not set.
-     - parameter bundle: an optional bundle to load models from. If not specified, the main bundle will be used.
-     - parameter versionTree: the version strings that indicate the sequence of model versions to be used as the order for progressive migrations. If not specified, will default to a non-migrating data stack.
-     */
-    @objc
-    public convenience init(modelName: XcodeDataModelFileName?, bundle: Bundle?, versionTree: [String: String]?) {
-        
-        self.init(
-            DataStack(
-                modelName: modelName ?? DataStack.applicationName,
-                bundle: bundle ?? Bundle.main,
-                migrationChain: versionTree.flatMap { MigrationChain($0) } ?? nil
-            )
-        )
-    }
-    
     /**
      Returns the stack's model version. The version string is the same as the name of the version-specific .xcdatamodeld file.
      */
@@ -227,6 +208,19 @@ public final class CSDataStack: NSObject, CoreStoreObjectiveCType {
     
     // MARK: Deprecated
     
+    @available(*, deprecated, message: "Use the -[initWithXcodeModelName:bundle:versionChain:] initializer.")
+    @objc
+    public convenience init(modelName: XcodeDataModelFileName?, bundle: Bundle?, versionChain: [String]?) {
+        
+        self.init(
+            DataStack(
+                xcodeModelName: modelName ?? DataStack.applicationName,
+                bundle: bundle ?? Bundle.main,
+                migrationChain: versionChain.flatMap { MigrationChain($0) } ?? nil
+            )
+        )
+    }
+    
     @available(*, deprecated, message: "Use the -[initWithModelName:bundle:versionChain:] initializer.")
     @objc
     public convenience init(model: NSManagedObjectModel, versionChain: [String]?) {

Sources/DataStack.swift

@@ -37,16 +37,16 @@ public final class DataStack: Equatable {
     /**
      Convenience initializer for `DataStack` that creates a `SchemaHistory` from the model with the specified `modelName` in the specified `bundle`.
      
-     - parameter modelName: the name of the (.xcdatamodeld) model file. If not specified, the application name (CFBundleName) will be used if it exists, or "CoreData" if it the bundle name was not set (e.g. in Unit Tests).
+     - parameter xcodeModelName: the name of the (.xcdatamodeld) model file. If not specified, the application name (CFBundleName) will be used if it exists, or "CoreData" if it the bundle name was not set (e.g. in Unit Tests).
      - parameter bundle: an optional bundle to load models from. If not specified, the main bundle will be used.
      - parameter migrationChain: the `MigrationChain` that indicates the sequence of model versions to be used as the order for progressive migrations. If not specified, will default to a non-migrating data stack.
      */
-    public convenience init(modelName: XcodeDataModelFileName = DataStack.applicationName, bundle: Bundle = Bundle.main, migrationChain: MigrationChain = nil) {
+    public convenience init(xcodeModelName: XcodeDataModelFileName = DataStack.applicationName, bundle: Bundle = Bundle.main, migrationChain: MigrationChain = nil) {
         
         self.init(
             schemaHistory: SchemaHistory(
                 XcodeDataModelSchema.from(
-                    modelName: modelName,
+                    modelName: xcodeModelName,
                     bundle: bundle,
                     migrationChain: migrationChain
                 ),
@@ -613,6 +613,17 @@ public final class DataStack: Equatable {
     
     // MARK: Deprecated
     
+    @available(*, deprecated, renamed: "init(xcodeModelName:bundle:migrationChain:)")
+    public convenience init(modelName: XcodeDataModelFileName, bundle: Bundle = Bundle.main, migrationChain: MigrationChain = nil) {
+        
+        self.init(
+            xcodeModelName: modelName,
+            bundle: bundle,
+            migrationChain: migrationChain
+        )
+    }
+    
+    
     @available(*, deprecated, message: "Use the new DataStack.init(schemaHistory:) initializer passing a LegacyXcodeDataModelSchema instance as argument")
     public convenience init(model: NSManagedObjectModel, migrationChain: MigrationChain = nil) {
         

Sources/DynamicObject.swift

@@ -48,6 +48,11 @@ public protocol DynamicObject: class {
      */
     static func cs_matches(object: NSManagedObject) -> Bool
     
+    /**
+     Used internally by CoreStore. Do not call directly.
+     */
+    func cs_id() -> NSManagedObjectID
+    
     /**
      Used internally by CoreStore. Do not call directly.
      */
@@ -86,6 +91,11 @@ extension NSManagedObject: DynamicObject {
         return object.isKind(of: self)
     }
     
+    public func cs_id() -> NSManagedObjectID {
+        
+        return self.objectID
+    }
+    
     public func cs_toRaw() -> NSManagedObject {
         
         return self
@@ -135,6 +145,11 @@ extension CoreStoreObject {
         return (self as AnyClass).isSubclass(of: type as AnyClass)
     }
     
+    public func cs_id() -> NSManagedObjectID {
+        
+        return self.rawObject!.objectID
+    }
+    
     public func cs_toRaw() -> NSManagedObject {
         
         return self.rawObject!

Sources/DynamicSchema+Convenience.swift

@@ -31,6 +31,12 @@ import Foundation
 
 public extension DynamicSchema {
     
+    /**
+     Prints the `DynamicSchema` as their corresponding `CoreStoreObject` Swift declarations. This is useful for converting current `XcodeDataModelSchema`-based models into the new `CoreStoreSchema` framework. Additional adjustments may need to be done to the generated source code for "Transformable" attributes.
+     
+     - Important: After transitioning to the new `CoreStoreSchema` framework, it is recommended to add the new schema as a new version that the existing versions' `XcodeDataModelSchema` can migrate to. It is discouraged to load existing SQLite files created with `XcodeDataModelSchema` directly into a `CoreStoreSchema`.
+     - returns: a string that represents the source code for the `DynamicSchema` as their corresponding `CoreStoreObject` Swift declarations.
+     */
     public func printCoreStoreSchema() -> String {
         
         let model = self.rawModel()

Sources/NSManagedObjectContext+Querying.swift

@@ -91,7 +91,7 @@ extension NSManagedObjectContext: FetchableSource, QueryableSource {
     @nonobjc
     public func fetchExisting<T: DynamicObject, S: Sequence>(_ objects: S) -> [T] where S.Iterator.Element == T {
         
-        return objects.flatMap({ self.fetchExisting($0.cs_toRaw().objectID) })
+        return objects.flatMap({ self.fetchExisting($0.cs_id()) })
     }
     
     @nonobjc

Sources/ObjectMonitor.swift

@@ -260,16 +260,15 @@ public final class ObjectMonitor<D: DynamicObject>: Equatable {
     
     private init(context: NSManagedObjectContext, object: ObjectType) {
         
-        let rawObject = object.cs_toRaw()
+        let objectID = object.cs_id()
         let fetchRequest = CoreStoreFetchRequest()
-        fetchRequest.entity = rawObject.entity
+        fetchRequest.entity = objectID.entity
         fetchRequest.fetchLimit = 0
         fetchRequest.resultType = .managedObjectResultType
         fetchRequest.sortDescriptors = []
         fetchRequest.includesPendingChanges = false
         fetchRequest.shouldRefreshRefetchedObjects = true
         
-        let objectID = rawObject.objectID
         let fetchedResultsController = CoreStoreFetchedResultsController(
             context: context,
             fetchRequest: fetchRequest.dynamicCast(),

Sources/Where.swift

@@ -148,7 +148,7 @@ public struct Where: FetchClause, QueryClause, DeleteClause, Hashable {
             self.init(NSPredicate(format: "\(keyPath) == nil"))
             
         case let object?:
-            self.init(NSPredicate(format: "\(keyPath) == %@", argumentArray: [object.cs_toRaw().objectID]))
+            self.init(NSPredicate(format: "\(keyPath) == %@", argumentArray: [object.cs_id()]))
         }
     }
     
@@ -171,7 +171,7 @@ public struct Where: FetchClause, QueryClause, DeleteClause, Hashable {
      */
     public init<S: Sequence>(_ keyPath: KeyPath, isMemberOf list: S) where S.Iterator.Element: DynamicObject {
         
-        self.init(NSPredicate(format: "\(keyPath) IN %@", list.map({ $0.cs_toRaw().objectID }) as NSArray))
+        self.init(NSPredicate(format: "\(keyPath) IN %@", list.map({ $0.cs_id() }) as NSArray))
     }
     
     /**