Version\Version

Complexity

Total Complexity

44

Size/Duplication

Total Lines	301
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

35 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	fromParts()	0	8	1
A	fromMajor()	0	4	1
A	fromMinor()	0	4	1
A	fromPatch()	0	4	1
A	fromPreRelease()	0	4	1
A	fromBuild()	0	4	1
B	fromString()	0	27	4
A	validatePart()	0	6	2
A	getMajor()	0	4	1
A	getMinor()	0	4	1
A	getPatch()	0	4	1
A	getPreRelease()	0	4	1
A	getBuild()	0	4	1
A	isPreRelease()	0	4	1
A	isBuild()	0	4	1
A	compareTo()	0	8	2
A	isEqualTo()	0	4	1
A	isNotEqualTo()	0	4	1
A	isGreaterThan()	0	4	1
A	isGreaterOrEqualTo()	0	4	1
A	isLessThan()	0	4	1
A	isLessOrEqualTo()	0	4	1
A	matches()	0	8	2
A	incrementMajor()	0	4	1
A	incrementMinor()	0	4	1
A	incrementPatch()	0	4	1
A	withPreRelease()	0	4	1
A	withBuild()	0	4	1
A	getVersionString()	0	10	3
A	__toString()	0	4	1
A	jsonSerialize()	0	4	1
A	toArray()	0	10	1
A	getComparator()	0	8	2
A	setComparator()	0	4	1

<?php

declare(strict_types=1);

namespace Version;

use JsonSerializable;
use Version\Metadata\PreRelease;
use Version\Metadata\Build;
use Version\Exception\InvalidVersionElementException;
use Version\Exception\InvalidVersionStringException;
use Version\Comparator\ComparatorInterface;
use Version\Comparator\SemverComparator;
use Version\Constraint\ConstraintInterface;
use Version\Constraint\Constraint;

/**
 * @author Nikola Posa <posa.nikola@gmail.com>
 */
class Version implements JsonSerializable
{
    /**
     * @var int
     */
    protected $major;

    /**
     * @var int
     */
    protected $minor;

    /**
     * @var int
     */
    protected $patch;

    /**
     * @var PreRelease
     */
    protected $preRelease;

    /**
     * @var Build
     */
    protected $build;

    /**
     * @var ComparatorInterface
     */
    protected static $comparator;

    protected function __construct(int $major, int $minor, int $patch, PreRelease $preRelease, Build $build)
    {
        $this->major = $major;
        $this->minor = $minor;
        $this->patch = $patch;
        $this->preRelease = $preRelease;
        $this->build = $build;
    }

    public static function fromParts(int $major, int $minor, int $patch, PreRelease $preRelease, Build $build) : Version
    {
        self::validatePart('major', $major);
        self::validatePart('minor', $minor);
        self::validatePart('patch', $patch);

        return new self($major, $minor, $patch, $preRelease, $build);
    }

    public static function fromMajor(int $major) : Version
    {
        return self::fromParts($major, 0, 0, PreRelease::createEmpty(), Build::createEmpty());
    }

    public static function fromMinor(int $major, int $minor) : Version
    {
        return self::fromParts($major, $minor, 0, PreRelease::createEmpty(), Build::createEmpty());
    }

    public static function fromPatch(int $major, int $minor, int $patch) : Version
    {
        return self::fromParts($major, $minor, $patch, PreRelease::createEmpty(), Build::createEmpty());
    }

    public static function fromPreRelease(int $major, int $minor, int $patch, PreRelease $preRelease) : Version
    {
        return self::fromParts($major, $minor, $patch, $preRelease, Build::createEmpty());
    }

    public static function fromBuild(int $major, int $minor, int $patch, Build $build) : Version
    {
        return self::fromParts($major, $minor, $patch, PreRelease::createEmpty(), $build);
    }

    /**
     * @param string $versionString
     * @return Version
     * @throws InvalidVersionStringException
     */
    public static function fromString(string $versionString) : Version
    {
        $parts = [];

        if (!preg_match(
            '#^'
            . '(?P<core>(?:[0-9]|[1-9][0-9]+)(?:\.(?:[0-9]|[1-9][0-9]+)){2})'
            . '(?:\-(?P<preRelease>[0-9A-Za-z\-\.]+))?'
            . '(?:\+(?P<build>[0-9A-Za-z\-\.]+))?'
            . '$#',
            (string) $versionString,
            $parts
        )) {
            throw InvalidVersionStringException::forVersionString($versionString);
        }

        list($major, $minor, $patch) = explode('.', $parts['core']);
        $major = (int) $major;
        $minor = (int) $minor;
        $patch = (int) $patch;

        $preRelease = (!empty($parts['preRelease'])) ? PreRelease::create($parts['preRelease']) : PreRelease::createEmpty();

        $build = (!empty($parts['build'])) ? Build::create($parts['build']) : Build::createEmpty();

        return self::fromParts($major, $minor, $patch, $preRelease, $build);
    }

    protected static function validatePart(string $part, int $value)
    {
        if ($value < 0) {
            throw InvalidVersionElementException::forElement($part);
        }
    }

    public function getMajor() : int
    {
        return $this->major;
    }

    public function getMinor() : int
    {
        return $this->minor;
    }

    public function getPatch() : int
    {
        return $this->patch;
    }

    public function getPreRelease() : PreRelease
    {
        return $this->preRelease;
    }

    public function getBuild() : Build
    {
        return $this->build;
    }

    public function isPreRelease() : bool
    {
        return !$this->preRelease->isEmpty();
    }

    public function isBuild() : bool
    {
        return !$this->build->isEmpty();
    }

    /**
     * @param self|string $version
     * @return int (1 if $this > $version, -1 if $this < $version, 0 if equal)
     */
    public function compareTo($version) : int
    {
        if (!$version instanceof self) {
            $version = self::fromString((string) $version);
        }

        return self::getComparator()->compare($this, $version);
    }

    /**
     * @param self|string $version
     * @return bool
     */
    public function isEqualTo($version) : bool
    {
        return $this->compareTo($version) === 0;
    }

    /**
     * @param self|string $version
     * @return bool
     */
    public function isNotEqualTo($version) : bool
    {
        return !$this->isEqualTo($version);
    }

    /**
     * @param self|string $version
     * @return bool
     */
    public function isGreaterThan($version) : bool
    {
        return $this->compareTo($version) > 0;
    }

    /**
     * @param self|string $version
     * @return bool
     */
    public function isGreaterOrEqualTo($version) : bool
    {
        return $this->compareTo($version) >= 0;
    }

    /**
     * @param self|string $version
     * @return bool
     */
    public function isLessThan($version) : bool
    {
        return $this->compareTo($version) < 0;
    }

    /**
     * @param self|string $version
     * @return bool
     */
    public function isLessOrEqualTo($version) : bool
    {
        return $this->compareTo($version) <= 0;
    }

    /**
     * @param ConstraintInterface|string $constraint
     * @return bool
     */
    public function matches($constraint) : bool
    {
        if (! $constraint instanceof ConstraintInterface) {
            $constraint = Constraint::fromString($constraint);
        }

        return $constraint->assert($this);
    }

    public function incrementMajor() : Version
    {
        return self::fromParts($this->major + 1, 0, 0, PreRelease::createEmpty(), Build::createEmpty());
    }

    public function incrementMinor() : Version
    {
        return self::fromParts($this->major, $this->minor + 1, 0, PreRelease::createEmpty(), Build::createEmpty());
    }

    public function incrementPatch() : Version
    {
        return self::fromParts($this->major, $this->minor, $this->patch + 1, PreRelease::createEmpty(), Build::createEmpty());
    }

    public function withPreRelease($preRelease) : Version
    {
        return self::fromParts($this->major, $this->minor, $this->patch, PreRelease::create($preRelease), Build::createEmpty());
    }

    public function withBuild($build) : Version
    {
        return self::fromParts($this->major, $this->minor, $this->patch, $this->preRelease, Build::create($build));
    }

    public function getVersionString() : string
    {
        return
            $this->major
            . '.' . $this->minor
            . '.' . $this->patch
            . ($this->isPreRelease() ? '-' . (string) $this->preRelease : '')
            . ($this->isBuild() ? '+' . (string) $this->build : '')
            ;
    }

    public function __toString() : string
    {
        return $this->getVersionString();
    }

    public function jsonSerialize() : string
    {
        return $this->getVersionString();
    }

    public function toArray() : array
    {
        return [
            'major' => $this->major,
            'minor' => $this->minor,
            'patch' => $this->patch,
            'preRelease' => $this->preRelease->toArray(),
            'build' => $this->build->toArray(),
        ];
    }

    public static function getComparator() : ComparatorInterface
    {
        if (null === self::$comparator) {
            self::setComparator(new SemverComparator());
        }

        return self::$comparator;
    }

    public static function setComparator(ComparatorInterface $comparator) : void
    {
        self::$comparator = $comparator;
    }
}