Overtrue\LaravelVersionable\Version

Complexity

Total Complexity

8

Size/Duplication

Total Lines	76
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

86.96%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	user()	0	4	1
A	versionable()	0	4	1
A	createForModel()	0	15	1
A	revert()	0	4	1
A	diff()	0	16	4

<?php

/*
 * This file is part of the overtrue/laravel-versionable.
 *
 * (c) overtrue <i@overtrue.me>
 *
 * This source file is subject to the MIT license that is bundled.
 */

namespace Overtrue\LaravelVersionable;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Arr;
use SebastianBergmann\Diff\Differ;

/**
 * Class Version.
 *
 * @property Model $versionable
 * @property array $contents
 */
class Version extends Model
{
    /**
     * @var array
     */
    protected $casts = [
        'contents' => 'array',
    ];

    /**
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function user()
    {
        return $this->belongsTo(\config('versionable.user_model'), \config('versionable.user_foreign_key'));
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\MorphTo
     */
    public function versionable()
    {
        return $this->morphTo('versionable');
    }

    /**
     * @param \Illuminate\Database\Eloquent\Model $model
     *
     * @return \Overtrue\LaravelVersionable\Version
     */
    public static function createForModel(Model $model)
    {
        $versionClass = $model->getVersionModel();

        $version = new $versionClass();

        $version->versionable_id = $model->getKey();
        $version->versionable_type = $model->getMorphClass();
        $version->{\config('versionable.user_foreign_key')} = \auth()->id();

The method id does only exist in Illuminate\Contracts\Auth\Guard, but not in Illuminate\Contracts\Auth\Factory.

        $version->contents = $model->getVersionableAttributes();

        $version->save();

        return $version;
    }

    /**
     * @return bool
     */
    public function revert()
    {
        return $this->versionable->forceFill($this->contents)->save();
    }

    /**
     * @param \Illuminate\Database\Eloquent\Model|null $model
     *
     * @return string
     */
    public function diff(Model $model = null)
    {
        $model || $model = $this->versionable;

Consider using a different name than the parameter $model. This often makes code more readable.

        if ($model instanceof Version) {
            $source = $model->contents;
        } else {
            if (!\in_array(Versionable::class, \class_uses($model))) {
                throw new \InvalidArgumentException(\sprintf('Model %s is not versionable.', \get_class($model)));
            }

            $source = $model->versionableFromArray($this->versionable->toArray());

The method versionableFromArray cannot be called on $model (of type null).

        }

        return (new Differ())->diff(Arr::only($source, \array_keys($this->contents)), $this->contents);
    }
}