Allow generating documentation when property and method start from "is"

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 * Mercure: Do not use data in options when deleting (#4056)
 * Doctrine: Support for foreign identifiers
+* SchemaFactory: Allow generating documentation when property and method start from "is" (property `isActive` and method `isActive`)
 
 ## 2.6.2
 

features/hal/collection.feature

@@ -73,6 +73,7 @@ Feature: HAL Collections support
             "description": "Smart dummy.",
             "dummy": "SomeDummyTest1",
             "dummyBoolean": null,
+            "isDummyBoolean": null,
             "dummyDate": null,
             "dummyFloat": null,
             "dummyPrice": null,
@@ -93,6 +94,7 @@ Feature: HAL Collections support
             "description": "Not so smart dummy.",
             "dummy": "SomeDummyTest2",
             "dummyBoolean": null,
+            "isDummyBoolean": null,
             "dummyDate": null,
             "dummyFloat": null,
             "dummyPrice": null,
@@ -113,6 +115,7 @@ Feature: HAL Collections support
             "description": "Smart dummy.",
             "dummy": "SomeDummyTest3",
             "dummyBoolean": null,
+            "isDummyBoolean": null,
             "dummyDate": null,
             "dummyFloat": null,
             "dummyPrice": null,
@@ -180,6 +183,7 @@ Feature: HAL Collections support
             "description": "Smart dummy.",
             "dummy": "SomeDummyTest7",
             "dummyBoolean": null,
+            "isDummyBoolean": null,
             "dummyDate": null,
             "dummyFloat": null,
             "dummyPrice": null,
@@ -200,6 +204,7 @@ Feature: HAL Collections support
             "description": "Not so smart dummy.",
             "dummy": "SomeDummyTest8",
             "dummyBoolean": null,
+            "isDummyBoolean": null,
             "dummyDate": null,
             "dummyFloat": null,
             "dummyPrice": null,
@@ -220,6 +225,7 @@ Feature: HAL Collections support
             "description": "Smart dummy.",
             "dummy": "SomeDummyTest9",
             "dummyBoolean": null,
+            "isDummyBoolean": null,
             "dummyDate": null,
             "dummyFloat": null,
             "dummyPrice": null,
@@ -278,6 +284,7 @@ Feature: HAL Collections support
             "description": "Not so smart dummy.",
             "dummy": "SomeDummyTest10",
             "dummyBoolean": null,
+            "isDummyBoolean": null,
             "dummyDate": null,
             "dummyFloat": null,
             "dummyPrice": null,
@@ -339,6 +346,7 @@ Feature: HAL Collections support
             "description": "Not so smart dummy.",
             "dummy": "SomeDummyTest4",
             "dummyBoolean": null,
+            "isDummyBoolean": null,
             "dummyDate": null,
             "dummyFloat": null,
             "dummyPrice": null,
@@ -359,6 +367,7 @@ Feature: HAL Collections support
             "description": "Smart dummy.",
             "dummy": "SomeDummyTest5",
             "dummyBoolean": null,
+            "isDummyBoolean": null,
             "dummyDate": null,
             "dummyFloat": null,
             "dummyPrice": null,
@@ -379,6 +388,7 @@ Feature: HAL Collections support
             "description": "Not so smart dummy.",
             "dummy": "SomeDummyTest6",
             "dummyBoolean": null,
+            "isDummyBoolean": null,
             "dummyDate": null,
             "dummyFloat": null,
             "dummyPrice": null,
@@ -501,6 +511,7 @@ Feature: HAL Collections support
             "description": "Not so smart dummy.",
             "dummy": "SomeDummyTest2",
             "dummyBoolean": null,
+            "isDummyBoolean": null,
             "dummyDate": null,
             "dummyFloat": null,
             "dummyPrice": null,
@@ -550,6 +561,7 @@ Feature: HAL Collections support
             "description": "Not so smart dummy.",
             "dummy": "SomeDummyTest8",
             "dummyBoolean": null,
+            "isDummyBoolean": null,
             "dummyDate": null,
             "dummyFloat": null,
             "dummyPrice": null,
@@ -599,6 +611,7 @@ Feature: HAL Collections support
             "description": "Not so smart dummy.",
             "dummy": "SomeDummyTest8",
             "dummyBoolean": null,
+            "isDummyBoolean": null,
             "dummyDate": null,
             "dummyFloat": null,
             "dummyPrice": null,

features/hal/hal.feature

@@ -71,6 +71,7 @@ Feature: HAL support
       "description": null,
       "dummy": null,
       "dummyBoolean": null,
+      "isDummyBoolean": null,
       "dummyDate": "2015-03-01T10:00:00+00:00",
       "dummyFloat": null,
       "dummyPrice": null,
@@ -114,6 +115,7 @@ Feature: HAL support
       "description": null,
       "dummy": null,
       "dummyBoolean": null,
+      "isDummyBoolean": null,
       "dummyDate": "2015-03-01T10:00:00+00:00",
       "dummyFloat": null,
       "dummyPrice": null,

features/json/relation.feature

@@ -208,6 +208,7 @@ Feature: JSON relations support
       "description": null,
       "dummy": null,
       "dummyBoolean": null,
+      "isDummyBoolean": null,
       "dummyDate": null,
       "dummyFloat": null,
       "dummyPrice": null,

features/jsonapi/related-resouces-inclusion.feature

@@ -338,6 +338,7 @@ Feature: JSON API Inclusion of Related Resources
                     "description": null,
                     "dummy": null,
                     "dummyBoolean": null,
+                    "isDummyBoolean": null,
                     "dummyDate": null,
                     "dummyFloat": null,
                     "dummyPrice": null,

features/main/content_negotiation.feature

@@ -19,7 +19,7 @@ Feature: Content Negotiation support
     And the XML should be equal to:
     """
     <?xml version="1.0"?>
-    <response><description/><dummy/><dummyBoolean/><dummyDate/><dummyFloat/><dummyPrice/><relatedDummy/><relatedDummies/><jsonData/><arrayData/><name_converted/><relatedOwnedDummy/><relatedOwningDummy/><id>1</id><name>XML!</name><alias/><foo/></response>
+    <response><description/><dummy/><dummyBoolean/><isDummyBoolean/><dummyDate/><dummyFloat/><dummyPrice/><relatedDummy/><relatedDummies/><jsonData/><arrayData/><name_converted/><relatedOwnedDummy/><relatedOwningDummy/><id>1</id><name>XML!</name><alias/><foo/></response>
     """
 
   Scenario:  Retrieve a collection in XML
@@ -31,7 +31,7 @@ Feature: Content Negotiation support
     And the XML should be equal to:
     """
     <?xml version="1.0"?>
-    <response><item key="0"><description/><dummy/><dummyBoolean/><dummyDate/><dummyFloat/><dummyPrice/><relatedDummy/><relatedDummies/><jsonData/><arrayData/><name_converted/><relatedOwnedDummy/><relatedOwningDummy/><id>1</id><name>XML!</name><alias/><foo/></item></response>
+    <response><item key="0"><description/><dummy/><dummyBoolean/><isDummyBoolean/><dummyDate/><dummyFloat/><dummyPrice/><relatedDummy/><relatedDummies/><jsonData/><arrayData/><name_converted/><relatedOwnedDummy/><relatedOwningDummy/><id>1</id><name>XML!</name><alias/><foo/></item></response>
     """
 
   Scenario:  Retrieve a collection in XML using the .xml URL
@@ -42,7 +42,7 @@ Feature: Content Negotiation support
     And the XML should be equal to:
     """
     <?xml version="1.0"?>
-    <response><item key="0"><description/><dummy/><dummyBoolean/><dummyDate/><dummyFloat/><dummyPrice/><relatedDummy/><relatedDummies/><jsonData/><arrayData/><name_converted/><relatedOwnedDummy/><relatedOwningDummy/><id>1</id><name>XML!</name><alias/><foo/></item></response>
+    <response><item key="0"><description/><dummy/><dummyBoolean/><isDummyBoolean/><dummyDate/><dummyFloat/><dummyPrice/><relatedDummy/><relatedDummies/><jsonData/><arrayData/><name_converted/><relatedOwnedDummy/><relatedOwningDummy/><id>1</id><name>XML!</name><alias/><foo/></item></response>
     """
 
   Scenario:  Retrieve a collection in JSON
@@ -58,6 +58,7 @@ Feature: Content Negotiation support
         "description": null,
         "dummy": null,
         "dummyBoolean": null,
+        "isDummyBoolean": null,
         "dummyDate": null,
         "dummyFloat": null,
         "dummyPrice": null,
@@ -89,7 +90,7 @@ Feature: Content Negotiation support
     And the XML should be equal to:
     """
     <?xml version="1.0"?>
-    <response><description/><dummy/><dummyBoolean/><dummyDate/><dummyFloat/><dummyPrice/><relatedDummy/><relatedDummies/><jsonData/><arrayData/><name_converted/><relatedOwnedDummy/><relatedOwningDummy/><id>2</id><name>Sent in JSON</name><alias/><foo/></response>
+    <response><description/><dummy/><dummyBoolean/><isDummyBoolean/><dummyDate/><dummyFloat/><dummyPrice/><relatedDummy/><relatedDummies/><jsonData/><arrayData/><name_converted/><relatedOwnedDummy/><relatedOwningDummy/><id>2</id><name>Sent in JSON</name><alias/><foo/></response>
     """
 
   Scenario: Requesting the same format in the Accept header and in the URL should work

features/main/crud.feature

@@ -33,6 +33,7 @@ Feature: Create-Retrieve-Update-Delete
       "description": null,
       "dummy": null,
       "dummyBoolean": null,
+      "isDummyBoolean": null,
       "dummyDate": "2015-03-01T10:00:00+00:00",
       "dummyFloat": null,
       "dummyPrice": null,
@@ -69,6 +70,7 @@ Feature: Create-Retrieve-Update-Delete
       "description": null,
       "dummy": null,
       "dummyBoolean": null,
+      "isDummyBoolean": null,
       "dummyDate": "2015-03-01T10:00:00+00:00",
       "dummyFloat": null,
       "dummyPrice": null,
@@ -119,6 +121,7 @@ Feature: Create-Retrieve-Update-Delete
           "description": null,
           "dummy": null,
           "dummyBoolean": null,
+          "isDummyBoolean": null,
           "dummyDate": "2015-03-01T10:00:00+00:00",
           "dummyFloat": null,
           "dummyPrice": null,
@@ -523,6 +526,7 @@ Feature: Create-Retrieve-Update-Delete
       "description": null,
       "dummy": null,
       "dummyBoolean": null,
+      "isDummyBoolean": null,
       "dummyDate": "2018-12-01T13:12:00+00:00",
       "dummyFloat": null,
       "dummyPrice": null,

features/main/relation.feature

@@ -155,6 +155,7 @@ Feature: Relations support
       "description": null,
       "dummy": null,
       "dummyBoolean": null,
+      "isDummyBoolean": null,
       "dummyDate": null,
       "dummyFloat": null,
       "dummyPrice": null,

features/main/subresource.feature

@@ -383,6 +383,7 @@ Feature: Subresource support
       "description": null,
       "dummy": null,
       "dummyBoolean": null,
+      "isDummyBoolean": null,
       "dummyDate": null,
       "dummyFloat": null,
       "dummyPrice": null,
@@ -416,6 +417,7 @@ Feature: Subresource support
       "description": null,
       "dummy": null,
       "dummyBoolean": null,
+      "isDummyBoolean": null,
       "dummyDate": null,
       "dummyFloat": null,
       "dummyPrice": null,

features/security/strong_typing.feature

@@ -25,6 +25,7 @@ Feature: Handle properly invalid data submitted to the API
       "description": null,
       "dummy": null,
       "dummyBoolean": null,
+      "isDummyBoolean": null,
       "dummyDate": null,
       "dummyFloat": null,
       "dummyPrice": null,
@@ -33,8 +34,8 @@ Feature: Handle properly invalid data submitted to the API
       "jsonData": [],
       "arrayData": [],
       "name_converted": null,
-	  "relatedOwnedDummy": null,
-	  "relatedOwningDummy": null,
+      "relatedOwnedDummy": null,
+      "relatedOwningDummy": null,
       "id": 1,
       "name": "Not existing",
       "alias": null,

features/security/unknown_attributes.feature

@@ -25,6 +25,7 @@ Feature: Ignore unknown attributes
       "description": null,
       "dummy": null,
       "dummyBoolean": null,
+      "isDummyBoolean": null,
       "dummyDate": null,
       "dummyFloat": null,
       "dummyPrice": null,

src/JsonSchema/SchemaFactory.php

@@ -325,7 +325,10 @@ private function getValidationGroups(ResourceMetadata $resourceMetadata, ?string
      */
     private function getFactoryOptions(array $serializerContext, array $validationGroups, ?string $operationType, ?string $operationName): array
     {
-        $options = [];
+        $options = [
+            /* @see https://github.com/symfony/symfony/blob/v5.1.0/src/Symfony/Component/PropertyInfo/Extractor/ReflectionExtractor.php */
+            'enable_getter_setter_extraction' => true,
+        ];
 
         if (isset($serializerContext[AbstractNormalizer::GROUPS])) {
             /* @see https://github.com/symfony/symfony/blob/v4.2.6/src/Symfony/Component/PropertyInfo/Extractor/SerializerExtractor.php */

tests/Bridge/Doctrine/Common/Filter/BooleanFilterTestTrait.php

@@ -46,6 +46,11 @@ public function testGetDescriptionDefaultFields()
                 'type' => 'bool',
                 'required' => false,
             ],
+            'isDummyBoolean' => [
+                'property' => 'isDummyBoolean',
+                'type' => 'bool',
+                'required' => false,
+            ],
         ], $filter->getDescription($this->resourceClass));
     }
 

tests/Bridge/Doctrine/Orm/Filter/ExistsFilterTest.php

@@ -90,6 +90,11 @@ public function testGetDescriptionDefaultFields()
                 'type' => 'bool',
                 'required' => false,
             ],
+            'exists[isDummyBoolean]' => [
+                'property' => 'isDummyBoolean',
+                'type' => 'bool',
+                'required' => false,
+            ],
         ], $filter->getDescription($this->resourceClass));
     }
 

tests/Bridge/Doctrine/Orm/Filter/OrderFilterTest.php

@@ -180,6 +180,18 @@ public function testGetDescriptionDefaultFields()
                     ],
                 ],
             ],
+            'order[isDummyBoolean]' => [
+                'property' => 'isDummyBoolean',
+                'type' => 'string',
+                'required' => false,
+                'schema' => [
+                    'type' => 'string',
+                    'enum' => [
+                        'asc',
+                        'desc',
+                    ],
+                ],
+            ],
         ], $filter->getDescription($this->resourceClass));
     }
 

tests/Bridge/Doctrine/Orm/Filter/RangeFilterTest.php

@@ -332,6 +332,31 @@ public function testGetDescriptionDefaultFields()
                 'type' => 'string',
                 'required' => false,
             ],
+            'isDummyBoolean[between]' => [
+                'property' => 'isDummyBoolean',
+                'type' => 'string',
+                'required' => false,
+            ],
+            'isDummyBoolean[gt]' => [
+                'property' => 'isDummyBoolean',
+                'type' => 'string',
+                'required' => false,
+            ],
+            'isDummyBoolean[gte]' => [
+                'property' => 'isDummyBoolean',
+                'type' => 'string',
+                'required' => false,
+            ],
+            'isDummyBoolean[lt]' => [
+                'property' => 'isDummyBoolean',
+                'type' => 'string',
+                'required' => false,
+            ],
+            'isDummyBoolean[lte]' => [
+                'property' => 'isDummyBoolean',
+                'type' => 'string',
+                'required' => false,
+            ],
         ], $filter->getDescription($this->resourceClass));
     }
 

tests/Bridge/Doctrine/Orm/Filter/SearchFilterTest.php

@@ -214,6 +214,20 @@ public function testGetDescriptionDefaultFields()
                 'strategy' => 'exact',
                 'is_collection' => true,
             ],
+            'isDummyBoolean' => [
+                'property' => 'isDummyBoolean',
+                'type' => 'bool',
+                'required' => false,
+                'strategy' => 'exact',
+                'is_collection' => false,
+            ],
+            'isDummyBoolean[]' => [
+                'property' => 'isDummyBoolean',
+                'type' => 'bool',
+                'required' => false,
+                'strategy' => 'exact',
+                'is_collection' => true,
+            ],
         ], $filter->getDescription($this->resourceClass));
     }