feat(metadata): Resource Collection

Author: soyuka

.github/workflows/ci.yml

@@ -247,17 +247,27 @@ jobs:
         if: (startsWith(matrix.php, '8.0'))
         run: rm -Rf tests/Fixtures/app/var/cache/*
       - name: Run Behat tests
+        if: (!startsWith(matrix.php, '8.0'))
         run: |
           mkdir -p build/logs/behat
           if [ "$COVERAGE" = '1' ]; then
-            vendor/bin/behat --out=std --format=progress --format=junit --out=build/logs/behat/junit --profile=default-coverage --no-interaction
+            vendor/bin/behat --out=std --format=progress --format=junit --out=build/logs/behat/junit --profile=default-coverage --no-interaction --tags='~@php8'
           else
             if [ "${{ matrix.php }}" = '7.1' ]; then
-              vendor/bin/behat --out=std --format=progress --format=junit --out=build/logs/behat/junit --profile=default --no-interaction --tags='~@symfony/uid'
+              vendor/bin/behat --out=std --format=progress --format=junit --out=build/logs/behat/junit --profile=default --no-interaction --tags='~@symfony/uid&&~@php8'
             else
-              vendor/bin/behat --out=std --format=progress --format=junit --out=build/logs/behat/junit --profile=default --no-interaction
+              vendor/bin/behat --out=std --format=progress --format=junit --out=build/logs/behat/junit --profile=default --no-interaction --tags='~@php8'
             fi
           fi
+      - name: Run Behat tests
+        if: (startsWith(matrix.php, '8.0'))
+        run: |
+          mkdir -p build/logs/behat
+          if [ "$COVERAGE" = '1' ]; then
+            vendor/bin/behat --out=std --format=progress --format=junit --out=build/logs/behat/junit --profile=default-coverage --no-interaction
+          else
+            vendor/bin/behat --out=std --format=progress --format=junit --out=build/logs/behat/junit --profile=default --no-interaction
+          fi
       - name: Merge code coverage reports
         if: matrix.coverage
         run: |
@@ -389,7 +399,7 @@ jobs:
         run: tests/Fixtures/app/console cache:clear --ansi
       - name: Run Behat tests
         # @TODO remove the tag "@symfony/uid" in 3.0
-        run: vendor/bin/behat --out=std --format=progress --profile=default --no-interaction --tags='~@symfony/uid'
+        run: vendor/bin/behat --out=std --format=progress --profile=default --no-interaction --tags='~@symfony/uid&&~php8'
 
   postgresql:
     name: Behat (PHP ${{ matrix.php }}) (PostgreSQL)
@@ -440,7 +450,7 @@ jobs:
         run: tests/Fixtures/app/console cache:clear --ansi
       - name: Run Behat tests
         run: | 
-          vendor/bin/behat --out=std --format=progress --profile=postgres --no-interaction -vv
+          vendor/bin/behat --out=std --format=progress --profile=postgres --no-interaction -vv --tags='~php8'
 
   mysql:
     name: Behat (PHP ${{ matrix.php }}) (MySQL)
@@ -500,7 +510,7 @@ jobs:
     strategy:
       matrix:
         php:
-          - '7.4'
+          - '8'
       fail-fast: false
     env:
       APP_ENV: mongodb
@@ -711,7 +721,7 @@ jobs:
         php:
           - '8.0'
         symfony:
-          - '5.4'
+          - '5.3'
       fail-fast: false
     steps:
       - name: Checkout
@@ -858,5 +868,10 @@ jobs:
       - name: Clear test app cache
         run: tests/Fixtures/app/console cache:clear --ansi
       - name: Run Behat tests
-        run: vendor/bin/behat --out=std --format=progress --profile=default --no-interaction
+        run: |
+            if ( "${{ matrix.php }}" -eq '7.4' ) {
+                vendor/bin/behat --out=std --format=progress --profile=default --no-interaction --tags='~@php8'
+            } else {
+                vendor/bin/behat --out=std --format=progress --profile=default --no-interaction 
+            }
 

.php-cs-fixer.dist.php

@@ -14,7 +14,7 @@
 $finder = PhpCsFixer\Finder::create()
     ->in(__DIR__)
     ->exclude([
-        'src/Bridge/Symfony/Maker/Resources/skeleton',
+        'src/Core/Bridge/Symfony/Maker/Resources/skeleton',
         'tests/Fixtures/app/var',
     ])
     ->notPath('src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php')

docs/adr/0002-resource-definition.md

@@ -24,8 +24,7 @@ In API Platform, this resource identifier is also named [IRI (Internationalized
 ```php
 <?php
 
-#[Get]
-#[Post]
+#[Resource]
 class Users
 {
     #[ApiProperty(iri="hydra:member")]
@@ -34,9 +33,11 @@ class Users
     public float $averageRate;
 }
 
-#[Get]
-#[Put]
-#[Delete]
+#[Resource("/companies/{companyId}/users/{id}", normalization_context=["groups"= [....]]), operations={}]
+#[Resource(normalization_context=["groups"= [....]], operations=[
+ new Get(),
+ new Post(),
+])]
 class User
 {
     #[ApiProperty(identifier=true)]

features/main/attribute_resource.feature

@@ -0,0 +1,103 @@
+Feature: Resource attributes
+  In order to use the Resource attribute
+  As a developer
+  I should be able to fetch data from a state provider
+  
+  @php8
+  @!mysql
+  @!mongodb
+  Scenario: Retrieve a Resource collection
+    When I add "Content-Type" header equal to "application/ld+json"
+    And I send a "GET" request to "/attribute_resources"
+    Then the response status code should be 200
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
+    And the JSON should be equal to:
+    """
+    {
+      "@context": "/contexts/AttributeResources",
+      "@id": "/attribute_resources",
+      "@type": "hydra:Collection",
+      "hydra:member": [
+        {
+          "@id": "/attribute_resources/1",
+          "@type": "AttributeResource",
+          "identifier": 1,
+          "name": "Foo"
+        },
+        {
+          "@id": "/attribute_resources/2",
+          "@type": "AttributeResource",
+          "identifier": 2,
+          "name": "Bar"
+        }
+      ]
+    }
+    """
+
+  @php8
+  @!mysql
+  @!mongodb
+  Scenario: Retrieve the first resource 
+    When I add "Content-Type" header equal to "application/ld+json"
+    And I send a "GET" request to "/attribute_resources/1"
+    Then the response status code should be 200
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
+    And the JSON should be equal to:
+    """
+    {
+      "@context": "/contexts/AttributeResource",
+      "@id": "/attribute_resources/1",
+      "@type": "AttributeResource",
+      "identifier": 1,
+      "name": "Foo"
+    } 
+    """
+
+  @php8
+  @!mysql
+  @!mongodb
+  Scenario: Retrieve the aliased resource
+    When I add "Content-Type" header equal to "application/ld+json"
+    And I send a "GET" request to "/dummy/1/attribute_resources/2"
+    Then the response status code should be 301
+    And the header "Location" should be equal to "/attribute_resources/2"
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
+    And the JSON should be equal to:
+    """
+    {
+      "@context": "/contexts/AttributeResource",
+      "@id": "/attribute_resources/2",
+      "@type": "AttributeResource",
+      "identifier": 2,
+      "dummy": "/dummies/1",
+      "name": "Foo"
+    } 
+    """
+
+  @php8
+  @!mysql
+  @!mongodb
+  Scenario: Patch the aliased resource
+    When I add "Content-Type" header equal to "application/merge-patch+json"
+    And I send a "PATCH" request to "/dummy/1/attribute_resources/2" with body:
+    """
+    {"name": "Patched"}
+    """
+    Then the response status code should be 301
+    And the header "Location" should be equal to "/attribute_resources/2"
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
+    And the JSON should be equal to:
+    """
+    {
+      "@context": "/contexts/AttributeResource",
+      "@id": "/attribute_resources/2",
+      "@type": "AttributeResource",
+      "identifier": 2,
+      "dummy": "/dummies/1",
+      "name": "Patched"
+    } 
+    """

phpstan.neon.dist

@@ -11,38 +11,41 @@ parameters:
 	bootstrapFiles:
 		- vendor/bin/.phpunit/phpunit/vendor/autoload.php
 		# We're aliasing classes for phpunit in this file, it needs to be added here see phpstan/#2194
-		- src/Bridge/Symfony/Bundle/Test/Constraint/ArraySubset.php
+		- src/Core/Bridge/Symfony/Bundle/Test/Constraint/ArraySubset.php
 		- tests/Fixtures/app/AppKernel.php
 	excludes_analyse:
 		# Symfony cache
 		- tests/Fixtures/app/var/cache
 		# Deprecated integrations (will be removed in API Platform 3)
-		- src/Bridge/NelmioApiDoc/*
+		- src/Core/Bridge/NelmioApiDoc/*
 		- tests/Bridge/NelmioApiDoc/*
-		- src/Bridge/FosUser/*
+		- src/Core/Bridge/FosUser/*
 		# BC layer
 		- tests/Bridge/Symfony/Bundle/DependencyInjection/Compiler/AnnotationFilterPassTest.php
 		- tests/Annotation/ApiResourceTest.php
 		- tests/Annotation/ApiPropertyTest.php
 		- tests/Metadata/Resource/Factory/AnnotationResourceMetadataFactoryTest.php
 		- tests/Fixtures/TestBundle/BrowserKit/Client.php
 		# The Symfony Configuration API isn't good enough to be analysed
-		- src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php
+		- src/Core/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php
 		# Phpstan runs on phpunit > 9, a signature changed in this file
-		- src/Bridge/Symfony/Bundle/Test/Constraint/ArraySubsetLegacy.php
+		- src/Core/Bridge/Symfony/Bundle/Test/Constraint/ArraySubsetLegacy.php
 		# Imported code (temporary)
-		- src/Bridge/Symfony/Bundle/Test/BrowserKitAssertionsTrait.php
+		- src/Core/Bridge/Symfony/Bundle/Test/BrowserKitAssertionsTrait.php
 		- tests/Bridge/Symfony/Bundle/Test/WebTestCaseTest.php
 		- tests/ProphecyTrait.php
 		- tests/Behat/CoverageContext.php
 		- tests/Fixtures/TestBundle/Security/AbstractSecurityUser.php
 		# Templates for Maker
-		- src/Bridge/Symfony/Maker/Resources/skeleton
+		- src/Core/Bridge/Symfony/Maker/Resources/skeleton
 	earlyTerminatingMethodCalls:
 		PHPUnit\Framework\Constraint\Constraint:
 			- fail
+		ApiPlatform\Metadata\Resource\ResourceMetadataCollection:
+			- handleNotFound 
 	ignoreErrors:
 		# False positives
+		- '#Parameter \#1 \$callback of function call_user_func expects callable\(\): mixed, non-empty-string given\.#'
 		-
 			message: "#Parameter \\#2 \\$dqlPart of method Doctrine\\\\ORM\\\\QueryBuilder::add\\(\\) expects array<'join'\\|int, array<int\\|string, object>\\|string>\\|object\\|string, array\\('o' => Doctrine\\\\ORM\\\\Query\\\\Expr\\\\Join\\) given\\.#"
 			paths:
@@ -51,15 +54,15 @@ parameters:
 		-
 			message: '#Strict comparison using !== between .+ and .+ will always evaluate to false\.#'
 			paths:
-				- src/Bridge/Doctrine/Common/PropertyHelperTrait.php
+				- src/Core/Bridge/Doctrine/Common/PropertyHelperTrait.php
 		- '#Access to an undefined property Prophecy\\Prophecy\\ObjectProphecy<(\\?[a-zA-Z0-9_]+)+>::\$[a-zA-Z0-9_]+#'
 		-
 			message: '#Call to an undefined method Doctrine\\Persistence\\ObjectManager::getConnection\(\)#'
-			path: src/Bridge/Doctrine/Common/Util/IdentifierManagerTrait.php
+			path: src/Core/Bridge/Doctrine/Common/Util/IdentifierManagerTrait.php
 		# https://github.com/willdurand/Negotiation/issues/89#issuecomment-513283286
 		-
 			message: '#Call to an undefined method Negotiation\\AcceptHeader::getType\(\)\.#'
-			path: src/EventListener/AddFormatListener.php
+			path: src/Core/EventListener/AddFormatListener.php
 		- '#Parameter \#1 \$vars of class GraphQL\\Language\\AST\\(IntValue|ObjectField|ObjectValue|BooleanValue|ListValue|StringValue)Node constructor expects array<bool\|float\|GraphQL\\Language\\AST\\Location\|GraphQL\\Language\\AST\\NameNode\|GraphQL\\Language\\AST\\NodeList\|GraphQL\\Language\\AST\\SelectionSetNode\|int\|string\|null>, array<string, .+> given\.#'
 		- '#Parameter \#1 \$defaultContext of class Symfony\\Component\\Serializer\\Encoder\\Json(De|En)code constructor expects array, (int|true) given\.#'
 		- '#Parameter \#(2|3) \$(resourceMetadataFactory|pagination) of class ApiPlatform\\Core\\Bridge\\Doctrine\\Orm\\Extension\\PaginationExtension constructor expects (ApiPlatform\\Core\\Metadata\\Resource\\Factory\\ResourceMetadataFactoryInterface\|Symfony\\Component\\HttpFoundation\\RequestStack|ApiPlatform\\Core\\DataProvider\\Pagination\|ApiPlatform\\Core\\Metadata\\Resource\\Factory\\ResourceMetadataFactoryInterface), stdClass given\.#'
@@ -76,7 +79,7 @@ parameters:
 		# https://github.com/phpstan/phpstan-doctrine/issues/115
 		-
 			message: '#Property ApiPlatform\\Core\\Test\\DoctrineMongoDbOdmFilterTestCase::\$repository \(Doctrine\\ODM\\MongoDB\\Repository\\DocumentRepository\) does not accept Doctrine\\ORM\\EntityRepository<ApiPlatform\\Core\\Tests\\Fixtures\\TestBundle\\Document\\Dummy>\.#'
-			path: src/Test/DoctrineMongoDbOdmFilterTestCase.php
+			path: src/Core/Test/DoctrineMongoDbOdmFilterTestCase.php
 		-
 			message: "#Call to method PHPUnit\\\\Framework\\\\Assert::assertSame\\(\\) with array\\('(collection_context|item_context|subresource_context)'\\) and array<Symfony\\\\Component\\\\VarDumper\\\\Cloner\\\\Data>\\|bool\\|float\\|int\\|string\\|null will always evaluate to false\\.#"
 			path: tests/Bridge/Symfony/Bundle/DataCollector/RequestDataCollectorTest.php

phpunit.xml.dist

@@ -16,6 +16,8 @@
     <testsuites>
         <testsuite name="Project Test Suite">
             <directory>tests</directory>
+            <directory phpVersion="8.0" phpVersionOperator=">=">tests/Metadata/Resource/Factory</directory>
+            <exclude>tests/Metadata/Resource/Factory</exclude>
         </testsuite>
     </testsuites>