Move xcdatamodeld into WordPressData

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: "WordPressData", targets: ["WordPressData"]),
         .library(name: "WordPressFlux", targets: ["WordPressFlux"]),
         .library(name: "WordPressShared", targets: ["WordPressShared"]),
         .library(name: "WordPressUI", targets: ["WordPressUI"]),
@@ -63,6 +64,14 @@ let package = Package(
             .product(name: "ScreenObject", package: "ScreenObject"),
             .product(name: "XCUITestHelpers", package: "ScreenObject"),
         ], swiftSettings: [.swiftLanguageMode(.v5)]),
+        .target(name: "WordPressDataObjC"),
+        .target(
+            name: "WordPressData",
+            dependencies: [
+                .target(name: "WordPressDataObjC"),
+                .target(name: "WordPressSharedObjC")
+            ]
+        ),
         .target(name: "WordPressFlux", swiftSettings: [.swiftLanguageMode(.v5)]),
         .target(name: "WordPressCore", dependencies: [.target(name: "WordPressShared"), .product(name: "WordPressAPI", package: "wordpress-rs")]),
         .target(name: "WordPressSharedObjC", resources: [.process("Resources")], swiftSettings: [.swiftLanguageMode(.v5)]),
@@ -105,7 +114,7 @@ let package = Package(
 ///
 /// ## Known Issues
 ///
-///   - SwiftPM copies resource bundles from a target, including dynamic frameworks,
+///   - SwiftPM copies resource bundles from a target, including dynamic frameworks,
 /// into every target that depends on it. Make sure to avoid including frameworks
 /// with large resources bundled into multiple targets.
 enum XcodeSupport {
@@ -159,6 +168,7 @@ enum XcodeSupport {
             .xcodeTarget("XcodeTarget_App", dependencies: [
                 "DesignSystem",
                 "JetpackStatsWidgetsCore",
+                "WordPressData",
                 "WordPressFlux",
                 "WordPressShared",
                 "WordPressReader",

Modules/Sources/WordPressData/CoreDataStackSwift.swift

@@ -0,0 +1,38 @@
+import CoreData
+import WordPressDataObjC
+
+public protocol CoreDataStackSwift: CoreDataStack {
+
+    /// Execute the given block with a background context and save the changes.
+    ///
+    /// This function _does not block_ its running thread. The block is executed in background and its return value
+    /// is passed onto the `completion` block which is executed on the given `queue`.
+    ///
+    /// - Parameters:
+    ///   - block: A closure which uses the given `NSManagedObjectContext` to make Core Data model changes.
+    ///   - completion: A closure which is called with the return value of the `block`, after the changed made
+    ///         by the `block` is saved.
+    ///   - queue: A queue on which to execute the completion block.
+    func performAndSave<T>(_ block: @escaping (NSManagedObjectContext) -> T, completion: ((T) -> Void)?, on queue: DispatchQueue)
+
+    /// Execute the given block with a background context and save the changes _if the block does not throw an error_.
+    ///
+    /// This function _does not block_ its running thread. The block is executed in background and the return value
+    /// (or an error) is passed onto the `completion` block which is executed on the given `queue`.
+    ///
+    /// - Parameters:
+    ///   - block: A closure that uses the given `NSManagedObjectContext` to make Core Data model changes. The changes
+    ///         are only saved if the block does not throw an error.
+    ///   - completion: A closure which is called with the `block`'s execution result, which is either an error thrown
+    ///         by the `block` or the return value of the `block`.
+    ///   - queue: A queue on which to execute the completion block.
+    func performAndSave<T>(_ block: @escaping (NSManagedObjectContext) throws -> T, completion: ((Result<T, Error>) -> Void)?, on queue: DispatchQueue)
+
+    /// Execute the given block with a background context and save the changes _if the block does not throw an error_.
+    ///
+    /// - Parameter block: A closure that uses the given `NSManagedObjectContext` to make Core Data model changes.
+    ///     The changes are only saved if the block does not throw an error.
+    /// - Returns: The value returned by the `block`
+    /// - Throws: The error thrown by the `block`, in which case the Core Data changes made by the `block` is discarded.
+    func performAndSave<T>(_ block: @escaping (NSManagedObjectContext) throws -> T) async throws -> T
+}

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 = []
+    }
+}

WordPress/Classes/WordPress.xcdatamodeld/WordPress 154.xcdatamodel/contents → Modules/Sources/WordPressData/WordPress.xcdatamodeld/WordPress 154.xcdatamodel/contents

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<model type="com.apple.IDECoreDataModeler.DataModel" documentVersion="1.0" lastSavedToolsVersion="22757" systemVersion="23E224" minimumToolsVersion="Xcode 9.0" sourceLanguage="Swift" userDefinedModelVersionIdentifier="">
+<model type="com.apple.IDECoreDataModeler.DataModel" documentVersion="1.0" lastSavedToolsVersion="23605" systemVersion="24D70" minimumToolsVersion="Xcode 9.0" sourceLanguage="Swift" userDefinedModelVersionIdentifier="">
     <entity name="AbstractPost" representedClassName="AbstractPost" isAbstract="YES" parentEntity="BasePost">
         <attribute name="autosaveContent" optional="YES" attributeType="String" syncable="YES"/>
         <attribute name="autosaveExcerpt" optional="YES" attributeType="String" syncable="YES"/>
@@ -215,7 +215,7 @@
         <attribute name="username" optional="YES" attributeType="String" syncable="YES"/>
         <relationship name="blog" optional="YES" maxCount="1" deletionRule="Nullify" destinationEntity="Blog" inverseName="authors" inverseEntity="Blog" syncable="YES"/>
     </entity>
-    <entity name="BloggingPrompt" representedClassName=".BloggingPrompt" syncable="YES">
+    <entity name="BloggingPrompt" representedClassName="WordPressData.BloggingPrompt" syncable="YES">
         <attribute name="additionalPostTags" optional="YES" attributeType="Transformable" valueTransformerName="NSSecureUnarchiveFromData" customClassName="[String]" syncable="YES"/>
         <attribute name="answerCount" attributeType="Integer 32" defaultValueString="0" usesScalarValueType="YES" syncable="YES"/>
         <attribute name="answered" attributeType="Boolean" defaultValueString="NO" usesScalarValueType="YES" syncable="YES"/>

Modules/Sources/WordPressData/WordPressData.swift

@@ -0,0 +1,29 @@
+@_exported import WordPressDataObjC
+
+public let modelURL: URL = {
+    guard let url = Bundle.module.url(forResource: "WordPress", withExtension: "momd") else {
+        fatalError("Cannot find model file.")
+    }
+    return url
+}()
+
+public func urlForModel(name: String, in directory: String?) -> URL? {
+    let bundle = Bundle(for: TemporaryDummyClassToPickUpModule.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
+}
+
+private class TemporaryDummyClassToPickUpModule {}

Modules/Sources/WordPressDataObjC/WordPressData.h

@@ -0,0 +1,6 @@
+FOUNDATION_EXPORT double WordPressDataVersionNumber;
+
+FOUNDATION_EXPORT const unsigned char WordPressDataVersionString[];
+
+#import <WordPressData/CoreDataService.h>
+#import <WordPressData/CoreDataStack.h>

WordPress/Classes/Services/CoreDataService.h → Modules/Sources/WordPressDataObjC/include/CoreDataService.h

@@ -1,5 +1,4 @@
 #import <Foundation/Foundation.h>
-
 #import "CoreDataStack.h"
 
 NS_ASSUME_NONNULL_BEGIN

WordPress/Classes/Utility/CoreData/CoreDataStack.h → Modules/Sources/WordPressDataObjC/include/CoreDataStack.h

@@ -4,11 +4,18 @@
 NS_ASSUME_NONNULL_BEGIN
 
 @protocol CoreDataStack
+
 @property (nonatomic, readonly, strong) NSManagedObjectContext *mainContext;
+
 - (NSManagedObjectContext *const)newDerivedContext DEPRECATED_MSG_ATTRIBUTE("Use `performAndSave` instead");
+
 - (void)saveContextAndWait:(NSManagedObjectContext *)context;
+
 - (void)saveContext:(NSManagedObjectContext *)context;
-- (void)saveContext:(NSManagedObjectContext *)context withCompletionBlock:(void (^ _Nullable)(void))completionBlock onQueue:(dispatch_queue_t)queue NS_SWIFT_NAME(save(_:completion:on:));
+
+- (void)saveContext:(NSManagedObjectContext *)context
+withCompletionBlock:(void (^ _Nullable)(void))completionBlock
+            onQueue:(dispatch_queue_t)queue NS_SWIFT_NAME(save(_:completion:on:));
 
 /// Execute the given block with a background context and save the changes.
 ///
@@ -27,7 +34,8 @@ NS_ASSUME_NONNULL_BEGIN
 ///   - aBlock: A block which uses the given `NSManagedObjectContext` to make Core Data model changes.
 ///   - completion: A block which is called after the changes made by the `block` are saved.
 ///   - queue: A queue on which to execute the `completion` block.
-- (void)performAndSaveUsingBlock:(void (^)(NSManagedObjectContext *context))aBlock completion:(void (^ _Nullable)(void))completion onQueue:(dispatch_queue_t)queue;
+- (void)performAndSaveUsingBlock:(void (^)(NSManagedObjectContext *context))aBlock
+                      completion:(void (^ _Nullable)(void))completion onQueue:(dispatch_queue_t)queue;
 
 @end
 

Modules/Sources/WordPressSharedObjC/Utility/NSObject+ClassName.m

@@ -0,0 +1,11 @@
+#import "NSObject+ClassName.h"
+
+@implementation NSObject (ClassName)
+
++ (NSString *)classNameWithoutNamespaces
+{
+    // Note that Swift prepends the module name to the class name itself
+    return [[NSStringFromClass(self) componentsSeparatedByString:@"."] lastObject];
+}
+
+@end

Modules/Sources/WordPressSharedObjC/include/NSObject+ClassName.h

@@ -0,0 +1,11 @@
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface NSObject (ClassName)
+
++ (NSString *)classNameWithoutNamespaces;
+
+@end
+
+NS_ASSUME_NONNULL_END

WordPress/Classes/Categories/Media+Extensions.m

@@ -1,7 +1,7 @@
 #import "Media+Extensions.h"
 #import "MediaService.h"
 #import "Blog.h"
-#import "CoreDataStack.h"
+@import WordPressDataObjC;
 #import "WordPress-Swift.h"
 
 @implementation Media (Extensions)

WordPress/Classes/Categories/NSObject+Helpers.h

@@ -4,6 +4,10 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface NSObject (Helpers)
 
+// FIXME: Currently duplicated in WordPressSharedObjC because it'll be used in WordPressData (which depends on WordPressSharedObjc)
+// It's not convenient to replace all usages in the main targets at this time.
+// They should progressively diminish as we move all the Core Data related code into WordPressData.
+// At that point, we should be able to remove this method from the main target.
 + (NSString *)classNameWithoutNamespaces;
 
 - (void)debounce:(SEL)selector afterDelay:(NSTimeInterval)timeInterval;

WordPress/Classes/Extensions/Media/Media+Sync.swift

@@ -1,5 +1,6 @@
 import Foundation
 import CoreData
+import WordPressData
 
 extension Media {
 

WordPress/Classes/Extensions/Post+BloggingPrompts.swift

@@ -1,4 +1,5 @@
 import Foundation
+import WordPressData
 
 extension Post {
 

WordPress/Classes/Login/WordPressDotComAuthenticator.swift

@@ -1,8 +1,8 @@
+import Alamofire
 import AuthenticationServices
 import Foundation
 import UIKit
-
-import Alamofire
+import WordPressData
 
 /// Log in or sign up a WordPress.com account via web.
 ///

WordPress/Classes/Models/AbstractPost.m

@@ -1,6 +1,6 @@
 #import "AbstractPost.h"
 #import "Media.h"
-#import "CoreDataStack.h"
+@import WordPressDataObjC;
 #import "WordPress-Swift.h"
 #import "BasePost.h"
 

WordPress/Classes/Models/BasePost.m

@@ -1,6 +1,6 @@
 #import "BasePost.h"
 #import "Media.h"
-#import "CoreDataStack.h"
+@import WordPressDataObjC;
 
 @import WordPressShared;
 

WordPress/Classes/Models/Blog/Blog.m

@@ -1,7 +1,7 @@
 #import "Blog.h"
 #import "WPAccount.h"
 #import "AccountService.h"
-#import "CoreDataStack.h"
+@import WordPressDataObjC;
 #import "Constants.h"
 #import "WPUserAgent.h"
 #import "WordPress-Swift.h"

WordPress/Classes/Models/BloggingPrompt+CoreDataClass.swift

@@ -1,25 +1,9 @@
 import Foundation
 import CoreData
+import WordPressData
 import WordPressKit
 
-public class BloggingPrompt: NSManagedObject {
-
-    @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 = []
-    }
-
-    var promptAttribution: BloggingPromptsAttribution? {
-        BloggingPromptsAttribution(rawValue: attribution.lowercased())
-    }
+extension BloggingPrompt {
 
     /// Convenience method to map properties from `BloggingPromptRemoteObject`.
     ///
@@ -42,6 +26,10 @@ public class BloggingPrompt: NSManagedObject {
         }
     }
 
+    var promptAttribution: BloggingPromptsAttribution? {
+        BloggingPromptsAttribution(rawValue: attribution.lowercased())
+    }
+
     func textForDisplay() -> String {
         return text.stringByDecodingXMLCharacters().trim()
     }

WordPress/Classes/Models/BloggingPrompt+CoreDataProperties.swift

@@ -1,31 +1,4 @@
 import Foundation
 import CoreData
 
-extension BloggingPrompt {
-    /// 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]?
-}
+// FIXME: Delete

WordPress/Classes/Models/Media.m

@@ -1,5 +1,5 @@
 #import "Media.h"
-#import "CoreDataStack.h"
+@import WordPressDataObjC;
 #import "WordPress-Swift.h"
 
 @implementation Media

WordPress/Classes/Models/ReaderPost.m

@@ -1,6 +1,6 @@
 #import "ReaderPost.h"
 #import "AccountService.h"
-#import "CoreDataStack.h"
+@import WordPressDataObjC;
 #import "SourcePostAttribution.h"
 #import "WPAccount.h"
 #import "WordPress-Swift.h"