Merge branch hotfix/v2.6.22

Author: roadiz-ci

.github/workflows/run-test.yml

@@ -19,7 +19,7 @@ jobs:
         runs-on: ubuntu-latest
         strategy:
             matrix:
-                php-version: ['8.1', '8.2', '8.3']
+                php-version: ['8.3', '8.4']
         steps:
             - uses: shivammathur/setup-php@v2
               with:
@@ -35,7 +35,5 @@ jobs:
                       ${{ runner.os }}-php-${{ matrix.php-version }}-
             - name: Install Dependencies
               run: composer install --no-scripts --no-ansi --no-interaction --no-progress
-            - name: Run PHP Code Sniffer
-              run: vendor/bin/phpcs --extensions=php --warning-severity=0 --standard=PSR12 -p ./src
             - name: Run PHPStan
               run: vendor/bin/phpstan analyse --no-progress -c phpstan.neon

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright © 2024 Ambroise Maupate
+Copyright © 2025 Ambroise Maupate
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

Makefile

@@ -3,15 +3,15 @@
     "description": "Markdown services and Twig extension for Roadiz",
     "type": "library",
     "require": {
-        "php": ">=8.1",
-        "league/commonmark": "^2.2.0",
-        "twig/twig": "^3.1",
+        "php": ">=8.3",
         "doctrine/collections": ">=1.6",
-        "symfony/stopwatch": "6.4.*"
+        "league/commonmark": "^2.2.0",
+        "symfony/stopwatch": "7.3.*",
+        "twig/twig": "^3.21"
     },
     "require-dev": {
-        "squizlabs/php_codesniffer": "^3.5",
-        "phpstan/phpstan": "^1.5.3"
+        "phpstan/phpstan": "^1.5.3",
+        "phpstan/phpdoc-parser": "<2"
     },
     "license": "MIT",
     "authors": [
@@ -29,8 +29,8 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "2.3.x-dev",
-            "dev-develop": "2.4.x-dev"
+            "dev-master": "2.6.x-dev",
+            "dev-develop": "2.7.x-dev"
         }
     }
 }

composer.json

@@ -7,46 +7,52 @@
 use League\CommonMark\MarkdownConverter;
 use Symfony\Component\Stopwatch\Stopwatch;
 
-final class CommonMark implements MarkdownInterface
+final readonly class CommonMark implements MarkdownInterface
 {
     public function __construct(
-        private readonly MarkdownConverter $textConverter,
-        private readonly MarkdownConverter $textExtraConverter,
-        private readonly MarkdownConverter $lineConverter,
-        private readonly ?Stopwatch $stopwatch = null
+        private MarkdownConverter $textConverter,
+        private MarkdownConverter $textExtraConverter,
+        private MarkdownConverter $lineConverter,
+        private ?Stopwatch $stopwatch = null,
     ) {
     }
 
-    public function text(string $markdown = null): string
+    #[\Override]
+    public function text(?string $markdown = null): string
     {
         if (null === $markdown) {
             return '';
         }
-        $this->stopwatch?->start(CommonMark::class . '::text');
+        $this->stopwatch?->start(CommonMark::class.'::text');
         $html = $this->textConverter->convert($markdown)->getContent();
-        $this->stopwatch?->stop(CommonMark::class . '::text');
+        $this->stopwatch?->stop(CommonMark::class.'::text');
+
         return $html;
     }
 
-    public function textExtra(string $markdown = null): string
+    #[\Override]
+    public function textExtra(?string $markdown = null): string
     {
         if (null === $markdown) {
             return '';
         }
-        $this->stopwatch?->start(CommonMark::class . '::textExtra');
+        $this->stopwatch?->start(CommonMark::class.'::textExtra');
         $html = $this->textExtraConverter->convert($markdown)->getContent();
-        $this->stopwatch?->stop(CommonMark::class . '::textExtra');
+        $this->stopwatch?->stop(CommonMark::class.'::textExtra');
+
         return $html;
     }
 
-    public function line(string $markdown = null): string
+    #[\Override]
+    public function line(?string $markdown = null): string
     {
         if (null === $markdown) {
             return '';
         }
-        $this->stopwatch?->start(CommonMark::class . '::line');
+        $this->stopwatch?->start(CommonMark::class.'::line');
         $html = $this->lineConverter->convert($markdown)->getContent();
-        $this->stopwatch?->stop(CommonMark::class . '::line');
+        $this->stopwatch?->stop(CommonMark::class.'::line');
+
         return $html;
     }
 }

phpcs.xml.dist

@@ -8,28 +8,16 @@ interface MarkdownInterface
 {
     /**
      * Convert Markdown to HTML using standard Markdown syntax.
-     *
-     * @param string|null $markdown
-     *
-     * @return string
      */
-    public function text(string $markdown = null): string;
+    public function text(?string $markdown = null): string;
 
     /**
      * Convert Markdown to HTML using standard Markdown Extra syntax.
-     *
-     * @param string|null $markdown
-     *
-     * @return string
      */
-    public function textExtra(string $markdown = null): string;
+    public function textExtra(?string $markdown = null): string;
 
     /**
      * Convert Markdown to HTML using only inline HTML elements.
-     *
-     * @param string|null $markdown
-     *
-     * @return string
      */
-    public function line(string $markdown = null): string;
+    public function line(?string $markdown = null): string;
 }

src/CommonMark.php

@@ -14,53 +14,42 @@ public function __construct(private readonly MarkdownInterface $markdown)
     {
     }
 
+    #[\Override]
     public function getFilters(): array
     {
         return [
-            new TwigFilter('markdown', [$this, 'markdown'], ['is_safe' => ['html']]),
-            new TwigFilter('inlineMarkdown', [$this, 'inlineMarkdown'], ['is_safe' => ['html']]),
-            new TwigFilter('inline_markdown', [$this, 'inlineMarkdown'], ['is_safe' => ['html']]),
-            new TwigFilter('markdownExtra', [$this, 'markdownExtra'], ['is_safe' => ['html']]),
-            new TwigFilter('markdown_extra', [$this, 'markdownExtra'], ['is_safe' => ['html']]),
+            new TwigFilter('markdown', $this->markdown(...), ['is_safe' => ['html']]),
+            new TwigFilter('inlineMarkdown', $this->inlineMarkdown(...), ['is_safe' => ['html']]),
+            new TwigFilter('inline_markdown', $this->inlineMarkdown(...), ['is_safe' => ['html']]),
+            new TwigFilter('markdownExtra', $this->markdownExtra(...), ['is_safe' => ['html']]),
+            new TwigFilter('markdown_extra', $this->markdownExtra(...), ['is_safe' => ['html']]),
         ];
     }
 
-    /**
-     * @param string|null $input
-     *
-     * @return string
-     */
     public function markdown(?string $input): string
     {
         if (null === $input) {
             return '';
         }
+
         return $this->markdown->text($input);
     }
 
-    /**
-     * @param string|null $input
-     *
-     * @return string
-     */
     public function inlineMarkdown(?string $input): string
     {
         if (null === $input) {
             return '';
         }
+
         return $this->markdown->line($input);
     }
 
-    /**
-     * @param string|null $input
-     *
-     * @return string
-     */
     public function markdownExtra(?string $input): string
     {
         if (null === $input) {
             return '';
         }
+
         return $this->markdown->textExtra($input);
     }
 }