FindReplaceTest::itCanChangeName() - Code Metrics - Inspection of "Merge pull request #148 from edmondscommerce/Fixin..." - edmondscommerce/doctrine-static-meta - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 75bdf9...8faa57 )

by joseph

created 2018-09-26 07:35 UTC

FindReplaceTest::itCanChangeName() A

↳ Parent: FindReplaceTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	21
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	17
nc	1
nop	0
dl	0
loc	21
rs	9.7
c	0
b	0
f	0

<?php declare(strict_types=1);

namespace EdmondsCommerce\DoctrineStaticMeta\Tests\Small\CodeGeneration\Filesystem\File;

use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Filesystem\File;
use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Filesystem\File\FindReplace;
use PHPUnit\Framework\TestCase;
//phpcs:disable Generic.Files.LineLength.TooLong
/**
 * @covers \EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Filesystem\File\FindReplace
 */
class FindReplaceTest extends TestCase
{

    /* **************************************************************
     * TEST CONTENT STARTS
     * **************************************************************/

    private const  TEST_CONTENTS = <<<'PHP'
<?php declare(strict_types=1);

namespace Test\Code\Generator\Entities;
// phpcs:disable Generic.Files.LineLength.TooLong

use Doctrine\ORM\Mapping\Builder\ClassMetadataBuilder;
use Test\Code\Generator\Entity\Fields\Traits\TextFieldTrait;
use Test\Code\Generator\Entity\Interfaces\CompanyInterface;
use Test\Code\Generator\Entity\Relations\Company\Director\Traits\HasCompanyDirectors\HasCompanyDirectorsOwningManyToMany;
use Test\Code\Generator\Entity\Relations\Some\Client\Traits\HasSomeClient\HasSomeClientOwningOneToOne;
use Test\Code\Generator\Entity\Repositories\CompanyRepository;

// phpcs:enable
class Company implements 
    CompanyInterface
{
	use HasCompanyDirectorsOwningManyToMany;
	
	/**
	 * This is called in UsesPHPMetaDataTrait::loadClassDoctrineMetaData
	 *
	 * @SuppressWarnings(PHPMD.UnusedPrivateMethod)
	 * @param ClassMetadataBuilder $builder
	 */
	private static function setCustomRepositoryClass(ClassMetadataBuilder $builder) {
		$builder->setCustomRepositoryClass(CompanyRepository::class);
	}

 /**
     * @var ArrayCollection|CompanyInterface[]
     */
    private $companies;

    /**
     * @param ValidatorClassMetaData $metadata
     *
     * @throws \Symfony\Component\Validator\Exception\MissingOptionsException
     * @throws \Symfony\Component\Validator\Exception\InvalidOptionsException
     * @throws \Symfony\Component\Validator\Exception\ConstraintDefinitionException
     */
    public static function validatorMetaForCompanies(
        ValidatorClassMetaData $metadata
    ): void {
        $metadata->addPropertyConstraint(
            HasCompaniesInterface::PROPERTY_NAME_COMPANIES,
            new Valid()
        );
    }

    /**
     * @param ClassMetadataBuilder $manyToManyBuilder
     *
     * @return void
     */
    abstract public static function metaForCompanies(
        ClassMetadataBuilder $manyToManyBuilder
    ): void;

    /**
     * @return Collection|CompanyInterface[]
     */
    public function getCompanies(): Collection
    {
        return $this->companies;
    }

    /**
     * @param Collection|CompanyInterface[] $companies
     *
     * @return self
     */
    public function setCompanies(
        Collection $companies
    ): HasCompaniesInterface {
        $this->setEntityCollectionAndNotify(
            'companies',
            $companies
        );

        return $this;
    }

    /**
     * @param CompanyInterface|null $company
     * @param bool                         $recip
     *
     * @return self
     * @SuppressWarnings(PHPMD.BooleanArgumentFlag)
     */
    public function addCompany(
        ?CompanyInterface $company,
        bool $recip = true
    ): HasCompaniesInterface {
        if ($company === null) {
            return $this;
        }

        $this->addToEntityCollectionAndNotify('companies', $company);
        if ($this instanceof ReciprocatesCompanyInterface && true === $recip) {
            $this->reciprocateRelationOnCompany(
                $company
            );
        }

        return $this;
    }

    /**
     * @param CompanyInterface $company
     * @param bool                    $recip
     *
     * @return self
     * @SuppressWarnings(PHPMD.BooleanArgumentFlag)
     */
    public function removeCompany(
        CompanyInterface $company,
        bool $recip = true
    ): HasCompaniesInterface {
        $this->removeFromEntityCollectionAndNotify('companies', $company);
        if ($this instanceof ReciprocatesCompanyInterface && true === $recip) {
            $this->removeRelationOnCompany(
                $company
            );
        }

        return $this;
    }

    /**
     * Initialise the companies property as a Doctrine ArrayCollection
     *
     * @return $this
     * @SuppressWarnings(PHPMD.UnusedPrivateMethod)
     */
    private function initCompanies()
    {
        $this->companies = new ArrayCollection();

        return $this;
    }
}
PHP;

    /* **************************************************************
     * TEST CONTENT ENDS
     * **************************************************************/

    /**
     * @test
     * @small
     */
    public function itCanDoSimpleStringReplace()
    {
        $file   = $this->getFile();
        $object = $this->getFindReplace($file);
        $object->findReplace('use', 'choose');
        self::assertNotContains('use', $file->getContents());
    }

    private function getFile()
    {
        $file = new File();
        $file->setContents(self::TEST_CONTENTS);

        return $file;
    }

    private function getFindReplace(File $file): FindReplace
    {
        return new FindReplace($file);
    }

    /**
     * @test
     * @small
     */
    public function itCanChangeName()
    {
        $file   = $this->getFile();
        $object = $this->getFindReplace($file);
        $object->findReplaceName('Company', 'Sheep');
        $contents = $file->getContents();
        self::assertNotContains('Company', $contents);
        self::assertNotContains('Companies', $contents);
        self::assertNotContains('company', $contents);
        self::assertNotContains('companies', $contents);
        self::assertContains(
            'class Sheep implements 
    SheepInterface',
            $contents
        );
        self::assertContains(
            'use HasSheepDirectorsOwningManyToMany;',
            $contents
        );
        self::assertContains('SheepInterface $sheep', $contents);
        self::assertContains('private $sheeps', $contents);
    }

    /**
     * @test
     * @small
     */
    public function itCanEscapeSlashesForRegexAndDoRegexReplace()
    {
        $file   = $this->getFile();
        $object = $this->getFindReplace($file);
        $object->findReplaceRegex(
            $object->escapeSlashesForRegex('%Doctrine\\.+?\\Mapping\\' . 'Builder\\ClassMetadataBuilder%'),
            'Foo\\Builder'
        );
        $contents = $file->getContents();
        self::assertNotContains('Doctrine\\ORM\Mapping\\Builder\\ClassMetadataBuilder', $contents);
        self::assertContains('use Foo\\Builder', $contents);
    }
}


1			<?php declare(strict_types=1);
2
3			namespace EdmondsCommerce\DoctrineStaticMeta\Tests\Small\CodeGeneration\Filesystem\File;
4
5			use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Filesystem\File;
6			use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Filesystem\File\FindReplace;
7			use PHPUnit\Framework\TestCase;
8			//phpcs:disable Generic.Files.LineLength.TooLong
9			/**
10			* @covers \EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Filesystem\File\FindReplace
11			*/
12			class FindReplaceTest extends TestCase
13			{
14
15			/* **************************************************************
16			* TEST CONTENT STARTS
17			* **************************************************************/
18
19			private const TEST_CONTENTS = <<<'PHP'
20			<?php declare(strict_types=1);
21
22			namespace Test\Code\Generator\Entities;
23			// phpcs:disable Generic.Files.LineLength.TooLong
24
25			use Doctrine\ORM\Mapping\Builder\ClassMetadataBuilder;
26			use Test\Code\Generator\Entity\Fields\Traits\TextFieldTrait;
27			use Test\Code\Generator\Entity\Interfaces\CompanyInterface;
28			use Test\Code\Generator\Entity\Relations\Company\Director\Traits\HasCompanyDirectors\HasCompanyDirectorsOwningManyToMany;
29			use Test\Code\Generator\Entity\Relations\Some\Client\Traits\HasSomeClient\HasSomeClientOwningOneToOne;
30			use Test\Code\Generator\Entity\Repositories\CompanyRepository;
31
32			// phpcs:enable
33			class Company implements
34			CompanyInterface
35			{
36			use HasCompanyDirectorsOwningManyToMany;
37
38			/**
39			* This is called in UsesPHPMetaDataTrait::loadClassDoctrineMetaData
40			*
41			* @SuppressWarnings(PHPMD.UnusedPrivateMethod)
42			* @param ClassMetadataBuilder $builder
43			*/
44			private static function setCustomRepositoryClass(ClassMetadataBuilder $builder) {
45			$builder->setCustomRepositoryClass(CompanyRepository::class);
46			}
47
48			/**
49			* @var ArrayCollection\|CompanyInterface[]
50			*/
51			private $companies;
52
53			/**
54			* @param ValidatorClassMetaData $metadata
55			*
56			* @throws \Symfony\Component\Validator\Exception\MissingOptionsException
57			* @throws \Symfony\Component\Validator\Exception\InvalidOptionsException
58			* @throws \Symfony\Component\Validator\Exception\ConstraintDefinitionException
59			*/
60			public static function validatorMetaForCompanies(
61			ValidatorClassMetaData $metadata
62			): void {
63			$metadata->addPropertyConstraint(
64			HasCompaniesInterface::PROPERTY_NAME_COMPANIES,
65			new Valid()
66			);
67			}
68
69			/**
70			* @param ClassMetadataBuilder $manyToManyBuilder
71			*
72			* @return void
73			*/
74			abstract public static function metaForCompanies(
75			ClassMetadataBuilder $manyToManyBuilder
76			): void;
77
78			/**
79			* @return Collection\|CompanyInterface[]
80			*/
81			public function getCompanies(): Collection
82			{
83			return $this->companies;
84			}
85
86			/**
87			* @param Collection\|CompanyInterface[] $companies
88			*
89			* @return self
90			*/
91			public function setCompanies(
92			Collection $companies
93			): HasCompaniesInterface {
94			$this->setEntityCollectionAndNotify(
95			'companies',
96			$companies
97			);
98
99			return $this;
100			}
101
102			/**
103			* @param CompanyInterface\|null $company
104			* @param bool $recip
105			*
106			* @return self
107			* @SuppressWarnings(PHPMD.BooleanArgumentFlag)
108			*/
109			public function addCompany(
110			?CompanyInterface $company,
111			bool $recip = true
112			): HasCompaniesInterface {
113			if ($company === null) {
114			return $this;
115			}
116
117			$this->addToEntityCollectionAndNotify('companies', $company);
118			if ($this instanceof ReciprocatesCompanyInterface && true === $recip) {
119			$this->reciprocateRelationOnCompany(
120			$company
121			);
122			}
123
124			return $this;
125			}
126
127			/**
128			* @param CompanyInterface $company
129			* @param bool $recip
130			*
131			* @return self
132			* @SuppressWarnings(PHPMD.BooleanArgumentFlag)
133			*/
134			public function removeCompany(
135			CompanyInterface $company,
136			bool $recip = true
137			): HasCompaniesInterface {
138			$this->removeFromEntityCollectionAndNotify('companies', $company);
139			if ($this instanceof ReciprocatesCompanyInterface && true === $recip) {
140			$this->removeRelationOnCompany(
141			$company
142			);
143			}
144
145			return $this;
146			}
147
148			/**
149			* Initialise the companies property as a Doctrine ArrayCollection
150			*
151			* @return $this
152			* @SuppressWarnings(PHPMD.UnusedPrivateMethod)
153			*/
154			private function initCompanies()
155			{
156			$this->companies = new ArrayCollection();
157
158			return $this;
159			}
160			}
161			PHP;
162
163			/* **************************************************************
164			* TEST CONTENT ENDS
165			* **************************************************************/
166
167			/**
168			* @test
169			* @small
170			*/
171			public function itCanDoSimpleStringReplace()
172			{
173			$file = $this->getFile();
174			$object = $this->getFindReplace($file);
175			$object->findReplace('use', 'choose');
176			self::assertNotContains('use', $file->getContents());
177			}
178
179			private function getFile()
180			{
181			$file = new File();
182			$file->setContents(self::TEST_CONTENTS);
183
184			return $file;
185			}
186
187			private function getFindReplace(File $file): FindReplace
188			{
189			return new FindReplace($file);
190			}
191
192			/**
193			* @test
194			* @small
195			*/
196			public function itCanChangeName()
197			{
198			$file = $this->getFile();
199			$object = $this->getFindReplace($file);
200			$object->findReplaceName('Company', 'Sheep');
201			$contents = $file->getContents();
202			self::assertNotContains('Company', $contents);
203			self::assertNotContains('Companies', $contents);
204			self::assertNotContains('company', $contents);
205			self::assertNotContains('companies', $contents);
206			self::assertContains(
207			'class Sheep implements
208			SheepInterface',
209			$contents
210			);
211			self::assertContains(
212			'use HasSheepDirectorsOwningManyToMany;',
213			$contents
214			);
215			self::assertContains('SheepInterface $sheep', $contents);
216			self::assertContains('private $sheeps', $contents);
217			}
218
219			/**
220			* @test
221			* @small
222			*/
223			public function itCanEscapeSlashesForRegexAndDoRegexReplace()
224			{
225			$file = $this->getFile();
226			$object = $this->getFindReplace($file);
227			$object->findReplaceRegex(
228			$object->escapeSlashesForRegex('%Doctrine\\.+?\\Mapping\\' . 'Builder\\ClassMetadataBuilder%'),
229			'Foo\\Builder'
230			);
231			$contents = $file->getContents();
232			self::assertNotContains('Doctrine\\ORM\Mapping\\Builder\\ClassMetadataBuilder', $contents);
233			self::assertContains('use Foo\\Builder', $contents);
234			}
235			}
236

edmondscommerce / doctrine-static-meta

GitHub Access Token became invalid

Push — master ( 75bdf9...8faa57 )

FindReplaceTest::itCanChangeName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like