GitWrapper\GitBranches

Complexity

Total Complexity

8

Size/Duplication

Total Lines	94
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

66.67%

Importance

Changes	6
Bugs	3	Features	1

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	fetchBranches()	0	8	2
A	trimBranch()	0	4	1
A	remote()	0	4	1
A	head()	0	4	1
A	getIterator()	0	5	1
A	all()	0	4	1

<?php

/**
 * A PHP wrapper around the Git command line utility.
 */

namespace GitWrapper;

/**
 * Class that parses and returnes an array of branches.
 */
class GitBranches implements \IteratorAggregate
{
    /**
     * The working copy that branches are being collected from.
     *
     * @var \GitWrapper\GitWorkingCopy
     */
    protected $git;

    /**
     * Constructs a GitBranches object.
     *
     * @param \GitWrapper\GitWorkingCopy $git
     *   The working copy that branches are being collected from.
     *
     * @throws \GitWrapper\GitException
     */
    public function __construct(GitWorkingCopy $git)
    {
        $this->git = clone $git;
        $output = (string) $git->branch(array('a' => true));

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

    }

    /**
     * Fetches the branches via the `git branch` command.
     *
     * @param boolean $onlyRemote
     *   Whether to fetch only remote branches, defaults to false which returns
     *   all branches.
     *
     * @return array
     */
    public function fetchBranches($onlyRemote = false)
    {
        $this->git->clearOutput();
        $options = ($onlyRemote) ? array('r' => true) : array('a' => true);
        $output = (string) $this->git->branch($options);
        $branches = preg_split("/\r\n|\n|\r/", rtrim($output));
        return array_map(array($this, 'trimBranch'), $branches);
    }

    /**
     * Strips unwanted characters from the branch.
     *
     * @param string $branch
     *   The raw branch returned in the output of the Git command.
     *
     * @return string
     *   The processed branch name.
     */
    public function trimBranch($branch)
    {
        return ltrim($branch, ' *');
    }

    /**
     * Implements \IteratorAggregate::getIterator().
     */
    public function getIterator()
    {
        $branches = $this->all();
        return new \ArrayIterator($branches);
    }

    /**
     * Returns all branches.
     *
     * @return array
     */
    public function all()
    {
        return $this->fetchBranches();
    }

    /**
     * Returns only remote branches.
     *
     * @return array
     */
    public function remote()
    {
        return $this->fetchBranches(true);
    }

    /**
     * Returns currently active branch (HEAD) of the working copy.
     *
     * @return string
     */
    public function head()
    {
        return trim((string) $this->git->run(array('rev-parse --abbrev-ref HEAD')));
    }
}