Approvable::approvals() - Code Metrics - Inspection of "Apply fixes from StyleCI" - victorlap/laravel-approvable - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 094305...023641 )

by Victor

created 2018-05-18 18:16 UTC

Approvable::approvals() A

↳ Parent: Approvable

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

namespace Victorlap\Approvable;

use Illuminate\Database\Eloquent\Relations\MorphMany;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\DB;

/**
 * Class Approvable
 * @package Victorlap\Approvable
 */
trait Approvable
{

    /** @var array */
    public $approveOf = array();

    /** @var array */
    public $dontApproveOf = array();

    /** @var bool */
    protected $withoutApproval = false;

    /**
     * Create the event listeners for the saving event
     * This lets us save approvals whenever a save is made, no matter the
     * http method
     */
    public static function bootApprovable(): void
    {
        static::saving(function ($model) {
            return $model->preSave();
        });
    }

    /**
     * @return MorphMany
     */
    public function approvals(): MorphMany
    {
        return $this->morphMany(Approval::class, 'approvable');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Check if this model has pending changes,
     * If an attribute is provided, check if the attribute has pending changes.
     *
     * @param null $attribute
     * @return bool
     */
    public function isPendingApproval($attribute = null): bool
    {
        return $this->approvals()
            ->when($attribute !== null, function ($query) use ($attribute) {
                $query->where('key', $attribute);
            })
            ->where('approved', null)
            ->exists();
    }

    /**
     * List all the attributes, that currently have pending changes.
     *
     * @return \Illuminate\Support\Collection
     */
    public function getPendingApprovalAttributes(): Collection
    {
        return $this->approvals()
            ->where('approved', null)
            ->groupBy('key')
            ->pluck('key');
    }

    public function withoutApproval(bool $withoutApproval = true): void
    {
        $this->withoutApproval = $withoutApproval;
    }

    /**
     * Invoked before a model is saved. Return false to abort the operation.
     *
     * @return bool
     */
    protected function preSave(): bool
    {
        if ($this->withoutApproval) {
            return true;
        }

        if ($this->currentUserCanApprove()) {
            // If the user is able to approve edits, do nothing.
            return true;
        }

        if (!$this->exists) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            // There is currently no way (implemented) to enable this for new models.
            return true;
        }

        $changes_to_record = $this->changedApprovableFields();

        $approvals = array();
        foreach ($changes_to_record as $key => $change) {
            $approvals[] = array(
                'approvable_type' => $this->getMorphClass(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                'approvable_id' => $this->getKey(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                'key' => $key,
                'value' => $change,
                'user_id' => $this->getSystemUserId(),
                'created_at' => new \DateTime(),
                'updated_at' => new \DateTime(),
            );
        }

        if (count($approvals) > 0) {
            $approval = new Approval();
            DB::table($approval->getTable())->insert($approvals);
        }

        return true;
    }

    /**
     * Get all of the changes that have been made, that are also supposed
     * to be approved.
     *
     * @return array fields with new data, that should be recorded
     */
    private function changedApprovableFields(): array
    {
        $dirty = $this->getDirty();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $changes_to_record = array();

        foreach ($dirty as $key => $value) {
            if ($this->isApprovable($key)) {
                if (!isset($this->original[$key]) || $this->original[$key] != $this->attributes[$key]) {
                    $changes_to_record[$key] = $value;

                    // Reset changes that we want to approve
                    if (!isset($this->original[$key])) {
                        unset($this->attributes[$key]);
                    } else {
                        $this->attributes[$key] = $this->original[$key];
class MyClass { }

$x = new MyClass();
$x->foo = true;
                    }
                }
            }
        }

        return $changes_to_record;
    }

    private function isApprovable(string $key): bool
    {
        if (isset($this->approveOf) && in_array($key, $this->approveOf)) {
            return true;
        }
        if (isset($this->dontApproveOf) && in_array($key, $this->dontApproveOf)) {
            return false;
        }

        return empty($this->approveOf);
    }

    protected function getSystemUserId(): ?int
    {
        return Auth::id() ?? null;
    }

    protected function currentUserCanApprove(): bool
    {
        return Auth::check() && Auth::user()->can('approve', $this) ?? false;
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }
}


1		<?php
2
3		namespace Victorlap\Approvable;
4
5		use Illuminate\Database\Eloquent\Relations\MorphMany;
6		use Illuminate\Support\Collection;
7		use Illuminate\Support\Facades\Auth;
8		use Illuminate\Support\Facades\DB;
9
10		/**
11		* Class Approvable
12		* @package Victorlap\Approvable
13		*/
14		trait Approvable
15		{
16
17		/** @var array */
18		public $approveOf = array();
19
20		/** @var array */
21		public $dontApproveOf = array();
22
23		/** @var bool */
24		protected $withoutApproval = false;
25
26		/**
27		* Create the event listeners for the saving event
28		* This lets us save approvals whenever a save is made, no matter the
29		* http method
30		*/
31		public static function bootApprovable(): void
32		{
33	8	static::saving(function ($model) {
34	8	return $model->preSave();
35	8	});
36	8	}
37
38		/**
39		* @return MorphMany
40		*/
41	3	public function approvals(): MorphMany
42		{
43	3	return $this->morphMany(Approval::class, 'approvable');
		0 ignored issues – show Bug introduced 2017-10-08 20:29 UTC by Report Bug Copy Issue Report It seems like `morphMany()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
44		}
45
46		/**
47		* Check if this model has pending changes,
48		* If an attribute is provided, check if the attribute has pending changes.
49		*
50		* @param null $attribute
51		* @return bool
52		*/
53	2	public function isPendingApproval($attribute = null): bool
54		{
55	2	return $this->approvals()
56	2	->when($attribute !== null, function ($query) use ($attribute) {
57	1	$query->where('key', $attribute);
58	2	})
59	2	->where('approved', null)
60	2	->exists();
61		}
62
63		/**
64		* List all the attributes, that currently have pending changes.
65		*
66		* @return \Illuminate\Support\Collection
67		*/
68	1	public function getPendingApprovalAttributes(): Collection
69		{
70	1	return $this->approvals()
71	1	->where('approved', null)
72	1	->groupBy('key')
73	1	->pluck('key');
74		}
75
76		public function withoutApproval(bool $withoutApproval = true): void
77		{
78		$this->withoutApproval = $withoutApproval;
79		}
80
81		/**
82		* Invoked before a model is saved. Return false to abort the operation.
83	1	*
84		* @return bool
85	1	*/
86	1	protected function preSave(): bool
87		{
88		if ($this->withoutApproval) {
89		return true;
90		}
91
92		if ($this->currentUserCanApprove()) {
93		// If the user is able to approve edits, do nothing.
94	8	return true;
95		}
96	8
97		if (!$this->exists) {
		0 ignored issues – show Bug introduced 2017-07-03 08:34 UTC by Report Bug Copy Issue Report The property `exists` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
98	2	// There is currently no way (implemented) to enable this for new models.
99		return true;
100		}
101	6
102		$changes_to_record = $this->changedApprovableFields();
103	6
104		$approvals = array();
105		foreach ($changes_to_record as $key => $change) {
106	5	$approvals[] = array(
107		'approvable_type' => $this->getMorphClass(),
		0 ignored issues – show Bug introduced 2017-07-03 08:34 UTC by Report Bug Copy Issue Report It seems like `getMorphClass()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
108	5	'approvable_id' => $this->getKey(),
		0 ignored issues – show Bug introduced 2017-07-03 08:34 UTC by Report Bug Copy Issue Report It seems like `getKey()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
109	5	'key' => $key,
110	5	'value' => $change,
111	5	'user_id' => $this->getSystemUserId(),
112	5	'created_at' => new \DateTime(),
113	5	'updated_at' => new \DateTime(),
114	5	);
115	5	}
116	5
117	5	if (count($approvals) > 0) {
118		$approval = new Approval();
119		DB::table($approval->getTable())->insert($approvals);
120		}
121	5
122	5	return true;
123	5	}
124
125		/**
126	5	* Get all of the changes that have been made, that are also supposed
127		* to be approved.
128		*
129		* @return array fields with new data, that should be recorded
130		*/
131		private function changedApprovableFields(): array
132		{
133		$dirty = $this->getDirty();
		0 ignored issues – show Bug introduced 2017-07-03 08:34 UTC by Report Bug Copy Issue Report It seems like `getDirty()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
134		$changes_to_record = array();
135	5
136		foreach ($dirty as $key => $value) {
137	5	if ($this->isApprovable($key)) {
138	5	if (!isset($this->original[$key]) \|\| $this->original[$key] != $this->attributes[$key]) {
139		$changes_to_record[$key] = $value;
140	5
141	5	// Reset changes that we want to approve
142	5	if (!isset($this->original[$key])) {
143	5	unset($this->attributes[$key]);
144		} else {
145		$this->attributes[$key] = $this->original[$key];
		0 ignored issues – show Bug introduced 2018-05-17 22:35 UTC by Report Bug Copy Issue Report The property `attributes` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history... Bug introduced 2017-07-03 08:34 UTC by Report Bug Copy Issue Report The property `original` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
146	5	}
147		}
148		}
149	5	}
150
151		return $changes_to_record;
152		}
153
154		private function isApprovable(string $key): bool
155	5	{
156		if (isset($this->approveOf) && in_array($key, $this->approveOf)) {
157		return true;
158		}
159		if (isset($this->dontApproveOf) && in_array($key, $this->dontApproveOf)) {
160		return false;
161		}
162	5
163		return empty($this->approveOf);
164	5	}
165
166		protected function getSystemUserId(): ?int
167	5	{
168		return Auth::id() ?? null;
169		}
170
171	5	protected function currentUserCanApprove(): bool
172		{
173		return Auth::check() && Auth::user()->can('approve', $this) ?? false;
		0 ignored issues – show Bug introduced 2017-07-03 08:34 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Illuminate\Contracts\Auth\Authenticatable` as the method `can()` does only exist in the following implementations of said interface: `Illuminate\Foundation\Auth\User`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
174		}
175		}
176

victorlap / laravel-approvable

GitHub Access Token became invalid

Push — master ( 094305...023641 )

Approvable::approvals() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like