Update from internal 0.19.0 changes

alenpokos · alenpokos · commit 0c284a5bd7fa · 2021-08-26T21:59:44.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,12 +6,46 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## Unreleased
 
+## [0.19.0] 2021-03-25
+
+### Added
+- Support for Doctrine common v3
+
+### Changed
+- CI now uses the Symfony binary for `security:check` instead of the deprecated composer package
+- CI "latest" build now runs on PHP 7.4
+
+### Fixed
+- Compliance with newer version of php cs fixer
+
+## [0.18.0] 2020-12-09
+
+### Added
+- Support for multi-level filters
+
+### Changed
+- CI removes created images & volumes when finished
+
+## [0.17.7] 2020-02-14
+
+### Added
+- Support for Doctrine bundle v2
+
+### Fixed
+- Specified includes now get properly included on create requests
+- Headers argument being unintentionally cleared in when creating response
+
+## [0.17.6] 2020-01-21
+
+### Added
+- Support for empty data attribute to `ResponseBodyDecoder`
+
 ### Changed
 - Form validation errors now generate pointers from cause instead of origin
 
 ### Fixed
 - Form validation errors pointers now correctly target deep properties 
-- Specified includes now get properly included on create requests
+- Failing tests in newer PHPUnit bridge version
 
 ## [0.17.5] 2019-11-15
 
diff --git a/composer.json b/composer.json
@@ -17,7 +17,7 @@
     "symfony/monolog-bundle": "^3.4",
     "neomerx/json-api": "^1.0",
     "doctrine/orm": "^2.4",
-    "doctrine/common": "^2",
+    "doctrine/common": "^2|^3",
     "doctrine/doctrine-bundle": "^1.11|^2.0",
     "ext-json": "*",
     "symfony/property-access": "^3.4|^4.4"
@@ -29,7 +29,6 @@
     "justinrainbow/json-schema": "^1.6",
     "doctrine/doctrine-fixtures-bundle": "^3.3",
     "fzaninotto/faker": "^1.5",
-    "sensiolabs/security-checker": "^5",
     "symfony/twig-bundle": "^3.4|^4.4",
     "doctrine/cache": "^1.6",
     "symfony/debug-bundle": "^3.4|^4.4",
diff --git a/src/CompilerPass/SchemaAutoMapCompilerPass.php b/src/CompilerPass/SchemaAutoMapCompilerPass.php
@@ -113,43 +113,43 @@ private function getClassFQNFromFileName($file): string
         $class = false;
         $namespace = false;
         $tokens = token_get_all(file_get_contents($file));
-        if (1 === \count($tokens) && T_INLINE_HTML === $tokens[0][0]) {
+        if (1 === \count($tokens) && \T_INLINE_HTML === $tokens[0][0]) {
             return false;
         }
         for ($i = 0; isset($tokens[$i]); ++$i) {
             $token = $tokens[$i];
             if (!isset($token[1])) {
                 continue;
             }
-            if (true === $class && T_STRING === $token[0]) {
+            if (true === $class && \T_STRING === $token[0]) {
                 return $namespace . '\\' . $token[1];
             }
-            if (true === $namespace && T_STRING === $token[0]) {
+            if (true === $namespace && \T_STRING === $token[0]) {
                 $namespace = $token[1];
-                while (isset($tokens[++$i][1]) && \in_array($tokens[$i][0], [T_NS_SEPARATOR, T_STRING])) {
+                while (isset($tokens[++$i][1]) && \in_array($tokens[$i][0], [\T_NS_SEPARATOR, \T_STRING])) {
                     $namespace .= $tokens[$i][1];
                 }
                 $token = $tokens[$i];
             }
-            if (T_CLASS === $token[0]) {
+            if (\T_CLASS === $token[0]) {
                 // Skip usage of ::class constant and anonymous classes
                 $skipClassToken = false;
                 for ($j = $i - 1; $j > 0; --$j) {
                     if (!isset($tokens[$j][1])) {
                         break;
                     }
-                    if (T_DOUBLE_COLON === $tokens[$j][0] || T_NEW === $tokens[$j][0]) {
+                    if (\T_DOUBLE_COLON === $tokens[$j][0] || \T_NEW === $tokens[$j][0]) {
                         $skipClassToken = true;
                         break;
-                    } elseif (!\in_array($tokens[$j][0], [T_WHITESPACE, T_DOC_COMMENT, T_COMMENT])) {
+                    } elseif (!\in_array($tokens[$j][0], [\T_WHITESPACE, \T_DOC_COMMENT, \T_COMMENT])) {
                         break;
                     }
                 }
                 if (!$skipClassToken) {
                     $class = true;
                 }
             }
-            if (T_NAMESPACE === $token[0]) {
+            if (\T_NAMESPACE === $token[0]) {
                 $namespace = true;
             }
         }
diff --git a/src/Listener/KernelListener.php b/src/Listener/KernelListener.php
@@ -157,12 +157,10 @@ private function getResponseFromControllerResult($controllerResult, array $resul
         switch (true) {
             // if you have response from controller, check if it is valid
             case $controllerResult instanceof Response:
-
                 // TODO - this should never happen here? Response is called in kernelResponse
 
                 break;
             case $controllerResult instanceof DataResponse:
-
                 $resultMeta = array_merge($resultMeta, $controllerResult->getMeta());
                 $resultLinks = array_merge($resultLinks, $controllerResult->getLinks());
 
@@ -194,7 +192,6 @@ private function getResponseFromControllerResult($controllerResult, array $resul
 
             // if we got our collection encode it and package it in response
             case $controllerResult instanceof ObjectListCollectionInterface:
-
                 // append total from collection
                 $resultMeta['total'] = $controllerResult->getTotal();
 
@@ -210,7 +207,6 @@ private function getResponseFromControllerResult($controllerResult, array $resul
 
             // if you got array or object, try to encode it and package in response
             case \is_array($controllerResult) || \is_object($controllerResult):
-
                 $response = $this->responseFactory->createResponse($this->encode($controllerResult, $resultMeta,
                     $resultLinks));
 
@@ -220,7 +216,6 @@ private function getResponseFromControllerResult($controllerResult, array $resul
 
             // no content response?
             case null === $controllerResult:
-
                 $response = $this->responseFactory->createNoContent();
 
                 return $response;
diff --git a/src/Resources/doc/getting_started/examples/ExampleController.php b/src/Resources/doc/getting_started/examples/ExampleController.php
@@ -21,10 +21,10 @@
  */
 class ExampleController extends JsonApiController
 {
+    use CreateActionTrait;
+    use DeleteActionTrait;
     use IndexActionTrait;
     use ShowActionTrait;
-    use CreateActionTrait;
     use UpdateActionTrait;
-    use DeleteActionTrait;
     use UpdateRelationshipActionTrait;
 }
diff --git a/src/Services/ModelInput/AbstractFormModelInputHandler.php b/src/Services/ModelInput/AbstractFormModelInputHandler.php
@@ -2,7 +2,8 @@
 
 namespace Trikoder\JsonApiBundle\Services\ModelInput;
 
-use Doctrine\Common\Persistence\Proxy;
+use Doctrine\Common\Persistence\Proxy as LegacyProxy;
+use Doctrine\Persistence\Proxy;
 use Symfony\Component\Form\Extension\Validator\Constraints\Form;
 use Symfony\Component\Form\FormErrorIterator;
 use Symfony\Component\Form\FormInterface;
@@ -46,7 +47,7 @@ public function forModel($model)
         $this->model = $model;
 
         // make sure we are not working with doctrine proxy
-        if ($this->model instanceof Proxy) {
+        if ($this->model instanceof Proxy || $this->model instanceof LegacyProxy) {
             $this->modelClass = get_parent_class($this->model);
         } else {
             $this->modelClass = \get_class($this->model);
diff --git a/src/Services/ModelInput/DoctrineModelMetaData.php b/src/Services/ModelInput/DoctrineModelMetaData.php
@@ -4,17 +4,21 @@
 
 namespace Trikoder\JsonApiBundle\Services\ModelInput;
 
-use Doctrine\Common\Persistence\Mapping\ClassMetadata;
+use Doctrine\Common\Persistence\Mapping\ClassMetadata as LegacyClassMetadata;
+use Doctrine\Persistence\Mapping\ClassMetadata;
 use Trikoder\JsonApiBundle\Contracts\ModelTools\ModelMetaDataInterface;
 
 final class DoctrineModelMetaData implements ModelMetaDataInterface
 {
     /**
-     * @var ClassMetadata
+     * @var ClassMetadata|LegacyClassMetadata
      */
     private $classMetaData;
 
-    public function __construct(ClassMetadata $classMetaData)
+    /**
+     * @param ClassMetadata|LegacyClassMetadata $classMetaData
+     */
+    public function __construct($classMetaData)
     {
         $this->classMetaData = $classMetaData;
     }
diff --git a/src/Services/ModelInput/ModelMetaDataFactory.php b/src/Services/ModelInput/ModelMetaDataFactory.php
@@ -4,17 +4,21 @@
 
 namespace Trikoder\JsonApiBundle\Services\ModelInput;
 
-use Doctrine\Common\Persistence\ObjectManager;
+use Doctrine\Common\Persistence\ObjectManager as LegacyObjectManager;
+use Doctrine\Persistence\ObjectManager;
 use Trikoder\JsonApiBundle\Contracts\ModelTools\ModelMetaDataInterface;
 
 final class ModelMetaDataFactory
 {
     /**
-     * @var ObjectManager
+     * @var ObjectManager|LegacyObjectManager
      */
     private $objectManager;
 
-    public function __construct(ObjectManager $objectManager)
+    /**
+     * @param ObjectManager|LegacyObjectManager $objectManager
+     */
+    public function __construct($objectManager)
     {
         $this->objectManager = $objectManager;
     }
diff --git a/src/Services/Neomerx/Container.php b/src/Services/Neomerx/Container.php
@@ -2,7 +2,8 @@
 
 namespace Trikoder\JsonApiBundle\Services\Neomerx;
 
-use Doctrine\Common\Persistence\Proxy;
+use Doctrine\Common\Persistence\Proxy as LegacyProxy;
+use Doctrine\Persistence\Proxy;
 use InvalidArgumentException;
 use Neomerx\JsonApi\Contracts\Schema\SchemaFactoryInterface;
 use Neomerx\JsonApi\Contracts\Schema\SchemaProviderInterface;
@@ -43,7 +44,7 @@ public function __construct(
      */
     protected function getResourceType($resource)
     {
-        if ($resource instanceof Proxy) {
+        if ($resource instanceof Proxy || $resource instanceof LegacyProxy) {
             return get_parent_class($resource);
         }
 
diff --git a/src/Services/Neomerx/EncoderService.php b/src/Services/Neomerx/EncoderService.php
@@ -112,7 +112,7 @@ private function buildEncoderOptions()
     {
         $options = 0;
         if (true === $this->configurationEncodingPrettyPrint) {
-            $options += JSON_PRETTY_PRINT;
+            $options += \JSON_PRETTY_PRINT;
         }
         $this->encoderOptions = new EncoderOptions($options, '');
     }
diff --git a/tests/Integration/ExtensionTest.php b/tests/Integration/ExtensionTest.php
@@ -33,7 +33,7 @@ public function testKernelEventListenerEventPriorities()
             -10,
             $eventDispatcher->getListenerPriority(
                 KernelEvents::CONTROLLER_ARGUMENTS,
-                [$listener, 'onKernelControllerarguments']
+                [$listener, 'onKernelControllerArguments']
             )
         );
 
diff --git a/tests/Resources/Controller/Api/Test/VersionedUserController.php b/tests/Resources/Controller/Api/Test/VersionedUserController.php
@@ -22,9 +22,9 @@
  */
 class VersionedUserController extends JsonApiController
 {
+    use CreateActionTrait;
+    use DeleteActionTrait;
     use IndexActionTrait;
     use ShowActionTrait;
-    use CreateActionTrait;
     use UpdateActionTrait;
-    use DeleteActionTrait;
 }
diff --git a/tests/Resources/Controller/Api/User/ConfigRestrictionsUserController.php b/tests/Resources/Controller/Api/User/ConfigRestrictionsUserController.php
@@ -30,8 +30,8 @@
  */
 class ConfigRestrictionsUserController extends JsonApiController
 {
-    use IndexActionTrait;
     use CreateActionTrait;
-    use UpdateActionTrait;
+    use IndexActionTrait;
     use ShowActionTrait;
+    use UpdateActionTrait;
 }
diff --git a/tests/Resources/Controller/Api/User/PostController.php b/tests/Resources/Controller/Api/User/PostController.php
@@ -19,8 +19,8 @@
  */
 class PostController extends JsonApiController
 {
+    use CreateActionTrait;
     use IndexActionTrait;
     use ShowActionTrait;
-    use CreateActionTrait;
     use UpdateActionTrait;
 }
diff --git a/tests/Resources/Controller/Api/User/ProductController.php b/tests/Resources/Controller/Api/User/ProductController.php
@@ -19,8 +19,8 @@
  */
 class ProductController extends JsonApiController
 {
+    use CreateActionTrait;
     use IndexActionTrait;
     use ShowActionTrait;
-    use CreateActionTrait;
     use UpdateActionTrait;
 }
diff --git a/tests/Resources/Controller/Api/User/UserController.php b/tests/Resources/Controller/Api/User/UserController.php
@@ -28,10 +28,10 @@
  */
 class UserController extends JsonApiController
 {
+    use CreateActionTrait;
+    use DeleteActionTrait;
     use IndexActionTrait;
     use ShowActionTrait;
-    use CreateActionTrait;
     use UpdateActionTrait;
-    use DeleteActionTrait;
     use UpdateRelationshipActionTrait;
 }
diff --git a/tests/Resources/app/AppKernel.php b/tests/Resources/app/AppKernel.php
@@ -1,5 +1,7 @@
 <?php
 
+use Doctrine\Common\Persistence\ObjectManager as LegacyObjectManager;
+use Doctrine\Persistence\ObjectManager;
 use Symfony\Component\Config\Loader\LoaderInterface;
 use Symfony\Component\HttpKernel\Kernel;
 
@@ -38,4 +40,12 @@ public function registerContainerConfiguration(LoaderInterface $loader)
     {
         $loader->load(__DIR__ . '/config/config.yml');
     }
+
+    public function boot()
+    {
+        if (!$this->booted && !interface_exists(LegacyObjectManager::class)) {
+            class_alias(ObjectManager::class, LegacyObjectManager::class);
+        }
+        parent::boot();
+    }
 }
diff --git a/tests/Resources/docker/bin/test.sh b/tests/Resources/docker/bin/test.sh
@@ -6,4 +6,4 @@ docker-compose run --no-deps --rm php rm -rf tests/Resources/app/cache/test/* va
 
 docker-compose run --no-deps --rm php vendor/bin/phpunit --debug --coverage-text=php://stdout --coverage-html=logs/coverage
 
-docker-compose run --no-deps --rm php php vendor/bin/security-checker security:check composer.lock
+docker-compose run --no-deps --rm php symfony security:check
diff --git a/tests/Resources/docker/docker-compose.yml b/tests/Resources/docker/docker-compose.yml
@@ -6,6 +6,9 @@ services:
     build:
           context: php
           dockerfile: Dockerfile
+          args:
+              PHP_VERSION_MAJOR: ${PHP_VERSION_MAJOR:-7}
+              PHP_VERSION_MINOR: ${PHP_VERSION_MINOR:-2}
     volumes:
       - ../../../:/usr/src/bundle #mount bundle root
     links:
diff --git a/tests/Resources/docker/php/Dockerfile b/tests/Resources/docker/php/Dockerfile
diff --git a/tests/Unit/Controller/Traits/IndexTraitTest.php b/tests/Unit/Controller/Traits/IndexTraitTest.php

Original file line number	Diff line number	Diff line change
`@@ -113,43 +113,43 @@ private function getClassFQNFromFileName($file): string`
`113`	`113`	`$class = false;`
`114`	`114`	`$namespace = false;`
`115`	`115`	`$tokens = token_get_all(file_get_contents($file));`
`116`		`- if (1 === \count($tokens) && T_INLINE_HTML === $tokens[0][0]) {`
	`116`	`+ if (1 === \count($tokens) && \T_INLINE_HTML === $tokens[0][0]) {`
`117`	`117`	`return false;`
`118`	`118`	`}`
`119`	`119`	`for ($i = 0; isset($tokens[$i]); ++$i) {`
`120`	`120`	`$token = $tokens[$i];`
`121`	`121`	`if (!isset($token[1])) {`
`122`	`122`	`continue;`
`123`	`123`	`}`
`124`		`- if (true === $class && T_STRING === $token[0]) {`
	`124`	`+ if (true === $class && \T_STRING === $token[0]) {`
`125`	`125`	`return $namespace . '\\' . $token[1];`
`126`	`126`	`}`
`127`		`- if (true === $namespace && T_STRING === $token[0]) {`
	`127`	`+ if (true === $namespace && \T_STRING === $token[0]) {`
`128`	`128`	`$namespace = $token[1];`
`129`		`- while (isset($tokens[++$i][1]) && \in_array($tokens[$i][0], [T_NS_SEPARATOR, T_STRING])) {`
	`129`	`+ while (isset($tokens[++$i][1]) && \in_array($tokens[$i][0], [\T_NS_SEPARATOR, \T_STRING])) {`
`130`	`130`	`$namespace .= $tokens[$i][1];`
`131`	`131`	`}`
`132`	`132`	`$token = $tokens[$i];`
`133`	`133`	`}`
`134`		`- if (T_CLASS === $token[0]) {`
	`134`	`+ if (\T_CLASS === $token[0]) {`
`135`	`135`	`// Skip usage of ::class constant and anonymous classes`
`136`	`136`	`$skipClassToken = false;`
`137`	`137`	`for ($j = $i - 1; $j > 0; --$j) {`
`138`	`138`	`if (!isset($tokens[$j][1])) {`
`139`	`139`	`break;`
`140`	`140`	`}`
`141`		`- if (T_DOUBLE_COLON === $tokens[$j][0] \|\| T_NEW === $tokens[$j][0]) {`
	`141`	`+ if (\T_DOUBLE_COLON === $tokens[$j][0] \|\| \T_NEW === $tokens[$j][0]) {`
`142`	`142`	`$skipClassToken = true;`
`143`	`143`	`break;`
`144`		`- } elseif (!\in_array($tokens[$j][0], [T_WHITESPACE, T_DOC_COMMENT, T_COMMENT])) {`
	`144`	`+ } elseif (!\in_array($tokens[$j][0], [\T_WHITESPACE, \T_DOC_COMMENT, \T_COMMENT])) {`
`145`	`145`	`break;`
`146`	`146`	`}`
`147`	`147`	`}`
`148`	`148`	`if (!$skipClassToken) {`
`149`	`149`	`$class = true;`
`150`	`150`	`}`
`151`	`151`	`}`
`152`		`- if (T_NAMESPACE === $token[0]) {`
	`152`	`+ if (\T_NAMESPACE === $token[0]) {`
`153`	`153`	`$namespace = true;`
`154`	`154`	`}`
`155`	`155`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,10 +21,10 @@`
`21`	`21`	`*/`
`22`	`22`	`class ExampleController extends JsonApiController`
`23`	`23`	`{`
	`24`	`+ use CreateActionTrait;`
	`25`	`+ use DeleteActionTrait;`
`24`	`26`	`use IndexActionTrait;`
`25`	`27`	`use ShowActionTrait;`
`26`		`- use CreateActionTrait;`
`27`	`28`	`use UpdateActionTrait;`
`28`		`- use DeleteActionTrait;`
`29`	`29`	`use UpdateRelationshipActionTrait;`
`30`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@ private function buildEncoderOptions()`
`112`	`112`	`{`
`113`	`113`	`$options = 0;`
`114`	`114`	`if (true === $this->configurationEncodingPrettyPrint) {`
`115`		`- $options += JSON_PRETTY_PRINT;`
	`115`	`+ $options += \JSON_PRETTY_PRINT;`
`116`	`116`	`}`
`117`	`117`	`$this->encoderOptions = new EncoderOptions($options, '');`
`118`	`118`	`}`