GitElephant\Command\SubmoduleCommand

Complexity

Total Complexity

12

Size/Duplication

Total Lines	123
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

26.47%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	add()	0	11	2
A	init()	0	10	2
A	listSubmodules()	0	7	1
A	lists()	0	4	1
A	update()	0	23	5

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

/**
 * Submodule command generator
 *
 * @author Matteo Giachino <matteog@gmail.com>
 */
class SubmoduleCommand extends BaseCommand
{
    public const SUBMODULE_COMMAND = 'submodule';
    public const SUBMODULE_ADD_COMMAND = 'add';
    public const SUBMODULE_INIT_COMMAND = 'init';
    public const SUBMODULE_UPDATE_COMMAND = 'update';
    public const SUBMODULE_OPTION_FORCE = '--force';
    public const SUBMODULE_OPTION_INIT = '--init';
    public const SUBMODULE_OPTION_RECURSIVE = '--recursive';

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

    /**
     * add a submodule
     *
     * @param string $gitUrl git url of the submodule
     * @param string $path   path to register the submodule to
     *
     * @throws \RuntimeException
     * @return string
     */
    public function add($gitUrl, $path = null): string
    {
        $this->clearAll();
        $this->addCommandName(sprintf('%s %s', self::SUBMODULE_COMMAND, self::SUBMODULE_ADD_COMMAND));
        $this->addCommandArgument($gitUrl);
        if (null !== $path) {
            $this->addCommandSubject($path);
        }

        return $this->getCommand();
    }

    /**
     * initialize a repository's submodules
     *
     * @param  string $path init only submodules at the specified path
     *
     * @return string
     */
    public function init($path = null): string
    {
        $this->clearAll();
        $this->addCommandName(sprintf('%s %s', self::SUBMODULE_COMMAND, self::SUBMODULE_INIT_COMMAND));
        if (null !== $path) {
            $this->addPath($path);
        }

        return $this->getCommand();
    }

    /**
     * Lists submodules
     *
     * @throws \RuntimeException
     * @return string the command
     */
    public function listSubmodules(): string
    {
        $this->clearAll();
        $this->addCommandName(self::SUBMODULE_COMMAND);

        return $this->getCommand();
    }

    /**
     * Lists submodules
     *
     * @deprecated This method uses an unconventional name but is being left in
     *             place to remain compatible with existing code relying on it.
     *             New code should be written to use listSubmodules().
     *
     * @throws \RuntimeException
     * @return string the command
     */
    public function lists(): string
    {
        return $this->listSubmodules();
    }

    /**
     * update a repository's submodules
     *
     * @param  bool   $recursive update recursively
     * @param  bool   $init      init before update
     * @param  bool   $force     force the checkout as part of update
     * @param  string $path      update only a specific submodule path
     *
     * @return string
     */
    public function update(
        bool $recursive = false,
        bool $init = false,
        bool $force = false,
        string $path = null
    ): string {
        $this->clearAll();
        $this->addCommandName(sprintf('%s %s', self::SUBMODULE_COMMAND, self::SUBMODULE_UPDATE_COMMAND));
        if ($recursive) {
            $this->addCommandArgument(self::SUBMODULE_OPTION_RECURSIVE);
        }
        if ($init) {
            $this->addCommandArgument(self::SUBMODULE_OPTION_INIT);
        }
        if ($force) {
            $this->addCommandArgument(self::SUBMODULE_OPTION_FORCE);
        }
        if ($path !== null) {
            $this->addPath($path);
        }

        return $this->getCommand();
    }
}