Merge pull request #12 from FreeElephants/develop

v0.0.10

Author: samizdam

CHANGELOG.md

@@ -8,6 +8,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Data Transfer Object classes generation from swagger spec
 
+## [0.0.10] - 2020-07-19
+### Added
+- AbstractDocument::fromHttpMessage(), possible constructing DTO from Response and Requests both
+- PsrContainerAwareSchemaContainer for injection dependencies to neomerx Schemas
+
+### Changed:
+- Mark AbstractDocument::__constructor as final
+- Extended neomerx Encoder and Factory don't use EntityManager, but use Psr\Container 
+
+### Deprecated
+- AbstractDocument::fromRequest, use fromHttpMessage instead
+
+### Removed
+- DoctrineProxyAwareSchemaContainer, use PsrContainerAwareSchemaContainer: it is check Doctrine Proxies too. 
+
 ## [0.0.9] - 2020-07-08
 ### Added
 - Typed attributes fields support and nested key-value structures in DTO
@@ -67,8 +82,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - FastRoute Dispatcher generation from swagger operationIds
 
-[Unreleased]: https://github.com/FreeElephants/json-api-php-toolkit/compare/0.0.9...HEAD
-[0.0.8]: https://github.com/FreeElephants/json-api-php-toolkit/compare/0.0.8...0.0.9
+[Unreleased]: https://github.com/FreeElephants/json-api-php-toolkit/compare/0.0.10...HEAD
+[0.0.10]: https://github.com/FreeElephants/json-api-php-toolkit/compare/0.0.9...0.0.10
+[0.0.9]: https://github.com/FreeElephants/json-api-php-toolkit/compare/0.0.8...0.0.9
 [0.0.8]: https://github.com/FreeElephants/json-api-php-toolkit/compare/0.0.7...0.0.8
 [0.0.7]: https://github.com/FreeElephants/json-api-php-toolkit/compare/0.0.6...0.0.7
 [0.0.6]: https://github.com/FreeElephants/json-api-php-toolkit/compare/0.0.5...0.0.6

docs/doctrine.md

@@ -7,22 +7,19 @@ Doctrine wrap your own class to Proxy, this issues explained in https://github.c
 Library provide solution for it. Example of dependency injection ([free-elephants/di](https://github.com/FreeElephants/php-di) container configuration):
 
 ```php
-
-use Doctrine\ORM\EntityManagerInterface;
+# index.php 
 use FreeElephants\DI\InjectorBuilder;
 use FreeElephants\JsonApiToolkit\Neomerx\Encoder;
 use Neomerx\JsonApi\Contracts\Encoder\EncoderInterface;
 
-/** @var EntityManagerInterface $entityManager */
-$entityManager = require 'bootstrap.php'; // your configuration file for doctrine
-$schemas = require_once 'jsonapi-schemas.php'; // your json:api schemas map for neomerx encoder
+$components = require_once 'components.php'; 
+$container = (new InjectorBuilder())->buildFromArray($components);
 
-Encoder::setEntityManager($entityManager);
+Encoder::setPsrContainer($container);
+$schemas = require_once 'jsonapi-schemas.php'; // your json:api schemas map for neomerx encoder
+$jsonApiEncoder = Encoder::instance($schemas);
 
-return [
-    InjectorBuilder::INSTANCES_KEY => [
-        EncoderInterface::class => Encoder::instance($schemas),
-    ]
-];
+$container->setService(EncoderInterface::class, $jsonApiEncoder);
 
+// other application code
 ```

docs/dto-psr7.md

@@ -1,5 +1,5 @@
-# Build Data Transfer Objects from PSR7 ServerRequests
+# Build Data Transfer Objects from PSR7 Messages
 
-Full typed objects from request body.
+Full typed objects from request or response body.
 
 See example in [test](/tests/FreeElephants/JsonApiToolkit/DTO/DocumentTest.php). 

src/FreeElephants/JsonApiToolkit/DTO/AbstractDocument.php

@@ -2,25 +2,37 @@
 
 namespace FreeElephants\JsonApiToolkit\DTO;
 
+use Psr\Http\Message\MessageInterface;
 use Psr\Http\Message\ServerRequestInterface;
 
 /**
- * @property AbstractResourceObject $data
+ * @property AbstractResourceObject|mixed $data
  */
 abstract class AbstractDocument
 {
-    public function __construct(array $data)
+    final public function __construct(array $data)
     {
         $concreteClass = new \ReflectionClass($this);
         $dataProperty = $concreteClass->getProperty('data');
-        $dataClassName = $dataProperty->getType()->getName();
+        /** @var \ReflectionNamedType $reflectionType */
+        $reflectionType = $dataProperty->getType();
+        $dataClassName = $reflectionType->getName();
         $this->data = new $dataClassName($data['data']);
     }
 
-    public static function fromRequest(ServerRequestInterface $request): self
+    /**
+     * @deprecated
+     * @see AbstractDocument::fromHttpMessage() instead
+     */
+    public static function fromRequest(ServerRequestInterface $httpMessage): self
     {
-        $request->getBody()->rewind();
-        $rawJson = $request->getBody()->getContents();
+        return self::fromHttpMessage($httpMessage);
+    }
+
+    public static function fromHttpMessage(MessageInterface $httpMessage): self
+    {
+        $httpMessage->getBody()->rewind();
+        $rawJson = $httpMessage->getBody()->getContents();
         $decodedJson = json_decode($rawJson, true);
 
         return new static($decodedJson);

src/FreeElephants/JsonApiToolkit/DTO/RelationshipToOne.php

@@ -2,23 +2,7 @@
 
 namespace FreeElephants\JsonApiToolkit\DTO;
 
-use Psr\Http\Message\ServerRequestInterface;
-
-class RelationshipToOne
+class RelationshipToOne extends AbstractDocument
 {
     public ResourceIdentifierObject $data;
-
-    public function __construct($data)
-    {
-        $this->data = new ResourceIdentifierObject($data['data']);
-    }
-
-    public static function fromRequest(ServerRequestInterface $request): self
-    {
-        $request->getBody()->rewind();
-        $rawJson = $request->getBody()->getContents();
-        $decodedJson = json_decode($rawJson, true);
-
-        return new self($decodedJson);
-    }
 }

src/FreeElephants/JsonApiToolkit/Neomerx/Doctrine/DoctrineProxyAwareSchemaContainer.php

@@ -2,21 +2,21 @@
 
 namespace FreeElephants\JsonApiToolkit\Neomerx;
 
-use Doctrine\ORM\EntityManagerInterface;
 use Neomerx\JsonApi\Contracts\Factories\FactoryInterface;
 use Neomerx\JsonApi\Encoder\Encoder as NeomerxEncoder;
+use Psr\Container\ContainerInterface;
 
 class Encoder extends NeomerxEncoder
 {
-    private static EntityManagerInterface $entityManager;
+    private static ContainerInterface $container;
 
-    public static function setEntityManager(EntityManagerInterface $entityManager)
+    public static function setPsrContainer(ContainerInterface $container)
     {
-        self::$entityManager = $entityManager;
+        self::$container = $container;
     }
 
     protected static function createFactory(): FactoryInterface
     {
-        return new Factory(self::$entityManager);
+        return new Factory(self::$container);
     }
 }

src/FreeElephants/JsonApiToolkit/Neomerx/Encoder.php

@@ -2,22 +2,21 @@
 
 namespace FreeElephants\JsonApiToolkit\Neomerx;
 
-use Doctrine\ORM\EntityManagerInterface;
-use FreeElephants\JsonApiToolkit\Neomerx\Doctrine\DoctrineProxyAwareSchemaContainer;
 use Neomerx\JsonApi\Contracts\Schema\SchemaContainerInterface;
 use Neomerx\JsonApi\Factories\Factory as NeomerxFactory;
+use Psr\Container\ContainerInterface;
 
 class Factory extends NeomerxFactory
 {
-    private EntityManagerInterface $entityManager;
+    private ContainerInterface $container;
 
-    public function __construct(EntityManagerInterface $entityManager)
+    public function __construct(ContainerInterface $container)
     {
-        $this->entityManager = $entityManager;
+        $this->container = $container;
     }
 
     public function createSchemaContainer(iterable $schemas): SchemaContainerInterface
     {
-        return new DoctrineProxyAwareSchemaContainer($this->entityManager, $this, $schemas);
+        return new PsrContainerAwareSchemaContainer($this->container, $this, $schemas);
     }
 }

src/FreeElephants/JsonApiToolkit/Neomerx/Factory.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace FreeElephants\JsonApiToolkit\Neomerx;
+
+use Doctrine\Persistence\Proxy;
+use Neomerx\JsonApi\Contracts\Factories\FactoryInterface;
+use Neomerx\JsonApi\Contracts\Schema\SchemaInterface;
+use Neomerx\JsonApi\Schema\SchemaContainer;
+use Psr\Container\ContainerInterface;
+
+/**
+ * Instantiate Schemas via Psr\Container.
+ */
+class PsrContainerAwareSchemaContainer extends SchemaContainer
+{
+    private ContainerInterface $container;
+
+    public function __construct(ContainerInterface $container, FactoryInterface $factory, iterable $schemas)
+    {
+        $this->container = $container;
+        parent::__construct($factory, $schemas);
+    }
+
+    /**
+     * Clear Doctrine Entity Proxies class names.
+     */
+    protected function getResourceType($resource): string
+    {
+        $class = get_class($resource);
+        $pos = strrpos($class, '\\' . Proxy::MARKER . '\\');
+
+        if ($pos === false) {
+            return $class;
+        }
+
+        return substr($class, $pos + Proxy::MARKER_LENGTH + 2);
+    }
+
+    protected function createSchemaFromClassName(string $className): SchemaInterface
+    {
+        return $this->container->get($className);
+    }
+}

src/FreeElephants/JsonApiToolkit/Neomerx/PsrContainerAwareSchemaContainer.php

@@ -30,7 +30,7 @@ public function testFromRequest()
 JSON
         );
 
-        $fooDTO = FooDocument::fromRequest($request);
+        $fooDTO = FooDocument::fromHttpMessage($request);
 
         $this->assertInstanceOf(FooResource::class, $fooDTO->data);
         $this->assertInstanceOf(FooAttributes::class, $fooDTO->data->attributes);