Roave\BackwardCompatibility\Change

Complexity

Total Complexity

11

Size/Duplication

Total Lines	71
Duplicated Lines	0 %

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	changed()	0	3	1
A	isSkipped()	0	3	1
A	added()	0	3	1
A	skippedDueToFailure()	0	4	1
A	isAdded()	0	3	1
A	removed()	0	3	1
A	isRemoved()	0	3	1
A	isChanged()	0	3	1
A	__construct()	0	5	1
A	__toString()	0	7	2

<?php

declare(strict_types=1);

namespace Roave\BackwardCompatibility;

use Throwable;
use function Safe\sprintf;
use function strtoupper;

/**
 * @todo this class probably needs subclassing or being turned into an interface
 */
final class Change
{
    private const ADDED   = 'added';
    private const CHANGED = 'changed';
    private const REMOVED = 'removed';
    private const SKIPPED = 'skipped';

    /** @var string */
    private $modificationType;

    /** @var string */
    private $description;

    /** @var bool */
    private $isBcBreak;

    private function __construct(string $modificationType, string $description, bool $isBcBreak)
    {
        $this->modificationType = $modificationType;
        $this->description      = $description;
        $this->isBcBreak        = $isBcBreak;
    }

    public static function added(string $description, bool $isBcBreak) : self
    {
        return new self(self::ADDED, $description, $isBcBreak);
    }

    public static function changed(string $description, bool $isBcBreak) : self
    {
        return new self(self::CHANGED, $description, $isBcBreak);
    }

    public static function removed(string $description, bool $isBcBreak) : self
    {
        return new self(self::REMOVED, $description, $isBcBreak);
    }

    public static function skippedDueToFailure(Throwable $failure) : self
    {
        // @TODO Note: we may consider importing the full exception for better printing later on
        return new self(self::SKIPPED, $failure->getMessage(), true);
    }

    public function isAdded() : bool
    {
        return $this->modificationType === self::ADDED;
    }

    public function isRemoved() : bool
    {
        return $this->modificationType === self::REMOVED;
    }

    public function isChanged() : bool
    {
        return $this->modificationType === self::CHANGED;
    }

    public function isSkipped() : bool
    {
        return $this->modificationType === self::SKIPPED;
    }

    public function __toString() : string
    {
        return sprintf(
            '%s%s: %s',
            $this->isBcBreak ? '[BC] ' : '     ',
            strtoupper($this->modificationType),
            $this->description
        );
    }
}