Merge pull request #18412 from wordpress-mobile/task/18388-qs-create-tour-2

Quick Start for Existing Users: Add new tasks collection for existing users

Author: hassaanelgarem

WordPress/Classes/Models/Blog+QuickStart.swift

@@ -9,6 +9,22 @@ extension Blog {
         return quickStartTours?.filter { $0.skipped }
     }
 
+    var quickStartType: QuickStartType {
+        get {
+            guard let value = quickStartTypeValue?.intValue,
+                    let type = QuickStartType(rawValue: value) else {
+                return .undefined
+            }
+            return type
+        }
+
+        set {
+            quickStartTypeValue = NSNumber(value: newValue.rawValue)
+            let context = managedObjectContext ?? ContextManager.sharedInstance().mainContext
+            ContextManager.sharedInstance().saveContextAndWait(context)
+        }
+    }
+
     public func skipTour(_ tourID: String) {
         let tourState = findOrCreate(tour: tourID)
         tourState.skipped = true

WordPress/Classes/Models/Blog.h

@@ -156,6 +156,7 @@ typedef NS_ENUM(NSInteger, SiteVisibility) {
 @property (nonatomic, strong, readwrite, nullable) NSSet *sharingButtons;
 @property (nonatomic, strong, readwrite, nullable) NSDictionary *capabilities;
 @property (nonatomic, strong, readwrite, nullable) NSSet<QuickStartTourState *> *quickStartTours;
+@property (nonatomic, strong, readwrite, nullable) NSNumber *quickStartTypeValue;
 /// The blog's user ID for the current user
 @property (nonatomic, strong, readwrite, nullable) NSNumber *userID;
 /// Disk quota for site, this is only available for WP.com sites

WordPress/Classes/Models/Blog.m

@@ -87,6 +87,7 @@ @implementation Blog
 @dynamic sharingButtons;
 @dynamic capabilities;
 @dynamic quickStartTours;
+@dynamic quickStartTypeValue;
 @dynamic userID;
 @dynamic quotaSpaceAllowed;
 @dynamic quotaSpaceUsed;

WordPress/Classes/Utility/BuildInformation/FeatureFlag.swift

@@ -27,6 +27,7 @@ enum FeatureFlag: Int, CaseIterable, OverrideableFlag {
     case statsNewAppearance
     case statsNewInsights
     case siteName
+    case quickStartForExistingUsers
 
     /// Returns a boolean indicating if the feature is enabled
     var enabled: Bool {
@@ -86,6 +87,8 @@ enum FeatureFlag: Int, CaseIterable, OverrideableFlag {
             return false
         case .siteName:
             return true
+        case .quickStartForExistingUsers:
+            return BuildConfiguration.current == .localDeveloper
         }
     }
 
@@ -166,6 +169,8 @@ extension FeatureFlag {
             return "New Cards for Stats Insights"
         case .siteName:
             return "Site Name"
+        case .quickStartForExistingUsers:
+            return "Quick Start For Existing Users"
         }
     }
 

WordPress/Classes/ViewRelated/Blog/Blog Dashboard/DashboardCard.swift

@@ -45,7 +45,7 @@ enum DashboardCard: String, CaseIterable {
     func shouldShow(for blog: Blog, apiResponse: BlogDashboardRemoteEntity? = nil, mySiteSettings: DefaultSectionProvider = MySiteSettings()) -> Bool {
         switch self {
         case .quickStart:
-            return QuickStartTourGuide.shouldShowChecklist(for: blog) && mySiteSettings.defaultSection == .dashboard
+            return QuickStartTourGuide.quickStartEnabled(for: blog) && mySiteSettings.defaultSection == .dashboard
         case .draftPosts:
             fallthrough
         case .scheduledPosts:

WordPress/Classes/ViewRelated/Blog/Blog Details/BlogDetailsViewController+FancyAlerts.swift

@@ -93,10 +93,10 @@ extension BlogDetailsViewController {
                 return false
             }
 
-            return QuickStartTourGuide.shouldShowChecklist(for: blog) && parentVC.mySiteSettings.defaultSection == .siteMenu
+            return QuickStartTourGuide.quickStartEnabled(for: blog) && parentVC.mySiteSettings.defaultSection == .siteMenu
         }
 
-        return QuickStartTourGuide.shouldShowChecklist(for: blog)
+        return QuickStartTourGuide.quickStartEnabled(for: blog)
     }
 
     @objc func showQuickStart() {

WordPress/Classes/ViewRelated/Blog/QuickStartFactory.swift

@@ -1,13 +1,28 @@
 import Foundation
 
-enum QuickStartType {
-    case newUser
-    case existingUser
+enum QuickStartType: Int {
+    case undefined
+    case newSite
+    case existingSite
 }
 
 class QuickStartFactory {
     static func collections(for blog: Blog) -> [QuickStartToursCollection] {
-        // TODO: Save QuickStartType in blog. Retrieve it here and return collections accordingly
-        return [QuickStartCustomizeToursCollection(blog: blog), QuickStartGrowToursCollection(blog: blog)]
+        switch blog.quickStartType {
+        case .undefined:
+            guard let completedTours = blog.completedQuickStartTours, completedTours.count > 0 else {
+                return []
+            }
+            // This is to support tours started before quickStartType was added.
+            fallthrough
+        case .newSite:
+            return [QuickStartCustomizeToursCollection(blog: blog), QuickStartGrowToursCollection(blog: blog)]
+        case .existingSite:
+            return [QuickStartGetToKnowAppCollection(blog: blog)]
+        }
+    }
+
+    static func allTours(for blog: Blog) -> [QuickStartTour] {
+        collections(for: blog).flatMap { $0.tours }
     }
 }

WordPress/Classes/ViewRelated/Blog/QuickStartTourGuide.swift

@@ -30,35 +30,37 @@ open class QuickStartTourGuide: NSObject {
 
     private override init() {}
 
-    func setup(for blog: Blog, withCompletedSteps steps: [QuickStartTour] = []) {
-
-        let createTour = QuickStartCreateTour()
-        completed(tour: createTour, for: blog)
+    func setup(for blog: Blog, type: QuickStartType, withCompletedSteps steps: [QuickStartTour] = []) {
+        if type == .newSite {
+            let createTour = QuickStartCreateTour()
+            completed(tour: createTour, for: blog)
+        }
 
         steps.forEach { (tour) in
             completed(tour: tour, for: blog)
         }
         tourInProgress = false
+        blog.quickStartType = type
 
+        NotificationCenter.default.post(name: .QuickStartTourElementChangedNotification, object: self)
         WPAnalytics.track(.quickStartStarted)
     }
 
-    func setupWithDelay(for blog: Blog, withCompletedSteps steps: [QuickStartTour] = []) {
+    func setupWithDelay(for blog: Blog, type: QuickStartType, withCompletedSteps steps: [QuickStartTour] = []) {
         DispatchQueue.main.asyncAfter(deadline: .now() + Constants.quickStartDelay) {
-            self.setup(for: blog, withCompletedSteps: steps)
+            self.setup(for: blog, type: type, withCompletedSteps: steps)
         }
     }
 
     @objc func remove(from blog: Blog) {
         blog.removeAllTours()
+        blog.quickStartType = .undefined
         endCurrentTour()
         NotificationCenter.default.post(name: .QuickStartTourElementChangedNotification, object: self)
     }
 
-    @objc static func shouldShowChecklist(for blog: Blog) -> Bool {
-        let list = QuickStartTourGuide.customizeListTours(for: blog) + QuickStartTourGuide.growListTours
-        let checklistCompletedCount = countChecklistCompleted(in: list, for: blog)
-        return checklistCompletedCount > 0
+    @objc static func quickStartEnabled(for blog: Blog) -> Bool {
+        QuickStartFactory.collections(for: blog).isEmpty == false
     }
 
     /// Provides a tour to suggest to the user
@@ -69,9 +71,9 @@ open class QuickStartTourGuide: NSObject {
         let completedTours: [QuickStartTourState] = blog.completedQuickStartTours ?? []
         let skippedTours: [QuickStartTourState] = blog.skippedQuickStartTours ?? []
         let unavailableTours = Array(Set(completedTours + skippedTours))
-        let allTours = QuickStartTourGuide.customizeListTours(for: blog) + QuickStartTourGuide.growListTours
+        let allTours = QuickStartFactory.allTours(for: blog)
 
-        guard isQuickStartEnabled(for: blog),
+        guard QuickStartTourGuide.quickStartEnabled(for: blog),
             recentlyTouredBlog == blog else {
                 return nil
         }
@@ -281,39 +283,9 @@ open class QuickStartTourGuide: NSObject {
         dismissCurrentNotice()
         currentTourState = nil
     }
-
-    static func customizeListTours(for blog: Blog) -> [QuickStartTour] {
-        return [
-            QuickStartCreateTour(),
-            QuickStartSiteTitleTour(blog: blog),
-            QuickStartSiteIconTour(),
-            QuickStartEditHomepageTour(),
-            QuickStartReviewPagesTour(),
-            QuickStartViewTour(blog: blog)
-        ]
-    }
-
-    static var growListTours: [QuickStartTour] {
-        return [
-            QuickStartShareTour(),
-            QuickStartPublishTour(),
-            QuickStartFollowTour(),
-            QuickStartCheckStatsTour()
-    // Temporarily disabled
-    //        QuickStartExplorePlansTour()
-        ]
-    }
 }
 
 private extension QuickStartTourGuide {
-    func isQuickStartEnabled(for blog: Blog) -> Bool {
-        // there must be at least one completed tour for quick start to have been enabled
-        guard let completedTours = blog.completedQuickStartTours else {
-                return false
-        }
-
-        return completedTours.count > 0
-    }
 
     func completed(tour: QuickStartTour, for blog: Blog, postNotification: Bool = true) {
         let completedTourIDs = (blog.completedQuickStartTours ?? []).map { $0.tourID }
@@ -357,7 +329,7 @@ private extension QuickStartTourGuide {
     /// - Parameter blog: blog to check
     /// - Returns: boolean, true if all tours have been completed
     func allToursCompleted(for blog: Blog) -> Bool {
-        let list = QuickStartTourGuide.customizeListTours(for: blog) + QuickStartTourGuide.growListTours
+        let list = QuickStartFactory.allTours(for: blog)
         return countChecklistCompleted(in: list, for: blog) >= list.count
     }
 

WordPress/Classes/ViewRelated/Blog/QuickStartToursCollection.swift

@@ -59,3 +59,25 @@ struct QuickStartGrowToursCollection: QuickStartToursCollection {
         ]
     }
 }
+
+struct QuickStartGetToKnowAppCollection: QuickStartToursCollection {
+    let title: String
+    let hint: String
+    let completedImageName: String
+    let analyticsKey: String
+    let tours: [QuickStartTour]
+
+    init(blog: Blog) {
+        self.title = NSLocalizedString("Get to know the WordPress app",
+                                      comment: "Name of the Quick Start list that guides users through a few tasks to explore the WordPress app.")
+        self.hint = NSLocalizedString("A series of steps helping you to explore the app.",
+                                     comment: "A VoiceOver hint to explain what the user gets when they select the 'Get to know the WordPress app' button.")
+        self.completedImageName = "wp-illustration-tasks-complete-site"
+        self.analyticsKey = "get-to-know"
+        self.tours = [
+            QuickStartCheckStatsTour(),
+            QuickStartViewTour(blog: blog),
+            QuickStartFollowTour()
+        ]
+    }
+}

WordPress/Classes/ViewRelated/Me/App Settings/DebugMenuViewController.swift

@@ -68,8 +68,11 @@ class DebugMenuViewController: UITableViewController {
 
     private var toolsRows: [ImmuTableRow] {
         var toolsRows = [
-            ButtonRow(title: Strings.quickStartRow, action: { [weak self] _ in
-                self?.displayBlogPickerForQuickStart()
+            ButtonRow(title: Strings.quickStartForNewSiteRow, action: { [weak self] _ in
+                self?.displayBlogPickerForQuickStart(type: .newSite)
+            }),
+            ButtonRow(title: Strings.quickStartForExistingSiteRow, action: { [weak self] _ in
+                self?.displayBlogPickerForQuickStart(type: .existingSite)
             }),
             ButtonRow(title: Strings.sandboxStoreCookieSecretRow, action: { [weak self] _ in
                 self?.displayStoreSandboxSecretInserter()
@@ -117,14 +120,14 @@ class DebugMenuViewController: UITableViewController {
         return rows
     }
 
-    private func displayBlogPickerForQuickStart() {
+    private func displayBlogPickerForQuickStart(type: QuickStartType) {
         let successHandler: BlogSelectorSuccessHandler = { [weak self] selectedObjectID in
             guard let blog = self?.blogService.managedObjectContext.object(with: selectedObjectID) as? Blog else {
                 return
             }
 
             self?.dismiss(animated: true) { [weak self] in
-                self?.enableQuickStart(for: blog)
+                self?.enableQuickStart(for: blog, type: type)
             }
         }
 
@@ -154,8 +157,8 @@ class DebugMenuViewController: UITableViewController {
         self.navigationController?.pushViewController(viewController, animated: true)
     }
 
-    private func enableQuickStart(for blog: Blog) {
-        QuickStartTourGuide.shared.setup(for: blog)
+    private func enableQuickStart(for blog: Blog, type: QuickStartType) {
+        QuickStartTourGuide.shared.setup(for: blog, type: type)
     }
 
     // MARK: Reader
@@ -181,7 +184,8 @@ class DebugMenuViewController: UITableViewController {
         static let featureFlags = NSLocalizedString("Feature flags", comment: "Title of the Feature Flags screen used in debug builds of the app")
         static let tools = NSLocalizedString("Tools", comment: "Title of the Tools section of the debug screen used in debug builds of the app")
         static let sandboxStoreCookieSecretRow = NSLocalizedString("Use Sandbox Store", comment: "Title of a row displayed on the debug screen used to configure the sandbox store use in the App.")
-        static let quickStartRow = NSLocalizedString("Enable Quick Start for Site", comment: "Title of a row displayed on the debug screen used in debug builds of the app")
+        static let quickStartForNewSiteRow = NSLocalizedString("Enable Quick Start for New Site", comment: "Title of a row displayed on the debug screen used in debug builds of the app")
+        static let quickStartForExistingSiteRow = NSLocalizedString("Enable Quick Start for Existing Site", comment: "Title of a row displayed on the debug screen used in debug builds of the app")
         static let sendTestCrash = NSLocalizedString("Send Test Crash", comment: "Title of a row displayed on the debug screen used to crash the app and send a crash report to the crash logging provider to ensure everything is working correctly")
         static let sendLogMessage = NSLocalizedString("Send Log Message", comment: "Title of a row displayed on the debug screen used to send a pretend error message to the crash logging provider to ensure everything is working correctly")
         static let alwaysSendLogs = NSLocalizedString("Always Send Crash Logs", comment: "Title of a row displayed on the debug screen used to indicate whether crash logs should be forced to send, even if they otherwise wouldn't")