Reader: Update Reader quick start tour with new message (#22557)

Author: wargcm

WordPress/Classes/ViewRelated/Blog/Blog Details/BlogDetailsViewController.h

@@ -69,7 +69,7 @@ typedef NS_ENUM(NSInteger, QuickStartTourElement) {
     QuickStartTourElementSharing = 8,
     QuickStartTourElementConnections = 9,
     QuickStartTourElementReaderTab = 10,
-    QuickStartTourElementReaderDiscoverSettings = 12,
+    QuickStartTourElementReaderDiscoverSubscriptions = 12,
     QuickStartTourElementTourCompleted = 13,
     QuickStartTourElementCongratulations = 14,
     QuickStartTourElementSiteIcon = 15,

WordPress/Classes/ViewRelated/Blog/QuickStartTourGuide.swift

@@ -42,6 +42,13 @@ open class QuickStartTourGuide: NSObject {
         return tourState.tour.mustBeShownInBlogDetails
     }
 
+    private var shouldAutoComplete: Bool {
+        guard let element = currentElement() else {
+            return false
+        }
+        return element.autoCompleteDelay != .never
+    }
+
     @objc static let shared = QuickStartTourGuide()
 
     private override init() {}
@@ -292,7 +299,7 @@ open class QuickStartTourGuide: NSObject {
         }
         if element != currentElement {
             let blogDetailEvents: [QuickStartTourElement] = [.blogDetailNavigation, .checklist, .themes, .viewSite, .sharing, .siteMenu]
-            let readerElements: [QuickStartTourElement] = [.readerTab, .readerDiscoverSettings]
+            let readerElements: [QuickStartTourElement] = [.readerTab, .readerDiscoverSubscriptions]
 
             if blogDetailEvents.contains(element) {
                 endCurrentTour()
@@ -442,6 +449,15 @@ private extension QuickStartTourGuide {
             showStepNotice(waypoint.description)
         }
 
+        if shouldAutoComplete {
+            let element = waypoint.element
+            DispatchQueue.main.asyncAfter(deadline: .now() + element.autoCompleteDelay) {
+                if element == self.currentElement() {
+                    self.visited(element)
+                }
+            }
+        }
+
         let userInfo: [String: Any] = [
             QuickStartTourGuide.notificationElementKey: waypoint.element,
             QuickStartTourGuide.notificationDescriptionKey: waypoint.description
@@ -527,3 +543,18 @@ private struct TourState {
     var blog: Blog
     var step: Int
 }
+
+extension QuickStartTourElement {
+
+    /// The delay to wait before auto completing the tour step. A value of `.never` means it will
+    /// not auto complete.
+    var autoCompleteDelay: DispatchTimeInterval {
+        switch self {
+        case .readerDiscoverSubscriptions:
+            return .seconds(5)
+        default:
+            return .never
+        }
+    }
+
+}

WordPress/Classes/ViewRelated/Blog/QuickStartTours.swift

@@ -176,21 +176,35 @@ struct QuickStartFollowTour: QuickStartTour {
     var waypoints: [WayPoint] = {
         let step1DescriptionBase = NSLocalizedString("Select %@ to find other sites.", comment: "A step in a guided tour for quick start. %@ will be the name of the item to select.")
         let step1DescriptionTarget = NSLocalizedString("Reader", comment: "The menu item to select during a guided tour.")
-        let step1: WayPoint = (element: .readerTab, description: step1DescriptionBase.highlighting(phrase: step1DescriptionTarget, icon: .gridicon(.reader)))
+        let step1: WayPoint = (element: .readerTab,
+                               description: step1DescriptionBase.highlighting(phrase: step1DescriptionTarget,
+                                                                              icon: UIImage(named: "tab-bar-reader-selected")))
 
         let step2DiscoverDescriptionBase = NSLocalizedString("Use %@ to find sites and tags.", comment: "A step in a guided tour for quick start. %@ will be the name of the item to select.")
         let step2DiscoverDescriptionTarget = NSLocalizedString("Discover", comment: "The menu item to select during a guided tour.")
         let step2DiscoverDescription = step2DiscoverDescriptionBase.highlighting(phrase: step2DiscoverDescriptionTarget, icon: nil)
 
-        let step2SettingsDescriptionBase = NSLocalizedString("Try selecting %@ to add topics you like.", comment: "A step in a guided tour for quick start. %@ will be the name of the item to select.")
-        let step2SettingsDescriptionTarget = NSLocalizedString("Settings", comment: "The menu item to select during a guided tour.")
-        let step2SettingsDescription = step2SettingsDescriptionBase.highlighting(phrase: step2SettingsDescriptionTarget, icon: .gridicon(.cog))
+        let step2SubscriptionDescriptionBase = NSLocalizedString(
+            "quick.start.reader.2.subscriptions.base",
+            value: "Try selecting %@ to view subscribed content and manage your subscriptions.",
+            comment: "A step in a guided tour for quick start. %@ will be a bolded Subscriptions text."
+        )
+        let step2SubscriptionDescriptionTarget = NSLocalizedString(
+            "quick.start.reader.2.subscriptions.target",
+            value: "Subscriptions",
+            comment: "The bolded Subscriptions text in the Reader step 2 description for the quick start tour."
+        )
+        let step2SubscriptionDescription = step2SubscriptionDescriptionBase.highlighting(
+            phrase: step2SubscriptionDescriptionTarget,
+            icon: nil
+        )
 
         /// Combined description for step 2
         let step2Format = NSAttributedString(string: "%@ %@")
-        let step2Description = NSAttributedString(format: step2Format, args: step2DiscoverDescription, step2SettingsDescription)
+        let step2Description = NSAttributedString(format: step2Format,
+                                                  args: step2DiscoverDescription, step2SubscriptionDescription)
 
-        let step2: WayPoint = (element: .readerDiscoverSettings, description: step2Description)
+        let step2: WayPoint = (element: .readerDiscoverSubscriptions, description: step2Description)
 
         return [step1, step2]
     }()

WordPress/Classes/ViewRelated/Reader/Manage/ReaderManageScenePresenter.swift

@@ -70,7 +70,6 @@ class ReaderManageScenePresenter {
         presentedViewController = navigationController
         viewController.present(navigationController, animated: true, completion: nil)
 
-        QuickStartTourGuide.shared.visited(.readerDiscoverSettings)
         WPAnalytics.track(.readerManageViewDisplayed)
     }
 }

WordPress/Classes/ViewRelated/Reader/Select Interests/ReaderSelectInterestsViewController.swift

@@ -344,9 +344,6 @@ extension ReaderSelectInterestsViewController: UICollectionViewDelegate {
             spotlightIsShown = false
         }
 
-        // End reader quick start tour if user selects a topic.
-        QuickStartTourGuide.shared.visited(.readerDiscoverSettings)
-
         dataSource.interest(for: indexPath.row).toggleSelected()
         updateNextButtonState()
 

WordPress/Classes/ViewRelated/Reader/Tab Navigation/ReaderTabViewController.swift

@@ -61,14 +61,6 @@ class ReaderTabViewController: UIViewController {
     override func viewWillAppear(_ animated: Bool) {
         super.viewWillAppear(animated)
 
-        if QuickStartTourGuide.shared.isCurrentElement(.readerDiscoverSettings) {
-
-            if viewModel.selectedIndex != ReaderTabConstants.discoverIndex {
-                viewModel.showTab(at: ReaderTabConstants.discoverIndex)
-            }
-
-            // TODO: Revisit Reader spotlight
-        }
         navigationController?.setNavigationBarHidden(true, animated: animated)
     }