mnabialek / laravel-modular

src/Console/Commands/ModuleMake.php

<?php

namespace Mnabialek\LaravelModular\Console\Commands;

use Mnabialek\LaravelModular\Models\Module;
use Mnabialek\LaravelModular\Traits\Replacer;
use Mnabialek\LaravelModular\Console\Traits\ModuleCreator;

class ModuleMake extends BaseCommand
{
    use Replacer;
    use ModuleCreator;
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'module:make 
    {module* : Module name (or multiple module names space separated)} 
    {--group= : Stub group name that will be used for creating this module}';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Generates new module structure.';

    /**
     * {@inheritdoc}
     */
    public function proceed()
    {
        $moduleNames = collect($this->argument('module'))->unique();

        $stubGroup = $this->getStubGroup();

        // verify whether stub directory exists
        $this->verifyStubGroup($stubGroup);

        $moduleNames->each(function ($moduleName) use ($stubGroup) {
            $module = $this->createModuleObject($moduleName);

            // module added to configuration or module directory exists
            if ($this->laravel['modular']->exists($module->name())
                || $this->exists($module->directory())
            ) {
                $this->warn("[Module {$module->name()}] Module already exists - ignoring");
            } else {
                // module does not exist - let's create it
                $this->createModule($module, $stubGroup);
                $this->info("[Module {$module->name()}] Module was generated");
            }
        });
    }

    /**
     * Create module object (it does not mean module exists)
     *
     * @param string $moduleName
     *
     * @return Module
     */
    protected function createModuleObject($moduleName)
    {
        return new Module($moduleName, $this->laravel);
    }

    /**
     * Create module
     *
     * @param Module $module
     * @param string $stubGroup
     */
    protected function createModule(Module $module, $stubGroup)
    {
        // first create directories
        $this->createModuleDirectories($module, $stubGroup);

        // now create files
        $this->createModuleFiles($module, $stubGroup);

        // finally add module to configuration (if not disabled in config)
        $this->addModuleToConfigurationFile($module);
    }

    /**
     * Add module to configuration file
     *
     * @param $module
     */
    protected function addModuleToConfigurationFile(Module $module)
    {
        $configFile = $this->laravel['modular.config']->configPath();

        if (!$this->laravel['modular.config']->autoAdd()) {
            $this->info("[Module {$module->name()}] - auto-adding to config file turned off\n" .
                "Please add this module manually into {$configFile} file if you want to use it");

            return;
        }

        // getting modified content of config file
        $result =
            preg_replace_callback($this->laravel['modular.config']->autoAddPattern(),
                function ($matches) use ($module, $configFile) {
                    return $matches[1] . $matches[2] .
                    $this->replace($this->laravel['modular.config']->autoAddTemplate(),
                        $module) .
                    $matches[3];
                },
                $this->laravel['files']->get($configFile), -1, $count);

        if ($count) {

The expression $count of type integer|null is loosely compared to true; this is ambiguous if the integer can be zero. You might want to explicitly use !== null instead.

            // found place where new module should be added into config file
            $this->laravel['files']->put($configFile, $result);
            $this->comment("[Module {$module->name()}] Added into config file {$configFile}");
        } else {
            // cannot add module to config file automatically
            $this->warn("[Module {$module->name()}] It was impossible to add module into {$configFile}" .
                " file.\n Please make sure you haven't changed structure of this file. " .
                "At the moment add <info>{$module->name()}</info> to this file manually");
        }
    }
}