MichaelRubel\ValueObjects\Collection\Complex\Email

Complexity

Total Complexity

4

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	5
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	hp$0 ➔ split()	0	3	1
A	__construct()	0	6	1
	validate()	0	10	?
A	hp$0 ➔ validationParameters()	0	3	1
A	domain()	0	3	1
A	hp$0 ➔ validate()	0	10	2
	split()	0	3	?
A	toArray()	0	6	1
A	username()	0	3	1
	validationParameters()	0	3	?

<?php

/**
 * 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 Illuminate\Support\Stringable;
use Illuminate\Validation\Concerns\ValidatesAttributes;
use Illuminate\Validation\ValidationException;
use MichaelRubel\ValueObjects\Collection\Primitive\Text;

/**
 * "Email" object that represents the email address.
 *
 * @author Michael Rubél <michael@laravel.software>
 *
 * @template TKey of array-key
 * @template TValue
 *
 * @method static static make(string|Stringable $value)
 * @method static static from(string|Stringable $value)
 * @method static static makeOrNull(string|Stringable|null $value)
 *
 * @extends Text<TKey, TValue>
 */
class Email extends Text
{
    /**
     * @var Collection<int, string>
     */
    protected Collection $split;

    /**
     * Create a new instance of the value object.
     *
     * @param  string|Stringable  $value
     */
    public function __construct(string|Stringable $value)
    {
        parent::__construct($value);

        $this->validate();
        $this->split();
    }

    /**
     * @return string
     */
    public function username(): string
    {
        return (string) $this->split->first();
    }

    /**
     * @return string
     */
    public function domain(): string
    {
        return (string) $this->split->last();
    }

    /**
     * Get an array representation of the value object.
     *
     * @return array
     */
    public function toArray(): array
    {
        return [
            'email'    => $this->value(),
            'username' => $this->username(),
            'domain'   => $this->domain(),
        ];
    }

    /**
     * Validate the email.
     *
     * @return void
     */
    protected function validate(): void
    {
        $toValidate = ['email', $this->value(), $this->validationParameters()];
        $validator = new class
        {
            use ValidatesAttributes;

The trait Illuminate\Validation\Concerns\ValidatesAttributes requires some properties which are not provided by anonymous//src/Collection/Complex/Email.php$0: $data, $container, $currentRule, $rules, $implicitAttributes

        };

        if (!$validator->validateEmail(...$toValidate)) {

It seems like $toValidate can also be of type array<integer,string>; however, parameter $attribute of anonymous//src/Collection/Complex/Email.php$0::validateEmail() does only seem to accept string, maybe add an additional type check?

            throw ValidationException::withMessages([__('Your email is invalid.')]);
        }
    }

    /**
     * Define how you want to validate the email.
     *
     * @return array
     */
    protected function validationParameters(): array
    {
        return ['filter', 'spoof'];
    }

    /**
     * Split the value by at symbol.
     *
     * @return void
     */
    protected function split(): void
    {
        $this->split = str($this->value())->split('/@/');
    }
}