matteosister / GitElephant

src/GitElephant/Status/Status.php

<?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\Status;

use GitElephant\Command\MainCommand;
use GitElephant\Repository;
use PhpCollection\Sequence;

/**
 * Class Status
 *
 * @package GitElephant\Status
 */
class Status
{
    /**
     * @var \GitElephant\Repository
     */
    private $repository;

    /**
     * @var array<StatusFile>
     */
    protected $files;

    /**
     * Private constructor in order to follow the singleton pattern
     *
     * @param Repository $repository
     *
     * @throws \RuntimeException
     * @throws \Symfony\Component\Process\Exception\RuntimeException
     */
    private function __construct(Repository $repository)
    {
        $this->files = [];
        $this->repository = $repository;
        $this->createFromCommand();
    }

    /**
     * @param Repository $repository
     *
     * @return \GitElephant\Status\Status
     */
    public static function get(Repository $repository)
    {
        return new static($repository);
    }

    /**
     * create from git command
     */
    private function createFromCommand(): void
    {
        $command = MainCommand::getInstance($this->repository)->status(true);
        $lines = $this->repository->getCaller()->execute($command)->getOutputLines(true);
        $this->parseOutputLines($lines);
    }

    /**
     * all files
     *
     * @return Sequence<StatusFile>

The doc-type Sequence<StatusFile> could not be parsed: Expected "|" or "end of type", but got "<" at position 8. (view supported doc-types)

     */
    public function all(): \PhpCollection\Sequence
    {
        return new Sequence($this->files);
    }

    /**
     * untracked files
     *
     * @return Sequence<StatusFile>

The doc-type Sequence<StatusFile> could not be parsed: Expected "|" or "end of type", but got "<" at position 8. (view supported doc-types)

     */
    public function untracked(): \PhpCollection\Sequence
    {
        return $this->filterByType(StatusFile::UNTRACKED);
    }

    /**
     * modified files
     *
     * @return Sequence<StatusFile>

The doc-type Sequence<StatusFile> could not be parsed: Expected "|" or "end of type", but got "<" at position 8. (view supported doc-types)

     */
    public function modified(): \PhpCollection\Sequence
    {
        return $this->filterByType(StatusFile::MODIFIED);
    }

    /**
     * added files
     *
     * @return Sequence<StatusFile>

The doc-type Sequence<StatusFile> could not be parsed: Expected "|" or "end of type", but got "<" at position 8. (view supported doc-types)

     */
    public function added(): \PhpCollection\Sequence
    {
        return $this->filterByType(StatusFile::ADDED);
    }

    /**
     * deleted files
     *
     * @return Sequence<StatusFile>

The doc-type Sequence<StatusFile> could not be parsed: Expected "|" or "end of type", but got "<" at position 8. (view supported doc-types)

     */
    public function deleted(): \PhpCollection\Sequence
    {
        return $this->filterByType(StatusFile::DELETED);
    }

    /**
     * renamed files
     *
     * @return Sequence<StatusFile>

The doc-type Sequence<StatusFile> could not be parsed: Expected "|" or "end of type", but got "<" at position 8. (view supported doc-types)

     */
    public function renamed(): \PhpCollection\Sequence
    {
        return $this->filterByType(StatusFile::RENAMED);
    }

    /**
     * copied files
     *
     * @return Sequence<StatusFile>

The doc-type Sequence<StatusFile> could not be parsed: Expected "|" or "end of type", but got "<" at position 8. (view supported doc-types)

     */
    public function copied(): \PhpCollection\Sequence
    {
        return $this->filterByType(StatusFile::COPIED);
    }

    /**
     * create objects from command output
     * https://www.kernel.org/pub/software/scm/git/docs/git-status.html in the output section
     *
     *
     * @param array $lines
     */
    private function parseOutputLines(array $lines): void
    {
        foreach ($lines as $line) {
            $matches = $this->splitStatusLine($line);
            if ($matches) {
                $x = isset($matches[1]) ? $matches[1] : null;
                $y = isset($matches[2]) ? $matches[2] : null;
                $file = isset($matches[3]) ? $matches[3] : null;
                $renamedFile = isset($matches[5]) ? $matches[5] : null;
                $this->files[] = StatusFile::create($x, $y, $file, $renamedFile);
            }
        }
    }

    /**
     * @param string $line
     *
     * @return array<string>|null
     */
    protected function splitStatusLine(string $line)
    {
        preg_match('/^([MADRCU\? ])?([MADRCU\? ])?\ "?([^"]+?)"?( -> "?([^"]+?)"?)?$/', $line, $matches);
        return $matches;
    }

    /**
     * filter files status in working tree and in index status
     *
     * @param string $type
     *
     * @return Sequence<StatusFile>

The doc-type Sequence<StatusFile> could not be parsed: Expected "|" or "end of type", but got "<" at position 8. (view supported doc-types)

     */
    protected function filterByType(string $type): \PhpCollection\Sequence
    {
        if (!$this->files) {

The expression $this->files of type GitElephant\Status\StatusFile[] is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

            return new Sequence();
        }

        return new Sequence(
            array_filter(
                $this->files,
                function (StatusFile $statusFile) use ($type) {
                    return $type === $statusFile->getWorkingTreeStatus() || $type === $statusFile->getIndexStatus();
                }
            )
        );
    }
}