GitElephant\Command\Caller\Caller

Complexity

Total Complexity

16

Size/Duplication

Total Lines	137
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

97.62%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	3
B	execute()	0	43	7
A	getOutput()	0	4	1
A	getOutputLines()	0	15	4
A	getRawOutput()	0	4	1

<?php

/**
 * GitElephant - An abstraction layer for git written in PHP
 * Copyright (C) 2013  Matteo Giachino
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see [http://www.gnu.org/licenses/].
 */

namespace GitElephant\Command\Caller;

use GitElephant\Exception\InvalidRepositoryPathException;
use Symfony\Component\Process\Process;

/**
 * Caller
 *
 * @author Matteo Giachino <matteog@gmail.com>
 * @author Tim Bernhard <tim@bernhard-webstudio.ch>
 */
class Caller extends AbstractCaller
{
    /**
     * the repository path
     *
     * @var string
     */
    private $repositoryPath;

    /**
     * raw output
     *
     * @var string
     */
    private $rawOutput;

    /**
     * Class constructor
     *
     * @param string|null   $gitPath the physical path to the git binary
     * @param string        $repositoryPath the physical base path for the repository
     */
    public function __construct($gitPath, $repositoryPath)
    {
        if (is_null($gitPath)) {
            // unix only!
            $gitPath = exec('which git');
        }
        $this->setBinaryPath($gitPath);
        if (!is_dir($repositoryPath)) {
            throw new InvalidRepositoryPathException($repositoryPath);
        }
        $this->repositoryPath = $repositoryPath;
    }

    /**
     * Executes a command
     *
     * @param string $cmd               the command to execute
     * @param bool   $git               if the command is git or a generic command
     * @param string $cwd               the directory where the command must be executed
     * @param array  $acceptedExitCodes exit codes accepted to consider the command execution successful
     *
     * @throws \RuntimeException
     * @throws \Symfony\Component\Process\Exception\InvalidArgumentException
     * @throws \Symfony\Component\Process\Exception\ProcessTimedOutException
     * @throws \Symfony\Component\Process\Exception\RuntimeException
     * @throws \Symfony\Component\Process\Exception\LogicException
     * @return Caller
     */
    public function execute(
        string $cmd,
        bool $git = true,
        string $cwd = null,
        array $acceptedExitCodes = [0]
    ): CallerInterface {
        if ($git) {
            $cmd = $this->getBinaryPath() . ' ' . $cmd;
        }

        if (stripos(PHP_OS, 'WIN') !== 0) {
            // We rely on the C locale in all output we parse.
            $cmd = 'LC_ALL=C ' . $cmd;
        }

        if (is_null($cwd) || !is_dir($cwd)) {
            $cwd = $this->repositoryPath;
        }

        if (method_exists(Process::class, 'fromShellCommandline')) {
            $process = Process::fromShellCommandline($cmd, $cwd);
        } else {
            // compatibility fix required for symfony/process versions prior to v4.2.
            $process = new Process($cmd, $cwd);
        }

        $process->setTimeout(15000);
        $process->run();
        if (!in_array($process->getExitCode(), $acceptedExitCodes)) {
            $text = 'Exit code: ' . $process->getExitCode();
            $text .= ' while executing: "' . $cmd;
            $text .= '" with reason: ' . $process->getErrorOutput();
            $text .= "\n" . $process->getOutput();
            throw new \RuntimeException($text);
        }
        
        $this->rawOutput = $process->getOutput();
        // rtrim values
        $values = array_map('rtrim', explode(PHP_EOL, $process->getOutput()));
        $this->outputLines = $values;

        return $this;
    }

    /**
     * returns the output of the last executed command
     *
     * @return string
     */
    public function getOutput(): string
    {
        return implode("\n", $this->outputLines);
    }

    /**
     * returns the output of the last executed command as an array of lines
     *
     * @param bool $stripBlankLines remove the blank lines
     *
     * @return array
     */
    public function getOutputLines(bool $stripBlankLines = false): array
    {
        if ($stripBlankLines) {
            $output = [];
            foreach ($this->outputLines as $line) {
                if ('' !== $line) {
                    $output[] = $line;
                }
            }

            return $output;
        }

        return $this->outputLines;
    }

    /**
     * Get RawOutput
     *
     * @return string
     */
    public function getRawOutput(): string
    {
        return $this->rawOutput;
    }
}