wip

Author: aguingand

docs/guide/testing.md

@@ -4,19 +4,29 @@ Sharp provides a fluent testing API to help you test your Sharp code. These asse
 
 ## The `SharpAssertions` trait
 
-To use Sharp's testing helpers, include the `Code16\Sharp\Utils\Testing\SharpAssertions` trait in your test class:
+To use Sharp's testing helpers, include the `Code16\Sharp\Utils\Testing\SharpAssertions` trait in your TestCase class:
 
 ```php
 use Code16\Sharp\Utils\Testing\SharpAssertions;
 
-class PostFormTest extends TestCase
+abstract class TestCase extends BaseTestCase
 {
     use SharpAssertions;
 
     // ...
 }
 ```
 
+or in `Pest.php`:
+
+```php
+use Code16\Sharp\Utils\Testing\SharpAssertions;
+
+pest()
+    ->extend(\Tests\TestCase::class)
+    ->use(SharpAssertions::class)
+```
+
 ## Authentication
 
 ### `loginAsSharpUser($user)`
@@ -68,31 +78,46 @@ You can call an Entity Command directly from the list:
 
 ```php
 $this->sharpList(Post::class)
-    ->callEntityCommand(ExportPosts::class, ['format' => 'csv'])
+    ->entityCommand(ExportPosts::class)
+    ->post()
     ->assertOk()
     ->assertReturnsDownload('posts.csv');
 ```
 
+If the command has a form, you can test it:
+
+```php
+$this->sharpList(Post::class)
+    ->entityCommand(ExportPosts::class)
+    ->getForm()
+    ->post(['format' => 'csv'])
+    ->assertOk();
+```
+
 ### Instance Commands
 
 Similarly, you can call an Instance Command:
 
 ```php
 $this->sharpList(Post::class)
-    ->callInstanceCommand(1, PublishPost::class)
+    ->instanceCommand(PublishPost::class, 1)
+    ->post()
     ->assertOk()
     ->assertReturnsReload();
 ```
 
 ### Multi-step Commands (Wizards)
 
-For commands that have multiple steps, you can use `callNextStep()`:
+For commands that have multiple steps, you can use `getNextStepForm()`:
 
 ```php
 $this->sharpList(Post::class)
-    ->callEntityCommand(MyWizardCommand::class, ['step1_data' => 'value'])
+    ->entityCommand(MyWizardCommand::class)
+    ->getForm()
+    ->post(['step1_data' => 'value'])
     ->assertReturnsStep('step2')
-    ->callNextStep(['step2_data' => 'value'])
+    ->getNextStepForm()
+    ->post(['step2_data' => 'value'])
     ->assertOk();
 ```
 
@@ -118,7 +143,8 @@ $this->sharpShow(Post::class, 1)
 
 ```php
 $this->sharpShow(Post::class, 1)
-    ->callInstanceCommand(PublishPost::class)
+    ->instanceCommand(PublishPost::class)
+    ->post()
     ->assertOk();
 ```
 
@@ -193,7 +219,8 @@ $this->sharpDashboard(MyDashboard::class)
 
 ```php
 $this->sharpDashboard(MyDashboard::class)
-    ->callDashboardCommand(RefreshStats::class)
+    ->dashboardCommand(RefreshStats::class)
+    ->post()
     ->assertOk();
 ```
 
@@ -219,22 +246,3 @@ $this->sharpShow(User::class, 1)
     ->get()
     ->assertOk();
 ```
-
-## Advanced: Breadcrumbs and Context
-
-Most of the time, Sharp handles the breadcrumb automatically. However, you might need to simulate a specific breadcrumb context.
-
-### `withSharpBreadcrumb(Closure $callback)`
-
-```php
-use Code16\Sharp\Utils\Links\BreadcrumbBuilder;
-
-$this->withSharpBreadcrumb(function (BreadcrumbBuilder $builder) {
-    return $builder
-        ->appendEntityList(Category::class)
-        ->appendShowPage(Category::class, 1);
-})
-    ->sharpShow(Post::class, 1)
-    ->get()
-    ->assertOk();
-```

src/EntityList/Traits/HandleEntityCommands.php

@@ -45,8 +45,6 @@ protected function appendEntityCommandsToConfig(array &$config): void
 
     final public function getEntityCommandsHandlers(): Collection
     {
-        ray($this->entityCommandHandlers);
-        ray()->trace();
         if ($this->entityCommandHandlers === null) {
             $groupIndex = 0;
             $this->entityCommandHandlers = collect($this->getEntityCommands())
@@ -75,7 +73,6 @@ final public function getEntityCommandsHandlers(): Collection
                         $commandHandler->setCommandKey($commandKey);
                     }
 
-                    // ray($this->queryParams ?? null, $commandHandler)->trace();
                     if (isset($this->queryParams)) {
                         // We have to init query params of the command
                         $commandHandler->initQueryParams($this->queryParams);

src/Utils/Testing/Commands/AssertableCommandForm.php

@@ -26,8 +26,6 @@ public function __construct(
 
     public function post(array $data = []): AssertableCommand
     {
-        ray($this->formData());
-
         return new AssertableCommand(
             postCommand: fn ($data, $step) => ($this->post)($data, $step, $this->formData()),
             getForm: $this->getForm,

src/Utils/Testing/Dashboard/PendingDashboard.php

@@ -82,7 +82,7 @@ public function dashboardCommand(string $commandKeyOrClassName): PendingCommand
                     route(
                         'code16.sharp.api.dashboard.command.form',
                         [
-                            'entityKey' => $this->entityKey,
+                            'dashboardKey' => $this->entityKey,
                             'commandKey' => $commandKey,
                             'command_step' => $step,
                             ...$this->dashboardQueryParams(),
@@ -97,7 +97,7 @@ public function dashboardCommand(string $commandKeyOrClassName): PendingCommand
                 ->postJson(
                     route(
                         'code16.sharp.api.dashboard.command',
-                        ['entityKey' => $this->entityKey, 'commandKey' => $commandKey]
+                        ['dashboardKey' => $this->entityKey, 'commandKey' => $commandKey]
                     ),
                     [
                         'data' => $this->formatDataForCommand(

tests/Fixtures/Entities/DashboardEntity.php

@@ -23,7 +23,7 @@ public function setShow(?SharpDashboard $show): self
 
     protected function getView(): SharpDashboard
     {
-        return $this->fakeView ?? parent::getView();
+        return isset($this->fakeView) ? clone $this->fakeView : parent::getView();
     }
 
     public function setPolicy(SharpEntityPolicy $policy): self

tests/Fixtures/Entities/PersonEntity.php

@@ -57,17 +57,17 @@ public function setForm(?SharpForm $form): self
 
     public function getForm(): ?SharpForm
     {
-        return $this->fakeForm ?? parent::getForm();
+        return isset($this->fakeForm) ? clone $this->fakeForm : parent::getForm();
     }
 
     protected function getShow(): ?SharpShow
     {
-        return $this->fakeShow ?? parent::getShow();
+        return isset($this->fakeShow) ? clone $this->fakeShow : parent::getShow();
     }
 
     protected function getList(): ?SharpEntityList
     {
-        return $this->fakeList ?? parent::getList();
+        return isset($this->fakeList) ? clone $this->fakeList : parent::getList();
     }
 
     public function setValidator(string $validatorClass, ?string $subentity = null): self

tests/Http/Api/ApiEntityListControllerTest.php

@@ -20,29 +20,27 @@
 });
 
 it('allows to reorder instances', function () {
-    $this->withoutExceptionHandling();
+    $ids = null;
 
-    $list = new class() extends PersonList
+    fakeListFor('person', new class($ids) extends PersonList
     {
-        public array $reorderedInstances = [];
+        public function __construct(public &$ids) {}
 
         public function buildListConfig(): void
         {
             $this->configureReorderable(
-                new class($this->reorderedInstances) implements ReorderHandler
+                new class($this->ids) implements ReorderHandler
                 {
-                    public function __construct(public array &$reorderedInstances) {}
+                    public function __construct(public &$ids) {}
 
                     public function reorder(array $ids): void
                     {
-                        $this->reorderedInstances = $ids;
+                        $this->ids = $ids;
                     }
                 }
             );
         }
-    };
-
-    fakeListFor('person', $list);
+    });
 
     $this
         ->postJson(
@@ -51,52 +49,45 @@ public function reorder(array $ids): void
         )
         ->assertOk();
 
-    expect($list->reorderedInstances)->toEqual([3, 2, 1]);
+    expect($ids)->toEqual([3, 2, 1]);
 });
 
 it('allows to delete an instance in the entity list if delete method is implemented', function () {
-    $list = new class() extends PersonList
+    $deletedId = null;
+
+    fakeListFor('person', new class($deletedId) extends PersonList
     {
-        public ?int $deletedInstance = null;
+        public function __construct(public &$deletedId) {}
 
         public function delete($id): void
         {
-            $this->deletedInstance = $id;
+            $this->deletedId = $id;
         }
-    };
-
-    fakeListFor('person', $list);
-
-    $idToDelete = rand(1, 10);
+    });
 
-    $this->deleteJson(route('code16.sharp.api.list.delete', ['root', 'person', $idToDelete]))
+    $this->deleteJson(route('code16.sharp.api.list.delete', ['root', 'person', 1]))
         ->assertOk();
 
-    expect($list->deletedInstance)->toEqual($idToDelete);
+    expect($deletedId)->toEqual(1);
 });
 
 it('delegates deletion to the show page if it exists', function () {
-    $this->withoutExceptionHandling();
-
-    fakeListFor('person', new PersonList());
+    $deletedId = null;
 
-    $show = new class() extends PersonShow
+    fakeShowFor('person', new class($deletedId) extends PersonShow
     {
-        public ?int $deletedInstance = null;
+        public function __construct(public &$deletedId) {}
 
         public function delete($id): void
         {
-            $this->deletedInstance = $id;
+            $this->deletedId = $id;
         }
-    };
-    fakeShowFor('person', $show);
-
-    $idToDelete = rand(1, 10);
+    });
 
-    $this->deleteJson(route('code16.sharp.api.list.delete', ['root', 'person', $idToDelete]))
+    $this->deleteJson(route('code16.sharp.api.list.delete', ['root', 'person', 1]))
         ->assertOk();
 
-    expect($show->deletedInstance)->toEqual($idToDelete);
+    expect($deletedId)->toEqual(1);
 });
 
 it('checks if the entity list allows deletion', function () {