ldc-flucollector/app/Console/Commands/GenerateClient.php

<?php

namespace App\Console\Commands;

use App\Enums\Api\ApiError;
use App\Enums\Api\ApiStatus;
use App\Enums\XmlInco\PortionType;
use App\Exceptions\Api\ApiErrorException;
use App\Exceptions\Api\ApplicationException;
use App\Lib\XmlInco\Allegations;
use App\Lib\XmlInco\NutritionalValues;
use App\Lib\XmlInco\PortionAmount;
use App\Traits\Enums\BaseEnum;
use Illuminate\Console\Command;
use Illuminate\Support\Facades\File;
use Illuminate\Support\Facades\Route;
use Illuminate\Support\Str;

/**
 * @codeCoverageIgnore
 */
class GenerateClient extends Command
{
    private const TARGET          = 'client/src';
    private const CLIENTNAMESPACE = 'UWIL\\Flucollector';

    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'client:generate';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Generate the flucollector client in `client` folder';

    /**
     * Execute the console command.
     *
     * @return integer
     */
    public function handle(): int
    {
        $this->copyLibXmlIncoClasses();
        $this->copyTraits();
        $this->copyEnums();
        $this->copyExceptions();
        $this->copyRoutesList();
        $this->copyApiConfigInfo();
        return 0;
    }

    /**
     * Copy config files
     *
     * @return void
     */
    private function copyApiConfigInfo(): void
    {
        $this->info('Copy Api Config');
        $rootTarget = app_path('../' . self::TARGET);
        if (File::exists("$rootTarget/../apiConfig.readonly.json")) {
            File::delete("$rootTarget/../apiConfig.readonly.json");
        }
        File::put(
            "$rootTarget/../apiConfig.readonly.json",
            \json_encode(config('api'), JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES)
        );
    }

    /**
     * Copy routes into a json file
     *
     * @return void
     */
    private function copyRoutesList(): void
    {
        $this->info('Copy Routes');
        $routes = [];
        /** @var \Illuminate\Routing\Route */
        foreach (Route::getRoutes() as $route) {
            if (\strpos($route->getPrefix(), 'api') !== false) {
                $routes[$route->getName()] = [
                    'uri' => $route->uri(),
                    'methods' => $route->methods()
                ];
            }
        }
        $rootTarget = app_path('../' . self::TARGET);
        if (File::exists("$rootTarget/routes.json")) {
            File::delete("$rootTarget/routes.json");
        }
        File::put(
            "$rootTarget/routes.json",
            \json_encode($routes, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES)
        );
    }

    /**
     * Copy Exeption classes
     *
     * @return void
     */
    private function copyExceptions(): void
    {
        $this->info('Copy Exceptions');
        $rootTarget = app_path('../' . self::TARGET);
        $classes    = [
            ApplicationException::class,
            ApiErrorException::class
        ];
        $this->copyToFolder($classes, 'Exceptions');

        foreach ($classes as $class) {
            $classBasename = class_basename($class);
            $dest          = "$rootTarget/Exceptions/$classBasename.php";
            $this->replaceInPhpFile($dest, 'App\\', self::CLIENTNAMESPACE . '\\');
        }
    }

    /**
     * Copy base enums classes
     *
     * @return void
     */
    private function copyTraits(): void
    {
        $this->info('Copy Traits');
        $rootTarget = app_path('../' . self::TARGET);
        $classes    = [
            BaseEnum::class
        ];
        $this->copyToFolder($classes, 'Traits');
        foreach ($classes as $class) {
            $classBasename = class_basename($class);
            $dest          = "$rootTarget/Traits/$classBasename.php";
            $this->replaceInPhpFile($dest, 'App\\', self::CLIENTNAMESPACE . '\\');
        }
    }

    /**
     * Copy enums classes
     *
     * @return void
     */
    private function copyEnums(): void
    {
        $this->info('Copy Enums');
        $classes = [
            ApiError::class,
            ApiStatus::class,
            PortionType::class,
        ];
        $this->copyToFolder($classes, 'Enums');
        $rootTarget = app_path('../' . self::TARGET);
        foreach ($classes as $class) {
            $classBasename = class_basename($class);
            $dest          = "{$rootTarget}/Enums/{$classBasename}.php";
            $this->replaceInPhpFile($dest, 'App\\', self::CLIENTNAMESPACE . '\\');
        }
    }

    /**
     * Copy lib XmlInco classes
     *
     * @return void
     */
    private function copyLibXmlIncoClasses(): void
    {
        $this->info('Copy Lib XmlInco classes');
        $classes = [
            Allegations::class,
            NutritionalValues::class,
            PortionAmount::class,
        ];
        $this->copyToFolder($classes, 'Lib');
        $rootTarget = app_path('../' . self::TARGET);
        foreach ($classes as $class) {
            $classBasename = class_basename($class);
            $dest          = "{$rootTarget}/Lib/{$classBasename}.php";
            $this->replaceInPhpFile($dest, 'App\\', self::CLIENTNAMESPACE . '\\');
        }
    }

    /**
     * Copy Classes to specified folder
     *
     * @param array  $classes
     * @param string $folder
     * @return void
     */
    private function copyToFolder(array $classes, string $folder): void
    {
        $rootTarget      = app_path('../' . self::TARGET);
        $folderNamespace = \str_replace('/', '\\', $folder);
        foreach ($classes as $class) {
            $classFileName = \str_replace("App\\$folderNamespace\\", '', sprintf('%s.php', $class));
            $classFileName = \str_replace('\\', '/', $classFileName);
            $classBasename = class_basename($class);
            $source        = \app_path("$folder/$classFileName");
            $dest          = "$rootTarget/$folder/$classBasename.php";
            if (File::exists($dest)) {
                File::delete($dest);
            }
            File::copy($source, $dest);
            $this->replaceInPhpFile($dest, 'namespace App', 'namespace ' . self::CLIENTNAMESPACE);
        }
    }

    /**
     * Replaces a specific string with another on a file
     *
     * @param string $source
     * @param string $search
     * @param string $replace
     * @return void
     */
    private function replaceInPhpFile(string $source, string $search, string $replace): void
    {
        $fContent = File::get($source);

        // Remove trailing \Api .
        $fContent = Str::of($fContent)->replaceMatches("/\\\(Api)([\s;\\\])/", '$2');
        // Remove trailing \XmlInco .
        $fContent = Str::of($fContent)->replaceMatches("/\\\(XmlInco)([\s;\\\])/", '$2');
        $fContent = Str::of($fContent)->replaceMatches("/\\\Traits\\\Enums/", '\Traits');

        // Replace namespace top level.
        $pos = strpos($fContent, $search);
        if ($pos !== false) {
            File::put($source, \str_replace($search, $replace, $fContent));
        }
    }
}