CommandBase.php

<?php

namespace Phug\Split\Command;

use Exception;
use Phug\Split;
use Phug\Split\Git\Commit;
use Phug\Split\Git\Log;
use Phug\Split\InvalidCli;
use SimpleCli\CommandBase as Command;
use SimpleCli\SimpleCli;

/**
 * @property-read string $gitProgram Git program path.
 * @property-read string $hashPrefix Prefix for split linked commit hashes.
 */
abstract class CommandBase extends Command
{
    /**
     * Assert the given CLI instance is a Split CLI instance.
     *
     * @param SimpleCli $cli
     *
     * @return Split
     */
    protected function getSplitCli(SimpleCli $cli): Split
    {
        if ($cli instanceof Split) {
            return $cli;
        }

        throw new InvalidCli($cli);
    }

    /**
     * Escape a value for git command argument or option.
     *
     * @param string $value
     *
     * @return string
     */
    protected function gitEscape(string $value): string
    {
        return '"'.addcslashes($value, '"').'"';
    }

    /**
     * Get a command using git program.
     *
     * @param string      $command  Git command and mandatory arguments
     * @param array       $options  CLI git command options
     * @param string|null $redirect redirection suffix (like '2>&1')
     *
     * @psalm-param truthy-string|null $redirect
     *
     * @return string
     *
     * @psalm-suppress UndefinedThisPropertyFetch
     */
    protected function getGitCommand(string $command, array $options = [], ?string $redirect = null): string
    {
        foreach ($options as $name => $value) {
            $command .= ' --'.$name.'='.$this->gitEscape($value);
        }

        return $this->gitProgram.' '.$command.($redirect ? ' '.$redirect : '');
    }

    /**
     * Execute a command using git program.
     *
     * @param string      $command  Git command and mandatory arguments
     * @param array       $options  CLI git command options
     * @param string|null $redirect redirection suffix (like '2>&1')
     *
     * @psalm-param truthy-string|null $redirect
     *
     * @return string
     */
    protected function git(string $command, array $options = [], ?string $redirect = null): string
    {
        $command = $this->getGitCommand($command, $options, $redirect);

        return (string) shell_exec($command);
    }

    /**
     * Return given count of latest commits as Log instance (collection of Commit instances).
     *
     * @param int    $count
     * @param string $directory
     *
     * @throws Exception
     *
     * @suppressWarnings(PHPMD.StaticAccess)
     *
     * @return Log
     */
    protected function latest(int $count = 1, string $directory = ''): Log
    {
        return Log::fromGitLogString($this->git("log --pretty=fuller --max-count=$count $directory") ?: '');
    }

    /**
     * Return the last commit.
     *
     * @param string $directory
     *
     * @throws Exception
     *
     * @return Commit
     */
    protected function last(string $directory = ''): Commit
    {
        return $this->latest(1, $directory)[0];
    }

    /**
     * Get the hash of the linked commit in the mono-repository for the last sub-package commit.
     *
     * @throws Exception
     *
     * @return string|null
     *
     * @psalm-return truthy-string|null
     *
     * @psalm-suppress UndefinedThisPropertyFetch
     */
    protected function getCurrentLinkedCommitHash(): ?string
    {
        return $this->last()->findInMessage('/^'.preg_quote($this->hashPrefix).'(.+)$/m');
    }

    /**
     * Remove a file or a directory even if not empty.
     *
     * @param string $fileOrDirectory
     *
     * @return bool
     *
     * @SuppressWarnings(PHPMD.ErrorControlOperator)
     */
    protected function remove(string $fileOrDirectory): bool
    {
        if (!is_writable($fileOrDirectory)) {
            return false;
        }

        @shell_exec('rm -rf '.escapeshellarg($fileOrDirectory).' 2>&1');
        file_exists($fileOrDirectory) && @shell_exec('rmdir /S /Q '.escapeshellarg($fileOrDirectory).' 2>&1');

        return true;
    }
}