SortableTrait - Code Metrics - Inspection of "Unique key" - spatie/eloquent-sortable - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#48)

unknown

created 2017-09-18 17:01 UTC

SortableTrait A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	252
Duplicated Lines	11.9 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	7
Bugs	1	Features	1

Metric	Value
wmc	31
c	7
b	1
f	1
lcom	1
cbo	2
dl	30
loc	252
rs	9.8

14 Methods

Rating	Name	Duplication	Size	Complexity
A	determineOrderColumnName()	0	11	3
A	bootSortableTrait()	0	8	3
A	setHighestOrderNumber()	0	6	1
A	getHighestOrderNumber()	0	4	1
A	scopeOrdered()	0	4	1
A	setNewOrder()	0	17	4
A	shouldSortWhenCreating()	0	4	1
A	moveOrderDown()	15	15	2
A	moveOrderUp()	15	15	2
A	swapOrderWithModel()	0	14	1
A	swapOrder()	0	4	1
A	moveToStart()	0	19	2
A	moveToEnd()	0	21	2
C	buildSortQuery()	0	27	7

How to fix Duplicated Code

<?php

namespace Spatie\EloquentSortable;

use ArrayAccess;
use InvalidArgumentException;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\SoftDeletingScope;

trait SortableTrait
{
    public static function bootSortableTrait()
    {
        static::creating(function ($model) {

            if ($model instanceof Sortable && $model->shouldSortWhenCreating()) {
                $model->setHighestOrderNumber();
            }
        });
    }

    /**
     * Modify the order column value.
     */
    public function setHighestOrderNumber()
    {
        $orderColumnName = $this->determineOrderColumnName();

        $this->$orderColumnName = $this->getHighestOrderNumber() + 1;
    }

    /**
     * Determine the order value for the new record.
     */
    public function getHighestOrderNumber(): int
    {
        return (int) $this->buildSortQuery()->max($this->determineOrderColumnName());
    }

    /**
     * Let's be nice and provide an ordered scope.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param string $direction
     *
     * @return \Illuminate\Database\Query\Builder
     */
    public function scopeOrdered(Builder $query, string $direction = 'asc')
    {
        return $query->orderBy($this->determineOrderColumnName(), $direction);

    }

    /**
     * This function reorders the records: the record with the first id in the array
     * will get order 1, the record with the second it will get order 2, ...
     *
     * A starting order number can be optionally supplied (defaults to 1).
     *
     * @param array|\ArrayAccess $ids
     * @param int $startOrder
     */
    public static function setNewOrder($ids, int $startOrder = 1)
    {
        if (! is_array($ids) && ! $ids instanceof ArrayAccess) {
            throw new InvalidArgumentException('You must pass an array or ArrayAccess object to setNewOrder');
        }

        $model = new static;

        $orderColumnName = $model->determineOrderColumnName();
        $primaryKeyColumn = $model->getKeyName();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        foreach ($ids as $id) {
            static::withoutGlobalScope(SoftDeletingScope::class)
                ->where($primaryKeyColumn, $id)
                ->update([$orderColumnName => $startOrder++]);
        }
    }

    /*
     * Determine the column name of the order column.
     */
    protected function determineOrderColumnName(): string
    {
        if (
            isset($this->sortable['order_column_name']) &&
            ! empty($this->sortable['order_column_name'])
        ) {
            return $this->sortable['order_column_name'];
        }

        return 'order_column';
    }

    /**
     * Determine if the order column should be set when saving a new model instance.
     */
    public function shouldSortWhenCreating(): bool
    {
        return $this->sortable['sort_when_creating'] ?? true;
    }

    /**
     * Swaps the order of this model with the model 'below' this model.
     *
     * @return $this
     */
    public function moveOrderDown()

    {
        $orderColumnName = $this->determineOrderColumnName();

        $swapWithModel = $this->buildSortQuery()->limit(1)
            ->ordered()
            ->where($orderColumnName, '>', $this->$orderColumnName)
            ->first();

        if (! $swapWithModel) {
            return $this;
        }

        return $this->swapOrderWithModel($swapWithModel);
    }

    /**
     * Swaps the order of this model with the model 'above' this model.
     *
     * @return $this
     */
    public function moveOrderUp()

    {
        $orderColumnName = $this->determineOrderColumnName();

        $swapWithModel = $this->buildSortQuery()->limit(1)
            ->ordered('desc')
            ->where($orderColumnName, '<', $this->$orderColumnName)
            ->first();

        if (! $swapWithModel) {
            return $this;
        }

        return $this->swapOrderWithModel($swapWithModel);
    }

    /**
     * Swap the order of this model with the order of another model.
     *
     * @param \Spatie\EloquentSortable\Sortable $otherModel
     *
     * @return $this
     */
    public function swapOrderWithModel(Sortable $otherModel)
    {
        $orderColumnName = $this->determineOrderColumnName();

        $oldOrderOfOtherModel = $otherModel->$orderColumnName;

        $otherModel->$orderColumnName = $this->$orderColumnName;
        $otherModel->save();

        $this->$orderColumnName = $oldOrderOfOtherModel;
        $this->save();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        return $this;
    }

    /**
     * Swap the order of two models.
     *
     * @param \Spatie\EloquentSortable\Sortable $model
     * @param \Spatie\EloquentSortable\Sortable $otherModel
     */
    public static function swapOrder(Sortable $model, Sortable $otherModel)
    {
        $model->swapOrderWithModel($otherModel);
    }

    /**
     * Moves this model to the first position.
     *
     * @return $this
     */
    public function moveToStart()
    {
        $firstModel = $this->buildSortQuery()->limit(1)
            ->ordered()
            ->first();

        if ($firstModel->id === $this->id) {
class MyClass { }

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

        $orderColumnName = $this->determineOrderColumnName();

        $this->$orderColumnName = $firstModel->$orderColumnName;
        $this->save();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $this->buildSortQuery()->where($this->getKeyName(), '!=', $this->id)->increment($orderColumnName);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        return $this;
    }

    /**
     * Moves this model to the last position.
     *
     * @return $this
     */
    public function moveToEnd()
    {
        $maxOrder = $this->getHighestOrderNumber();

        $orderColumnName = $this->determineOrderColumnName();

        if ($this->$orderColumnName === $maxOrder) {
            return $this;
        }

        $oldOrder = $this->$orderColumnName;

        $this->$orderColumnName = $maxOrder;
        $this->save();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $this->buildSortQuery()->where($this->getKeyName(), '!=', $this->id)
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            ->where($orderColumnName, '>', $oldOrder)
            ->decrement($orderColumnName);

        return $this;
    }

    /**
     * Build eloquent builder of sortable.
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function buildSortQuery()
    {
        /** @var \Illuminate\Database\Eloquent\Builder $query */
        $query = static::query();

        if (
            isset($this->sortable['order_unique']) &&
            ! empty($this->sortable['order_unique'])
        ) {
            if (is_array($this->sortable['order_unique'])) {
                foreach ($this->sortable['order_unique'] as $key) {
                    if (empty($this->$key)) {
                        throw new \Exception('Unique sorting key must be set first ('.$key.')');
                    }
                    $query->where($key, '=', $this->$key);
                }
            } else {
                $key = $this->sortable['order_unique'];
                if (empty($this->$key)) {
                    throw new \Exception('Unique sorting key must be set first ('.$key.')');
                }
                $query->where($key, '=', $this->$key);
            }
        }

        return $query;
    }
}


1		<?php
2
3		namespace Spatie\EloquentSortable;
4
5		use ArrayAccess;
6		use InvalidArgumentException;
7		use Illuminate\Database\Eloquent\Builder;
8		use Illuminate\Database\Eloquent\SoftDeletingScope;
9
10		trait SortableTrait
11		{
12		public static function bootSortableTrait()
13		{
14		static::creating(function ($model) {
		0 ignored issues – show Bug introduced 2016-10-21 22:32 UTC by Report Bug Copy Issue Report The method `creating()` does not exist on `Spatie\EloquentSortable\SortableTrait`. Did you maybe mean `shouldSortWhenCreating()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
15		if ($model instanceof Sortable && $model->shouldSortWhenCreating()) {
16		$model->setHighestOrderNumber();
17		}
18		});
19		}
20
21		/**
22		* Modify the order column value.
23		*/
24		public function setHighestOrderNumber()
25		{
26		$orderColumnName = $this->determineOrderColumnName();
27
28		$this->$orderColumnName = $this->getHighestOrderNumber() + 1;
29		}
30
31		/**
32		* Determine the order value for the new record.
33		*/
34		public function getHighestOrderNumber(): int
35		{
36		return (int) $this->buildSortQuery()->max($this->determineOrderColumnName());
37		}
38
39		/**
40		* Let's be nice and provide an ordered scope.
41		*
42		* @param \Illuminate\Database\Eloquent\Builder $query
43		* @param string $direction
44		*
45		* @return \Illuminate\Database\Query\Builder
46		*/
47		public function scopeOrdered(Builder $query, string $direction = 'asc')
48		{
49		return $query->orderBy($this->determineOrderColumnName(), $direction);
		0 ignored issues – show Bug introduced 2017-04-05 09:01 UTC by Report Bug Copy Issue Report The method `orderBy()` does not exist on `Illuminate\Database\Eloquent\Builder`. Did you maybe mean `enforceOrderBy()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
50		}
51
52		/**
53		* This function reorders the records: the record with the first id in the array
54		* will get order 1, the record with the second it will get order 2, ...
55		*
56		* A starting order number can be optionally supplied (defaults to 1).
57		*
58		* @param array\|\ArrayAccess $ids
59		* @param int $startOrder
60		*/
61		public static function setNewOrder($ids, int $startOrder = 1)
62		{
63		if (! is_array($ids) && ! $ids instanceof ArrayAccess) {
64		throw new InvalidArgumentException('You must pass an array or ArrayAccess object to setNewOrder');
65		}
66
67		$model = new static;
68
69		$orderColumnName = $model->determineOrderColumnName();
70		$primaryKeyColumn = $model->getKeyName();
		0 ignored issues – show Bug introduced 2016-10-18 22:46 UTC by Report Bug Copy Issue Report It seems like `getKeyName()` 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...
71
72		foreach ($ids as $id) {
73		static::withoutGlobalScope(SoftDeletingScope::class)
74		->where($primaryKeyColumn, $id)
75		->update([$orderColumnName => $startOrder++]);
76		}
77		}
78
79		/*
80		* Determine the column name of the order column.
81		*/
82		protected function determineOrderColumnName(): string
83		{
84		if (
85		isset($this->sortable['order_column_name']) &&
86		! empty($this->sortable['order_column_name'])
87		) {
88		return $this->sortable['order_column_name'];
89		}
90
91		return 'order_column';
92		}
93
94		/**
95		* Determine if the order column should be set when saving a new model instance.
96		*/
97		public function shouldSortWhenCreating(): bool
98		{
99		return $this->sortable['sort_when_creating'] ?? true;
100		}
101
102		/**
103		* Swaps the order of this model with the model 'below' this model.
104		*
105		* @return $this
106		*/
107	View Code Duplication	public function moveOrderDown()
		0 ignored issues – show Duplication introduced 2017-08-30 15:43 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
108		{
109		$orderColumnName = $this->determineOrderColumnName();
110
111		$swapWithModel = $this->buildSortQuery()->limit(1)
112		->ordered()
113		->where($orderColumnName, '>', $this->$orderColumnName)
114		->first();
115
116		if (! $swapWithModel) {
117		return $this;
118		}
119
120		return $this->swapOrderWithModel($swapWithModel);
121		}
122
123		/**
124		* Swaps the order of this model with the model 'above' this model.
125		*
126		* @return $this
127		*/
128	View Code Duplication	public function moveOrderUp()
		0 ignored issues – show Duplication introduced 2017-08-30 15:43 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
129		{
130		$orderColumnName = $this->determineOrderColumnName();
131
132		$swapWithModel = $this->buildSortQuery()->limit(1)
133		->ordered('desc')
134		->where($orderColumnName, '<', $this->$orderColumnName)
135		->first();
136
137		if (! $swapWithModel) {
138		return $this;
139		}
140
141		return $this->swapOrderWithModel($swapWithModel);
142		}
143
144		/**
145		* Swap the order of this model with the order of another model.
146		*
147		* @param \Spatie\EloquentSortable\Sortable $otherModel
148		*
149		* @return $this
150		*/
151		public function swapOrderWithModel(Sortable $otherModel)
152		{
153		$orderColumnName = $this->determineOrderColumnName();
154
155		$oldOrderOfOtherModel = $otherModel->$orderColumnName;
156
157		$otherModel->$orderColumnName = $this->$orderColumnName;
158		$otherModel->save();
159
160		$this->$orderColumnName = $oldOrderOfOtherModel;
161		$this->save();
		0 ignored issues – show Bug introduced 2017-01-28 19:34 UTC by Report Bug Copy Issue Report It seems like `save()` 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...
162
163		return $this;
164		}
165
166		/**
167		* Swap the order of two models.
168		*
169		* @param \Spatie\EloquentSortable\Sortable $model
170		* @param \Spatie\EloquentSortable\Sortable $otherModel
171		*/
172		public static function swapOrder(Sortable $model, Sortable $otherModel)
173		{
174		$model->swapOrderWithModel($otherModel);
175		}
176
177		/**
178		* Moves this model to the first position.
179		*
180		* @return $this
181		*/
182		public function moveToStart()
183		{
184		$firstModel = $this->buildSortQuery()->limit(1)
185		->ordered()
186		->first();
187
188		if ($firstModel->id === $this->id) {
		0 ignored issues – show Bug introduced 2016-10-18 21:42 UTC by Report Bug Copy Issue Report The property `id` 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...
189		return $this;
190		}
191
192		$orderColumnName = $this->determineOrderColumnName();
193
194		$this->$orderColumnName = $firstModel->$orderColumnName;
195		$this->save();
		0 ignored issues – show Bug introduced 2017-04-16 10:13 UTC by Report Bug Copy Issue Report It seems like `save()` 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...
196
197		$this->buildSortQuery()->where($this->getKeyName(), '!=', $this->id)->increment($orderColumnName);
		0 ignored issues – show Bug introduced 2016-10-19 14:01 UTC by Report Bug Copy Issue Report It seems like `getKeyName()` 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...
198
199		return $this;
200		}
201
202		/**
203		* Moves this model to the last position.
204		*
205		* @return $this
206		*/
207		public function moveToEnd()
208		{
209		$maxOrder = $this->getHighestOrderNumber();
210
211		$orderColumnName = $this->determineOrderColumnName();
212
213		if ($this->$orderColumnName === $maxOrder) {
214		return $this;
215		}
216
217		$oldOrder = $this->$orderColumnName;
218
219		$this->$orderColumnName = $maxOrder;
220		$this->save();
		0 ignored issues – show Bug introduced 2017-04-16 10:13 UTC by Report Bug Copy Issue Report It seems like `save()` 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...
221
222		$this->buildSortQuery()->where($this->getKeyName(), '!=', $this->id)
		0 ignored issues – show Bug introduced 2016-10-18 22:48 UTC by Report Bug Copy Issue Report It seems like `getKeyName()` 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...
223		->where($orderColumnName, '>', $oldOrder)
224		->decrement($orderColumnName);
225
226		return $this;
227		}
228
229		/**
230		* Build eloquent builder of sortable.
231		*
232		* @return \Illuminate\Database\Eloquent\Builder
233		*/
234		public function buildSortQuery()
235		{
236		/** @var \Illuminate\Database\Eloquent\Builder $query */
237		$query = static::query();
238
239		if (
240		isset($this->sortable['order_unique']) &&
241		! empty($this->sortable['order_unique'])
242		) {
243		if (is_array($this->sortable['order_unique'])) {
244		foreach ($this->sortable['order_unique'] as $key) {
245		if (empty($this->$key)) {
246		throw new \Exception('Unique sorting key must be set first ('.$key.')');
247		}
248		$query->where($key, '=', $this->$key);
249		}
250		} else {
251		$key = $this->sortable['order_unique'];
252		if (empty($this->$key)) {
253		throw new \Exception('Unique sorting key must be set first ('.$key.')');
254		}
255		$query->where($key, '=', $this->$key);
256		}
257		}
258
259		return $query;
260		}
261		}
262

spatie / eloquent-sortable

Pull Request — master (#48)

SortableTrait A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

14 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like