Merge pull request #18 from markhuot/craft5

WIP Craft 5 Compat

.github/workflows/docs.yml

@@ -16,6 +16,10 @@ jobs:
         with:
           ref: ${{ github.head_ref }}
 
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.3'
+
       - name: Validate composer.json and composer.lock
         run: composer validate --strict
 

.github/workflows/php.yml

@@ -15,7 +15,15 @@ jobs:
 
     strategy:
       matrix:
-        version: [~4.5.0, ~4.6.0]
+        version: 
+          - constraint: ~4.5.0
+            config: 4
+          - constraint: ~4.6.0
+            config: 4
+          - constraint:  ~4.7.0
+            config: 4
+          - constraint: ~5.0.0
+            config: 5
 
     env:
       CRAFT_APP_ID: pest
@@ -37,7 +45,7 @@ jobs:
 
     services:
       mysql:
-        image: mysql
+        image: mysql:8
         env:
           MYSQL_ROOT_PASSWORD: root
           MYSQL_DATABASE: pest
@@ -54,7 +62,7 @@ jobs:
 
     - uses: shivammathur/setup-php@v2
       with:
-        php-version: '8.2'
+        php-version: '8.3'
 
     - name: Validate composer.json and composer.lock
       run: composer validate --strict
@@ -66,18 +74,19 @@ jobs:
         path: |
           composer.lock
           vendor
-        key: ${{ runner.os }}-craft-vendor-${{ hashFiles('composer.json') }}
+        key: ${{ runner.os }}-craft-${{ matrix.version.constraint }}-vendor-${{ hashFiles('composer.json') }}
 
     - name: Install dependencies
       run: |
-        composer require "craftcms/cms:${{ matrix.version }}" --prefer-dist --no-progress
+        composer require "craftcms/cms:${{ matrix.version.constraint }}" --prefer-dist --no-progress
         ./bin/post-clone.sh
 
     - name: Copy config files
       run: |
         mkdir -p ./storage
-        cp -r ./stubs/config ./
-        cat config/app.php
+        cp -r ./stubs/config/app.php ./config/app.php
+        cp -r ./stubs/config/general.php ./config/general.php
+        cp -r ./stubs/config/project-${{ matrix.version.config }}/ ./config/project/
 
     - name: Wait for MySQL
       run: until mysqladmin ping -h 127.0.0.1 -u root -proot; do sleep 1; done
@@ -90,6 +99,8 @@ jobs:
 
     - name: Run pint
       run: ./vendor/bin/pint --test -vvv src/
+      if: always()
 
     - name: Run test suite
       run: ./vendor/bin/pest --compact -vvv
+      if: always()

.gitignore

@@ -3,6 +3,7 @@
 .idea
 cpresources
 /src/bin/index.php
+.phpunit.cache
 .phpunit.result.cache
 /config
 .env
@@ -24,4 +25,4 @@ node_modules
 /templates
 /node_modules
 /.env.example
-/cpresources
+/cpresources

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

@@ -15,11 +15,12 @@
         "symfony/css-selector": "^5.3|^6.0",
         "symfony/dom-crawler": "^6.0.3",
         "symfony/process": "^5.3|^6.0",
-        "illuminate/collections": "^8.23|^9.1|^10.0",
-        "pestphp/pest": "^2.26",
+        "pestphp/pest": "^3.0",
         "vlucas/phpdotenv": "^2.4|^3.4|^5.4",
-        "craftcms/cms": "^4.5",
-        "illuminate/support": "^9.52"
+        "craftcms/cms": "^4.5|^5.0.0-beta.1",
+        "illuminate/support": "^9.52|^10.0|^11.0",
+        "composer/composer": "^2.7",
+        "composer/semver": "^3.4"
     },
     "autoload": {
         "psr-4": {
@@ -54,7 +55,7 @@
     "prefer-stable": true,
     "require-dev": {
         "craftcms/phpstan": "dev-main",
-        "craftcms/craft": "^4.0",
+        "craftcms/craft": "^4.0.0|^5.0.0-alpha.1",
         "symfony/var-dumper": "^5.0|^6.0",
         "laravel/pint": "^1.13"
     }

docs/factories/entry.md

@@ -12,7 +12,7 @@ in three ways,
 
 If you do not pass a section, one will be created automatically.
 
-## type($handle)
+## type($identifier)
 Set the entry type
 
 ## postDate(DateTime|string|int $value)

phpstan-craft4.neon

@@ -0,0 +1,5 @@
+parameters:
+    excludePaths:
+        - src/actions/RenderCraft5CompiledClasses.php
+        - src/factories/EntryType.php
+        - src/factories/MatrixFieldEntries.php

phpstan-craft5.neon

@@ -0,0 +1,6 @@
+parameters:
+    excludePaths:
+        - src/actions/RenderCraft4CompiledClasses.php
+        - src/factories/AddsMatrixBlocks.php
+        - src/factories/BlockType.php
+        - src/factories/MatrixFieldBlocks.php

phpstan.neon

@@ -1,5 +1,6 @@
 includes:
     - vendor/craftcms/phpstan/phpstan.neon
+    - phpstan.php
 
 parameters:
     paths:
@@ -15,3 +16,4 @@ parameters:
     excludePaths:
       - src/craft/*
       - src/illuminate/*
+      - src/actions/RenderCompiledClasses.php

phpstan.php

@@ -0,0 +1,16 @@
+<?php
+
+use Composer\InstalledVersions;
+use Composer\Semver\VersionParser;
+
+$config = [];
+
+if (InstalledVersions::satisfies(new VersionParser, 'craftcms/cms', '~4.0')) {
+    $config['includes'][] = 'phpstan-craft4.neon';
+}
+
+if (InstalledVersions::satisfies(new VersionParser, 'craftcms/cms', '~5.0')) {
+    $config['includes'][] = 'phpstan-craft5.neon';
+}
+
+return $config;

phpunit.xml

@@ -1,5 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.2/phpunit.xsd" bootstrap="vendor/autoload.php" colors="true" cacheDirectory=".phpunit.cache">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.2/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         cacheDirectory=".phpunit.cache"
+         beStrictAboutOutputDuringTests="false"
+  >
   <testsuites>
     <testsuite name="Test Suite">
       <directory suffix="Test.php">./tests</directory>

src/Pest.php

@@ -2,16 +2,21 @@
 
 namespace markhuot\craftpest;
 
+use Composer\Semver\Semver;
 use Craft;
 use craft\base\Field;
 use craft\elements\db\ElementQuery;
 use craft\elements\Entry;
 use craft\events\DefineBehaviorsEvent;
+use markhuot\craftpest\actions\RenderCraft4CompiledClasses;
+use markhuot\craftpest\actions\RenderCraft5CompiledClasses;
 use markhuot\craftpest\behaviors\ExpectableBehavior;
 use markhuot\craftpest\behaviors\FieldTypeHintBehavior;
 use markhuot\craftpest\behaviors\TestableElementBehavior;
 use markhuot\craftpest\behaviors\TestableElementQueryBehavior;
 use markhuot\craftpest\console\PestController;
+use markhuot\craftpest\interfaces\RenderCompiledClassesInterface;
+use markhuot\craftpest\interfaces\SectionsServiceInterface;
 use yii\base\BootstrapInterface;
 use yii\base\Event;
 
@@ -52,5 +57,17 @@ function (DefineBehaviorsEvent $event) {
                 $event->behaviors['fieldTypeHintBehavior'] = FieldTypeHintBehavior::class;
             }
         );
+
+        Craft::$container->set(SectionsServiceInterface::class, function () {
+            return Semver::satisfies(Craft::$app->version, '~5.0')
+                ? Craft::$app->getEntries() // @phpstan-ignore-line
+                : Craft::$app->getSections(); // @phpstan-ignore-line
+        });
+
+        Craft::$container->set(RenderCompiledClassesInterface::class, function () {
+            return Semver::satisfies(Craft::$app->version, '~5.0')
+                ? Craft::$container->get(RenderCraft5CompiledClasses::class) // @phpstan-ignore-line
+                : Craft::$container->get(RenderCraft4CompiledClasses::class); // @phpstan-ignore-line
+        });
     }
 }

src/actions/RenderCompiledClasses.php → src/actions/RenderCraft4CompiledClasses.php

@@ -5,10 +5,11 @@
 use craft\db\Table;
 use craft\helpers\FileHelper;
 use craft\helpers\StringHelper;
+use markhuot\craftpest\interfaces\RenderCompiledClassesInterface;
 
-class RenderCompiledClasses
+class RenderCraft4CompiledClasses implements RenderCompiledClassesInterface
 {
-    public function handle($forceRecreate = false)
+    public function handle(bool $forceRecreate = false)
     {
         $contentService = \Craft::$app->getContent();
         $originalContentTable = $contentService->contentTable;

src/actions/RenderCraft5CompiledClasses.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace markhuot\craftpest\actions;
+
+use craft\helpers\FileHelper;
+use craft\helpers\StringHelper;
+use markhuot\craftpest\interfaces\RenderCompiledClassesInterface;
+
+class RenderCraft5CompiledClasses implements RenderCompiledClassesInterface
+{
+    public function handle(bool $forceRecreate = false)
+    {
+        $this->render($forceRecreate);
+
+        return true;
+    }
+
+    protected function render(bool $forceRecreate)
+    {
+        $storedFieldVersion = \Craft::$app->getFields()->getFieldVersion();
+        $compiledClassesPath = \Craft::$app->getPath()->getCompiledClassesPath();
+        $fieldVersionExists = $storedFieldVersion !== null;
+        if (! $fieldVersionExists) {
+            $storedFieldVersion = StringHelper::randomString(12);
+        }
+
+        $compiledClassPath = $compiledClassesPath.DIRECTORY_SEPARATOR.'FactoryFields_'.$storedFieldVersion.'.php';
+
+        if (file_exists($compiledClassPath) && ! $forceRecreate) {
+            return false;
+        }
+
+        $this->cleanupOldMixins('FactoryFields_'.$storedFieldVersion.'.php');
+
+        $template = file_get_contents(__DIR__.'/../../stubs/compiled_classes/FactoryFields.twig');
+
+        $compiledClass = \Craft::$app->view->renderString($template, [
+            'fields' => \Craft::$app->fields->getAllFields(),
+        ]);
+
+        file_put_contents($compiledClassPath, $compiledClass);
+    }
+
+    protected function cleanupOldMixins(?string $except = null)
+    {
+        $compiledClassesPath = __DIR__.'/../storage/';
+
+        FileHelper::clearDirectory($compiledClassesPath, [
+            'filter' => function (string $path) use ($except): bool {
+                $b = basename($path);
+
+                return
+                    str_starts_with($b, 'FactoryFields') &&
+                    ($except === null || $b !== $except);
+            },
+        ]);
+    }
+}

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);
     }