Nip\Records\Traits\HasUuid\HasUuidRecordManagerTrait

Complexity

Total Complexity

14

Size/Duplication

Total Lines	94
Duplicated Lines	0 %

Test Coverage

Coverage

76.67%

Importance

Changes	1
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	resolveUuidVersion()	0	13	5
A	uuidColumn()	0	3	1
A	bootHasUuidRecordManagerTrait()	0	20	5
A	uuidColumns()	0	3	1
A	generateUuid()	0	10	2

<?php

namespace Nip\Records\Traits\HasUuid;


use Exception;
use Nip\Records\EventManager\Events\Event;
use Nip\Records\RecordManager;
use Nip\Utility\Uuid;
use Ramsey\Uuid\Exception\InvalidUuidStringException;

/**
 * Trait HasUuidRecordManagerTrait
 * @package Nip\Records\Traits\HasUuid
 */
trait HasUuidRecordManagerTrait
{
    /**
     * The UUID versions.
     *
     * @var array
     */
    protected $uuidVersions = [
        '1',
        '3',
        '4',
        '5',
        '6',
        'ordered',
    ];

    public function bootHasUuidRecordManagerTrait()
    {
        static::creating(function (Event $event) {
            $record = $event->getRecord();
            /** @var static|RecordManager $manager */
            $manager = $event->getManager();
            $columns = $manager->uuidColumns();

The method uuidColumns() does not exist on Nip\Records\RecordManager. Since you implemented __call, consider adding a @method annotation.

            foreach ($columns as $column) {
                /* @var \Ramsey\Uuid\Uuid $uuid */
                $uuid = $manager->generateUuid();

The method generateUuid() does not exist on Nip\Records\RecordManager. Since you implemented __call, consider adding a @method annotation.

                if (isset($record->{$column}) && !is_null($record->{$column})) {
                    try {
                        $uuid = $uuid->fromString(strtolower($record->{$column}));
                    } catch (InvalidUuidStringException $e) {
                        $uuid = $uuid->fromBytes($record->{$column});

The method fromBytes() does not exist on Ramsey\Uuid\UuidInterface. It seems like you code against a sub-type of said class. However, the method does not exist in Ramsey\Uuid\Rfc4122\UuidInterface. Are you sure you never get one of those?

                    }
                }

                $record->{$column} = strtolower($uuid->toString());
            }
        });
    }

    /**
     * The name of the column that should be used for the UUID.
     *
     * @return string
     */
    public function uuidColumn(): string
    {
        return 'uuid';
    }

    /**
     * The names of the columns that should be used for the UUID.
     *
     * @return array
     */
    public function uuidColumns(): array
    {
        return [$this->uuidColumn()];
    }

    /**
     * Resolve the UUID version to use when setting the UUID value. Default to uuid4.
     *
     * @return string
     */
    public function resolveUuidVersion(): string
    {
        if (property_exists($this, 'uuidVersion') && in_array($this->uuidVersion, $this->uuidVersions)) {
            return $this->uuidVersion;
        }
        if (method_exists($this, 'uuidVersion')) {
            $version = $this->uuidVersion();
            if (in_array($version, $this->uuidVersions)) {
                return $version;
            }
        }

        return 4;
    }

    /**
     * @return \Ramsey\Uuid\UuidInterface
     * @throws Exception
     */
    protected function generateUuid()
    {
        $version = $this->resolveUuidVersion();

        switch ($version) {
            case 4:
                return Uuid::v4();
        }

        throw new Exception("UUID version [{$version}] not supported.");
    }
}