Update from internal 0.16 release

Author: alenpokos

.gitignore

@@ -5,5 +5,7 @@
 tests/Resources/app/cache/
 tests/Resources/app/data/
 tests/Resources/app/logs/
+/var/
 docker-compose.override.yml
 /.php_cs.cache
+/var

.gitlab-ci.yml

@@ -25,6 +25,20 @@ ci-latest:
     - docker-compose run --no-deps --rm php php vendor/bin/phpunit --debug --colors=never --coverage-text=php://stdout --coverage-html=logs/coverage
     - bin/php php ../../../vendor/bin/security-checker security:check ../../../composer.lock
 
+# symfony 4.2 build
+ci-symfony4.2:
+  stage: test-versions
+  tags:
+      - docker-compose
+  script:
+    - cd tests/Resources/docker/
+    - docker-compose build
+    - docker-compose up -d
+    - bin/composer require "symfony/framework-bundle:^4.2" "symfony/form:^4.2" "symfony/validator:^4.2" --no-interaction --no-ansi --prefer-dist
+    - docker-compose run --no-deps --rm php composer install --no-interaction --no-ansi --prefer-dist
+    - bin/setup_fixtures.sh
+    - docker-compose run --no-deps --rm php php vendor/bin/phpunit --debug --colors=never
+
 # symfony 4.1 build
 ci-symfony4.1:
   stage: test-versions
@@ -63,7 +77,7 @@ ci-symfony3.4:
     - docker-compose build
     - docker-compose up -d
     - mv -f ../app/config/symfony34/config.yml ../app/config/
-    - bin/composer require "symfony/framework-bundle:^3.4" "symfony/form:^3.4" "symfony/validator:^3.4" --no-interaction --no-ansi --prefer-dist
+    - bin/composer require "symfony/framework-bundle:^3.4" "symfony/form:^3.4" "symfony/validator:^3.4" "symfony/config:^3.4" "symfony/translation:^3.4" "symfony/http-foundation:^3.4" "symfony/http-kernel:^3.4" "symfony/twig-bundle:^3.4" --no-interaction --no-ansi --prefer-dist
     - docker-compose run --no-deps --rm php composer install --no-interaction --no-ansi --prefer-dist
     - bin/setup_fixtures.sh
     - docker-compose run --no-deps --rm php php vendor/bin/phpunit --debug --colors=never
@@ -78,7 +92,7 @@ ci-symfony3.3:
     - docker-compose build
     - docker-compose up -d
     - mv -f ../app/config/symfony34/config.yml ../app/config/
-    - bin/composer require "symfony/framework-bundle:^3.3" "symfony/form:^3.3" "symfony/validator:^3.3" --no-interaction --no-ansi --prefer-dist
+    - bin/composer require "symfony/framework-bundle:^3.3" "symfony/form:^3.3" "symfony/validator:^3.3" "symfony/config:^3.3" "symfony/translation:^3.3" "symfony/http-foundation:^3.3" "symfony/http-kernel:^3.3" "symfony/twig-bundle:^3.3" --no-interaction --no-ansi --prefer-dist
     - docker-compose run --no-deps --rm php composer install --no-interaction --no-ansi --prefer-dist
     - bin/setup_fixtures.sh
     - docker-compose run --no-deps --rm php php vendor/bin/phpunit --debug --colors=never
@@ -94,7 +108,7 @@ ci-symfony3.2:
     - docker-compose build
     - docker-compose up -d
     - mv -f ../app/config/symfony34/config.yml ../app/config/
-    - bin/composer require "symfony/framework-bundle:^3.2" "symfony/form:^3.2" "symfony/validator:^3.2" --no-interaction --no-ansi --prefer-dist
+    - bin/composer require "symfony/framework-bundle:^3.2" "symfony/form:^3.2" "symfony/validator:^3.2" "symfony/config:^3.2" "symfony/translation:^3.2" "symfony/http-foundation:^3.2" "symfony/http-kernel:^3.2" "symfony/twig-bundle:^3.2" --no-interaction --no-ansi --prefer-dist
     - docker-compose run --no-deps --rm php composer install --no-interaction --no-ansi --prefer-dist
     - bin/setup_fixtures.sh
     - docker-compose run --no-deps --rm php php vendor/bin/phpunit --debug --colors=never
@@ -110,7 +124,7 @@ ci-symfony3.1:
     - docker-compose build
     - docker-compose up -d
     - mv -f ../app/config/symfony34/config.yml ../app/config/
-    - bin/composer require "symfony/framework-bundle:^3.1" "symfony/form:^3.1" "symfony/validator:^3.1" --no-interaction --no-ansi --prefer-dist
+    - bin/composer require "symfony/framework-bundle:^3.1" "symfony/form:^3.1" "symfony/validator:^3.1" "symfony/config:^3.1" "symfony/translation:^3.1" "symfony/http-foundation:^3.1" "symfony/http-kernel:^3.1" "symfony/twig-bundle:^3.1" --no-interaction --no-ansi --prefer-dist
     - docker-compose run --no-deps --rm php composer install --no-interaction --no-ansi --prefer-dist
     - bin/setup_fixtures.sh
     - docker-compose run --no-deps --rm php php vendor/bin/phpunit --debug --colors=never

CHANGELOG.md

@@ -6,6 +6,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## Unreleased
 
+## [0.16.0] 2019-02-14
+
+### Added
+- `GenericFormModelInputHandler` can now auto-magicaly handle PHP objects using return typehints, see `GenericModelMetaData`
+
+### Changed
+- `Trikoder\JsonApiBundle\Contracts\RepositoryInterface::save` can now return a object that is saved
+- InputHandlers will now throw `UnhandleableModelInputException` exceptions when input cannot be properly handled onto model
+
+
 ## [0.14.0] 2018-10-23
 
 ### Added
@@ -20,8 +30,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Changed
 - Changed route annotation use to symfony/routing, previously was sensio/framework-extra-bundle
-- Added symfony/routing as dependancy on 3.4
-- Added "doctrine/common": "<2.9" as dependancy to cover deprication notices
+- Added symfony/routing as dependency on 3.4
+- Added "doctrine/common": "<2.9" as dependency to cover deprecation notices
 
 ### Removed
 - Removed second argument (ServiceContainer) of schema as closure definition. see [Manual](src/Resources/doc/getting_started/schema_class_map.md)

README.md

@@ -40,7 +40,7 @@ Change log for the project can be found in changelog.md
 
 ## Testing
 
-The whole sandbox and development enviroment is located inside project.
+The whole sandbox and development environment is located inside project.
 
 To run tests, position yourself inside `tests/Resources/docker` and run `bin/test.sh`
 This will build whole docker setup, load fixtures and run all test suites.
@@ -56,15 +56,15 @@ There is also php access script `bin/php [CMD]` (eg. `bin/php bash` to enter bas
 
 ### Coding standards
 
-When contributing to this package, you will need to adhere to our conding standards.
+When contributing to this package, you will need to adhere to our coding standards.
 They are following PSR-2 with some additional rules. To check your code during development
 you can use provided config for php-cs-fixer. it's in root of the project, file:
 
 `.php_cs.dist`
 
 **Checking your code**
 
-First you need to setup test enviroment (as described in paragraph above).
+First you need to setup test environment (as described in paragraph above).
 
 Then:
 
@@ -73,7 +73,7 @@ Checking code:
 ```
 bin/php_cs --dry-run
 ```
-If you want automatic fix, just ommit ``--dry-run`:
+If you want automatic fix, just omit ``--dry-run`:
 
 ```
 bin/php_cs

composer.json

@@ -4,19 +4,22 @@
   "type": "symfony-bundle",
   "require": {
     "php": ">=7.0.0|>=7.1.0",
-    "symfony/framework-bundle": ">=3.1 <5.0",
-    "symfony/dependency-injection": ">=3.1 <5.0",
+    "symfony/framework-bundle": ">=3.1 <5",
+    "symfony/dependency-injection": ">=3.1 <5",
+    "symfony/config": ">=3.1 <5",
     "sensio/framework-extra-bundle": ">3.0|^5.1|^5.2",
+    "symfony/http-foundation": ">=3.1 <5",
     "symfony/form": ">=3.1 <5.0",
-    "symfony/routing": ">=3.1 <5.0",
+    "symfony/routing": ">=3.1 <4.1.8",
     "symfony/security-bundle": "^3.1|^4.0",
-    "symfony/translation": ">=3.1 <5.0",
+    "symfony/translation": ">=3.1 <5",
     "symfony/validator": ">=3.1 <5.0",
     "symfony/monolog-bundle": ">=3.1 <5.0",
     "neomerx/json-api": "^1.0",
     "doctrine/orm": "^2.4",
     "doctrine/common": "^2",
-    "doctrine/doctrine-bundle": "~1.6|^1.8|^1.9"
+    "doctrine/doctrine-bundle": "~1.6|^1.8|^1.9",
+    "ext-json": "*"
   },
   "require-dev": {
     "phpunit/phpunit": "^5.7",

phpunit.xml.dist

@@ -31,6 +31,7 @@
                 <directory>./src/Resources/doc</directory>
                 <directory>./tests</directory>
                 <directory>./vendor</directory>
+                <directory>./var</directory>
                 <file>./src/DependencyInjection/TrikoderJsonApiExtension.php</file>
             </exclude>
         </whitelist>

src/Bridge/Doctrine/DoctrineRepository.php

@@ -61,6 +61,8 @@ public function save($model)
     {
         $this->entityManager->persist($model);
         $this->entityManager->flush();
+
+        return $model;
     }
 
     /**

src/CompilerPass/SchemaAutoMapCompilerPass.php

@@ -27,7 +27,10 @@ public function process(ContainerBuilder $container)
 
             $schemaDirScanPatterns = $config['schema_automap_scan_patterns'];
 
-            $schemaFilenames = $this->getSchemaFilenames($schemaDirScanPatterns);
+            $schemaFilenames = $this->getSchemaFilenames(
+                $this->processSchemaDirScanPatterns($schemaDirScanPatterns,
+                    $container->getParameter('kernel.project_dir'))
+            );
 
             foreach ($schemaFilenames as $schemaFilename) {
                 // we need fqn for reflection and service definition changes
@@ -42,6 +45,15 @@ public function process(ContainerBuilder $container)
         }
     }
 
+    protected function processSchemaDirScanPatterns(array $schemaDirScanPatterns, string $rootDir): array
+    {
+        foreach ($schemaDirScanPatterns as $key => $pattern) {
+            $schemaDirScanPatterns[$key] = $rootDir . '/' . $pattern;
+        }
+
+        return $schemaDirScanPatterns;
+    }
+
     /**
      * @return string[]
      */

src/Contracts/ModelTools/ModelInputHandlerInterface.php

@@ -2,6 +2,8 @@
 
 namespace Trikoder\JsonApiBundle\Contracts\ModelTools;
 
+use Trikoder\JsonApiBundle\Services\ModelInput\UnhandleableModelInputException;
+
 /**
  * Interface ModelInputHandlerInterface
  */
@@ -11,11 +13,12 @@ interface ModelInputHandlerInterface
      * @param object $model
      *
      * @return $this
-     * TODO - check if better in contructor so it cannot be changed on runtime?
      */
     public function forModel($model);
 
     /**
+     * @throws UnhandleableModelInputException
+     *
      * @return $this
      */
     public function handle(array $input);

src/Contracts/ModelTools/ModelMetaDataInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Trikoder\JsonApiBundle\Contracts\ModelTools;
+
+interface ModelMetaDataInterface
+{
+    public function getAllFields(): array;
+
+    /**
+     * @return null|string
+     */
+    public function getTypeForField(string $fieldName);
+}

src/Contracts/RepositoryInterface.php

@@ -30,7 +30,8 @@ public function getOne($id, $filter = []);
      * Saves model to arbitrary persistance layer
      *
      * @param object $model model to save
-     * TODO - check return values
+     *
+     * @return null|object null or newly saved object
      */
     public function save($model);
 

src/Contracts/RequestBodyDecoderInterface.php

@@ -2,12 +2,14 @@
 
 namespace Trikoder\JsonApiBundle\Contracts;
 
+use Trikoder\JsonApiBundle\Services\RequestDecoder\Exception\InvalidBodyForMethodException;
+
 interface RequestBodyDecoderInterface
 {
     /**
-     * @param array $body
+     * @return array
      *
-     * @return null|array
+     * @throws InvalidBodyForMethodException
      */
-    public function decode(array $body = null);
+    public function decode(string $requestMethod, array $body = []);
 }

src/Contracts/RequestBodyValidatorInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Trikoder\JsonApiBundle\Contracts;
+
+use Trikoder\JsonApiBundle\Services\RequestDecoder\Exception\InvalidBodyForMethodException;
+
+interface RequestBodyValidatorInterface
+{
+    /**
+     * @throws InvalidBodyForMethodException
+     */
+    public function validate(string $requestMethod, array $body);
+}

src/Contracts/ResponseFactoryInterface.php

@@ -40,4 +40,9 @@ public function createError(string $data, Response $response = null): Response;
      * @param Response $response
      */
     public function createErrorFromException(Exception $exception, Response $response = null): Response;
+
+    /**
+     * @param Response $response
+     */
+    public function createBadRequest(string $data, Response $response = null): Response;
 }

src/Controller/Traits/Actions/CreateTrait.php

@@ -5,14 +5,17 @@
 use RuntimeException;
 use Symfony\Bundle\FrameworkBundle\Routing\Router;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 use Symfony\Component\Routing\Route;
 use Symfony\Component\Routing\RouterInterface;
 use Trikoder\JsonApiBundle\Contracts\Config\ConfigInterface;
 use Trikoder\JsonApiBundle\Contracts\ModelTools\ModelInputHandlerInterface;
 use Trikoder\JsonApiBundle\Contracts\ModelTools\ModelValidatorInterface;
+use Trikoder\JsonApiBundle\Contracts\RepositoryInterface;
 use Trikoder\JsonApiBundle\Contracts\ResponseFactoryInterface;
 use Trikoder\JsonApiBundle\Contracts\SchemaClassMapProviderInterface;
 use Trikoder\JsonApiBundle\Services\ModelInput\ModelValidationException;
+use Trikoder\JsonApiBundle\Services\ModelInput\UnhandleableModelInputException;
 use Trikoder\JsonApiBundle\Services\Neomerx\EncoderService;
 
 /**
@@ -26,6 +29,7 @@ trait CreateTrait
      * @return object
      *
      * @throws ModelValidationException
+     * @throws UnhandleableModelInputException
      */
     protected function handleCreateModelInputFromRequest(ConfigInterface $config, $emptyModel, Request $request)
     {
@@ -52,6 +56,7 @@ protected function handleCreateModelInputFromRequest(ConfigInterface $config, $e
                 $modelInput[$filesKey] = $filesValue;
             }
         }
+
         $model = $handler->forModel($emptyModel)->handle($modelInput)->getResult();
 
         // validate result
@@ -69,6 +74,7 @@ protected function handleCreateModelInputFromRequest(ConfigInterface $config, $e
      * @param object $model
      *
      * @throws ModelValidationException
+     * @throws UnhandleableModelInputException
      */
     protected function validateCreatedModel(ConfigInterface $config, $model)
     {
@@ -95,6 +101,7 @@ protected function validateCreatedModel(ConfigInterface $config, $model)
      * @return object
      *
      * @throws ModelValidationException
+     * @throws UnhandleableModelInputException
      */
     protected function createModelFromRequest(Request $request)
     {
@@ -111,8 +118,20 @@ protected function createModelFromRequest(Request $request)
 
         $this->validateCreatedModel($config, $model);
 
+        /** @var RepositoryInterface $repository */
+        $repository = $config->getApi()->getRepository();
+
         // save it
-        $config->getApi()->getRepository()->save($model);
+        $saveResult = $repository->save($model);
+        // if repository returned result, we take it as new model
+        if (null !== $saveResult) {
+            // if repository returned different class for model, we consider it error
+            if (false === ($saveResult instanceof $model)) {
+                throw new \LogicException(sprintf('Repository result is not a valid, expected object of type %s, got %s', \get_class($model), \get_class($saveResult)));
+            }
+
+            return $saveResult;
+        }
 
         return $model;
     }
@@ -134,9 +153,16 @@ protected function createCreatedFromRequest(Request $request)
         try {
             $model = $this->createModelFromRequest($request);
         } catch (ModelValidationException $modelValidationException) {
-            // TODO this should return conflict response (similar to DataResponse) or HttConflictException
             $response = $responseFactory->createConflict($encoder->encodeErrors($modelValidationException->getViolations()));
 
+            return $response;
+        } catch (UnhandleableModelInputException $unhandleableModelInputException) {
+            if ($unhandleableModelInputException->getPrevious() instanceof ModelValidationException && $unhandleableModelInputException->getPrevious()->hasViolations()) {
+                $response = $responseFactory->createConflict($encoder->encodeErrors($unhandleableModelInputException->getPrevious()->getViolations()));
+            } else {
+                $response = $responseFactory->createErrorFromException(new BadRequestHttpException($unhandleableModelInputException->getMessage()));
+            }
+
             return $response;
         }