Merge pull request #591 from woocommerce/fix/358-item-price

Reapply updates from "item price" PR (#577)

Author: bummytime

Networking/Networking/Model/OrderItem.swift

@@ -8,6 +8,7 @@ public struct OrderItem: Decodable {
     public let name: String
     public let productID: Int
     public let quantity: Int
+    public let price: NSDecimalNumber
     public let sku: String?
     public let subtotal: String
     public let subtotalTax: String
@@ -18,11 +19,12 @@ public struct OrderItem: Decodable {
 
     /// OrderItem struct initializer.
     ///
-    public init(itemID: Int, name: String, productID: Int, quantity: Int, sku: String, subtotal: String, subtotalTax: String, taxClass: String, total: String, totalTax: String, variationID: Int) {
+    public init(itemID: Int, name: String, productID: Int, quantity: Int, price: NSDecimalNumber, sku: String?, subtotal: String, subtotalTax: String, taxClass: String, total: String, totalTax: String, variationID: Int) {
         self.itemID = itemID
         self.name = name
         self.productID = productID
         self.quantity = quantity
+        self.price = price
         self.sku = sku
         self.subtotal = subtotal
         self.subtotalTax = subtotalTax
@@ -31,6 +33,39 @@ public struct OrderItem: Decodable {
         self.totalTax = totalTax
         self.variationID = variationID
     }
+
+    /// The public initializer for OrderItem.
+    ///
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        let itemID = try container.decode(Int.self, forKey: .itemID)
+        let name = try container.decode(String.self, forKey: .name)
+        let productID = try container.decode(Int.self, forKey: .productID)
+        let quantity = try container.decode(Int.self, forKey: .quantity)
+        let decimalPrice = try container.decodeIfPresent(Decimal.self, forKey: .price) ?? Decimal(0)
+        let price = NSDecimalNumber(decimal: decimalPrice)
+        let sku = try container.decodeIfPresent(String.self, forKey: .sku)
+        let subtotal = try container.decode(String.self, forKey: .subtotal)
+        let subtotalTax = try container.decode(String.self, forKey: .subtotalTax)
+        let taxClass = try container.decode(String.self, forKey: .taxClass)
+        let total = try container.decode(String.self, forKey: .total)
+        let totalTax = try container.decode(String.self, forKey: .totalTax)
+        let variationID = try container.decode(Int.self, forKey: .variationID)
+
+        // initialize the struct
+        self.init(itemID: itemID,
+                  name: name,
+                  productID: productID,
+                  quantity: quantity,
+                  price: price,
+                  sku: sku,
+                  subtotal: subtotal,
+                  subtotalTax: subtotalTax,
+                  taxClass: taxClass,
+                  total: total,
+                  totalTax: totalTax,
+                  variationID: variationID)
+    }
 }
 
 
@@ -43,6 +78,7 @@ private extension OrderItem {
         case name           = "name"
         case productID      = "product_id"
         case quantity       = "quantity"
+        case price          = "price"
         case sku            = "sku"
         case subtotal       = "subtotal"
         case subtotalTax    = "subtotal_tax"
@@ -62,6 +98,7 @@ extension OrderItem: Comparable {
             lhs.name == rhs.name &&
             lhs.productID == rhs.productID &&
             lhs.quantity == rhs.quantity &&
+            lhs.price == rhs.price &&
             lhs.sku == rhs.sku &&
             lhs.subtotal == rhs.subtotal &&
             lhs.subtotalTax == rhs.subtotalTax &&

Networking/NetworkingTests/Mapper/OrderListMapperTests.swift

@@ -87,7 +87,8 @@ class OrderListMapperTests: XCTestCase {
         XCTAssertEqual(firstItem.itemID, 890)
         XCTAssertEqual(firstItem.name, "Fruits Basket (Mix & Match Product)")
         XCTAssertEqual(firstItem.productID, 52)
-        XCTAssertEqual(firstItem.quantity, 1)
+        XCTAssertEqual(firstItem.quantity, 2)
+        XCTAssertEqual(firstItem.price, NSDecimalNumber(integerLiteral: 30))
         XCTAssertEqual(firstItem.sku, "")
         XCTAssertEqual(firstItem.subtotal, "50.00")
         XCTAssertEqual(firstItem.subtotalTax, "2.00")

Networking/NetworkingTests/Mapper/OrderMapperTests.swift

@@ -78,7 +78,8 @@ class OrderMapperTests: XCTestCase {
         XCTAssertEqual(firstItem.itemID, 890)
         XCTAssertEqual(firstItem.name, "Fruits Basket (Mix & Match Product)")
         XCTAssertEqual(firstItem.productID, 52)
-        XCTAssertEqual(firstItem.quantity, 1)
+        XCTAssertEqual(firstItem.quantity, 2)
+        XCTAssertEqual(firstItem.price, NSDecimalNumber(integerLiteral: 30))
         XCTAssertEqual(firstItem.sku, "")
         XCTAssertEqual(firstItem.subtotal, "50.00")
         XCTAssertEqual(firstItem.subtotalTax, "2.00")

Networking/NetworkingTests/Responses/order.json

@@ -86,7 +86,7 @@
                        "name": "Fruits Basket (Mix & Match Product)",
                        "product_id": 52,
                        "variation_id": 0,
-                       "quantity": 1,
+                       "quantity": 2,
                        "tax_class": "",
                        "subtotal": "50.00",
                        "subtotal_tax": "2.00",
@@ -123,7 +123,7 @@
                                  ],
                        "meta_data": [],
                        "sku": "5555-A",
-                       "price": 0
+                       "price": 0.00
                        }
                        ],
         "tax_lines": [

Networking/NetworkingTests/Responses/orders-load-all.json

@@ -87,7 +87,8 @@
                             "name": "Fruits Basket (Mix & Match Product)",
                             "product_id": 52,
                             "variation_id": 0,
-                            "quantity": 1,
+                            "quantity": 2,
+                            "price": 30.00,
                             "tax_class": "",
                             "subtotal": "50.00",
                             "subtotal_tax": "2.00",
@@ -101,8 +102,7 @@
                                       }
                                       ],
                             "meta_data": [],
-                            "sku": "",
-                            "price": 30
+                            "sku": ""
                             },
                             {
                             "id": 891,

Storage/Storage/Model/MIGRATIONS.md

@@ -2,7 +2,13 @@
 
 This file documents changes in the WCiOS Storage data model. Please explain any changes to the data model as well as any custom migrations.
 
-## Model 9 (Release 0.15)
+## Model 9 (Release 1.0.0.1) 
+- @bummytime 2019-01-11
+    - Added `price` attribute on `OrderItem` entity
+
+Note: the 1.0.0 model 9 never made it to our users so we are not reving the version #.
+
+## Model 9 (Release 1.0.0)
 - @jleandroperez 2018-12-26
     - New `Order.exclusiveForSearch` property
     - New `OrderSearchResults` entity

Storage/Storage/Model/OrderItem+CoreDataProperties.swift

@@ -11,6 +11,7 @@ extension OrderItem {
     @NSManaged public var itemID: Int64
     @NSManaged public var name: String?
     @NSManaged public var quantity: Int64
+    @NSManaged public var price: NSDecimalNumber?
     @NSManaged public var productID: Int64
     @NSManaged public var sku: String?
     @NSManaged public var subtotal: String?

Storage/Storage/Model/WooCommerce.xcdatamodeld/Model 9.xcdatamodel/contents

@@ -82,6 +82,7 @@
     <entity name="OrderItem" representedClassName="OrderItem" syncable="YES">
         <attribute name="itemID" attributeType="Integer 64" defaultValueString="0" usesScalarValueType="YES" syncable="YES"/>
         <attribute name="name" optional="YES" attributeType="String" syncable="YES"/>
+        <attribute name="price" optional="YES" attributeType="Decimal" defaultValueString="0.0" syncable="YES"/>
         <attribute name="productID" optional="YES" attributeType="Integer 64" defaultValueString="0" usesScalarValueType="YES" syncable="YES"/>
         <attribute name="quantity" optional="YES" attributeType="Integer 64" defaultValueString="0" usesScalarValueType="YES" syncable="YES"/>
         <attribute name="sku" optional="YES" attributeType="String" syncable="YES"/>
@@ -184,12 +185,12 @@
     </entity>
     <elements>
         <element name="Account" positionX="-200.9765625" positionY="63.5625" width="128" height="120"/>
-        <element name="Note" positionX="-162" positionY="180" width="128" height="285"/>
+        <element name="Note" positionX="-369.61328125" positionY="-95.85546875" width="128" height="285"/>
         <element name="Order" positionX="-20" positionY="27" width="128" height="720"/>
         <element name="OrderCoupon" positionX="-206.01953125" positionY="379.74609375" width="128" height="120"/>
-        <element name="OrderItem" positionX="-364.890625" positionY="379.453125" width="128" height="225"/>
+        <element name="OrderItem" positionX="-364.890625" positionY="379.453125" width="128" height="240"/>
         <element name="OrderNote" positionX="-365.16796875" positionY="630.2109375" width="128" height="135"/>
-        <element name="OrderSearchResults" positionX="-153" positionY="189" width="128" height="75"/>
+        <element name="OrderSearchResults" positionX="144.44140625" positionY="743.43359375" width="128" height="75"/>
         <element name="OrderStats" positionX="137.859375" positionY="388.33203125" width="128" height="225"/>
         <element name="OrderStatsItem" positionX="321.74609375" positionY="425.51171875" width="128" height="330"/>
         <element name="Site" positionX="-203.6875" positionY="208.0703125" width="128" height="150"/>

WooCommerce/Classes/Tools/Currency/CurrencyFormatter.swift

@@ -78,6 +78,15 @@ public class CurrencyFormatter {
             return nil
         }
 
+        return formatAmount(decimalAmount, with: currency)
+    }
+
+    /// Applies currency option settings to the amount for the given currency.
+    /// - Parameters:
+    ///     - amount: a NSDecimalNumber representation of the amount, from the API, with no formatting applied. e.g. "19.87"
+    ///     - currency: a 3-letter country code for currencies that are supported in the API. e.g. "USD"
+    ///
+    func formatAmount(_ decimalAmount: NSDecimalNumber, with currency: String = CurrencySettings.shared.currencyCode.rawValue) -> String? {
         // Grab the read-only currency options. These are set by the user in Site > Settings.
         let separator = CurrencySettings.shared.decimalSeparator
         let position = CurrencySettings.shared.numberOfDecimals

WooCommerce/Classes/ViewModels/OrderItemViewModel.swift

@@ -39,7 +39,7 @@ struct OrderItemViewModel {
         }
 
         let itemTotal = currencyFormatter.formatAmount(item.total, with: currency) ?? String()
-        let itemSubtotal = currencyFormatter.formatAmount(item.subtotal, with: currency) ?? String()
+        let itemSubtotal = currencyFormatter.formatAmount(item.price, with: currency) ?? String()
 
         return itemTotal + " (" + itemSubtotal + " × " + quantity + ")"
     }