Merge pull request #8267 from woocommerce/issue/8146-introduce-last-range-structure

[Analytics Hub] Refactor Time Range data structure

Author: ThomazFB

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

@@ -15,14 +15,14 @@ final class AnalyticsHubViewModel: ObservableObject {
     init(siteID: Int64,
          statsTimeRange: StatsTimeRangeV4,
          stores: StoresManager = ServiceLocator.stores) {
-        let selectedType = AnalyticsHubTimeRangeGenerator.SelectionType.from(statsTimeRange)
-        let timeRangeGenerator = AnalyticsHubTimeRangeGenerator(selectionType: selectedType)
+        let selectedType = AnalyticsHubTimeRangeSelection.SelectionType(statsTimeRange)
+        let timeRangeSelection = AnalyticsHubTimeRangeSelection(selectionType: selectedType)
 
         self.siteID = siteID
         self.stores = stores
         self.timeRangeSelectionType = selectedType
-        self.timeRangeGenerator = timeRangeGenerator
-        self.timeRangeCard = AnalyticsHubViewModel.timeRangeCard(timeRangeGenerator: timeRangeGenerator)
+        self.timeRangeSelection = timeRangeSelection
+        self.timeRangeCard = AnalyticsHubViewModel.timeRangeCard(timeRangeSelection: timeRangeSelection)
 
         bindViewModelsWithData()
     }
@@ -41,7 +41,7 @@ final class AnalyticsHubViewModel: ObservableObject {
 
     /// Time Range Selection Type
     ///
-    @Published var timeRangeSelectionType: AnalyticsHubTimeRangeGenerator.SelectionType
+    @Published var timeRangeSelectionType: AnalyticsHubTimeRangeSelection.SelectionType
 
     /// Time Range ViewModel
     ///
@@ -59,7 +59,7 @@ final class AnalyticsHubViewModel: ObservableObject {
 
     /// Time Range selection data defining the current and previous time period
     ///
-    private var timeRangeGenerator: AnalyticsHubTimeRangeGenerator
+    private var timeRangeSelection: AnalyticsHubTimeRangeSelection
 
     /// Request stats data from network
     ///
@@ -80,8 +80,8 @@ private extension AnalyticsHubViewModel {
     func retrieveOrderStats() async throws {
         switchToLoadingState()
 
-        let currentTimeRange = try timeRangeGenerator.unwrapCurrentTimeRange()
-        let previousTimeRange = try timeRangeGenerator.unwrapPreviousTimeRange()
+        let currentTimeRange = try timeRangeSelection.unwrapCurrentTimeRange()
+        let previousTimeRange = try timeRangeSelection.unwrapPreviousTimeRange()
 
         async let currentPeriodRequest = retrieveStats(earliestDateToInclude: currentTimeRange.start,
                                                        latestDateToInclude: currentTimeRange.end,
@@ -145,8 +145,8 @@ private extension AnalyticsHubViewModel {
             .removeDuplicates()
             .sink { [weak self] newSelectionType in
                 guard let self else { return }
-                self.timeRangeGenerator = AnalyticsHubTimeRangeGenerator(selectionType: newSelectionType)
-                self.timeRangeCard = AnalyticsHubViewModel.timeRangeCard(timeRangeGenerator: self.timeRangeGenerator)
+                self.timeRangeSelection = AnalyticsHubTimeRangeSelection(selectionType: newSelectionType)
+                self.timeRangeCard = AnalyticsHubViewModel.timeRangeCard(timeRangeSelection: self.timeRangeSelection)
                 Task.init {
                     await self.updateData()
                 }
@@ -208,10 +208,10 @@ private extension AnalyticsHubViewModel {
                                              isRedacted: false)
     }
 
-    static func timeRangeCard(timeRangeGenerator: AnalyticsHubTimeRangeGenerator) -> AnalyticsTimeRangeCardViewModel {
-        return AnalyticsTimeRangeCardViewModel(selectedRangeTitle: timeRangeGenerator.selectionDescription,
-                                               currentRangeSubtitle: timeRangeGenerator.generateCurrentRangeDescription(),
-                                               previousRangeSubtitle: timeRangeGenerator.generatePreviousRangeDescription())
+    static func timeRangeCard(timeRangeSelection: AnalyticsHubTimeRangeSelection) -> AnalyticsTimeRangeCardViewModel {
+        return AnalyticsTimeRangeCardViewModel(selectedRangeTitle: timeRangeSelection.rangeSelectionDescription,
+                                               currentRangeSubtitle: timeRangeSelection.currentRangeDescription,
+                                               previousRangeSubtitle: timeRangeSelection.previousRangeDescription)
     }
 }
 

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

@@ -7,11 +7,11 @@ struct AnalyticsTimeRangeCard: View {
     let timeRangeTitle: String
     let currentRangeDescription: String
     let previousRangeDescription: String
-    @Binding var selectionType: AnalyticsHubTimeRangeGenerator.SelectionType
+    @Binding var selectionType: AnalyticsHubTimeRangeSelection.SelectionType
 
     @State private var showTimeRangeSelectionView: Bool = false
 
-    init(viewModel: AnalyticsTimeRangeCardViewModel, selectionType: Binding<AnalyticsHubTimeRangeGenerator.SelectionType>) {
+    init(viewModel: AnalyticsTimeRangeCardViewModel, selectionType: Binding<AnalyticsHubTimeRangeSelection.SelectionType>) {
         self.timeRangeTitle = viewModel.selectedRangeTitle
         self.currentRangeDescription = viewModel.currentRangeSubtitle
         self.previousRangeDescription = viewModel.previousRangeSubtitle
@@ -22,7 +22,7 @@ struct AnalyticsTimeRangeCard: View {
         createTimeRangeContent()
             .sheet(isPresented: $showTimeRangeSelectionView) {
                 SelectionList(title: Localization.timeRangeSelectionTitle,
-                              items: AnalyticsHubTimeRangeGenerator.SelectionType.allCases,
+                              items: AnalyticsHubTimeRangeSelection.SelectionType.allCases,
                               contentKeyPath: \.description,
                               selected: $selectionType)
             }

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

@@ -0,0 +1,16 @@
+import Foundation
+
+struct AnalyticsHubDayRangeData: AnalyticsHubTimeRangeData {
+    let currentDateStart: Date?
+    let currentDateEnd: Date?
+    let previousDateStart: Date?
+    let previousDateEnd: Date?
+
+    init(referenceDate: Date, timezone: TimeZone, calendar: Calendar) {
+        self.currentDateEnd = referenceDate
+        self.currentDateStart = referenceDate.startOfDay(timezone: timezone)
+        let previousDateEnd = calendar.date(byAdding: .day, value: -1, to: referenceDate)
+        self.previousDateEnd = previousDateEnd
+        self.previousDateStart = previousDateEnd?.startOfDay(timezone: timezone)
+    }
+}

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

@@ -0,0 +1,16 @@
+import Foundation
+
+struct AnalyticsHubMonthRangeData: AnalyticsHubTimeRangeData {
+    let currentDateStart: Date?
+    let currentDateEnd: Date?
+    let previousDateStart: Date?
+    let previousDateEnd: Date?
+
+    init(referenceDate: Date, timezone: TimeZone, calendar: Calendar) {
+        self.currentDateEnd = referenceDate
+        self.currentDateStart = referenceDate.startOfMonth(timezone: timezone)
+        let previousDateEnd = calendar.date(byAdding: .month, value: -1, to: referenceDate)
+        self.previousDateEnd = previousDateEnd
+        self.previousDateStart = previousDateEnd?.startOfMonth(timezone: timezone)
+    }
+}

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

@@ -0,0 +1,20 @@
+import Foundation
+
+struct AnalyticsHubTimeRange {
+    let start: Date
+    let end: Date
+
+    func formatToString(simplified: Bool, calendar: Calendar) -> String {
+        if simplified {
+            return DateFormatter.Stats.analyticsHubDayMonthYearFormatter.string(from: start)
+        }
+
+        let startDateDescription = DateFormatter.Stats.analyticsHubDayMonthFormatter.string(from: start)
+
+        if start.isSameMonth(as: end, using: calendar) {
+            return "\(startDateDescription) - \(DateFormatter.Stats.analyticsHubDayYearFormatter.string(from: end))"
+        } else {
+            return "\(startDateDescription) - \(DateFormatter.Stats.analyticsHubDayMonthYearFormatter.string(from: end))"
+        }
+    }
+}

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

@@ -0,0 +1,29 @@
+import Foundation
+
+protocol AnalyticsHubTimeRangeData {
+    var currentDateStart: Date? { get }
+    var currentDateEnd: Date? { get }
+    var previousDateStart: Date? { get }
+    var previousDateEnd: Date? { get }
+
+    init(referenceDate: Date, timezone: TimeZone, calendar: Calendar)
+}
+
+extension AnalyticsHubTimeRangeData {
+    var currentTimeRange: AnalyticsHubTimeRange? {
+        generateTimeRangeFrom(startDate: currentDateStart, endDate: currentDateEnd)
+    }
+
+    var previousTimeRange: AnalyticsHubTimeRange? {
+        generateTimeRangeFrom(startDate: previousDateStart, endDate: previousDateEnd)
+    }
+
+    private func generateTimeRangeFrom(startDate: Date?, endDate: Date?) -> AnalyticsHubTimeRange? {
+        if let startDate = startDate,
+           let endDate = endDate {
+            return AnalyticsHubTimeRange(start: startDate, end: endDate)
+        } else {
+            return nil
+        }
+    }
+}