Talentify\ValueObject\Geography\Address\Physical\ByCountry\Us\UsPhysicalAddress

Complexity

Total Complexity

59

Size/Duplication

Total Lines	171
Duplicated Lines	0 %

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	getRegion()	0	3	1
A	getStreet()	0	3	1
A	getCounty()	0	3	1
A	getCity()	0	3	1
A	getTown()	0	3	1
A	getZipCode()	0	3	1
A	getCountry()	0	3	1
A	getDistrict()	0	3	1
A	__toString()	0	3	1
F	equals()	0	48	37
A	getState()	0	3	1
A	getPostalCode()	0	3	1
A	__construct()	0	15	1
C	getAddress()	0	24	10

<?php

declare(strict_types=1);

namespace Talentify\ValueObject\Geography\Address\Physical\ByCountry\Us;

use Talentify\ValueObject\Geography\Address\ByCountry\Us\County;
use Talentify\ValueObject\Geography\Address\ByCountry\Us\District;
use Talentify\ValueObject\Geography\Address\ByCountry\Us\State;
use Talentify\ValueObject\Geography\Address\ByCountry\Us\ZipCode;
use Talentify\ValueObject\Geography\Address\City;
use Talentify\ValueObject\Geography\Address\Country;
use Talentify\ValueObject\Geography\Address\Physical\PhysicalAddress;
use Talentify\ValueObject\Geography\Address\PostalCode;
use Talentify\ValueObject\Geography\Address\Region;
use Talentify\ValueObject\Geography\Address\Street;
use Talentify\ValueObject\Geography\CountryList;
use Talentify\ValueObject\StringUtils;
use Talentify\ValueObject\ValueObject;
use function is_object;

/**
 * Represents an address on the United States of America (USA).
 *
 * Example:
 *  - new UsPhysicalAddress(new Street('Broad St', '400'), new City('Seattle'), new County('King County'), new State('Washington'));
 *
 * @see https://en.wikipedia.org/wiki/Address#United_States
 */
final class UsPhysicalAddress implements PhysicalAddress
{
    /** @var \Talentify\ValueObject\Geography\Address\Street|null */
    private $street;
    /** @var \Talentify\ValueObject\Geography\Address\City|null */
    private $city;
    /** @var \Talentify\ValueObject\Geography\Address\ByCountry\Us\County|null */
    private $county;
    /** @var \Talentify\ValueObject\Geography\Address\ByCountry\Us\State|null */
    private $state;
    /** @var \Talentify\ValueObject\Geography\Address\ByCountry\Us\ZipCode|null */
    private $zipCode;
    /** @var \Talentify\ValueObject\Geography\Address\Country */
    private $country;
    /** @var string */
    private $formattedAddress;

    /**
     * @throws \InvalidArgumentException
     */
    public function __construct(
        ?Street $street = null,
        ?City $town = null,
        ?County $county = null,
        ?State $state = null,
        ?ZipCode $zipCode = null,
        ?string $formattedAddress = null
    ) {
        $this->street           = $street;
        $this->city             = $town;
        $this->county           = $county;
        $this->state            = $state;
        $this->zipCode          = $zipCode;
        $this->country          = CountryList::US();
        $this->formattedAddress = $formattedAddress;
    }

    public function getStreet() : ?Street
    {
        return $this->street;
    }

    public function getDistrict() : ?District
    {
        return null;
    }

    public function getCity() : ?City
    {
        return $this->city;
    }

    public function getTown() : ?City
    {
        return $this->city;
    }

    public function getCounty() : ?County
    {
        return $this->county;
    }

    public function getRegion() : ?Region
    {
        return $this->state;
    }

    public function getState() : ?Region
    {
        return $this->state;
    }

    public function getCountry() : Country
    {
        return $this->country;
    }

    public function getPostalCode() : ?PostalCode
    {
        return $this->zipCode;
    }

    public function getZipCode() : ?ZipCode
    {
        return $this->zipCode;
    }

    public function equals(?ValueObject $object) : bool
    {
        if (!$object instanceof self) {
            return false;
        }

        return (
            (
                (null === $this->getStreet() && null === $object->getStreet()) ||
                (is_object($this->getStreet()) && $this->getStreet()
                                                       ->equals($object->getStreet())) ||
                (is_object($object->getStreet()) && $object->getStreet()
                                                           ->equals($this->getStreet()))
            ) &&
            (
                (null === $this->getCity() && null === $object->getCity()) ||
                (is_object($this->getCity()) && $this->getCity()
                                                     ->equals($object->getCity())) ||
                (is_object($object->getCity()) && $object->getCity()
                                                         ->equals($this->getCity()))
            ) &&
            (
                (null === $this->getCounty() && null === $object->getCounty()) ||
                (is_object($this->getCounty()) && $this->getCounty()
                                                       ->equals($object->getCounty())) ||
                (is_object($object->getCounty()) && $object->getCounty()
                                                           ->equals($this->getCounty()))
            ) &&
            (
                (null === $this->getState() && null === $object->getState()) ||
                (is_object($this->getState()) && $this->getState()
                                                      ->equals($object->getState())) ||
                (is_object($object->getState()) && $object->getState()
                                                          ->equals($this->getState()))
            ) &&
            (
                (null === $this->getZipCode() && null === $object->getZipCode()) ||
                (is_object($this->getZipCode()) && $this->getZipCode()
                                                        ->equals($object->getZipCode())) ||
                (is_object($object->getZipCode()) && $object->getZipCode()
                                                            ->equals($this->getZipCode()))
            ) &&
            (
                (null === $this->getCountry() && null === $object->getCountry()) ||
                (is_object($this->getCountry()) && $this->getCountry()
                                                        ->equals($object->getCountry())) ||
                (is_object($object->getCountry()) && $object->getCountry()
                                                            ->equals($this->getCountry()))
            )
        );
    }

    /**
     *  Example: 400 Broad St, Seattle, WA 98109, EUA
     */
    public function getAddress() : string
    {
        if ($this->formattedAddress !== null) {
            return $this->formattedAddress;
        }

        $street     = $this->getStreet() ? $this->getStreet()->getFormatted() : '';
        $city       = $this->getCity() ? $this->getCity()->getFormatted() : '';
        $county     = $this->getCounty() ? $this->getCounty()->getFormatted() : '';

The assignment to $county is dead and can be removed.

        $state      = $this->getState() ? $this->getState()->__toString() : '';
        $postalCode = $this->getPostalCode() ? $this->getPostalCode()->getFormatted() : '';
        $country    = $this->getCountry() ? $this->getCountry()->__toString() : '';

        $values = [$street, $city, $state, $postalCode, $country];
        $nonEmptyValues = [];
        foreach ($values as $value) {
            if($value !== ''){
                $nonEmptyValues[] = $value;
            }
        }

        $formatted = implode(', ', $nonEmptyValues);

        return StringUtils::trimSpacesWisely($formatted);

The expression return Talentify\ValueObject\StringUtils::trimSpacesWisely($formatted) could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

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