Spiechu\SymfonyCommonsBundle\ApiFeature\Definition

Complexity

Total Complexity

16

Size/Duplication

Total Lines	98
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

85.71%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	19	7
A	__toString()	0	4	1
A	getName()	0	4	1
A	getSince()	0	4	1
A	getUntil()	0	4	1
A	isAvailableForVersion()	0	7	4
A	jsonSerialize()	0	8	1

<?php

declare(strict_types=1);

namespace Spiechu\SymfonyCommonsBundle\ApiFeature;

use Spiechu\SymfonyCommonsBundle\Utils\StringUtils;

class Definition implements \JsonSerializable
{
    /**
     * @var string
     */
    protected $name;

    /**
     * @var null|string
     */
    protected $since;

    /**
     * @var null|string
     */
    protected $until;

    /**
     * @param string      $name
     * @param null|string $since
     * @param null|string $until
     *
     * @throws \InvalidArgumentException
     */
    public function __construct(string $name, ?string $since, ?string $until)
    {
        StringUtils::assertNotEmpty($name, 'Empty feature name');

        if (null !== $since && !is_numeric($since)) {
            throw new \InvalidArgumentException('Since parameter is not numeric');
        }
        if (null !== $until && !is_numeric($until)) {
            throw new \InvalidArgumentException('Until parameter is not numeric');
        }

        if (null === $since && null === $until) {
            throw new \InvalidArgumentException('No version constraints provided');
        }

        $this->name = $name;
        $this->since = $since;

It seems like $since can also be of type integer or double. However, the property $since is declared as type null|string. Maybe add an additional type check?

        $this->until = $until;

It seems like $until can also be of type integer or double. However, the property $until is declared as type null|string. Maybe add an additional type check?

    }

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

    /**
     * @return string
     */
    public function getName(): string
    {
        return $this->name;
    }

    /**
     * @return null|string
     */
    public function getSince(): ?string
    {
        return $this->since;
    }

    /**
     * @return null|string
     */
    public function getUntil(): ?string
    {
        return $this->until;
    }

    /**
     * @param string $version
     *
     * @return bool
     */
    public function isAvailableForVersion(string $version): bool
    {
        $sinceVersionMatch = null === $this->since || version_compare($version, $this->since, '>=');
        $untilVersionMatch = null === $this->until || version_compare($version, $this->until, '<=');

        return $sinceVersionMatch && $untilVersionMatch;
    }

    /**
     * {@inheritdoc}
     */
    public function jsonSerialize(): array
    {
        return [
            'name' => $this->name,
            'since' => $this->since,
            'until' => $this->until,
        ];
    }
}