Version::user() - Code Metrics - Inspection of "Add version creator relation." - overtrue/laravel-versionable - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 36c463...758946 )

by Carlos

created 2019-11-12 10:43 UTC

Version::user() A

↳ Parent: Version

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

/*
 * This file is part of the overtrue/laravel-versionable.
 *
 * (c) overtrue <[email protected]>
 *
 * 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();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        $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;


        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());

        }

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


1		<?php
2
3		/*
4		* This file is part of the overtrue/laravel-versionable.
5		*
6		* (c) overtrue <[email protected]>
7		*
8		* This source file is subject to the MIT license that is bundled.
9		*/
10
11		namespace Overtrue\LaravelVersionable;
12
13		use Illuminate\Database\Eloquent\Model;
14		use Illuminate\Support\Arr;
15		use SebastianBergmann\Diff\Differ;
16
17		/**
18		* Class Version.
19		*
20		* @property Model $versionable
21		* @property array $contents
22		*/
23		class Version extends Model
24		{
25		/**
26		* @var array
27		*/
28		protected $casts = [
29		'contents' => 'array',
30		];
31
32		/**
33		* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
34		*/
35		public function user()
36		{
37		return $this->belongsTo(\config('versionable.user_model'), \config('versionable.user_foreign_key'));
38		}
39
40		/**
41		* @return \Illuminate\Database\Eloquent\Relations\MorphTo
42		*/
43	2	public function versionable()
44		{
45	2	return $this->morphTo('versionable');
46		}
47
48		/**
49		* @param \Illuminate\Database\Eloquent\Model $model
50		*
51		* @return \Overtrue\LaravelVersionable\Version
52		*/
53	5	public static function createForModel(Model $model)
54		{
55	5	$versionClass = $model->getVersionModel();
56
57	5	$version = new $versionClass();
58
59	5	$version->versionable_id = $model->getKey();
60	5	$version->versionable_type = $model->getMorphClass();
61	5	$version->{\config('versionable.user_foreign_key')} = \auth()->id();
		0 ignored issues – show Bug introduced 2019-06-03 03:39 UTC by Report Bug Copy Issue Report The method `id` does only exist in `Illuminate\Contracts\Auth\Guard`, but not in `Illuminate\Contracts\Auth\Factory`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
62	5	$version->contents = $model->getVersionableAttributes();
63
64	5	$version->save();
65
66	5	return $version;
67		}
68
69		/**
70		* @return bool
71		*/
72	1	public function revert()
73		{
74	1	return $this->versionable->forceFill($this->contents)->save();
75		}
76
77		/**
78		* @param \Illuminate\Database\Eloquent\Model\|null $model
79		*
80		* @return string
81		*/
82	1	public function diff(Model $model = null)
83		{
84	1	$model \|\| $model = $this->versionable;
		0 ignored issues – show Coding Style introduced 2019-06-03 03:39 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$model`. This often makes code more readable. Loading history...
85
86	1	if ($model instanceof Version) {
87	1	$source = $model->contents;
88		} else {
89	1	if (!\in_array(Versionable::class, \class_uses($model))) {
90		throw new \InvalidArgumentException(\sprintf('Model %s is not versionable.', \get_class($model)));
91		}
92
93	1	$source = $model->versionableFromArray($this->versionable->toArray());
		0 ignored issues – show Bug introduced 2019-06-03 03:39 UTC by Report Bug Copy Issue Report The method `versionableFromArray` cannot be called on `$model` (of type `null`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
94		}
95
96	1	return (new Differ())->diff(Arr::only($source, \array_keys($this->contents)), $this->contents);
97		}
98		}
99

overtrue / laravel-versionable

Push — master ( 36c463...758946 )

Version::user() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like