Merge branch 'develop' into issue/4745-service-packages-endpoint

Author: rachelmcr

Networking/Networking/Model/Address.swift

@@ -3,7 +3,7 @@ import Codegen
 
 /// Represents an Address Entity.
 ///
-public struct Address: Decodable, Equatable, GeneratedFakeable {
+public struct Address: Decodable, GeneratedFakeable {
     public let firstName: String
     public let lastName: String
     public let company: String?
@@ -69,8 +69,46 @@ public struct Address: Decodable, Equatable, GeneratedFakeable {
                   phone: phone,
                   email: email)
     }
+
+    public static var empty: Address {
+        self.init(firstName: "",
+                  lastName: "",
+                  company: nil,
+                  address1: "",
+                  address2: nil,
+                  city: "",
+                  state: "",
+                  postcode: "",
+                  country: "",
+                  phone: nil,
+                  email: nil)
+    }
 }
 
+extension Address: Equatable {
+    // custom implementation to handle empty strings and `nil` comparison
+    public static func ==(lhs: Address, rhs: Address) -> Bool {
+        return lhs.firstName == rhs.firstName &&
+            lhs.lastName == rhs.lastName &&
+            (lhs.company == rhs.company ||
+                lhs.company == nil && rhs.company?.isEmpty == true ||
+                lhs.company?.isEmpty == true && rhs.company == nil) &&
+            lhs.address1 == rhs.address1 &&
+            (lhs.address2 == rhs.address2 ||
+                lhs.address2 == nil && rhs.address2?.isEmpty == true ||
+                lhs.address2?.isEmpty == true && rhs.address2 == nil) &&
+            lhs.city == rhs.city &&
+            lhs.state == rhs.state &&
+            lhs.postcode == rhs.postcode &&
+            lhs.country == rhs.country &&
+            (lhs.phone == rhs.phone ||
+                lhs.phone == nil && rhs.phone?.isEmpty == true ||
+                lhs.phone?.isEmpty == true && rhs.phone == nil) &&
+            (lhs.email == rhs.email ||
+                lhs.email == nil && rhs.email?.isEmpty == true ||
+                lhs.email?.isEmpty == true && rhs.email == nil)
+    }
+}
 
 /// Defines all of the Address's CodingKeys.
 ///

WooCommerce/Classes/Model/ShippingLabelPackageAttributes.swift

@@ -0,0 +1,15 @@
+import Foundation
+
+/// A structure to hold the basic details for a selected package on Package Details screen of Shipping Label purchase flow.
+///
+struct ShippingLabelPackageAttributes: Hashable, Equatable {
+
+    /// ID of the selected package.
+    let packageID: String
+
+    /// Total weight of the package in string value.
+    let totalWeight: String
+
+    /// List of product or variation IDs for items in the package.
+    let productIDs: [Int64]
+}

WooCommerce/Classes/ViewModels/CardPresentPayments/CardPresentModalScanningForReader.swift

@@ -47,7 +47,7 @@ private extension CardPresentModalScanningForReader {
         )
 
         static let instruction = NSLocalizedString(
-            "Press the power button of your reader until you see a flashing blue light",
+            "To turn on your card reader, briefly press its power button. When powered on, the power LED will blink blue.",
             comment: "Label within the modal dialog that appears when searching for a card reader"
         )
 

WooCommerce/Classes/ViewRelated/ListSelector/ListSelector.swift

@@ -1,12 +1,16 @@
 import SwiftUI
 
+/// Protocol required to re-render the view when the command updates any of it's content.
+///
+protocol ObservableListSelectorCommand: ListSelectorCommand, ObservableObject {}
+
 /// `SwiftUI` wrapper for `ListSelectorViewController`
 ///
-struct ListSelector<Command: ListSelectorCommand>: UIViewControllerRepresentable {
+struct ListSelector<Command: ObservableListSelectorCommand>: UIViewControllerRepresentable {
 
     /// Command that defines cell style and provide data.
     ///
-    let command: Command
+    @ObservedObject var command: Command
 
     /// Table view style.
     ///

WooCommerce/Classes/ViewRelated/Orders/Order Details/Address Edit/CountrySelectorCommand.swift

@@ -3,17 +3,17 @@ import Yosemite
 
 /// Command to be used to select a country when editing addresses.
 ///
-final class CountrySelectorCommand: ListSelectorCommand {
+final class CountrySelectorCommand: ObservableListSelectorCommand {
     typealias Model = Country
     typealias Cell = BasicTableViewCell
 
     /// Original array of countries.
     ///
-    private let countries: [Country]
+    private var countries: [Country]
 
     /// Data to display
     ///
-    private(set) var data: [Country]
+    @Published private(set) var data: [Country]
 
     /// Current selected country
     ///
@@ -23,7 +23,7 @@ final class CountrySelectorCommand: ListSelectorCommand {
     ///
     let navigationBarTitle: String? = ""
 
-    init(countries: [Country] = temporaryCountries, selected: Country? = nil) {
+    init(countries: [Country], selected: Country? = nil) {
         self.countries = countries
         self.data = countries
         self.selected = selected
@@ -41,6 +41,13 @@ final class CountrySelectorCommand: ListSelectorCommand {
         cell.textLabel?.text = model.name
     }
 
+    /// Resets countries data.
+    ///
+    func resetCountries(_ countries: [Country]) {
+        self.countries = countries
+        self.data = countries
+    }
+
     /// Filter available countries that contains a given search term.
     ///
     func filterCountries(term: String) {
@@ -51,16 +58,3 @@ final class CountrySelectorCommand: ListSelectorCommand {
         data = countries.filter { $0.name.localizedCaseInsensitiveContains(term) }
     }
 }
-
-// MARK: Temporary Methods
-extension CountrySelectorCommand {
-
-    // Supported countries will come from the view model later.
-    //
-    private static let temporaryCountries: [Country] = {
-        return Locale.isoRegionCodes.map { regionCode in
-            let name = Locale.current.localizedString(forRegionCode: regionCode) ?? ""
-            return Country(code: regionCode, name: name, states: [])
-        }
-    }()
-}

WooCommerce/Classes/ViewRelated/Orders/Order Details/Address Edit/CountrySelectorViewModel.swift

@@ -1,18 +1,87 @@
 import Combine
+import SwiftUI
+import Yosemite
+import protocol Storage.StorageManagerType
 
 /// View Model for the `CountrySelector` view.
 ///
-final class CountrySelectorViewModel: ObservableObject {
+final class CountrySelectorViewModel: FilterListSelectorViewModelable, ObservableObject {
 
     /// Current search term entered by the user.
     /// Each update will trigger an update to the `command` that contains the country data.
-    @Published var searchTerm = "" {
+    var searchTerm: String = "" {
         didSet {
             command.filterCountries(term: searchTerm)
         }
     }
 
     /// Command that powers the `ListSelector` view.
     ///
-    let command = CountrySelectorCommand()
+    let command = CountrySelectorCommand(countries: [])
+
+    /// Navigation title
+    ///
+    let navigationTitle = Localization.title
+
+    /// Filter text field placeholder
+    ///
+    let filterPlaceholder = Localization.placeholder
+
+    /// ResultsController for stored countries.
+    ///
+    private lazy var countriesResultsController: ResultsController<StorageCountry> = {
+        let countriesDescriptor = NSSortDescriptor(key: "name", ascending: true)
+        return ResultsController<StorageCountry>(storageManager: storageManager, sortedBy: [countriesDescriptor])
+    }()
+
+    /// Storage to fetch countries
+    ///
+    private let storageManager: StorageManagerType
+
+    /// Stores to sync countries
+    ///
+    private let stores: StoresManager
+
+    /// Current `SiteID`, needed to sync countries from a remote source.
+    ///
+    private let siteID: Int64
+
+    init(siteID: Int64, storageManager: StorageManagerType = ServiceLocator.storageManager, stores: StoresManager = ServiceLocator.stores) {
+        self.siteID = siteID
+        self.storageManager = storageManager
+        self.stores = stores
+        fetchAndBindCountries()
+    }
+}
+
+// MARK: Helpers
+private extension CountrySelectorViewModel {
+    /// Fetches & Binds countries from storage, If there are no stored countries, sync them from a remote source.
+    ///
+    func fetchAndBindCountries() {
+        // Bind stored countries & command
+        countriesResultsController.onDidChangeContent = { [weak self] in
+            guard let self = self else { return }
+            self.command.resetCountries(self.countriesResultsController.fetchedObjects)
+        }
+
+        // Initial fetch
+        try? countriesResultsController.performFetch()
+
+        // Reset countries with fetched data or sync countries if needed.
+        if !countriesResultsController.isEmpty {
+            command.resetCountries(countriesResultsController.fetchedObjects)
+        } else {
+            let action = DataAction.synchronizeCountries(siteID: siteID, onCompletion: { _ in })
+            stores.dispatch(action)
+        }
+    }
+}
+
+// MARK: Constants
+private extension CountrySelectorViewModel {
+    enum Localization {
+        static let title = NSLocalizedString("Country", comment: "Title to select country from the edit address screen")
+        static let placeholder = NSLocalizedString("Filter Countries", comment: "Placeholder on the search field to search for a specific country")
+    }
 }