Salah3id\Domains\Repository\Generators\Generator

Complexity

Total Complexity

42

Size/Duplication

Total Lines	374
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

21 Methods

Rating	Name	Duplication	Size	Complexity
A	getPath()	0	3	1
A	getOptions()	0	3	1
A	getBasePath()	0	3	1
A	run()	0	11	4
A	getReplacements()	0	6	1
C	getConfigGeneratorClassPath()	0	45	12
A	getStub()	0	9	2
A	getNamespace()	0	10	2
A	setUp()	0	2	1
A	__get()	0	7	2
A	getName()	0	11	3
A	setFilesystem()	0	5	1
A	__construct()	0	6	1
A	getClass()	0	3	1
A	getFilesystem()	0	3	1
A	getOption()	0	7	3
A	getSegments()	0	3	1
A	hasOption()	0	3	1
A	getAppNamespace()	0	3	1
A	option()	0	3	1
A	getRootNamespace()	0	3	1

<?php

namespace Salah3id\Domains\Repository\Generators;

use Illuminate\Filesystem\Filesystem;
use Illuminate\Support\Str;

/**
 * Class Generator
 * @package Salah3id\Domains\Repository\Generators
 * @author Anderson Andrade <contato@andersonandra.de>
 */
abstract class Generator
{

    /**
     * The filesystem instance.
     *
     * @var \Illuminate\Filesystem\Filesystem
     */
    protected $filesystem;

    /**
     * The array of options.
     *
     * @var array
     */
    protected $options;

    /**
     * The shortname of stub.
     *
     * @var string
     */
    protected $stub;


    /**
     * The shortname of domain.
     *
     * @var string
     */
    protected $domain;

    /**
     * The base path for domain.
     *
     * @var string
     */
    protected $domainPath;


    /**
     * Create new instance of this class.
     *
     * @param array $options
     */
    public function __construct(array $options = [],string $domain = null, string $domainPath = null)
    {
        $this->filesystem = new Filesystem;
        $this->options = $options;
        $this->domain = $domain;
        $this->domainPath = $domainPath;
    }


    /**
     * Get the filesystem instance.
     *
     * @return \Illuminate\Filesystem\Filesystem
     */
    public function getFilesystem()
    {
        return $this->filesystem;
    }


    /**
     * Set the filesystem instance.
     *
     * @param \Illuminate\Filesystem\Filesystem $filesystem
     *
     * @return $this
     */
    public function setFilesystem(Filesystem $filesystem)
    {
        $this->filesystem = $filesystem;

        return $this;
    }


    /**
     * Get stub template for generated file.
     *
     * @return string
     */
    public function getStub()
    {
        $path = config('domains.paths.repo-generator.stubsOverridePath', __DIR__);

        if(!file_exists($path . '/Stubs/' . $this->stub . '.stub')){
            $path = __DIR__;
        }

        return (new Stub($path . '/Stubs/' . $this->stub . '.stub', $this->getReplacements()))->render();
    }


    /**
     * Get template replacements.
     *
     * @return array
     */
    public function getReplacements()
    {
        return [
            'class'          => $this->getClass(),
            'namespace'      => $this->getNamespace(),
            'root_namespace' => $this->getRootNamespace()
        ];
    }


    /**
     * Get base path of destination file.
     *
     * @return string
     */
    public function getBasePath()
    {
        return base_path();
    }


    /**
     * Get destination path for generated file.
     *
     * @return string
     */
    public function getPath()
    {
        return $this->getBasePath() . '/' . $this->getName() . '.php';
    }


    /**
     * Get name input.
     *
     * @return string
     */
    public function getName()
    {
        $name = $this->name;

The property name does not exist on Salah3id\Domains\Repository\Generators\Generator. Since you implemented __get, consider adding a @property annotation.

        if (Str::contains($this->name, '\\')) {
            $name = str_replace('\\', '/', $this->name);
        }
        if (Str::contains($this->name, '/')) {
            $name = str_replace('/', '/', $this->name);
        }

        return Str::studly(str_replace(' ', '/', ucwords(str_replace('/', ' ', $name))));
    }


   /**
     * Get application namespace
     *
     * @return string
     */
    public function getAppNamespace()
    {
        return 'Domains\\'.$this->domain.'\\';
    }


    /**
     * Get class name.
     *
     * @return string
     */
    public function getClass()
    {
        return Str::studly(class_basename($this->getName()));
    }


    /**
     * Get paths of namespace.
     *
     * @return array
     */
    public function getSegments()
    {
        return explode('/', $this->getName());
    }


    /**
     * Get root namespace.
     *
     * @return string
     */
    public function getRootNamespace()
    {
        return $this->getAppNamespace();
    }


    /**
     * Get class-specific output paths.
     *
     * @param $class
     *
     * @return string
     */
    public function getConfigGeneratorClassPath($class, $directoryPath = false)
    {
        switch ($class) {
            case ('models' === $class):
                $path = config('domains.paths.repo-generator.paths.models', 'Entities');
                break;
            case ('relations' === $class):
                $path = config('domains.paths.repo-generator.paths.relations', 'Entities/Traits/Relations');
                break;
            case ('repositories' === $class):
                $path = config('domains.paths.repo-generator.paths.repositories', 'Repositories');
                break;
            case ('interfaces' === $class):
                $path = config('domains.paths.repo-generator.paths.interfaces', 'Repositories');
                break;
            case ('presenters' === $class):
                $path = config('domains.paths.repo-generator.paths.presenters', 'Presenters');
                break;
            case ('transformers' === $class):
                $path = config('domains.paths.repo-generator.paths.transformers', 'Transformers');
                break;
            case ('validators' === $class):
                $path = config('domains.paths.repo-generator.paths.validators', 'Validators');
                break;
            case ('controllers' === $class):
                $path = config('domains.paths.repo-generator.paths.controllers', 'Http\Controllers');
                break;
            case ('provider' === $class):
                $path = config('domains.paths.repo-generator.paths.provider', 'RepositoryServiceProvider');
                break;
            case ('criteria' === $class):
                $path = config('domains.paths.repo-generator.paths.criteria', 'Criteria');
                break;
            default:
                $path = '';
        }

        if ($directoryPath) {
            $path = str_replace('\\', '/', $path);
        } else {
            $path = str_replace('/', '\\', $path);
        }


        return $path;
    }


    abstract public function getPathConfigNode();


    /**
     * Get class namespace.
     *
     * @return string
     */
    public function getNamespace()
    {
        $segments = $this->getSegments();
        array_pop($segments);
        $rootNamespace = $this->getRootNamespace();
        if ($rootNamespace == false) {

It seems like you are loosely comparing $rootNamespace of type string to the boolean false. If you are specifically checking for an empty string, consider using the more explicit === '' instead.

            return null;
        }

        return 'namespace ' . rtrim($rootNamespace . '\\' . implode('\\', $segments), '\\') . ';';
    }


    /**
     * Setup some hook.
     *
     * @return void
     */
    public function setUp()
    {
        //
    }


    /**
     * Run the generator.
     *
     * @return int
     * @throws FileAlreadyExistsException
     */
    public function run()
    {
        $this->setUp();
        if ($this->filesystem->exists($path = $this->getPath()) && !$this->force) {

The property force does not exist on Salah3id\Domains\Repository\Generators\Generator. Since you implemented __get, consider adding a @property annotation.

            throw new FileAlreadyExistsException($path);
        }
        if (!$this->filesystem->isDirectory($dir = dirname($path))) {
            $this->filesystem->makeDirectory($dir, 0777, true, true);
        }

        return $this->filesystem->put($path, $this->getStub());
    }


    /**
     * Get options.
     *
     * @return string
     */
    public function getOptions()
    {
        return $this->options;

The expression return $this->options returns the type array which is incompatible with the documented return type string.

    }


    /**
     * Determinte whether the given key exist in options array.
     *
     * @param  string $key
     *
     * @return boolean
     */
    public function hasOption($key)
    {
        return array_key_exists($key, $this->options);
    }


    /**
     * Get value from options by given key.
     *
     * @param  string      $key
     * @param  string|null $default
     *
     * @return string
     */
    public function getOption($key, $default = null)
    {
        if (!$this->hasOption($key)) {
            return $default;
        }

        return $this->options[$key] ?: $default;
    }


    /**
     * Helper method for "getOption".
     *
     * @param  string      $key
     * @param  string|null $default
     *
     * @return string
     */
    public function option($key, $default = null)
    {
        return $this->getOption($key, $default);
    }


    /**
     * Handle call to __get method.
     *
     * @param  string $key
     *
     * @return string|mixed
     */
    public function __get($key)
    {
        if (property_exists($this, $key)) {
            return $this->{$key};
        }

        return $this->option($key);
    }
}