refactor: clean and modularize some code

mascam97 · mascam97 · commit eb05f6858c00 · 2023-05-16T09:15:49.000-05:00
diff --git a/app/Actions/Notes/StoreNoteAction.php b/app/Actions/Notes/StoreNoteAction.php
@@ -5,20 +5,22 @@
 use App\Dtos\Notes\StoreNoteData;
 use App\Dtos\Subscriptions\SubscriptionRulesData;
 use App\Exceptions\NoteExceptions;
+use App\Exceptions\SubscriptionExceptions;
 use App\Models\Note;
 use App\Models\User;
 
 class StoreNoteAction
 {
     /**
      * @throws NoteExceptions
+     * @throws SubscriptionExceptions
      */
     public function handle(StoreNoteData $data, User $user): Note
     {
         $userSubscription = $user->subscription;
 
         if ($userSubscription === null) {
-            throw NoteExceptions::userDoesNotHaveSubscription();
+            throw SubscriptionExceptions::userDoesNotHaveSubscription();
         }
 
         $notesAmount = $user->notes()->count();
diff --git a/app/Exceptions/NoteExceptions.php b/app/Exceptions/NoteExceptions.php
@@ -10,9 +10,4 @@ public static function notesAmountLimit(int $limitNotes): self
     {
         return new static(__('validation.custom.notes.limit', ['amount' => $limitNotes]));
     }
-
-    public static function userDoesNotHaveSubscription(): self
-    {
-        return new static(__('validation.custom.subscription.required'));
-    }
 }
diff --git a/app/Exceptions/SubscriptionExceptions.php b/app/Exceptions/SubscriptionExceptions.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace App\Exceptions;
+
+use Exception;
+
+class SubscriptionExceptions extends Exception
+{
+    public static function userDoesNotHaveSubscription(): self
+    {
+        return new static(__('validation.custom.subscription.required'));
+    }
+}
diff --git a/app/Http/Controllers/Api/NotesController.php b/app/Http/Controllers/Api/NotesController.php
@@ -7,6 +7,7 @@
 use App\Dtos\Notes\StoreNoteData;
 use App\Dtos\Notes\UpdateNoteData;
 use App\Exceptions\NoteExceptions;
+use App\Exceptions\SubscriptionExceptions;
 use App\Http\Controllers\Controller;
 use App\Http\Controllers\NoteResource;
 use App\Http\Requests\UpdateNoteRequest;
@@ -44,7 +45,7 @@ public function store(StoreNoteRequest $request): JsonResponse
 
         try {
             $note = (new StoreNoteAction())->handle($data, $authUser);
-        } catch (NoteExceptions $e) {
+        } catch (NoteExceptions|SubscriptionExceptions $e) {
             return response()->json(['message' => $e->getMessage()], 400);
         }
 
diff --git a/app/Http/Controllers/NotesController.php b/app/Http/Controllers/NotesController.php
@@ -7,6 +7,7 @@
 use App\Dtos\Notes\StoreNoteData;
 use App\Dtos\Notes\UpdateNoteData;
 use App\Exceptions\NoteExceptions;
+use App\Exceptions\SubscriptionExceptions;
 use App\Http\Requests\UpdateNoteRequest;
 use App\Models\Note;
 use App\Models\User;
@@ -49,7 +50,7 @@ public function store(StoreNoteRequest $request): RedirectResponse
 
         try {
             (new StoreNoteAction())->handle($data, $authUser);
-        } catch (NoteExceptions $e) {
+        } catch (NoteExceptions|SubscriptionExceptions $e) {
             return redirect()
                 ->route('notes.index')
                 ->with('warning', $e->getMessage());
diff --git a/tests/Feature/Http/Controllers/Api/Notes/DestroyNoteControllerTest.php b/tests/Feature/Http/Controllers/Api/Notes/DestroyNoteControllerTest.php
@@ -5,13 +5,11 @@
 use App\Models\User;
 use App\Models\Note;
 use Illuminate\Foundation\Testing\RefreshDatabase;
-use Illuminate\Foundation\Testing\WithFaker;
 use Tests\TestCase;
 
 class DestroyNoteControllerTest extends TestCase
 {
     use RefreshDatabase;
-    use WithFaker;
 
     private string $url = 'api/notes';
 
diff --git a/tests/Feature/Http/Controllers/Api/Notes/IndexNotesControllerTest.php b/tests/Feature/Http/Controllers/Api/Notes/IndexNotesControllerTest.php
@@ -5,13 +5,11 @@
 use App\Models\User;
 use App\Models\Note;
 use Illuminate\Foundation\Testing\RefreshDatabase;
-use Illuminate\Foundation\Testing\WithFaker;
 use Tests\TestCase;
 
 class IndexNotesControllerTest extends TestCase
 {
     use RefreshDatabase;
-    use WithFaker;
 
     private string $url = 'api/notes';
 
diff --git a/tests/Feature/Http/Controllers/Api/Notes/ShowNoteControllerTest.php b/tests/Feature/Http/Controllers/Api/Notes/ShowNoteControllerTest.php
@@ -5,14 +5,12 @@
 use App\Models\User;
 use App\Models\Note;
 use Illuminate\Foundation\Testing\RefreshDatabase;
-use Illuminate\Foundation\Testing\WithFaker;
 use Illuminate\Testing\Fluent\AssertableJson;
 use Tests\TestCase;
 
 class ShowNoteControllerTest extends TestCase
 {
     use RefreshDatabase;
-    use WithFaker;
 
     private string $url = 'api/notes';
 
diff --git a/tests/Feature/Http/Controllers/Api/Notes/StoreNoteControllerTest.php b/tests/Feature/Http/Controllers/Api/Notes/StoreNoteControllerTest.php
@@ -5,13 +5,11 @@
 use App\Models\Subscription;
 use App\Models\User;
 use Illuminate\Foundation\Testing\RefreshDatabase;
-use Illuminate\Foundation\Testing\WithFaker;
 use Tests\TestCase;
 
 class StoreNoteControllerTest extends TestCase
 {
     use RefreshDatabase;
-    use WithFaker;
 
     private string $url = 'api/notes';
 
diff --git a/tests/Feature/Http/Controllers/Api/Notes/StoreNoteValidationsControllerTest.php b/tests/Feature/Http/Controllers/Api/Notes/StoreNoteValidationsControllerTest.php
@@ -6,13 +6,11 @@
 use App\Models\Subscription;
 use App\Models\User;
 use Illuminate\Foundation\Testing\RefreshDatabase;
-use Illuminate\Foundation\Testing\WithFaker;
 use Tests\TestCase;
 
 class StoreNoteValidationsControllerTest extends TestCase
 {
     use RefreshDatabase;
-    use WithFaker;
 
     private string $url = 'api/notes';
 
diff --git a/tests/Feature/Http/Controllers/Api/Notes/UpdateNoteControllerTest.php b/tests/Feature/Http/Controllers/Api/Notes/UpdateNoteControllerTest.php
@@ -5,13 +5,11 @@
 use App\Models\Note;
 use App\Models\User;
 use Illuminate\Foundation\Testing\RefreshDatabase;
-use Illuminate\Foundation\Testing\WithFaker;
 use Tests\TestCase;
 
 class UpdateNoteControllerTest extends TestCase
 {
     use RefreshDatabase;
-    use WithFaker;
 
     private string $url = 'api/notes';
 
diff --git a/tests/Feature/Http/Controllers/Api/Notes/UpdateNoteValidationsControllerTest.php b/tests/Feature/Http/Controllers/Api/Notes/UpdateNoteValidationsControllerTest.php
@@ -5,13 +5,11 @@
 use App\Models\Note;
 use App\Models\User;
 use Illuminate\Foundation\Testing\RefreshDatabase;
-use Illuminate\Foundation\Testing\WithFaker;
 use Tests\TestCase;
 
 class UpdateNoteValidationsControllerTest extends TestCase
 {
     use RefreshDatabase;
-    use WithFaker;
 
     private string $url = 'api/notes';
 
diff --git a/tests/Feature/Http/Controllers/Notes/DestroyControllerTest.php b/tests/Feature/Http/Controllers/Notes/DestroyControllerTest.php
@@ -0,0 +1,44 @@
+<?php
+
+namespace Tests\Feature\Http\Controllers\Notes;
+
+use App\Models\User;
+use App\Models\Note;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Tests\TestCase;
+
+class DestroyControllerTest extends TestCase
+{
+    use RefreshDatabase;
+
+    private string $url = '/notes';
+
+    private User $user;
+
+    private Note $note;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->user = User::factory()->create();
+
+        $this->note = Note::factory()->user($this->user)->create([
+            'title' => 'Post to delete',
+        ]);
+
+        $this->actingAs($this->user);
+    }
+
+    public function test_destroy()
+    {
+        $this->delete("$this->url/{$this->note->id}")
+            ->assertStatus(302);
+
+        $this->assertDatabaseMissing('notes', [
+            'id' => $this->note->id,
+            'user_id' => $this->note->user_id,
+            'title' => 'post to delete'
+        ]);
+    }
+}
diff --git a/tests/Feature/Http/Controllers/Notes/IndexNotesControllerTest.php b/tests/Feature/Http/Controllers/Notes/IndexNotesControllerTest.php
@@ -5,13 +5,11 @@
 use App\Models\User;
 use App\Models\Note;
 use Illuminate\Foundation\Testing\RefreshDatabase;
-use Illuminate\Foundation\Testing\WithFaker;
 use Tests\TestCase;
 
 class IndexNotesControllerTest extends TestCase
 {
     use RefreshDatabase;
-    use WithFaker;
 
     private string $url = '/notes';
 
diff --git a/tests/Feature/Http/Controllers/Notes/NotesControllerTest.php b/tests/Feature/Http/Controllers/Notes/NotesControllerTest.php
@@ -5,15 +5,13 @@
 use App\Models\User;
 use App\Models\Note;
 use Illuminate\Foundation\Testing\RefreshDatabase;
-use Illuminate\Foundation\Testing\WithFaker;
 use Tests\TestCase;
 
 class NotesControllerTest extends TestCase
 {
     use RefreshDatabase;
-    use WithFaker;
 
-    private $url = '/notes';
+    private string $url = '/notes';
 
     public function test_guest()
     {
@@ -48,20 +46,4 @@ public function test_show_and_edit()
         $response_edit->assertSee($data['title']);
         $response_edit->assertSee($data['content']);
     }
-
-    public function test_destroy()
-    {
-        $user = User::factory()->create();
-        $note = Note::factory()->user($user)->create([
-            'title' => 'post to delete'
-        ]);
-
-        $response = $this->actingAs($user)->delete("$this->url/{$note->id}");
-
-        $response->assertStatus(302);
-        $this->assertDatabaseMissing('notes', [
-            'user_id' => $note->user_id,
-            'title' => 'post to delete'
-        ]);
-    }
 }
diff --git a/tests/Feature/Http/Controllers/Notes/ShowNotesControllerTest.php b/tests/Feature/Http/Controllers/Notes/ShowNotesControllerTest.php
@@ -0,0 +1,45 @@
+<?php
+
+namespace Tests\Feature\Http\Controllers\Notes;
+
+use App\Models\User;
+use App\Models\Note;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Tests\TestCase;
+
+class ShowNotesControllerTest extends TestCase
+{
+    use RefreshDatabase;
+
+    private string $url = '/notes';
+
+    private User $user;
+
+    private Note $note;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->user = User::factory()->create();
+
+        $this->note = Note::factory()->user($this->user)->create([
+            'title' => 'Post to delete',
+        ]);
+
+        $this->actingAs($this->user);
+    }
+
+    public function test_show_and_edit()
+    {
+        $this->get("$this->url/{$this->note->id}")
+            ->assertStatus(200)
+            ->assertSee($this->note->title)
+            ->assertSee($this->note->content);
+
+        $this->get("$this->url/{$this->note->id}/edit")
+            ->assertStatus(200)
+            ->assertSee($this->note->title)
+            ->assertSee($this->note->content);
+    }
+}
diff --git a/tests/Feature/Http/Controllers/Notes/StoreNoteControllerTest.php b/tests/Feature/Http/Controllers/Notes/StoreNoteControllerTest.php
@@ -5,13 +5,11 @@
 use App\Models\Subscription;
 use App\Models\User;
 use Illuminate\Foundation\Testing\RefreshDatabase;
-use Illuminate\Foundation\Testing\WithFaker;
 use Tests\TestCase;
 
 class StoreNoteControllerTest extends TestCase
 {
     use RefreshDatabase;
-    use WithFaker;
 
     private string $url = '/notes';
 
@@ -31,15 +29,6 @@ protected function setUp(): void
         $this->actingAs($this->user);
     }
 
-    public function test_validate_store()
-    {
-        $this->post($this->url, [
-            'title' => '',
-            'content' => ''
-        ])->assertStatus(302)
-            ->assertSessionHasErrors(['title', 'content']);
-    }
-
     public function test_store()
     {
         $this->post($this->url, [
diff --git a/tests/Feature/Http/Controllers/Notes/StoreNoteValidationsControllerTest.php b/tests/Feature/Http/Controllers/Notes/StoreNoteValidationsControllerTest.php
@@ -0,0 +1,40 @@
+<?php
+
+namespace Tests\Feature\Http\Controllers\Notes;
+
+use App\Models\Subscription;
+use App\Models\User;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Tests\TestCase;
+
+class StoreNoteValidationsControllerTest extends TestCase
+{
+    use RefreshDatabase;
+
+    private string $url = '/notes';
+
+    private User $user;
+
+    private Subscription $subscription;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->user = User::factory()->create();
+
+        $this->subscription = Subscription::factory()->create(['rules' => ['notes_maximum_amount' => 1000]]);
+        $this->user->subscription()->associate($this->subscription)->save();
+
+        $this->actingAs($this->user);
+    }
+
+    public function test_validate_store()
+    {
+        $this->post($this->url, [
+            'title' => '',
+            'content' => ''
+        ])->assertStatus(302)
+            ->assertSessionHasErrors(['title', 'content']);
+    }
+}
diff --git a/tests/Feature/Http/Controllers/Notes/UpdateNoteControllerTest.php b/tests/Feature/Http/Controllers/Notes/UpdateNoteControllerTest.php
diff --git a/tests/Feature/Http/Controllers/Notes/UpdateNoteValidationsControllerTest.php b/tests/Feature/Http/Controllers/Notes/UpdateNoteValidationsControllerTest.php
diff --git a/tests/Feature/Http/Middleware/NoteBelongsToLoggedUserTest.php b/tests/Feature/Http/Middleware/NoteBelongsToLoggedUserTest.php
diff --git a/tests/Unit/Actions/Notes/StoreNoteActionTest.php b/tests/Unit/Actions/Notes/StoreNoteActionTest.php

Original file line number	Diff line number	Diff line change
`@@ -10,9 +10,4 @@ public static function notesAmountLimit(int $limitNotes): self`
`10`	`10`	`{`
`11`	`11`	`return new static(__('validation.custom.notes.limit', ['amount' => $limitNotes]));`
`12`	`12`	`}`
`13`		`-`
`14`		`- public static function userDoesNotHaveSubscription(): self`
`15`		`- {`
`16`		`- return new static(__('validation.custom.subscription.required'));`
`17`		`- }`
`18`	`13`	`}`