Update to PHP 8.4

.github/workflows/ci.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php-versions: ['7.4', '8.0']
+        php-versions: ['8.2', '8.3', '8.4']
     name: PHP ${{ matrix.php-versions }}
     steps:
       - uses: actions/checkout@v2
@@ -22,7 +22,7 @@ jobs:
 
       - name: Cache Composer packages
         id: composer-cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: vendor
           key: composer-${{ hashFiles('**/composer.json') }}

composer.json

@@ -12,11 +12,11 @@
         }
     },
     "require": {
-        "php": "^7.4|^8.0",
-        "symfony/yaml": "^4.0|^5.0|^6.0|^7.0",
+        "php": "^8.2||^8.3||^8.4",
+        "symfony/yaml": "^7.0",
         "league/commonmark": "^2.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.0"
+        "phpunit/phpunit": "^11.0"
     }
 }

phpunit.xml.dist

@@ -2,15 +2,18 @@
 <!--
     phpunit -c phpunit.xml
 -->
-<phpunit backupGlobals="false"
-         backupStaticAttributes="false"
-         colors="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnFailure="false"
-         bootstrap="vendor/autoload.php">
+<phpunit 
+    bootstrap="vendor/autoload.php" 
+    executionOrder="depends,defects" 
+    beStrictAboutOutputDuringTests="true" 
+    failOnDeprecation="true"
+    failOnRisky="true" 
+    failOnWarning="true" 
+    colors="true" 
+    testdox="false"
+    cacheDirectory=".phpunit.cache" 
+    displayDetailsOnTestsThatTriggerDeprecations="true"
+    beStrictAboutCoverageMetadata="true">
 
     <testsuites>
         <testsuite name="Tests">

src/Bridge/CommonMark/CommonMarkParser.php

@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace Mni\FrontYAML\Bridge\CommonMark;
 
@@ -9,17 +11,17 @@
 /**
  * Bridge to the League CommonMark parser
  */
-class CommonMarkParser implements MarkdownParser
+final class CommonMarkParser implements MarkdownParser
 {
     private MarkdownConverterInterface $parser;
 
-    public function __construct(MarkdownConverterInterface $commonMarkConverter = null)
+    public function __construct(MarkdownConverterInterface|null $commonMarkConverter = null)
     {
-        $this->parser = $commonMarkConverter ?: new CommonMarkConverter;
+        $this->parser = $commonMarkConverter ?: new CommonMarkConverter();
     }
 
     public function parse(string $markdown): string
     {
-        return $this->parser->convertToHtml($markdown)->getContent();
+        return $this->parser?->convertToHtml($markdown)?->getContent() ?? '';
     }
 }

src/Bridge/Symfony/SymfonyYAMLParser.php

@@ -8,16 +8,16 @@
 /**
  * Bridge to the Symfony YAML parser
  */
-class SymfonyYAMLParser implements YAMLParser
+final class SymfonyYAMLParser implements YAMLParser
 {
     private Parser $parser;
 
     public function __construct()
     {
-        $this->parser = new Parser;
+        $this->parser = new Parser();
     }
 
-    public function parse(string $yaml)
+    public function parse(string $yaml): mixed
     {
         return $this->parser->parse($yaml);
     }

src/Document.php

@@ -2,18 +2,17 @@
 
 namespace Mni\FrontYAML;
 
-class Document
+final class Document
 {
-    /** @var mixed */
-    private $yaml;
+    private mixed $yaml;
 
     private string $content;
 
     /**
      * @param mixed $yaml YAML content.
      * @param string $content Content of the document.
      */
-    public function __construct($yaml, string $content)
+    public function __construct(mixed $yaml, string $content)
     {
         $this->yaml = $yaml;
         $this->content = $content;
@@ -22,7 +21,7 @@ public function __construct($yaml, string $content)
     /**
      * @return mixed YAML content.
      */
-    public function getYAML()
+    public function getYAML(): mixed
     {
         return $this->yaml;
     }

src/Parser.php

@@ -7,39 +7,37 @@
 use Mni\FrontYAML\Markdown\MarkdownParser;
 use Mni\FrontYAML\YAML\YAMLParser;
 
+use function array_filter;
+use function array_map;
+use function implode;
+use function ltrim;
+use function preg_match;
+use function preg_quote;
+use function trim;
+
 /**
  * YAML Front matter parser
  */
-class Parser
+final class Parser
 {
-    /**
-     * @var YAMLParser
-     */
-    private $yamlParser;
+    private YAMLParser $yamlParser;
 
-    /**
-     * @var MarkdownParser
-     */
-    private $markdownParser;
+    private MarkdownParser $markdownParser;
 
     private array $startSep;
 
     private array $endSep;
 
-    /**
-     * @param string|string[] $startSep
-     * @param string|string[] $endSep
-     */
     public function __construct(
-        ?YAMLParser $yamlParser = null,
-        ?MarkdownParser $markdownParser = null,
-        $startSep = '---',
-        $endSep = '---'
+        YAMLParser|null $yamlParser = null,
+        MarkdownParser|null $markdownParser = null,
+        string|array $startSep = '---',
+        string|array $endSep = '---'
     ) {
-        $this->yamlParser = $yamlParser ?: new SymfonyYAMLParser;
-        $this->markdownParser = $markdownParser ?: new CommonMarkParser;
-        $this->startSep = array_filter((array) $startSep, 'is_string') ?: ['---'];
-        $this->endSep = array_filter((array) $endSep, 'is_string') ?: ['---'];
+        $this->yamlParser     = $yamlParser ?? new SymfonyYAMLParser();
+        $this->markdownParser = $markdownParser ?? new CommonMarkParser();
+        $this->startSep       = array_filter((array) $startSep, 'is_string') ?: ['---'];
+        $this->endSep         = array_filter((array) $endSep, 'is_string') ?: ['---'];
     }
 
     /**
@@ -51,7 +49,7 @@ public function parse(string $str, bool $parseMarkdown = true): Document
     {
         $yaml = null;
 
-        $quote = static function ($str) {
+        $quote = static function (string $str): string {
             return preg_quote($str, "~");
         };
 

src/YAML/YAMLParser.php

@@ -9,8 +9,6 @@ interface YAMLParser
 {
     /**
      * Parses a YAML string.
-     *
-     * @return mixed
      */
-    public function parse(string $yaml);
+    public function parse(string $yaml): mixed;
 }

tests/Bridge/CommonMark/CommonMarkParserTest.php

@@ -10,7 +10,7 @@
 
 class CommonMarkParserTest extends TestCase
 {
-    public function testParseWithDefaultParser()
+    public function testParseWithDefaultParser(): void
     {
         $parser = new CommonMarkParser();
 
@@ -19,10 +19,10 @@ public function testParseWithDefaultParser()
         $this->assertSame("<h1>This is a title</h1>\n", $html);
     }
 
-    public function testParseWithCustomParser()
+    public function testParseWithCustomParser(): void
     {
-        $environment = new Environment;
-        $environment->addExtension(new CommonMarkCoreExtension);
+        $environment = new Environment();
+        $environment->addExtension(new CommonMarkCoreExtension());
         $converter = new MarkdownConverter($environment);
 
         $parser = new CommonMarkParser($converter);

tests/FunctionalTest.php

@@ -5,11 +5,13 @@
 use Mni\FrontYAML\Parser;
 use PHPUnit\Framework\TestCase;
 
-class FunctionalTest extends TestCase
+use function str_replace;
+
+final class FunctionalTest extends TestCase
 {
-    public function testSimpleDocument()
+    public function testSimpleDocument(): void
     {
-        $parser = new Parser;
+        $parser = new Parser();
 
         $str = <<<EOF
 ---
@@ -23,9 +25,9 @@ public function testSimpleDocument()
         $this->assertSame("<p>This <strong>strong</strong></p>\n", $document->getContent());
     }
 
-    public function testEscaping()
+    public function testEscaping(): void
     {
-        $parser = new Parser;
+        $parser = new Parser();
 
         $str = <<<EOF
 ---
@@ -52,10 +54,10 @@ public function testEscaping()
         $this->assertSame("<p>Foo</p>\n", $document->getContent());
     }
 
-    public function testMultilineMarkdown()
+    public function testMultilineMarkdown(): void
     {
-        $parser = new Parser;
-        $str = <<<EOF
+        $parser   = new Parser();
+        $str      = <<<EOF
 Foo
 
 Bar
@@ -69,9 +71,9 @@ public function testMultilineMarkdown()
         $this->assertEquals($this->normalizeEOL($expected), $this->normalizeEOL($document->getContent()));
     }
 
-    public function testCrossOsMultiline()
+    public function testCrossOsMultiline(): void
     {
-        $parser = new Parser;
+        $parser  = new Parser();
         $content = <<<EOF
 ---
 lorem: ipsum
@@ -105,10 +107,10 @@ public function testCrossOsMultiline()
         $this->assertSame($this->normalizeEOL($expectedHtml), $this->normalizeEOL($dosYaml['multiline']));
     }
 
-    public function testNonGreedySeparator()
+    public function testNonGreedySeparator(): void
     {
-        $parser = new Parser;
-        $content = <<<EOF
+        $parser   = new Parser();
+        $content  = <<<EOF
 ---
 lorem: ipsum
 ---
@@ -117,10 +119,10 @@ public function testNonGreedySeparator()
 Ipsum
 EOF;
         $document = $parser->parse($content);
-        $this->assertSame(array('lorem' => 'ipsum'), $document->getYAML());
+        $this->assertSame(['lorem' => 'ipsum'], $document->getYAML());
     }
 
-    private function normalizeEOL($str)
+    private function normalizeEOL(string $str): string|array
     {
         return str_replace("\r", '', $str);
     }