PHPFeature_SemanticVersion

Complexity

Total Complexity

31

Size/Duplication

Total Lines	239
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Test Coverage

Coverage

83.93%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	2
A	getVersion()	0	4	2
A	getMajor()	0	4	2
A	getMinor()	0	4	2
A	getPatch()	0	4	2
A	getPreRelease()	0	4	2
A	getBuild()	0	4	2
A	__toString()	0	4	1
B	validate()	0	33	10
A	getVersionFromComponents()	0	17	3
A	getComponent()	0	6	2
A	setComponent()	0	4	1

<?php
/**
 * PHPFeature_SemanticVersion Class.
 *
 * @package   brightnucleus/phpfeature
 * @author    Alain Schlesser <alain.schlesser@gmail.com>
 * @license   MIT
 * @link      http://www.brightnucleus.com/
 * @copyright 2016 Alain Schlesser, Bright Nucleus
 */

/**
 * Class PHPFeature_SemanticVersion.
 *
 * This class implements the semantic versioning logic and enables comparison between version strings.
 *
 * @since  0.1.0
 *
 * @author Alain Schlesser <alain.schlesser@gmail.com>
 */
class PHPFeature_SemanticVersion
{

    /**
     * RegEx pattern that matches the different version components.
     *
     * @since 0.1.0
     *
     * @var string
     */
    const VERSION_PATTERN = '/^(\d+)(?:\.(\d+))?(?:\.(\d+))?(?:-([0-9A-Za-z-]*))?(?:\+([0-9A-Za-z-]*))?$/';

    /**
     * Version that is used.
     *
     * @since 0.1.0
     *
     * @var string
     */
    protected $version;

    /**
     * Different components of the version that is used.
     *
     * @since 0.1.0
     *
     * @var array
     */
    protected $components;

    /**
     * Instantiate a PHPFeature_SemanticVersion object.
     *
     * @since 0.1.0
     *
     * @param string|null $version Optional. The version to use. Defaults to the current PHP interpreter's version.
     * @param bool        $partial Optional. Whether to accept a partial version number. If true, the missing
     *                             components will default to `0` instead of throwing an exception.
     *
     * @throws RuntimeException When the version fails to validate.
     */
    public function __construct($version = null, $partial = false)
    {

        if (null === $version) {
            $version = '0.0.0';
        }

        $version = $this->validate($version, $partial);

        $this->version = $version;
    }

    /**
     * Get the version that is used.
     *
     * @since 0.1.0
     *
     * @return string The version that is used. '0.0.0' if not defined.
     */
    public function getVersion()
    {
        return (string)isset($this->version) ? $this->version : '0.0.0';
    }

    /**
     * Get the major version number.
     *
     * @since 0.1.0
     *
     * @return int The major version that is used. 0 if not defined.
     */
    public function getMajor()
    {
        return (int)$this->getComponent('major') ?: 0;
    }

    /**
     * Get the minor version number.
     *
     * @since 0.1.0
     *
     * @return int The minor version that is used. 0 if not defined.
     */
    public function getMinor()
    {
        return (int)$this->getComponent('minor') ?: 0;
    }

    /**
     * Get the patch version number.
     *
     * @since 0.1.0
     *
     * @return int The patch version that is used. 0 if not defined.
     */
    public function getPatch()
    {
        return (int)$this->getComponent('patch') ?: 0;
    }

    /**
     * Get the pre-release label.
     *
     * @since 0.1.0
     *
     * @return string The patch version that is used. Empty string if not defined.
     */
    public function getPreRelease()
    {
        return (string)$this->getComponent('pre-release') ?: '';
    }

    /**
     * Get the build metadata.
     *
     * @since 0.1.0
     *
     * @return string The build metadata for the version that is used. Empty string if not defined.
     */
    public function getBuild()
    {
        return (string)$this->getComponent('build') ?: '';
    }

    /**
     * Get a string representation of the object.
     *
     * @since 0.2.0
     *
     * @return string String representation of the version.
     */
    public function __toString()
    {
        return (string)$this->getVersion();
    }

    /**
     * Validate the version and assert it is in SemVer format.
     *
     * @since 0.1.0
     *
     * @param string $version The version to validate.
     * @param bool   $partial Optional. Whether to accept a partial version number. If true, the missing components
     *                        will default to `0` instead of throwing an exception.
     *
     * @return string Validated version string.
     * @throws RuntimeException When the version fails to validate.
     */
    protected function validate($version, $partial = false)
    {

        $version = trim($version);
        $pattern = self::VERSION_PATTERN;

        $components = array();
        $result     = preg_match($pattern, $version, $components);

        if ( ! $result) {
            throw new RuntimeException(sprintf(
                'Failed to validate version "%1$s".',
                (string)$version
            ));
        }

        if ( ! $partial && ( ! isset($components[2]) || ! isset($components[3]))) {
            throw new RuntimeException(sprintf(
                'Could not accept partial version "%1$s", requested full versions only.',
                (string)$version
            ));
        }

        $this->setComponent('major', isset($components[1]) ? (int)$components[1] : 0);
        $this->setComponent('minor', isset($components[2]) ? (int)$components[2] : 0);
        $this->setComponent('patch', isset($components[3]) ? (int)$components[3] : 0);
        $this->setComponent('pre-release', isset($components[4]) ? (string)$components[4] : '');
        $this->setComponent('build', isset($components[5]) ? (string)$components[5] : '');

        $version = $this->getVersionFromComponents();

        return $version;
    }

    /**
     * Build and return a version from the separated components.
     *
     * @since 0.1.0
     *
     * @return string String representation of the component's version.
     */
    protected function getVersionFromComponents()
    {

        $pre_release = $this->getPreRelease() ? '-' . $this->getPreRelease() : '';
        $build       = $this->getBuild() ? '+' . $this->getBuild() : '';

        $version = sprintf(
            '%1$s.%2$s.%3$s%4$s%5$s',
            $this->getMajor(),
            $this->getMinor(),
            $this->getPatch(),
            $pre_release,
            $build
        );

        return $version;
    }

    /**
     * Get a component of the version.
     *
     * @since 0.1.0
     *
     * @param string $level What level of component to get.
     *                      Possible values: 'major', 'minor', 'patch'
     *
     * @return int The requested version component. null if not defined.
     */
    protected function getComponent($level)
    {
        return array_key_exists($level, $this->components)
            ? $this->components[$level]
            : null;
    }

    /**
     * Set a component of the version.
     *
     * @since 0.1.0
     *
     * @param string $level   What level of component to set.
     *                        Possible values: 'major', 'minor', 'patch'
     * @param int    $version What version to set that component to.
     */
    protected function setComponent($level, $version)
    {
        $this->components[$level] = $version;
    }
}