GitElephant\Command\CloneCommand

Complexity

Total Complexity

10

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

90.91%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
B	cloneUrl()	0	42	9

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

/**
 * CloneCommand generator
 *
 * @author Matteo Giachino <matteog@gmail.com>
 * @author Kirk Madera <kmadera@robofirm.com>
 */
class CloneCommand extends BaseCommand
{
    public const GIT_CLONE_COMMAND = 'clone';

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

    /**
     * Command to clone a repository
     *
     * @param string      $url           repository url
     * @param string      $to            where to clone the repo
     * @param string|null $repoReference Repo reference to clone. Required if performing a shallow clone.
     * @param int|null    $depth         Depth of commits to clone
     * @param bool        $recursive     Whether to recursively clone submodules.
     *
     * @throws \RuntimeException
     * @return string command
     */
    public function cloneUrl(
        string $url,
        string $to = null,
        string $repoReference = null,
        int $depth = null,
        bool $recursive = false
    ): string {
        // get binary version before reset
        $version = $this->getBinaryVersion();

        $this->clearAll();
        $this->addCommandName(static::GIT_CLONE_COMMAND);
        $this->addCommandSubject($url);
        if (null !== $to) {
            $this->addCommandSubject2($to);
        }

        if (null !== $repoReference) {
            // git documentation says the --branch was added in 2.0.0, but it exists undocumented at least back to 1.8.3.1
            if (version_compare($version, '1.8.3.1', '<')) {
                throw new \RuntimeException(
                    'Please upgrade to git v1.8.3.1 or newer to support cloning a specific branch. You have ' . $version . '.'
                );
            }
            $this->addCommandArgument('--branch=' . $repoReference);
        }

        if (null !== $depth) {
            $this->addCommandArgument('--depth=' . $depth);
            // shallow-submodules is a nice to have feature. Just ignoring if git version not high enough
            // It would be nice if this had a logger injected for us to log notices
            if (version_compare($version, '2.9.0', '>=') && $recursive && 1 == $depth) {
                $this->addCommandArgument('--shallow-submodules');
            }
        }
        
        if ($recursive) {
            $this->addCommandArgument('--recursive');
        }

        return $this->getCommand();
    }
}