Merge pull request #226 from woocommerce/feature/217-empty-shipping

Order Details: Handle empty shipping address

Author: mindgraffiti

Networking/Networking/Model/Address.swift

@@ -16,6 +16,13 @@ public struct Address: Decodable {
     public let phone: String?
     public let email: String?
 
+    /// Make Address conform to Error protocol.
+    ///
+    enum AddressParseError: Error {
+        case missingCountry
+    }
+
+
     /// Designated Initializer.
     ///
     public init(firstName: String, lastName: String, company: String?, address1: String, address2: String?, city: String, state: String, postcode: String, country: String, phone: String?, email: String?) {
@@ -31,6 +38,30 @@ public struct Address: Decodable {
         self.phone = phone
         self.email = email
     }
+
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+
+        let firstName = try container.decode(String.self, forKey: .firstName)
+        let lastName = try container.decode(String.self, forKey: .lastName)
+        let company = try container.decodeIfPresent(String.self, forKey: .company)
+        let address1 = try container.decode(String.self, forKey: .address1)
+        let address2 = try container.decodeIfPresent(String.self, forKey: .address2)
+        let city = try container.decode(String.self, forKey: .city)
+        let state = try container.decode(String.self, forKey: .state)
+        let postcode = try container.decode(String.self, forKey: .postcode)
+        let country = try container.decode(String.self, forKey: .country)
+        let phone = try container.decodeIfPresent(String.self, forKey: .phone)
+        let email = try container.decodeIfPresent(String.self, forKey: .email)
+
+        // Check for an empty country, because on Android that's how
+        // we determine if the shipping address should be considered empty.
+        if country.isEmpty {
+            throw AddressParseError.missingCountry
+        }
+
+        self.init(firstName: firstName, lastName: lastName, company: company, address1: address1, address2: address2, city: city, state: state, postcode: postcode, country: country, phone: phone, email: email)
+    }
 }
 
 

Networking/Networking/Model/Order.swift

@@ -27,8 +27,8 @@ public struct Order: Decodable {
     public let paymentMethodTitle: String
 
     public let items: [OrderItem]
-    public let billingAddress: Address
-    public let shippingAddress: Address
+    public let billingAddress: Address?
+    public let shippingAddress: Address?
     public let coupons: [OrderCouponLine]
 
     /// Order struct initializer.
@@ -52,8 +52,8 @@ public struct Order: Decodable {
                 totalTax: String,
                 paymentMethodTitle: String,
                 items: [OrderItem],
-                billingAddress: Address,
-                shippingAddress: Address,
+                billingAddress: Address?,
+                shippingAddress: Address?,
                 coupons: [OrderCouponLine]) {
 
         self.siteID = siteID
@@ -116,11 +116,24 @@ public struct Order: Decodable {
         let paymentMethodTitle = try container.decode(String.self, forKey: .paymentMethodTitle)
 
         let items = try container.decode([OrderItem].self, forKey: .items)
-        let shippingAddress = try container.decode(Address.self, forKey: .shippingAddress)
-        let billingAddress = try container.decode(Address.self, forKey: .billingAddress)
+
+        var shippingAddress: Address? = nil
+        do {
+            shippingAddress = try container.decodeIfPresent(Address.self, forKey: .shippingAddress)
+        } catch {
+            // no-op
+        }
+
+        var billingAddress: Address? = nil
+        do {
+            billingAddress = try container.decode(Address.self, forKey: .billingAddress)
+        } catch {
+            billingAddress = Address(firstName: "", lastName: "", company: "", address1: "", address2: "", city: "", state: "", postcode: "", country: "", phone: "", email: "")
+        }
+
         let coupons = try container.decode([OrderCouponLine].self, forKey: .couponLines)
 
-        self.init(siteID: siteID, orderID: orderID, parentID: parentID, customerID: customerID, number: number, status: status, currency: currency, customerNote: customerNote, dateCreated: dateCreated, dateModified: dateModified, datePaid: datePaid, discountTotal: discountTotal, discountTax: discountTax, shippingTotal: shippingTotal, shippingTax: shippingTax, total: total, totalTax: totalTax, paymentMethodTitle: paymentMethodTitle, items: items, billingAddress: billingAddress, shippingAddress: shippingAddress, coupons: coupons) // initialize the struct
+        self.init(siteID: siteID, orderID: orderID, parentID: parentID, customerID: customerID, number: number, status: status, currency: currency, customerNote: customerNote, dateCreated: dateCreated, dateModified: dateModified, datePaid: datePaid, discountTotal: discountTotal, discountTax: discountTax, shippingTotal: shippingTotal, shippingTax: shippingTax, total: total, totalTax: totalTax, paymentMethodTitle: paymentMethodTitle, items: items, billingAddress: billingAddress, shippingAddress: shippingAddress, coupons: coupons)
     }
 }
 

Networking/NetworkingTests/Mapper/OrderListMapperTests.swift

@@ -55,7 +55,14 @@ class OrderListMapperTests: XCTestCase {
         XCTAssert(orders.count == 3)
 
         let firstOrder = orders[0]
-        let dummyAddresses = [firstOrder.billingAddress, firstOrder.shippingAddress]
+        var dummyAddresses = [Address]()
+        if let shippingAddress = firstOrder.shippingAddress {
+            dummyAddresses.append(shippingAddress)
+        }
+
+        if let billingAddress = firstOrder.billingAddress {
+            dummyAddresses.append(billingAddress)
+        }
 
         for address in dummyAddresses {
             XCTAssertEqual(address.firstName, "Johnny")

Networking/NetworkingTests/Mapper/OrderMapperTests.swift

@@ -50,7 +50,8 @@ class OrderMapperTests: XCTestCase {
             return
         }
 
-        let dummyAddresses = [order.billingAddress, order.shippingAddress]
+        let dummyAddresses = [order.shippingAddress, order.billingAddress].compactMap({ $0 })
+        XCTAssertEqual(dummyAddresses.count, 2)
 
         for address in dummyAddresses {
             XCTAssertEqual(address.firstName, "Johnny")

WooCommerce/Classes/Model/Order+Woo.swift

@@ -14,4 +14,16 @@ extension Order {
 
         return NSLocale(localeIdentifier: identifier).currencySymbol
     }
+
+    /// Determines if a shipping address exists.
+    ///
+    var hasSeparateShippingDetail: Bool {
+        return shippingAddress != nil
+    }
+
+    /// FIXME: Creates an empty-string value Billing details, until i6 fix
+    ///
+    func generateEmptyBillingAddress() -> Address {
+        return Address(firstName: "", lastName: "", company: "", address1: "", address2: "", city: "", state: "", postcode: "", country: "", phone: "", email: "")
+    }
 }

WooCommerce/Classes/ViewModels/OrderDetailsViewModel.swift

@@ -14,8 +14,11 @@ class OrderDetailsViewModel {
         self.orderStatusViewModel = OrderStatusViewModel(orderStatus: order.status)
     }
 
-    var summaryTitle: String {
-        return "#\(order.number) \(order.shippingAddress.firstName) \(order.shippingAddress.lastName)"
+    var summaryTitle: String? {
+        if let billingAddress = order.billingAddress {
+            return "#\(order.number) \(billingAddress.firstName) \(billingAddress.lastName)"
+        }
+        return "#\(order.number)"
     }
 
     var summaryDateCreated: String {
@@ -60,14 +63,30 @@ class OrderDetailsViewModel {
     }
 
     var shippingViewModel: ContactViewModel {
-        return ContactViewModel(with: order.shippingAddress, contactType: ContactType.shipping)
+        if let shippingAddress = order.shippingAddress {
+            return ContactViewModel(with: shippingAddress, contactType: ContactType.shipping)
+        }
+
+        if let billingAddress = order.billingAddress {
+            return ContactViewModel(with: billingAddress, contactType: ContactType.shipping)
+        }
+
+        return ContactViewModel(with: order.generateEmptyBillingAddress(), contactType: ContactType.shipping)
     }
     var shippingAddress: String? {
         return shippingViewModel.formattedAddress
     }
 
-    private(set) lazy var billingViewModel = ContactViewModel(with: order.billingAddress, contactType: ContactType.billing)
-    private(set) lazy var billingAddress = billingViewModel.formattedAddress
+    var billingViewModel: ContactViewModel? {
+        if let billingAddress = order.billingAddress {
+            return ContactViewModel(with: billingAddress, contactType: ContactType.billing)
+        }
+        return nil
+    }
+
+    var billingAddress: String? {
+        return billingViewModel?.formattedAddress
+    }
 
     let subtotalLabel = NSLocalizedString("Subtotal", comment: "Subtotal label for payment view")
 

WooCommerce/Classes/ViewRelated/Orders/FulfillViewController.swift

@@ -257,7 +257,9 @@ private extension FulfillViewController {
             fatalError()
         }
 
-        let address = order.shippingAddress
+        guard let address = order.shippingAddress ?? order.billingAddress else {
+            return
+        }
 
         cell.title = NSLocalizedString("Shipping details", comment: "Shipping title for customer info cell")
         cell.name = address.fullName
@@ -377,7 +379,20 @@ private extension Section {
 
         let address: Section = {
             let title = NSLocalizedString("Customer Information", comment: "")
-            let row = Row.address(shipping: order.shippingAddress)
+            if let shippingAddress = order.shippingAddress {
+                let row = Row.address(shipping: shippingAddress)
+
+                return Section(title: title, secondaryTitle: nil, rows: [row])
+            }
+
+            if let billingAddress = order.billingAddress {
+                let row = Row.address(shipping: billingAddress)
+
+                return Section(title: title, secondaryTitle: nil, rows: [row])
+            }
+
+            let emptyAddress = order.generateEmptyBillingAddress()
+            let row = Row.address(shipping: emptyAddress)
 
             return Section(title: title, secondaryTitle: nil, rows: [row])
         }()

WooCommerce/Classes/ViewRelated/Orders/OrderDetails/OrderDetailsViewController.swift

@@ -245,7 +245,12 @@ private extension OrderDetailsViewController {
         case let cell as CustomerInfoTableViewCell where row == .shippingAddress:
             cell.configure(with: viewModel.shippingViewModel)
         case let cell as CustomerInfoTableViewCell where row == .billingAddress:
-            cell.configure(with: viewModel.billingViewModel)
+            if let billingViewModel = viewModel.billingViewModel {
+                cell.configure(with: billingViewModel)
+            } else {
+                let billingViewModel = ContactViewModel(with: viewModel.order.generateEmptyBillingAddress(), contactType: ContactType.billing)
+                cell.configure(with: billingViewModel)
+            }
         case let cell as BillingDetailsTableViewCell where row == .billingPhone:
             configure(cell, for: .billingPhone)
         case let cell as BillingDetailsTableViewCell where row == .billingEmail:
@@ -265,12 +270,12 @@ private extension OrderDetailsViewController {
 
     private func configure(_ cell: BillingDetailsTableViewCell, for billingRow: Row) {
         if billingRow == .billingPhone {
-            cell.configure(text: viewModel.billingViewModel.phoneNumber, image: Gridicon.iconOfType(.ellipsis))
+            cell.configure(text: viewModel.billingViewModel?.phoneNumber, image: Gridicon.iconOfType(.ellipsis))
             cell.onTouchUp = { [weak self] in
                 self?.phoneButtonAction()
             }
         } else if billingRow == .billingEmail {
-            cell.configure(text: viewModel.billingViewModel.email, image: Gridicon.iconOfType(.mail))
+            cell.configure(text: viewModel.billingViewModel?.email, image: Gridicon.iconOfType(.mail))
             cell.onTouchUp = { [weak self] in
                 self?.emailButtonAction()
             }
@@ -471,7 +476,11 @@ extension OrderDetailsViewController: UITableViewDelegate {
 //
 extension OrderDetailsViewController: MFMessageComposeViewControllerDelegate {
     func sendTextMessageIfPossible() {
-        let contactViewModel = ContactViewModel(with: viewModel.order.billingAddress, contactType: .billing)
+        guard let billingAddress = viewModel.order.billingAddress else {
+            return
+        }
+
+        let contactViewModel = ContactViewModel(with: billingAddress, contactType: .billing)
         guard let phoneNumber = contactViewModel.cleanedPhoneNumber else {
             return
         }
@@ -498,10 +507,15 @@ extension OrderDetailsViewController: MFMessageComposeViewControllerDelegate {
 extension OrderDetailsViewController: MFMailComposeViewControllerDelegate {
     func sendEmailIfPossible() {
         if MFMailComposeViewController.canSendMail() {
-            let contactViewModel = ContactViewModel(with: viewModel.order.billingAddress, contactType: .billing)
+            guard let billingAddress = viewModel.order.billingAddress else {
+                return
+            }
+
+            let contactViewModel = ContactViewModel(with: billingAddress, contactType: .billing)
             guard let email = contactViewModel.email else {
                 return
             }
+
             sendEmail(to: email)
         }
     }

Yosemite/Yosemite/Model/Storage/Order+ReadOnlyConvertible.swift

@@ -30,29 +30,33 @@ extension Storage.Order: ReadOnlyConvertible {
         totalTax = order.totalTax
         paymentMethodTitle = order.paymentMethodTitle
 
-        billingFirstName = order.billingAddress.firstName
-        billingLastName = order.billingAddress.lastName
-        billingCompany = order.billingAddress.company
-        billingAddress1 = order.billingAddress.address1
-        billingAddress2 = order.billingAddress.address2
-        billingCity = order.billingAddress.city
-        billingState = order.billingAddress.state
-        billingPostcode = order.billingAddress.postcode
-        billingCountry = order.billingAddress.country
-        billingPhone = order.billingAddress.phone
-        billingEmail = order.billingAddress.email
+        if let billingAddress = order.billingAddress {
+            billingFirstName = billingAddress.firstName
+            billingLastName = billingAddress.lastName
+            billingCompany = billingAddress.company
+            billingAddress1 = billingAddress.address1
+            billingAddress2 = billingAddress.address2
+            billingCity = billingAddress.city
+            billingState = billingAddress.state
+            billingPostcode = billingAddress.postcode
+            billingCountry = billingAddress.country
+            billingPhone = billingAddress.phone
+            billingEmail = billingAddress.email
+        }
 
-        shippingFirstName = order.shippingAddress.firstName
-        shippingLastName = order.shippingAddress.lastName
-        shippingCompany = order.shippingAddress.company
-        shippingAddress1 = order.shippingAddress.address1
-        shippingAddress2 = order.shippingAddress.address2
-        shippingCity = order.shippingAddress.city
-        shippingState = order.shippingAddress.state
-        shippingPostcode = order.shippingAddress.postcode
-        shippingCountry = order.shippingAddress.country
-        shippingPhone = order.shippingAddress.phone
-        shippingEmail = order.shippingAddress.email
+        if let shippingAddress = order.shippingAddress {
+            shippingFirstName = shippingAddress.firstName
+            shippingLastName = shippingAddress.lastName
+            shippingCompany = shippingAddress.company
+            shippingAddress1 = shippingAddress.address1
+            shippingAddress2 = shippingAddress.address2
+            shippingCity = shippingAddress.city
+            shippingState = shippingAddress.state
+            shippingPostcode = shippingAddress.postcode
+            shippingCountry = shippingAddress.country
+            shippingPhone = shippingAddress.phone
+            shippingEmail = shippingAddress.email
+        }
     }
 
     /// Returns a ReadOnly version of the receiver.