Merge pull request #772 from dunglas/id_not_iri

dunglas · web-flow · commit f45ebe8682f6 · 2016-10-09T23:15:10.000+02:00
ID should not be an IRI when not using an hypermedia format, don't hide the raw ID property by default
diff --git a/features/composite.feature b/features/composite.feature
@@ -21,6 +21,7 @@ Feature: Retrieve data with Composite identifiers
         {
           "@id": "/composite_items/1",
           "@type": "CompositeItem",
+          "id": 1,
           "field1": "foobar",
           "compositeValues": [
             "/composite_relations/compositeItem=1;compositeLabel=1",
@@ -42,6 +43,7 @@ Feature: Retrieve data with Composite identifiers
     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 print last JSON response
     And the JSON should be equal to:
     """
     {
@@ -52,17 +54,23 @@ Feature: Retrieve data with Composite identifiers
         {
           "@id": "/composite_relations/compositeItem=1;compositeLabel=1",
           "@type": "CompositeRelation",
-          "value": "somefoobardummy"
+          "value": "somefoobardummy",
+          "compositeItem": "/composite_items/1",
+          "compositeLabel": "/composite_labels/1"
         },
         {
           "@id": "/composite_relations/compositeItem=1;compositeLabel=2",
           "@type": "CompositeRelation",
-          "value": "somefoobardummy"
+          "value": "somefoobardummy",
+          "compositeItem": "/composite_items/1",
+          "compositeLabel": "/composite_labels/2"
         },
         {
           "@id": "/composite_relations/compositeItem=1;compositeLabel=3",
           "@type": "CompositeRelation",
-          "value": "somefoobardummy"
+          "value": "somefoobardummy",
+          "compositeItem": "/composite_items/1",
+          "compositeLabel": "/composite_labels/3"
         }
       ],
       "hydra:totalItems": 4,
@@ -86,10 +94,12 @@ Feature: Retrieve data with Composite identifiers
     And the JSON should be equal to:
     """
     {
-      "@context": "\/contexts\/CompositeRelation",
-      "@id": "\/composite_relations\/compositeItem=1;compositeLabel=1",
+      "@context": "/contexts/CompositeRelation",
+      "@id": "/composite_relations/compositeItem=1;compositeLabel=1",
       "@type": "CompositeRelation",
-      "value": "somefoobardummy"
+      "value": "somefoobardummy",
+      "compositeItem": "/composite_items/1",
+      "compositeLabel": "/composite_labels/1"
     }
     """
 
@@ -102,10 +112,12 @@ Feature: Retrieve data with Composite identifiers
     And the JSON should be equal to:
     """
     {
-      "@context": "\/contexts\/CompositeRelation",
-      "@id": "\/composite_relations\/compositeItem=1;compositeLabel=1",
+      "@context": "/contexts/CompositeRelation",
+      "@id": "/composite_relations/compositeItem=1;compositeLabel=1",
       "@type": "CompositeRelation",
-      "value": "somefoobardummy"
+      "value": "somefoobardummy",
+      "compositeItem": "/composite_items/1",
+      "compositeLabel": "/composite_labels/1"
     }
     """
 
diff --git a/features/configurable.feature b/features/configurable.feature
@@ -19,6 +19,7 @@ Feature: Configurable resource CRUD
           {
               "@id": "/fileconfigdummies/1",
               "@type": "fileconfigdummy",
+              "id": 1,
               "name": "ConfigDummy"
           }
       ],
@@ -54,6 +55,7 @@ Feature: Configurable resource CRUD
           "@context": "\/contexts\/fileconfigdummy",
           "@id": "\/fileconfigdummies\/1",
           "@type": "fileconfigdummy",
+          "id": 1,
           "name": "ConfigDummy"
       }
     """
diff --git a/features/content_negotiation.feature b/features/content_negotiation.feature
@@ -18,7 +18,7 @@ Feature: Content Negotiation support
     And the response should be equal to
     """
     <?xml version="1.0"?>
-    <response><id>/dummies/1</id><description/><dummy/><dummyBoolean/><dummyDate/><dummyFloat/><dummyPrice/><relatedDummy/><relatedDummies/><jsonData/><name_converted/><name>XML!</name><alias/></response>
+    <response><description/><dummy/><dummyBoolean/><dummyDate/><dummyFloat/><dummyPrice/><relatedDummy/><relatedDummies/><jsonData/><name_converted/><id>1</id><name>XML!</name><alias/></response>
     """
 
   Scenario:  Retrieve a collection in XML
@@ -29,7 +29,7 @@ Feature: Content Negotiation support
     And the response should be equal to
     """
     <?xml version="1.0"?>
-    <response><item key="0"><id>/dummies/1</id><description/><dummy/><dummyBoolean/><dummyDate/><dummyFloat/><dummyPrice/><relatedDummy/><relatedDummies/><jsonData/><name_converted/><name>XML!</name><alias/></item></response>
+    <response><item key="0"><description/><dummy/><dummyBoolean/><dummyDate/><dummyFloat/><dummyPrice/><relatedDummy/><relatedDummies/><jsonData/><name_converted/><id>1</id><name>XML!</name><alias/></item></response>
     """
 
   Scenario:  Retrieve a collection in XML using the .xml URL
@@ -39,7 +39,7 @@ Feature: Content Negotiation support
     And the response should be equal to
     """
     <?xml version="1.0"?>
-    <response><item key="0"><id>/dummies/1</id><description/><dummy/><dummyBoolean/><dummyDate/><dummyFloat/><dummyPrice/><relatedDummy/><relatedDummies/><jsonData/><name_converted/><name>XML!</name><alias/></item></response>
+    <response><item key="0"><description/><dummy/><dummyBoolean/><dummyDate/><dummyFloat/><dummyPrice/><relatedDummy/><relatedDummies/><jsonData/><name_converted/><id>1</id><name>XML!</name><alias/></item></response>
     """
 
   Scenario:  Retrieve a collection in JSON
@@ -52,7 +52,6 @@ Feature: Content Negotiation support
     """
     [
       {
-        "id": "/dummies/1",
         "description": null,
         "dummy": null,
         "dummyBoolean": null,
@@ -63,6 +62,7 @@ Feature: Content Negotiation support
         "relatedDummies": [],
         "jsonData": [],
         "name_converted": null,
+        "id": 1,
         "name": "XML!",
         "alias": null
       }
@@ -81,7 +81,7 @@ Feature: Content Negotiation support
     And the response should be equal to
     """
     <?xml version="1.0"?>
-    <response><id>/dummies/2</id><description/><dummy/><dummyBoolean/><dummyDate/><dummyFloat/><dummyPrice/><relatedDummy/><relatedDummies/><jsonData/><name_converted/><name>Sent in JSON</name><alias/></response>
+    <response><description/><dummy/><dummyBoolean/><dummyDate/><dummyFloat/><dummyPrice/><relatedDummy/><relatedDummies/><jsonData/><name_converted/><id>2</id><name>Sent in JSON</name><alias/></response>
     """
 
   Scenario: Requesting the same format in the Accept header and in the URL should work
diff --git a/features/crud.feature b/features/crud.feature
@@ -43,6 +43,7 @@ Feature: Create-Retrieve-Update-Delete
         ]
       },
       "name_converted": null,
+      "id": 1,
       "name": "My Dummy",
       "alias": null
     }
@@ -74,6 +75,7 @@ Feature: Create-Retrieve-Update-Delete
         ]
       },
       "name_converted": null,
+      "id": 1,
       "name": "My Dummy",
       "alias": null
     }
@@ -113,6 +115,7 @@ Feature: Create-Retrieve-Update-Delete
             ]
           },
           "name_converted": null,
+          "id": 1,
           "name": "My Dummy",
           "alias": null
         }
@@ -350,6 +353,7 @@ Feature: Create-Retrieve-Update-Delete
         }
       ],
       "name_converted": null,
+      "id": 1,
       "name": "A nice dummy",
       "alias": null
     }
diff --git a/features/crud_abstract.feature b/features/crud_abstract.feature
@@ -23,6 +23,7 @@ Feature: Create-Retrieve-Update-Delete on abstract resource
       "@id": "/concrete_dummies/1",
       "@type": "ConcreteDummy",
       "instance": "Concrete",
+      "id": 1,
       "name": "My Dummy"
     }
     """
@@ -39,6 +40,7 @@ Feature: Create-Retrieve-Update-Delete on abstract resource
       "@id": "/concrete_dummies/1",
       "@type": "ConcreteDummy",
       "instance": "Concrete",
+      "id": 1,
       "name": "My Dummy"
     }
     """
@@ -95,6 +97,7 @@ Feature: Create-Retrieve-Update-Delete on abstract resource
         "@id": "/concrete_dummies/1",
         "@type": "ConcreteDummy",
         "instance": "Become real",
+        "id": 1,
         "name": "A nice dummy"
       }
       """
diff --git a/features/custom_identifier.feature b/features/custom_identifier.feature
@@ -21,6 +21,7 @@ Feature: Using custom identifier on resource
       "@context": "/contexts/CustomIdentifierDummy",
       "@id": "/custom_identifier_dummies/1",
       "@type": "CustomIdentifierDummy",
+      "customId": 1,
       "name": "My Dummy"
     }
     """
@@ -36,6 +37,7 @@ Feature: Using custom identifier on resource
       "@context": "/contexts/CustomIdentifierDummy",
       "@id": "/custom_identifier_dummies/1",
       "@type": "CustomIdentifierDummy",
+      "customId": 1,
       "name": "My Dummy"
     }
     """
@@ -55,6 +57,7 @@ Feature: Using custom identifier on resource
         {
           "@id": "/custom_identifier_dummies/1",
           "@type": "CustomIdentifierDummy",
+          "customId": 1,
           "name": "My Dummy"
         }
       ],
@@ -79,6 +82,7 @@ Feature: Using custom identifier on resource
         "@context": "/contexts/CustomIdentifierDummy",
         "@id": "/custom_identifier_dummies/1",
         "@type": "CustomIdentifierDummy",
+        "customId": 1,
         "name": "My Dummy modified"
       }
       """
diff --git a/features/custom_writable_identifier.feature b/features/custom_writable_identifier.feature
@@ -22,6 +22,7 @@ Feature: Using custom writable identifier on resource
       "@context": "/contexts/CustomWritableIdentifierDummy",
       "@id": "/custom_writable_identifier_dummies/my_slug",
       "@type": "CustomWritableIdentifierDummy",
+      "slug": "my_slug",
       "name": "My Dummy"
     }
     """
@@ -37,6 +38,7 @@ Feature: Using custom writable identifier on resource
       "@context": "/contexts/CustomWritableIdentifierDummy",
       "@id": "/custom_writable_identifier_dummies/my_slug",
       "@type": "CustomWritableIdentifierDummy",
+      "slug": "my_slug",
       "name": "My Dummy"
     }
     """
@@ -56,6 +58,7 @@ Feature: Using custom writable identifier on resource
         {
           "@id": "/custom_writable_identifier_dummies/my_slug",
           "@type": "CustomWritableIdentifierDummy",
+          "slug": "my_slug",
           "name": "My Dummy"
         }
       ],
@@ -81,6 +84,7 @@ Feature: Using custom writable identifier on resource
       "@context": "/contexts/CustomWritableIdentifierDummy",
       "@id": "/custom_writable_identifier_dummies/slug_modified",
       "@type": "CustomWritableIdentifierDummy",
+      "slug": "slug_modified",
       "name": "My Dummy modified"
     }
     """
@@ -94,7 +98,7 @@ Feature: Using custom writable identifier on resource
     And 2 properties are available for hydra class "CustomWritableIdentifierDummy"
     And "name" property is readable for hydra class "CustomWritableIdentifierDummy"
     And "name" property is writable for hydra class "CustomWritableIdentifierDummy"
-    And "slug" property is not readable for hydra class "CustomWritableIdentifierDummy"
+    And "slug" property is readable for hydra class "CustomWritableIdentifierDummy"
     And "slug" property is writable for hydra class "CustomWritableIdentifierDummy"
 
   @dropSchema
diff --git a/features/hal.feature b/features/hal.feature
@@ -74,6 +74,7 @@ Feature: HAL support
       "dummyPrice": null,
       "jsonData": [],
       "name_converted": null,
+      "id": 1,
       "name": "Dummy with relations",
       "alias": null
     }
@@ -113,6 +114,7 @@ Feature: HAL support
       "dummyPrice": null,
       "jsonData": [],
       "name_converted": null,
+      "id": 1,
       "name": "A nice dummy",
       "alias": null
     }
@@ -214,6 +216,7 @@ Feature: HAL support
             "dummyPrice": null,
             "jsonData": [],
             "name_converted": null,
+            "id": 1,
             "name": "A nice dummy",
             "alias": null
           }
diff --git a/features/overridden_operation.feature b/features/overridden_operation.feature
@@ -54,7 +54,7 @@ Feature: Create-Retrieve-Update-Delete with a Overridden Operation context
     And the response should be equal to
     """
     <?xml version="1.0"?>
-    <response><id>/overridden_operation_dummies/1</id><name>My Overridden Operation Dummy</name><alias/><description>Gerard</description></response>
+    <response><name>My Overridden Operation Dummy</name><alias/><description>Gerard</description></response>
     """
 
   Scenario: Get a not found exception
diff --git a/features/relation.feature b/features/relation.feature
@@ -19,6 +19,7 @@ Feature: Relations support
       "@context": "/contexts/ThirdLevel",
       "@id": "/third_levels/1",
       "@type": "ThirdLevel",
+      "id": 1,
       "level": 3,
       "test": true
     }
@@ -39,6 +40,7 @@ Feature: Relations support
       "@context": "/contexts/DummyFriend",
       "@id": "/dummy_friends/1",
       "@type": "DummyFriend",
+      "id": 1,
       "name": "Zoidberg"
     }
     """
@@ -63,6 +65,7 @@ Feature: Relations support
       "thirdLevel": "/third_levels/1",
       "relatedToDummyFriend": null,
       "dummyBoolean": null,
+      "id": 1,
       "symfony": "symfony",
       "age": null
     }
@@ -150,6 +153,7 @@ Feature: Relations support
       ],
       "jsonData": [],
       "name_converted": null,
+      "id": 1,
       "name": "Dummy with relations",
       "alias": null
     }
diff --git a/features/security/strong_typing.feature b/features/security/strong_typing.feature
@@ -32,6 +32,7 @@ Feature: Handle properly invalid data submitted to the API
       "relatedDummies": [],
       "jsonData": [],
       "name_converted": null,
+      "id": 1,
       "name": "Not existing",
       "alias": null
     }
diff --git a/features/security/unknown_attributes.feature b/features/security/unknown_attributes.feature
@@ -33,6 +33,7 @@ Feature: Ignore unknown attributes
       "relatedDummies": [],
       "jsonData": [],
       "name_converted": null,
+      "id": 1,
       "name": "Not existing",
       "alias": null
     }
diff --git a/features/uuid.feature b/features/uuid.feature
diff --git a/src/Hal/Serializer/ItemNormalizer.php b/src/Hal/Serializer/ItemNormalizer.php
diff --git a/src/JsonLd/Serializer/ItemNormalizer.php b/src/JsonLd/Serializer/ItemNormalizer.php
diff --git a/src/Metadata/Property/Factory/SerializerPropertyMetadataFactory.php b/src/Metadata/Property/Factory/SerializerPropertyMetadataFactory.php
diff --git a/src/Serializer/ItemNormalizer.php b/src/Serializer/ItemNormalizer.php
diff --git a/tests/Serializer/ItemNormalizerTest.php b/tests/Serializer/ItemNormalizerTest.php

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@ Feature: Configurable resource CRUD`
`19`	`19`	`{`
`20`	`20`	`"@id": "/fileconfigdummies/1",`
`21`	`21`	`"@type": "fileconfigdummy",`
	`22`	`+ "id": 1,`
`22`	`23`	`"name": "ConfigDummy"`
`23`	`24`	`}`
`24`	`25`	`],`
`@@ -54,6 +55,7 @@ Feature: Configurable resource CRUD`
`54`	`55`	`"@context": "\/contexts\/fileconfigdummy",`
`55`	`56`	`"@id": "\/fileconfigdummies\/1",`
`56`	`57`	`"@type": "fileconfigdummy",`
	`58`	`+ "id": 1,`
`57`	`59`	`"name": "ConfigDummy"`
`58`	`60`	`}`
`59`	`61`	`"""`
Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,7 @@ Feature: Create-Retrieve-Update-Delete`
`43`	`43`	`]`
`44`	`44`	`},`
`45`	`45`	`"name_converted": null,`
	`46`	`+ "id": 1,`
`46`	`47`	`"name": "My Dummy",`
`47`	`48`	`"alias": null`
`48`	`49`	`}`
`@@ -74,6 +75,7 @@ Feature: Create-Retrieve-Update-Delete`
`74`	`75`	`]`
`75`	`76`	`},`
`76`	`77`	`"name_converted": null,`
	`78`	`+ "id": 1,`
`77`	`79`	`"name": "My Dummy",`
`78`	`80`	`"alias": null`
`79`	`81`	`}`
`@@ -113,6 +115,7 @@ Feature: Create-Retrieve-Update-Delete`
`113`	`115`	`]`
`114`	`116`	`},`
`115`	`117`	`"name_converted": null,`
	`118`	`+ "id": 1,`
`116`	`119`	`"name": "My Dummy",`
`117`	`120`	`"alias": null`
`118`	`121`	`}`
`@@ -350,6 +353,7 @@ Feature: Create-Retrieve-Update-Delete`
`350`	`353`	`}`
`351`	`354`	`],`
`352`	`355`	`"name_converted": null,`
	`356`	`+ "id": 1,`
`353`	`357`	`"name": "A nice dummy",`
`354`	`358`	`"alias": null`
`355`	`359`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ Feature: Using custom identifier on resource`
`21`	`21`	`"@context": "/contexts/CustomIdentifierDummy",`
`22`	`22`	`"@id": "/custom_identifier_dummies/1",`
`23`	`23`	`"@type": "CustomIdentifierDummy",`
	`24`	`+ "customId": 1,`
`24`	`25`	`"name": "My Dummy"`
`25`	`26`	`}`
`26`	`27`	`"""`
`@@ -36,6 +37,7 @@ Feature: Using custom identifier on resource`
`36`	`37`	`"@context": "/contexts/CustomIdentifierDummy",`
`37`	`38`	`"@id": "/custom_identifier_dummies/1",`
`38`	`39`	`"@type": "CustomIdentifierDummy",`
	`40`	`+ "customId": 1,`
`39`	`41`	`"name": "My Dummy"`
`40`	`42`	`}`
`41`	`43`	`"""`
`@@ -55,6 +57,7 @@ Feature: Using custom identifier on resource`
`55`	`57`	`{`
`56`	`58`	`"@id": "/custom_identifier_dummies/1",`
`57`	`59`	`"@type": "CustomIdentifierDummy",`
	`60`	`+ "customId": 1,`
`58`	`61`	`"name": "My Dummy"`
`59`	`62`	`}`
`60`	`63`	`],`
`@@ -79,6 +82,7 @@ Feature: Using custom identifier on resource`
`79`	`82`	`"@context": "/contexts/CustomIdentifierDummy",`
`80`	`83`	`"@id": "/custom_identifier_dummies/1",`
`81`	`84`	`"@type": "CustomIdentifierDummy",`
	`85`	`+ "customId": 1,`
`82`	`86`	`"name": "My Dummy modified"`
`83`	`87`	`}`
`84`	`88`	`"""`