Add cart soft deleting

lunarphp · May 23, 2024 · 17e67ed · 17e67ed
1 parent fe6108a
commit 17e67ed
Show file tree

Hide file tree

Showing 5 changed files with 137 additions and 1 deletion.
diff --git a/docs/core/upgrading.md b/docs/core/upgrading.md
@@ -18,6 +18,17 @@ php artisan migrate
 
 Lunar currently provides bug fixes and security updates for only the latest minor release, e.g. `0.7`.
 
+## 1.0.0-alpha.22
+
+### Medium Impact
+
+Carts now use soft deletes and a cart will be deleted when `CartSession::forget()` is called.
+If you don't want to delete the cart when you call `forget` you can pass `delete: false` as a parameter:
+
+```php
+\Lunar\Facades\CartSession::forget(delete: false);
+```
+
 ## 1.0.0-alpha.20
 
 ### High Impact

diff --git a/packages/core/database/migrations/2024_04_23_100000_add_soft_deletes_to_carts_table.php b/packages/core/database/migrations/2024_04_23_100000_add_soft_deletes_to_carts_table.php
@@ -0,0 +1,22 @@
+<?php
+
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+use Lunar\Base\Migration;
+
+return new class extends Migration
+{
+    public function up(): void
+    {
+        Schema::table($this->prefix.'carts', function (Blueprint $table) {
+            $table->softDeletes();
+        });
+    }
+
+    public function down(): void
+    {
+        Schema::table($this->prefix.'carts', function (Blueprint $table) {
+            $table->dropColumn('deleted_at');
+        });
+    }
+};
diff --git a/packages/core/src/Managers/CartSessionManager.php b/packages/core/src/Managers/CartSessionManager.php
@@ -57,12 +57,21 @@ public function getShippingEstimateMeta(): array
     /**
      * {@inheritDoc}
      */
-    public function forget()
+    public function forget(bool $delete = true)
     {
+        if ($delete) {
+            Cart::destroy(
+                $this->sessionManager->get(
+                    $this->getSessionKey()
+                )
+            );
+        }
+
         $this->sessionManager->forget('shipping_estimate_meta');
         $this->sessionManager->forget(
             $this->getSessionKey()
         );
+
     }
 
     /**

diff --git a/packages/core/src/Models/Cart.php b/packages/core/src/Models/Cart.php
@@ -9,6 +9,7 @@
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Eloquent\Relations\HasOne;
+use Illuminate\Database\Eloquent\SoftDeletes;
 use Illuminate\Foundation\Auth\User;
 use Illuminate\Pipeline\Pipeline;
 use Illuminate\Support\Collection;
@@ -53,13 +54,15 @@
  * @property ?\Illuminate\Support\Carbon $completed_at
  * @property ?\Illuminate\Support\Carbon $created_at
  * @property ?\Illuminate\Support\Carbon $updated_at
+ * @property ?\Illuminate\Support\Carbon $deleted_at
  */
 class Cart extends BaseModel
 {
     use CachesProperties;
     use HasFactory;
     use HasMacros;
     use LogsActivity;
+    use SoftDeletes;
 
     /**
      * Array of cachable class properties.

diff --git a/tests/core/Unit/Managers/CartSessionManagerTest.php b/tests/core/Unit/Managers/CartSessionManagerTest.php
@@ -166,6 +166,97 @@
 
 });
 
+test('can forget a cart and soft delete it', function () {
+    Currency::factory()->create([
+        'default' => true,
+    ]);
+
+    Channel::factory()->create([
+        'default' => true,
+    ]);
+
+    Config::set('lunar.cart.auto_create', true);
+
+    $cart = CartSession::current();
+
+    $shipping = CartAddress::factory()->create([
+        'cart_id' => $cart->id,
+        'type' => 'shipping',
+    ]);
+
+    $billing = CartAddress::factory()->create([
+        'cart_id' => $cart->id,
+        'type' => 'billing',
+    ]);
+
+    $cart->setShippingAddress($shipping);
+    $cart->setBillingAddress($billing);
+
+    $sessionCart = Session::get(config('lunar.cart.session_key'));
+
+    expect($sessionCart)
+        ->not
+        ->toBeNull()
+        ->and($sessionCart)
+        ->toEqual($cart->id);
+
+    CartSession::forget();
+
+    expect(
+        Session::get(config('lunar.cart.session_key'))
+    )
+        ->toBeNull()
+        ->and($cart->refresh()->deleted_at)
+        ->not
+        ->toBeNull();
+
+});
+
+test('can forget a cart an optionally prevent soft deleting', function () {
+    Currency::factory()->create([
+        'default' => true,
+    ]);
+
+    Channel::factory()->create([
+        'default' => true,
+    ]);
+
+    Config::set('lunar.cart.auto_create', true);
+
+    $cart = CartSession::current();
+
+    $shipping = CartAddress::factory()->create([
+        'cart_id' => $cart->id,
+        'type' => 'shipping',
+    ]);
+
+    $billing = CartAddress::factory()->create([
+        'cart_id' => $cart->id,
+        'type' => 'billing',
+    ]);
+
+    $cart->setShippingAddress($shipping);
+    $cart->setBillingAddress($billing);
+
+    $sessionCart = Session::get(config('lunar.cart.session_key'));
+
+    expect($sessionCart)
+        ->not
+        ->toBeNull()
+        ->and($sessionCart)
+        ->toEqual($cart->id);
+
+    CartSession::forget(delete: false);
+
+    expect(
+        Session::get(config('lunar.cart.session_key'))
+    )
+        ->toBeNull()
+        ->and($cart->refresh()->deleted_at)
+        ->toBeNull();
+
+});
+
 test('can set shipping estimate meta', function () {
     CartSession::estimateShippingUsing([
         'postcode' => 'NP1 1TX',