Merge pull request #3 from p-chess/improve-readme

garak · web-flow · commit cde2528c5d52 · 2025-01-05T11:32:52.000+01:00
🎨 improve Twig extension
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -6,44 +6,44 @@ on:
 
 jobs:
     phpstan:
-        runs-on: ubuntu-22.04
+        runs-on: ubuntu-24.04
         name: PHPStan
         steps:
             - name: Checkout
               uses: actions/checkout@v3
             - name: PHPStan
-              uses: docker://oskarstark/phpstan-ga
+              uses: docker://oskarstark/phpstan-ga:1.8.0
               env:
                   REQUIRE_DEV: true
               with:
                   args: analyse
     cs-fixer:
-        runs-on: ubuntu-22.04
+        runs-on: ubuntu-24.04
         name: PHP-CS-Fixer
         steps:
             - name: Checkout
               uses: actions/checkout@v3
             - name: Fix CS
               uses: docker://oskarstark/php-cs-fixer-ga
     tests:
-        runs-on: ubuntu-22.04
+        runs-on: ubuntu-24.04
         strategy:
             matrix:
                 php:
-                    - '8.0'
                     - '8.1'
                     - '8.2'
                     - '8.3'
+                    - '8.4'
                 include:
                     - description: 'Symfony 6.4'
-                      php: '8.0'
+                      php: '8.1'
                       composer_option: '--prefer-lowest'
                     - description: 'Symfony 6.4'
-                      php: '8.2'
-                      symfony: 6.4.*
-                    - description: 'Symfony 7.0'
                       php: '8.3'
-                      symfony: 7.0.*
+                      symfony: 6.4.*
+                    - description: 'Symfony 7.2'
+                      php: '8.4'
+                      symfony: 7.2.*
         name: PHP ${{ matrix.php }} tests (${{ matrix.description }})
         steps:
             - name: Checkout
diff --git a/README.md b/README.md
@@ -7,20 +7,20 @@ Run `composer require p-chess/chess-bundle`
 ## Configuration
 
 Create a service that extends `PChess\ChessBundle\HtmlOutput` and
-implements required methods.
-You probably want to inject Symfony's router service here, and use it
-to return required URLs.
+implement the required methods.
+You probably want to inject Symfony's router service here and use it
+to return the required URLs.
 Note that each route can be provided with an identifier for your game.
 
-Create a configuration file, and use a content like the following:
+Create a configuration file, and use content like the following:
 
 ```yaml
 # config/packages/chess.yaml
 chess:
     output_service: App\YourOutputService
 ```
 
-This is an example of how routes can be defined (using an "id" parameter as identifier):
+This is an example of how routes can be defined (using an "id" parameter as an identifier):
 
 ```yaml
 # config/routes.yaml
@@ -52,11 +52,11 @@ move_end:
 You can inject a service implementing `\PChess\ChessBundle\ChessProviderInterface` in your controller, then
 implement different actions, using provided `\PChess\Chess\Chess` object.
 
-In your template, you can use Twig function `chess_render(chess)` to render the board.
+In your template, you can use the Twig function `chess_render(chess)` to render the board.
 If you need to pass an identifier, use `chess_render(chess, identifier)` instead.
 
 The main service you can use is `\PChess\ChessBundle\SessionChessProvider`.
-This service allows you to keep chess games in session, providing following methods:
+This service allows you to keep chess games in session, providing the following methods:
 
 * `getChess($identifier, $fen)` to get main `\PChess\Chess\Chess` instance (as provided by interface)
 * `restart($identifier)` to restart the game
@@ -68,7 +68,7 @@ Using `$identifier` is not mandatory.
 
 ### Styling
 
-You can use provided `_board.scss` file to style the board:
+You can use the provided `_board.scss` file to style the board:
 
 `@import '~@p-chess/chess-bundle/scss/board';`
 
diff --git a/composer.json b/composer.json
@@ -19,18 +19,18 @@
         }
     ],
     "require": {
-        "php": "^8.0",
-        "p-chess/chess": "^0.4",
-        "symfony/config": "^5.4 || ^6.4 || ^7.0",
-        "symfony/dependency-injection": "^5.4 || ^6.4 || ^7.0",
-        "symfony/http-kernel": "^5.4 || ^6.4 || ^7.0",
-        "symfony/routing": "^5.4 || ^6.4 || ^7.0",
-        "twig/twig": "^3.0"
+        "php": "^8.1",
+        "p-chess/chess": "^0.6",
+        "symfony/config": "^6.4 || ^7.0",
+        "symfony/dependency-injection": "^6.4 || ^7.0",
+        "symfony/http-kernel": "^6.4 || ^7.0",
+        "symfony/routing": "^6.4 || ^7.0",
+        "twig/twig": "^3.18"
     },
     "require-dev": {
-        "dg/bypass-finals": "^1.3",
+        "dg/bypass-finals": "^1.6",
         "phpunit/phpunit": "^9.6",
-        "symfony/phpunit-bridge": "^7.0"
+        "symfony/phpunit-bridge": "^7.2"
     },
     "config": {
         "sort-packages": true
diff --git a/config/services.xml b/config/services.xml
@@ -11,8 +11,11 @@
         </service>
         <service id="PChess\ChessBundle\SimpleChessProvider"/>
         <service id="PChess\ChessBundle\Twig\ChessExtension">
-            <argument type="abstract" key="$output"/>
             <tag name="twig.extension"/>
         </service>
+        <service id="PChess\ChessBundle\Twig\ChessRuntime">
+            <argument type="abstract" key="$output"/>
+            <tag name="twig.runtime"/>
+        </service>
     </services>
 </container>
diff --git a/src/ChessProviderInterface.php b/src/ChessProviderInterface.php
@@ -6,5 +6,5 @@
 
 interface ChessProviderInterface
 {
-    public function getChess(mixed $identifier = null, string $fen = null): Chess;
+    public function getChess(mixed $identifier = null, ?string $fen = null): Chess;
 }
diff --git a/src/DependencyInjection/CompilerPass.php b/src/DependencyInjection/CompilerPass.php
@@ -2,7 +2,7 @@
 
 namespace PChess\ChessBundle\DependencyInjection;
 
-use PChess\ChessBundle\Twig\ChessExtension as TwigExtension;
+use PChess\ChessBundle\Twig\ChessRuntime;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
@@ -13,6 +13,6 @@ public function process(ContainerBuilder $container): void
         /** @var string $service */
         $service = $container->getParameter('chess.output_service');
         $output = $container->getDefinition($service);
-        $container->getDefinition(TwigExtension::class)->replaceArgument(0, $output);
+        $container->getDefinition(ChessRuntime::class)->replaceArgument(0, $output);
     }
 }
diff --git a/src/HtmlOutput.php b/src/HtmlOutput.php
@@ -18,7 +18,7 @@ abstract public function getCancelUrl(mixed $identifier = null): string;
 
     abstract public function getPromotionUrl(string $from, string $to, mixed $identifier = null): string;
 
-    public function generateLinks(Chess $chess, string $from = null, mixed $identifier = null): array
+    public function generateLinks(Chess $chess, ?string $from = null, mixed $identifier = null): array
     {
         $links = [];
         $allowedMoves = self::getAllowedMoves($chess, $from);
@@ -58,7 +58,7 @@ public function generateLinks(Chess $chess, string $from = null, mixed $identifi
     /**
      * @return array<string, array<int, string>>
      */
-    private static function getAllowedMoves(Chess $chess, string $from = null): array
+    private static function getAllowedMoves(Chess $chess, ?string $from = null): array
     {
         $moves = $chess->moves($from ? Board::SQUARES[$from] : null);
         $return = [];
diff --git a/src/Mover.php b/src/Mover.php
@@ -16,7 +16,7 @@ final class Mover
      *
      * @return array<string, array<int, string>>
      */
-    public static function getAllowedMoves(Chess $chess, string $from = null): array
+    public static function getAllowedMoves(Chess $chess, ?string $from = null): array
     {
         $moves = $chess->moves($from ? Board::SQUARES[$from] : null);
         $return = [];
diff --git a/src/SessionChessProvider.php b/src/SessionChessProvider.php
@@ -15,7 +15,7 @@ public function __construct(private RequestStack $requestStack, private string $
     {
     }
 
-    public function getChess(mixed $identifier = null, string $fen = null, History $history = null): Chess
+    public function getChess(mixed $identifier = null, ?string $fen = null, ?History $history = null): Chess
     {
         $name = $this->name.$identifier;
         $chess = $this->getSession()->has($name) ? $this->getSession()->get($name) : new Chess($fen, $history);
diff --git a/src/SimpleChessProvider.php b/src/SimpleChessProvider.php
@@ -6,7 +6,7 @@
 
 final class SimpleChessProvider implements ChessProviderInterface
 {
-    public function getChess(mixed $identifier = null, string $fen = null): Chess
+    public function getChess(mixed $identifier = null, ?string $fen = null): Chess
     {
         return new Chess($fen);
     }
diff --git a/src/Twig/ChessExtension.php b/src/Twig/ChessExtension.php
@@ -8,19 +8,13 @@
 
 final class ChessExtension extends AbstractExtension
 {
-    public function __construct(private HtmlOutput $output)
-    {
-    }
-
     /**
      * @codeCoverageIgnore
-     *
-     * @return array<int, TwigFunction>
      */
     public function getFunctions(): array
     {
         return [
-            new TwigFunction('chess_render', [$this->output, 'render'], ['is_safe' => ['html']]),
+            new TwigFunction('chess_render', [ChessRuntime::class, 'render'], ['is_safe' => ['html']]),
         ];
     }
 }
diff --git a/src/Twig/ChessRuntime.php b/src/Twig/ChessRuntime.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace PChess\ChessBundle\Twig;
+
+use PChess\Chess\Chess;
+use PChess\ChessBundle\HtmlOutput;
+use Twig\Extension\AbstractExtension;
+use Twig\TwigFunction;
+
+final class ChessRuntime extends AbstractExtension
+{
+    public function __construct(private HtmlOutput $output)
+    {
+    }
+
+    public function render(Chess $chess, ?string $from = null, mixed $identifier = null): string
+    {
+        return $this->output->render($chess, $from, $identifier);
+    }
+}
diff --git a/tests/DependencyInjection/CompilerPassTest.php b/tests/DependencyInjection/CompilerPassTest.php
@@ -3,7 +3,7 @@
 namespace PChess\ChessBundle\Tests\DependencyInjection;
 
 use PChess\ChessBundle\DependencyInjection\CompilerPass;
-use PChess\ChessBundle\Twig\ChessExtension;
+use PChess\ChessBundle\Twig\ChessRuntime;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
@@ -19,7 +19,7 @@ public function testProcess(): void
         $container = $this->createMock(ContainerBuilder::class);
         $container->expects(self::once())->method('getParameter')->with('chess.output_service')->willReturn('foo');
         $container->expects(self::at(1))->method('getDefinition')->with('foo')->willReturn($definition);
-        $container->expects(self::at(2))->method('getDefinition')->with(ChessExtension::class)->willReturn($definition);
+        $container->expects(self::at(2))->method('getDefinition')->with(ChessRuntime::class)->willReturn($definition);
         $pass = new CompilerPass();
         $pass->process($container);
     }
diff --git a/tests/Twig/ChessExtensionTest.php b/tests/Twig/ChessExtensionTest.php
@@ -2,16 +2,14 @@
 
 namespace PChess\ChessBundle\Tests\Twig;
 
-use PChess\ChessBundle\HtmlOutput;
 use PChess\ChessBundle\Twig\ChessExtension;
 use PHPUnit\Framework\TestCase;
 
 final class ChessExtensionTest extends TestCase
 {
     public function testFunctions(): void
     {
-        $output = $this->createMock(HtmlOutput::class);
-        $ext = new ChessExtension($output);
+        $ext = new ChessExtension();
         self::assertIsArray($ext->getFunctions());
     }
 }
diff --git a/tests/Twig/ChessRuntimeTest.php b/tests/Twig/ChessRuntimeTest.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace PChess\ChessBundle\Tests\Twig;
+
+use PChess\Chess\Chess;
+use PChess\ChessBundle\HtmlOutput;
+use PChess\ChessBundle\Twig\ChessRuntime;
+use PHPUnit\Framework\TestCase;
+
+final class ChessRuntimeTest extends TestCase
+{
+    public function testRender(): void
+    {
+        $output = $this->createMock(HtmlOutput::class);
+        $runtime = new ChessRuntime($output);
+        self::assertIsString($runtime->render(new Chess()));
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -6,5 +6,5 @@`
`6`	`6`
`7`	`7`	`interface ChessProviderInterface`
`8`	`8`	`{`
`9`		`- public function getChess(mixed $identifier = null, string $fen = null): Chess;`
	`9`	`+ public function getChess(mixed $identifier = null, ?string $fen = null): Chess;`
`10`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace PChess\ChessBundle\DependencyInjection;`
`4`	`4`
`5`		`-use PChess\ChessBundle\Twig\ChessExtension as TwigExtension;`
	`5`	`+use PChess\ChessBundle\Twig\ChessRuntime;`
`6`	`6`	`use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;`
`7`	`7`	`use Symfony\Component\DependencyInjection\ContainerBuilder;`
`8`	`8`
`@@ -13,6 +13,6 @@ public function process(ContainerBuilder $container): void`
`13`	`13`	`/** @var string $service */`
`14`	`14`	`$service = $container->getParameter('chess.output_service');`
`15`	`15`	`$output = $container->getDefinition($service);`
`16`		`- $container->getDefinition(TwigExtension::class)->replaceArgument(0, $output);`
	`16`	`+ $container->getDefinition(ChessRuntime::class)->replaceArgument(0, $output);`
`17`	`17`	`}`
`18`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ final class Mover`
`16`	`16`	`*`
`17`	`17`	`* @return array<string, array<int, string>>`
`18`	`18`	`*/`
`19`		`- public static function getAllowedMoves(Chess $chess, string $from = null): array`
	`19`	`+ public static function getAllowedMoves(Chess $chess, ?string $from = null): array`
`20`	`20`	`{`
`21`	`21`	`$moves = $chess->moves($from ? Board::SQUARES[$from] : null);`
`22`	`22`	`$return = [];`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public function __construct(private RequestStack $requestStack, private string $`
`15`	`15`	`{`
`16`	`16`	`}`
`17`	`17`
`18`		`- public function getChess(mixed $identifier = null, string $fen = null, History $history = null): Chess`
	`18`	`+ public function getChess(mixed $identifier = null, ?string $fen = null, ?History $history = null): Chess`
`19`	`19`	`{`
`20`	`20`	`$name = $this->name.$identifier;`
`21`	`21`	`$chess = $this->getSession()->has($name) ? $this->getSession()->get($name) : new Chess($fen, $history);`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`
`7`	`7`	`final class SimpleChessProvider implements ChessProviderInterface`
`8`	`8`	`{`
`9`		`- public function getChess(mixed $identifier = null, string $fen = null): Chess`
	`9`	`+ public function getChess(mixed $identifier = null, ?string $fen = null): Chess`
`10`	`10`	`{`
`11`	`11`	`return new Chess($fen);`
`12`	`12`	`}`