Location\CardinalDirection\CardinalDirectionDistances

Complexity

Total Complexity

12

Size/Duplication

Total Lines	100
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	create()	0	4	1
A	setNorth()	0	6	1
A	setEast()	0	6	1
A	setSouth()	0	6	1
A	setWest()	0	6	1
A	getNorth()	0	4	1
A	getEast()	0	4	1
A	getSouth()	0	4	1
A	getWest()	0	4	1
A	validatePositive()	0	6	2

<?php

declare(strict_types=1);

namespace Location\CardinalDirection;

use Location\Exception\InvalidDistanceException;

/** @psalm-immutable */
class CardinalDirectionDistances
{
    /** @var float */
    private $north;

    /** @var float */
    private $east;

    /** @var float */
    private $south;

    /** @var float */
    private $west;

    private function __construct(float $north, float $east, float $south, float $west)
    {
        $this->north = $north;
        $this->east = $east;
        $this->south = $south;
        $this->west = $west;
    }

    /**
     * @psalm-pure
     * @psalm-mutation-free
     */
    public static function create(): self
    {
        return new self(0, 0, 0, 0);
    }

    /** @psalm-mutation-free */
    public function setNorth(float $north): self
    {
        $this->validatePositive($north);

        return new self($north, $this->east, $this->south, $this->west);
    }

    /** @psalm-mutation-free */
    public function setEast(float $east): self
    {
        $this->validatePositive($east);

        return new self($this->north, $east, $this->south, $this->west);
    }

    /** @psalm-mutation-free */
    public function setSouth(float $south): self
    {
        $this->validatePositive($south);

        return new self($this->north, $this->east, $south, $this->west);
    }

    /** @psalm-mutation-free */
    public function setWest(float $west): self
    {
        $this->validatePositive($west);

        return new self($this->north, $this->east, $this->south, $west);
    }

    /** @psalm-mutation-free */
    public function getNorth(): float
    {
        return $this->north;
    }

    /** @psalm-mutation-free */
    public function getEast(): float
    {
        return $this->east;
    }

    /** @psalm-mutation-free */
    public function getSouth(): float
    {
        return $this->south;
    }

    /** @psalm-mutation-free */
    public function getWest(): float
    {
        return $this->west;
    }

    /**
     * @psalm-pure
     * @psalm-mutation-free
     *
     * @throws InvalidDistanceException
     */
    private function validatePositive(float $value): void
    {
        if ($value < 0) {
            throw new InvalidDistanceException('Negative distance is invalid.');
        }
    }
}