DataTransferObjectCreatorTest::itCanCreateADto() - Code Metrics - Inspection of "Required relations" - edmondscommerce/doctrine-static-meta - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#152)

by joseph
created 2018-10-29 17:36 UTC
DataTransferObjectCreatorTest::itCanCreateADto() A

↳ Parent: DataTransferObjectCreatorTest
Complexity

Conditions	1
Paths	1
Size

Total Lines	9
Code Lines	6
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	6
nc	1
nop	0
dl	0
loc	9
rs	10
c	0
b	0
f	0
<?php declare(strict_types=1);

namespace EdmondsCommerce\DoctrineStaticMeta\Tests\Medium\CodeGeneration\Creation\Src\Entity\DataTransferObjects;

use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\CodeHelper;
use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Creation\Src\Entity\DataTransferObjects\DtoCreator;
use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Filesystem\Factory\FileFactory;
use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Filesystem\Factory\FindReplaceFactory;
use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Filesystem\File;
use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Filesystem\File\Writer;
use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\NamespaceHelper;
use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\ReflectionHelper;
use EdmondsCommerce\DoctrineStaticMeta\Config;
use EdmondsCommerce\DoctrineStaticMeta\Tests\Assets\AbstractTest;
use EdmondsCommerce\DoctrineStaticMeta\Tests\Small\ConfigTest;

/**
 * @covers \EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Creation\Src\Entity\DataTransferObjects\DtoCreator
 * @medium
 */
class DataTransferObjectCreatorTest extends AbstractTest
{
    public const WORK_DIR = self::VAR_PATH . '/' . self::TEST_TYPE_MEDIUM . '/DataTransferObjectCreatorTest';
// phpcs:disable
    private const DTO = <<<'PHP'
<?php declare(strict_types=1);
// phpcs:disable Generic.Files.LineLength.TooLong
namespace My\Test\Project\Entity\DataTransferObjects;

use Doctrine\Common\Collections\ArrayCollection;
use EdmondsCommerce\DoctrineStaticMeta\Entity\Debug\DebugEntityDataObjectIds;
use EdmondsCommerce\DoctrineStaticMeta\Entity\Interfaces\DataTransferObjectInterface;
use EdmondsCommerce\DoctrineStaticMeta\Entity\Interfaces\EntityInterface;
use EdmondsCommerce\DoctrineStaticMeta\Exception\DoctrineStaticMetaException;
use Ramsey\Uuid\UuidInterface;
use Symfony\Component\Validator\Mapping\ClassMetadata as ValidatorClassMetaData;
use My\Test\Project\Entities\Person;

/**
 * This data transfer object should be used to hold potentially unvalidated update data,
 * ready to be fed into the Entity::update method
 *
 * You can choose to validate the DTO, but it the Entity will still be validated at the Entity::update stage
 *
 * Entity Properties use a single class property which can be either
 * - DataTransferObjectInterface
 * - EntityInterface
 *
 * This class should never have any logic beyond getters and setters
 * @SuppressWarnings(PHPMD)
 */
final class PersonDto implements DataTransferObjectInterface
{

    /**
     * These are required imports that we have in this comment to prevent PHPStorm from removing them
     *
     * @see ArrayCollection
     * @see EntityInterface
     */

    use DebugEntityDataObjectIds;

    public const ENTITY_FQN = Person::class;

    /**
     * @var \Ramsey\Uuid\UuidInterface
     */
    private $id;

    /**
     * This method is called by the Symfony validation component when loading the meta data
     *
     * In this method, we pass the meta data through to the Entity so that it can be configured
     *
     * @param ValidatorClassMetaData $metadata
     *
     * @throws DoctrineStaticMetaException
     */
    public static function loadValidatorMetaData(ValidatorClassMetaData $metadata): void
    {
        Person::loadValidatorMetaData($metadata);
    }

    public static function getEntityFqn(): string
    {
        return self::ENTITY_FQN;
    }

    public function getId(): UuidInterface
    {
        return $this->id;
    }

    public function setId(UuidInterface $id): self
    {
        $this->id = $id;
        $this->initDebugIds(true);

        return $this;
    }


    /**
     * @var ?\DateTime
     */
    private $datetime = Person::DEFAULT_DATETIME;

    /**
     * @var ?bool
     */
    private $boolean = Person::DEFAULT_BOOLEAN;

    /**
     * @var ?float
     */
    private $float = Person::DEFAULT_FLOAT;

    /**
     * @var ?int
     */
    private $integer = Person::DEFAULT_INTEGER;

    /**
     * @var ?string
     */
    private $json = Person::DEFAULT_JSON;

    /**
     * @var ?string
     */
    private $string = Person::DEFAULT_STRING;

    /**
     * @var ?string
     */
    private $text = Person::DEFAULT_TEXT;

    /**
     * @var \Doctrine\Common\Collections\Collection
     */
    private $attributesEmails = null;

    /**
     * @var null|\My\Test\Project\Entity\Interfaces\Attributes\AddressInterface|\My\Test\Project\Entity\DataTransferObjects\Attributes\AddressDto
     */
    private $attributesAddress = null;

    /**
     * @var null|\My\Test\Project\Entity\Interfaces\Company\DirectorInterface|\My\Test\Project\Entity\DataTransferObjects\Company\DirectorDto
     */
    private $companyDirector = null;

    /**
     * @var null|\My\Test\Project\Entity\Interfaces\Large\RelationInterface|\My\Test\Project\Entity\DataTransferObjects\Large\RelationDto
     */
    private $largeRelation = null;

    /**
     */
    private $decimal = Person::DEFAULT_DECIMAL;


    public function getAttributesAddress(): ?\My\Test\Project\Entity\Interfaces\Attributes\AddressInterface
    {
        if(null === $this->attributesAddress){
            return $this->attributesAddress;
        }
        if($this->attributesAddress instanceof \My\Test\Project\Entity\Interfaces\Attributes\AddressInterface){
            return $this->attributesAddress;
        }
        throw new \RuntimeException(
            '$this->attributesAddress is not an Entity, but is '. \get_class($this->attributesAddress)
        );
    }


    public function getAttributesAddressDto(): ?\My\Test\Project\Entity\DataTransferObjects\Attributes\AddressDto
    {
        if(null === $this->attributesAddress){
            return $this->attributesAddress;
        }
        if($this->attributesAddress instanceof \My\Test\Project\Entity\DataTransferObjects\Attributes\AddressDto){
            return $this->attributesAddress;
        }
        throw new \RuntimeException(
            '$this->attributesAddress is not a DTO, but is '. \get_class($this->attributesAddress)
        );
    }


    public function getAttributesEmails(): \Doctrine\Common\Collections\Collection
    {
        return $this->attributesEmails ?? $this->attributesEmails = new ArrayCollection();
    }


    public function getCompanyDirector(): ?\My\Test\Project\Entity\Interfaces\Company\DirectorInterface
    {
        if(null === $this->companyDirector){
            return $this->companyDirector;
        }
        if($this->companyDirector instanceof \My\Test\Project\Entity\Interfaces\Company\DirectorInterface){
            return $this->companyDirector;
        }
        throw new \RuntimeException(
            '$this->companyDirector is not an Entity, but is '. \get_class($this->companyDirector)
        );
    }


    public function getCompanyDirectorDto(): ?\My\Test\Project\Entity\DataTransferObjects\Company\DirectorDto
    {
        if(null === $this->companyDirector){
            return $this->companyDirector;
        }
        if($this->companyDirector instanceof \My\Test\Project\Entity\DataTransferObjects\Company\DirectorDto){
            return $this->companyDirector;
        }
        throw new \RuntimeException(
            '$this->companyDirector is not a DTO, but is '. \get_class($this->companyDirector)
        );
    }


    public function getDatetime(): ?\DateTime
    {
        return $this->datetime;
    }


    public function getDecimal()
    {
        return $this->decimal;
    }


    public function getFloat(): ?float
    {
        return $this->float;
    }


    public function getInteger(): ?int
    {
        return $this->integer;
    }


    public function getJson(): ?string
    {
        return $this->json;
    }


    public function getLargeRelation(): ?\My\Test\Project\Entity\Interfaces\Large\RelationInterface
    {
        if(null === $this->largeRelation){
            return $this->largeRelation;
        }
        if($this->largeRelation instanceof \My\Test\Project\Entity\Interfaces\Large\RelationInterface){
            return $this->largeRelation;
        }
        throw new \RuntimeException(
            '$this->largeRelation is not an Entity, but is '. \get_class($this->largeRelation)
        );
    }


    public function getLargeRelationDto(): ?\My\Test\Project\Entity\DataTransferObjects\Large\RelationDto
    {
        if(null === $this->largeRelation){
            return $this->largeRelation;
        }
        if($this->largeRelation instanceof \My\Test\Project\Entity\DataTransferObjects\Large\RelationDto){
            return $this->largeRelation;
        }
        throw new \RuntimeException(
            '$this->largeRelation is not a DTO, but is '. \get_class($this->largeRelation)
        );
    }


    public function getString(): ?string
    {
        return $this->string;
    }


    public function getText(): ?string
    {
        return $this->text;
    }


    public function isBoolean(): ?bool
    {
        return $this->boolean;
    }


    public function issetAttributesAddressAsDto(): bool
    {
        return $this->attributesAddress instanceof DataTransferObjectInterface;
    }


    public function issetAttributesAddressAsEntity(): bool
    {
        return $this->attributesAddress instanceof EntityInterface;
    }


    public function issetCompanyDirectorAsDto(): bool
    {
        return $this->companyDirector instanceof DataTransferObjectInterface;
    }


    public function issetCompanyDirectorAsEntity(): bool
    {
        return $this->companyDirector instanceof EntityInterface;
    }


    public function issetLargeRelationAsDto(): bool
    {
        return $this->largeRelation instanceof DataTransferObjectInterface;
    }


    public function issetLargeRelationAsEntity(): bool
    {
        return $this->largeRelation instanceof EntityInterface;
    }


    public function setAttributesAddress(?\My\Test\Project\Entity\Interfaces\Attributes\AddressInterface $attributesAddress): self 
    {
        $this->attributesAddress = $attributesAddress;
        return $this;
    }


    public function setAttributesAddressDto(?\My\Test\Project\Entity\DataTransferObjects\Attributes\AddressDto $attributesAddress): self 
    {
        $this->attributesAddress = $attributesAddress;
        return $this;
    }


    public function setAttributesEmails(\Doctrine\Common\Collections\Collection $attributesEmails): self 
    {
        $this->attributesEmails = $attributesEmails;
        return $this;
    }


    public function setBoolean(?bool $boolean): self 
    {
        $this->boolean = $boolean;
        return $this;
    }


    public function setCompanyDirector(?\My\Test\Project\Entity\Interfaces\Company\DirectorInterface $companyDirector): self 
    {
        $this->companyDirector = $companyDirector;
        return $this;
    }


    public function setCompanyDirectorDto(?\My\Test\Project\Entity\DataTransferObjects\Company\DirectorDto $companyDirector): self 
    {
        $this->companyDirector = $companyDirector;
        return $this;
    }


    public function setDatetime(?\DateTime $datetime): self 
    {
        $this->datetime = $datetime;
        return $this;
    }


    public function setDecimal( $decimal): self 
    {
        $this->decimal = $decimal;
        return $this;
    }


    public function setFloat(?float $float): self 
    {
        $this->float = $float;
        return $this;
    }


    public function setInteger(?int $integer): self 
    {
        $this->integer = $integer;
        return $this;
    }


    public function setJson(?string $json): self 
    {
        $this->json = $json;
        return $this;
    }


    public function setLargeRelation(?\My\Test\Project\Entity\Interfaces\Large\RelationInterface $largeRelation): self 
    {
        $this->largeRelation = $largeRelation;
        return $this;
    }


    public function setLargeRelationDto(?\My\Test\Project\Entity\DataTransferObjects\Large\RelationDto $largeRelation): self 
    {
        $this->largeRelation = $largeRelation;
        return $this;
    }


    public function setString(?string $string): self 
    {
        $this->string = $string;
        return $this;
    }


    public function setText(?string $text): self 
    {
        $this->text = $text;
        return $this;
    }

}
PHP;


    private const NESTED_DTO = <<<'PHP'
<?php declare(strict_types=1);
// phpcs:disable Generic.Files.LineLength.TooLong
namespace My\Test\Project\Entity\DataTransferObjects\Another\Deeply\Nested;

use Doctrine\Common\Collections\ArrayCollection;
use EdmondsCommerce\DoctrineStaticMeta\Entity\Debug\DebugEntityDataObjectIds;
use EdmondsCommerce\DoctrineStaticMeta\Entity\Interfaces\DataTransferObjectInterface;
use EdmondsCommerce\DoctrineStaticMeta\Entity\Interfaces\EntityInterface;
use EdmondsCommerce\DoctrineStaticMeta\Exception\DoctrineStaticMetaException;
use Ramsey\Uuid\UuidInterface;
use Symfony\Component\Validator\Mapping\ClassMetadata as ValidatorClassMetaData;
use My\Test\Project\Entities\Another\Deeply\Nested\Client;

/**
 * This data transfer object should be used to hold potentially unvalidated update data,
 * ready to be fed into the Entity::update method
 *
 * You can choose to validate the DTO, but it the Entity will still be validated at the Entity::update stage
 *
 * Entity Properties use a single class property which can be either
 * - DataTransferObjectInterface
 * - EntityInterface
 *
 * This class should never have any logic beyond getters and setters
 * @SuppressWarnings(PHPMD)
 */
final class ClientDto implements DataTransferObjectInterface
{

    /**
     * These are required imports that we have in this comment to prevent PHPStorm from removing them
     *
     * @see ArrayCollection
     * @see EntityInterface
     */

    use DebugEntityDataObjectIds;

    public const ENTITY_FQN = Client::class;

    /**
     * @var \Ramsey\Uuid\UuidInterface
     */
    private $id;

    /**
     * This method is called by the Symfony validation component when loading the meta data
     *
     * In this method, we pass the meta data through to the Entity so that it can be configured
     *
     * @param ValidatorClassMetaData $metadata
     *
     * @throws DoctrineStaticMetaException
     */
    public static function loadValidatorMetaData(ValidatorClassMetaData $metadata): void
    {
        Client::loadValidatorMetaData($metadata);
    }

    public static function getEntityFqn(): string
    {
        return self::ENTITY_FQN;
    }

    public function getId(): UuidInterface
    {
        return $this->id;
    }

    public function setId(UuidInterface $id): self
    {
        $this->id = $id;
        $this->initDebugIds(true);

        return $this;
    }


    /**
     * @var ?\DateTime
     */
    private $datetime = Client::DEFAULT_DATETIME;

    /**
     * @var ?bool
     */
    private $boolean = Client::DEFAULT_BOOLEAN;

    /**
     * @var ?float
     */
    private $float = Client::DEFAULT_FLOAT;

    /**
     * @var ?int
     */
    private $integer = Client::DEFAULT_INTEGER;

    /**
     * @var ?string
     */
    private $json = Client::DEFAULT_JSON;

    /**
     * @var ?string
     */
    private $string = Client::DEFAULT_STRING;

    /**
     * @var ?string
     */
    private $text = Client::DEFAULT_TEXT;

    /**
     * @var null|\My\Test\Project\Entity\Interfaces\CompanyInterface|\My\Test\Project\Entity\DataTransferObjects\CompanyDto
     */
    private $company = null;

    /**
     */
    private $decimal = Client::DEFAULT_DECIMAL;


    public function getCompany(): ?\My\Test\Project\Entity\Interfaces\CompanyInterface
    {
        if(null === $this->company){
            return $this->company;
        }
        if($this->company instanceof \My\Test\Project\Entity\Interfaces\CompanyInterface){
            return $this->company;
        }
        throw new \RuntimeException(
            '$this->company is not an Entity, but is '. \get_class($this->company)
        );
    }


    public function getCompanyDto(): ?\My\Test\Project\Entity\DataTransferObjects\CompanyDto
    {
        if(null === $this->company){
            return $this->company;
        }
        if($this->company instanceof \My\Test\Project\Entity\DataTransferObjects\CompanyDto){
            return $this->company;
        }
        throw new \RuntimeException(
            '$this->company is not a DTO, but is '. \get_class($this->company)
        );
    }


    public function getDatetime(): ?\DateTime
    {
        return $this->datetime;
    }


    public function getDecimal()
    {
        return $this->decimal;
    }


    public function getFloat(): ?float
    {
        return $this->float;
    }


    public function getInteger(): ?int
    {
        return $this->integer;
    }


    public function getJson(): ?string
    {
        return $this->json;
    }


    public function getString(): ?string
    {
        return $this->string;
    }


    public function getText(): ?string
    {
        return $this->text;
    }


    public function isBoolean(): ?bool
    {
        return $this->boolean;
    }


    public function issetCompanyAsDto(): bool
    {
        return $this->company instanceof DataTransferObjectInterface;
    }


    public function issetCompanyAsEntity(): bool
    {
        return $this->company instanceof EntityInterface;
    }


    public function setBoolean(?bool $boolean): self 
    {
        $this->boolean = $boolean;
        return $this;
    }


    public function setCompany(?\My\Test\Project\Entity\Interfaces\CompanyInterface $company): self 
    {
        $this->company = $company;
        return $this;
    }


    public function setCompanyDto(?\My\Test\Project\Entity\DataTransferObjects\CompanyDto $company): self 
    {
        $this->company = $company;
        return $this;
    }


    public function setDatetime(?\DateTime $datetime): self 
    {
        $this->datetime = $datetime;
        return $this;
    }


    public function setDecimal( $decimal): self 
    {
        $this->decimal = $decimal;
        return $this;
    }


    public function setFloat(?float $float): self 
    {
        $this->float = $float;
        return $this;
    }


    public function setInteger(?int $integer): self 
    {
        $this->integer = $integer;
        return $this;
    }


    public function setJson(?string $json): self 
    {
        $this->json = $json;
        return $this;
    }


    public function setString(?string $string): self 
    {
        $this->string = $string;
        return $this;
    }


    public function setText(?string $text): self 
    {
        $this->text = $text;
        return $this;
    }

}
PHP;

// phpcs:enable
    protected static $buildOnce = true;

    public function setup()
    {
        parent::setUp();
        if (false === self::$built) {
            $this->getTestCodeGenerator()
                 ->copyTo(self::WORK_DIR);
            self::$built = true;
        }
        $this->setupCopiedWorkDir();
    }

    /**
     * @test
     */
    public function itCanCreateADto(): void
    {
        $newObjectFqn = $this->getCopiedFqn(
            self::TEST_PROJECT_ROOT_NAMESPACE . '\\Entity\\DataTransferObjects\\PersonDto'
        );
        $file         = $this->getCreator()->createTargetFileObject($newObjectFqn)->getTargetFile();
        $expected     = self::DTO;
        $actual       = $this->replaceNamespaceBackToStandard($file);
        self::assertSame($expected, $actual);
    }

    private function getCreator(): DtoCreator
    {
        $namespaceHelper = new NamespaceHelper();
        $config          = new Config(ConfigTest::SERVER);

        $creator = new DtoCreator(
            new FileFactory($namespaceHelper, $config),
            $namespaceHelper,
            new Writer(),
            $config,
            new FindReplaceFactory(),
            new ReflectionHelper($namespaceHelper),
            new CodeHelper($namespaceHelper)
        );
        $creator->setProjectRootNamespace(ltrim($this->getCopiedFqn(self::TEST_PROJECT_ROOT_NAMESPACE), '\\'));
        $creator->setProjectRootDirectory($this->copiedWorkDir);
        $creator->setProjectRootDirectory(/** @scrutinizer ignore-type */ $this->copiedWorkDir);

        return $creator;
    }

    private function replaceNamespaceBackToStandard(File $file): string
    {
        return \str_replace(
            ltrim($this->getCopiedFqn('My\\Test\\Project'), '\\'),
            'My\\Test\\Project\\',
            $file->getContents()
        );
    }

    /**
     * @test
     */
    public function itCanCreateADtoFromAnEntityFqn(): void
    {
        $entityFqn = $this->getCopiedFqn(
            self::TEST_PROJECT_ROOT_NAMESPACE . '\\Entities\\Person'
        );
        $file      = $this->getCreator()
                          ->setNewObjectFqnFromEntityFqn($entityFqn)
                          ->createTargetFileObject()
                          ->getTargetFile();
        $expected  = self::DTO;
        $actual    = $this->replaceNamespaceBackToStandard($file);
        self::assertSame($expected, $actual);
    }

    /**
     * @test
     */
    public function itCanCreateANestedDto(): void
    {
        $newObjectFqn = $this->getCopiedFqn(
            self::TEST_PROJECT_ROOT_NAMESPACE .
            '\\Entity\\DataTransferObjects\\Another\\Deeply\\Nested\\ClientDto'
        );
        $file         = $this->getCreator()->createTargetFileObject($newObjectFqn)->getTargetFile();
        $expected     = self::NESTED_DTO;
        $actual       = $this->replaceNamespaceBackToStandard($file);
        self::assertSame($expected, $actual);
    }

    /**
     * @test
     */
    public function itCanCreateANestedDtoFromEntityFqn(): void
    {
        $entityFqn = $this->getCopiedFqn(
            self::TEST_PROJECT_ROOT_NAMESPACE .
            '\\Entities\\Another\\Deeply\\Nested\\Client'
        );
        $file      = $this->getCreator()
                          ->setNewObjectFqnFromEntityFqn($entityFqn)
                          ->createTargetFileObject()
                          ->getTargetFile();
        $expected  = self::NESTED_DTO;
        $actual    = $this->replaceNamespaceBackToStandard($file);
        self::assertSame($expected, $actual);
    }
}

edmondscommerce / doctrine-static-meta

GitHub Access Token became invalid

Pull Request — master (#152)

DataTransferObjectCreatorTest::itCanCreateADto() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
