feat: pet actions appear in feed (#215)

monicahq · Sep 10, 2022 · 086e913 · 086e913
1 parent 8721225
commit 086e913
Show file tree

Hide file tree

Showing 14 changed files with 253 additions and 0 deletions.
diff --git a/app/Models/ContactFeedItem.php b/app/Models/ContactFeedItem.php
@@ -34,6 +34,12 @@ class ContactFeedItem extends Model
 
     public const ACTION_NOTE_DESTROYED = 'note_destroyed';
 
+    public const ACTION_PET_CREATED = 'pet_created';
+
+    public const ACTION_PET_UPDATED = 'pet_updated';
+
+    public const ACTION_PET_DESTROYED = 'pet_destroyed';
+
     public const ACTION_GOAL_CREATED = 'goal_created';
 
     public const ACTION_GOAL_UPDATED = 'goal_updated';

diff --git a/app/Models/Pet.php b/app/Models/Pet.php
@@ -5,6 +5,7 @@
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\MorphOne;
 
 class Pet extends Model
 {
@@ -42,4 +43,14 @@ public function contact(): BelongsTo
     {
         return $this->belongsTo(Contact::class);
     }
+
+    /**
+     * Get the pet's feed item.
+     *
+     * @return MorphOne
+     */
+    public function feedItem(): MorphOne
+    {
+        return $this->morphOne(ContactFeedItem::class, 'feedable');
+    }
 }
diff --git a/domains/Contact/ManageContactFeed/Web/ViewHelpers/Actions/ActionFeedPet.php b/domains/Contact/ManageContactFeed/Web/ViewHelpers/Actions/ActionFeedPet.php
@@ -0,0 +1,38 @@
+<?php
+
+namespace App\Contact\ManageContactFeed\Web\ViewHelpers\Actions;
+
+use App\Models\ContactFeedItem;
+
+class ActionFeedPet
+{
+    public static function data(ContactFeedItem $item): array
+    {
+        $contact = $item->contact;
+        $pet = $item->feedable;
+
+        return [
+            'pet' => [
+                'object' => $pet ? [
+                    'id' => $pet->id,
+                    'name' => $pet->name,
+                    'pet_category' => [
+                        'id' => $pet->petCategory->id,
+                        'name' => $pet->petCategory->name,
+                    ],
+                ] : null,
+                'description' => $item->description,
+            ],
+            'contact' => [
+                'id' => $contact->id,
+                'name' => $contact->name,
+                'age' => $contact->age,
+                'avatar' => $contact->avatar,
+                'url' => route('contact.show', [
+                    'vault' => $contact->vault_id,
+                    'contact' => $contact->id,
+                ]),
+            ],
+        ];
+    }
+}
diff --git a/domains/Contact/ManageContactFeed/Web/ViewHelpers/ModuleFeedViewHelper.php b/domains/Contact/ManageContactFeed/Web/ViewHelpers/ModuleFeedViewHelper.php
@@ -6,6 +6,7 @@
 use App\Contact\ManageContactFeed\Web\ViewHelpers\Actions\ActionFeedContactInformation;
 use App\Contact\ManageContactFeed\Web\ViewHelpers\Actions\ActionFeedGenericContactInformation;
 use App\Contact\ManageContactFeed\Web\ViewHelpers\Actions\ActionFeedLabelAssigned;
+use App\Contact\ManageContactFeed\Web\ViewHelpers\Actions\ActionFeedPet;
 use App\Helpers\DateHelper;
 use App\Helpers\UserHelper;
 use App\Models\ContactFeedItem;
@@ -81,6 +82,11 @@ private static function getData(ContactFeedItem $item, User $user)
             case 'contact_information_destroyed':
                 return ActionFeedContactInformation::data($item);
 
+            case 'pet_created':
+            case 'pet_updated':
+            case 'pet_destroyed':
+                return ActionFeedPet::data($item);
+
             default:
                 return ActionFeedGenericContactInformation::data($item);
         }

diff --git a/domains/Contact/ManagePets/Services/CreatePet.php b/domains/Contact/ManagePets/Services/CreatePet.php
@@ -3,6 +3,7 @@
 namespace App\Contact\ManagePets\Services;
 
 use App\Interfaces\ServiceInterface;
+use App\Models\ContactFeedItem;
 use App\Models\Pet;
 use App\Models\PetCategory;
 use App\Services\BaseService;
@@ -66,6 +67,20 @@ public function execute(array $data): Pet
         $this->contact->last_updated_at = Carbon::now();
         $this->contact->save();
 
+        $this->createFeedItem();
+
         return $this->pet;
     }
+
+    private function createFeedItem(): void
+    {
+        $feedItem = ContactFeedItem::create([
+            'author_id' => $this->author->id,
+            'contact_id' => $this->contact->id,
+            'action' => ContactFeedItem::ACTION_PET_CREATED,
+            'description' => $this->pet->petCategory->name,
+        ]);
+
+        $this->pet->feedItem()->save($feedItem);
+    }
 }
diff --git a/domains/Contact/ManagePets/Services/DestroyPet.php b/domains/Contact/ManagePets/Services/DestroyPet.php
@@ -3,6 +3,7 @@
 namespace App\Contact\ManagePets\Services;
 
 use App\Interfaces\ServiceInterface;
+use App\Models\ContactFeedItem;
 use App\Models\Pet;
 use App\Services\BaseService;
 use Carbon\Carbon;
@@ -58,5 +59,17 @@ public function execute(array $data): void
 
         $this->contact->last_updated_at = Carbon::now();
         $this->contact->save();
+
+        $this->createFeedItem();
+    }
+
+    private function createFeedItem(): void
+    {
+        ContactFeedItem::create([
+            'author_id' => $this->author->id,
+            'contact_id' => $this->contact->id,
+            'action' => ContactFeedItem::ACTION_PET_DESTROYED,
+            'description' => $this->pet->petCategory->name,
+        ]);
     }
 }
diff --git a/domains/Contact/ManagePets/Services/UpdatePet.php b/domains/Contact/ManagePets/Services/UpdatePet.php
@@ -3,6 +3,7 @@
 namespace App\Contact\ManagePets\Services;
 
 use App\Interfaces\ServiceInterface;
+use App\Models\ContactFeedItem;
 use App\Models\Pet;
 use App\Models\PetCategory;
 use App\Services\BaseService;
@@ -69,6 +70,20 @@ public function execute(array $data): Pet
         $this->contact->last_updated_at = Carbon::now();
         $this->contact->save();
 
+        $this->createFeedItem();
+
         return $this->pet;
     }
+
+    private function createFeedItem(): void
+    {
+        $feedItem = ContactFeedItem::create([
+            'author_id' => $this->author->id,
+            'contact_id' => $this->contact->id,
+            'action' => ContactFeedItem::ACTION_PET_UPDATED,
+            'description' => $this->pet->petCategory->name,
+        ]);
+
+        $this->pet->feedItem()->save($feedItem);
+    }
 }
diff --git a/lang/en/contact.php b/lang/en/contact.php
@@ -27,6 +27,9 @@
     'feed_item_address_created' => 'added an address',
     'feed_item_address_updated' => 'updated an address',
     'feed_item_address_destroyed' => 'deleted an address',
+    'feed_item_pet_created' => 'added a pet',
+    'feed_item_pet_updated' => 'updated a pet',
+    'feed_item_pet_destroyed' => 'deleted a pet',
     'feed_item_contact_information_created' => 'added a contact information',
     'feed_item_contact_information_updated' => 'updated a contact information',
     'feed_item_contact_information_destroyed' => 'deleted a contact information',

diff --git a/resources/js/Shared/Modules/Feed.vue b/resources/js/Shared/Modules/Feed.vue
@@ -95,6 +95,15 @@
             "
             :data="feedItem.data"
             :contact-view-mode="contactViewMode" />
+
+          <pet
+            v-if="
+              feedItem.action === 'pet_created' ||
+              feedItem.action === 'pet_updated' ||
+              feedItem.action === 'pet_destroyed'
+            "
+            :data="feedItem.data"
+            :contact-view-mode="contactViewMode" />
         </div>
 
         <!-- details -->
@@ -121,6 +130,7 @@ import GenericAction from '@/Shared/Modules/FeedItems/GenericAction.vue';
 import LabelAssigned from '@/Shared/Modules/FeedItems/LabelAssigned.vue';
 import Addresses from '@/Shared/Modules/FeedItems/Address.vue';
 import ContactInformation from '@/Shared/Modules/FeedItems/ContactInformation.vue';
+import Pet from '@/Shared/Modules/FeedItems/Pet.vue';
 
 export default {
   components: {
@@ -129,6 +139,7 @@ export default {
     LabelAssigned,
     Addresses,
     ContactInformation,
+    Pet,
   },
 
   props: {

diff --git a/resources/js/Shared/Modules/FeedItems/Pet.vue b/resources/js/Shared/Modules/FeedItems/Pet.vue
@@ -0,0 +1,52 @@
+<template>
+  <div class="rounded-lg border border-gray-300 dark:border-gray-700">
+    <!-- contact information -->
+    <div
+      v-if="!contactViewMode"
+      class="flex items-center border-b border-gray-300 px-3 py-2 text-sm dark:border-gray-700">
+      <avatar
+        :data="data.contact.avatar"
+        :classes="'rounded-full border-gray-200 dark:border-gray-800 border relative h-5 w-5 mr-2'" />
+
+      <div class="flex flex-col">
+        <inertia-link :href="data.contact.url" class="text-gray-800 hover:underline dark:text-gray-200">{{
+          data.contact.name
+        }}</inertia-link>
+      </div>
+    </div>
+
+    <div class="px-3 py-2">
+      <!-- the pet still exists in the system -->
+      <div v-if="data.pet.object" class="flex items-center">
+        <span class="mr-2 text-sm text-gray-500">{{ data.pet.object.pet_category.name }}</span>
+        <span class="mr-2">{{ data.pet.object.name }}</span>
+      </div>
+
+      <!-- the pet was deleted -->
+      <span v-else class="mr-2 mb-2">
+        <span>{{ data.pet.description }}</span>
+      </span>
+    </div>
+  </div>
+</template>
+
+<script>
+import Avatar from '@/Shared/Avatar.vue';
+
+export default {
+  components: {
+    Avatar,
+  },
+
+  props: {
+    data: {
+      type: Object,
+      default: null,
+    },
+    contactViewMode: {
+      type: Boolean,
+      default: true,
+    },
+  },
+};
+</script>
diff --git a/tests/Unit/Domains/Contact/ManageContactFeed/Web/ViewHelpers/Actions/ActionFeedPetTest.php b/tests/Unit/Domains/Contact/ManageContactFeed/Web/ViewHelpers/Actions/ActionFeedPetTest.php
@@ -0,0 +1,65 @@
+<?php
+
+namespace Tests\Unit\Domains\Contact\ManageContactFeed\Web\ViewHelpers\Actions;
+
+use App\Contact\ManageContactFeed\Web\ViewHelpers\Actions\ActionFeedPet;
+use App\Models\Contact;
+use App\Models\ContactFeedItem;
+use App\Models\Pet;
+use App\Models\PetCategory;
+use Illuminate\Foundation\Testing\DatabaseTransactions;
+use Tests\TestCase;
+
+class ActionFeedPetTest extends TestCase
+{
+    use DatabaseTransactions;
+
+    /** @test */
+    public function it_gets_the_data_needed_for_the_view(): void
+    {
+        $contact = Contact::factory()->create([
+            'first_name' => 'John',
+            'last_name' => 'Doe',
+        ]);
+        $petCategory = PetCategory::factory()->create([
+            'name' => 'Dog',
+        ]);
+        $pet = Pet::factory()->create([
+            'pet_category_id' => $petCategory->id,
+            'name' => 'Charles',
+        ]);
+
+        $feedItem = ContactFeedItem::factory()->create([
+            'contact_id' => $contact->id,
+            'action' => ContactFeedItem::ACTION_PET_CREATED,
+            'description' => 'pet',
+        ]);
+        $pet->feedItem()->save($feedItem);
+
+        $array = ActionFeedPet::data($feedItem);
+
+        $this->assertEquals(
+            [
+                'pet' => [
+                    'object' => [
+                        'id' => $pet->id,
+                        'name' => 'Charles',
+                        'pet_category' => [
+                            'id' => $petCategory->id,
+                            'name' => 'Dog',
+                        ],
+                    ],
+                    'description' => 'pet',
+                ],
+                'contact' => [
+                    'id' => $contact->id,
+                    'name' => 'John Doe',
+                    'age' => null,
+                    'avatar' => $contact->avatar,
+                    'url' => env('APP_URL').'/vaults/'.$contact->vault_id.'/contacts/'.$contact->id,
+                ],
+            ],
+            $array
+        );
+    }
+}
diff --git a/tests/Unit/Domains/Contact/ManagePets/Services/CreatePetTest.php b/tests/Unit/Domains/Contact/ManagePets/Services/CreatePetTest.php
@@ -6,6 +6,7 @@
 use App\Exceptions\NotEnoughPermissionException;
 use App\Models\Account;
 use App\Models\Contact;
+use App\Models\ContactFeedItem;
 use App\Models\PetCategory;
 use App\Models\User;
 use App\Models\Vault;
@@ -117,5 +118,10 @@ private function executeService(User $author, Account $account, Vault $vault, Co
             'pet_category_id' => $petCategory->id,
             'name' => 'boubou',
         ]);
+
+        $this->assertDatabaseHas('contact_feed_items', [
+            'contact_id' => $contact->id,
+            'action' => ContactFeedItem::ACTION_PET_CREATED,
+        ]);
     }
 }
diff --git a/tests/Unit/Domains/Contact/ManagePets/Services/DestroyPetTest.php b/tests/Unit/Domains/Contact/ManagePets/Services/DestroyPetTest.php
@@ -6,6 +6,7 @@
 use App\Exceptions\NotEnoughPermissionException;
 use App\Models\Account;
 use App\Models\Contact;
+use App\Models\ContactFeedItem;
 use App\Models\Pet;
 use App\Models\User;
 use App\Models\Vault;
@@ -121,5 +122,10 @@ private function executeService(User $author, Account $account, Vault $vault, Co
         $this->assertDatabaseMissing('pets', [
             'id' => $pet->id,
         ]);
+
+        $this->assertDatabaseHas('contact_feed_items', [
+            'contact_id' => $contact->id,
+            'action' => ContactFeedItem::ACTION_PET_DESTROYED,
+        ]);
     }
 }
diff --git a/tests/Unit/Domains/Contact/ManagePets/Services/UpdatePetTest.php b/tests/Unit/Domains/Contact/ManagePets/Services/UpdatePetTest.php
@@ -6,6 +6,7 @@
 use App\Exceptions\NotEnoughPermissionException;
 use App\Models\Account;
 use App\Models\Contact;
+use App\Models\ContactFeedItem;
 use App\Models\ContactInformationType;
 use App\Models\Pet;
 use App\Models\PetCategory;
@@ -158,5 +159,10 @@ private function executeService(User $author, Account $account, Vault $vault, Co
             'pet_category_id' => $petCategory->id,
             'name' => 'boubou',
         ]);
+
+        $this->assertDatabaseHas('contact_feed_items', [
+            'contact_id' => $contact->id,
+            'action' => ContactFeedItem::ACTION_PET_UPDATED,
+        ]);
     }
 }