TaxNumber::make() - Code Metrics - Inspection of "Revert "remove `null` from docblocks"" - michael-rubel/laravel-value-objects - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( ec6948...9b9c4a )

by Michael

created 2022-09-21 12:56 UTC

TaxNumber::make() A

↳ Parent: TaxNumber

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
eloc	1
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
c	1
b	0
f	1
cc	1
nc	1
nop	2
crap	1

<?php

declare(strict_types=1);

namespace MichaelRubel\ValueObjects\Complex;

use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Support\Traits\Conditionable;
use Illuminate\Support\Traits\Macroable;
use MichaelRubel\Formatters\Collection\TaxNumberFormatter;
use MichaelRubel\ValueObjects\ValueObject;

/**
 * @method make(string $taxNumber, string $country)
 */
class TaxNumber extends ValueObject implements Arrayable
{
    use Macroable, Conditionable;


    /**
     * @param  string|null  $taxNumber
     * @param  string|null  $country
     */
    public function __construct(
        protected ?string $taxNumber = null,
        protected ?string $country = null,
    ) {
        $this->taxNumber = format(TaxNumberFormatter::class, $this->taxNumber, $this->country);

        $this->when($this->isWithCountry(), function () {
            $this->country = str($this->taxNumber)
                ->substr(0, 2)
                ->upper()
                ->value();

            $this->taxNumber = str($this->taxNumber)
                ->substr(2)
                ->value();
        });
    }

    /**
     * Get the tax number with a country prefix.
     *
     * @return string
     */
    public function fullTaxNumber(): string
    {
        return $this->country() . $this->taxNumber();
    }

    /**
     * Get the tax number without country prefix.
     *
     * @return string
     */
    public function taxNumber(): string
    {
        return str($this->taxNumber)
            ->upper()
            ->value();
    }

    /**
     * Get the country prefix for a given tax number.
     *
     * @return string
     */
    public function country(): string
    {
        return str($this->country)
            ->upper()
            ->value();
    }

    /**
     * Check if the tax number length is less or equal two.
     *
     * @return bool
     */
    public function isWithCountry(): bool
    {
        return strlen($this->taxNumber) >= 2 && ! is_numeric($this->taxNumber);
        return strlen(/** @scrutinizer ignore-type */ $this->taxNumber) >= 2 && ! is_numeric($this->taxNumber);
    }

    /**
     * Get array representation of the value object.
     *
     * @return array
     */
    public function toArray(): array
    {
        return [
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
            'fullTaxNumber' => $this->fullTaxNumber(),
            'taxNumber'     => $this->taxNumber(),
            'country'       => $this->country(),
        ];
    }

    /**
     * Get string representation of the value object.
     *
     * @return string
     */
    public function __toString(): string
    {
        return $this->fullTaxNumber();
    }
}


michael-rubel / laravel-value-objects

Push — main ( ec6948...9b9c4a )

TaxNumber::make() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like