AbstractCommand::checkMigrationPath() - Code Metrics - Inspection of "Add route command and rewrite migration" - platine-php/framework - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — develop ( 0204ba...bd77d0 )

by nguereza

created 2021-07-05 06:30 UTC

AbstractCommand::checkMigrationPath() A

↳ Parent: AbstractCommand

Complexity

Conditions	3
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
eloc	5
c	1
b	0
f	0
nc	2
nop	0
dl	0
loc	8
rs	10

<?php

/**
 * Platine Framework
 *
 * Platine Framework is a lightweight, high-performance, simple and elegant
 * PHP Web framework
 *
 * This content is released under the MIT License (MIT)
 *
 * Copyright (c) 2020 Platine Framework
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 *  @file AbstractCommand.php
 *
 *  The Base migration command class
 *
 *  @package    Platine\Framework\Migration\Command
 *  @author Platine Developers team
 *  @copyright  Copyright (c) 2020
 *  @license    http://opensource.org/licenses/MIT  MIT License
 *  @link   http://www.iacademy.cf
 *  @version 1.0.0
 *  @filesource
 */

declare(strict_types=1);

namespace Platine\Framework\Migration\Command;

use Platine\Config\Config;
use Platine\Console\Command\Command;
use Platine\Database\Connection;
use Platine\Database\Exception\QueryPrepareException;
use Platine\Database\Schema;
use Platine\Database\Schema\CreateTable;
use Platine\Filesystem\DirectoryInterface;
use Platine\Filesystem\FileInterface;
use Platine\Filesystem\Filesystem;
use Platine\Framework\App\Application;
use Platine\Framework\Migration\AbstractMigration;
use Platine\Framework\Migration\MigrationRepository;
use Platine\Stdlib\Helper\Path;
use Platine\Stdlib\Helper\Str;
use RuntimeException;

/**
 * class AbstractCommand
 * @package Platine\Framework\Migration\Command
 */
abstract class AbstractCommand extends Command
{

    /**
     * The migration repository
     * @var MigrationRepository
     */
    protected MigrationRepository $repository;

    /**
     * The schema to use
     * @var Schema
     */
    protected Schema $schema;

    /**
     * The configuration to use
     * @var Config
     */
    protected Config $config;

    /**
     * The file system to use
     * @var Filesystem
     */
    protected Filesystem $filesystem;

    /**
     * The Platine Application
     * @var Application
     */
    protected Application $application;

    /**
     * The migration files path
     * @var string
     */
    protected string $migrationPath = '';

    /**
     * Migration table name
     * @var string
     */
    protected string $table = 'migrations';

    /**
     * Create new instance
     * @param Application $app
     * @param MigrationRepository $repository
     * @param Schema $schema
     * @param Config $config
     * @param Filesystem $filesystem
     */
    public function __construct(
        Application $app,
        MigrationRepository $repository,
        Schema $schema,
        Config $config,
        Filesystem $filesystem
    ) {
        parent::__construct('migration', 'Command to manage database migration');
        $this->application = $app;
        $this->repository = $repository;
        $this->schema = $schema;
        $this->config = $config;
        $this->filesystem = $filesystem;
        $path = Path::convert2Absolute($config->get('migration.path', 'migrations'));
        $this->migrationPath = Path::normalizePathDS($path, true);
        $this->table = $config->get('migration.table', 'migrations');
    }

    /**
     * Check the migration directory
     * @return void
     */
    protected function checkMigrationPath(): void
    {
        $directory = $this->filesystem->directory($this->migrationPath);

        if (!$directory->exists() || !$directory->isWritable()) {
            throw new RuntimeException(sprintf(
                'Migration directory [%s] does not exist or is writable',
                $this->migrationPath
            ));
        }
    }

    /**
     * Check if migration table does not exist and create it
     * @return void
     */
    protected function checkMigrationTable(): void
    {
        try {
            $this->repository->find('xx');
        } catch (QueryPrepareException $ex) {
            $this->createMigrationTable();
        }
    }

    /**
     * Create migration table
     * @return void
     */
    protected function createMigrationTable(): void
    {
        $tableName = $this->config->get('migration.table', 'migrations');
        $this->schema->create($tableName, function (CreateTable $table) {
            $table->string('version', 20)
                   ->description('The migration version')
                   ->primary();
            $table->string('description')
                   ->description('The migration description');
            $table->datetime('created_at')
                    ->description('Migration run time');

            $table->engine('INNODB');
        });
    }

    /**
     * Create migration class for the given version
     * @param string $description
     * @param string $version
     * @return AbstractMigration
     */
    protected function createMigrationClass(
        string $description,
        string $version
    ): AbstractMigration {
        $this->checkMigrationPath();

        $className = $this->getMigrationClassName($description, $version);
        $filename = $this->getFilenameFromClass($className, $version);
        $fullPath = $this->migrationPath . $filename;

        $file = $this->filesystem->file($fullPath);
        $fullClasName = 'Platine\\Framework\\Migration\\' . $className;

        if (!$file->exists()) {
            throw new RuntimeException(sprintf(
                'Migration file [%s] does not exist',
                $fullPath
            ));
        }

        require_once $fullPath;

        if (!class_exists($fullClasName)) {
            throw new RuntimeException(sprintf(
                'Migration class [%s] does not exist',
                $fullClasName
            ));
        }

        $connection = $this->application->get(Connection::class);

        return new $fullClasName($connection);
    }

    /**
     * Return all migrations files available
     * @return array<string, string>
     */
    protected function getMigrations(): array
    {
        $this->checkMigrationPath();

        $directory = $this->filesystem->directory($this->migrationPath);
        $result = [];
        /** @var FileInterface[] $files */
        $files = $directory->read(DirectoryInterface::FILE);
        foreach ($files as $file) {
            $matches = [];
            if (preg_match('/^([0-9_]+)_([a-z_]+)\.php$/i', $file->getName(), $matches)) {
                $result[$matches[1]] = $matches[2];
            }
        }

        ksort($result);

        return $result;
    }

    /**
     * Return the executed migration
     * @param string $orderDir
     * @return array<string, Entity>
     */
    protected function getExecuted(string $orderDir = 'ASC'): array
    {
        $this->checkMigrationTable();

        $migrations = $this->repository
                           ->query()
                           ->orderBy('version', $orderDir)
                           ->all();
        $result = [];

        foreach ($migrations as $entity) {
            $result[$entity->version] = $entity;
        }

        return $result;
    }

    /**
     * Return the migration class name for the given name
     * @param string $description
     * @param string $version
     * @return string
     */
    protected function getMigrationClassName(string $description, string $version): string
    {
        return Str::camel($description, false)
               . Str::replaceFirst('_', '', $version);
    }

    /**
     * Return the name of the migration file
     * @param string $className
     * @param string $version
     * @return string
     */
    protected function getFilenameFromClass(string $className, string $version): string
    {
        return $filename = sprintf(

            '%s_%s.php',
            $version,
            str_replace(Str::replaceFirst('_', '', $version), '', Str::snake($className))
        );
    }
}


1			<?php
2
3			/**
4			* Platine Framework
5			*
6			* Platine Framework is a lightweight, high-performance, simple and elegant
7			* PHP Web framework
8			*
9			* This content is released under the MIT License (MIT)
10			*
11			* Copyright (c) 2020 Platine Framework
12			*
13			* Permission is hereby granted, free of charge, to any person obtaining a copy
14			* of this software and associated documentation files (the "Software"), to deal
15			* in the Software without restriction, including without limitation the rights
16			* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17			* copies of the Software, and to permit persons to whom the Software is
18			* furnished to do so, subject to the following conditions:
19			*
20			* The above copyright notice and this permission notice shall be included in all
21			* copies or substantial portions of the Software.
22			*
23			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29			* SOFTWARE.
30			*/
31
32			/**
33			* @file AbstractCommand.php
34			*
35			* The Base migration command class
36			*
37			* @package Platine\Framework\Migration\Command
38			* @author Platine Developers team
39			* @copyright Copyright (c) 2020
40			* @license http://opensource.org/licenses/MIT MIT License
41			* @link http://www.iacademy.cf
42			* @version 1.0.0
43			* @filesource
44			*/
45
46			declare(strict_types=1);
47
48			namespace Platine\Framework\Migration\Command;
49
50			use Platine\Config\Config;
51			use Platine\Console\Command\Command;
52			use Platine\Database\Connection;
53			use Platine\Database\Exception\QueryPrepareException;
54			use Platine\Database\Schema;
55			use Platine\Database\Schema\CreateTable;
56			use Platine\Filesystem\DirectoryInterface;
57			use Platine\Filesystem\FileInterface;
58			use Platine\Filesystem\Filesystem;
59			use Platine\Framework\App\Application;
60			use Platine\Framework\Migration\AbstractMigration;
61			use Platine\Framework\Migration\MigrationRepository;
62			use Platine\Stdlib\Helper\Path;
63			use Platine\Stdlib\Helper\Str;
64			use RuntimeException;
65
66			/**
67			* class AbstractCommand
68			* @package Platine\Framework\Migration\Command
69			*/
70			abstract class AbstractCommand extends Command
71			{
72
73			/**
74			* The migration repository
75			* @var MigrationRepository
76			*/
77			protected MigrationRepository $repository;
78
79			/**
80			* The schema to use
81			* @var Schema
82			*/
83			protected Schema $schema;
84
85			/**
86			* The configuration to use
87			* @var Config
88			*/
89			protected Config $config;
90
91			/**
92			* The file system to use
93			* @var Filesystem
94			*/
95			protected Filesystem $filesystem;
96
97			/**
98			* The Platine Application
99			* @var Application
100			*/
101			protected Application $application;
102
103			/**
104			* The migration files path
105			* @var string
106			*/
107			protected string $migrationPath = '';
108
109			/**
110			* Migration table name
111			* @var string
112			*/
113			protected string $table = 'migrations';
114
115			/**
116			* Create new instance
117			* @param Application $app
118			* @param MigrationRepository $repository
119			* @param Schema $schema
120			* @param Config $config
121			* @param Filesystem $filesystem
122			*/
123			public function __construct(
124			Application $app,
125			MigrationRepository $repository,
126			Schema $schema,
127			Config $config,
128			Filesystem $filesystem
129			) {
130			parent::__construct('migration', 'Command to manage database migration');
131			$this->application = $app;
132			$this->repository = $repository;
133			$this->schema = $schema;
134			$this->config = $config;
135			$this->filesystem = $filesystem;
136			$path = Path::convert2Absolute($config->get('migration.path', 'migrations'));
137			$this->migrationPath = Path::normalizePathDS($path, true);
138			$this->table = $config->get('migration.table', 'migrations');
139			}
140
141			/**
142			* Check the migration directory
143			* @return void
144			*/
145			protected function checkMigrationPath(): void
146			{
147			$directory = $this->filesystem->directory($this->migrationPath);
148
149			if (!$directory->exists() \|\| !$directory->isWritable()) {
150			throw new RuntimeException(sprintf(
151			'Migration directory [%s] does not exist or is writable',
152			$this->migrationPath
153			));
154			}
155			}
156
157			/**
158			* Check if migration table does not exist and create it
159			* @return void
160			*/
161			protected function checkMigrationTable(): void
162			{
163			try {
164			$this->repository->find('xx');
165			} catch (QueryPrepareException $ex) {
166			$this->createMigrationTable();
167			}
168			}
169
170			/**
171			* Create migration table
172			* @return void
173			*/
174			protected function createMigrationTable(): void
175			{
176			$tableName = $this->config->get('migration.table', 'migrations');
177			$this->schema->create($tableName, function (CreateTable $table) {
178			$table->string('version', 20)
179			->description('The migration version')
180			->primary();
181			$table->string('description')
182			->description('The migration description');
183			$table->datetime('created_at')
184			->description('Migration run time');
185
186			$table->engine('INNODB');
187			});
188			}
189
190			/**
191			* Create migration class for the given version
192			* @param string $description
193			* @param string $version
194			* @return AbstractMigration
195			*/
196			protected function createMigrationClass(
197			string $description,
198			string $version
199			): AbstractMigration {
200			$this->checkMigrationPath();
201
202			$className = $this->getMigrationClassName($description, $version);
203			$filename = $this->getFilenameFromClass($className, $version);
204			$fullPath = $this->migrationPath . $filename;
205
206			$file = $this->filesystem->file($fullPath);
207			$fullClasName = 'Platine\\Framework\\Migration\\' . $className;
208
209			if (!$file->exists()) {
210			throw new RuntimeException(sprintf(
211			'Migration file [%s] does not exist',
212			$fullPath
213			));
214			}
215
216			require_once $fullPath;
217
218			if (!class_exists($fullClasName)) {
219			throw new RuntimeException(sprintf(
220			'Migration class [%s] does not exist',
221			$fullClasName
222			));
223			}
224
225			$connection = $this->application->get(Connection::class);
226
227			return new $fullClasName($connection);
228			}
229
230			/**
231			* Return all migrations files available
232			* @return array<string, string>
233			*/
234			protected function getMigrations(): array
235			{
236			$this->checkMigrationPath();
237
238			$directory = $this->filesystem->directory($this->migrationPath);
239			$result = [];
240			/** @var FileInterface[] $files */
241			$files = $directory->read(DirectoryInterface::FILE);
242			foreach ($files as $file) {
243			$matches = [];
244			if (preg_match('/^([0-9_]+)_([a-z_]+)\.php$/i', $file->getName(), $matches)) {
245			$result[$matches[1]] = $matches[2];
246			}
247			}
248
249			ksort($result);
250
251			return $result;
252			}
253
254			/**
255			* Return the executed migration
256			* @param string $orderDir
257			* @return array<string, Entity>
258			*/
259			protected function getExecuted(string $orderDir = 'ASC'): array
260			{
261			$this->checkMigrationTable();
262
263			$migrations = $this->repository
264			->query()
265			->orderBy('version', $orderDir)
266			->all();
267			$result = [];
268
269			foreach ($migrations as $entity) {
270			$result[$entity->version] = $entity;
271			}
272
273			return $result;
274			}
275
276			/**
277			* Return the migration class name for the given name
278			* @param string $description
279			* @param string $version
280			* @return string
281			*/
282			protected function getMigrationClassName(string $description, string $version): string
283			{
284			return Str::camel($description, false)
285			. Str::replaceFirst('_', '', $version);
286			}
287
288			/**
289			* Return the name of the migration file
290			* @param string $className
291			* @param string $version
292			* @return string
293			*/
294			protected function getFilenameFromClass(string $className, string $version): string
295			{
296			return $filename = sprintf(
			0 ignored issues – show Unused Code introduced 2021-07-05 06:34 UTC by Report Bug Copy Issue Report The assignment to `$filename` is dead and can be removed. Loading history...
297			'%s_%s.php',
298			$version,
299			str_replace(Str::replaceFirst('_', '', $version), '', Str::snake($className))
300			);
301			}
302			}
303

platine-php / framework

Push — develop ( 0204ba...bd77d0 )

AbstractCommand::checkMigrationPath() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like