FileOverrider::getOverridesIterator() - Code Metrics - Inspection of "Snags and tweaks pending version 6" - edmondscommerce/doctrine-static-meta - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#154)

by joseph

created 2018-12-11 15:42 UTC

FileOverrider::getOverridesIterator() A

↳ Parent: FileOverrider

Complexity

Conditions	3
Paths	6

Size

Total Lines	21
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	3

Importance

Changes

Metric	Value
cc	3
eloc	12
nc	6
nop	0
dl	0
loc	21
ccs	12
cts	12
cp	1
crap	3
rs	9.8666
c	0
b	0
f	0

<?php declare(strict_types=1);

namespace EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\PostProcessor;

/**
 * This class provides the necessary functionality to allow you to maintain a set of file overrides and to safely apply
 * them as part of a post process to your main build process
 */
class FileOverrider
{
    /**
     * The default path to the overrides folder, relative to the project root
     */
    public const OVERRIDES_PATH = '/build/overrides';

    private const EXTENSION_LENGTH_NO_HASH   = 4;
    private const EXTENSION_LENGTH_WITH_HASH = 37;

    /**
     * @var string
     */
    private $pathToProjectRoot;

    /**
     * @var string
     */
    private $pathToOverridesDirectory;

    public function __construct(
        string $pathToProjectRoot = null,
        string $relativePathToOverridesDirectory = self::OVERRIDES_PATH
    ) {
        if (null !== $pathToProjectRoot) {
            $this->setPathToProjectRoot($pathToProjectRoot);
            $this->setPathToOverridesDirectory($this->pathToProjectRoot . '/' . $relativePathToOverridesDirectory);
        }
    }

    /**
     * @param string $pathToProjectRoot
     *
     * @return $this
     * @throws \RuntimeException
     */
    public function setPathToProjectRoot(string $pathToProjectRoot): self
    {
        $this->pathToProjectRoot = $this->getRealPath($pathToProjectRoot);
        $this->setPathToOverridesDirectory($this->pathToProjectRoot . self::OVERRIDES_PATH);

        return $this;
    }

    private function getRealPath(string $path): string
    {
        $realPath = \realpath($path);
        if (false === $realPath) {
            if (!mkdir($path, 0777, true) && !is_dir($path)) {
                throw new \RuntimeException(sprintf('Directory "%s" was not created', $path));
            }
            $realPath = realpath($path);
        }

        return $realPath;
    }

    /**
     * Create a new Override File by copying the file from the project into the project's overrides directory
     *
     * @param string $pathToFileInProject
     *
     * @return string
     */
    public function createNewOverride(string $pathToFileInProject): string
    {
        $relativePathToFileInProject = $this->getRelativePathToFile($pathToFileInProject);
        if (null !== $this->getOverrideForPath($relativePathToFileInProject)) {
            throw new \RuntimeException('Override already exists for path ' . $relativePathToFileInProject);
        }
        $overridePath =
            $this->getOverrideDirectoryForFile($relativePathToFileInProject) .
            '/' . $this->getFileNameNoExtensionForPath($relativePathToFileInProject) .
            '.' . $this->getProjectFileHash($relativePathToFileInProject) .
            '.php';
        copy($this->pathToProjectRoot . '/' . $relativePathToFileInProject, $overridePath);

        return $this->getRelativePathToFile($overridePath);
    }

    private function getRelativePathToFile(string $pathToFileInProject): string
    {
        return str_replace($this->pathToProjectRoot, '', $this->getRealPath($pathToFileInProject));
    }

    private function getOverrideForPath(string $relativePathToFileInProject): ?string
    {
        $fileDirectory       = $this->getOverrideDirectoryForFile($relativePathToFileInProject);
        $fileNameNoExtension = $this->getFileNameNoExtensionForPath($relativePathToFileInProject);
        $filesInDirectory    = glob("$fileDirectory/$fileNameNoExtension*");
        if ([] === $filesInDirectory) {
            return null;
        }
        if (1 === count($filesInDirectory)) {
            return $fileDirectory . '/' . current($filesInDirectory);
        }
        throw new \RuntimeException(
            'Found more than one override in path ' . $fileDirectory . ': '
            . print_r($filesInDirectory, true)
        );
    }

    private function getOverrideDirectoryForFile(string $relativePathToFileInProject): string
    {
        $path = $this->getPathToOverridesDirectory() . \dirname($relativePathToFileInProject);
        if (!is_dir($path) && !(mkdir($path, 0777, true) && is_dir($path))) {
            throw new \RuntimeException('Failed making override directory path ' . $path);
        }

        return $this->getRealPath($path);
    }

    /**
     * @return string
     */
    public function getPathToOverridesDirectory(): string
    {
        return $this->getRealPath($this->pathToOverridesDirectory);
    }

    /**
     * @param string $pathToOverridesDirectory
     *
     * @return FileOverrider
     */
    public function setPathToOverridesDirectory(string $pathToOverridesDirectory): FileOverrider
    {
        $this->pathToOverridesDirectory = $this->getRealPath($pathToOverridesDirectory);

        return $this;
    }

    private function getFileNameNoExtensionForPath(string $relativePathToFileInProject): string
    {
        $fileName = basename($relativePathToFileInProject);

        return substr($fileName, 0, -self::EXTENSION_LENGTH_NO_HASH);
    }

    private function getProjectFileHash(string $relativePathToFileInProject): string
    {
        return $this->getFileHash($this->pathToProjectRoot . '/' . $relativePathToFileInProject);
    }

    private function getFileHash(string $path): string
    {
        $contents = \ts\file_get_contents($path);

        return md5($contents);
    }

    /**
     * Loop over all the override files and update with the file contents from the project
     *
     * @return array[] the file paths that have been updated
     */
    public function updateOverrideFiles(): array
    {
        $filesUpdated = [];
        $fileSame     = [];
        foreach ($this->getOverridesIterator() as $pathToFileInOverrides) {
            $relativePathToFileInProject = $this->getRelativePathFromOverridePath($pathToFileInOverrides);
            if ($this->projectFileIsSameAsOverride($pathToFileInOverrides)) {
                $fileSame[] = $relativePathToFileInProject;
                continue;
            }
            copy($this->pathToProjectRoot . $relativePathToFileInProject, $pathToFileInOverrides);
            $filesUpdated[] = $relativePathToFileInProject;
        }

        return [$this->sortFiles($filesUpdated), $this->sortFiles($fileSame)];
    }

    /**
     * Yield file paths in the override folder
     *
     * @return \Generator|string[]
     */
    private function getOverridesIterator(): \Generator
    {
        try {
            $recursiveIterator = new \RecursiveIteratorIterator(
                new \RecursiveDirectoryIterator(
                    $this->getPathToOverridesDirectory(),
                    \RecursiveDirectoryIterator::SKIP_DOTS
                ),
                \RecursiveIteratorIterator::SELF_FIRST
            );
            foreach ($recursiveIterator as $fileInfo) {
                /**
                 * @var \SplFileInfo $fileInfo
                 */
                if ($fileInfo->isFile()) {
                    yield $fileInfo->getPathname();
                }
            }
        } finally {
            $recursiveIterator = null;
            unset($recursiveIterator);
        }
    }

    private function getRelativePathFromOverridePath(string $pathToFileInOverrides): string
    {
        $relativePath = substr($pathToFileInOverrides, strlen($this->getPathToOverridesDirectory()));
        $relativeDir  = dirname($relativePath);
        $filename     = basename($pathToFileInOverrides);
        $filename     = substr($filename, 0, -self::EXTENSION_LENGTH_WITH_HASH) . '.php';

        return $this->getRelativePathToFile(
            $this->getRealPath($this->pathToProjectRoot . '/' . $relativeDir . '/' . $filename)
        );
    }

    /**
     * Is the file in the project the same as the override file already?
     *
     * @param string $pathToFileInOverrides
     *
     * @return bool
     */
    private function projectFileIsSameAsOverride(string $pathToFileInOverrides): bool
    {
        $relativePathToFileInProject = $this->getRelativePathFromOverridePath($pathToFileInOverrides);

        return $this->getFileHash($this->pathToProjectRoot . '/' . $relativePathToFileInProject) ===
               $this->getFileHash($pathToFileInOverrides);
    }

    private function sortFiles(array $files): array
    {
        sort($files, SORT_STRING);

        return $files;
    }

    /**
     * Loop over all the override files and copy into the project
     *
     * @return array[] the file paths that have been updated
     */
    public function applyOverrides(): array
    {
        $filesUpdated = [];
        $filesSame    = [];
        $errors       = [];
        foreach ($this->getOverridesIterator() as $pathToFileInOverrides) {
            $relativePathToFileInProject = $this->getRelativePathFromOverridePath($pathToFileInOverrides);
            if ($this->overrideFileHashIsCorrect($pathToFileInOverrides)) {
                copy($pathToFileInOverrides, $this->pathToProjectRoot . $relativePathToFileInProject);
                $filesUpdated[] = $relativePathToFileInProject;
                continue;
            }
            if ($this->projectFileIsSameAsOverride($pathToFileInOverrides)) {
                $filesSame[] = $relativePathToFileInProject;
                continue;
            }
            $errors[$pathToFileInOverrides] = $this->getProjectFileHash($relativePathToFileInProject);
        }
        if ([] !== $errors) {
            throw new \RuntimeException('These file hashes were not up to date:' . print_r($errors, true));
        }

        return [$this->sortFiles($filesUpdated), $this->sortFiles($filesSame)];
    }

    private function overrideFileHashIsCorrect(string $pathToFileInOverrides): bool
    {
        $filenameParts = explode('.', basename($pathToFileInOverrides));
        if (3 !== count($filenameParts)) {
            throw new \RuntimeException('Invalid override filename ' . $pathToFileInOverrides);
        }
        $hash                        = $filenameParts[1];
        $relativePathToFileInProject = $this->getRelativePathFromOverridePath($pathToFileInOverrides);

        return $hash === $this->getProjectFileHash($relativePathToFileInProject);
    }
}


1		<?php declare(strict_types=1);
2
3		namespace EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\PostProcessor;
4
5		/**
6		* This class provides the necessary functionality to allow you to maintain a set of file overrides and to safely apply
7		* them as part of a post process to your main build process
8		*/
9		class FileOverrider
10		{
11		/**
12		* The default path to the overrides folder, relative to the project root
13		*/
14		public const OVERRIDES_PATH = '/build/overrides';
15
16		private const EXTENSION_LENGTH_NO_HASH = 4;
17		private const EXTENSION_LENGTH_WITH_HASH = 37;
18
19		/**
20		* @var string
21		*/
22		private $pathToProjectRoot;
23
24		/**
25		* @var string
26		*/
27		private $pathToOverridesDirectory;
28
29	15	public function __construct(
30		string $pathToProjectRoot = null,
31		string $relativePathToOverridesDirectory = self::OVERRIDES_PATH
32		) {
33	15	if (null !== $pathToProjectRoot) {
34	15	$this->setPathToProjectRoot($pathToProjectRoot);
35	15	$this->setPathToOverridesDirectory($this->pathToProjectRoot . '/' . $relativePathToOverridesDirectory);
36		}
37	15	}
38
39		/**
40		* @param string $pathToProjectRoot
41		*
42		* @return $this
43		* @throws \RuntimeException
44		*/
45	15	public function setPathToProjectRoot(string $pathToProjectRoot): self
46		{
47	15	$this->pathToProjectRoot = $this->getRealPath($pathToProjectRoot);
48	15	$this->setPathToOverridesDirectory($this->pathToProjectRoot . self::OVERRIDES_PATH);
49
50	15	return $this;
51		}
52
53	15	private function getRealPath(string $path): string
54		{
55	15	$realPath = \realpath($path);
56	15	if (false === $realPath) {
57		if (!mkdir($path, 0777, true) && !is_dir($path)) {
58		throw new \RuntimeException(sprintf('Directory "%s" was not created', $path));
59		}
60		$realPath = realpath($path);
61		}
62
63	15	return $realPath;
64		}
65
66		/**
67		* Create a new Override File by copying the file from the project into the project's overrides directory
68		*
69		* @param string $pathToFileInProject
70		*
71		* @return string
72		*/
73	6	public function createNewOverride(string $pathToFileInProject): string
74		{
75	6	$relativePathToFileInProject = $this->getRelativePathToFile($pathToFileInProject);
76	6	if (null !== $this->getOverrideForPath($relativePathToFileInProject)) {
77	3	throw new \RuntimeException('Override already exists for path ' . $relativePathToFileInProject);
78		}
79		$overridePath =
80	3	$this->getOverrideDirectoryForFile($relativePathToFileInProject) .
81	3	'/' . $this->getFileNameNoExtensionForPath($relativePathToFileInProject) .
82	3	'.' . $this->getProjectFileHash($relativePathToFileInProject) .
83	3	'.php';
84	3	copy($this->pathToProjectRoot . '/' . $relativePathToFileInProject, $overridePath);
85
86	3	return $this->getRelativePathToFile($overridePath);
87		}
88
89	15	private function getRelativePathToFile(string $pathToFileInProject): string
90		{
91	15	return str_replace($this->pathToProjectRoot, '', $this->getRealPath($pathToFileInProject));
92		}
93
94	6	private function getOverrideForPath(string $relativePathToFileInProject): ?string
95		{
96	6	$fileDirectory = $this->getOverrideDirectoryForFile($relativePathToFileInProject);
97	6	$fileNameNoExtension = $this->getFileNameNoExtensionForPath($relativePathToFileInProject);
98	6	$filesInDirectory = glob("$fileDirectory/$fileNameNoExtension*");
99	6	if ([] === $filesInDirectory) {
100	3	return null;
101		}
102	3	if (1 === count($filesInDirectory)) {
103	3	return $fileDirectory . '/' . current($filesInDirectory);
104		}
105		throw new \RuntimeException(
106		'Found more than one override in path ' . $fileDirectory . ': '
107		. print_r($filesInDirectory, true)
108		);
109		}
110
111	6	private function getOverrideDirectoryForFile(string $relativePathToFileInProject): string
112		{
113	6	$path = $this->getPathToOverridesDirectory() . \dirname($relativePathToFileInProject);
114	6	if (!is_dir($path) && !(mkdir($path, 0777, true) && is_dir($path))) {
115		throw new \RuntimeException('Failed making override directory path ' . $path);
116		}
117
118	6	return $this->getRealPath($path);
119		}
120
121		/**
122		* @return string
123		*/
124	15	public function getPathToOverridesDirectory(): string
125		{
126	15	return $this->getRealPath($this->pathToOverridesDirectory);
127		}
128
129		/**
130		* @param string $pathToOverridesDirectory
131		*
132		* @return FileOverrider
133		*/
134	15	public function setPathToOverridesDirectory(string $pathToOverridesDirectory): FileOverrider
135		{
136	15	$this->pathToOverridesDirectory = $this->getRealPath($pathToOverridesDirectory);
137
138	15	return $this;
139		}
140
141	6	private function getFileNameNoExtensionForPath(string $relativePathToFileInProject): string
142		{
143	6	$fileName = basename($relativePathToFileInProject);
144
145	6	return substr($fileName, 0, -self::EXTENSION_LENGTH_NO_HASH);
146		}
147
148	9	private function getProjectFileHash(string $relativePathToFileInProject): string
149		{
150	9	return $this->getFileHash($this->pathToProjectRoot . '/' . $relativePathToFileInProject);
151		}
152
153	12	private function getFileHash(string $path): string
154		{
155	12	$contents = \ts\file_get_contents($path);
156
157	12	return md5($contents);
158		}
159
160		/**
161		* Loop over all the override files and update with the file contents from the project
162		*
163		* @return array[] the file paths that have been updated
164		*/
165	3	public function updateOverrideFiles(): array
166		{
167	3	$filesUpdated = [];
168	3	$fileSame = [];
169	3	foreach ($this->getOverridesIterator() as $pathToFileInOverrides) {
170	3	$relativePathToFileInProject = $this->getRelativePathFromOverridePath($pathToFileInOverrides);
171	3	if ($this->projectFileIsSameAsOverride($pathToFileInOverrides)) {
172		$fileSame[] = $relativePathToFileInProject;
173		continue;
174		}
175	3	copy($this->pathToProjectRoot . $relativePathToFileInProject, $pathToFileInOverrides);
176	3	$filesUpdated[] = $relativePathToFileInProject;
177		}
178
179	3	return [$this->sortFiles($filesUpdated), $this->sortFiles($fileSame)];
180		}
181
182		/**
183		* Yield file paths in the override folder
184		*
185		* @return \Generator\|string[]
186		*/
187	9	private function getOverridesIterator(): \Generator
188		{
189		try {
190	9	$recursiveIterator = new \RecursiveIteratorIterator(
191	9	new \RecursiveDirectoryIterator(
192	9	$this->getPathToOverridesDirectory(),
193	9	\RecursiveDirectoryIterator::SKIP_DOTS
194		),
195	9	\RecursiveIteratorIterator::SELF_FIRST
196		);
197	9	foreach ($recursiveIterator as $fileInfo) {
198		/**
199		* @var \SplFileInfo $fileInfo
200		*/
201	9	if ($fileInfo->isFile()) {
202	9	yield $fileInfo->getPathname();
203		}
204		}
205	9	} finally {
206	9	$recursiveIterator = null;
207	9	unset($recursiveIterator);
208		}
209	9	}
210
211	9	private function getRelativePathFromOverridePath(string $pathToFileInOverrides): string
212		{
213	9	$relativePath = substr($pathToFileInOverrides, strlen($this->getPathToOverridesDirectory()));
214	9	$relativeDir = dirname($relativePath);
215	9	$filename = basename($pathToFileInOverrides);
216	9	$filename = substr($filename, 0, -self::EXTENSION_LENGTH_WITH_HASH) . '.php';
217
218	9	return $this->getRelativePathToFile(
219	9	$this->getRealPath($this->pathToProjectRoot . '/' . $relativeDir . '/' . $filename)
220		);
221		}
222
223		/**
224		* Is the file in the project the same as the override file already?
225		*
226		* @param string $pathToFileInOverrides
227		*
228		* @return bool
229		*/
230	6	private function projectFileIsSameAsOverride(string $pathToFileInOverrides): bool
231		{
232	6	$relativePathToFileInProject = $this->getRelativePathFromOverridePath($pathToFileInOverrides);
233
234	6	return $this->getFileHash($this->pathToProjectRoot . '/' . $relativePathToFileInProject) ===
235	6	$this->getFileHash($pathToFileInOverrides);
236		}
237
238	6	private function sortFiles(array $files): array
239		{
240	6	sort($files, SORT_STRING);
241
242	6	return $files;
243		}
244
245		/**
246		* Loop over all the override files and copy into the project
247		*
248		* @return array[] the file paths that have been updated
249		*/
250	6	public function applyOverrides(): array
251		{
252	6	$filesUpdated = [];
253	6	$filesSame = [];
254	6	$errors = [];
255	6	foreach ($this->getOverridesIterator() as $pathToFileInOverrides) {
256	6	$relativePathToFileInProject = $this->getRelativePathFromOverridePath($pathToFileInOverrides);
257	6	if ($this->overrideFileHashIsCorrect($pathToFileInOverrides)) {
258	3	copy($pathToFileInOverrides, $this->pathToProjectRoot . $relativePathToFileInProject);
259	3	$filesUpdated[] = $relativePathToFileInProject;
260	3	continue;
261		}
262	3	if ($this->projectFileIsSameAsOverride($pathToFileInOverrides)) {
263		$filesSame[] = $relativePathToFileInProject;
264		continue;
265		}
266	3	$errors[$pathToFileInOverrides] = $this->getProjectFileHash($relativePathToFileInProject);
267		}
268	6	if ([] !== $errors) {
269	3	throw new \RuntimeException('These file hashes were not up to date:' . print_r($errors, true));
270		}
271
272	3	return [$this->sortFiles($filesUpdated), $this->sortFiles($filesSame)];
273		}
274
275	6	private function overrideFileHashIsCorrect(string $pathToFileInOverrides): bool
276		{
277	6	$filenameParts = explode('.', basename($pathToFileInOverrides));
278	6	if (3 !== count($filenameParts)) {
279		throw new \RuntimeException('Invalid override filename ' . $pathToFileInOverrides);
280		}
281	6	$hash = $filenameParts[1];
282	6	$relativePathToFileInProject = $this->getRelativePathFromOverridePath($pathToFileInOverrides);
283
284	6	return $hash === $this->getProjectFileHash($relativePathToFileInProject);
285		}
286		}
287

edmondscommerce / doctrine-static-meta

GitHub Access Token became invalid

Pull Request — master (#154)

FileOverrider::getOverridesIterator() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like