Merge branch 'craft5' into patch-1

bin/create-default-fs.php

@@ -22,7 +22,7 @@
 
 $volume = $app->volumes->getVolumeByHandle('local');
 if (! $volume) {
-    $volume = new \craft\models\Volume();
+    $volume = new \craft\models\Volume;
     $volume->name = 'Local';
     $volume->handle = 'local';
     $volume->fs = $fs;

composer.json

@@ -31,6 +31,7 @@
             "src/helpers/Craft.php",
             "src/helpers/Http.php",
             "src/helpers/Model.php",
+            "src/helpers/Queue.php",
             "src/helpers/Test.php"
         ]
     },

src/bin/generate-docs.php

@@ -59,7 +59,7 @@ function parseClass(string $className)
 function parseComment(string $comment)
 {
     preg_match_all('/@see\s+(.+)$/m', $comment, $sees);
-    foreach (($sees[1] ?? []) as $index => $otherClass) {
+    foreach ($sees[1] as $index => $otherClass) {
         $comment = str_replace($sees[0][$index], 'SEE['.$otherClass.']', $comment);
     }
 
@@ -71,7 +71,7 @@ function parseComment(string $comment)
     $comment = preg_replace('/(^\s+|\s+$)/', '', $comment);
 
     preg_match_all('/^SEE\[(.+)\]$/m', $comment, $sees);
-    foreach (($sees[1] ?? []) as $index => $otherClass) {
+    foreach ($sees[1] as $index => $otherClass) {
         $comment = str_replace($sees[0][$index], "\n\n".implode("\n\n", parseClass($otherClass))."\n\n", $comment);
     }
 

src/console/TestableResponse.php

@@ -10,8 +10,7 @@ public function __construct(
         protected int $exitCode,
         protected string $stdout,
         protected string $stderr,
-    ) {
-    }
+    ) {}
 
     public function assertSuccesful()
     {

src/events/RollbackTransactionEvent.php

@@ -4,6 +4,4 @@
 
 use yii\base\Event;
 
-class RollbackTransactionEvent extends Event
-{
-}
+class RollbackTransactionEvent extends Event {}

src/exceptions/AutoCommittingFieldsException.php

@@ -2,6 +2,4 @@
 
 namespace markhuot\craftpest\exceptions;
 
-class AutoCommittingFieldsException extends \Exception
-{
-}
+class AutoCommittingFieldsException extends \Exception {}

src/factories/Asset.php

@@ -78,7 +78,7 @@ public function source(string $source)
 
     public function newElement()
     {
-        return new \craft\elements\Asset();
+        return new \craft\elements\Asset;
     }
 
     public function definition(int $index = 0)

src/factories/BlockType.php

@@ -33,7 +33,7 @@ public function inferences(array $definition = [])
 
     public function newElement()
     {
-        return new MatrixBlockType();
+        return new MatrixBlockType;
     }
 
     public function store($blockType)

src/factories/Category.php

@@ -22,7 +22,7 @@ public function group($handle)
 
     public function newElement()
     {
-        return new \craft\elements\Category();
+        return new \craft\elements\Category;
     }
 
     public function definition(int $index = 0)

src/factories/Entry.php

@@ -187,7 +187,7 @@ public function inferTypeId(?int $sectionid): ?int
      */
     public function newElement()
     {
-        return new \craft\elements\Entry();
+        return new \craft\elements\Entry;
     }
 
     /**

src/factories/EntryType.php

@@ -35,7 +35,7 @@ public function inferences(array $definition = [])
 
     public function newElement()
     {
-        return new EntryTypeModel();
+        return new EntryTypeModel;
     }
 
     public function store($entryType)

src/factories/Fieldable.php

@@ -55,7 +55,7 @@ public function storeFields(FieldLayout $fieldLayout, $context = null)
             ->toArray();
 
         if (empty($fieldLayout->getTabs()[0])) {
-            $fieldLayoutTab = new FieldLayoutTab();
+            $fieldLayoutTab = new FieldLayoutTab;
             $fieldLayoutTab->name = 'Content';
             $fieldLayoutTab->sortOrder = 1;
             $fieldLayout->setTabs([$fieldLayoutTab]);

src/factories/Section.php

@@ -66,7 +66,7 @@ public function template(string $template)
      */
     public function newElement()
     {
-        return new \craft\models\Section();
+        return new \craft\models\Section;
     }
 
     /**
@@ -94,7 +94,7 @@ public function inferences(array $definition = [])
         $handle = $definition['handle'];
         $definition['siteSettings'] = collect(Craft::$app->sites->getAllSites())
             ->mapWithkeys(function ($site) use ($name, $handle) {
-                $settings = new Section_SiteSettings();
+                $settings = new Section_SiteSettings;
                 $settings->siteId = $site->id;
                 $settings->hasUrls = $this->hasUrls;
                 $settings->uriFormat = $this->uriFormat;

src/helpers/Craft.php

@@ -80,7 +80,7 @@ function createVolume()
     function volumeDefinition(array $definition = [])
     {
         if (version_greater_than_or_equal_to(\Craft::$app->version, '4')) {
-            $fileSystem = new \craft\fs\Local();                                                                  // @phpstan-ignore-line
+            $fileSystem = new \craft\fs\Local;                                                                  // @phpstan-ignore-line
             $fileSystem->name = $definition['name'].' FS';                                                      // @phpstan-ignore-line
             $fileSystem->handle = $definition['handle'].'Fs';                                                   // @phpstan-ignore-line
             $fileSystem->path = \Craft::getAlias('@storage').'/volumes/'.$definition['handle'].'/';    // @phpstan-ignore-line

src/helpers/Queue.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace markhuot\craftpest\helpers\queue;
+
+use Craft;
+
+if (! function_exists('queue')) {
+    function queue($callback = null): mixed
+    {
+        $result = null;
+
+        if ($callback) {
+            $result = $callback();
+        }
+
+        Craft::$app->queue->run();
+
+        return $result;
+    }
+}

src/http/requests/GetRequest.php

@@ -2,6 +2,4 @@
 
 namespace markhuot\craftpest\http\requests;
 
-class GetRequest extends WebRequest
-{
-}
+class GetRequest extends WebRequest {}

src/http/requests/PostRequest.php

@@ -2,6 +2,4 @@
 
 namespace markhuot\craftpest\http\requests;
 
-class PostRequest extends WebRequest
-{
-}
+class PostRequest extends WebRequest {}

src/overrides/Config.php

@@ -2,6 +2,4 @@
 
 namespace markhuot\craftpest\overrides;
 
-class Config extends \craft\services\Config
-{
-}
+class Config extends \craft\services\Config {}

src/overrides/ProjectConfig.php

@@ -2,6 +2,4 @@
 
 namespace markhuot\craftpest\overrides;
 
-class ProjectConfig extends \craft\services\Config
-{
-}
+class ProjectConfig extends \craft\services\Config {}

src/pest/PhpReporter.php

@@ -2,6 +2,4 @@
 
 namespace markhuot\craftpest\pest;
 
-class PhpReporter extends Reporter
-{
-}
+class PhpReporter extends Reporter {}

src/test/CleanupRequestState.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace markhuot\craftpest\test;
+
+use Craft;
+use markhuot\craftpest\web\Application;
+
+trait CleanupRequestState
+{
+    /**
+     * Cleanup any request state that may be left over from previous tests.
+     *
+     * This is normally cleaned up (and run) after a request goes through Craft's router.
+     * However, if a test isn't interacting with the route and is just calling actions or
+     * running queues then the after request callbacks won't be cleared.
+     */
+    public function tearDownCleanupRequestState(): void
+    {
+        $app = Craft::$app;
+
+        if ($app instanceof Application) {
+            $reflect = new \ReflectionClass($app);
+            while ($reflect && ! $reflect->hasProperty('afterRequestCallbacks')) {
+                $reflect = $reflect->getParentClass();
+            }
+
+            if ($reflect) {
+                $property = $reflect->getProperty('afterRequestCallbacks');
+                $property->setValue($app, []);
+            }
+        }
+    }
+}

src/test/DatabaseAssertions.php

@@ -22,7 +22,7 @@ trait DatabaseAssertions
      */
     public function assertDatabaseCount(string $tableName, int $expectedCount)
     {
-        $actualCount = (new Query())->from($tableName)->count();
+        $actualCount = (new Query)->from($tableName)->count();
 
         $this->assertEquals($expectedCount, $actualCount);
     }

src/test/RefreshesDatabase.php

@@ -129,7 +129,7 @@ public function rollBackTransaction()
 
         $this->transaction->rollBack();
 
-        $event = new RollbackTransactionEvent();
+        $event = new RollbackTransactionEvent;
         $event->sender = $this;
         Event::trigger(RefreshesDatabase::class, 'EVENT_ROLLBACK_TRANSACTION', $event);
 

src/test/TestCase.php

@@ -14,6 +14,7 @@ class TestCase extends \PHPUnit\Framework\TestCase
 {
     use ActingAs,
         Benchmark,
+        CleanupRequestState,
         CookieState,
         DatabaseAssertions,
         Dd,

src/web/BenchmarkResult.php

@@ -29,8 +29,7 @@ class BenchmarkResult
     public function __construct(
         public int $startProfileAt,
         public int $endProfileAt,
-    ) {
-    }
+    ) {}
 
     // function summary()
     // {

tests/RequestStateTest.php

@@ -0,0 +1,17 @@
+<?php
+
+test('sets request state', function () {
+    Craft::$app->onAfterRequest(fn () => throw new Exception('An after request callback was not cleared.'));
+
+    expect(true)->toBeTrue();
+});
+
+test('expects request state to be empty', function () {
+    $app = Craft::$app;
+    $reflect = new ReflectionClass($app);
+    while ($reflect && ! $reflect->hasProperty('afterRequestCallbacks')) {
+        $reflect = $reflect->getParentClass();
+    }
+
+    expect($reflect->getProperty('afterRequestCallbacks')->getValue($app))->toBeEmpty();
+})->depends('sets request state');