ModelCommand::isValidTemplate() - Code Metrics - Inspection of "`make:model` command outputs file with same name a..." - spider-mane/leonidas - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 65b7f9...30151a )

by Chris
created 2022-06-24 21:45 UTC
ModelCommand::isValidTemplate() A

↳ Parent: ModelCommand
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Importance

Changes
Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	1
dl	0
loc	3
ccs	0
cts	2
cp	0
crap	2
rs	10
<?php

namespace Leonidas\Console\Command\Make;

use DirectoryIterator;
use Leonidas\Console\Command\HopliteCommand;
use Leonidas\Console\Library\ModelComponentFactory;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputOption;

class ModelCommand extends HopliteCommand
{
    protected const CORE_FILE_METHODS = [
        'makeModelFiles',
        'makeCollectionFiles',
        'makeRepositoryFiles',
    ];

    protected const SUPPORT_FILE_METHODS = [
        'makeFactoryFiles',
        'makeAccessProviderFiles',
    ];

    protected const VALID_TEMPLATES = [
        'post',
        'post:h',
        'attachment',
        'term',
        'term:h',
        'user',
    ];

    protected static $defaultName = 'make:model';

    protected function configure()
    {
        $this
            ->addArgument('model', InputArgument::REQUIRED, '')
            ->addArgument('entity', InputArgument::REQUIRED, '')
            ->addArgument('single', InputArgument::REQUIRED, '')
            ->addArgument('plural', InputArgument::REQUIRED, '')
            ->addOption('namespace', 'l', InputOption::VALUE_OPTIONAL, '')
            ->addOption('contracts', 'c', InputOption::VALUE_OPTIONAL, '')
            ->addOption('abstracts', 'a', InputOption::VALUE_OPTIONAL, '')
            ->addOption('template', 't', InputOption::VALUE_REQUIRED, '', 'post')
            ->addOption('components', 'p', InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'The component set to generate')
            ->addOption('design', 'd', InputOption::VALUE_NONE, 'Generate interfaces only')
            ->addOption('build', 'b', InputOption::VALUE_NONE, 'Generate classes using interfaces as guide')
            ->addOption('replace', 'r', InputOption::VALUE_OPTIONAL, '');
    }

    protected function handle(): int
    {
        $template = $this->input->getOption('template');

        if ($this->isValidTemplate($template)) {
            $status = $this->makeFiles($template);
        } else {
            $this->output->error("Value \"{$template}\" is not an accepted value for template");

            $status = self::FAILURE;
        }

        return $status;
    }

    protected function isValidTemplate(string $template): bool
    {
        return in_array($template, static::VALID_TEMPLATES);
    }

    protected function makeFiles(string $template): int
    {
        $factory = $this->getComponentFactory($template);
        $action = $this->resolveRequestedAction();
        $paths = $this->getOutputPaths();

        foreach (static::CORE_FILE_METHODS as $method) {
            $status = $this->$method($factory, $action, $paths);

            if (self::SUCCESS !== $status) {
                return $status;
            }
        }

        if ('interfaces' !== $action) {
            foreach (static::SUPPORT_FILE_METHODS as $method) {
                $status = $this->$method($factory, $paths);

                if (self::SUCCESS !== $status) {
                    return $status;
                }
            }
        }

        $this->output->success("Successfully created model files");

        return self::SUCCESS;
    }

    protected function getComponentFactory(string $template): ModelComponentFactory
    {
        $model = $this->input->getArgument('model');
        $entity = $this->input->getArgument('entity');
        $single = $this->input->getArgument('single');
        $plural = $this->input->getArgument('plural');

        $model = $this->convert($model)->toPascal();

        $namespace = $this->getNamespaceFromPath($this->configuredOption(
        $namespace = $this->getNamespaceFromPath(/** @scrutinizer ignore-type */ $this->configuredOption(
            'namespace',
            'make.model.namespace'
        )) . '\\' . $model;

        $contracts = $this->getNamespaceFromPath($this->configuredOption(
            'contracts',
            'make.model.contracts'
        )) . '\\' . $model;

        $abstracts = $this->resolveAbstractNamespace($namespace);

        $factory = ModelComponentFactory::build([
            'model' => $model,
            'namespace' => $namespace,
            'contracts' => $contracts,
            'abstracts' => $abstracts,
            'entity' => $entity,
            'single' => $single,
            'plural' => $plural,
            'template' => $template,
        ]);

        return $factory;
    }

    protected function resolveRequestedAction(): string
    {
        if ($this->input->getOption('design')) {
            return 'interfaces';
        } elseif ($this->input->getOption('build')) {
            return 'classes';
        } else {
            return 'complete';
        }
    }

    protected function getOutputPaths(): array
    {
        $playground = $this->setupTestDir();

        return [
            'interfaces' => $playground,
            'abstracts' => $playground,
            'classes' => $playground,
        ];
    }

    protected function setupTestDir(): string
    {
        $playground = $this->external('/.playground/model');

        if ($this->filesystem->exists($playground)) {
            // $this->filesystem->remove($playground);
        } else {
            $this->filesystem->mkdir($playground);
        }

        foreach (new DirectoryIterator($playground) as $file) {
            if (!$file->isFile()) {
                continue;
            }

            if (!str_ends_with($file->getBasename(), 'Interface.php')) {
                $this->filesystem->remove($file->getPathname());
            } else {
                require $file->getPathname();
            }
        }

        return $playground;
    }

    protected function makeModelFiles(ModelComponentFactory $factory, string $action, array $paths): int
    {
        $interface = $factory->getModelInterfacePrinter();
        $class = $factory->getModelPrinter();

        $interfaceFile = $this->phpFile($paths['interfaces'], $interface->getClass());
        $classFile = $this->phpFile($paths['classes'], $class->getClass());

        if ('interfaces' === $action || 'complete' === $action) {
            $this->writeFile($interfaceFile, $interface->printFile());
        } elseif ('classes' === $action) {
            if (!interface_exists($interfaceFqn = $interface->getClassFqn())) {
                $this->output->error("Interface {$interfaceFqn} does not exist");

                return self::INVALID;
            }

            $this->writeFile($classFile, $class->printFromType());
        }

        if ('complete' === $action) {
            $this->writeFile($classFile, $class->printFile());
        }

        return self::SUCCESS;
    }

    protected function makeCollectionFiles(ModelComponentFactory $factory, string $action, array $paths): int
    {
        $isPost = $factory->isPostTemplate();

        $interface = $factory->getCollectionInterfacePrinter();
        $collection = $isPost
            ? $factory->getChildCollectionPrinter()
            : $factory->getCollectionPrinter();
        $abstract = $factory->getAbstractCollectionPrinter();
        $query = $factory->getChildQueryPrinter();

        $interfaceFile = $this->phpFile($paths['interfaces'], $interface->getClass());
        $collectionFile = $this->phpFile($paths['classes'], $collection->getClass());
        $abstractFile = $this->phpFile($paths['abstracts'], $abstract->getClass());
        $queryFile = $this->phpFile($paths['classes'], $query->getClass());

        if ('interfaces' === $action || 'complete' === $action) {
            $this->writeFile($interfaceFile, $interface->printFile());
        } elseif ('classes' === $action) {
            if (!interface_exists($interface->getClassFqn())) {
                $this->output->error("Interface {$interface->getClassFqn()} does not exist");

                return self::INVALID;
            }

            if ($isPost) {
                $this->writeFile($abstractFile, $abstract->printFromType());
                $this->writeFile($collectionFile, $collection->printFile());
                $this->writeFile($queryFile, $query->printFile());
            } else {
                $this->writeFile($collectionFile, $collection->printFromType());
                $this->writeFile($collectionFile, $collection->/** @scrutinizer ignore-call */ printFromType());
            }
        }

        if ('complete' === $action) {
            $this->writeFile($collectionFile, $collection->printFile());

            if ($isPost) {
                $this->writeFile($abstractFile, $abstract->printFile());
                $this->writeFile($queryFile, $query->printFile());
            }
        }

        return self::SUCCESS;
    }

    protected function makeRepositoryFiles(ModelComponentFactory $factory, string $action, array $paths): int
    {
        $interface = $factory->getRepositoryInterfacePrinter();
        $class = $factory->getRepositoryPrinter();

        $interfaceFile = $this->phpFile($paths['interfaces'], $interface->getClass());
        $classFile = $this->phpFile($paths['classes'], $class->getClass());

        if ('interfaces' === $action || 'complete' === $action) {
            $this->writeFile($interfaceFile, $interface->printFile());
        } elseif ('classes' === $action) {
            if (!interface_exists($interfaceFqn = $interface->getClassFqn())) {
                $this->output->error("Interface {$interfaceFqn} does not exist");

                return self::INVALID;
            }

            $this->writeFile($classFile, $class->printFromType());
        }

        if ('complete' === $action) {
            $this->writeFile($classFile, $class->printFile());
        }

        return self::SUCCESS;
    }

    protected function makeFactoryFiles(ModelComponentFactory $factory, array $paths): int
    {
        $model = $factory->getModelConverterPrinter();
        $collection = $factory->getCollectionFactoryPrinter();

        $modelFile = $this->phpFile($paths['classes'], $model->getClass());
        $collectionFile = $this->phpFile($paths['classes'], $collection->getClass());

        $this->writeFile($modelFile, $model->printFile());
        $this->writeFile($collectionFile, $collection->printFile());

        if ($factory->isPostTemplate()) {
            $query = $factory->getQueryFactoryPrinter();
            $queryFile = $this->phpFile($paths['classes'], $query->getClass());

            $this->writeFile($queryFile, $query->printFile());
        }

        return self::SUCCESS;
    }

    protected function makeAccessProviderFiles(ModelComponentFactory $factory, array $paths): int
    {
        $get = $factory->getGetAccessProviderPrinter();
        $set = $factory->getSetAccessProviderPrinter();

        $getFile = $this->phpFile($paths['classes'], $get->getClass());
        $setFile = $this->phpFile($paths['classes'], $set->getClass());

        $this->writeFile($getFile, $get->printFile());
        $this->writeFile($setFile, $set->printFile());

        if ($factory->isPostTemplate()) {
            $tag = $factory->getTagAccessProviderPrinter();
            $tagFile = $this->phpFile($paths['classes'], $tag->getClass());

            $this->writeFile($tagFile, $tag->printFile());
        }

        return self::SUCCESS;
    }
}

spider-mane / leonidas

Push — master ( 65b7f9...30151a )

ModelCommand::isValidTemplate() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
