cerbero90 / console-tasker

src/Console/Tasks/CreateCommandTasks.php

<?php

namespace Cerbero\ConsoleTasker\Console\Tasks;

use Cerbero\ConsoleTasker\Console\ParsedTask;
use Cerbero\ConsoleTasker\Console\TasksParser;
use Cerbero\ConsoleTasker\Tasks;
use Cerbero\ConsoleTasker\Tasks\AbstractCreatorTask;
use Cerbero\ConsoleTasker\Traits\ConfigAware;
use Illuminate\Container\Container;
use Illuminate\Support\Str;

/**
 * The task to create the command tasks.
 *
 */
class CreateCommandTasks extends AbstractCreatorTask
{
    use ConfigAware;

    /**
     * The tasks parser.
     *
     * @var TasksParser
     */
    protected $parser;

    /**
     * The parsed task to generate.
     *
     * @var ParsedTask
     */
    protected $parsedTask;

    /**
     * The stubs map.
     *
     * @var array
     */
    protected $stubsMap = [
        Tasks\AbstractTask::class => __DIR__ . '/../../../stubs/task.stub',
        Tasks\AbstractCreatorTask::class => __DIR__ . '/../../../stubs/creator.stub',
        Tasks\AbstractFilesManipulatorTask::class => __DIR__ . '/../../../stubs/updater.stub',
    ];

    /**
     * Instantiate the class.
     *
     * @param TasksParser $parser
     */
    public function __construct(TasksParser $parser)
    {
        $this->parser = $parser;
    }

    /**
     * Run the task
     *
     * @return mixed
     */
    public function run()
    {
        $parsedTasks = $this->parser->parse($this->option('tasks'));

        foreach ($parsedTasks as $parsedTask) {
            $this->parsedTask = $parsedTask;
            $succeeded = parent::run() && $this->createStub();

            if (!$succeeded) {
                return false;
            }
        }
    }

    /**
     * Create stub if needed
     *
     * @return bool
     */
    protected function createStub(): bool
    {
        if ($this->parsedTask->parentClass != AbstractCreatorTask::class) {
            return true;
        }

        $path = dirname($this->getPath()) . '/stubs/' . Str::snake($this->parsedTask->name) . '.stub';
        $this->file($path)->needsManualUpdateTo('add stub content');

        if (!is_dir(dirname($path))) {
            @mkdir(dirname($path), 0777, true);

It seems like you do not handle an error condition for mkdir(). This can introduce security issues, and is generally not recommended.

        }

        return file_put_contents($path, '') !== false;
    }

    /**
     * Determine whether this task should run
     *
     * @return bool
     */
    public function shouldRun(): bool
    {
        return !!$this->option('tasks');
    }

    /**
     * Retrieve the reason why this task should not run
     *
     * @return string|null
     */
    public function getSkippingReason(): ?string
    {
        return 'tasks to generate were not specified';
    }

    /**
     * Retrieve the path of the stub
     *
     * @return string
     */
    protected function getStubPath(): string
    {
        return $this->stubsMap[$this->parsedTask->parentClass];
    }

    /**
     * Retrieve the fully qualified name of the file to create
     *
     * @return string|null
     */
    protected function getFullyQualifiedName(): ?string
    {
        return vsprintf('%s%s\%s\%s', [
            Container::getInstance()->make('app')->getNamespace(),
            str_replace('/', '\\', $this->config('tasks_directory')),
            $this->argument('name'),
            $this->parsedTask->name,
        ]);
    }

    /**
     * Retrieve the reason why the file needs to be updated manually
     *
     * @return string|null
     */
    public function needsManualUpdateTo(): ?string
    {
        return 'implement task logic';
    }

    /**
     * Retrieve the replacements to apply on the stub
     *
     * @return array
     */
    protected function getReplacements(): array
    {
        return [
            '{{ purpose }}' => Str::snake($this->parsedTask->name, ' '),
            '{{ stub }}' => Str::snake($this->parsedTask->name),
        ];
    }
}