Rework EditorThemeStore to be stored in CoreData

MIGRATIONS.md

@@ -3,6 +3,32 @@
 This file documents changes in the data model. Please explain any changes to the
 data model as well as any custom migrations.
 
+## WordPress 120
+
+@chipsnyder 2021-04-12
+
+- Created a new entity `BlockEditorSettings` with:
+  - `isFSETheme` (required, default `false`, `Boolean`) FSE = "Full Site Editing"
+  - `lastUpdated` (required, no default, `Date`)
+
+- Created a new entity `BlockEditorSettingElement` with:
+  - `type` (required, no default, `String`)
+  - `value` (required, no default, `String`)
+  - `slug` (required, no default, `String`)
+  - `name` ( required, no default, `String`)
+
+- Created one-to-many relationship between `BlockEditorSettings` and `BlockEditorSettingElement`
+  - `BlockEditorSettings`
+    - `elements` (optional, to-many, cascade on delete)
+  - `BlockEditorSettingElement`
+    - `settings` (required, to-one, nullify on delete)
+
+- Created one-to-one relationship between `Blog` and `BlockEditorSettings`
+  - `BlockEditorSettings`
+    - `blockEditorSettings` (optional, to-one, cascade on delete)
+  - `BlockEditorSettings`
+    - `blog` (required, to-one, nullify on delete)
+
 ## WordPress 119
 
 @mkevins 2021-03-31

Podfile

@@ -47,9 +47,9 @@ def wordpress_ui
 end
 
 def wordpress_kit
-    pod 'WordPressKit', '~> 4.30.0'
+    # pod 'WordPressKit', '~> 4.30.0'
     # pod 'WordPressKit', :git => 'https://github.com/wordpress-mobile/WordPressKit-iOS.git', :tag => ''
-    # pod 'WordPressKit', :git => 'https://github.com/wordpress-mobile/WordPressKit-iOS.git', :branch => ''
+    pod 'WordPressKit', :git => 'https://github.com/wordpress-mobile/WordPressKit-iOS.git', :branch => 'task/addWrapperForRestAPIs'
     # pod 'WordPressKit', :git => 'https://github.com/wordpress-mobile/WordPressKit-iOS.git', :commit => ''
     # pod 'WordPressKit', :path => '../WordPressKit-iOS'
 end
@@ -161,7 +161,7 @@ abstract_target 'Apps' do
     ## Gutenberg (React Native)
     ## =====================
     ##
-    gutenberg :tag => 'v1.50.0'
+    gutenberg :commit => '619aa0a7a2e776d1ffa89a676956948b87bb59f6'
 
 
     ## Third party libraries

WordPress/Classes/Models/BlockEditorSettingElement+CoreDataClass.swift

@@ -0,0 +1,7 @@
+import Foundation
+import CoreData
+
+@objc(BlockEditorSettingElement)
+public class BlockEditorSettingElement: NSManagedObject {
+
+}

WordPress/Classes/Models/BlockEditorSettingElement+CoreDataProperties.swift

@@ -0,0 +1,59 @@
+import Foundation
+import CoreData
+
+enum BlockEditorSettingElementTypes: String {
+    case color
+    case gradient
+
+    var valueKey: String {
+        self.rawValue
+    }
+}
+
+extension BlockEditorSettingElement {
+
+    @nonobjc public class func fetchRequest() -> NSFetchRequest<BlockEditorSettingElement> {
+        return NSFetchRequest<BlockEditorSettingElement>(entityName: "BlockEditorSettingElement")
+    }
+
+    /// Stores the associated type that this object represents.
+    /// Available types are defined in `BlockEditorSettingElementTypes`
+    ///
+    @NSManaged public var type: String
+
+    /// Stores the value for the associated type. The associated field in the API response might differ based on the type.
+    ///
+    @NSManaged public var value: String
+
+    /// Stores a unique key associated to the `value`.
+    ///
+    @NSManaged public var slug: String
+
+    /// Stores a user friendly display name for the `slug`.
+    ///
+    @NSManaged public var name: String
+
+    /// Stores a reference back to the parent `BlockEditorSettings`.
+    ///
+    @NSManaged public var settings: BlockEditorSettings
+}
+
+extension BlockEditorSettingElement: Identifiable {
+    var rawRepresentation: [String: String]? {
+        guard let type = BlockEditorSettingElementTypes(rawValue: self.type) else { return nil }
+        return [
+            #keyPath(BlockEditorSettingElement.slug): self.slug,
+            #keyPath(BlockEditorSettingElement.name): self.name,
+            type.valueKey: self.value
+        ]
+    }
+
+    convenience init(fromRawRepresentation rawObject: [String: String], type: BlockEditorSettingElementTypes, context: NSManagedObjectContext) {
+        self.init(context: context)
+
+        self.type = type.rawValue
+        self.value = rawObject[type.valueKey] ?? ""
+        self.slug = rawObject[#keyPath(BlockEditorSettingElement.slug)] ?? ""
+        self.name = rawObject[ #keyPath(BlockEditorSettingElement.name)] ?? ""
+    }
+}

WordPress/Classes/Models/BlockEditorSettings+CoreDataClass.swift

@@ -0,0 +1,7 @@
+import Foundation
+import CoreData
+
+@objc(BlockEditorSettings)
+public class BlockEditorSettings: NSManagedObject {
+
+}

WordPress/Classes/Models/BlockEditorSettings+CoreDataProperties.swift

@@ -0,0 +1,51 @@
+import Foundation
+import CoreData
+
+extension BlockEditorSettings {
+
+    @nonobjc public class func fetchRequest() -> NSFetchRequest<BlockEditorSettings> {
+        return NSFetchRequest<BlockEditorSettings>(entityName: "BlockEditorSettings")
+    }
+
+    /// Stores a n MD5 checksum representing the stored data. Used for a comparison to decide if the data has changed.
+    ///
+    @NSManaged public var checksum: String
+
+    /// Stores a Bool indicating if the theme supports Full Site Editing (FSE) or not. `true` means the theme is an FSE theme.
+    /// Default is `false`
+    ///
+    @NSManaged public var isFSETheme: Bool
+
+    /// Stores a date indicating the last time stamp that the settings were modified. 
+    ///
+    @NSManaged public var lastUpdated: Date
+
+    /// Stores a set of attributes describing values that are represented with arrays in the API request.
+    /// Available types are defined in `BlockEditorSettingElementTypes`
+    ///
+    @NSManaged public var elements: Set<BlockEditorSettingElement>?
+
+    /// Stores a reference back to the parent blog. 
+    ///
+    @NSManaged public var blog: Blog
+}
+
+// MARK: Generated accessors for elements
+extension BlockEditorSettings {
+
+    @objc(addElementsObject:)
+    @NSManaged public func addToElements(_ value: BlockEditorSettingElement)
+
+    @objc(removeElementsObject:)
+    @NSManaged public func removeFromElements(_ value: BlockEditorSettingElement)
+
+    @objc(addElements:)
+    @NSManaged public func addToElements(_ values: Set<BlockEditorSettingElement>)
+
+    @objc(removeElements:)
+    @NSManaged public func removeFromElements(_ values: Set<BlockEditorSettingElement>)
+}
+
+extension BlockEditorSettings: Identifiable {
+
+}

WordPress/Classes/Models/BlockEditorSettings+GutenbergEditorTheme.swift

@@ -0,0 +1,40 @@
+import Foundation
+import Gutenberg
+
+extension BlockEditorSettings: GutenbergEditorTheme {
+    public var colors: [[String: String]]? {
+        elementsByType(.color)
+    }
+
+    public var gradients: [[String: String]]? {
+        elementsByType(.gradient)
+    }
+
+    private func elementsByType(_ type: BlockEditorSettingElementTypes) -> [[String: String]]? {
+        return elements?.compactMap({ (element) -> [String: String]? in
+            guard element.type == type.rawValue else { return nil }
+            return element.rawRepresentation
+        })
+    }
+}
+
+extension BlockEditorSettings {
+    convenience init?(editorTheme: EditorTheme, context: NSManagedObjectContext) {
+        self.init(context: context)
+        self.lastUpdated = Date()
+        self.checksum = editorTheme.checksum
+
+        var parsedElements = Set<BlockEditorSettingElement>()
+        if let themeSupport = editorTheme.themeSupport {
+            themeSupport.colors?.forEach({ (color) in
+                parsedElements.insert(BlockEditorSettingElement(fromRawRepresentation: color, type: .color, context: context))
+            })
+
+            themeSupport.gradients?.forEach({ (gradient) in
+                parsedElements.insert(BlockEditorSettingElement(fromRawRepresentation: gradient, type: .gradient, context: context))
+            })
+        }
+
+        self.elements = parsedElements
+    }
+}

WordPress/Classes/Models/Blog+BlockEditorSettings.swift

@@ -0,0 +1,10 @@
+import Foundation
+import CoreData
+
+extension Blog {
+
+    /// Stores the relationship to the `BlockEditorSettings` which is an optional entity that holds settings realated to the BlockEditor. These are features
+    /// such as Global Styles and Full Site Editing settings and capabilities. 
+    ///
+    @NSManaged public var blockEditorSettings: BlockEditorSettings?
+}

WordPress/Classes/Models/EditorTheme.swift

@@ -1,30 +1,35 @@
 import Foundation
 import Gutenberg
 
-struct EditorTheme: Codable, Equatable {
+struct EditorTheme: Codable {
     static func == (lhs: EditorTheme, rhs: EditorTheme) -> Bool {
-        return lhs.description == rhs.description
+        return lhs.checksum == rhs.checksum
     }
 
     enum CodingKeys: String, CodingKey {
         case themeSupport = "theme_supports"
-        case version
-        case stylesheet
     }
 
     let themeSupport: EditorThemeSupport?
-    let version: String?
-    let stylesheet: String?
-
-    var description: String {
-        return "\(stylesheet ?? "")-\(version ?? "")"
-    }
+    let checksum: String
 
     init(from decoder: Decoder) throws {
         let map = try decoder.container(keyedBy: CodingKeys.self)
-        self.themeSupport = try? map.decode(EditorThemeSupport.self, forKey: .themeSupport)
-        self.version = try? map.decode(String.self, forKey: .version)
-        self.stylesheet = try? map.decode(String.self, forKey: .stylesheet)
+        let parsedTheme = try? map.decode(EditorThemeSupport.self, forKey: .themeSupport)
+        self.themeSupport = parsedTheme
+        self.checksum = {
+            guard let parsedTheme = parsedTheme else { return "" }
+            let encoder = JSONEncoder()
+            encoder.outputFormatting = .sortedKeys
+            let result: String
+            do {
+                let data = try encoder.encode(parsedTheme)
+                result = String(data: data, encoding: .utf8) ?? ""
+            } catch {
+                result = ""
+            }
+            return result.md5()
+        }()
     }
 }