Refactor description generation functions to computed properties

Author: ThomazFB

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

@@ -203,8 +203,8 @@ private extension AnalyticsHubViewModel {
 
     static func timeRangeCard(timeRangeSelection: AnalyticsHubTimeRangeSelection) -> AnalyticsTimeRangeCardViewModel {
         return AnalyticsTimeRangeCardViewModel(selectedRangeTitle: timeRangeSelection.rangeSelectionDescription,
-                                               currentRangeSubtitle: timeRangeSelection.generateCurrentRangeDescription(),
-                                               previousRangeSubtitle: timeRangeSelection.generatePreviousRangeDescription())
+                                               currentRangeSubtitle: timeRangeSelection.currentRangeDescription,
+                                               previousRangeSubtitle: timeRangeSelection.previousRangeDescription)
     }
 }
 

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

@@ -4,7 +4,7 @@ struct AnalyticsHubTimeRange {
     let start: Date
     let end: Date
 
-    func generateDescription(simplified: Bool, calendar: Calendar) -> String {
+    func formatToString(simplified: Bool, calendar: Calendar) -> String {
         if simplified {
             return DateFormatter.Stats.analyticsHubDayMonthYearFormatter.string(from: start)
         }

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

@@ -7,10 +7,30 @@ import Yosemite
 public class AnalyticsHubTimeRangeSelection {
     private let currentTimeRange: AnalyticsHubTimeRange?
     private let previousTimeRange: AnalyticsHubTimeRange?
-    private let currentRangeDescription: String?
-    private let previousRangeDescription: String?
+    private let formattedCurrentRangeText: String?
+    private let formattedPreviousRangeText: String?
     let rangeSelectionDescription: String
 
+    /// Provide a date description of the current time range set internally.
+    /// - Returns the Time range in a UI friendly format. If the current time range is not available,
+    /// then returns an presentable error message.
+    var currentRangeDescription: String {
+        guard let currentTimeRangeDescription = formattedCurrentRangeText else {
+            return Localization.noCurrentPeriodAvailable
+        }
+        return currentTimeRangeDescription
+    }
+
+    /// Generates a date description of the previous time range set internally.
+    /// - Returns the Time range in a UI friendly format. If the previous time range is not available,
+    /// then returns an presentable error message.
+    var previousRangeDescription: String {
+        guard let previousTimeRangeDescription = formattedPreviousRangeText else {
+            return Localization.noPreviousPeriodAvailable
+        }
+        return previousTimeRangeDescription
+    }
+
     //TODO: abandon usage of the ISO 8601 Calendar and build one based on the Site calendar configuration
     init(selectionType: SelectionType,
          currentDate: Date = Date(),
@@ -35,8 +55,10 @@ public class AnalyticsHubTimeRangeSelection {
         self.previousTimeRange = previousTimeRange
 
         let simplifiedDescription = selectionType == .today
-        self.currentRangeDescription = currentTimeRange?.generateDescription(simplified: simplifiedDescription, calendar: calendar)
-        self.previousRangeDescription = previousTimeRange?.generateDescription(simplified: simplifiedDescription, calendar: calendar)
+        self.formattedCurrentRangeText = currentTimeRange?.formatToString(simplified: simplifiedDescription,
+                                                                               calendar: calendar)
+        self.formattedPreviousRangeText = previousTimeRange?.formatToString(simplified: simplifiedDescription,
+                                                                                 calendar: calendar)
         self.rangeSelectionDescription = selectionType.description
     }
 
@@ -59,26 +81,6 @@ public class AnalyticsHubTimeRangeSelection {
         }
         return previousTimeRange
     }
-
-    /// Generates a date description of the previous time range set internally.
-    /// - Returns the Time range in a UI friendly format. If the previous time range is not available,
-    /// then returns an presentable error message.
-    func generateCurrentRangeDescription() -> String {
-        guard let currentTimeRangeDescription = currentRangeDescription else {
-            return Localization.noCurrentPeriodAvailable
-        }
-        return currentTimeRangeDescription
-    }
-
-    /// Generates a date description of the previous time range set internally.
-    /// - Returns the Time range in a UI friendly format. If the previous time range is not available,
-    /// then returns an presentable error message.
-    func generatePreviousRangeDescription() -> String {
-        guard let previousTimeRangeDescription = previousRangeDescription else {
-            return Localization.noPreviousPeriodAvailable
-        }
-        return previousTimeRangeDescription
-    }
 }
 
 // MARK: - Time Range Selection Type