Allow order creation without a shipping address when a collection shi…

…pping option has been selected (#1745) Currently, a shipping address is always required if a Cart is "shippable", i.e. when it contains physical products. However, when a customer chooses to pick up an order, rather than having it delivered, a shipping address should not be required. --------- Co-authored-by: tim <[email protected]> Co-authored-by: Glenn Jacobs <[email protected]>
lunarphp · May 22, 2024 · 35687ad · 35687ad
1 parent a494f50
commit 35687ad
Show file tree

Hide file tree

Showing 2 changed files with 179 additions and 14 deletions.
diff --git a/packages/core/src/Validation/Cart/ValidateCartForOrderCreation.php b/packages/core/src/Validation/Cart/ValidateCartForOrderCreation.php
@@ -33,24 +33,26 @@ public function validate(): bool
  return $this->fail('cart', $billingValidator->errors()->getMessages());
  }
 
- // Is this cart shippable and if so, does it have a shipping address.
  if ($cart->isShippable()) {
- if (! $cart->shippingAddress) {
- return $this->fail('cart', __('lunar::exceptions.carts.shipping_missing'));
+ // Do we have a shipping option applied?
+ if (! $shippingOption = $cart->getShippingOption()) {
+ return $this->fail('cart', __('lunar::exceptions.carts.shipping_option_missing'));
  }
 
- $shippingValidator = Validator::make(
- $cart->shippingAddress->toArray(),
- $this->getAddressRules()
- );
+ // Is this cart going to be shipped and if so, does it have a shipping address?
+ if (! $shippingOption->collect) {
+ if (! $cart->shippingAddress) {
+ return $this->fail('cart', __('lunar::exceptions.carts.shipping_missing'));
+ }
 
- if ($shippingValidator->fails()) {
- return $this->fail('cart', $shippingValidator->errors()->getMessages());
- }
+ $shippingValidator = Validator::make(
+ $cart->shippingAddress->toArray(),
+ $this->getAddressRules()
+ );
 
- // Do we have a shipping option applied?
- if (! $cart->getShippingOption()) {
- return $this->fail('cart', __('lunar::exceptions.carts.shipping_option_missing'));
+  if ($shippingValidator->fails()) {
+  return $this->fail('cart', $shippingValidator->errors()->getMessages());
+ }
  }
  }
 

diff --git a/tests/core/Unit/Validation/Cart/ValidateCartForOrderCreationTest.php b/tests/core/Unit/Validation/Cart/ValidateCartForOrderCreationTest.php
@@ -1,10 +1,16 @@
 <?php
 
 uses(\Lunar\Tests\Core\TestCase::class);
+
+use Lunar\DataTypes\Price;
+use Lunar\DataTypes\ShippingOption;
 use Lunar\Exceptions\Carts\CartException;
+use Lunar\Facades\ShippingManifest;
 use Lunar\Models\Cart;
 use Lunar\Models\CartAddress;
 use Lunar\Models\Currency;
+use Lunar\Models\ProductVariant;
+use Lunar\Models\TaxClass;
 use Lunar\Validation\Cart\ValidateCartForOrderCreation;
 
 uses(\Illuminate\Foundation\Testing\RefreshDatabase::class);
@@ -81,27 +87,138 @@
  }
 });
 
-test('can validate shippable cart', function () {
+test('can validate missing shipping option', function () {
  $currency = Currency::factory()->create();
 
  $cart = Cart::factory()->create([
  'currency_id' => $currency->id,
  ]);
 
+ $purchasable = ProductVariant::factory()->create([
+ 'shippable' => true,
+ ]);
+
+ $cart->lines()->create([
+ 'purchasable_type' => get_class($purchasable),
+ 'purchasable_id' => $purchasable->id,
+ 'quantity' => 1,
+ ]);
+
  $validator = (new ValidateCartForOrderCreation)->using(
  cart: $cart
  );
 
  CartAddress::factory()->create([
  'type' => 'billing',
  'cart_id' => $cart->id,
+ ]);
+
+ $this->expectException(CartException::class);
+ $this->expectExceptionMessage(__('lunar::exceptions.carts.shipping_option_missing'));
+
+ $validator->validate();
+});
+
+test('can validate collection with partial shipping address', function () {
+ $currency = Currency::factory()->create();
+ $taxClass = TaxClass::factory()->create();
+
+ $cart = Cart::factory()->create([
+ 'currency_id' => $currency->id,
+ ]);
+
+ $purchasable = ProductVariant::factory()->create([
+ 'shippable' => true,
+ ]);
+
+ $cart->lines()->create([
+ 'purchasable_type' => get_class($purchasable),
+ 'purchasable_id' => $purchasable->id,
+ 'quantity' => 1,
+ ]);
+
+ $shippingOption = new ShippingOption(
+ name: 'Collection',
+ description: 'Collection',
+ identifier: 'COLLECT',
+ price: new Price(0, $cart->currency, 1),
+ taxClass: $taxClass,
+ collect: true
+ );
+
+ ShippingManifest::addOption($shippingOption);
+
+ CartAddress::factory()->create([
+ 'type' => 'shipping',
+ 'cart_id' => $cart->id,
  'first_name' => null,
  'line_one' => null,
  'city' => null,
  'postcode' => null,
  'country_id' => null,
+ 'shipping_option' => $shippingOption->getIdentifier(),
+ ]);
+
+ CartAddress::factory()->create([
+ 'type' => 'billing',
+ 'cart_id' => $cart->id,
  ]);
 
+ $validator = (new ValidateCartForOrderCreation)->using(
+ cart: $cart
+ );
+
+ expect($validator->validate())->toBeTrue();
+});
+
+test('can validate delivery with partial shipping address', function () {
+ $currency = Currency::factory()->create();
+ $taxClass = TaxClass::factory()->create();
+
+ $cart = Cart::factory()->create([
+ 'currency_id' => $currency->id,
+ ]);
+
+ $purchasable = ProductVariant::factory()->create([
+ 'shippable' => true,
+ ]);
+
+ $cart->lines()->create([
+ 'purchasable_type' => get_class($purchasable),
+ 'purchasable_id' => $purchasable->id,
+ 'quantity' => 1,
+ ]);
+
+ $shippingOption = new ShippingOption(
+ name: 'Basic Delivery',
+ description: 'Basic Delivery',
+ identifier: 'BASDEL',
+ price: new Price(500, $cart->currency, 1),
+ taxClass: $taxClass
+ );
+
+ ShippingManifest::addOption($shippingOption);
+
+ CartAddress::factory()->create([
+ 'type' => 'shipping',
+ 'cart_id' => $cart->id,
+ 'first_name' => null,
+ 'line_one' => null,
+ 'city' => null,
+ 'postcode' => null,
+ 'country_id' => null,
+ 'shipping_option' => $shippingOption->getIdentifier(),
+ ]);
+
+ CartAddress::factory()->create([
+ 'type' => 'billing',
+ 'cart_id' => $cart->id,
+ ]);
+
+ $validator = (new ValidateCartForOrderCreation)->using(
+ cart: $cart
+ );
+
  try {
  $validator->validate();
  } catch (CartException $e) {
@@ -116,3 +233,49 @@
  ]))->toBeTrue();
  }
 });
+
+test('can validate delivery with populated shipping address', function () {
+ $currency = Currency::factory()->create();
+ $taxClass = TaxClass::factory()->create();
+
+ $cart = Cart::factory()->create([
+ 'currency_id' => $currency->id,
+ ]);
+
+ $purchasable = ProductVariant::factory()->create([
+ 'shippable' => true,
+ ]);
+
+ $cart->lines()->create([
+ 'purchasable_type' => get_class($purchasable),
+ 'purchasable_id' => $purchasable->id,
+ 'quantity' => 1,
+ ]);
+
+ $shippingOption = new ShippingOption(
+ name: 'Basic Delivery',
+ description: 'Basic Delivery',
+ identifier: 'BASDEL',
+ price: new Price(500, $cart->currency, 1),
+ taxClass: $taxClass
+ );
+
+ ShippingManifest::addOption($shippingOption);
+
+ CartAddress::factory()->create([
+ 'type' => 'shipping',
+ 'cart_id' => $cart->id,
+ 'shipping_option' => $shippingOption->getIdentifier(),
+ ]);
+
+ CartAddress::factory()->create([
+ 'type' => 'billing',
+ 'cart_id' => $cart->id,
+ ]);
+
+ $validator = (new ValidateCartForOrderCreation)->using(
+ cart: $cart
+ );
+
+ expect($validator->validate())->toBeTrue();
+});