FullName::validate() - Code Metrics - Inspection of "Consistent API for object input validation" - michael-rubel/laravel-value-objects - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#2)

by Michael

created 2022-10-06 06:27 UTC

FullName::validate() A

↳ Parent: FullName

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2

Importance

Changes

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

<?php

declare(strict_types=1);

/**
 * This file is part of michael-rubel/laravel-value-objects. (https://github.com/michael-rubel/laravel-value-objects)
 *
 * @link https://github.com/michael-rubel/laravel-value-objects for the canonical source repository
 * @copyright Copyright (c) 2022 Michael Rubél. (https://github.com/michael-rubel/)
 * @license https://raw.githubusercontent.com/michael-rubel/laravel-value-objects/main/LICENSE.md MIT
 */

namespace MichaelRubel\ValueObjects\Collection\Complex;

use Illuminate\Support\Collection;
use InvalidArgumentException;
use MichaelRubel\Formatters\Collection\FullNameFormatter;
use MichaelRubel\ValueObjects\ValueObject;

/**
 * "FullName" object presenting a full name.
 *
 * @author Michael Rubél <[email protected]>
 *
 * @template TKey of array-key
 * @template TValue
 *
 * @method static static make(string|null $value)
 * @method static static from(string|null $value)
 *
 * @extends ValueObject<TKey, TValue>
 */
class FullName extends ValueObject
{
    /**
     * @var Collection<int, string>
     */
    protected Collection $split;

    /**
     * Create a new instance of the value object.
     *
     * @param  string  $value
     */
    public function __construct(protected string $value)
    {
        $this->validate();

        $this->value = $this->format();
        $this->split = $this->split();
    }

    /**
     * Get the full name.
     *
     * @return string
     */
    public function fullName(): string
    {
        return $this->value;
    }

    /**
     * Get the first name.
     *
     * @return string|null
     */
    public function firstName(): ?string
    {
        return $this->split->first();
    }

    /**
     * Get the last name.
     *
     * @return string|null
     */
    public function lastName(): ?string
    {
        return $this->split->last();
    }

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

    /**
     * Get an array representation of the value object.
     *
     * @return array<string, string|null>
     */
    public function toArray(): array
    {
        return [

            'fullName'  => $this->fullName(),
            'firstName' => $this->firstName(),
            'lastName'  => $this->lastName(),
        ];
    }

    /**
     * Validate the value object data.
     *
     * @return void
     */
    protected function validate(): void
    {
        if (empty($this->value())) {
            throw new InvalidArgumentException('Full name cannot be empty.');
        }
    }

    /**
     * Format the value.
     *
     * @return string
     */
    protected function format(): string
    {
        return format(FullNameFormatter::class, $this->value());
    }

    /**
     * Split the value.
     *
     * @return Collection<int, string>
     */
    protected function split(): Collection
    {
        return str($this->value())->split('/\s/');
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		/**
6		* This file is part of michael-rubel/laravel-value-objects. (https://github.com/michael-rubel/laravel-value-objects)
7		*
8		* @link https://github.com/michael-rubel/laravel-value-objects for the canonical source repository
9		* @copyright Copyright (c) 2022 Michael Rubél. (https://github.com/michael-rubel/)
10		* @license https://raw.githubusercontent.com/michael-rubel/laravel-value-objects/main/LICENSE.md MIT
11		*/
12
13		namespace MichaelRubel\ValueObjects\Collection\Complex;
14
15		use Illuminate\Support\Collection;
16		use InvalidArgumentException;
17		use MichaelRubel\Formatters\Collection\FullNameFormatter;
18		use MichaelRubel\ValueObjects\ValueObject;
19
20		/**
21		* "FullName" object presenting a full name.
22		*
23		* @author Michael Rubél <[email protected]>
24		*
25		* @template TKey of array-key
26		* @template TValue
27		*
28		* @method static static make(string\|null $value)
29		* @method static static from(string\|null $value)
30		*
31		* @extends ValueObject<TKey, TValue>
32		*/
33		class FullName extends ValueObject
34		{
35		/**
36		* @var Collection<int, string>
37		*/
38		protected Collection $split;
39
40		/**
41		* Create a new instance of the value object.
42		*
43		* @param string $value
44		*/
45	13	public function __construct(protected string $value)
46		{
47	13	$this->validate();
48
49	12	$this->value = $this->format();
50	12	$this->split = $this->split();
51		}
52
53		/**
54		* Get the full name.
55		*
56		* @return string
57		*/
58	13	public function fullName(): string
59		{
60	13	return $this->value;
61		}
62
63		/**
64		* Get the first name.
65		*
66		* @return string\|null
67		*/
68	6	public function firstName(): ?string
69		{
70	6	return $this->split->first();
71		}
72
73		/**
74		* Get the last name.
75		*
76		* @return string\|null
77		*/
78	5	public function lastName(): ?string
79		{
80	5	return $this->split->last();
81		}
82
83		/**
84		* Get the object value.
85		*
86		* @return string
87		*/
88	13	public function value(): string
89		{
90	13	return $this->fullName();
91		}
92
93		/**
94		* Get an array representation of the value object.
95		*
96		* @return array<string, string\|null>
97		*/
98	1	public function toArray(): array
99		{
100		return [
		0 ignored issues – show introduced 2022-10-04 10:35 UTC by Report Bug Copy Issue Report The expression `return array('fullName' ...' => $this->lastName())` returns an array which contains values of type `string` which are incompatible with the return type `Illuminate\Contracts\Support\TValue` mandated by `Illuminate\Contracts\Support\Arrayable::toArray()`. Loading history...
101	1	'fullName' => $this->fullName(),
102	1	'firstName' => $this->firstName(),
103	1	'lastName' => $this->lastName(),
104		];
105		}
106
107		/**
108		* Validate the value object data.
109		*
110		* @return void
111		*/
112	13	protected function validate(): void
113		{
114	13	if (empty($this->value())) {
115	1	throw new InvalidArgumentException('Full name cannot be empty.');
116		}
117		}
118
119		/**
120		* Format the value.
121		*
122		* @return string
123		*/
124	12	protected function format(): string
125		{
126	12	return format(FullNameFormatter::class, $this->value());
127		}
128
129		/**
130		* Split the value.
131		*
132		* @return Collection<int, string>
133		*/
134	12	protected function split(): Collection
135		{
136	12	return str($this->value())->split('/\s/');
137		}
138		}
139

michael-rubel / laravel-value-objects

Pull Request — main (#2)

FullName::validate() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like