Refactor structure (#8)

1. `ManagedObjectFindOrCreateBy` has been split into `ManagedObjectFindOrCreateBy` and `ManagedObjectFind`.
2. Updated documentation and repo structure

Author: spnkr

Example App/Example App.xcodeproj/project.pbxproj

@@ -314,7 +314,7 @@
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				ASSETCATALOG_COMPILER_GLOBAL_ACCENT_COLOR_NAME = AccentColor;
 				CODE_SIGN_STYLE = Automatic;
-				CURRENT_PROJECT_VERSION = 1;
+				CURRENT_PROJECT_VERSION = 2;
 				DEVELOPMENT_ASSET_PATHS = "\"Example App/Preview Content\"";
 				DEVELOPMENT_TEAM = 63P2N3D9XL;
 				ENABLE_PREVIEWS = YES;
@@ -344,7 +344,7 @@
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				ASSETCATALOG_COMPILER_GLOBAL_ACCENT_COLOR_NAME = AccentColor;
 				CODE_SIGN_STYLE = Automatic;
-				CURRENT_PROJECT_VERSION = 1;
+				CURRENT_PROJECT_VERSION = 2;
 				DEVELOPMENT_ASSET_PATHS = "\"Example App/Preview Content\"";
 				DEVELOPMENT_TEAM = 63P2N3D9XL;
 				ENABLE_PREVIEWS = YES;

Example App/Example App/ContentView.swift

@@ -125,7 +125,7 @@ struct ContentView: View {
             // using name as the unique identifier
             let lydia = Author.findOrCreate(column: "name", value: "Lydia Millet", using: .background)
 
-            var authors = [murakami, jk, lydia]
+            let authors = [murakami, jk, lydia]
 
             for _ in 0..<10 {
                 let newItem = Book.findOrCreate(id: UUID().uuidString, using: .background)

Scripts/build-core-data-plus-docs.sh

@@ -17,4 +17,4 @@ echo "<script>window.location.href += \"/documentation/coredataplus\"</script>"
 
 #git add .;
 #git commit -m 'Documentation update';
-#git push origin docs;
+#git push origin docs;

…ces/CoreDataPlus/CoreDataContainer.swift …taPlus/DataStore/CoreDataContainer.swiftSources/CoreDataPlus/CoreDataContainer.swift renamed to Sources/CoreDataPlus/DataStore/CoreDataContainer.swift Sources/CoreDataPlus/CoreDataContainer.swift renamed to Sources/CoreDataPlus/DataStore/CoreDataContainer.swift

@@ -0,0 +1,65 @@
+import CoreData
+import Foundation
+
+public protocol ManagedObjectFind where Self: NSFetchRequestResult {
+    // Tip: You will probably want to define id, as part of the Identifiable protocol. If you add this as a column in your db, you get automatic conformance. If your NSManagedObject doesn't have an `id` property in the database, you'd implement this:
+    // var id: String { get set }
+
+    init(context: NSManagedObjectContext)
+    static func entity() -> NSEntityDescription
+    static func fetchRequest() -> NSFetchRequest<NSFetchRequestResult>
+}
+
+public extension ManagedObjectFind {
+    
+    /// Finds an instance of the NSManagedObject that has a column (property) matching the passed value. If it doesn't exist in the database, creates one, and returns it.
+    /// - Parameters:
+    ///   - column: Name of column that uniquely identifies a row (primary key).
+    ///   - value: Value of the primary key.
+    ///   - context: NSManagedObjectContext to use
+    /// - Returns: An instance of the object, or nil
+    
+    /// Finds an instance of the NSManagedObject that has a column (property) matching the passed value. If it doesn't exist in the database, returns nil.
+    /// - Parameters:
+    ///   - column: Name of column that uniquely identifies a row (primary key).
+    ///   - value: Value of the primary key.
+    ///   - using: Optional. Specify `.foreground` for the main view context (operates on the main thread). Use `.background` to use a shared background context that automatically merges into the view context. Use `.custom(nsManagedObjectContext:)` to choose your own NSManagedObjectContext.
+    /// - Returns: An instance of the object, or nil.
+    static func find(column: String, value: Any, using: ContextMode = .foreground) -> Self? {
+        let context = contextModeToNSManagedObjectContext(using)
+        
+        return find(column: column, value: value, context: context)
+    }
+    
+    /// Same as `find(column: String, value: Any, using: ContextMode = .foreground)`, but allows you to pass your own `NSManagedObjectContext`.
+    static func find(column: String, value: Any, context: NSManagedObjectContext) -> Self? {
+        
+        let request = NSFetchRequest<Self>()
+        request.predicate = Predicate("\(column) = %@", value)
+        request.fetchLimit = 1
+        request.entity = entity()
+        
+        do {
+            let objects: [Self] = try context.fetch(request)
+            
+            if let object = objects.first {
+                return object
+            }
+        } catch {
+            CoreDataPlusLogger.shared.log("FindButDoNotCreateById context fetch failure: \(error.localizedDescription)")
+        }
+        
+        return nil
+    }
+    
+    /// Same as `find(column: String, value: Any, ...`, but with the column name set to `id`.
+    static func find(id: String, using: ContextMode = .foreground) -> Self? {
+        return find(column: "id", value: id, using: using)
+    }
+    
+    /// Same as `find(column: String, value: Any, ...`, but with the column name set to `id`.
+    static func find(id: String, context: NSManagedObjectContext) -> Self? {
+        return find(column: "id", value: id, context: context)
+    }
+    
+}

…ces/CoreDataPlus/CoreDataPlusStore.swift …taPlus/DataStore/CoreDataPlusStore.swiftSources/CoreDataPlus/CoreDataPlusStore.swift renamed to Sources/CoreDataPlus/DataStore/CoreDataPlusStore.swift Sources/CoreDataPlus/CoreDataPlusStore.swift renamed to Sources/CoreDataPlus/DataStore/CoreDataPlusStore.swift

@@ -0,0 +1,62 @@
+import CoreData
+import Foundation
+
+public protocol ManagedObjectFindOrCreateBy where Self: NSFetchRequestResult {
+    // Tip: You will probably want to define id, as part of the Identifiable protocol. If you add this as a column in your db, you get automatic conformance. If your NSManagedObject doesn't have an `id` property in the database, you'd implement this:
+    // var id: String { get set }
+
+    init(context: NSManagedObjectContext)
+    static func entity() -> NSEntityDescription
+    static func fetchRequest() -> NSFetchRequest<NSFetchRequestResult>
+}
+
+public extension ManagedObjectFindOrCreateBy {
+    /// Finds an instance of the NSManagedObject that has a column (property) matching the passed value. If it doesn't exist in the database, creates one, and returns it.
+    /// - Parameters:
+    ///   - column: Name of column that uniquely identifies a row (primary key).
+    ///   - value: Value of the primary key.
+    ///   - using: Optional. Specify `.foreground` for the main view context (operates on the main thread). Use `.background` to use a shared background context that automatically merges into the view context. Use `.custom(nsManagedObjectContext:)` to choose your own NSManagedObjectContext.
+    /// - Returns: An instance of the object
+    static func findOrCreate(column: String, value: Any, using: ContextMode = .foreground) -> Self {
+        let context = contextModeToNSManagedObjectContext(using)
+        
+        return findOrCreate(column: column, value: value, context: context)
+    }
+    
+    /// Same as `findOrCreate(column: String, value: Any, using: ContextMode = .foreground)`, but allows you to pass your own `NSManagedObjectContext`.
+    static func findOrCreate(column: String, value: Any, context: NSManagedObjectContext) -> Self {
+        let request = NSFetchRequest<Self>()
+        request.predicate = Predicate("\(column) = %@", value)
+        request.entity = entity()
+        
+        do {
+            let objects: [Self] = try context.fetch(request)
+            
+            if let object = objects.first {
+                return object
+            }
+        } catch {
+            CoreDataPlusLogger.shared.log("findOrCreate context fetch failure: \(error.localizedDescription)")
+        }
+        
+        let object = Self(context: context)
+        
+        if let object = object as? NSManagedObject {
+            object.setValue(value, forKey: column)
+        }
+        
+        return object
+    }
+    
+    /// Same as `findOrCreate(column: String, value: Any, ...`, but with the column name set to `id`.
+    static func findOrCreate(id: String, using: ContextMode = .foreground) -> Self {
+        let context = contextModeToNSManagedObjectContext(using)
+        
+        return findOrCreate(column: "id", value: id, context: context)
+    }
+    
+    /// Same as `findOrCreate(column: String, value: Any, ...`, but with the column name set to `id`.
+    static func findOrCreate(id: String, context: NSManagedObjectContext) -> Self {
+        return findOrCreate(column: "id", value: id, context: context)
+    }
+}

…oreDataPlus/ManagedObjectCountable.swift …nagedObject/ManagedObjectCountable.swiftSources/CoreDataPlus/ManagedObjectCountable.swift renamed to Sources/CoreDataPlus/ManagedObject/ManagedObjectCountable.swift Sources/CoreDataPlus/ManagedObjectCountable.swift renamed to Sources/CoreDataPlus/ManagedObject/ManagedObjectCountable.swift

@@ -1,2 +1,2 @@
 /// Shortcut for adding all ManagedObject extensions
-public typealias ManagedObjectPlus = ManagedObjectCountable & ManagedObjectDeletable & ManagedObjectSearchable & ManagedObjectFindOrCreateBy
+public typealias ManagedObjectPlus = ManagedObjectCountable & ManagedObjectDeletable & ManagedObjectSearchable & ManagedObjectFindOrCreateBy & ManagedObjectFind