NGUtech\Bitcoin\ValueObject\Bitcoin

Complexity

Total Complexity

22

Size/Duplication

Total Lines	136
Duplicated Lines	0 %

Test Coverage

Coverage

61.29%

Importance

Changes

0

21 Methods

Rating	Name	Duplication	Size	Complexity
A	isLessThanOrEqual()	0	4	1
A	add()	0	6	1
A	multiply()	0	5	1
A	divide()	0	5	1
A	getCurrency()	0	3	1
A	makeEmpty()	0	3	1
A	toNative()	0	3	1
A	__toString()	0	3	1
A	isZero()	0	3	1
A	isGreaterThanOrEqual()	0	4	1
A	subtract()	0	6	1
A	isPositive()	0	3	1
A	__construct()	0	9	1
A	percentage()	0	3	1
A	zero()	0	3	1
A	isEmpty()	0	3	1
A	equals()	0	4	1
A	asBaseMoney()	0	3	1
A	getAmount()	0	3	1
A	isNegative()	0	3	1
A	fromNative()	0	9	2

<?php declare(strict_types=1);
/**
 * This file is part of the ngutech/bitcoin-interop project.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace NGUtech\Bitcoin\ValueObject;

use Daikon\Interop\Assertion;
use Daikon\Interop\InvalidArgumentException;
use Daikon\Interop\MakeEmptyInterface;
use Daikon\Money\ValueObject\MoneyInterface;
use Money\Currency;
use Money\Money;
use NGUtech\Bitcoin\Service\BitcoinCurrencies;
use NGUtech\Bitcoin\Service\SatoshiCurrencies;

final class Bitcoin implements MakeEmptyInterface, MoneyInterface
{
    private Money $money;

    /** @param self $comparator */
    public function equals($comparator): bool
    {
        Assertion::isInstanceOf($comparator, self::class);
        return $this->toNative() === $comparator->toNative();
    }

    public function getAmount(): string
    {
        return $this->money->getAmount();
    }

    public function getCurrency(): string
    {
        return $this->money->getCurrency()->getCode();
    }

    public function multiply($multiplier, int $roundingMode = self::ROUND_HALF_UP): self
    {
        Assertion::numeric($multiplier, 'Multipler must be numeric.');
        $multiplied = $this->money->multiply($multiplier, $roundingMode);
        return new self($multiplied);
    }

    public function divide($divisor, int $roundingMode = self::ROUND_HALF_UP): self
    {
        Assertion::numeric($divisor, 'Divider must be numeric.');
        $divided = $this->money->divide($divisor, $roundingMode);
        return new self($divided);
    }

    public function percentage($percentage, int $roundingMode = self::ROUND_HALF_UP): self
    {
        return $this->multiply($percentage)->divide(100, $roundingMode);
    }

    public function add(MoneyInterface $money): self
    {
        $added = $this->money->add(
            self::asBaseMoney($money->getAmount(), $money->getCurrency())
        );
        return new self($added);
    }

    public function subtract(MoneyInterface $money): self
    {
        $subtracted = $this->money->subtract(
            self::asBaseMoney($money->getAmount(), $money->getCurrency())
        );
        return new self($subtracted);
    }

    public function isZero(): bool
    {
        return $this->money->isZero();
    }

    public function isPositive(): bool
    {
        return $this->money->isPositive();
    }

    public function isNegative(): bool
    {
        return $this->money->isNegative();
    }

    public function isLessThanOrEqual(MoneyInterface $money): bool
    {
        return $this->money->lessThanOrEqual(
            self::asBaseMoney($money->getAmount(), $money->getCurrency())
        );
    }

    public function isGreaterThanOrEqual(MoneyInterface $money): bool
    {
        return $this->money->greaterThanOrEqual(
            self::asBaseMoney($money->getAmount(), $money->getCurrency())
        );
    }

    /** @param string $value */
    public static function fromNative($value): self
    {
        Assertion::string($value, 'Must be a string.');

        if (!preg_match('/^(?<amount>-?\d+)\s?(?<currency>M?SAT|BTC|XBT)$/i', $value, $matches)) {
            throw new InvalidArgumentException('Invalid amount.');
        }

        return new self(self::asBaseMoney($matches['amount'], strtoupper($matches['currency'])));
    }

    public static function zero($currency = null): self
    {
        return self::fromNative('0'.($currency ?? SatoshiCurrencies::MSAT));
    }

    public static function makeEmpty(): self
    {
        return self::zero();
    }

    public function isEmpty(): bool
    {
        return $this->isZero();
    }

    public function toNative(): string
    {
        return $this->getAmount().$this->getCurrency();
    }

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

    private static function asBaseMoney(string $amount, string $currency): Money
    {
        return new Money($amount, new Currency($currency));
    }

    private function __construct(Money $money)
    {
        Assertion::choice((string)$money->getCurrency(), [
            SatoshiCurrencies::MSAT,
            SatoshiCurrencies::SAT,
            BitcoinCurrencies::BTC,
            BitcoinCurrencies::XBT
        ], 'Invalid currency');
        $this->money = $money;
    }
}