Merge pull request #43 from tipoff/chx2/feature/30-update-migrations

Update migrations #30

Author: drewroberts

database/factories/ContactFactory.php

@@ -1,10 +1,11 @@
-<?php 
+<?php
 
 declare(strict_types=1);
 
 namespace Tipoff\Forms\Database\Factories;
 
 use Illuminate\Database\Eloquent\Factories\Factory;
+use Tipoff\Forms\Enums\FormType;
 use Tipoff\Forms\Models\Contact;
 
 class ContactFactory extends Factory
@@ -14,7 +15,7 @@ class ContactFactory extends Factory
     public function definition()
     {
         return [
-            'form_type'      => $this->faker->randomElement(['contact', 'reservation', 'parties', 'groups', 'employment']),
+            'form_type'      => $this->faker->randomElement(FormType::getValues()),
             'location_id'    => randomOrCreate(app('location')),
             'email'          => $this->faker->email,
             'first_name'     => $this->faker->firstName,

database/factories/ContactResponseFactory.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tipoff\Forms\Database\Factories;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Tipoff\Forms\Models\Contact;
+use Tipoff\Forms\Models\ContactResponse;
+
+class ContactResponseFactory extends Factory
+{
+    protected $model = ContactResponse::class;
+
+    public function definition()
+    {
+        return [
+            'contact_id' => Contact::factory()->create()->id,
+            'emailed_at' => $this->faker->dateTime,
+            'creator_id' => randomOrCreate(app('user')),
+        ];
+    }
+}

database/migrations/2020_05_20_100000_create_contacts_table.php

@@ -12,7 +12,7 @@ public function up()
     {
         Schema::create('contacts', function (Blueprint $table) {
             $table->id();
-            $table->string('form_type')->index(); // String title of the form type so know which one was completed
+            $table->string('form_type')->index();
             $table->string('reference_number')->index()->unique(); // Generated by system. This is identifier used to communicate with customer about their contact form. Reference number is emailed to them.
             $table->foreignIdFor(app('location'))->index();
             $table->string('email');
@@ -22,17 +22,8 @@ public function up()
             $table->string('company_name')->nullable();
             $table->string('phone')->nullable(); // Will need to format before saving
             $table->text('message')->nullable();
-            $table->json('additional_fields')->nullable();
-            
-            // Move application specific data to additonal_fields
-            $table->smallInteger('participants')->nullable();
-            $table->date('requested_date')->nullable();
-            $table->time('requested_time')->nullable(); // Stored in location timezone
-            
-            // Move response fields to different table (contact followup or something like that)
-            $table->dateTime('emailed_at')->nullable();
-            $table->dateTime('closed_at')->nullable();
-            
+            $table->json('fields')->nullable();
+
             $table->softDeletes(); // Soft delete if email bounces or if the contact submission is spam.
             $table->timestamps();
         });

database/migrations/2021_02_13_100000_add_contact_permissions.php

@@ -13,6 +13,10 @@ public function up()
             'create contacts' => ['Owner', 'Executive', 'Staff'],
             'update contacts' => ['Owner', 'Executive', 'Staff'],
             'delete contacts' => ['Owner', 'Executive', 'Staff'],
+            'view contact responses' => ['Owner', 'Executive', 'Staff'],
+            'create contact responses' => ['Owner', 'Executive', 'Staff'],
+            'update contact responses' => ['Owner', 'Executive', 'Staff'],
+            'delete contact responses' => ['Owner', 'Executive', 'Staff'],
         ];
 
         $this->createPermissions($permissions);

database/migrations/2021_03_20_153107_create_contact_responses_table.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+use Tipoff\Forms\Models\Contact;
+
+class CreateContactResponsesTable extends Migration
+{
+    public function up()
+    {
+        Schema::create('contact_responses', function (Blueprint $table) {
+            $table->id();
+            $table->foreignIdFor(Contact::class);
+            $table->text('message')->nullable(); // Message will be communication to or from contact user
+            $table->text('comment')->nullable(); // Comment is internal communication. This is more like documentation so it is different than a note attachment from tipoff/notes
+            $table->dateTime('emailed_at')->nullable();
+
+            $table->foreignIdFor(app('user'), 'creator_id');
+            $table->timestamp('created_at');
+        });
+    }
+}

src/Enums/FormType.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tipoff\Forms\Enums;
+
+use MabeEnum\Enum;
+
+/**
+ * @method static FormType CONTACT()
+ * @method static FormType EMPLOYMENT()
+ * @method static FormType GROUPS()
+ * @method static FormType PARTIES()
+ * @method static FormType RESERVATIONS()
+ * @psalm-immutable
+ */
+class FormType extends Enum
+{
+    const CONTACT = 'contact';
+    const EMPLOYMENT = 'employment';
+    const GROUPS = 'groups';
+    const PARTIES = 'parties';
+    const RESERVATIONS = 'reservations';
+}

src/FormsServiceProvider.php

@@ -6,7 +6,9 @@
 
 use Tipoff\Forms\Commands\AttachContactUsers;
 use Tipoff\Forms\Models\Contact;
+use Tipoff\Forms\Models\ContactResponse;
 use Tipoff\Forms\Policies\ContactPolicy;
+use Tipoff\Forms\Policies\ContactResponsePolicy;
 use Tipoff\Support\TipoffPackage;
 use Tipoff\Support\TipoffServiceProvider;
 
@@ -17,9 +19,11 @@ public function configureTipoffPackage(TipoffPackage $package): void
         $package
             ->hasPolicies([
                 Contact::class => ContactPolicy::class,
+                ContactResponse::class => ContactResponsePolicy::class,
             ])
             ->hasNovaResources([
                 \Tipoff\Forms\Nova\Contact::class,
+                \Tipoff\Forms\Nova\ContactResponse::class,
             ])
             ->hasCommands([
                 AttachContactUsers::class,

src/Models/Contact.php

@@ -24,6 +24,7 @@ class Contact extends BaseModel
     protected $casts = [
         'emailed_at' => 'datetime',
         'requested_date' => 'date',
+        'fields' => 'array',
     ];
 
     protected static function boot()
@@ -76,6 +77,11 @@ public function getContactStatusHistory(): Collection
         return $this->getStatusHistory(ContactStatus::statusType());
     }
 
+    public function response()
+    {
+        return $this->hasOne(ContactResponse::class);
+    }
+
     public function user()
     {
         return $this->belongsTo(app('user'));

src/Models/ContactResponse.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tipoff\Forms\Models;
+
+use Illuminate\Database\Eloquent\SoftDeletes;
+use Tipoff\Support\Models\BaseModel;
+use Tipoff\Support\Traits\HasPackageFactory;
+
+class ContactResponse extends BaseModel
+{
+    use HasPackageFactory;
+    use SoftDeletes;
+
+    const UPDATED_AT = null;
+
+    public function contact()
+    {
+        return $this->belongsTo(Contact::class);
+    }
+}

src/Nova/Contact.php

@@ -18,6 +18,7 @@
 use Laravel\Nova\Http\Requests\NovaRequest;
 use Laravel\Nova\Panel;
 use Tipoff\Forms\Enums\ContactStatus;
+use Tipoff\Forms\Enums\FormType;
 use Tipoff\Support\Nova\BaseResource;
 use Tipoff\Support\Nova\Fields\Enum;
 
@@ -61,11 +62,11 @@ public function fields(Request $request)
                 return $contact->getContactStatus();
             })->attach(ContactStatus::class),
             Select::make('Form Type')->options([
-                'contact' => 'Contact Page',
-                'reservation' => 'Reservation Page',
-                'parties' => 'Private Parties Page',
-                'groups' => 'Team Building Page',
-                'employment' => 'Employment Page',
+                FormType::CONTACT => 'Contact',
+                FormType::RESERVATIONS => 'Reservations',
+                FormType::PARTIES => 'Parties',
+                FormType::GROUPS => 'Groups',
+                FormType::EMPLOYMENT => 'Employment',
             ])->required()->hideWhenUpdating(),
             nova('location') ? BelongsTo::make('Location', 'location', nova('location'))->required()->hideWhenUpdating() : null,
             nova('user') ? BelongsTo::make('User', 'user', nova('user'))->required()->hideWhenUpdating() : null,
@@ -83,9 +84,9 @@ protected function submissionFields()
     {
         return [
             Text::make('Number', 'reference_number')->exceptOnForms(),
-            Number::make('Participants')->nullable()->hideWhenUpdating(),
-            Date::make('Requested Date')->nullable()->hideWhenUpdating(),
-            Text::make('Requested Time')->nullable()->hideWhenUpdating(),
+            Number::make('Participants', 'fields->participants')->nullable()->hideWhenUpdating(),
+            Date::make('Requested Date', 'fields->requested_date')->nullable()->hideWhenUpdating(),
+            Text::make('Requested Time', 'fields->requested_time')->nullable()->hideWhenUpdating(),
             Text::make('Company Name')->nullable()->hideWhenUpdating(),
         ];
     }

src/Nova/ContactResponse.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tipoff\Forms\Nova;
+
+use Illuminate\Http\Request;
+use Laravel\Nova\Fields\DateTime;
+use Laravel\Nova\Fields\ID;
+use Laravel\Nova\Fields\Textarea;
+use Laravel\Nova\Http\Requests\NovaRequest;
+use Laravel\Nova\Panel;
+use Tipoff\Support\Nova\BaseResource;
+
+class ContactResponse extends BaseResource
+{
+    public static $model = \Tipoff\Forms\Models\ContactResponse::class;
+
+    public static $search = [
+        'id',
+    ];
+
+    public static $group = 'Forms';
+
+    public function fieldsForIndex(NovaRequest $request)
+    {
+        return array_filter([
+            ID::make(),
+        ]);
+    }
+
+    public function fields(Request $request)
+    {
+        return array_filter([
+            new Panel('Data Fields', $this->dataFields()),
+            Textarea::make('Message')->rows(3)->alwaysShow()->nullable()->hideWhenUpdating(),
+            Textarea::make('Comment')->rows(3)->alwaysShow()->nullable()->hideWhenUpdating(),
+        ]);
+    }
+
+    protected function dataFields(): array
+    {
+        return [
+            ID::make(),
+            DateTime::make('Emailed At', 'emailed_at')->exceptOnForms(),
+        ];
+    }
+}

src/Policies/ContactResponsePolicy.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tipoff\Forms\Policies;
+
+use Illuminate\Auth\Access\HandlesAuthorization;
+use Tipoff\Forms\Models\ContactResponse;
+use Tipoff\Support\Contracts\Models\UserInterface;
+
+class ContactResponsePolicy
+{
+    use HandlesAuthorization;
+
+    public function viewAny(UserInterface $user): bool
+    {
+        return $user->hasPermissionTo('view contact responses') ? true : false;
+    }
+
+    public function view(UserInterface $user, ContactResponse $contact_response): bool
+    {
+        return $user->hasPermissionTo('view contact responses') ? true : false;
+    }
+
+    public function create(UserInterface $user): bool
+    {
+        return $user->hasPermissionTo('create contact responses') ? true : false;
+    }
+
+    public function update(UserInterface $user, ContactResponse $contact_response): bool
+    {
+        return $user->hasPermissionTo('update contact responses') ? true : false;
+    }
+
+    public function delete(UserInterface $user, ContactResponse $contact_response): bool
+    {
+        return $user->hasPermissionTo('delete contact responses') ? true : false;
+    }
+
+    public function restore(UserInterface $user, ContactResponse $contact_response): bool
+    {
+        return false;
+    }
+
+    public function forceDelete(UserInterface $user, ContactResponse $contact_response): bool
+    {
+        return false;
+    }
+}

tests/Unit/Models/ContactResponseModelTest.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tipoff\Forms\Tests\Unit\Models;
+
+use Illuminate\Foundation\Testing\DatabaseTransactions;
+use Illuminate\Foundation\Testing\WithFaker;
+use Tipoff\Forms\Models\ContactResponse;
+use Tipoff\Forms\Tests\TestCase;
+
+class ContactResponseModelTest extends TestCase
+{
+    use DatabaseTransactions;
+    use WithFaker;
+
+    /** @test */
+    public function create()
+    {
+        $model = ContactResponse::factory()->create();
+        $this->assertNotNull($model);
+    }
+}