MakeTransformerCommand::getModelsDirectory() - Code Metrics - Inspection of "Bulk transformers generation" - rexlabsio/smokescreen-laravel-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#13)

by Andrea Marco
created 2018-06-15 05:53 UTC
MakeTransformerCommand::getModelsDirectory() A

↳ Parent: MakeTransformerCommand
Complexity

Conditions	3
Paths	2
Size

Total Lines	9
Code Lines	4
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	3
eloc	4
nc	2
nop	0
dl	0
loc	9
rs	9.6666
c	0
b	0
f	0
<?php

namespace Rexlabs\Laravel\Smokescreen\Console;

use Illuminate\Console\GeneratorCommand;
use Illuminate\Contracts\View\Factory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Filesystem\Filesystem;

class MakeTransformerCommand extends GeneratorCommand
{
    /**
     * The name and signature of the console command.
     * make:transformer User
     *
     * @var string
     */
    protected $signature = 'make:transformer
        {model? : The name of the model to transform. e.g. User} 
        {--f|force : Overwrite an existing transformer}
        {--a|all= : Generate a transformer for all models. You can optionally specify the models directory}';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Create a new smokescreen transformer class';

    /**
     * The view factory.
     *
     * @var \Illuminate\Contracts\View\Factory
     */
    protected $viewFactory;

    /**
     * Inject the dependencies.
     *
     * @param \Illuminate\Filesystem\Filesystem  $files
     * @param \Illuminate\Contracts\View\Factory $viewFactory
     */
    public function __construct(
        Filesystem $files,
        Factory $viewFactory
    ) {
        parent::__construct($files);

        $this->viewFactory = $viewFactory;
    }

    /**
     * {@inheritdoc}
     */
    public function handle()
    {
        $model = $this->getModelName();
        $this->type = "{$model} transformer";

        if (is_null($this->argument('model'))) {

            $this->generateAllTransformers();
        } elseif (!class_exists($this->getModelClass())) {
            $this->error("The model [{$model}] does not exist.");
        } elseif (class_exists($this->getTransformerClass()) && !$this->option('force')) {
            $this->warn("{$this->type} already exists.");
        } else {
            parent::handle();
        }
    }

    /**
     * Generate a transformer for every model.
     *
     * @return void
     */
    protected function generateAllTransformers() : void
    {
        $directory = $this->getModelsDirectory();
        $models = (new ModelsFinder)->findInDirectory($directory);

        foreach ($models as $model) {
            $this->call('make:transformer', [
                'model' => class_basename($model),
                '--force' => $this->option('force'),
            ]);
        }
    }

    /**
     * Retrieve the models directory.
     *
     * @return string
     */
    protected function getModelsDirectory() : string
    {
        $relativePath = $this->option('all') ?: config('smokescreen.models_directory');

        if (!file_exists($absolutePath = base_path($relativePath))) {
            exit($this->error("The specified models directory does not exist: {$absolutePath}"));
interface ReturnsInt {
    public function returnsIntHinted(): int;
}

class MyClass implements ReturnsInt {
    public function returnsIntHinted(): int
    {
        if (foo()) {
            return 123;
        }
        // here: null is implicitly returned
    }
}
        }

        return $absolutePath;
    }

    /**
     * {@inheritdoc}
     */
    protected function getStub()
    {
        return 'smokescreen::transformer';
    }

    /**
     * {@inheritdoc}
     */
    protected function buildClass($name)
    {
        return $this->viewFactory->make($this->getStub(), $this->getTemplateData())
            ->render();
    }

    /**
     * @throws \ReflectionException
     *
     * @return array
     */
    protected function getTemplateData()
    {
        $modelInspector = new ModelMapper($this->getModel());

        return [
            'model' => $this->getModel(),
            'modelClass' => $this->getModelClass(),
            'modelNamespace' => $this->getModelNamespace(),
            'modelName' => $this->getModelName(),
            'transformerClass' => $this->getTransformerClass(),
            'transformerNamespace' => $this->getTransformerNamespace(),
            'transformerName' => $this->getTransformerName(),
            'includes' => $modelInspector->getIncludes(),
            'properties' => $modelInspector->getDeclaredProperties(),
            'defaultProperties' => $modelInspector->getDefaultProperties(),
        ];
    }

    /**
     * {@inheritdoc}
     */
    protected function getNameInput()
    {
        return $this->getTransformerClass();
    }

    /**
     * Get the transformer class name.
     *
     * @return string
     */
    protected function getTransformerName()
    {
        return preg_replace(
            '/{ModelName}/i',
            $this->getModelName(),
            config('smokescreen.transformer_name', '{ModelName}Transformer')
        );
    }

    /**
     * Retrieve the transformer namespace.
     *
     * @return \Illuminate\Config\Repository|mixed
     */
    protected function getTransformerNamespace()
    {
        return config('smokescreen.transformer_namespace', 'App\Transformers');
    }

    /**
     * Retrieve the transformer class including namespace.
     *
     * @return string
     */
    protected function getTransformerClass()
    {
        return $this->getTransformerNamespace() . '\\' . $this->getTransformerName();
        return /** @scrutinizer ignore-type */ $this->getTransformerNamespace() . '\\' . $this->getTransformerName();
    }

    /**
     * Retrieve the model class including namespace.
     *
     * @return string
     */
    protected function getModelClass(): string
    {
        $directory = config('smokescreen.models_directory', 'app/');
        $file = str_finish($directory, '/') . $this->getModelName();
        $segments = array_map('ucfirst', explode('/', $file));

        return implode('\\', $segments);
    }

    /**
     * Get the eloquent model instance.
     *
     * @return Model
     */
    protected function getModel(): Model
    {
        $class = $this->getModelClass();

        return new $class();
    }

    /**
     * Retrieve the model class name.
     *
     * @return string
     */
    protected function getModelName(): string
    {
        return ucfirst($this->argument('model'));
        return ucfirst(/** @scrutinizer ignore-type */ $this->argument('model'));
    }

    /**
     * Get the namespace of the model class.
     *
     * @return string
     */
    protected function getModelNamespace()
    {
        return $this->getNamespace($this->getModelClass());
    }
}

rexlabsio / smokescreen-laravel-php

Pull Request — master (#13)

MakeTransformerCommand::getModelsDirectory() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
