Input WYSIWYG: Updated API testing, fixed description set issue

ssddanbrown · ssddanbrown · commit 2a7a81e74952 · 2023-12-22T13:17:23.000Z
Fixed issue where an existing description_html field would not be
updated via 'description' input.
diff --git a/app/Entities/Repos/BaseRepo.php b/app/Entities/Repos/BaseRepo.php
@@ -116,6 +116,7 @@ protected function updateDescription(Entity $entity, array $input): void
             $entity->description = html_entity_decode(strip_tags($input['description_html']));
         } else if (isset($input['description'])) {
             $entity->description = $input['description'];
+            $entity->description_html = '';
             $entity->description_html = $entity->descriptionHtml();
         }
     }
diff --git a/tests/Api/BooksApiTest.php b/tests/Api/BooksApiTest.php
@@ -33,19 +33,44 @@ public function test_create_endpoint()
         $this->actingAsApiEditor();
         $templatePage = $this->entities->templatePage();
         $details = [
-            'name'        => 'My API book',
-            'description' => 'A book created via the API',
+            'name'                => 'My API book',
+            'description'         => 'A book created via the API',
             'default_template_id' => $templatePage->id,
         ];
 
         $resp = $this->postJson($this->baseEndpoint, $details);
         $resp->assertStatus(200);
 
         $newItem = Book::query()->orderByDesc('id')->where('name', '=', $details['name'])->first();
-        $resp->assertJson(array_merge($details, ['id' => $newItem->id, 'slug' => $newItem->slug]));
+        $resp->assertJson(array_merge($details, [
+            'id' => $newItem->id,
+            'slug' => $newItem->slug,
+            'description_html' => '<p>A book created via the API</p>',
+        ]));
         $this->assertActivityExists('book_create', $newItem);
     }
 
+    public function test_create_endpoint_with_html()
+    {
+        $this->actingAsApiEditor();
+        $details = [
+            'name'             => 'My API book',
+            'description_html' => '<p>A book <em>created</em> <strong>via</strong> the API</p>',
+        ];
+
+        $resp = $this->postJson($this->baseEndpoint, $details);
+        $resp->assertStatus(200);
+
+        $newItem = Book::query()->orderByDesc('id')->where('name', '=', $details['name'])->first();
+        $expectedDetails = array_merge($details, [
+            'id'          => $newItem->id,
+            'description' => 'A book created via the API',
+        ]);
+
+        $resp->assertJson($expectedDetails);
+        $this->assertDatabaseHas('books', $expectedDetails);
+    }
+
     public function test_book_name_needed_to_create()
     {
         $this->actingAsApiEditor();
@@ -61,7 +86,7 @@ public function test_book_name_needed_to_create()
                 'validation' => [
                     'name' => ['The name field is required.'],
                 ],
-                'code' => 422,
+                'code'       => 422,
             ],
         ]);
     }
@@ -128,18 +153,37 @@ public function test_update_endpoint()
         $templatePage = $this->entities->templatePage();
         $details = [
             'name'        => 'My updated API book',
-            'description' => 'A book created via the API',
+            'description' => 'A book updated via the API',
             'default_template_id' => $templatePage->id,
         ];
 
         $resp = $this->putJson($this->baseEndpoint . "/{$book->id}", $details);
         $book->refresh();
 
         $resp->assertStatus(200);
-        $resp->assertJson(array_merge($details, ['id' => $book->id, 'slug' => $book->slug]));
+        $resp->assertJson(array_merge($details, [
+            'id' => $book->id,
+            'slug' => $book->slug,
+            'description_html' => '<p>A book updated via the API</p>',
+        ]));
         $this->assertActivityExists('book_update', $book);
     }
 
+    public function test_update_endpoint_with_html()
+    {
+        $this->actingAsApiEditor();
+        $book = $this->entities->book();
+        $details = [
+            'name'             => 'My updated API book',
+            'description_html' => '<p>A book <strong>updated</strong> via the API</p>',
+        ];
+
+        $resp = $this->putJson($this->baseEndpoint . "/{$book->id}", $details);
+        $resp->assertStatus(200);
+
+        $this->assertDatabaseHas('books', array_merge($details, ['id' => $book->id, 'description' => 'A book updated via the API']));
+    }
+
     public function test_update_increments_updated_date_if_only_tags_are_sent()
     {
         $this->actingAsApiEditor();
diff --git a/tests/Api/ChaptersApiTest.php b/tests/Api/ChaptersApiTest.php
@@ -51,7 +51,11 @@ public function test_create_endpoint()
         $resp = $this->postJson($this->baseEndpoint, $details);
         $resp->assertStatus(200);
         $newItem = Chapter::query()->orderByDesc('id')->where('name', '=', $details['name'])->first();
-        $resp->assertJson(array_merge($details, ['id' => $newItem->id, 'slug' => $newItem->slug]));
+        $resp->assertJson(array_merge($details, [
+            'id' => $newItem->id,
+            'slug' => $newItem->slug,
+            'description_html' => '<p>A chapter created via the API</p>',
+        ]));
         $this->assertDatabaseHas('tags', [
             'entity_id'   => $newItem->id,
             'entity_type' => $newItem->getMorphClass(),
@@ -62,6 +66,28 @@ public function test_create_endpoint()
         $this->assertActivityExists('chapter_create', $newItem);
     }
 
+    public function test_create_endpoint_with_html()
+    {
+        $this->actingAsApiEditor();
+        $book = $this->entities->book();
+        $details = [
+            'name'             => 'My API chapter',
+            'description_html' => '<p>A chapter <strong>created</strong> via the API</p>',
+            'book_id'          => $book->id,
+        ];
+
+        $resp = $this->postJson($this->baseEndpoint, $details);
+        $resp->assertStatus(200);
+        $newItem = Chapter::query()->orderByDesc('id')->where('name', '=', $details['name'])->first();
+
+        $expectedDetails = array_merge($details, [
+            'id'          => $newItem->id,
+            'description' => 'A chapter created via the API',
+        ]);
+        $resp->assertJson($expectedDetails);
+        $this->assertDatabaseHas('chapters', $expectedDetails);
+    }
+
     public function test_chapter_name_needed_to_create()
     {
         $this->actingAsApiEditor();
@@ -131,7 +157,7 @@ public function test_update_endpoint()
         $chapter = $this->entities->chapter();
         $details = [
             'name'        => 'My updated API chapter',
-            'description' => 'A chapter created via the API',
+            'description' => 'A chapter updated via the API',
             'tags'        => [
                 [
                     'name'  => 'freshtag',
@@ -146,11 +172,31 @@ public function test_update_endpoint()
 
         $resp->assertStatus(200);
         $resp->assertJson(array_merge($details, [
-            'id' => $chapter->id, 'slug' => $chapter->slug, 'book_id' => $chapter->book_id,
+            'id' => $chapter->id,
+            'slug' => $chapter->slug,
+            'book_id' => $chapter->book_id,
+            'description_html' => '<p>A chapter updated via the API</p>',
         ]));
         $this->assertActivityExists('chapter_update', $chapter);
     }
 
+    public function test_update_endpoint_with_html()
+    {
+        $this->actingAsApiEditor();
+        $chapter = $this->entities->chapter();
+        $details = [
+            'name'             => 'My updated API chapter',
+            'description_html' => '<p>A chapter <em>updated</em> via the API</p>',
+        ];
+
+        $resp = $this->putJson($this->baseEndpoint . "/{$chapter->id}", $details);
+        $resp->assertStatus(200);
+
+        $this->assertDatabaseHas('chapters', array_merge($details, [
+            'id' => $chapter->id, 'description' => 'A chapter updated via the API'
+        ]));
+    }
+
     public function test_update_increments_updated_date_if_only_tags_are_sent()
     {
         $this->actingAsApiEditor();
diff --git a/tests/Api/ShelvesApiTest.php b/tests/Api/ShelvesApiTest.php
@@ -42,7 +42,11 @@ public function test_create_endpoint()
         $resp = $this->postJson($this->baseEndpoint, array_merge($details, ['books' => [$books[0]->id, $books[1]->id]]));
         $resp->assertStatus(200);
         $newItem = Bookshelf::query()->orderByDesc('id')->where('name', '=', $details['name'])->first();
-        $resp->assertJson(array_merge($details, ['id' => $newItem->id, 'slug' => $newItem->slug]));
+        $resp->assertJson(array_merge($details, [
+            'id' => $newItem->id,
+            'slug' => $newItem->slug,
+            'description_html' => '<p>A shelf created via the API</p>',
+        ]));
         $this->assertActivityExists('bookshelf_create', $newItem);
         foreach ($books as $index => $book) {
             $this->assertDatabaseHas('bookshelves_books', [
@@ -53,6 +57,28 @@ public function test_create_endpoint()
         }
     }
 
+    public function test_create_endpoint_with_html()
+    {
+        $this->actingAsApiEditor();
+
+        $details = [
+            'name'             => 'My API shelf',
+            'description_html' => '<p>A <strong>shelf</strong> created via the API</p>',
+        ];
+
+        $resp = $this->postJson($this->baseEndpoint, $details);
+        $resp->assertStatus(200);
+        $newItem = Bookshelf::query()->orderByDesc('id')->where('name', '=', $details['name'])->first();
+
+        $expectedDetails = array_merge($details, [
+            'id'          => $newItem->id,
+            'description' => 'A shelf created via the API',
+        ]);
+
+        $resp->assertJson($expectedDetails);
+        $this->assertDatabaseHas('bookshelves', $expectedDetails);
+    }
+
     public function test_shelf_name_needed_to_create()
     {
         $this->actingAsApiEditor();
@@ -102,17 +128,36 @@ public function test_update_endpoint()
         $shelf = Bookshelf::visible()->first();
         $details = [
             'name'        => 'My updated API shelf',
-            'description' => 'A shelf created via the API',
+            'description' => 'A shelf updated via the API',
         ];
 
         $resp = $this->putJson($this->baseEndpoint . "/{$shelf->id}", $details);
         $shelf->refresh();
 
         $resp->assertStatus(200);
-        $resp->assertJson(array_merge($details, ['id' => $shelf->id, 'slug' => $shelf->slug]));
+        $resp->assertJson(array_merge($details, [
+            'id' => $shelf->id,
+            'slug' => $shelf->slug,
+            'description_html' => '<p>A shelf updated via the API</p>',
+        ]));
         $this->assertActivityExists('bookshelf_update', $shelf);
     }
 
+    public function test_update_endpoint_with_html()
+    {
+        $this->actingAsApiEditor();
+        $shelf = Bookshelf::visible()->first();
+        $details = [
+            'name'             => 'My updated API shelf',
+            'description_html' => '<p>A shelf <em>updated</em> via the API</p>',
+        ];
+
+        $resp = $this->putJson($this->baseEndpoint . "/{$shelf->id}", $details);
+        $resp->assertStatus(200);
+
+        $this->assertDatabaseHas('bookshelves', array_merge($details, ['id' => $shelf->id, 'description' => 'A shelf updated via the API']));
+    }
+
     public function test_update_increments_updated_date_if_only_tags_are_sent()
     {
         $this->actingAsApiEditor();

Original file line number	Diff line number	Diff line change
`@@ -116,6 +116,7 @@ protected function updateDescription(Entity $entity, array $input): void`
`116`	`116`	`$entity->description = html_entity_decode(strip_tags($input['description_html']));`
`117`	`117`	`} else if (isset($input['description'])) {`
`118`	`118`	`$entity->description = $input['description'];`
	`119`	`+ $entity->description_html = '';`
`119`	`120`	`$entity->description_html = $entity->descriptionHtml();`
`120`	`121`	`}`
`121`	`122`	`}`