Move xcdatamodeld into WordPressData

.editorconfig

@@ -1,9 +1,23 @@
+root = true
+
 # Apply to all files
 [*]
+indent_style = space
+indent_size = 2
 end_of_line = lf
 insert_final_newline = true
+charset = utf-8
 trim_trailing_whitespace = true
 
+[*.md]
+trim_trailing_whitespace = false
+
+[*.swift]
+indent_size = 4
+
+[{*.h,*.m}]
+indent_size = 4
+
 # Ruby specific rules
 [{*.rb,Fastfile,Gemfile}]
 indent_style = space

Modules/Package.swift

@@ -11,6 +11,7 @@ let package = Package(
         .library(name: "AsyncImageKit", targets: ["AsyncImageKit"]),
         .library(name: "DesignSystem", targets: ["DesignSystem"]),
         .library(name: "JetpackStatsWidgetsCore", targets: ["JetpackStatsWidgetsCore"]),
+        .library(name: "SFHFKeychainUtils", targets: ["SFHFKeychainUtils"]),
         .library(name: "WordPressData", targets: ["WordPressData"]),
         .library(name: "WordPressFlux", targets: ["WordPressFlux"]),
         .library(name: "WordPressShared", targets: ["WordPressShared"]),
@@ -60,17 +61,34 @@ let package = Package(
         ]),
         .target(name: "DesignSystem", swiftSettings: [.swiftLanguageMode(.v5)]),
         .target(name: "JetpackStatsWidgetsCore", swiftSettings: [.swiftLanguageMode(.v5)]),
+        // SFHFKeychainUtils is an old Objective-C keychain wrapper.
+        // The implementatoin predates ARC, hence the dedicated target with ARC disabled, for the time being.
+        .target(
+            name: "SFHFKeychainUtils",
+            cSettings: [.unsafeFlags(["-fno-objc-arc"])]
+        ),
         .target(name: "UITestsFoundation", dependencies: [
             .product(name: "ScreenObject", package: "ScreenObject"),
             .product(name: "XCUITestHelpers", package: "ScreenObject"),
         ], swiftSettings: [.swiftLanguageMode(.v5)]),
-        .target(name: "WordPressDataObjC"),
+        .target(
+            name: "WordPressDataObjC",
+            dependencies: [
+                "SFHFKeychainUtils",
+                .target(name: "WordPressShared"),
+                .product(name: "CocoaLumberjack", package: "CocoaLumberjack"),
+            ]
+        ),
         .target(
             name: "WordPressData",
             dependencies: [
                 .target(name: "WordPressDataObjC"),
-                .target(name: "WordPressSharedObjC")
-            ]
+                .target(name: "WordPressSharedObjC"),
+                .product(name: "CocoaLumberjack", package: "CocoaLumberjack"),
+                .product(name: "CocoaLumberjackSwift", package: "CocoaLumberjack")
+            ],
+            // Avoid supporting Sendable and concurrency for the time being...
+            swiftSettings: [.swiftLanguageMode(.v5)]
         ),
         .target(name: "WordPressFlux", swiftSettings: [.swiftLanguageMode(.v5)]),
         .target(name: "WordPressCore", dependencies: [.target(name: "WordPressShared"), .product(name: "WordPressAPI", package: "wordpress-rs")]),
@@ -90,6 +108,11 @@ let package = Package(
         ),
         .testTarget(name: "JetpackStatsWidgetsCoreTests", dependencies: [.target(name: "JetpackStatsWidgetsCore")], swiftSettings: [.swiftLanguageMode(.v5)]),
         .testTarget(name: "DesignSystemTests", dependencies: [.target(name: "DesignSystem")], swiftSettings: [.swiftLanguageMode(.v5)]),
+        .testTarget(
+            name: "WordPressDataTests",
+            dependencies: ["WordPressData"],
+            swiftSettings: [.swiftLanguageMode(.v5)]
+        ),
         .testTarget(name: "WordPressFluxTests", dependencies: ["WordPressFlux"], swiftSettings: [.swiftLanguageMode(.v5)]),
         .testTarget(name: "AsyncImageKitTests", dependencies: [
             .target(name: "AsyncImageKit"),
@@ -146,6 +169,7 @@ enum XcodeSupport {
         ]
 
         let shareAndDraftExtensionsDependencies: [Target.Dependency] = [
+            "SFHFKeychainUtils",
             "WordPressShared",
             "WordPressUI",
             .product(name: "CocoaLumberjackSwift", package: "CocoaLumberjack"),
@@ -168,6 +192,7 @@ enum XcodeSupport {
             .xcodeTarget("XcodeTarget_App", dependencies: [
                 "DesignSystem",
                 "JetpackStatsWidgetsCore",
+                "SFHFKeychainUtils",
                 "WordPressData",
                 "WordPressFlux",
                 "WordPressShared",
@@ -206,6 +231,7 @@ enum XcodeSupport {
                 .product(name: "WordPressEditor", package: "AztecEditor-iOS"),
             ]),
             .xcodeTarget("XcodeTarget_WordPressTests", dependencies: testDependencies + [
+                "SFHFKeychainUtils",
                 "WordPressShared",
                 .product(name: "Gravatar", package: "Gravatar-SDK-iOS"),
                 .product(name: "Nimble", package: "Nimble"),
@@ -216,6 +242,7 @@ enum XcodeSupport {
             .xcodeTarget("XcodeTarget_ShareExtension", dependencies: shareAndDraftExtensionsDependencies),
             .xcodeTarget("XcodeTarget_DraftActionExtension", dependencies: shareAndDraftExtensionsDependencies),
             .xcodeTarget("XcodeTarget_NotificationServiceExtension", dependencies: [
+                "SFHFKeychainUtils",
                 "WordPressShared",
             ]),
             .xcodeTarget("XcodeTarget_StatsWidget", dependencies: [

WordPress/Classes/Utility/SFHFKeychainUtils.h → Modules/Sources/SFHFKeychainUtils/include/SFHFKeychainUtils.h

@@ -27,7 +27,7 @@
 //  OTHER DEALINGS IN THE SOFTWARE.
 //
 
-#import <UIKit/UIKit.h>
+#import <Foundation/Foundation.h>
 
 
 @interface SFHFKeychainUtils : NSObject {
@@ -68,4 +68,4 @@
 + (NSArray<NSDictionary<NSString *, NSString *> *> *)getAllPasswordsForAccessGroup:(NSString *)accessGroup
                                                                              error:(NSError **)error;
 
-@end
+@end

WordPress/Classes/Utility/CoreData/ContextManager+ErrorHandling.swift → Modules/Sources/WordPressData/ContextManager+ErrorHandling.swift

@@ -1,4 +1,5 @@
 import CoreData
+import CocoaLumberjackSwift
 
 // Imported from CoreData.CoreDataErrors
 private let coreDataKnownErrorCodes = [

WordPress/Classes/Utility/CoreData/ContextManager.swift → Modules/Sources/WordPressData/ContextManager.swift

@@ -1,3 +1,4 @@
+import CocoaLumberjackSwift
 import CoreData
 import Foundation
 import WordPressData
@@ -57,13 +58,18 @@ public class ContextManager: NSObject, CoreDataStack, CoreDataStackSwift {
         super.init()
 
         mainContext.automaticallyMergesChangesFromParent = true
-        mainContext.mergePolicy = NSMergeByPropertyObjectTrumpMergePolicy
-        NullBlogPropertySanitizer(context: mainContext).sanitize()
+        // FIXME: Temporary disabled to move on with migration. Gives error:
+        // Reference to var 'NSMergeByPropertyObjectTrumpMergePolicy' is not concurrency-safe because it involves shared mutable state
+        // mainContext.mergePolicy = NSMergeByPropertyObjectTrumpMergePolicy
+        // FIXME: We still need to migrate this. Too many dependencies on the models
+        // NullBlogPropertySanitizer(context: mainContext).sanitize()
     }
 
     public func newDerivedContext() -> NSManagedObjectContext {
         let context = persistentContainer.newBackgroundContext()
-        context.mergePolicy = NSMergeByPropertyObjectTrumpMergePolicy
+        // FIXME: Temporary disabled to move on with migration. Gives error:
+        // Reference to var 'NSMergeByPropertyObjectTrumpMergePolicy' is not concurrency-safe because it involves shared mutable state
+        // context.mergePolicy = NSMergeByPropertyObjectTrumpMergePolicy
         return context
     }
 
@@ -155,11 +161,7 @@ public class ContextManager: NSObject, CoreDataStack, CoreDataStackSwift {
 
         DDLogWarn("Migration required for persistent store.")
 
-        guard let modelFileURL = Bundle.main.url(forResource: "WordPress", withExtension: "momd") else {
-            fatalError("Can't find WordPress.momd")
-        }
-
-        guard let versionInfo = NSDictionary(contentsOf: modelFileURL.appendingPathComponent("VersionInfo.plist")) else {
+        guard let versionInfo = NSDictionary(contentsOf: WordPressData.modelURL.appendingPathComponent("VersionInfo.plist")) else {
             fatalError("Can't get the object model's version info")
         }
 
@@ -222,9 +224,7 @@ private extension ContextManager {
 
 private extension ContextManager {
     static func createPersistentContainer(storeURL: URL, modelName: String) -> NSPersistentContainer {
-        guard var modelFileURL = Bundle.main.url(forResource: "WordPress", withExtension: "momd") else {
-            fatalError("Can't find WordPress.momd")
-        }
+        var modelFileURL = WordPressData.modelURL
 
         if modelName != ContextManagerModelNameCurrent {
             modelFileURL = modelFileURL.appendingPathComponent(modelName).appendingPathExtension("mom")
@@ -234,13 +234,15 @@ private extension ContextManager {
             fatalError("Can't create object model named \(modelName) at \(modelFileURL)")
         }
 
-        let startupEvent = SentryStartupEvent()
+        // FIXME: Discarding Sentry in the context of this migration 1/5
+        // let startupEvent = SentryStartupEvent()
 
         do {
             try migrateDataModelsIfNecessary(storeURL: storeURL, objectModel: objectModel)
         } catch {
             DDLogError("Unable to migrate store: \(error)")
-            startupEvent.add(error: error as NSError)
+            // FIXME: Discarding Sentry in the context of this migration 2/5
+            // startupEvent.add(error: error as NSError)
         }
 
         let storeDescription = NSPersistentStoreDescription(url: storeURL)
@@ -254,16 +256,19 @@ private extension ContextManager {
             }
 
             DDLogError("Error opening the database. \(error)\nDeleting the file and trying again")
-            startupEvent.add(error: error)
+            // FIXME: Discarding Sentry in the context of this migration 3/5
+            // startupEvent.add(error: error)
 
             // make a backup of the old database
             do {
                 try CoreDataIterativeMigrator.backupDatabase(at: storeURL)
             } catch {
-                startupEvent.add(error: error)
+                // FIXME: Discarding Sentry in the context of this migration 4/5
+                // startupEvent.add(error: error)
             }
 
-            startupEvent.send(title: "Can't initialize Core Data stack")
+            // FIXME: Discarding Sentry in the context of this migration 5/5
+            // startupEvent.send(title: "Can't initialize Core Data stack")
             objc_exception_throw(
                 NSException(
                     name: NSExceptionName(rawValue: "Can't initialize Core Data stack"),
@@ -279,19 +284,20 @@ private extension ContextManager {
 
 extension ContextManager {
     private static let internalSharedInstance = ContextManager()
+
     /// Tests purpose only
-    static var overrideInstance: ContextManager?
+    nonisolated(unsafe) static var overrideInstance: ContextManager?
 
-    @objc class func sharedInstance() -> ContextManager {
+    @objc public class func sharedInstance() -> CoreDataStack {
         if let overrideInstance {
             return overrideInstance
         }
 
         return ContextManager.internalSharedInstance
     }
 
-    static var shared: ContextManager {
-        return sharedInstance()
+    static var shared: CoreDataStackSwift {
+        return sharedInstance() as! CoreDataStackSwift
     }
 }
 

WordPress/Classes/Utility/CoreData/Migrator/CoreDataIterativeMigrator.swift → Modules/Sources/WordPressData/CoreDataIterativeMigrator.swift

@@ -1,5 +1,6 @@
-import Foundation
 import CoreData
+import CocoaLumberjackSwift
+import Foundation
 
 /// CoreDataIterativeMigrator: Migrates through a series of models to allow for users to skip app versions without risk.
 ///
@@ -271,7 +272,7 @@ private extension CoreDataIterativeMigrator {
 
     static func models(for names: [String]) throws -> [NSManagedObjectModel] {
         let models = try names.map { (name) -> NSManagedObjectModel in
-            guard let url = urlForModel(name: name, in: nil),
+            guard let url = WordPressData.urlForModel(name: name, in: nil),
                 let model = NSManagedObjectModel(contentsOf: url) else {
                     let description = "No model found for \(name)"
                     throw error(with: .noModelFound, description: description)
@@ -282,25 +283,6 @@ private extension CoreDataIterativeMigrator {
 
         return models
     }
-
-    static func urlForModel(name: String, in directory: String?) -> URL? {
-        let bundle = Bundle(for: ContextManager.self)
-        var url = bundle.url(forResource: name, withExtension: "mom", subdirectory: directory)
-
-        if url != nil {
-            return url
-        }
-
-        let momdPaths = bundle.paths(forResourcesOfType: "momd", inDirectory: directory)
-        momdPaths.forEach { (path) in
-            if url != nil {
-                return
-            }
-            url = bundle.url(forResource: name, withExtension: "mom", subdirectory: URL(fileURLWithPath: path).lastPathComponent)
-        }
-
-        return url
-    }
 }
 
 enum IterativeMigratorErrorCodes: Int {

WordPress/Classes/Utility/CoreData/CoreDataHelper.swift → Modules/Sources/WordPressData/Extensions.swift

@@ -1,5 +1,6 @@
 import Foundation
 import CoreData
+import CocoaLumberjackSwift
 import WordPressShared
 
 // MARK: - NSManagedObject Default entityName Helper
@@ -11,7 +12,7 @@ extension NSManagedObject {
     ///
     /// Note: entity().name returns nil as per iOS 10, in Unit Testing Targets. Awesome.
     ///
-    @objc class func entityName() -> String {
+    @objc open class func entityName() -> String {
         return entity().name ?? classNameWithoutNamespaces()
     }
 
@@ -88,7 +89,8 @@ extension NSManagedObjectContext {
     ///
     /// - Parameter predicate: Defines the conditions that any given object should meet.
     ///
-    func firstObject<T: NSManagedObject>(ofType type: T.Type, matching predicate: NSPredicate) -> T? {
+    // FIXME: Might be able to return internal after Role is migrated
+    public func firstObject<T: NSManagedObject>(ofType type: T.Type, matching predicate: NSPredicate) -> T? {
         let request = T.safeFetchRequest()
         request.predicate = predicate
         request.fetchLimit = 1
@@ -140,7 +142,8 @@ extension NSManagedObjectContext {
             objects = try fetch(request) as? [T]
         } catch {
             DDLogError("Error loading Objects [\(String(describing: T.entityName))")
-            wpAssertionFailure("CoreData.loadObjects failed", userInfo: ["error": "\(error)"])
+            // FIXME: Enabling this will require adding dependencies such as Tracks through the chain...
+            // wpAssertionFailure("CoreData.loadObjects failed", userInfo: ["error": "\(error)"])
         }
 
         return objects ?? []
@@ -191,7 +194,7 @@ extension ContextManager.ContextManagerError: LocalizedError, CustomDebugStringC
     }
 }
 
-extension CoreDataStack {
+public extension CoreDataStack {
     /// Perform a query using the `mainContext` and return the result.
     ///
     /// - Warning: Do not return `NSManagedObject` instances from the closure.
@@ -357,8 +360,7 @@ extension CoreDataStack {
     }
 
     private func migrateDatabaseIfNecessary(at databaseLocation: URL) throws {
-        guard let modelFileURL = Bundle.main.url(forResource: "WordPress", withExtension: "momd"),
-              let objectModel = NSManagedObjectModel(contentsOf: modelFileURL) else {
+        guard let objectModel = NSManagedObjectModel(contentsOf: WordPressData.modelURL) else {
             return
         }
         try ContextManager.migrateDataModelsIfNecessary(storeURL: databaseLocation, objectModel: objectModel)

Modules/Sources/WordPressData/Models/BloggingPrompt.swift

@@ -0,0 +1,45 @@
+import CoreData
+import WordPressSharedObjC
+
+public class BloggingPrompt: NSManagedObject {
+
+    /// The unique ID for the prompt, received from the server.
+    @NSManaged public var promptID: Int32
+
+    /// The site ID for the prompt.
+    @NSManaged public var siteID: Int32
+
+    /// The prompt content to be displayed at entry points.
+    @NSManaged public var text: String
+
+    /// The attribution source for the prompt.
+    @NSManaged public var attribution: String
+
+    /// The prompt date. Time information should be ignored.
+    @NSManaged public var date: Date
+
+    /// Whether the current user has answered the prompt in `siteID`.
+    @NSManaged public var answered: Bool
+
+    /// The number of users that has answered the prompt.
+    @NSManaged public var answerCount: Int32
+
+    /// Contains avatar URLs of some users that have answered the prompt.
+    @NSManaged public var displayAvatarURLs: [URL]
+
+    /// Contains additional tags that should be appended to the post for this prompt's answer.
+    @NSManaged public var additionalPostTags: [String]?
+
+    @nonobjc public class func fetchRequest() -> NSFetchRequest<BloggingPrompt> {
+        return NSFetchRequest<BloggingPrompt>(entityName: Self.classNameWithoutNamespaces())
+    }
+
+    @nonobjc public class func newObject(in context: NSManagedObjectContext) -> BloggingPrompt? {
+        return NSEntityDescription.insertNewObject(forEntityName: Self.classNameWithoutNamespaces(), into: context) as? BloggingPrompt
+    }
+
+    public override func awakeFromInsert() {
+        self.date = .init(timeIntervalSince1970: 0)
+        self.displayAvatarURLs = []
+    }
+}