VendorPublishCommand::publishFile() - Code Metrics - Inspection of "Add support to publish templates" - platine-php/framework - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed
Push — develop ( f7f0fb...a5cb71 )

by nguereza
created 2023-11-19 06:44 UTC
VendorPublishCommand::publishFile() A

↳ Parent: VendorPublishCommand
Complexity

Conditions	3
Paths	2
Size

Total Lines	18
Code Lines	13
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	3
eloc	13
nc	2
nop	2
dl	0
loc	18
rs	9.8333
c	0
b	0
f	0
<?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 VendorPublishCommand.php
 *
 *  The Composer vendor publish command class
 *
 *  @package    Platine\Framework\Console\Command
 *  @author Platine Developers team
 *  @copyright  Copyright (c) 2020
 *  @license    http://opensource.org/licenses/MIT  MIT License
 *  @link   https://www.platine-php.com
 *  @version 1.0.0
 *  @filesource
 */

declare(strict_types=1);

namespace Platine\Framework\Console\Command;

use Platine\Config\Config;
use Platine\Console\Command\Command;
use Platine\Filesystem\DirectoryInterface;
use Platine\Filesystem\FileInterface;
use Platine\Filesystem\Filesystem;
use Platine\Framework\App\Application;
use Platine\Stdlib\Helper\Composer;
use Platine\Stdlib\Helper\Path;

/**
 * @class VendorPublishCommand
 * @package Platine\Framework\Console\Command
 * @template T
 */
class VendorPublishCommand extends Command
{
    /**
     * Application instance
     * @var Application
     */
    protected Application $application;

    /**
     * The vendor path
     * @var string
     */
    protected string $vendorPath;

    /**
     * The package installation path
     * @var string
     */
    protected string $packagePath = '';

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

    /**
     * Package manifest information
     * @var array<string, mixed>
     */
    protected array $manifest = [];

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

    /**
     * Create new instance
     * @param Application $app
     * @param Filesystem $filesystem
     * @param Config<T> $config
     */
    public function __construct(
        Application $app,
        Filesystem $filesystem,
        Config $config
    ) {
        parent::__construct(
            'vendor:publish',
            'Command to publish composer vendor configuration, migration, language etc.'
        );
        $this->addArgument('name', 'The package name', null, true);
        $this->addOption('-o|--overwrite', 'Overwrite existing files.', false, false);
        $this->addOption('-c|--config', 'Publish only the configuration.', false, false);
        $this->addOption('-m|--migration', 'Publish only the migrations.', false, false);
        $this->addOption('-l|--lang', 'Publish only the languages.', false, false);
        $this->addOption('-t|--template', 'Publish only the templates.', false, false);
        $this->addOption('-a|--all', 'Publish all files.', false, false);

        $this->config = $config;
        $this->filesystem = $filesystem;
        $this->application = $app;
        $this->vendorPath = Path::normalizePathDS($app->getVendorPath(), true);
    }

    /**
     * {@inheritdoc}
     */
    public function execute()
    {
        $writer = $this->io()->writer();
        $name = $this->getArgumentValue('name');
        $writer->boldGreen(sprintf('PUBLISH OF PACKAGE [%s]', $name), true)->eol();

        $package = $this->getPackageInfo($name);
        $package = $this->getPackageInfo(/** @scrutinizer ignore-type */ $name);
        if (empty($package)) {
            $writer->red(sprintf(
                'Can not find the composer package [%s].',
                $name
            ), true);
            return;
        }

        $packagePath = $this->vendorPath . $name;
        $packagePath = Path::convert2Absolute($packagePath);

        $this->packagePath = $packagePath;

        $writer->bold('Name: ');
        $writer->boldBlueBgBlack($package['name'], true);

        $writer->bold('Description: ');
        $writer->boldBlueBgBlack($package['description'], true);

        $writer->bold('Version: ');
        $writer->boldBlueBgBlack($package['version'], true);

        $writer->bold('Type: ');
        $writer->boldBlueBgBlack($package['type'], true);

        $writer->bold('Path: ');
        $writer->boldBlueBgBlack($packagePath, true)->eol();

        $extras = $package['extra'] ?? [];
        $manifest = $extras['platine'] ?? [];

        if (empty($manifest)) {
            $writer->boldGreen('NOTHING TO PUBLISH, COMMAND ENDED!', true);
            return;
        }

        $this->manifest = $manifest;

        $this->publishPackage();

        $writer->eol();
        $writer->boldGreen('Command finished successfully')->eol();
    }

    /**
     * Package publication
     * @return void
     */
    protected function publishPackage(): void
    {
        $all = $this->getOptionValue('all');
        if ($all) {
            $this->publishAll();
            return;
        }

        $config = $this->getOptionValue('config');
        if ($config) {
            $this->publishConfiguration();
        }

        $migration = $this->getOptionValue('migration');
        if ($migration) {
            $this->publishMigration();
        }

        $lang = $this->getOptionValue('lang');
        if ($lang) {
            $this->publishLanguage();
        }
        
        $template = $this->getOptionValue('template');
        if ($template) {
            $this->publishTemplate();
        }
    }

    /**
     * Publish all assets for this package
     * @return void
     */
    protected function publishAll(): void
    {
        $this->publishConfiguration();
        $this->publishMigration();
        $this->publishLanguage();
        $this->publishTemplate();
    }

    /**
     * Publish the configuration
     * @return void
     */
    protected function publishConfiguration(): void
    {
        $writer = $this->io()->writer();
        $writer->boldYellow('Publish of package configuration', true);

        $manifest = $this->manifest;
        $config = $manifest['config'] ?? [];
        $destinationPath = Path::normalizePathDS(
            $this->application->getConfigPath(),
            true
        );
        foreach ($config as $cfg) {
            $this->publishItem($cfg, $destinationPath, 'configuration');
        }
    }

    /**
     * Publish the language
     * @return void
     */
    protected function publishLanguage(): void
    {
        $writer = $this->io()->writer();
        $writer->boldYellow('Publish of package language', true);

        $path = Path::convert2Absolute(
            $this->config->get('lang.translation_path')
            /** @scrutinizer ignore-type */ $this->config->get('lang.translation_path')
        );
        $destinationPath = Path::normalizePathDS($path, true);

        $manifest = $this->manifest;
        $languages = $manifest['lang'] ?? [];
        foreach ($languages as $language) {
            $this->publishItem($language, $destinationPath, 'language');
        }
    }

    /**
     * Publish the migration
     * @return void
     */
    protected function publishMigration(): void
    {
        $writer = $this->io()->writer();
        $writer->boldYellow('Publish of package migration', true);


        $path = Path::convert2Absolute(
            $this->config->get('database.migration.path', 'migrations')
        );
        $destinationPath = Path::normalizePathDS($path, true);

        $manifest = $this->manifest;
        $migrations = $manifest['migration'] ?? [];
        foreach ($migrations as $migration) {
            $this->publishItem($migration, $destinationPath, 'migration');
        }
    }
    
    /**
     * Publish the template
     * @return void
     */
    protected function publishTemplate(): void
    {
        $writer = $this->io()->writer();
        $writer->boldYellow('Publish of package template', true);


        $path = Path::convert2Absolute(
            $this->config->get('template.template_dir', 'templates')
        );
        $destinationPath = Path::normalizePathDS($path, true);

        $manifest = $this->manifest;
        $templates = $manifest['template'] ?? [];
        foreach ($templates as $template) {
            $this->publishItem($template, $destinationPath, 'template');
        }
    }

    /**
     * Publish asset
     * @param string $src
     * @param string $dest
     * @param string $type
     * @return void
     */
    protected function publishItem(string $src, string $dest, string $type): void
    {
        $writer = $this->io()->writer();

        $sourcePath = $this->packagePath . '/' . $src;
        $asset = $this->filesystem->get($sourcePath);
        if ($asset === null) {
            $writer->red(sprintf(
                'Can not find the package file %s [%s].',
                $type,
                $sourcePath
            ), true);
            return;
        }

        if ($asset instanceof DirectoryInterface) {
            $this->publishDirectory($asset, $dest);
        } elseif ($asset instanceof FileInterface) {

            $this->publishFile($asset, $dest);
        }

        $writer->boldGreen(
            sprintf(
                'Package %s [%s] publish successfully',
                $type,
                $src
            ),
            true
        );
    }

    /**
     * Copy file to the destination
     * @param FileInterface $file
     * @param string $dest
     * @return void
     */
    protected function publishFile(FileInterface $file, string $dest): void
    {
        $sourceFilename = $file->getName();
        $destFile = $this->filesystem->file(
            $dest . $sourceFilename
        );

        $overwrite = $this->getOptionValue('overwrite');

        $writer = $this->io()->writer();
        if ($destFile->exists() && !$overwrite) {
            $writer->red(sprintf(
                "File \n[%s]\n already exist, if you want to overwrite"
                    . ' use option "--overwrite".',
                $destFile->getPath()
            ), true);
        } else {
            $file->copyTo($dest);
        }
    }

    /**
     * Publish directory
     * @param DirectoryInterface $directory
     * @param string $dest
     * @return void
     */
    protected function publishDirectory(DirectoryInterface $directory, string $dest): void
    {
        foreach ($directory->read() as $item) {
            $item->copyTo($dest);
        }
    }

    /**
     * Return the information for given package
     * @param string $name
     * @return array<string, mixed>
     */
    protected function getPackageInfo(string $name): array
    {
        $packages = Composer::parseLockFile($this->application->getRootPath());
        foreach ($packages as $package) {
            $packageName = $package['name'] ?? '';
            if ($name === $packageName) {
                return $package;
            }
        }

        return [];
    }
}

platine-php / framework

Push — develop ( f7f0fb...a5cb71 )

VendorPublishCommand::publishFile() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
