Pyrech\ComposerChangelogs\UrlGenerator\GitBasedUrlGenerator

Complexity

Total Complexity

12

Size/Duplication

Total Lines	128
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

97.62%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
	getDomain()	0	1	?
A	supports()	0	4	1
A	generateBaseUrl()	0	16	3
A	getCompareVersion()	0	11	2
A	extractRepositoryInformation()	0	17	3
A	isSshUrl()	0	4	1
A	transformSshUrlIntoHttp()	0	15	2

<?php

/*
 * This file is part of the composer-changelogs project.
 *
 * (c) Loïck Piera <pyrech@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Pyrech\ComposerChangelogs\UrlGenerator;

use Pyrech\ComposerChangelogs\Version;

abstract class GitBasedUrlGenerator implements UrlGenerator
{
    const REGEX_USER = '(?P<user>[^/]+)';
    const REGEX_REPOSITORY = '(?P<repository>[^/]+)';

    /**
     * Returns the domain of the service, like "example.org".
     *
     * @return string
     */
    abstract protected function getDomain();

    /**
     * {@inheritdoc}
     */
    public function supports($sourceUrl)
    {
        return strpos($sourceUrl, $this->getDomain()) !== false;
    }

    /**
     * Generates the canonical http url for a repository.
     *
     * It ensures there is no .git part in http url. It also supports ssh urls
     * by converting them in their http equivalent format.
     *
     * @param string $sourceUrl
     *
     * @return string
     */
    protected function generateBaseUrl($sourceUrl)
    {
        if ($this->isSshUrl($sourceUrl)) {
            return $this->transformSshUrlIntoHttp($sourceUrl);
        }

        $sourceUrl = parse_url($sourceUrl);
        $pos = strrpos($sourceUrl['path'], '.git');

        return sprintf(
            '%s://%s%s',
            $sourceUrl['scheme'],
            $sourceUrl['host'],
            $pos === false ? $sourceUrl['path'] : substr($sourceUrl['path'], 0, strrpos($sourceUrl['path'], '.git'))
        );
    }

    /**
     * Get the version to use for the compare url.
     *
     * For dev versions, it returns the commit short hash in full pretty version.
     *
     * @param Version $version
     *
     * @return string
     */
    protected function getCompareVersion(Version $version)
    {
        if ($version->isDev()) {
            return substr(
                $version->getFullPretty(),
                strlen($version->getPretty()) + 1
            );
        }

        return $version->getPretty();
    }

    /**
     * Extracts information like user and repository from the http url.
     *
     * @param string $sourceUrl
     *
     * @return array
     */
    protected function extractRepositoryInformation($sourceUrl)
    {
        $pattern = '#' . $this->getDomain() . '/' . self::REGEX_USER . '/' . self::REGEX_REPOSITORY . '#';

        preg_match($pattern, $sourceUrl, $matches);

        if (!isset($matches['user']) || !isset($matches['repository'])) {
            throw new \LogicException(
                sprintf('Unrecognized url format for %s ("%s")', $this->getDomain(), $sourceUrl)
            );
        }

        return [
            'user' => $matches['user'],
            'repository' => $matches['repository'],
        ];
    }

    /**
     * Returns whether an url uses a ssh git protocol.
     *
     * @param string $url
     *
     * @return string
     */
    private function isSshUrl($url)
    {
        return strpos($url, 'git@') !== false;
    }

    /**
     * Transform an ssh git url into an http one.
     *
     * @param string $url
     *
     * @return string
     */
    private function transformSshUrlIntoHttp($url)
    {
        $pattern = '#git@' . $this->getDomain() . ':' . self::REGEX_USER . '/' . self::REGEX_REPOSITORY . '.git$#';

        if (preg_match($pattern, $url, $matches)) {
            return sprintf(
                'https://%s/%s/%s',
                $this->getDomain(),
                $matches['user'],
                $matches['repository']
            );
        }

        return $url;
    }
}