fspringveldt / silverstripe-porter

src/Commands/CreateDataObjectCommand.php

<?php

namespace SilverStripe\Porter\Commands;

use SilverStripe\Porter\Helpers\ValidationHelper;
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Yaml\Exception\RuntimeException;

/**
 * Class CreateDataObjectCommand
 */
class CreateDataObjectCommand extends Command
{
    const ARGUMENTS_NAME = 'name';
    const ARGUMENTS_NAMESPACE = 'namespace';
    const ARGUMENTS_PATH = 'path';
    const OPTIONS_HAS_ONE = 'withHasOne';
    const OPTIONS_HAS_MANY = 'withHasMany';
    const OPTIONS_MANY_MANY = 'withManyMany';
    const OPTIONS_TRADITIONAL_ARRAY = 'withTraditionalArray';

    /**
     * @var string
     */
    private $name;

Consider using a different property name as you override a private property of the parent class.

    /**
     * @var string
     */
    private $namespace;

    /**
     * @var string
     */
    private $modulePath;

    /**
     * @var Filesystem
     */
    private $fileSystem;

    /**
     * @var string The target frameowkr version
     */
    private $frameworkVersion = 'ss4';

    /**
     * @var string
     */
    private $separator = DIRECTORY_SEPARATOR;

    /**
     * Whether or not to use traditional array syntax
     * @var bool
     */
    private $useTraditionalArraySyntax = false;

    /**
     * Configures the command
     */
    protected function configure()

This method seems to be duplicated in your project.

    {
        $this->setName('create-dataobject')
            ->setDescription('Sets up a new SilverStripe dataobject skeleton at the'
                . ' given path.')
            ->addArgument(self::ARGUMENTS_NAME, InputArgument::REQUIRED)
            ->addArgument(self::ARGUMENTS_PATH, InputArgument::REQUIRED)
            ->addArgument(self::ARGUMENTS_NAMESPACE, InputArgument::REQUIRED)
            ->addOption(self::OPTIONS_HAS_ONE, null, InputOption::VALUE_NONE)
            ->addOption(self::OPTIONS_HAS_MANY, null, InputOption::VALUE_NONE)
            ->addOption(self::OPTIONS_MANY_MANY, null, InputOption::VALUE_NONE)
            ->addOption(self::OPTIONS_TRADITIONAL_ARRAY, null, InputOption::VALUE_NONE);
    }

    /**
     * Executes this command
     * @param InputInterface $input
     * @param OutputInterface $output
     * @return int|null|void
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $this->setArguments($input);
        $output->writeln(
            "Creating SilverStripe DataObject named {$this->name} "
            . "at {$this->modulePath}"
        );
        $this->preCopyOptions($input);
        $this->copySkeleton();
        $output->writeln(' - Skeleton created');
        $this->postCopyOptions($input);
        $output->writeln(' - Options applied');
        $output->writeln(' - Done');
    }

    /**
     * Sets the argument values to their respective properties
     * @param InputInterface $input
     * @throws RuntimeException
     */
    protected function setArguments(InputInterface $input)

This method seems to be duplicated in your project.

    {
        $this->name = $input->getArgument(self::ARGUMENTS_NAME);
        $this->namespace = $input->getArgument(self::ARGUMENTS_NAMESPACE);
        $this->modulePath = $input->getArgument(self::ARGUMENTS_PATH);

        ValidationHelper::validateNamespace($this->namespace);
        ValidationHelper::validateModuleName($this->moduleName);

The property moduleName does not exist. Did you maybe forget to declare it?

    }

    /**
     * @param InputInterface $input
     */
    protected function preCopyOptions(InputInterface $input)
    {
        if ($input->getOption(self::OPTIONS_TRADITIONAL_ARRAY)) {
            $this->useTraditionalArraySyntax = true;
        }
    }

    /**
     * Checks for and actions all actions
     * @param InputInterface $input
     * @param OutputInterface $output

There is no parameter named $output. Was it maybe removed?

     */
    protected function postCopyOptions(InputInterface $input)
    {
        $source = $this->getSourcePath('options');
        $target = $this->getTargetPath();
        $uri = function ($folder, $endPoint) {
            return "{$folder}{$this->separator}{$endPoint}";
        };
        if ($input->getOption(self::OPTIONS_HAS_ONE)) {

This if statement is empty and can be removed.

//            $this->moduleType = 'silverstripe-module';

45% of this comment could be valid code. Did you maybe forget this after debugging?

        }

        if ($ss3 = $input->getOption(self::OPTIONS_SS3)) {

$ss3 is not used, you could remove the assignment.

            $this->frameworkVersion = 'ss3';
        }

        if ($withTravis = $input->getOption(self::OPTIONS_HAS_MANY)) {

$withTravis is not used, you could remove the assignment.

This code seems to be duplicated across your project.

            $file = '.travis.yml';
            $this->getFilesystem()->copy(
                $uri($source, $file),
                $uri($target, $file)
            );
        }

        if ($withCircleCI = $input->getOption(self::OPTIONS_MANY_MANY)) {

$withCircleCI is not used, you could remove the assignment.

This code seems to be duplicated across your project.

            $folder = '.circleci';
            $this->getFilesystem()->mirror(
                $uri($source, $folder),
                $uri($target, $folder)
            );
        }
    }

    /**
     * Copies the skeleton to the root directory
     */
    protected function copySkeleton()
    {
        $this->getFilesystem()->mirror(
            $this->getSourcePath(),
            $this->getTargetPath()
        );
    }

    /**
     * Copies the configured values to the composer.json file
     */
    protected function setupComposerJson()
    {
        $path = $this->getTargetPath() . DIRECTORY_SEPARATOR . 'composer.json';
        $contents = file_get_contents($path);
        $search = [
            '$moduleName',
            '$namespace'
        ];
        $replace = [
            $this->name,
            $this->namespace
        ];

        $contents = str_ireplace($search, $replace, $contents);
        $this->getFilesystem()->dumpFile($path, $contents);
    }

    /**
     * Gets or sets the file system property
     * @return Filesystem
     */
    protected function getFilesystem()
    {
        if (!$this->fileSystem) {
            $this->fileSystem = new Filesystem();
        }

        return $this->fileSystem;
    }

    /**
     * Returns the path to the given sub-dir. Defaults to assets skeleton
     * @param string $subDir
     * @return string
     */
    protected function getSourcePath($subDir = 'assets')
    {
        $porterDir = __DIR__;
        return "{$porterDir}{$this->separator}{$subDir}{$this->separator}{$this->frameworkVersion}-dataobject";
    }

    /**
     * Gets destination path for the module skeleton
     * @return string
     */
    protected function getTargetPath()
    {
        $folderName = substr($this->name, stripos($this->name, DIRECTORY_SEPARATOR) + 1);
        return $this->modulePath . $this->separator . $folderName;
    }

    /**
     * @return bool
     */
    public function isTraditionalSyntax()
    {
        return $this->useTraditionalArraySyntax;
    }

    /**
     * @param bool $traditionalSyntax
     * @return CreateDataObjectCommand
     */
    public function setTraditionalSyntax($traditionalSyntax)
    {
        $this->useTraditionalArraySyntax = $traditionalSyntax;
        return $this;
    }
}