chore: move RamseyUuid bridge to its own component (api-platform#5580)

Author: PierreRebeilleau

.github/workflows/ci.yml

@@ -193,6 +193,7 @@ jobs:
           - OpenApi
           - Metadata
           - Elasticsearch
+          - RamseyUuid
       fail-fast: false
     steps:
       - name: Checkout

src/Api/UriVariableTransformerInterface.php

@@ -13,27 +13,6 @@
 
 namespace ApiPlatform\Api;
 
-use ApiPlatform\Exception\InvalidUriVariableException;
-
-interface UriVariableTransformerInterface
+interface UriVariableTransformerInterface extends \ApiPlatform\Metadata\UriVariableTransformerInterface
 {
-    /**
-     * Transforms the value of a URI variable (identifier) to its type.
-     *
-     * @param mixed $value   The URI variable value to transform
-     * @param array $types   The guessed type behind the URI variable
-     * @param array $context Options available to the transformer
-     *
-     * @throws InvalidUriVariableException Occurs when the URI variable could not be transformed
-     */
-    public function transform(mixed $value, array $types, array $context = []);
-
-    /**
-     * Checks whether the value of a URI variable can be transformed to its type by this transformer.
-     *
-     * @param mixed $value   The URI variable value to transform
-     * @param array $types   The types to which the URI variable value should be transformed
-     * @param array $context Options available to the transformer
-     */
-    public function supportsTransformation(mixed $value, array $types, array $context = []): bool;
 }

src/Exception/InvalidUriVariableException.php

@@ -17,7 +17,9 @@
  * Identifier is not valid exception.
  *
  * @author Antoine Bluchet <[email protected]>
+ *
+ * @final
  */
-final class InvalidUriVariableException extends \Exception implements ExceptionInterface
+class InvalidUriVariableException extends \Exception implements ExceptionInterface
 {
 }

src/Metadata/Exception/InvalidUriVariableException.php

@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Metadata\Exception;
+
+use ApiPlatform\Exception\InvalidUriVariableException as LegacyInvalidUriVariableException;
+
+if (class_exists(LegacyInvalidUriVariableException::class)) {
+    class InvalidUriVariableException extends LegacyInvalidUriVariableException
+    {
+    }
+} else {
+    /**
+     * Identifier is not valid exception.
+     *
+     * @author Antoine Bluchet <[email protected]>
+     */
+    final class InvalidUriVariableException extends \Exception implements ExceptionInterface
+    {
+    }
+}

src/Metadata/UriVariableTransformerInterface.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Metadata;
+
+use ApiPlatform\Exception\InvalidUriVariableException;
+
+interface UriVariableTransformerInterface
+{
+    /**
+     * Transforms the value of a URI variable (identifier) to its type.
+     *
+     * @param mixed $value   The URI variable value to transform
+     * @param array $types   The guessed type behind the URI variable
+     * @param array $context Options available to the transformer
+     *
+     * @throws InvalidUriVariableException Occurs when the URI variable could not be transformed
+     */
+    public function transform(mixed $value, array $types, array $context = []);
+
+    /**
+     * Checks whether the value of a URI variable can be transformed to its type by this transformer.
+     *
+     * @param mixed $value   The URI variable value to transform
+     * @param array $types   The types to which the URI variable value should be transformed
+     * @param array $context Options available to the transformer
+     */
+    public function supportsTransformation(mixed $value, array $types, array $context = []): bool;
+}

src/RamseyUuid/.gitignore

@@ -0,0 +1,3 @@
+/composer.lock
+/vendor
+/.phpunit.result.cache

src/RamseyUuid/LICENSE

@@ -0,0 +1,21 @@
+The MIT license
+
+Copyright (c) 2015-present Kévin Dunglas
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

src/RamseyUuid/README.md

@@ -0,0 +1,3 @@
+# API Platform - RamseyUuid
+
+RamseyUuid component from API Platform

tests/RamseyUuid/Serializer/UuidDenormalizerTest.php renamed to src/RamseyUuid/Tests/Serializer/UuidDenormalizerTest.php

@@ -13,7 +13,7 @@
 
 namespace ApiPlatform\Tests\RamseyUuid\UriVariableTransformer;
 
-use ApiPlatform\Exception\InvalidUriVariableException;
+use ApiPlatform\Metadata\Exception\InvalidUriVariableException;
 use ApiPlatform\RamseyUuid\UriVariableTransformer\UuidUriVariableTransformer;
 use PHPUnit\Framework\TestCase;
 use Ramsey\Uuid\Uuid;