Release 2.0-beta7 (#79)

Author: actions-user

CHANGELOG.md

@@ -3,70 +3,75 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
-## [Unreleased]
+## 2.0-beta7 - 2022-01-19
 
 ### Fixed
 
-- When translating an attribute, if we can't find a translation we default to whatever the FieldType gives back instead of erroring.
-- `TranslatedText` fieldtype now implements `JsonSerializable` interface ([#50](https://github.com/getcandy/getcandy/issues/50))
-- When translating an attribute, if we can't find a translation we default to whatever the FieldType gives back instead of erroring.
+- When translating an attribute, if we can't find a translation, we default to whatever the FieldType gives back instead of erroring.
+- `TranslatedText` fieldtype now implements `JsonSerializable` interface ([#50](https://github.com/getcandy/getcandy/issues/50)).
 
-### Added
+### Changed
 
-- Created the `AttributeManifest` class so dev's can add their own attributable classes.
-- Created the `FieldTypeManifest` class so dev's can add custom FieldTypes to the store.
-- Added a new `default` column to the `tax_classes` table.
+- Models that have channels now implement `start_at` and `end_at` columns. This replaces the previous `published_at` column.
+- Laravel UI modal components removed.
 
 ### Added
 
+- Added a new `default` column to the `tax_classes` table.
+- Added `customer_id` to orders so an order has a 1:1 relation to a customer. ([#73](https://github.com/getcandy/getcandy/issues/73)).
 - Created the `AttributeManifest` class so dev's can add their own attributable classes.
 - Created the `FieldTypeManifest` class so dev's can add custom FieldTypes to the store.
+- Added `$table->userForeignKey()` macro for migrations that create foreign keys which reference a user id.
 
-### Changed
-
-- Models that have channels now implement `start_at` and `end_at` columns. This replaces the previous `published_at` column.
+[View Changes](https://github.com/getcandy/core/compare/2.0-beta5...2.0-beta7)
 
 ## 2.0-beta5 - 2022-01-10
 
-### Fixes
+### Fixed
 
-- Added check on customers for when using MySQL search driver to prevent undefined columns [#40](https://github.com/getcandy/getcandy/issues/40)
+- Added check on customers for when using MySQL search driver to prevent undefined columns [#40](https://github.com/getcandy/getcandy/issues/40).
 
 ### Changed
 
 - Changed `https` to `http` on country import due to issues with local environment CA installations.
 
 ## 2.0-beta4 - 2022-01-07
 
-### Added
-- Made customers searchable via Scout
-- Added Addresses relationship to the customer model
+### Fixed
+
+- Fixes [Issue 24](https://github.com/getcandy/getcandy/issues/24) where URL relationship is `elements` when it should be `element`.
+- Fixed an issue where `now()->year` would return an int on single digit months, but we need to have a leading zero.
 
 ### Changed
+
 - Customers `meta` column now uses Laravel's `casts` property and is cast to an object.
 
-### Fixes
-- Fixes [Issue 24](https://github.com/getcandy/getcandy/issues/24) where URL relationship is `elements` when it should be `element`
-- Fixed an issue where `now()->year` would return an int on single digit months, but we need to have a leading zero.
+### Added
+
+- Made customers searchable via Scout.
+- Added addresses relationship to the customer model.
 
 [View Changes](https://github.com/getcandy/core/compare/2.0-beta3...2.0-beta4)
 
 ## 2.0-beta3 - 2021-12-24
 
-### Fixes
+### Fixed
+
 - Fixed and issue where the meilisearch set up wasn't creating the indexes it needed if they didn't exist.
 
 [View Changes](https://github.com/getcandy/core/compare/2.0-beta2...2.0-beta3)
 
 ## 2.0-beta2 - 2021-12-23
 
-### Added
-- Added a default collection group
-### Changes
-- Install command no longer publishes hub assets
-### Fixes
+### Fixed
 - Default currency has `enabled` set to true.
 
+### Changed
+- Install command no longer publishes hub assets
+
+### Added
+- Added a default `CollectionGroup`.
+
 [View Changes](https://github.com/getcandy/core/compare/2.0-beta...2.0-beta2)
 
 ## 2.0-beta - 2021-12-22

database/migrations/2021_10_01_090000_create_orders_table.php

@@ -9,11 +9,8 @@ class CreateOrdersTable extends Migration
     public function up()
     {
         Schema::create($this->prefix.'orders', function (Blueprint $table) {
-            $userModel = config('auth.providers.users.model');
             $table->bigIncrements('id');
-            $table->foreignId('user_id')->nullable()->constrained(
-                (new $userModel())->getTable()
-            );
+            $table->userForeignKey(nullable: true);
             $table->foreignId('channel_id')->constrained($this->prefix.'channels');
             $table->string('status')->index();
             $table->string('reference')->nullable()->unique();

database/migrations/2021_10_01_100000_create_carts_table.php

@@ -9,12 +9,8 @@ class CreateCartsTable extends Migration
     public function up()
     {
         Schema::create($this->prefix.'carts', function (Blueprint $table) {
-            $userModel = config('auth.providers.users.model');
-
             $table->bigIncrements('id');
-            $table->foreignId('user_id')->nullable()->constrained(
-                (new $userModel())->getTable()
-            );
+            $table->userForeignKey(nullable: true);
             $table->foreignId('merged_id')->nullable()->constrained($this->prefix.'carts');
             $table->foreignId('currency_id')->constrained($this->prefix.'currencies');
             $table->foreignId('channel_id')->constrained($this->prefix.'channels');

database/migrations/2022_01_18_100001_add_customer_id_to_orders_table.php

@@ -0,0 +1,25 @@
+<?php
+
+use GetCandy\Base\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class AddCustomerIdToOrdersTable extends Migration
+{
+    public function up()
+    {
+        Schema::table($this->prefix.'orders', function (Blueprint $table) {
+            $table->foreignId('customer_id')->after('id')
+                ->nullable()
+                ->constrained($this->prefix.'customers');
+        });
+    }
+
+    public function down()
+    {
+        Schema::table($this->prefix.'orders', function ($table) {
+            $table->dropForeign(['customer_id']);
+            $table->dropColumn('customer_id');
+        });
+    }
+}

database/state/EnsureDefaultTaxClassExists.php

@@ -15,9 +15,12 @@ public function run()
 
         // Get the first tax class and make it default
         $taxClass = TaxClass::first();
-        $taxClass->update([
-            'default' => true,
-        ]);
+
+        if ($taxClass) {
+            $taxClass->update([
+                'default' => true,
+            ]);
+        }
     }
 
     protected function canRun()

database/state/EnsureUserOrdersHaveACustomer.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace GetCandy\Database\State;
+
+use GetCandy\Models\Order;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\Schema;
+
+class EnsureUserOrdersHaveACustomer
+{
+    public function run()
+    {
+        if (!$this->canRun()) {
+            return;
+        }
+
+        // Get any orders which have a user but not a customer id
+        $orders = Order::with('user.customers')
+            ->whereNull('customer_id')
+            ->whereNotNull('user_id')
+            ->get();
+
+        DB::transaction(function () use ($orders) {
+            foreach ($orders as $order) {
+                $customer = $order->user->customers->first();
+                $order->update([
+                    'customer_id' => $customer?->id,
+                ]);
+            }
+        });
+    }
+
+    protected function canRun()
+    {
+        $prefix = config('getcandy.database.table_prefix');
+
+        return Schema::hasTable("{$prefix}orders");
+    }
+}

src/GetCandyServiceProvider.php

@@ -227,22 +227,26 @@ protected function registerBlueprintMacros(): void
             }
         });
 
-        Blueprint::macro('userForeignKey', function ($field_name = 'user_id') {
+        Blueprint::macro('userForeignKey', function ($field_name = 'user_id', $nullable = false) {
             $userModel = config('auth.providers.users.model');
 
             $type = config('getcandy.database.users_id_type', 'bigint');
 
             if ($type == 'uuid') {
-                $this->foreignUuId($field_name)->constrained(
-                    (new $userModel())->getTable()
-                );
+                $this->foreignUuId($field_name)
+                    ->nullable($nullable)
+                    ->constrained(
+                        (new $userModel())->getTable()
+                    );
             } elseif ($type == 'int') {
-                $this->unsignedInteger($field_name);
+                $this->unsignedInteger($field_name)->nullable($nullable);
                 $this->foreign($field_name)->references('id')->on('users');
             } else {
-                $this->foreignId($field_name)->constrained(
-                    (new $userModel())->getTable()
-                );
+                $this->foreignId($field_name)
+                    ->nullable($nullable)
+                    ->constrained(
+                        (new $userModel())->getTable()
+                    );
             }
         });
     }

src/Models/Order.php

@@ -174,6 +174,28 @@ public function refunds()
         return $this->transactions()->whereRefund(true);
     }
 
+    /**
+     * Return the customer relationship.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function customer()
+    {
+        return $this->belongsTo(Customer::class);
+    }
+
+    /**
+     * Return the user relationship.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function user()
+    {
+        return $this->belongsTo(
+            config('auth.providers.users.model')
+        );
+    }
+
     public function toSearchableArray()
     {
         if (config('scout.driver') == 'mysql') {

tests/Unit/Models/OrderTest.php

@@ -3,7 +3,9 @@
 namespace GetCandy\Tests\Unit\Models;
 
 use DateTime;
+use GetCandy\Hub\Tests\Stubs\User;
 use GetCandy\Models\Currency;
+use GetCandy\Models\Customer;
 use GetCandy\Models\Order;
 use GetCandy\Models\OrderLine;
 use GetCandy\Models\ProductVariant;
@@ -162,4 +164,28 @@ public function can_retrieve_different_transaction_types_for_order()
         $this->assertEquals($charge->id, $order->charges->first()->id);
         $this->assertEquals($refund->id, $order->refunds->first()->id);
     }
+
+    /** @test */
+    public function can_have_user_and_customer_associated()
+    {
+        $user = User::create([
+            'name'              => 'Test User',
+            'email'             => 'test@domain.com',
+            'email_verified_at' => now(),
+            'password'          => '$2y$10$92IXUNpkjO0rOQ5byMi.Ye4oKoEa3Ro9llC/.og/at2.uheWG/igi', // password
+            'remember_token'    => \Illuminate\Support\Str::random(10),
+        ]);
+
+        $customer = $user->customers()->create(
+            Customer::factory()->make()->toArray()
+        );
+
+        $order = Order::factory()->create([
+            'customer_id' => $customer->id,
+            'user_id'     => $user->id,
+        ]);
+
+        $this->assertEquals($customer->id, $order->customer->id);
+        $this->assertEquals($user->id, $order->user->id);
+    }
 }