Adds custom range case support to AnalyticsHubTimeRangeSelection

Author: Ecarrion

WooCommerce/Classes/ViewRelated/Dashboard/Analytics Hub/AnalyticsHubViewModel.swift

@@ -188,7 +188,18 @@ private extension AnalyticsHubViewModel {
             .removeDuplicates()
             .sink { [weak self] newSelectionType in
                 guard let self else { return }
-                self.timeRangeSelection = AnalyticsHubTimeRangeSelection(selectionType: newSelectionType)
+
+                // Temporary while the Custom Range Selection integration
+                let curatedSelection: AnalyticsHubTimeRangeSelection.SelectionType = {
+                    switch newSelectionType {
+                    case .custom(start: nil, end: nil):
+                        return .custom(start: Date().startOfWeek(timezone: .current), end: Date().endOfDay(timezone: .current))
+                    default:
+                        return newSelectionType
+                    }
+                }()
+
+                self.timeRangeSelection = AnalyticsHubTimeRangeSelection(selectionType: curatedSelection)
                 self.timeRangeCard = AnalyticsHubViewModel.timeRangeCard(timeRangeSelection: self.timeRangeSelection)
                 Task.init {
                     await self.updateData()

WooCommerce/Classes/ViewRelated/Dashboard/Analytics Hub/Time Range/AnalyticsHubTimeRangeSelection.swift

@@ -33,7 +33,17 @@ public class AnalyticsHubTimeRangeSelection {
          currentDate: Date = Date(),
          timezone: TimeZone = TimeZone.current,
          calendar: Calendar = Locale.current.calendar) {
-        let selectionData = selectionType.toRangeData(referenceDate: currentDate, timezone: timezone, calendar: calendar)
+
+        // Exit early if we can't generate a selection Data.
+        guard let selectionData = selectionType.toRangeData(referenceDate: currentDate, timezone: timezone, calendar: calendar) else {
+            self.currentTimeRange = nil
+            self.previousTimeRange = nil
+            self.formattedCurrentRangeText = nil
+            self.formattedPreviousRangeText = nil
+            self.rangeSelectionDescription = ""
+            return
+        }
+
         let currentTimeRange = selectionData.currentTimeRange
         let previousTimeRange = selectionData.previousTimeRange
         let useShortFormat = selectionType == .today || selectionType == .yesterday
@@ -67,7 +77,16 @@ public class AnalyticsHubTimeRangeSelection {
 
 // MARK: - Time Range Selection Type
 extension AnalyticsHubTimeRangeSelection {
-    enum SelectionType: CaseIterable {
+    enum SelectionType: CaseIterable, Equatable, Hashable {
+        /// Wee need to provide a custom `allCases` because the `.custom(Date?, Date?)`case  disables its synthetization.
+        ///
+        static var allCases: [AnalyticsHubTimeRangeSelection.SelectionType] {
+            [.custom(start: nil, end: nil), .today, .yesterday, .lastWeek, .lastMonth, .lastQuarter, .lastYear, .weekToDate, .monthToDate, .quarterToDate,
+             .yearToDate]
+        }
+
+        // When adding a new case, remember to add it to `allCases`.
+        case custom(start: Date?, end: Date?)
         case today
         case yesterday
         case lastWeek
@@ -81,6 +100,8 @@ extension AnalyticsHubTimeRangeSelection {
 
         var description: String {
             switch self {
+            case .custom:
+                return Localization.custom
             case .today:
                 return Localization.today
             case .yesterday:
@@ -121,8 +142,14 @@ extension AnalyticsHubTimeRangeSelection {
 
 // MARK: - SelectionType helper functions
 private extension AnalyticsHubTimeRangeSelection.SelectionType {
-    func toRangeData(referenceDate: Date, timezone: TimeZone, calendar: Calendar) -> AnalyticsHubTimeRangeData {
+    func toRangeData(referenceDate: Date, timezone: TimeZone, calendar: Calendar) -> AnalyticsHubTimeRangeData? {
         switch self {
+        case let .custom(start?, end?):
+            return AnalyticsHubCustomRangeData(start: start, end: end, timezone: timezone, calendar: calendar)
+        case .custom:
+            // Nil custom dates are not supported but can exists when the user has selected the custom range option but hasn't choosen dates yet.
+            // To properly fix this, we should decouple UI selection types, from ranges selection types.
+            return nil
         case .today:
             return AnalyticsHubTodayRangeData(referenceDate: referenceDate, timezone: timezone, calendar: calendar)
         case .yesterday:
@@ -155,6 +182,7 @@ extension AnalyticsHubTimeRangeSelection {
     }
 
     enum Localization {
+        static let custom = NSLocalizedString("Custom", comment: "Title of the Analytics Hub Custom selection range")
         static let today = NSLocalizedString("Today", comment: "Title of the Analytics Hub Today's selection range")
         static let yesterday = NSLocalizedString("Yesterday", comment: "Title of the Analytics Hub Yesterday selection range")
         static let lastWeek = NSLocalizedString("Last Week", comment: "Title of the Analytics Hub Last Week selection range")