Adds a new Range enum only meant for ui consumption

Author: Ecarrion

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

@@ -31,13 +31,14 @@ struct AnalyticsTimeRangeCard: View {
         createTimeRangeContent()
             .sheet(isPresented: $showTimeRangeSelectionView) {
                 SelectionList(title: Localization.timeRangeSelectionTitle,
-                              items: AnalyticsHubTimeRangeSelection.SelectionType.allCases,
+                              items: Range.allCases,
                               contentKeyPath: \.description,
                               selected: internalSelectionBinding()) { selection in
                     usageTracksEventEmitter.interacted()
                     ServiceLocator.analytics.track(event: .AnalyticsHub.dateRangeOptionSelected(selection.tracksIdentifier))
                 }
                 .sheet(isPresented: $showCustomRangeSelectionView) {
+                    // TODO: Pass real dates here
                     RangedDatePicker() { start, end in
                         showTimeRangeSelectionView = false // Dismiss the initial sheet for a smooth transition
                         self.selectionType = .custom(start: start, end: end)
@@ -96,26 +97,19 @@ struct AnalyticsTimeRangeCard: View {
     /// Tracks the range selection internally to determine if the custom range selection should be presented or not.
     /// If custom range selection is not needed, the internal selection is forwarded to `selectionType`.
     ///
-    private func internalSelectionBinding() -> Binding<AnalyticsHubTimeRangeSelection.SelectionType> {
+    private func internalSelectionBinding() -> Binding<Range> {
         .init(
             get: {
-                // Temporary
-                switch selectionType {
-                    // If a `custom` case is set return one with nil values so the Custom row is selected
-                case .custom:
-                    return .custom(start: nil, end: nil)
-                default:
-                    return selectionType
-                }
+                return selectionType.asTimeCardRange
             },
             set: { newValue in
                 switch newValue {
-                    // If we get a `custom` case with nil dates it is because we need to present the custom range selection
-                case .custom(start: nil, end: nil):
+                    // If we get a `custom` case it is because we need to present the custom range selection
+                case .custom:
                     showCustomRangeSelectionView = true
                 default:
                     // Any other selection should be forwarded to our parent binding.
-                    selectionType = newValue
+                    selectionType = newValue.asAnalyticsHubRange
                 }
             }
         )
@@ -154,3 +148,39 @@ struct TimeRangeCard_Previews: PreviewProvider {
         AnalyticsTimeRangeCard(viewModel: viewModel, selectionType: .constant(.monthToDate))
     }
 }
+
+
+extension AnalyticsTimeRangeCard {
+    enum Range: CaseIterable {
+        case custom
+        case today
+        case yesterday
+        case lastWeek
+        case lastMonth
+        case lastQuarter
+        case lastYear
+        case weekToDate
+        case monthToDate
+        case quarterToDate
+        case yearToDate
+
+        /// Wee need to provide a custom `allCases` in order to evict `.custom` while the feature flag is active.
+        /// We should delete this once the feature flag has been removed.
+        ///
+        static var allCases: [Range] {
+            [
+                ServiceLocator.featureFlagService.isFeatureFlagEnabled(.analyticsHub) ? .custom : nil,
+                .today,
+                .yesterday,
+                .lastWeek,
+                .lastMonth,
+                .lastQuarter,
+                .lastYear,
+                .weekToDate,
+                .monthToDate,
+                .quarterToDate,
+                yearToDate
+            ].compactMap { $0 }
+        }
+    }
+}

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

@@ -77,27 +77,9 @@ public class AnalyticsHubTimeRangeSelection {
 
 // MARK: - Time Range Selection Type
 extension AnalyticsHubTimeRangeSelection {
-    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] {
-            [
-                ServiceLocator.featureFlagService.isFeatureFlagEnabled(.analyticsHub) ? .custom(start: nil, end: nil) : nil,
-                .today,
-                .yesterday,
-                .lastWeek,
-                .lastMonth,
-                .lastQuarter,
-                .lastYear,
-                .weekToDate,
-                .monthToDate,
-                .quarterToDate,
-                yearToDate
-            ].compactMap { $0 }
-        }
+    enum SelectionType: Equatable {
 
-        // When adding a new case, remember to add it to `allCases`.
-        case custom(start: Date?, end: Date?)
+        case custom(start: Date, end: Date)
         case today
         case yesterday
         case lastWeek
@@ -109,33 +91,6 @@ extension AnalyticsHubTimeRangeSelection {
         case quarterToDate
         case yearToDate
 
-        var description: String {
-            switch self {
-            case .custom:
-                return Localization.custom
-            case .today:
-                return Localization.today
-            case .yesterday:
-                return Localization.yesterday
-            case .lastWeek:
-                return Localization.lastWeek
-            case .lastMonth:
-                return Localization.lastMonth
-            case .lastQuarter:
-                return Localization.lastQuarter
-            case .lastYear:
-                return Localization.lastYear
-            case .weekToDate:
-                return Localization.weekToDate
-            case .monthToDate:
-                return Localization.monthToDate
-            case .quarterToDate:
-                return Localization.quarterToDate
-            case .yearToDate:
-                return Localization.yearToDate
-            }
-        }
-
         /// The granularity that should be used to request stats from the given SelectedType
         ///
         var granularity: StatsGranularityV4 {
@@ -171,33 +126,6 @@ extension AnalyticsHubTimeRangeSelection {
             }
         }
 
-        var tracksIdentifier: String {
-            switch self {
-            case .custom:
-                return "Custom"
-            case .today:
-                return "Today"
-            case .yesterday:
-                return "Yesterday"
-            case .lastWeek:
-                return "Last Week"
-            case .lastMonth:
-                return "Last Month"
-            case .lastQuarter:
-                return "Last Quarter"
-            case .lastYear:
-                return "Last Year"
-            case .weekToDate:
-                return "Week to Date"
-            case .monthToDate:
-                return "Month to Date"
-            case .quarterToDate:
-                return "Quarter to Date"
-            case .yearToDate:
-                return "Year to Date"
-            }
-        }
-
         init(_ statsTimeRange: StatsTimeRangeV4) {
             switch statsTimeRange {
             case .today:
@@ -217,12 +145,8 @@ extension AnalyticsHubTimeRangeSelection {
 private extension AnalyticsHubTimeRangeSelection.SelectionType {
     func toRangeData(referenceDate: Date, timezone: TimeZone, calendar: Calendar) -> AnalyticsHubTimeRangeData? {
         switch self {
-        case let .custom(start?, end?):
+        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:
@@ -255,17 +179,6 @@ 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")
-        static let lastMonth = NSLocalizedString("Last Month", comment: "Title of the Analytics Hub Last Month selection range")
-        static let lastQuarter = NSLocalizedString("Last Quarter", comment: "Title of the Analytics Hub Last Quarter selection range")
-        static let lastYear = NSLocalizedString("Last Year", comment: "Title of the Analytics Hub Last Year selection range")
-        static let weekToDate = NSLocalizedString("Week to Date", comment: "Title of the Analytics Hub Week to Date selection range")
-        static let monthToDate = NSLocalizedString("Month to Date", comment: "Title of the Analytics Hub Month to Date selection range")
-        static let quarterToDate = NSLocalizedString("Quarter to Date", comment: "Title of the Analytics Hub Quarter to Date selection range")
-        static let yearToDate = NSLocalizedString("Year to Date", comment: "Title of the Analytics Hub Year to Date selection range")
         static let selectionTitle = NSLocalizedString("Date Range", comment: "Title of the range selection list")
         static let noCurrentPeriodAvailable = NSLocalizedString("No current period available",
                                                                 comment: "A error message when it's not possible to acquire"