GitElephant\Command\RevListCommand

Complexity

Total Complexity

3

Size/Duplication

Total Lines	53
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getTagCommit()	0	10	1
A	commitPath()	0	9	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;

use GitElephant\Objects\Commit;
use GitElephant\Objects\Tag;
use GitElephant\Repository;

/**
 * RevList Command generator
 *
 * @author Matteo Giachino <matteog@gmail.com>
 */
class RevListCommand extends BaseCommand
{
    public const GIT_REVLIST = 'rev-list';

    /**
     * constructor
     *
     * @param \GitElephant\Repository $repo The repository object this command
     *                                      will interact with
     */
    public function __construct(Repository $repo = null)
    {
        parent::__construct($repo);
    }

    /**
     * get tag commit command via rev-list
     *
     * @param \GitElephant\Objects\Tag $tag a tag instance
     *
     * @throws \RuntimeException
     * @return string
     */
    public function getTagCommit(Tag $tag): string
    {
        $this->clearAll();
        $this->addCommandName(static::GIT_REVLIST);
        // only the last commit
        $this->addCommandArgument('-n1');
        $this->addCommandSubject($tag->getFullRef());

        return $this->getCommand();
    }

    /**
     * get the commits path to the passed commit. Useful to count commits in a repo
     *
     * @param \GitElephant\Objects\Commit $commit commit instance
     * @param int                         $max    max count
     *
     * @throws \RuntimeException
     * @return string
     */
    public function commitPath(Commit $commit, $max = 1000): string
    {
        $this->clearAll();
        $this->addCommandName(static::GIT_REVLIST);
        $this->addCommandArgument(sprintf('--max-count=%s', $max));
        $this->addCommandSubject($commit->getSha());

        return $this->getCommand();
    }
}