Merge branch 'release/v0.7.0'

.github/workflows/integrate.yml

@@ -19,7 +19,7 @@ jobs:
       - name: "Set up PHP"
         uses: "shivammathur/setup-php@v2"
         with:
-          php-version: "8.1"
+          php-version: "8.4"
           extensions: "${{ env.PHP_EXTENSIONS }}"
           ini-values: "post_max_size=256M"
 
@@ -60,9 +60,7 @@ jobs:
     strategy:
       matrix:
         php-version:
-          - "8.1"
-          - "8.2"
-          - "8.3"
+          - "8.4"
     steps:
       - name: "Set up PHP"
         uses: "shivammathur/setup-php@v2"
@@ -101,7 +99,7 @@ jobs:
       - name: "Set up PHP"
         uses: "shivammathur/setup-php@v2"
         with:
-          php-version: "8.1"
+          php-version: "8.4"
           extensions: "${{ env.PHP_EXTENSIONS }}"
           ini-values: "post_max_size=256M"
 

.gitignore

@@ -5,3 +5,5 @@ composer.lock
 Thumbs.db
 /phpunit.xml
 /.idea
+
+effigy.json

CHANGELOG.md

@@ -1,3 +1,13 @@
+## v0.7.0 (2024-02-17)
+* Added @phpstan-require-implements constraints
+* Upgraded PHPStan to v2
+* Updated dependencies
+* Made Macros const part of MacroHandler interface
+* Tidied boolean logic
+* Fixed Exceptional syntax
+* Added PHP8.4 to CI workflow
+* Made PHP8.4 minimum version
+
 ## v0.6.0 (2024-08-21)
 * Converted consts to protected PascalCase
 * Updated dependency versions

composer.json

@@ -9,16 +9,16 @@
             "email": "tom@inflatablecookie.com"
         } ],
     "require": {
-        "php": "^8.1",
-        "symfony/polyfill-mbstring": "^1.7",
+        "php": "^8.4",
+        "symfony/polyfill-mbstring": "^1.31",
 
-        "decodelabs/archetype": "^0.3",
-        "decodelabs/coercion": "^0.2",
-        "decodelabs/exceptional": "^0.4",
-        "decodelabs/tagged": "^0.15"
+        "decodelabs/archetype": "^0.3.8",
+        "decodelabs/coercion": "^0.2.15",
+        "decodelabs/exceptional": "^0.5.3",
+        "decodelabs/tagged": "^0.16"
     },
     "require-dev": {
-        "decodelabs/phpstan-decodelabs": "^0.6",
+        "decodelabs/phpstan-decodelabs": "^0.7",
 
         "soundasleep/html2text": "^1.1|^2",
         "erusev/parsedown": "^1.7",
@@ -34,9 +34,31 @@
             "DecodeLabs\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "DecodeLabs\\Metamorph\\Tests\\": "tests/"
+        }
+    },
     "extra": {
         "branch-alias": {
-            "dev-develop": "0.6.x-dev"
+            "dev-develop": "0.7.x-dev"
+        },
+        "effigy": {
+            "exports": [
+                "phpstan-extension.neon"
+            ]
+        },
+        "phpstan": {
+            "includes": [
+                "phpstan-extension.neon"
+            ]
         }
+    },
+    "config": {
+        "allow-plugins": {
+            "phpstan/extension-installer": true
+        }
+    },
+    "repositories": {
     }
 }

phpstan-extension.neon

@@ -0,0 +1,5 @@
+services:
+    -
+        class: DecodeLabs\PHPStan\MetamorphReflectionExtension
+        tags:
+            - phpstan.broker.methodsClassReflectionExtension

phpstan.neon

@@ -1,3 +1,6 @@
+includes:
+    - ./phpstan-extension.neon
+
 parameters:
     paths:
         - src/

src/Metamorph/Handler/HtmlToText.php

@@ -22,7 +22,7 @@ class HtmlToText implements MacroHandler
 {
     use MacroHandlerTrait;
 
-    protected const Macros = [
+    public const array Macros = [
         'wrap' => [
             'wrap' => true
         ],
@@ -40,7 +40,7 @@ class HtmlToText implements MacroHandler
     /**
      * Set options
      *
-     * @param array<string, mixed> $options
+     * @param array<string,mixed> $options
      */
     public function __construct(
         array $options

src/Metamorph/Handler/Markdown.php

@@ -14,18 +14,16 @@
 use DecodeLabs\Metamorph\MacroHandler;
 use DecodeLabs\Metamorph\MacroHandlerTrait;
 use DecodeLabs\Tagged\Buffer;
-
 use Michelf\Markdown as MarkdownLib;
 use Parsedown;
-
 use Stringable;
 
 class Markdown implements MacroHandler
 {
     use MacroHandlerTrait;
     use HtmlTrait;
 
-    protected const Macros = [
+    public const array Macros = [
         'safe' => [
             'safe' => true
         ],
@@ -44,7 +42,7 @@ class Markdown implements MacroHandler
     /**
      * Set options
      *
-     * @param array<string, mixed> $options
+     * @param array<string,mixed> $options
      */
     public function __construct(
         array $options
@@ -75,7 +73,7 @@ class_exists(MarkdownLib::class)
         }
 
         throw Exceptional::ComponentUnavailable(
-            'No supported Markdown processors could be found for the requested format - try installing Parsedown'
+            message: 'No supported Markdown processors could be found for the requested format - try installing Parsedown'
         );
     }
 
@@ -94,9 +92,9 @@ protected function convertParsedown(
         }
 
         if ($this->inline) {
-            $output = $parser->line($content);
+            $output = Coercion::toString($parser->line($content));
         } else {
-            $output = $parser->text($content);
+            $output = Coercion::toString($parser->text($content));
         }
 
         $output = $this->resolveHtmlUrls($output);

src/Metamorph/Handler/Text.php

@@ -21,7 +21,7 @@ class Text implements MacroHandler
 {
     use MacroHandlerTrait;
 
-    protected const Macros = [
+    public const array Macros = [
         'raw' => [
             'wrap' => false
         ],
@@ -42,7 +42,7 @@ class Text implements MacroHandler
     /**
      * Set options
      *
-     * @param array<string, mixed> $options
+     * @param array<string,mixed> $options
      */
     public function __construct(
         array $options

src/Metamorph/MacroHandler.php

@@ -11,10 +11,15 @@
 
 interface MacroHandler extends Handler
 {
+    /**
+     * @var array<string,array<string,mixed>>
+     */
+    public const array Macros = [];
+
     /**
      * Load macro options
      *
-     * @return array<string, mixed>|null
+     * @return array<string,mixed>|null
      */
     public static function loadMacro(
         string $name

src/Metamorph/MacroHandlerTrait.php

@@ -9,25 +9,19 @@
 
 namespace DecodeLabs\Metamorph;
 
+/**
+ * @phpstan-require-implements MacroHandler
+ */
 trait MacroHandlerTrait
 {
-    //protected const Macros = [];
-
     /**
      * Load macro options
      *
-     * @return array<string, mixed>|null
+     * @return ?array<string,mixed>
      */
     public static function loadMacro(
         string $name
     ): ?array {
-        if (
-            !isset(static::Macros[$name]) ||
-            !is_array(static::Macros[$name])
-        ) {
-            return null;
-        }
-
         return static::Macros[$name];
     }
 }

src/PHPStan/MetamorphReflectionExtension.php

@@ -0,0 +1,54 @@
+<?php
+
+/**
+ * @package PHPStanDecodeLabs
+ * @license http://opensource.org/licenses/MIT
+ */
+
+declare(strict_types=1);
+
+namespace DecodeLabs\PHPStan;
+
+use DecodeLabs\Metamorph;
+use DecodeLabs\PHPStan\MethodReflection;
+use PHPStan\Reflection\ClassReflection;
+use PHPStan\Reflection\FunctionVariant;
+use PHPStan\Reflection\MethodReflection as MethodReflectionInterface;
+use PHPStan\Reflection\MethodsClassReflectionExtension;
+use PHPStan\Reflection\ReflectionProvider;
+
+class MetamorphReflectionExtension implements MethodsClassReflectionExtension
+{
+    protected ReflectionProvider $reflectionProvider;
+
+    public function __construct(
+        ReflectionProvider $reflectionProvider
+    ) {
+        $this->reflectionProvider = $reflectionProvider;
+    }
+
+    public function hasMethod(
+        ClassReflection $classReflection,
+        string $methodName
+    ): bool {
+        return $classReflection->getName() === Metamorph::class;
+    }
+
+    public function getMethod(
+        ClassReflection $classReflection,
+        string $methodName
+    ): MethodReflectionInterface {
+        $method = $this->reflectionProvider->getClass(Metamorph::class)->getNativeMethod('convert');
+
+        /** @var FunctionVariant $variant */
+        $variant = $method->getVariants()[0];
+        $params = array_slice($variant->getParameters(), 1);
+
+        $newVariant = MethodReflection::alterVariant($variant, $params);
+
+        $output = new MethodReflection($classReflection, $methodName, [$newVariant]);
+        $output->setStatic(true);
+
+        return $output;
+    }
+}

tests/AnalyzeFactoryCall.php

@@ -0,0 +1,23 @@
+<?php
+
+/**
+ * @package Metamorph
+ * @license http://opensource.org/licenses/MIT
+ */
+
+declare(strict_types=1);
+
+namespace DecodeLabs\Metamorph\Tests;
+
+use DecodeLabs\Metamorph;
+use Stringable;
+
+class AnalyzeFactoryCall {
+
+    public function render(): string|Stringable {
+        return Metamorph::{'markdown.safe'}('Hello World');
+    }
+}
+
+$obj = new AnalyzeFactoryCall();
+$obj->render();