repository pattern implementation

app/Enums/CommentStatus.php

@@ -9,4 +9,5 @@ enum CommentStatus: string
     case PASSIVE = 'passive';
     case PENDING = 'pending';
     case TRASH = 'trash';
+    case ANALYZING = 'analyzing';
 }

app/Http/Controllers/CommentController.php

@@ -5,35 +5,54 @@
 use App\Http\Requests\CommentRequest;
 use App\Http\Resources\CommentResource;
 use App\Models\Comment;
+use App\Repositories\CommentRepositoryInterface;
 
 class CommentController extends Controller
 {
+    public function __construct(protected CommentRepositoryInterface $repository)
+    {
+    }
+
     public function index()
     {
-        return CommentResource::collection(Comment::all());
+        return CommentResource::collection(
+            $this->repository->all()
+        );
     }
 
     public function store(CommentRequest $request)
     {
-        return new CommentResource(Comment::create($request->validated()));
+        return new CommentResource(
+            $this->repository->create(
+                $request->validated()
+            )
+        );
     }
 
     public function show(Comment $comment)
     {
-        return new CommentResource($comment);
+        return new CommentResource(
+            $this->repository->find(
+                $comment->id
+            )
+        );
     }
 
     public function update(CommentRequest $request, Comment $comment)
     {
-        $comment->update($request->validated());
 
-        return new CommentResource($comment);
+        return new CommentResource(
+            $this->repository->update(
+                $comment->id,
+                $request->validated()
+            )
+        );
     }
 
     public function delete(Comment $comment)
     {
-        $comment->delete();
-
-        return response()->json();
+        return $this->repository->delete(
+            $comment->id
+        );
     }
 }

app/Providers/AppServiceProvider.php

@@ -2,6 +2,8 @@
 
 namespace App\Providers;
 
+use App\Repositories\CommentRepository;
+use App\Repositories\CommentRepositoryInterface;
 use Illuminate\Support\ServiceProvider;
 
 class AppServiceProvider extends ServiceProvider
@@ -11,7 +13,7 @@ class AppServiceProvider extends ServiceProvider
      */
     public function register(): void
     {
-        //
+        $this->app->bind(CommentRepositoryInterface::class, CommentRepository::class);
     }
 
     /**

app/Repositories/BaseRepository.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace App\Repositories;
+
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Model;
+use stdClass;
+
+class BaseRepository implements BaseRepositoryInterface
+{
+    public function __construct(protected Model $model)
+    {
+
+    }
+
+    public function all(): Collection
+    {
+        return $this->model->all();
+    }
+
+    public function find(int|string $id): ?stdClass
+    {
+        return (object) $this->model->findOrFail($id)->toArray();
+    }
+
+    public function create(array $data): stdClass
+    {
+        return $this->model->create([$data])->toArray();
+    }
+
+    public function update(string|int $id, array $data): ?stdClass
+    {
+        return (object) tap($this->model->findOrFail($id))->update($data)->toArray();
+    }
+
+    public function delete(int|string $id): bool
+    {
+        return $this->model->findOrFail($id)->delete();
+    }
+}

app/Repositories/BaseRepositoryInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace App\Repositories;
+
+use Illuminate\Database\Eloquent\Collection;
+use stdClass;
+
+interface BaseRepositoryInterface
+{
+    public function all(): Collection;
+
+    public function find(int|string $id): ?stdClass;
+
+    public function create(array $data): stdClass;
+
+    public function update(int|string $id, array $data): ?stdClass;
+
+    public function delete(int|string $id): bool;
+}

app/Repositories/CommentRepository.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace App\Repositories;
+
+use App\Enums\CommentStatus;
+use App\Models\Comment;
+use stdClass;
+
+class CommentRepository extends BaseRepository implements CommentRepositoryInterface
+{
+    public function __construct(Comment $comment)
+    {
+        parent::__construct($comment);
+    }
+
+    // Overriding BaseRepository method
+    // For example. If I have to pass ANALYZING case when $data['status'] is not exists. This can be handle in CommentRepository.
+    //(Maybe here is not a great place to apply this usage. In Comment Model we can use creating case on boot method)
+    public function create(array $data): stdClass
+    {
+        return (object) $this->model->create([
+            'email' => $data['email'],
+            'body' => $data['body'],
+            'rate' => $data['rate'],
+            'status' => $data['status'] ?? CommentStatus::ANALYZING->value,
+        ])->toArray();
+    }
+}

app/Repositories/CommentRepositoryInterface.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace App\Repositories;
+
+interface CommentRepositoryInterface
+{
+    // In here some of interface instances may override
+    // Usage examples:
+    // Example1: In some cases, instead of using "array $data" as
+    // parameter, a structure like "CommentDTO $data" can be used
+}

tests/Feature/Api/CommentTest.php

@@ -7,6 +7,11 @@
 
 class CommentTest extends TestCase
 {
+    public function test_index_has_comments()
+    {
+        $this->get('/api/comments')->assertSuccessful();
+    }
+
     public function test_stores_a_comment()
     {
         $this->post('/api/comments', [
@@ -16,17 +21,23 @@ public function test_stores_a_comment()
         ])->assertSuccessful();
     }
 
+    public function test_view_a_comment()
+    {
+        $comment = Comment::latest()->first();
+        $this->get('/api/comments/'.$comment->id)->assertSuccessful();
+    }
+
     public function test_updates_a_comment()
     {
-        $comment = Comment::first();
+        $comment = Comment::latest()->first();
         $this->put('/api/comments/'.$comment->id, [
             'body' => 'update comment | testing repository pattern',
         ])->assertSuccessful();
     }
 
     public function test_delete_a_comment()
     {
-        $comment = Comment::first();
+        $comment = Comment::latest()->first();
         $this->delete('/api/comments/'.$comment->id)->assertSuccessful();
     }
 }