feature #503 Add onHand to product response (alexander-schranz)

This PR was merged into the 1.0-dev branch. Discussion ---------- It should be possible to know how many products are still available. Commits ------- 168ca19 Add onHand to product response
Sylius · Jul 31, 2019 · d4ebf04 · d4ebf04
2 parents 3e49756 + 168ca19
commit d4ebf04
Show file tree

Hide file tree

Showing 46 changed files with 123 additions and 0 deletions.
diff --git a/doc/swagger.yml b/doc/swagger.yml
@@ -1332,6 +1332,9 @@ definitions:
                 type: "object"
                 additionalProperties:
                     type: "string"
+            onHand:
+                type: "integer"
+                example: 12
             price:
                 $ref: "#/definitions/Price"
             images:

diff --git a/spec/Factory/Product/ProductVariantViewFactorySpec.php b/spec/Factory/Product/ProductVariantViewFactorySpec.php
@@ -52,6 +52,7 @@ function it_builds_product_variant_view(
         $variantView = new ProductVariantView();
 
         $variant->getCode()->willReturn('SMALL_RED_LOGAN_HAT_CODE');
+        $variant->getOnHand()->willReturn(12);
         $variant->getTranslation('en_GB')->willReturn($productVariantTranslation);
         $variant->getChannelPricingForChannel($channel)->willReturn($channelPrice);
         $variant->getOptionValues()->willReturn(new ArrayCollection([
@@ -85,6 +86,7 @@ function it_builds_product_variant_view(
         $variantView->name = 'Small red Logan hat code';
         $variantView->price = new PriceView();
         $variantView->axis = ['HAT_SIZE_S', 'HAT_COLOR_RED'];
+        $variantView->onHand = 12;
         $variantView->nameAxis = [
             'HAT_SIZE_S' => 'Size S',
             'HAT_COLOR_RED' => 'Color Red',

diff --git a/src/Factory/Product/ProductVariantViewFactory.php b/src/Factory/Product/ProductVariantViewFactory.php
@@ -37,6 +37,7 @@ public function create(ProductVariantInterface $variant, ChannelInterface $chann
 
         $variantView->code = $variant->getCode();
         $variantView->name = $variant->getTranslation($locale)->getName();
+        $variantView->onHand = $variant->getOnHand();
         $variantView->price = $this->priceViewFactory->create(
             $channelPricing->getPrice(),
             $channel->getBaseCurrency()->getCode()

diff --git a/src/Resources/config/serializer/Product/ProductVariantView.yml b/src/Resources/config/serializer/Product/ProductVariantView.yml
@@ -14,6 +14,9 @@ Sylius\ShopApiPlugin\View\Product\ProductVariantView:
         nameAxis:
             expose: true
             type: array<string, string>
+        onHand:
+            expose: true
+            type: int
         price:
             expose: true
             type: Sylius\ShopApiPlugin\View\PriceView

diff --git a/src/View/Product/ProductVariantView.php b/src/View/Product/ProductVariantView.php
@@ -21,6 +21,9 @@ class ProductVariantView
     /** @var array */
     public $nameAxis = [];
 
+    /** @var int */
+    public $onHand;
+
     /** @var PriceView */
     public $price;
 

diff --git a/tests/DataFixtures/ORM/shop.yml b/tests/DataFixtures/ORM/shop.yml
@@ -117,6 +117,7 @@ Sylius\Component\Core\Model\ProductVariant:
         product: "@mug"
         currentLocale: "en_GB"
         translations: ["@en_gb_mug_variant_translation", "@de_de_mug_variant_translation"]
+        onHand: 12
         channelPricings:
             WEB_GB: "@gb_mug_web_channel_pricing"
             WEB_DE: "@de_mug_web_channel_pricing"

diff --git a/tests/Responses/Expected/cart/add_multiple_products_to_cart_response.json b/tests/Responses/Expected/cart/add_multiple_products_to_cart_response.json
@@ -29,6 +29,7 @@
                         "name": "Logan Mug",
                         "axis": [],
                         "nameAxis": {},
+                        "onHand": 12,
                         "price": {
                             "current": 1999,
                             "currency": "GBP"
@@ -81,6 +82,7 @@
                         "name": "Small Logan T-Shirt",
                         "axis": [],
                         "nameAxis": {},
+                        "onHand": 0,
                         "price": {
                             "current": 1999,
                             "currency": "GBP"
@@ -141,6 +143,7 @@
                             "HAT_SIZE_S": "Size S",
                             "HAT_COLOR_RED": "Color Red"
                         },
+                        "onHand": 0,
                         "price": {
                             "current": 500,
                             "currency": "GBP"

diff --git a/tests/Responses/Expected/cart/add_multiple_products_to_new_cart_response.json b/tests/Responses/Expected/cart/add_multiple_products_to_new_cart_response.json
@@ -29,6 +29,7 @@
             "name": "Logan Mug",
             "axis": [],
             "nameAxis": {},
+            "onHand": 12,
             "price": {
               "current": 1999,
               "currency": "GBP"
@@ -81,6 +82,7 @@
             "name": "Small Logan T-Shirt",
             "axis": [],
             "nameAxis": {},
+            "onHand": 0,
             "price": {
               "current": 1999,
               "currency": "GBP"
@@ -141,6 +143,7 @@
               "HAT_SIZE_S": "Size S",
               "HAT_COLOR_RED": "Color Red"
             },
+            "onHand": 0,
             "price": {
               "current": 500,
               "currency": "GBP"

diff --git a/...s/Expected/cart/add_product_variant_based_on_options_multiple_times_to_cart_response.json b/...s/Expected/cart/add_product_variant_based_on_options_multiple_times_to_cart_response.json
@@ -35,6 +35,7 @@
                             "HAT_SIZE_S": "Size S",
                             "HAT_COLOR_RED": "Color Red"
                         },
+                        "onHand": 0,
                         "price": {
                             "current": 500,
                             "currency": "GBP"

diff --git a/tests/Responses/Expected/cart/add_product_variant_based_on_options_to_cart_response.json b/tests/Responses/Expected/cart/add_product_variant_based_on_options_to_cart_response.json
@@ -35,6 +35,7 @@
                             "HAT_SIZE_S": "Size S",
                             "HAT_COLOR_RED": "Color Red"
                         },
+                        "onHand": 0,
                         "price": {
                             "current": 500,
                             "currency": "GBP"

diff --git a/tests/Responses/Expected/cart/add_product_variant_multiple_times_to_cart_response.json b/tests/Responses/Expected/cart/add_product_variant_multiple_times_to_cart_response.json
@@ -29,6 +29,7 @@
                         "name": "Small Logan T-Shirt",
                         "axis": [],
                         "nameAxis": {},
+                        "onHand": 0,
                         "price": {
                             "current": 1999,
                             "currency": "GBP"

diff --git a/tests/Responses/Expected/cart/add_product_variant_to_cart_response.json b/tests/Responses/Expected/cart/add_product_variant_to_cart_response.json
@@ -29,6 +29,7 @@
                         "name": "Small Logan T-Shirt",
                         "axis": [],
                         "nameAxis": {},
+                        "onHand": 0,
                         "price": {
                             "current": 1999,
                             "currency": "GBP"

diff --git a/tests/Responses/Expected/cart/add_simple_product_multiple_times_to_cart_response.json b/tests/Responses/Expected/cart/add_simple_product_multiple_times_to_cart_response.json
@@ -29,6 +29,7 @@
                         "name": "Logan Mug",
                         "axis": [],
                         "nameAxis": {},
+                        "onHand": 12,
                         "price": {
                             "current": 1999,
                             "currency": "GBP"

diff --git a/tests/Responses/Expected/cart/add_simple_product_to_cart_response.json b/tests/Responses/Expected/cart/add_simple_product_to_cart_response.json
@@ -29,6 +29,7 @@
                         "name": "Logan Mug",
                         "axis": [],
                         "nameAxis": {},
+                        "onHand": 12,
                         "price": {
                             "current": 1999,
                             "currency": "GBP"

diff --git a/tests/Responses/Expected/cart/add_simple_product_to_new_cart_response.json b/tests/Responses/Expected/cart/add_simple_product_to_new_cart_response.json
@@ -29,6 +29,7 @@
             "name": "Logan Mug",
             "axis": [],
             "nameAxis": {},
+            "onHand": 12,
             "price": {
               "current": 1999,
               "currency": "GBP"

diff --git a/tests/Responses/Expected/cart/cart_with_coupon_based_promotion_applied_response.json b/tests/Responses/Expected/cart/cart_with_coupon_based_promotion_applied_response.json
@@ -29,6 +29,7 @@
                         "name": "Logan Mug",
                         "axis": [],
                         "nameAxis": {},
+                        "onHand": 12,
                         "price": {
                             "current": 1999,
                             "currency": "GBP"

diff --git a/tests/Responses/Expected/cart/filled_cart_with_product_variant_summary_response.json b/tests/Responses/Expected/cart/filled_cart_with_product_variant_summary_response.json
@@ -29,6 +29,7 @@
                         "name": "Small Logan T-Shirt",
                         "axis": [],
                         "nameAxis": {},
+                        "onHand": 0,
                         "price": {
                             "current": 1999,
                             "currency": "GBP"
@@ -89,6 +90,7 @@
                             "HAT_SIZE_S": "Size S",
                             "HAT_COLOR_RED": "Color Red"
                         },
+                        "onHand": 0,
                         "price": {
                             "current": 500,
                             "currency": "GBP"

diff --git a/tests/Responses/Expected/cart/filled_cart_with_simple_product_summary_response.json b/tests/Responses/Expected/cart/filled_cart_with_simple_product_summary_response.json
@@ -29,6 +29,7 @@
                         "name": "Logan Mug",
                         "axis": [],
                         "nameAxis": {},
+                        "onHand": 12,
                         "price": {
                             "current": 1999,
                             "currency": "GBP"

diff --git a/tests/Responses/Expected/cart/german_filled_cart_with_product_variant_summary_response.json b/tests/Responses/Expected/cart/german_filled_cart_with_product_variant_summary_response.json
@@ -35,6 +35,7 @@
                             "HAT_SIZE_S": "Size S",
                             "HAT_COLOR_RED": "Farbe Rot"
                         },
+                        "onHand": 0,
                         "price": {
                             "current": 590,
                             "currency": "EUR"

diff --git a/tests/Responses/Expected/cart/german_filled_cart_with_simple_product_summary_response.json b/tests/Responses/Expected/cart/german_filled_cart_with_simple_product_summary_response.json
@@ -28,6 +28,7 @@
                         "name": "Logan Becher",
                         "axis": [],
                         "nameAxis": {},
+                        "onHand": 12,
                         "price": {
                             "current": 2099,
                             "currency": "EUR"

diff --git a/tests/Responses/Expected/cart/recalculated_cart_after_log_in.json b/tests/Responses/Expected/cart/recalculated_cart_after_log_in.json
@@ -29,6 +29,7 @@
                         "name": "Logan Mug",
                         "axis": [],
                         "nameAxis": {},
+                        "onHand": 12,
                         "price": {
                             "current": 1999,
                             "currency": "GBP"

diff --git a/tests/Responses/Expected/cart/reprocessed_cart_after_deleting_an_item.json b/tests/Responses/Expected/cart/reprocessed_cart_after_deleting_an_item.json
@@ -29,6 +29,7 @@
                         "name": "Logan Mug",
                         "axis": [],
                         "nameAxis": {},
+                        "onHand": 12,
                         "price": {
                             "current": 1999,
                             "currency": "GBP"

diff --git a/tests/Responses/Expected/checkout/cart_addressed_response.json b/tests/Responses/Expected/checkout/cart_addressed_response.json
@@ -29,6 +29,7 @@
                         "name": "Logan Mug",
                         "axis": [],
                         "nameAxis": {},
+                        "onHand": 12,
                         "price": {
                             "current": 1999,
                             "currency": "GBP"

diff --git a/...xpected/checkout/cart_addressed_with_different_shipping_and_billing_address_response.json b/...xpected/checkout/cart_addressed_with_different_shipping_and_billing_address_response.json
@@ -29,6 +29,7 @@
                         "name": "Logan Mug",
                         "axis": [],
                         "nameAxis": {},
+                        "onHand": 12,
                         "price": {
                             "current": 1999,
                             "currency": "GBP"

diff --git a/tests/Responses/Expected/checkout/cart_with_chosen_payment_response.json b/tests/Responses/Expected/checkout/cart_with_chosen_payment_response.json
@@ -29,6 +29,7 @@
                         "name": "Logan Mug",
                         "axis": [],
                         "nameAxis": {},
+                        "onHand": 12,
                         "price": {
                             "current": 1999,
                             "currency": "GBP"

diff --git a/tests/Responses/Expected/checkout/cart_with_chosen_shipment_response.json b/tests/Responses/Expected/checkout/cart_with_chosen_shipment_response.json
@@ -29,6 +29,7 @@
                         "name": "Logan Mug",
                         "axis": [],
                         "nameAxis": {},
+                        "onHand": 12,
                         "price": {
                             "current": 1999,
                             "currency": "GBP"

diff --git a/tests/Responses/Expected/checkout/cart_with_chosen_shipment_with_per_item_rate_response.json b/tests/Responses/Expected/checkout/cart_with_chosen_shipment_with_per_item_rate_response.json
@@ -29,6 +29,7 @@
                         "name": "Logan Mug",
                         "axis": [],
                         "nameAxis": {},
+                        "onHand": 12,
                         "price": {
                             "current": 1999,
                             "currency": "GBP"

diff --git a/...ses/Expected/checkout/modified_cart_with_chosen_shipment_with_per_item_rate_response.json b/...ses/Expected/checkout/modified_cart_with_chosen_shipment_with_per_item_rate_response.json
@@ -29,6 +29,7 @@
                         "name": "Logan Mug",
                         "axis": [],
                         "nameAxis": {},
+                        "onHand": 12,
                         "price": {
                             "current": 1999,
                             "currency": "GBP"

diff --git a/tests/Responses/Expected/order/order_details_response.json b/tests/Responses/Expected/order/order_details_response.json
@@ -29,6 +29,7 @@
                         "name": "Logan Mug",
                         "axis": [],
                         "nameAxis": {},
+                        "onHand": 12,
                         "price": {
                             "current": 1999,
                             "currency": "GBP"

diff --git a/tests/Responses/Expected/order/order_details_response_guest.json b/tests/Responses/Expected/order/order_details_response_guest.json
@@ -29,6 +29,7 @@
                         "name": "Logan Mug",
                         "axis": [],
                         "nameAxis": {},
+                        "onHand": 12,
                         "price": {
                             "current": 1999,
                             "currency": "GBP"

diff --git a/tests/Responses/Expected/order/orders_list_response.json b/tests/Responses/Expected/order/orders_list_response.json
@@ -30,6 +30,7 @@
                             "name": "Logan Mug",
                             "axis": [],
                             "nameAxis": {},
+                            "onHand": 12,
                             "price": {
                                 "current": 1999,
                                 "currency": "GBP"

diff --git a/tests/Responses/Expected/product/german_product_list_page_by_code_response.json b/tests/Responses/Expected/product/german_product_list_page_by_code_response.json
@@ -29,6 +29,7 @@
                     "name": "Logan Becher",
                     "axis": [],
                     "nameAxis": {},
+                    "onHand": 12,
                     "price": {
                         "current": 1999,
                         "currency": "GBP"
@@ -87,6 +88,7 @@
                         "HAT_SIZE_S": "Size S",
                         "HAT_COLOR_RED": "Farbe Rot"
                     },
+                    "onHand": 0,
                     "price": {
                         "current": 500,
                         "currency": "GBP"
@@ -104,6 +106,7 @@
                         "HAT_SIZE_L": "Size L",
                         "HAT_COLOR_RED": "Farbe Rot"
                     },
+                    "onHand": 0,
                     "price": {
                         "current": 999,
                         "currency": "GBP"
@@ -121,6 +124,7 @@
                         "HAT_SIZE_S": "Size S",
                         "HAT_COLOR_BLUE": "Farbe Blau"
                     },
+                    "onHand": 0,
                     "price": {
                         "current": 1500,
                         "currency": "GBP"
@@ -138,6 +142,7 @@
                         "HAT_SIZE_L": "Size L",
                         "HAT_COLOR_BLUE": "Farbe Blau"
                     },
+                    "onHand": 0,
                     "price": {
                         "current": 2599,
                         "currency": "GBP"
@@ -167,6 +172,7 @@
                                 "name": "Logan Becher",
                                 "axis": [],
                                 "nameAxis": {},
+                                "onHand": 12,
                                 "price": {
                                     "current": 1999,
                                     "currency": "GBP"
@@ -219,6 +225,7 @@
                                 "name": "Small Logan T-Shirt",
                                 "axis": [],
                                 "nameAxis": {},
+                                "onHand": 0,
                                 "price": {
                                     "current": 1999,
                                     "currency": "GBP"
@@ -235,6 +242,7 @@
                                 "name": "Large Logan T-Shirt",
                                 "axis": [],
                                 "nameAxis": {},
+                                "onHand": 0,
                                 "price": {
                                     "current": 2999,
                                     "currency": "GBP"