Merge pull request #42 from tipoff/chx2/feature/41-contact-status

Contact Status #41

Author: drewroberts

composer.json

@@ -21,7 +21,7 @@
         "tipoff/authorization": "^2.5.5",
         "tipoff/locations": "^2.6.0",
         "tipoff/notes": "^2.0.1",
-        "tipoff/statuses": "^2.1.0",
+        "tipoff/statuses": "^2.1",
         "tipoff/support": "^1.7.2"
     },
     "require-dev": {

database/migrations/2021_03_19_185945_add_contact_statuses.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+use Illuminate\Database\Migrations\Migration;
+use Tipoff\Forms\Enums\ContactStatus;
+use Tipoff\Statuses\Models\Status;
+
+class AddContactStatuses extends Migration
+{
+    public function up()
+    {
+        Status::publishStatuses(ContactStatus::statusType(), ContactStatus::getValues());
+    }
+}

src/Enums/ContactStatus.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tipoff\Forms\Enums;
+
+use Tipoff\Statuses\Models\Status;
+use Tipoff\Support\Enums\BaseEnum;
+
+/**
+ * @method static ContactStatus SUBMITTED()
+ * @psalm-immutable
+ */
+class ContactStatus extends BaseEnum
+{
+    const SUBMITTED = 'Submitted';
+
+    public static function statusType(): string
+    {
+        return StatusType::CONTACT;
+    }
+
+    public function toStatus(): ? Status
+    {
+        /** @psalm-suppress ImpureMethodCall */
+        return Status::findStatus(static::statusType(), (string) $this->getValue());
+    }
+}

src/Enums/StatusType.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tipoff\Forms\Enums;
+
+use Tipoff\Support\Enums\BaseEnum;
+
+/**
+ * @method static StatusType CONTACT()
+ * @psalm-immutable
+ */
+class StatusType extends BaseEnum
+{
+    const CONTACT = 'contact';
+}

src/Models/Contact.php

@@ -6,15 +6,20 @@
 
 use Assert\Assert;
 use Carbon\Carbon;
+use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\SoftDeletes;
+use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
+use Tipoff\Forms\Enums\ContactStatus;
+use Tipoff\Statuses\Traits\HasStatuses;
 use Tipoff\Support\Models\BaseModel;
 use Tipoff\Support\Traits\HasPackageFactory;
 
 class Contact extends BaseModel
 {
     use HasPackageFactory;
     use SoftDeletes;
+    use HasStatuses;
 
     protected $casts = [
         'emailed_at' => 'datetime',
@@ -47,6 +52,30 @@ public function generateReferenceNumber()
         $this->reference_number = $token;
     }
 
+    public function scopeByContactStatus(Builder $query, ContactStatus $contactStatus): Builder
+    {
+        return $this->scopeByStatus($query, $contactStatus->toStatus());
+    }
+
+    public function setContactStatus(ContactStatus $contactStatus): self
+    {
+        $this->setStatus((string) $contactStatus->getValue(), ContactStatus::statusType());
+
+        return $this;
+    }
+
+    public function getContactStatus(): ? ContactStatus
+    {
+        $status = $this->getStatus(ContactStatus::statusType());
+
+        return $status ? ContactStatus::byValue((string) $status) : null;
+    }
+
+    public function getContactStatusHistory(): Collection
+    {
+        return $this->getStatusHistory(ContactStatus::statusType());
+    }
+
     public function user()
     {
         return $this->belongsTo(app('user'));

src/Nova/Contact.php

@@ -17,7 +17,9 @@
 use Laravel\Nova\Fields\Textarea;
 use Laravel\Nova\Http\Requests\NovaRequest;
 use Laravel\Nova\Panel;
+use Tipoff\Forms\Enums\ContactStatus;
 use Tipoff\Support\Nova\BaseResource;
+use Tipoff\Support\Nova\Fields\Enum;
 
 class Contact extends BaseResource
 {
@@ -41,6 +43,9 @@ public function fieldsForIndex(NovaRequest $request)
     {
         return array_filter([
             ID::make(),
+            Enum::make('ContactStatus', function (\Tipoff\Forms\Models\Contact $contact) {
+                return $contact->getContactStatus();
+            })->attach(ContactStatus::class)->sortable(),
             Text::make('Form Type')->sortable(),
             Text::make('Number', 'reference_number')->sortable(),
             nova('user') ? BelongsTo::make('User', 'user', nova('user'))->sortable() : null,
@@ -52,6 +57,9 @@ public function fieldsForIndex(NovaRequest $request)
     public function fields(Request $request)
     {
         return array_filter([
+            Enum::make('ContactStatus', function (\Tipoff\Forms\Models\Contact $contact) {
+                return $contact->getContactStatus();
+            })->attach(ContactStatus::class),
             Select::make('Form Type')->options([
                 'contact' => 'Contact Page',
                 'reservation' => 'Reservation Page',

tests/TestCase.php

@@ -11,6 +11,7 @@
 use Tipoff\Forms\FormsServiceProvider;
 use Tipoff\Forms\Tests\Support\Providers\NovaPackageServiceProvider;
 use Tipoff\Locations\LocationsServiceProvider;
+use Tipoff\Statuses\StatusesServiceProvider;
 use Tipoff\Support\SupportServiceProvider;
 use Tipoff\TestSupport\BaseTestCase;
 
@@ -21,6 +22,7 @@ protected function getPackageProviders($app)
         return [
             SupportServiceProvider::class,
             AddressesServiceProvider::class,
+            StatusesServiceProvider::class,
             AuthorizationServiceProvider::class,
             PermissionServiceProvider::class,
             LocationsServiceProvider::class,

tests/Unit/Models/ContactModelTest.php

@@ -5,17 +5,40 @@
 namespace Tipoff\Forms\Tests\Unit\Models;
 
 use Illuminate\Foundation\Testing\DatabaseTransactions;
+use Illuminate\Foundation\Testing\WithFaker;
+use Tipoff\Authorization\Models\User;
+use Tipoff\Forms\Enums\ContactStatus;
 use Tipoff\Forms\Models\Contact;
 use Tipoff\Forms\Tests\TestCase;
+use Tipoff\Statuses\Models\StatusRecord;
 
 class ContactModelTest extends TestCase
 {
     use DatabaseTransactions;
+    use WithFaker;
 
     /** @test */
     public function create()
     {
         $model = Contact::factory()->create();
         $this->assertNotNull($model);
     }
+
+    /** @test */
+    public function can_set_status()
+    {
+        $this->actingAs(User::factory()->create());
+
+        /** @var Contact $contact */
+        $contact = Contact::factory()->create();
+        $contact->setContactStatus(ContactStatus::SUBMITTED());
+        $this->assertEquals(ContactStatus::SUBMITTED, $contact->getContactStatus()->getValue());
+
+        $history = $contact->getContactStatusHistory()
+            ->map(function (StatusRecord $statusRecord) {
+                return (string) $statusRecord->status;
+            })->toArray();
+
+        $this->assertEquals([ContactStatus::SUBMITTED], $history);
+    }
 }