Salah3id\Domains\Generators\DomainGenerator

Complexity

Total Complexity

53

Size/Duplication

Total Lines	572
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

35 Methods

Rating	Name	Duplication	Size	Complexity
A	setComponent()	0	4	1
A	generate()	0	35	5
A	generateResources()	0	23	3
A	setConsole()	0	5	1
A	generateFolders()	0	14	4
A	getFiles()	0	3	1
A	getProviderNamespaceReplacement()	0	3	1
A	getFilesystem()	0	3	1
A	generateFiles()	0	11	3
A	setActive()	0	5	1
A	getStubContents()	0	7	1
A	getStudlyNameReplacement()	0	3	1
A	setForce()	0	5	1
A	cleanDomainJsonFile()	0	13	1
A	getAuthorEmailReplacement()	0	3	1
A	setDomain()	0	5	1
B	getReplacement()	0	26	7
A	setConfig()	0	5	1
A	getConfig()	0	3	1
A	setFilesystem()	0	5	1
A	getAuthorNameReplacement()	0	3	1
A	getFolders()	0	3	1
A	getName()	0	3	1
A	generateDomainJsonFile()	0	10	2
A	generateGitKeep()	0	3	1
A	getDomainNamespaceReplacement()	0	3	1
A	getConsole()	0	3	1
A	getDomain()	0	3	1
A	getLowerNameReplacement()	0	3	1
A	getReplacements()	0	3	1
A	setActivator()	0	5	1
A	__construct()	0	14	1
A	getComponent()	0	3	1
A	getVendorReplacement()	0	3	1
A	setType()	0	5	1

<?php

namespace Salah3id\Domains\Generators;

use Illuminate\Config\Repository as Config;
use Illuminate\Console\Command as Console;
use Illuminate\Filesystem\Filesystem;
use Illuminate\Support\Str;
use Salah3id\Domains\Contracts\ActivatorInterface;
use Salah3id\Domains\FileRepository;
use Salah3id\Domains\Support\Config\GenerateConfigReader;
use Salah3id\Domains\Support\Stub;

class DomainGenerator extends Generator
{
    /**
     * The domain name will created.
     *
     * @var string
     */
    protected $name;

    /**
     * The laravel config instance.
     *
     * @var Config
     */
    protected $config;

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

    /**
     * The laravel console instance.
     *
     * @var Console
     */
    protected $console;

    /**
     * The laravel component Factory instance.
     *
     * @var \Illuminate\Console\View\Components\Factory
     */
    protected $component;


    /**
     * The activator instance
     *
     * @var ActivatorInterface
     */
    protected $activator;

    /**
     * The domain instance.
     *
     * @var \Salah3id\Domains\Domain
     */
    protected $domain;

    /**
     * Force status.
     *
     * @var bool
     */
    protected $force = false;

    /**
     * set default domain type.
     *
     * @var string
     */
    protected $type = 'web';

    /**
     * Enables the domain.
     *
     * @var bool
     */
    protected $isActive = false;

    /**
     * The constructor.
     * @param $name
     * @param FileRepository $domain
     * @param Config     $config
     * @param Filesystem $filesystem
     * @param Console    $console
     */
    public function __construct(
        $name,
        FileRepository $domain = null,
        Config $config = null,
        Filesystem $filesystem = null,
        Console $console = null,
        ActivatorInterface $activator = null
    ) {
        $this->name = $name;
        $this->config = $config;
        $this->filesystem = $filesystem;
        $this->console = $console;
        $this->domain = $domain;

It seems like $domain can also be of type Salah3id\Domains\FileRepository. However, the property $domain is declared as type Salah3id\Domains\Domain. Maybe add an additional type check?

        $this->activator = $activator;
    }

    /**
     * Set type.
     *
     * @param string $type
     *
     * @return $this
     */
    public function setType($type)
    {
        $this->type = $type;

        return $this;
    }

    /**
     * Set active flag.
     *
     * @param bool $active
     *
     * @return $this
     */
    public function setActive(bool $active)
    {
        $this->isActive = $active;

        return $this;
    }

    /**
     * Get the name of domain will created. By default in studly case.
     *
     * @return string
     */
    public function getName()
    {
        return Str::studly($this->name);
    }

    /**
     * Get the laravel config instance.
     *
     * @return Config
     */
    public function getConfig()
    {
        return $this->config;
    }

    /**
     * Set the laravel config instance.
     *
     * @param Config $config
     *
     * @return $this
     */
    public function setConfig($config)
    {
        $this->config = $config;

        return $this;
    }

    /**
     * Set the domains activator
     *
     * @param ActivatorInterface $activator
     *
     * @return $this
     */
    public function setActivator(ActivatorInterface $activator)
    {
        $this->activator = $activator;

        return $this;
    }

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

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

        return $this;
    }

    /**
     * Get the laravel console instance.
     *
     * @return Console
     */
    public function getConsole()
    {
        return $this->console;
    }

    /**
     * Set the laravel console instance.
     *
     * @param Console $console
     *
     * @return $this
     */
    public function setConsole($console)
    {
        $this->console = $console;

        return $this;
    }

    /**
     * @return \Illuminate\Console\View\Components\Factory
     */
    public function getComponent(): \Illuminate\Console\View\Components\Factory
    {
        return $this->component;
    }

    /**
     * @param \Illuminate\Console\View\Components\Factory $component
     */
    public function setComponent(\Illuminate\Console\View\Components\Factory $component): self
    {
        $this->component = $component;
        return $this;
    }

    /**
     * Get the domain instance.
     *
     * @return \Salah3id\Domains\Domain
     */
    public function getDomain()
    {
        return $this->domain;
    }

    /**
     * Set the domain instance.
     *
     * @param mixed $domain
     *
     * @return $this
     */
    public function setDomain($domain)
    {
        $this->domain = $domain;

        return $this;
    }

    /**
     * Get the list of folders will created.
     *
     * @return array
     */
    public function getFolders()
    {
        return $this->domain->config('paths.generator');

The method config() does not exist on Salah3id\Domains\Domain. Since you implemented __call, consider adding a @method annotation.

    }

    /**
     * Get the list of files will created.
     *
     * @return array
     */
    public function getFiles()
    {
        return $this->domain->config('stubs.files');
    }

    /**
     * Set force status.
     *
     * @param bool|int $force
     *
     * @return $this
     */
    public function setForce($force)
    {
        $this->force = $force;

It seems like $force can also be of type integer. However, the property $force is declared as type boolean. Maybe add an additional type check?

        return $this;
    }

    /**
     * Generate the domain.
     */
    public function generate(): int
    {
        $name = $this->getName();

        if ($this->domain->has($name)) {

The method has() does not exist on Salah3id\Domains\Domain. Since you implemented __call, consider adding a @method annotation.

            if ($this->force) {
                $this->domain->delete($name);

The call to Salah3id\Domains\Domain::delete() has too many arguments starting with $name.

            } else {
                $this->component->error("Domain [{$name}] already exists!");

                return E_ERROR;
            }
        }
        $this->component->info("Creating domain: [$name]");

        $this->generateFolders();

        $this->generateDomainJsonFile();

        if ($this->type !== 'plain') {
            $this->generateFiles();
            $this->generateResources();
        }

        if ($this->type === 'plain') {
            $this->cleanDomainJsonFile();
        }

        $this->activator->setActiveByName($name, $this->isActive);

        $this->console->newLine(1);

        $this->component->info("Domain [{$name}] created successfully.");

        return 0;
    }

    /**
     * Generate the folders.
     */
    public function generateFolders()
    {
        foreach ($this->getFolders() as $key => $folder) {
            $folder = GenerateConfigReader::read($key);

            if ($folder->generate() === false) {
                continue;
            }

            $path = $this->domain->getDomainPath($this->getName()) . '/' . $folder->getPath();

The method getDomainPath() does not exist on Salah3id\Domains\Domain. Since you implemented __call, consider adding a @method annotation.

            $this->filesystem->makeDirectory($path, 0755, true);
            if (config('domains.stubs.gitkeep')) {
                $this->generateGitKeep($path);
            }
        }
    }

    /**
     * Generate git keep to the specified path.
     *
     * @param string $path
     */
    public function generateGitKeep($path)
    {
        $this->filesystem->put($path . '/.gitkeep', '');
    }

    /**
     * Generate the files.
     */
    public function generateFiles()
    {
        foreach ($this->getFiles() as $stub => $file) {
            $path = $this->domain->getDomainPath($this->getName()) . $file;

            $this->component->task("Generating file {$path}",function () use ($stub, $path) {
                if (!$this->filesystem->isDirectory($dir = dirname($path))) {
                    $this->filesystem->makeDirectory($dir, 0775, true);
                }

                $this->filesystem->put($path, $this->getStubContents($stub));
            });
        }
    }

    /**
     * Generate some resources.
     */
    public function generateResources()
    {
        if (GenerateConfigReader::read('seeder')->generate() === true) {
            $this->console->call('domain:make-seed', [
                'name' => $this->getName(),
                'domain' => $this->getName(),
                '--master' => true,
            ]);
        }

        if (GenerateConfigReader::read('provider')->generate() === true) {
            $this->console->call('domain:make-provider', [
                'name' => $this->getName() . 'ServiceProvider',
                'domain' => $this->getName(),
                '--master' => true,
            ]);
            $this->console->call('domain:route-provider', [
                'domain' => $this->getName(),
            ]);

            $this->console->call('domain:make-provider', [
                'name' => 'RepositoryServiceProvider',
                'domain' => $this->getName(),
            ]);
        }
    }

    /**
     * Get the contents of the specified stub file by given stub name.
     *
     * @param $stub
     *
     * @return string
     */
    protected function getStubContents($stub)
    {
        return (new Stub(
            '/' . $stub . '.stub',
            $this->getReplacement($stub)
        )
        )->render();
    }

    /**
     * get the list for the replacements.
     */
    public function getReplacements()
    {
        return $this->domain->config('stubs.replacements');
    }

    /**
     * Get array replacement for the specified stub.
     *
     * @param $stub
     *
     * @return array
     */
    protected function getReplacement($stub)
    {
        $replacements = $this->domain->config('stubs.replacements');

        if (!isset($replacements[$stub])) {
            return [];
        }

        $keys = $replacements[$stub];

        $replaces = [];

        if ($stub === 'json' || $stub === 'composer') {
            if (in_array('PROVIDER_NAMESPACE', $keys, true) === false) {
                $keys[] = 'PROVIDER_NAMESPACE';
            }
        }
        foreach ($keys as $key) {
            if (method_exists($this, $method = 'get' . ucfirst(Str::studly(strtolower($key))) . 'Replacement')) {
                $replaces[$key] = $this->$method();
            } else {
                $replaces[$key] = null;
            }
        }

        return $replaces;
    }

    /**
     * Generate the domain.json file
     */
    private function generateDomainJsonFile()
    {
        $path = $this->domain->getDomainPath($this->getName()) . 'domain.json';

        $this->component->task("Generating file $path",function () use ($path) {
            if (!$this->filesystem->isDirectory($dir = dirname($path))) {
                $this->filesystem->makeDirectory($dir, 0775, true);
            }

            $this->filesystem->put($path, $this->getStubContents('json'));
        });
    }

    /**
     * Remove the default service provider that was added in the domain.json file
     * This is needed when a --plain domain was created
     */
    private function cleanDomainJsonFile()
    {
        $path = $this->domain->getDomainPath($this->getName()) . 'domain.json';

        $content = $this->filesystem->get($path);
        $namespace = $this->getDomainNamespaceReplacement();
        $studlyName = $this->getStudlyNameReplacement();

        $provider = '"' . $namespace . '\\\\' . $studlyName . '\\\\Providers\\\\' . $studlyName . 'ServiceProvider"';

        $content = str_replace($provider, '', $content);

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

    /**
     * Get the domain name in lower case.
     *
     * @return string
     */
    protected function getLowerNameReplacement()
    {
        return strtolower($this->getName());
    }

    /**
     * Get the domain name in studly case.
     *
     * @return string
     */
    protected function getStudlyNameReplacement()
    {
        return $this->getName();
    }

    /**
     * Get replacement for $VENDOR$.
     *
     * @return string
     */
    protected function getVendorReplacement()
    {
        return $this->domain->config('composer.vendor');
    }

    /**
     * Get replacement for $DOMAIN_NAMESPACE$.
     *
     * @return string
     */
    protected function getDomainNamespaceReplacement()
    {
        return str_replace('\\', '\\\\', $this->domain->config('namespace'));
    }

    /**
     * Get replacement for $AUTHOR_NAME$.
     *
     * @return string
     */
    protected function getAuthorNameReplacement()
    {
        return $this->domain->config('composer.author.name');
    }

    /**
     * Get replacement for $AUTHOR_EMAIL$.
     *
     * @return string
     */
    protected function getAuthorEmailReplacement()
    {
        return $this->domain->config('composer.author.email');
    }

    protected function getProviderNamespaceReplacement(): string
    {
        return str_replace('\\', '\\\\', GenerateConfigReader::read('provider')->getNamespace());
    }
}