AbstractCreator::configurePipeline() - 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

AbstractCreator::configurePipeline() A

↳ Parent: AbstractCreator

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	0
dl	0
loc	5
ccs	4
cts	4
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php declare(strict_types=1);

namespace EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Creation;

use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Creation\Process\Pipeline;
use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Creation\Process\ReplaceNameProcess;
use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Creation\Process\ReplaceProjectRootNamespaceProcess;
use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Filesystem\Factory\FileFactory;
use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Filesystem\Factory\FindReplaceFactory;
use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Filesystem\File;
use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\NamespaceHelper;
use EdmondsCommerce\DoctrineStaticMeta\Config;

/**
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 */
abstract class AbstractCreator implements CreatorInterface
{
    protected const TEMPLATE_ENTITY_NAME = 'TemplateEntity';

    /**
     * The absolute path to the template file residing in the root codeTemplates directory
     */
    protected const TEMPLATE_PATH = 'override me';
    /**
     * The basename of the Template object FQN
     */
    protected const FIND_NAME = 'override me';
    /**
     * The path to the root code templates folder
     */
    public const ROOT_TEMPLATE_PATH = __DIR__ . '/../../../codeTemplates/';

    public const SRC_DIR = 'src';

    public const TEST_DIR = 'tests';

    /**
     * @var string
     */
    protected $newObjectFqn;
    /**
     * @var File
     */
    protected $templateFile;
    /**
     * @var File
     */
    protected $targetFile;
    /**
     * @var FileFactory
     */
    protected $fileFactory;
    /**
     * @var FindReplaceFactory
     */
    protected $findReplaceFactory;
    /**
     * @var NamespaceHelper
     */
    protected $namespaceHelper;
    /**
     * @var File\Writer
     */
    protected $fileWriter;
    /**
     * @var Pipeline
     */
    protected $pipeline;
    /**
     * @var string
     */
    protected $projectRootNamespace;
    /**
     * @var string
     */
    protected $projectRootDirectory;

    public function __construct(
        FileFactory $fileFactory,
        NamespaceHelper $namespaceHelper,
        File\Writer $fileWriter,
        Config $config,
        FindReplaceFactory $findReplaceFactory
    ) {
        $this->fileFactory     = $fileFactory;
        $this->namespaceHelper = $namespaceHelper;
        $this->fileWriter      = $fileWriter;
        $this->setProjectRootNamespace($this->namespaceHelper->getProjectRootNamespaceFromComposerJson());
        $this->setProjectRootDirectory($config::getProjectRootDirectory());
        $this->findReplaceFactory = $findReplaceFactory;
    }

    public function setProjectRootNamespace(string $projectRootNamespace): self
    {
        $this->projectRootNamespace = $projectRootNamespace;
        $this->fileFactory->setProjectRootNamespace($projectRootNamespace);

        return $this;
    }

    public function setProjectRootDirectory(string $projectRootDirectory): self
    {
        $this->projectRootDirectory = $projectRootDirectory;
        $this->fileFactory->setProjectRootDirectory($projectRootDirectory);

        return $this;
    }

    public function createTargetFileObject(string $newObjectFqn = null): self
    {
        if (null === $newObjectFqn && null === $this->newObjectFqn) {
            throw new \RuntimeException(
                'No new objectFqn either set previously or passed in'
            );
        }
        if (null !== $newObjectFqn) {
            $this->newObjectFqn = $newObjectFqn;
        }
        $this->templateFile = $this->fileFactory->createFromExistingPath(static::TEMPLATE_PATH);
        $this->targetFile   = $this->fileFactory->createFromFqn($this->newObjectFqn);
        $this->updateRootDirOnTargetFile();
        $this->setTargetContentsWithTemplateContents();
        $this->configurePipeline();
        $this->pipeline->run($this->targetFile);

        return $this;
    }

    /**
     * Where the template file is in tests, we need to fix that in the target file
     */
    private function updateRootDirOnTargetFile(): void
    {
        $realTemplateTestsPath = realpath(self::ROOT_TEMPLATE_PATH . self::TEST_DIR);
        if (0 === \strpos($this->templateFile->getPath(), $realTemplateTestsPath)) {
            $targetSrcPath   = rtrim($this->projectRootDirectory, '/') . '/' . self::SRC_DIR;
            $targetTestsPath = rtrim($this->projectRootDirectory, '/') . '/' . self::TEST_DIR;
            $updatedPath     = str_replace(
                $targetSrcPath,
                $targetTestsPath,
                $this->targetFile->getPath()
            );
            $this->targetFile->setPath($updatedPath);
        }
    }

    protected function setTargetContentsWithTemplateContents()
    {
        $this->targetFile->setContents(
            $this->templateFile->loadContents()
                               ->getContents()
        );
    }

    /**
     * In this method we register all the process steps that we want to rnu against the file
     *
     * By default this registers the ReplaceNameProcess which is almost certainly required. Other processes can be
     * registered as required
     */
    protected function configurePipeline(): void
    {
        $this->pipeline = new Pipeline($this->findReplaceFactory);
        $this->registerReplaceName();
        $this->registerReplaceProjectRootNamespace();
    }

    protected function registerReplaceName(): void
    {
        $replaceName = new ReplaceNameProcess();
        $replaceName->setArgs(static::FIND_NAME, $this->namespaceHelper->basename($this->newObjectFqn));
        $this->pipeline->register($replaceName);
    }

    protected function registerReplaceProjectRootNamespace()
    {
        $replaceTemplateNamespace = new ReplaceProjectRootNamespaceProcess();
        $replaceTemplateNamespace->setProjectRootNamespace($this->projectRootNamespace);
        $this->pipeline->register($replaceTemplateNamespace);
    }

    public function getTargetFile(): File
    {
        return $this->targetFile;
    }

    /**
     * Write the file only if it doesn't already exist
     *
     * @return string
     * @throws \EdmondsCommerce\DoctrineStaticMeta\Exception\DoctrineStaticMetaException
     */
    public function writeIfNotExists(): string
    {
        if ($this->targetFile->exists()) {
            return $this->targetFile->getPath();
        }

        return $this->write();
    }

    /**
     * Write the file and return the generated path
     *
     * @return string
     * @throws \EdmondsCommerce\DoctrineStaticMeta\Exception\DoctrineStaticMetaException
     */
    public function write(): string
    {
        return $this->fileWriter->write($this->targetFile);
    }

    protected function registerEntityReplaceName(string $entityFqn): void
    {
        $replaceName = new ReplaceNameProcess();
        $replaceName->setArgs(self::TEMPLATE_ENTITY_NAME, $this->namespaceHelper->basename($entityFqn));
        $this->pipeline->register($replaceName);
    }
}


1		<?php declare(strict_types=1);
2
3		namespace EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Creation;
4
5		use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Creation\Process\Pipeline;
6		use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Creation\Process\ReplaceNameProcess;
7		use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Creation\Process\ReplaceProjectRootNamespaceProcess;
8		use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Filesystem\Factory\FileFactory;
9		use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Filesystem\Factory\FindReplaceFactory;
10		use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\Filesystem\File;
11		use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\NamespaceHelper;
12		use EdmondsCommerce\DoctrineStaticMeta\Config;
13
14		/**
15		* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
16		*/
17		abstract class AbstractCreator implements CreatorInterface
18		{
19		protected const TEMPLATE_ENTITY_NAME = 'TemplateEntity';
20
21		/**
22		* The absolute path to the template file residing in the root codeTemplates directory
23		*/
24		protected const TEMPLATE_PATH = 'override me';
25		/**
26		* The basename of the Template object FQN
27		*/
28		protected const FIND_NAME = 'override me';
29		/**
30		* The path to the root code templates folder
31		*/
32		public const ROOT_TEMPLATE_PATH = __DIR__ . '/../../../codeTemplates/';
33
34		public const SRC_DIR = 'src';
35
36		public const TEST_DIR = 'tests';
37
38		/**
39		* @var string
40		*/
41		protected $newObjectFqn;
42		/**
43		* @var File
44		*/
45		protected $templateFile;
46		/**
47		* @var File
48		*/
49		protected $targetFile;
50		/**
51		* @var FileFactory
52		*/
53		protected $fileFactory;
54		/**
55		* @var FindReplaceFactory
56		*/
57		protected $findReplaceFactory;
58		/**
59		* @var NamespaceHelper
60		*/
61		protected $namespaceHelper;
62		/**
63		* @var File\Writer
64		*/
65		protected $fileWriter;
66		/**
67		* @var Pipeline
68		*/
69		protected $pipeline;
70		/**
71		* @var string
72		*/
73		protected $projectRootNamespace;
74		/**
75		* @var string
76		*/
77		protected $projectRootDirectory;
78
79	19	public function __construct(
80		FileFactory $fileFactory,
81		NamespaceHelper $namespaceHelper,
82		File\Writer $fileWriter,
83		Config $config,
84		FindReplaceFactory $findReplaceFactory
85		) {
86	19	$this->fileFactory = $fileFactory;
87	19	$this->namespaceHelper = $namespaceHelper;
88	19	$this->fileWriter = $fileWriter;
89	19	$this->setProjectRootNamespace($this->namespaceHelper->getProjectRootNamespaceFromComposerJson());
90	19	$this->setProjectRootDirectory($config::getProjectRootDirectory());
91	19	$this->findReplaceFactory = $findReplaceFactory;
92	19	}
93
94	19	public function setProjectRootNamespace(string $projectRootNamespace): self
95		{
96	19	$this->projectRootNamespace = $projectRootNamespace;
97	19	$this->fileFactory->setProjectRootNamespace($projectRootNamespace);
98
99	19	return $this;
100		}
101
102	19	public function setProjectRootDirectory(string $projectRootDirectory): self
103		{
104	19	$this->projectRootDirectory = $projectRootDirectory;
105	19	$this->fileFactory->setProjectRootDirectory($projectRootDirectory);
106
107	19	return $this;
108		}
109
110	18	public function createTargetFileObject(string $newObjectFqn = null): self
111		{
112	18	if (null === $newObjectFqn && null === $this->newObjectFqn) {
113		throw new \RuntimeException(
114		'No new objectFqn either set previously or passed in'
115		);
116		}
117	18	if (null !== $newObjectFqn) {
118	12	$this->newObjectFqn = $newObjectFqn;
119		}
120	18	$this->templateFile = $this->fileFactory->createFromExistingPath(static::TEMPLATE_PATH);
121	18	$this->targetFile = $this->fileFactory->createFromFqn($this->newObjectFqn);
122	18	$this->updateRootDirOnTargetFile();
123	18	$this->setTargetContentsWithTemplateContents();
124	18	$this->configurePipeline();
125	18	$this->pipeline->run($this->targetFile);
126
127	18	return $this;
128		}
129
130		/**
131		* Where the template file is in tests, we need to fix that in the target file
132		*/
133	18	private function updateRootDirOnTargetFile(): void
134		{
135	18	$realTemplateTestsPath = realpath(self::ROOT_TEMPLATE_PATH . self::TEST_DIR);
136	18	if (0 === \strpos($this->templateFile->getPath(), $realTemplateTestsPath)) {
137		$targetSrcPath = rtrim($this->projectRootDirectory, '/') . '/' . self::SRC_DIR;
138		$targetTestsPath = rtrim($this->projectRootDirectory, '/') . '/' . self::TEST_DIR;
139		$updatedPath = str_replace(
140		$targetSrcPath,
141		$targetTestsPath,
142		$this->targetFile->getPath()
143		);
144		$this->targetFile->setPath($updatedPath);
145		}
146	18	}
147
148	18	protected function setTargetContentsWithTemplateContents()
149		{
150	18	$this->targetFile->setContents(
151	18	$this->templateFile->loadContents()
152	18	->getContents()
153		);
154	18	}
155
156		/**
157		* In this method we register all the process steps that we want to rnu against the file
158		*
159		* By default this registers the ReplaceNameProcess which is almost certainly required. Other processes can be
160		* registered as required
161		*/
162	18	protected function configurePipeline(): void
163		{
164	18	$this->pipeline = new Pipeline($this->findReplaceFactory);
165	18	$this->registerReplaceName();
166	18	$this->registerReplaceProjectRootNamespace();
167	18	}
168
169	18	protected function registerReplaceName(): void
170		{
171	18	$replaceName = new ReplaceNameProcess();
172	18	$replaceName->setArgs(static::FIND_NAME, $this->namespaceHelper->basename($this->newObjectFqn));
173	18	$this->pipeline->register($replaceName);
174	18	}
175
176	18	protected function registerReplaceProjectRootNamespace()
177		{
178	18	$replaceTemplateNamespace = new ReplaceProjectRootNamespaceProcess();
179	18	$replaceTemplateNamespace->setProjectRootNamespace($this->projectRootNamespace);
180	18	$this->pipeline->register($replaceTemplateNamespace);
181	18	}
182
183	18	public function getTargetFile(): File
184		{
185	18	return $this->targetFile;
186		}
187
188		/**
189		* Write the file only if it doesn't already exist
190		*
191		* @return string
192		* @throws \EdmondsCommerce\DoctrineStaticMeta\Exception\DoctrineStaticMetaException
193		*/
194		public function writeIfNotExists(): string
195		{
196		if ($this->targetFile->exists()) {
197		return $this->targetFile->getPath();
198		}
199
200		return $this->write();
201		}
202
203		/**
204		* Write the file and return the generated path
205		*
206		* @return string
207		* @throws \EdmondsCommerce\DoctrineStaticMeta\Exception\DoctrineStaticMetaException
208		*/
209		public function write(): string
210		{
211		return $this->fileWriter->write($this->targetFile);
212		}
213
214	8	protected function registerEntityReplaceName(string $entityFqn): void
215		{
216	8	$replaceName = new ReplaceNameProcess();
217	8	$replaceName->setArgs(self::TEMPLATE_ENTITY_NAME, $this->namespaceHelper->basename($entityFqn));
218	8	$this->pipeline->register($replaceName);
219	8	}
220		}
221

edmondscommerce / doctrine-static-meta

GitHub Access Token became invalid

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

AbstractCreator::configurePipeline() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like