ci: setup PHPUnit, PHPStan, PHP CS Fixer and GitHub Actions workflow (#2)

Author: Ezar101

.gitattributes

@@ -12,3 +12,7 @@
 /yarn.lock         export-ignore
 /doc               export-ignore
 /.editorconfig     export-ignore
+/tests             export-ignore
+/phpunit.xml.dist  export-ignore
+/phpstan.neon.dist export-ignore
+/phpstan-baseline.neon export-ignore

.github/workflows/ci.yaml

@@ -0,0 +1,55 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  tests:
+    name: PHP ${{ matrix.php }}
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        php: ['8.4']
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: mbstring, xml, ctype, iconv, intl, pdo_sqlite
+          coverage: none
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache composer dependencies
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install dependencies
+        run: composer update --prefer-dist --no-progress
+
+      - name: Initialize PHPUnit Bridge
+        run: vendor/bin/simple-phpunit -v
+
+      - name: Run PHP CS Fixer (Code Style)
+        if: matrix.php == '8.4'
+        run: composer cs:check
+
+      - name: Run PHPStan (Static Analysis)
+        run: composer stan
+
+      - name: Run PHPUnit (Tests)
+        run: composer tests

.gitignore

@@ -1,6 +1,9 @@
 composer.lock
 var
 vendor/*
+.phpunit.result.cache
+/phpunit.xml
+.php-cs-fixer.cache
 
 /node_modules/
 npm-debug.log

.php-cs-fixer.dist.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__ . '/src')
+    ->in(__DIR__ . '/tests')
+    ->append([__FILE__])
+    ->ignoreDotFiles(true)
+    ->ignoreVCS(true)
+    ->files()
+    ->name('*.php');
+
+return new PhpCsFixer\Config()
+    ->setParallelConfig(PhpCsFixer\Runner\Parallel\ParallelConfigFactory::detect())
+    ->setRules([
+        '@Symfony' => true,
+        '@Symfony:risky' => true,
+        '@PHP84Migration' => true,
+        'declare_strict_types' => true,
+        'global_namespace_import' => [
+            'import_classes' => true,
+            'import_constants' => true,
+            'import_functions' => true,
+        ],
+        'yoda_style' => false, // Disable the Yoda style (e.g., if (null === $var)) if you prefer the classic style (if ($var === null)).
+        'concat_space' => ['spacing' => 'one'], // Adds a space around the concatenation points
+    ])
+    ->setUsingCache(true)
+    ->setRiskyAllowed(true)
+    ->setFinder($finder)
+    ->setCacheFile(__DIR__ . '/var/cache/.php-cs-fixer.cache'); // Put the cache away neatly.

README.md

@@ -4,6 +4,7 @@
     <a href="https://packagist.org/packages/ezar101/easyadmin-trix-extension-bundle"><img src="https://poser.pugx.org/ezar101/easyadmin-trix-extension-bundle/v" alt="Latest Stable Version"></a>
     <a href="https://packagist.org/packages/ezar101/easyadmin-trix-extension-bundle"><img src="https://poser.pugx.org/ezar101/easyadmin-trix-extension-bundle/downloads" alt="Total Downloads"></a>
     <a href="LICENSE"><img src="https://poser.pugx.org/ezar101/easyadmin-trix-extension-bundle/license" alt="License"></a>
+    <a href="https://github.com/Ezar101/EasyAdminTrixExtensionBundle/actions/workflows/ci.yaml"><img src="https://github.com/Ezar101/EasyAdminTrixExtensionBundle/actions/workflows/ci.yaml/badge.svg" alt="CI"></a>
 </p>
 
 This Symfony bundle extends the native capabilities of EasyAdmin's `TextEditorField` (based on Trix). It offers an enhanced writing experience by adding essential features that are missing by default, all without any complex front-end configuration.

composer.json

@@ -25,17 +25,42 @@
     "symfony/framework-bundle": "^6.0|^7.0|^8.0",
     "easycorp/easyadmin-bundle": "^4.0|^5.0"
   },
+  "require-dev": {
+    "friendsofphp/php-cs-fixer": "^3.94",
+    "phpstan/extension-installer": "^1.4",
+    "phpstan/phpstan": "^2.0",
+    "phpstan/phpstan-phpunit": "^2.0",
+    "phpstan/phpstan-strict-rules": "^2.0",
+    "symfony/phpunit-bridge": "^6.4.26|^7.0|^8.0"
+  },
   "autoload": {
     "psr-4": {
       "Ezar101\\EasyAdminTrixExtensionBundle\\": "src/"
     }
   },
+  "autoload-dev": {
+    "psr-4": {
+      "Ezar101\\EasyAdminTrixExtensionBundle\\Tests\\": "tests/"
+    }
+  },
   "config": {
     "sort-packages": true,
     "allow-plugins": {
+      "phpstan/extension-installer": true,
       "symfony/flex": true,
       "symfony/runtime": false
     }
   },
+  "scripts": {
+    "tests": "simple-phpunit",
+    "cs:check": "php-cs-fixer fix --dry-run --diff",
+    "cs:fix": "php-cs-fixer fix",
+    "stan": "phpstan analyse",
+    "qa": [
+      "@cs:check",
+      "@stan",
+      "@tests"
+    ]
+  },
   "minimum-stability": "stable"
 }

phpstan.neon.dist

@@ -0,0 +1,21 @@
+parameters:
+    level: 6
+    phpVersion: 80400
+    paths:
+        - src/
+        - tests/
+
+    excludePaths:
+        - vendor/
+
+    bootstrapFiles:
+        - vendor/bin/.phpunit/phpunit/vendor/autoload.php
+
+    ignoreErrors:
+        -
+            identifier: missingType.generics
+
+    treatPhpDocTypesAsCertain: false
+    reportUnmatchedIgnoredErrors: false
+
+    tmpDir: var/cache/phpstan

phpunit.xml.dist

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- https://phpunit.de/manual/current/en/appendixes.configuration.html -->
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="vendor/bin/.phpunit/phpunit.xsd"
+         colors="true"
+         bootstrap="tests/bootstrap.php">
+
+    <php>
+        <ini name="display_errors" value="1" />
+        <ini name="error_reporting" value="-1" />
+        <server name="APP_ENV" value="test" force="true" />
+        <server name="APP_DEBUG" value="true" force="true" />
+        <server name="SHELL_VERBOSITY" value="-1" />
+    </php>
+
+    <testsuites>
+        <testsuite name="EasyAdmin Trix Extension Unit Test Suite">
+            <directory>tests/</directory>
+        </testsuite>
+    </testsuites>
+
+    <coverage processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+    </coverage>
+</phpunit>

src/Config/Asset.php

@@ -4,8 +4,13 @@
 
 namespace Ezar101\EasyAdminTrixExtensionBundle\Config;
 
+use JsonException;
+
+use const JSON_THROW_ON_ERROR;
+
 final class Asset
 {
+    /** @var array<string, string>|null */
     private static ?array $manifest = null;
 
     private function __construct()
@@ -20,8 +25,8 @@ public static function from(string $filename): string
             if (file_exists($path)) {
                 try {
                     $content = file_get_contents($path);
-                    self::$manifest = json_decode($content, true, 512, JSON_THROW_ON_ERROR) ?: [];
-                } catch (\JsonException $e) {
+                    self::$manifest = json_decode($content, true, 512, JSON_THROW_ON_ERROR) ?? [];
+                } catch (JsonException $e) {
                     self::$manifest = [];
                 }
             } else {

src/Field/ExtendedTextEditorField.php

@@ -4,21 +4,24 @@
 
 namespace Ezar101\EasyAdminTrixExtensionBundle\Field;
 
+use EasyCorp\Bundle\EasyAdminBundle\Config\Asset as EasyAdminAsset;
 use EasyCorp\Bundle\EasyAdminBundle\Contracts\Field\FieldInterface;
 use EasyCorp\Bundle\EasyAdminBundle\Field\FieldTrait;
 use EasyCorp\Bundle\EasyAdminBundle\Field\TextEditorField;
 use EasyCorp\Bundle\EasyAdminBundle\Form\Type\TextEditorType;
 use Ezar101\EasyAdminTrixExtensionBundle\Config\Asset;
+use InvalidArgumentException;
 use Symfony\Contracts\Translation\TranslatableInterface;
-use EasyCorp\Bundle\EasyAdminBundle\Config\Asset as EasyAdminAsset;
+
+use function sprintf;
 
 final class ExtendedTextEditorField implements FieldInterface
 {
     use FieldTrait;
 
     public static function new(string $propertyName, TranslatableInterface|bool|string|null $label = null): self
     {
-        return (new self)
+        return new self()
             ->setProperty($propertyName)
             ->setLabel($label)
             ->setTemplateName('crud/field/text_editor')
@@ -41,7 +44,7 @@ public static function new(string $propertyName, TranslatableInterface|bool|stri
     public function setNumOfRows(int $rows): self
     {
         if ($rows < 1) {
-            throw new \InvalidArgumentException(sprintf('The argument of the "%s()" method must be 1 or higher (%d given).', __METHOD__, $rows));
+            throw new InvalidArgumentException(sprintf('The argument of the "%s()" method must be 1 or higher (%d given).', __METHOD__, $rows));
         }
 
         $this->setCustomOption(TextEditorField::OPTION_NUM_OF_ROWS, $rows);
@@ -51,6 +54,7 @@ public function setNumOfRows(int $rows): self
 
     /**
      * @param array<string, mixed> $config
+     *
      * @see TextEditorField::setTrixEditorConfig()
      */
     public function setTrixEditorConfig(array $config): self