Merge pull request #17429 from wordpress-mobile/feature/land-in-the-editor

A/B test landing in the editor

Author: mkevins

Podfile

@@ -20,7 +20,7 @@ workspace 'WordPress.xcworkspace'
 ## ===================================
 ##
 def wordpress_shared
-    pod 'WordPressShared', '~> 1.17.0'
+    pod 'WordPressShared', '~> 1.17.1-beta.1'
     #pod 'WordPressShared', :git => 'https://github.com/wordpress-mobile/WordPress-iOS-Shared.git', :tag => ''
     #pod 'WordPressShared', :git => 'https://github.com/wordpress-mobile/WordPress-iOS-Shared.git', :branch => ''
     #pod 'WordPressShared', :git => 'https://github.com/wordpress-mobile/WordPress-iOS-Shared.git', :commit  => ''

Podfile.lock

@@ -471,7 +471,7 @@ PODS:
     - WordPressShared (~> 1.15-beta)
     - wpxmlrpc (~> 0.9)
   - WordPressMocks (0.0.15)
-  - WordPressShared (1.17.0):
+  - WordPressShared (1.17.1-beta.1):
     - CocoaLumberjack (~> 3.4)
     - FormatterKit/TimeIntervalFormatter (~> 1.8)
   - WordPressUI (1.12.3)
@@ -569,7 +569,7 @@ DEPENDENCIES:
   - WordPressAuthenticator (~> 1.43.0)
   - WordPressKit (~> 4.47.0-beta.1)
   - WordPressMocks (~> 0.0.15)
-  - WordPressShared (~> 1.17.0)
+  - WordPressShared (~> 1.17.1-beta.1)
   - WordPressUI (~> 1.12.3)
   - WPMediaPicker (~> 1.8.2)
   - Yoga (from `https://raw.githubusercontent.com/wordpress-mobile/gutenberg-mobile/v1.70.0/third-party-podspecs/Yoga.podspec.json`)
@@ -579,6 +579,7 @@ DEPENDENCIES:
 SPEC REPOS:
   https://github.com/wordpress-mobile/cocoapods-specs.git:
     - WordPressAuthenticator
+    - WordPressShared
   trunk:
     - Alamofire
     - AlamofireImage
@@ -619,7 +620,6 @@ SPEC REPOS:
     - WordPress-Editor-iOS
     - WordPressKit
     - WordPressMocks
-    - WordPressShared
     - WordPressUI
     - WPMediaPicker
     - wpxmlrpc
@@ -833,7 +833,7 @@ SPEC CHECKSUMS:
   WordPressAuthenticator: e4a43745a647e4dc4b35d21b1353bc4f07f9f3c9
   WordPressKit: 375f54b3b27bf37f8fc5ed444afd0507fe48a2c7
   WordPressMocks: 6b52b0764d9939408151367dd9c6e8a910877f4d
-  WordPressShared: a4b0308a6345d4dda20c8f7ad9317df4246b4a00
+  WordPressShared: bc50e38a31e05134a7c643cef9cf6a7e28e9cf34
   WordPressUI: 45591178e843ecb82e65e868ec766148befe9f9f
   WPMediaPicker: a34b708a7b995a0889bd5098e3b79f4a50a7a9bd
   wpxmlrpc: bf55a43a7e710bd2a4fb8c02dfe83b1246f14f13
@@ -847,6 +847,6 @@ SPEC CHECKSUMS:
   ZendeskSupportSDK: 3a8e508ab1d9dd22dc038df6c694466414e037ba
   ZIPFoundation: e27423c004a5a1410c15933407747374e7c6cb6e
 
-PODFILE CHECKSUM: b10963dbcbffa2add515936104b784dcc64f8ad3
+PODFILE CHECKSUM: c9667ea89c8f053063df53439705577c83f22e17
 
 COCOAPODS: 1.11.2

WordPress/Classes/Models/Blog+HomepageSettings.swift

@@ -99,4 +99,15 @@ extension Blog {
             setValue(number as Any, forOption: OptionsKeys.homepageID)
         }
     }
+
+    /// Getter which returns the current homepage (or nil)
+    /// Note: It seems to be necessary to first sync pages (otherwise the `findPost` result fails to cast to `Page`)
+    var homepage: Page? {
+        guard let pageID = homepageType == .page ? homepagePageID
+                : homepageType == .posts ? homepagePostsPageID
+                : nil else { return nil }
+        let context = ContextManager.sharedInstance().mainContext
+        let postService = PostService(managedObjectContext: context)
+        return postService.findPost(withID: NSNumber(value: pageID), in: self) as? Page
+    }
 }

WordPress/Classes/Utility/AB Testing/ABTest.swift

@@ -2,6 +2,7 @@ import AutomatticTracks
 
 enum ABTest: String, CaseIterable {
     case unknown = "unknown"
+    case landInTheEditorPhase1 = "wpios_land_in_the_editor_phase1_v3"
 
     /// Returns a variation for the given experiment
     var variation: Variation {

WordPress/Classes/Utility/Analytics/WPAnalyticsTrackerAutomatticTracks.m

@@ -790,6 +790,9 @@ + (TracksEventPair *)eventPairForStat:(WPAnalyticsStat)stat
         case WPAnalyticsStatInstallJetpackWebviewFailed:
             eventName = @"connect_jetpack_failed";
             break;
+        case WPAnalyticsStatLandingEditorShown:
+            eventName = @"landing_editor_shown";
+            break;
         case WPAnalyticsStatLayoutPickerPreviewErrorShown:
             eventName = @"layout_picker_preview_error_shown";
             break;

WordPress/Classes/Utility/Editor/EditorFactory.swift

@@ -20,7 +20,7 @@ class EditorFactory {
         }
     }
 
-    private func createGutenbergVC(with post: AbstractPost, loadAutosaveRevision: Bool, replaceEditor: @escaping ReplaceEditorBlock) -> GutenbergViewController {
+    func createGutenbergVC(with post: AbstractPost, loadAutosaveRevision: Bool, replaceEditor: @escaping ReplaceEditorBlock) -> GutenbergViewController {
         let gutenbergVC = GutenbergViewController(post: post, loadAutosaveRevision: loadAutosaveRevision, replaceEditor: replaceEditor)
 
         if gutenbergSettings.shouldAutoenableGutenberg(for: post) {
@@ -33,6 +33,19 @@ class EditorFactory {
         return gutenbergVC
     }
 
+    // TODO: DRY this up
+    func createHomepageGutenbergVC(with post: AbstractPost, loadAutosaveRevision: Bool, replaceEditor: @escaping ReplaceEditorBlock) -> EditHomepageViewController {
+        let gutenbergVC = EditHomepageViewController(post: post, loadAutosaveRevision: loadAutosaveRevision, replaceEditor: replaceEditor)
+
+        if gutenbergSettings.shouldAutoenableGutenberg(for: post) {
+            gutenbergSettings.setGutenbergEnabled(true, for: post.blog, source: .onBlockPostOpening)
+            gutenbergSettings.postSettingsToRemote(for: post.blog)
+            gutenbergVC.shouldPresentInformativeDialog = true
+            gutenbergSettings.willShowDialog(for: post.blog)
+        }
+
+        return gutenbergVC
+    }
     func switchToGutenberg(from source: EditorViewController) {
         let replacement = GutenbergViewController(post: source.post, replaceEditor: source.replaceEditor, editorSession: source.editorSession)
         source.replaceEditor(source, replacement)

WordPress/Classes/ViewRelated/Gutenberg/EditHomepageViewController.swift

@@ -0,0 +1,45 @@
+import Foundation
+
+class EditHomepageViewController: GutenbergViewController {
+    required init(
+        post: AbstractPost,
+        loadAutosaveRevision: Bool = false,
+        replaceEditor: @escaping ReplaceEditorCallback,
+        editorSession: PostEditorAnalyticsSession? = nil,
+        navigationBarManager: PostEditorNavigationBarManager? = nil
+    ) {
+        let navigationBarManager = navigationBarManager ?? HomepageEditorNavigationBarManager()
+        super.init(post: post, loadAutosaveRevision: loadAutosaveRevision, replaceEditor: replaceEditor, editorSession: editorSession, navigationBarManager: navigationBarManager)
+    }
+
+    required init?(coder aDecoder: NSCoder) {
+        fatalError("init(coder:) has not been implemented")
+    }
+
+    private(set) lazy var homepageEditorStateContext: PostEditorStateContext = {
+        return PostEditorStateContext(post: post, delegate: self, action: .continueFromHomepageEditing)
+    }()
+
+    override var postEditorStateContext: PostEditorStateContext {
+        return homepageEditorStateContext
+    }
+
+    // If there are changes, offer to save them, otherwise continue will dismiss the editor with no changes.
+    override func continueFromHomepageEditing() {
+        if editorHasChanges {
+            handlePublishButtonTap()
+        } else {
+            cancelEditing()
+        }
+    }
+}
+
+extension EditHomepageViewController: HomepageEditorNavigationBarManagerDelegate {
+    var continueButtonText: String {
+        return postEditorStateContext.publishButtonText
+    }
+
+    func navigationBarManager(_ manager: HomepageEditorNavigationBarManager, continueWasPressed sender: UIButton) {
+        requestHTML(for: .continueFromHomepageEditing)
+    }
+}

WordPress/Classes/ViewRelated/Gutenberg/GutenbergViewController.swift

@@ -6,7 +6,6 @@ import WordPressFlux
 import Kanvas
 
 class GutenbergViewController: UIViewController, PostEditor, FeaturedImageDelegate {
-
     let errorDomain: String = "GutenbergViewController.errorDomain"
 
     enum RequestHTMLReason {
@@ -15,6 +14,7 @@ class GutenbergViewController: UIViewController, PostEditor, FeaturedImageDelega
         case more
         case switchBlog
         case autoSave
+        case continueFromHomepageEditing
     }
 
     private lazy var stockPhotos: GutenbergStockPhotos = {
@@ -223,7 +223,7 @@ class GutenbergViewController: UIViewController, PostEditor, FeaturedImageDelega
     ///
     var loadAutosaveRevision: Bool
 
-    let navigationBarManager = PostEditorNavigationBarManager()
+    let navigationBarManager: PostEditorNavigationBarManager
 
     lazy var attachmentDelegate = AztecAttachmentDelegate(post: post)
 
@@ -299,25 +299,32 @@ class GutenbergViewController: UIViewController, PostEditor, FeaturedImageDelega
     }()
 
     // MARK: - Initializers
+    required convenience init(post: AbstractPost, loadAutosaveRevision: Bool, replaceEditor: @escaping ReplaceEditorCallback, editorSession: PostEditorAnalyticsSession?) {
+        self.init(post: post, loadAutosaveRevision: loadAutosaveRevision, replaceEditor: replaceEditor, editorSession: editorSession)
+    }
+
     required init(
         post: AbstractPost,
         loadAutosaveRevision: Bool = false,
-        replaceEditor: @escaping (EditorViewController, EditorViewController) -> (),
-        editorSession: PostEditorAnalyticsSession? = nil) {
+        replaceEditor: @escaping ReplaceEditorCallback,
+        editorSession: PostEditorAnalyticsSession? = nil,
+        navigationBarManager: PostEditorNavigationBarManager? = nil
+    ) {
 
         self.post = post
         self.loadAutosaveRevision = loadAutosaveRevision
 
         self.replaceEditor = replaceEditor
         verificationPromptHelper = AztecVerificationPromptHelper(account: self.post.blog.account)
         self.editorSession = PostEditorAnalyticsSession(editor: .gutenberg, post: post)
+        self.navigationBarManager = navigationBarManager ?? PostEditorNavigationBarManager()
 
         super.init(nibName: nil, bundle: nil)
 
         addObservers(toPost: post)
 
         PostCoordinator.shared.cancelAnyPendingSaveOf(post: post)
-        navigationBarManager.delegate = self
+        self.navigationBarManager.delegate = self
     }
 
     required init?(coder aDecoder: NSCoder) {
@@ -882,10 +889,19 @@ extension GutenbergViewController: GutenbergBridgeDelegate {
                 blogPickerWasPressed()
             case .autoSave:
                 break
+                // Inelegant :(
+            case .continueFromHomepageEditing:
+                continueFromHomepageEditing()
+                break
             }
         }
     }
 
+    // Not ideal, but seems the least bad of the alternatives
+    @objc func continueFromHomepageEditing() {
+        fatalError("This method must be overriden by the extending class")
+    }
+
     func gutenbergDidLayout() {
         defer {
             isFirstGutenbergLayout = false

WordPress/Classes/ViewRelated/Pages/EditPageViewController.swift

@@ -6,11 +6,19 @@ class EditPageViewController: UIViewController {
     fileprivate var postTitle: String?
     fileprivate var content: String?
     fileprivate var hasShownEditor = false
+    fileprivate var isHomePageEditor = false
+    private var homepageEditorCompletion: HomepageEditorCompletion?
 
     convenience init(page: Page) {
         self.init(page: page, blog: page.blog, postTitle: nil, content: nil, appliedTemplate: nil)
     }
 
+    convenience init(homepage: Page, completion: @escaping HomepageEditorCompletion) {
+        self.init(page: homepage)
+        isHomePageEditor = true
+        homepageEditorCompletion = completion
+    }
+
     convenience init(blog: Blog, postTitle: String?, content: String?, appliedTemplate: String?) {
         self.init(page: nil, blog: blog, postTitle: postTitle, content: content, appliedTemplate: appliedTemplate)
     }
@@ -35,7 +43,11 @@ class EditPageViewController: UIViewController {
     override func viewDidAppear(_ animated: Bool) {
         super.viewDidAppear(animated)
         if  !hasShownEditor {
-            showEditor()
+            if isHomePageEditor {
+                showHomepageEditor()
+            } else {
+                showEditor()
+            }
             hasShownEditor = true
         }
     }
@@ -58,6 +70,15 @@ class EditPageViewController: UIViewController {
         }
     }
 
+    fileprivate func showHomepageEditor() {
+        let editorFactory = EditorFactory()
+        let gutenbergVC = editorFactory.createHomepageGutenbergVC(with: self.pageToEdit(), loadAutosaveRevision: false, replaceEditor: { [weak self] (editor, replacement) in
+            self?.replaceEditor(editor: editor, replacement: replacement)
+        })
+
+        show(gutenbergVC)
+    }
+
     fileprivate func showEditor() {
         let editorFactory = EditorFactory()
 
@@ -75,7 +96,10 @@ class EditPageViewController: UIViewController {
             // Dismiss navigation controller
             self?.dismiss(animated: true) {
                 // Dismiss self
-                self?.dismiss(animated: false)
+                self?.dismiss(animated: false) {
+                    // Invoke completion
+                    self?.homepageEditorCompletion?()
+                }
             }
         }
 

WordPress/Classes/ViewRelated/Post/HomepageEditorNavigationBarManager.swift

@@ -0,0 +1,58 @@
+import Foundation
+
+protocol HomepageEditorNavigationBarManagerDelegate: PostEditorNavigationBarManagerDelegate {
+    var continueButtonText: String { get }
+
+    func navigationBarManager(_ manager: HomepageEditorNavigationBarManager, continueWasPressed sender: UIButton)
+}
+
+class HomepageEditorNavigationBarManager: PostEditorNavigationBarManager {
+    weak var homepageEditorNavigationBarManagerDelegate: HomepageEditorNavigationBarManagerDelegate?
+
+    override weak var delegate: PostEditorNavigationBarManagerDelegate? {
+        get {
+            return homepageEditorNavigationBarManagerDelegate
+        }
+        set {
+            if let newDelegate = newValue {
+                if let newHomepageDelegate = newDelegate as? HomepageEditorNavigationBarManagerDelegate {
+                    homepageEditorNavigationBarManagerDelegate = newHomepageDelegate
+                } else {
+                    // This should not happen, but fail fast in case
+                    fatalError("homepageEditorNavigationBarManagerDelegate must be of type HomepageEditorNavigationBarManagerDelegate?")
+                }
+            } else {
+                homepageEditorNavigationBarManagerDelegate = nil
+            }
+        }
+    }
+
+    /// Continue Button
+    private(set) lazy var continueButton: UIButton = {
+        let button = UIButton(type: .system)
+        button.addTarget(self, action: #selector(continueButtonTapped(sender:)), for: .touchUpInside)
+        button.setTitle(homepageEditorNavigationBarManagerDelegate?.continueButtonText ?? "", for: .normal)
+        button.sizeToFit()
+        button.isEnabled = true
+        button.setContentHuggingPriority(.required, for: .horizontal)
+        return button
+    }()
+
+    /// Continue Button
+    private(set) lazy var continueBarButtonItem: UIBarButtonItem = {
+        let button = UIBarButtonItem(customView: self.continueButton)
+        return button
+    }()
+
+    @objc private func continueButtonTapped(sender: UIButton) {
+        homepageEditorNavigationBarManagerDelegate?.navigationBarManager(self, continueWasPressed: sender)
+    }
+
+    override var leftBarButtonItems: [UIBarButtonItem] {
+        return []
+    }
+
+    override var rightBarButtonItems: [UIBarButtonItem] {
+        return [moreBarButtonItem, continueBarButtonItem, separatorButtonItem]
+    }
+}