feat: add support for PHP 8 attributes and symfony 7

flix-tech · Jan 28, 2024 · 6da3e54 · 6da3e54
1 parent ffeab36
commit 6da3e54
Show file tree

Hide file tree

Showing 19 changed files with 533 additions and 20 deletions.
diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
@@ -27,18 +27,15 @@ jobs:
     strategy:
       matrix:
         php:
-          -
-            version: '7.4'
-            xdebug: '3.1.5'
-          -
-            version: '8.0'
-            xdebug: '3.1.5'
           -
             version: '8.1'
             xdebug: '3.1.5'
           -
             version: '8.2'
             xdebug: '3.2.1'
+          -
+            version: '8.3'
+            xdebug: '3.3.1'
     runs-on: ubuntu-20.04
     steps:
       -
@@ -81,26 +78,20 @@ jobs:
     strategy:
       matrix:
         php:
-          -
-            version: '7.4'
-            composer: --prefer-lowest
-          -
-            version: '8.0'
-            composer: --prefer-lowest
           -
             version: '8.1'
             composer: --prefer-lowest
           -
             version: '8.2'
             composer: --prefer-lowest
           -
-            version: '7.4'
-            composer: --prefer-stable
+            version: '8.3'
+            composer: --prefer-lowest
           -
-            version: '8.0'
+            version: '8.1'
             composer: --prefer-stable
           -
-            version: '8.1'
+            version: '8.2'
             composer: --prefer-stable
           -
             version: '8.2'

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Avro SerDe for PHP 7.3+ and 8.0
+# Avro SerDe for PHP 8.1+
 
 [![php-confluent-serde Actions Status](https://github.com/flix-tech/avro-serde-php/workflows/php-confluent-serde/badge.svg?branch=master)](https://github.com/flix-tech/avro-serde-php/actions)
 [![Maintainability](https://api.codeclimate.com/v1/badges/7500470a6812cf5a1ad5/maintainability)](https://codeclimate.com/github/flix-tech/avro-serde-php/maintainability)

diff --git a/composer.json b/composer.json
@@ -23,7 +23,7 @@
     }
   ],
   "require": {
-    "php": "^7.3|^8.0",
+    "php": "^8.1",
     "beberlei/assert": "^2.9.9|~3.0",
     "flix-tech/confluent-schema-registry-api": "^8.0",
     "guzzlehttp/promises": "^1.4.0|^2.0.0",
@@ -35,7 +35,7 @@
     "phpunit/phpunit": "^9.4.2",
     "phpbench/phpbench": "1.0.0-alpha2",
     "vlucas/phpdotenv": "~2.4",
-    "symfony/serializer": "^3.4|^4.3",
+    "symfony/serializer": "^6.4|^7.0",
     "doctrine/annotations": "^1.11"
   },
   "autoload": {

diff --git a/integrations/Symfony/Serializer/AvroSerDeEncoder.php b/integrations/Symfony/Serializer/AvroSerDeEncoder.php
@@ -32,7 +32,7 @@ public function __construct(RecordSerializer $recordSerializer)
      *
      * @throws \FlixTech\SchemaRegistryApi\Exception\SchemaRegistryException
      */
-    public function decode($data, $format, array $context = [])
+    public function decode(string $data, string $format, array $context = []): mixed
     {
         $readersSchema = $context[self::CONTEXT_DECODE_READERS_SCHEMA] ?? null;
         Assert::that($readersSchema)->nullOr()->isInstanceOf(\AvroSchema::class);

diff --git a/src/Objects/Schema/Generation/AttributeReader.php b/src/Objects/Schema/Generation/AttributeReader.php
@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FlixTech\AvroSerializer\Objects\Schema\Generation;
+
+class AttributeReader implements SchemaAttributeReader
+{
+    public function readClassAttributes(\ReflectionClass $class): SchemaAttributes
+    {
+        $attributes = $class->getAttributes();
+
+        return $this->getSchemaAttributes(...$attributes);
+    }
+
+    public function readPropertyAttributes(\ReflectionProperty $property): SchemaAttributes
+    {
+        $attributes = $property->getAttributes();
+
+        return $this->getSchemaAttributes(...$attributes);
+    }
+
+    private function getSchemaAttributes(\ReflectionAttribute ...$attributes): SchemaAttributes
+    {
+        $attributes = array_map(fn ($attr) => $attr->newInstance(), $attributes);
+        $attributes = array_filter($attributes, fn ($attr) => $attr instanceof SchemaAttribute);
+
+        return new SchemaAttributes(...$attributes);
+    }
+}
diff --git a/src/Objects/Schema/Generation/Attributes/AvroAliases.php b/src/Objects/Schema/Generation/Attributes/AvroAliases.php
@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FlixTech\AvroSerializer\Objects\Schema\Generation\Attributes;
+
+use FlixTech\AvroSerializer\Objects\Schema\AttributeName;
+use FlixTech\AvroSerializer\Objects\Schema\Generation\SchemaAttributes;
+use FlixTech\AvroSerializer\Objects\Schema\Generation\VariadicAttribute;
+
+#[\Attribute]
+final class AvroAliases implements VariadicAttribute
+{
+    /**
+     * @var array<string>
+     */
+    public array $aliases;
+
+    public function __construct(
+        string ...$aliases,
+    ) {
+        $this->aliases = $aliases;
+    }
+
+    public function name(): string
+    {
+        return AttributeName::ALIASES;
+    }
+
+    public function value(): array
+    {
+        return $this->aliases;
+    }
+
+    public function attributes(): SchemaAttributes
+    {
+        return new SchemaAttributes();
+    }
+}
diff --git a/src/Objects/Schema/Generation/Attributes/AvroDefault.php b/src/Objects/Schema/Generation/Attributes/AvroDefault.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FlixTech\AvroSerializer\Objects\Schema\Generation\Attributes;
+
+use FlixTech\AvroSerializer\Objects\Schema\AttributeName;
+use FlixTech\AvroSerializer\Objects\Schema\Generation\SchemaAttribute;
+use FlixTech\AvroSerializer\Objects\Schema\Generation\SchemaAttributes;
+
+#[\Attribute]
+final class AvroDefault implements SchemaAttribute
+{
+    public function __construct(
+        public mixed $value,
+    ) {
+    }
+
+    public function name(): string
+    {
+        return AttributeName::DEFAULT;
+    }
+
+    public function value(): mixed
+    {
+        return $this->value;
+    }
+
+    public function attributes(): SchemaAttributes
+    {
+        return new SchemaAttributes();
+    }
+}
diff --git a/src/Objects/Schema/Generation/Attributes/AvroDoc.php b/src/Objects/Schema/Generation/Attributes/AvroDoc.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FlixTech\AvroSerializer\Objects\Schema\Generation\Attributes;
+
+use FlixTech\AvroSerializer\Objects\Schema\AttributeName;
+use FlixTech\AvroSerializer\Objects\Schema\Generation\SchemaAttribute;
+use FlixTech\AvroSerializer\Objects\Schema\Generation\SchemaAttributes;
+
+#[\Attribute]
+final class AvroDoc implements SchemaAttribute
+{
+    public function __construct(
+        public string $value
+    ) {
+    }
+
+    public function name(): string
+    {
+        return AttributeName::DOC;
+    }
+
+    public function value(): string
+    {
+        return $this->value;
+    }
+
+    public function attributes(): SchemaAttributes
+    {
+        return new SchemaAttributes();
+    }
+}
diff --git a/src/Objects/Schema/Generation/Attributes/AvroItems.php b/src/Objects/Schema/Generation/Attributes/AvroItems.php
@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FlixTech\AvroSerializer\Objects\Schema\Generation\Attributes;
+
+use FlixTech\AvroSerializer\Objects\Schema\AttributeName;
+use FlixTech\AvroSerializer\Objects\Schema\Generation\SchemaAttributes;
+use FlixTech\AvroSerializer\Objects\Schema\Generation\TypeOnlyAttribute;
+
+#[\Attribute]
+final class AvroItems implements TypeOnlyAttribute
+{
+    /**
+     * @var AvroType[]
+     */
+    private array $types;
+
+    public function __construct(Type|AvroType ...$types)
+    {
+        $this->types = array_map(function ($type) {
+            if ($type instanceof AvroType) {
+                return $type;
+            }
+
+            return new AvroType($type);
+        }, $types);
+    }
+
+    /**
+     * @return AvroType[]
+     */
+    public function value(): array
+    {
+        return $this->types;
+    }
+
+    public function attributes(): SchemaAttributes
+    {
+        return new SchemaAttributes(...$this->value());
+    }
+
+    public function name(): string
+    {
+        return AttributeName::ITEMS;
+    }
+}
diff --git a/src/Objects/Schema/Generation/Attributes/AvroName.php b/src/Objects/Schema/Generation/Attributes/AvroName.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FlixTech\AvroSerializer\Objects\Schema\Generation\Attributes;
+
+use FlixTech\AvroSerializer\Objects\Schema\AttributeName;
+use FlixTech\AvroSerializer\Objects\Schema\Generation\SchemaAttribute;
+use FlixTech\AvroSerializer\Objects\Schema\Generation\SchemaAttributes;
+
+#[\Attribute]
+class AvroName implements SchemaAttribute
+{
+    public function __construct(
+        public string $value,
+    ) {
+    }
+
+    public function name(): string
+    {
+        return AttributeName::NAME;
+    }
+
+    public function value(): string
+    {
+        return $this->value;
+    }
+
+    public function attributes(): SchemaAttributes
+    {
+        return new SchemaAttributes();
+    }
+}
diff --git a/src/Objects/Schema/Generation/Attributes/AvroNamespace.php b/src/Objects/Schema/Generation/Attributes/AvroNamespace.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FlixTech\AvroSerializer\Objects\Schema\Generation\Attributes;
+
+use FlixTech\AvroSerializer\Objects\Schema\AttributeName;
+use FlixTech\AvroSerializer\Objects\Schema\Generation\SchemaAttribute;
+use FlixTech\AvroSerializer\Objects\Schema\Generation\SchemaAttributes;
+
+#[\Attribute]
+class AvroNamespace implements SchemaAttribute
+{
+    public function __construct(
+        public string $value,
+    ) {
+    }
+
+    public function name(): string
+    {
+        return AttributeName::NAMESPACE;
+    }
+
+    public function value(): string
+    {
+        return $this->value;
+    }
+
+    public function attributes(): SchemaAttributes
+    {
+        return new SchemaAttributes();
+    }
+}
diff --git a/src/Objects/Schema/Generation/Attributes/AvroOrder.php b/src/Objects/Schema/Generation/Attributes/AvroOrder.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FlixTech\AvroSerializer\Objects\Schema\Generation\Attributes;
+
+use FlixTech\AvroSerializer\Objects\Schema\AttributeName;
+use FlixTech\AvroSerializer\Objects\Schema\Generation\SchemaAttribute;
+use FlixTech\AvroSerializer\Objects\Schema\Generation\SchemaAttributes;
+
+#[\Attribute]
+final class AvroOrder implements SchemaAttribute
+{
+    public function __construct(
+        private Order $order,
+    ) {
+    }
+
+    public function name(): string
+    {
+        return AttributeName::ORDER;
+    }
+
+    public function value(): string
+    {
+        return $this->order->value;
+    }
+
+    public function attributes(): SchemaAttributes
+    {
+        return new SchemaAttributes();
+    }
+}