platine-php / framework

src/Console/MakeCommand.php

<?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 MakeCommand.php
 *
 *  The Make Command base class
 *
 *  @package    Platine\Framework\Console
 *  @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;

use Platine\Console\Input\Reader;
use Platine\Console\Output\Writer;
use Platine\Filesystem\Filesystem;
use Platine\Framework\App\Application;

/**
 * @class MakeCommand
 * @package Platine\Framework\Console
 */
abstract class MakeCommand extends BaseCommand
{
    /**
     * The type of class
     * @var string
     */
    protected string $type = '';

    /**
     * The class full name given by user
     * @var string
     */
    protected string $className = '';

    /**
     * The action properties
     * @var array<string, array<string, mixed>>
     */
    protected array $properties = [];

    /**
     * Create new instance
     * @param Application $application
     * @param Filesystem $filesystem
     */
    public function __construct(
        Application $application,
        Filesystem $filesystem
    ) {
        parent::__construct($application, $filesystem);
        $this->addArgument('name', 'The full class name (without the root namespace)', null, false);
        $this->addOption('-f|--force', 'Overwrite existing files.', false, false);
    }

    /**
     * {@inheritdoc}
     */
    public function execute(): mixed
    {
        $io = $this->io();
        $writer = $io->writer();
        $name = $this->className;

        $className = $this->getFullClassName($name);
        $path = $this->getPath($name);
        $namespace = $this->getNamespace($name);

        $writer->boldGreen(sprintf(
            'Generation of new %s class [%s]',
            $this->type,
            $className
        ), true)->eol();


        if ($this->fileExists($name) && !$this->getOptionValue('force')) {
            $writer->red(sprintf(
                'File [%s] already exists.',
                $path
            ), true);

            return true;
        }

        $writer->bold('Class: ');
        $writer->boldBlueBgBlack($className, true);

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

        $writer->bold('Namespace: ');
        $writer->boldBlueBgBlack($namespace, true);

        if ($io->confirm(sprintf('Are you confirm the generation of [%s] ?', $className), 'y')) {
            $this->createParentDirectory($path);
            $content = $this->createClass();

            $file = $this->filesystem->file($path);
            $file->write($content);
            $writer->boldGreen(sprintf('Class [%s] generated successfully.', $className), true);
        }

        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function interact(Reader $reader, Writer $writer): void
    {
        $writer->boldYellow('GENERATION OF NEW CLASS', true)->eol();
        $name = $this->getArgumentValue('name');
        if (empty($name)) {
            $io = $this->io();
            $name = $io->prompt('Enter the full class name (can include root namespace)', null);
        }

        $this->className = $name;
    }

    /**
     * Return the the class template
     * @return string
     */
    abstract public function getClassTemplate(): string;

    /**
     * Create the class for the given name
     * @return string
     */
    protected function createClass(): string
    {
        $template = $this->getClassTemplate();

        $replaceNamespace = $this->replaceNamespace($template);
        $replaceUses = $this->replaceClassUses($replaceNamespace);
        $replaceClasses = $this->replaceClasses($replaceUses);
        $replaceProperties = $this->replaceProperties($replaceClasses);
        $replaceConstructor = $this->replaceConstructor($replaceProperties);
        $replaceMethodBody = $this->replaceMethodBody($replaceConstructor);

        return $replaceMethodBody;
    }

    /**
     * Replace the name space
     * @param string $content
     * @return string
     */
    protected function replaceNamespace(string $content): string
    {
        $namespace = $this->getNamespace($this->className);
        return str_replace('%namespace%', $namespace, $content);
    }

    /**
     * Replace the properties
     * @param string $content
     * @return string
     */
    protected function replaceProperties(string $content): string
    {
        $replaceContent = $this->getPropertiesContent();
        return str_replace('%properties%', $replaceContent, $content);
    }

    /**
     * Replace the constructor
     * @param string $content
     * @return string
     */
    protected function replaceConstructor(string $content): string
    {
        $replaceContent = $this->getConstructorContent();

        return str_replace('%constructor%', $replaceContent, $content);
    }

    /**
     * Replace the method body
     * @param string $content
     * @return string
     */
    protected function replaceMethodBody(string $content): string
    {
        $replaceContent = $this->getMethodBodyContent();

        return str_replace('%method_body%', $replaceContent, $content);
    }

    /**
     * Replace the class uses instructions
     * @param string $content
     * @return string
     */
    protected function replaceClassUses(string $content): string
    {
        $replaceContent = $this->getUsesContent();
        return str_replace('%uses%', $replaceContent, $content);
    }

    /**
     * Replace the classes
     * @param string $content
     * @return string
     */
    protected function replaceClasses(string $content): string
    {
        $shortClassName = $this->getShortClassName($this->className);
        $fullClassName = $this->getFullClassName($this->className);

        $replaced = str_replace('%classname%', $shortClassName, $content);

        return str_replace('%fullclassname%', $fullClassName, $replaced);
    }

    /**
     * Return the properties content
     * @return string
     */
    protected function getPropertiesContent(): string
    {
        if (count($this->properties) === 0) {
            return '';
        }

        $content = '';

        foreach ($this->properties as $className => $info) {
            $content .= $this->getPropertyTemplate($className, $info);
        }

        return $content;
    }

    /**
     * Return the name space uses content
     * @return string
     */
    protected function getUsesContent(): string
    {
        if (count($this->properties) === 0) {
            return '';
        }

        $content = '';

        foreach ($this->properties as $className => $info) {
            $content .= $this->getUsesTemplate($className);
        }

        return $content;
    }


    /**
     * Return the constructor content
     * @return string
     */
    protected function getConstructorContent(): string
    {
        if (count($this->properties) === 0) {
            return '';
        }

        $docblock = $this->getConstructorDocBlockContent();
        $params = $this->getConstructorParamsContent();
        $body = $this->getConstructorBodyContent();

        return <<<EOF
        $docblock
            public function __construct(
               $params
            ){
                $body
            }
        EOF;
    }

    /**
     * Return the constructor content
     * @return string
     */
    protected function getMethodBodyContent(): string
    {
        return '';
    }


    /**
     * Return the constructor document block comment content
     * @return string
     */
    protected function getConstructorDocBlockContent(): string
    {
        $content = '';
        foreach ($this->properties as $className => $info) {
            $content .= $this->getConstructorDocBlockTemplate($className, $info);
        }

        return <<<EOF
        /**
            * Create new instance
            $content*/
        EOF;
    }

    /**
     * Return the constructor parameters content
     * @return string
     */
    protected function getConstructorParamsContent(): string
    {
        $content = '';
        $i = 1;
        $count = count($this->properties);
        foreach ($this->properties as $className => $info) {
            $content .= $this->getConstructorParamsTemplate(
                $className,
                $info,
                $i === $count
            );
            $i++;
        }

        return $content;
    }

    /**
     * Return the constructor body content
     * @return string
     */
    protected function getConstructorBodyContent(): string
    {
        // TODO: since PHP 8 we use the feature
        // of constructor property promotion
        return '';
    }

    /**
     * Return the constructor document block template for the given class
     * @param string $className
     * @param array<string, string> $info
     * @return string
     */
    protected function getConstructorDocBlockTemplate(string $className, array $info): string

The parameter $className is not used and could be removed.

    {
        $shortClass = $info['short'];
        $name = $info['name'];

        return <<<EOF
        * @param $shortClass \$$name 
            
        EOF;
    }

    /**
     * Return the constructor arguments template for the given class
     * @param string $className
     * @param array<string, string> $info
     * @param bool $isLast
     * @return string
     */
    protected function getConstructorParamsTemplate(
        string $className,

The parameter $className is not used and could be removed.

        array $info,
        bool $isLast = false
    ): string {
        $shortClass = $info['short'];
        $name = $info['name'];

        if ($isLast) {
            return <<<EOF
            protected $shortClass \$$name,
            EOF;
        }

        return <<<EOF
        protected $shortClass \$$name,
               
        EOF;
    }

    /**
     * Return the property template for the given class
     * @param string $className
     * @param array<string, mixed> $info
     * @return string
     */
    protected function getPropertyTemplate(string $className, array $info): string
    {
        // TODO: since PHP 8 we use the feature
        // of constructor property promotion

        return '';
    }

    /**
     * Return the name space use template for the given class
     * @param string $className
     * @return string
     */
    protected function getUsesTemplate(string $className): string
    {
        return <<<EOF
        use $className; 
        
        EOF;
    }
}