SortableTrait - Code Metrics - Inspection of "Added ability to sort models grouped by a column" - spatie/eloquent-sortable - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#56)

unknown

created 2018-03-02 09:55 UTC

SortableTrait A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	265
Duplicated Lines	11.32 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	7
Bugs	1	Features	1

Metric	Value
wmc	32
c	7
b	1
f	1
lcom	1
cbo	2
dl	30
loc	265
rs	9.6

17 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	determineGroupColumnName()	0	11	3
A	getGroupColumnValue()	0	5	1
A	shouldSortByGroup()	0	4	1
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
A	buildSortQuery()	0	8	3

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 the column name of the group column.
     */
    protected function determineGroupColumnName(): string
    {
        if (
            isset($this->sortable['group_column_name']) &&
            ! empty($this->sortable['group_column_name'])
        ) {
            return $this->sortable['group_column_name'];
        }

        return 'group_column';
    }

    /**
     * Determine the order value for the new record.
     */
    public function getGroupColumnValue()
    {
        $groupColumnName = $this->determineGroupColumnName();
        return $this->$groupColumnName;
    }

    /**
     * Determine if it should be sorted by group column.
     */
    public function shouldSortByGroup(): bool
    {
        return $this->sortable['sort_by_group'] ?? false;
    }

    /**
     * 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()
    {
        if ($this->shouldSortByGroup() && $groupColumnName = $this->determineGroupColumnName()) {
            return static::query()->where($groupColumnName, $this->getGroupColumnValue());
        } else {
            return static::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 the column name of the group column.
96		*/
97		protected function determineGroupColumnName(): string
98		{
99		if (
100		isset($this->sortable['group_column_name']) &&
101		! empty($this->sortable['group_column_name'])
102		) {
103		return $this->sortable['group_column_name'];
104		}
105
106		return 'group_column';
107		}
108
109		/**
110		* Determine the order value for the new record.
111		*/
112		public function getGroupColumnValue()
113		{
114		$groupColumnName = $this->determineGroupColumnName();
115		return $this->$groupColumnName;
116		}
117
118		/**
119		* Determine if it should be sorted by group column.
120		*/
121		public function shouldSortByGroup(): bool
122		{
123		return $this->sortable['sort_by_group'] ?? false;
124		}
125
126		/**
127		* Determine if the order column should be set when saving a new model instance.
128		*/
129		public function shouldSortWhenCreating(): bool
130		{
131		return $this->sortable['sort_when_creating'] ?? true;
132		}
133
134		/**
135		* Swaps the order of this model with the model 'below' this model.
136		*
137		* @return $this
138		*/
139	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...
140		{
141		$orderColumnName = $this->determineOrderColumnName();
142
143		$swapWithModel = $this->buildSortQuery()->limit(1)
144		->ordered()
145		->where($orderColumnName, '>', $this->$orderColumnName)
146		->first();
147
148		if (! $swapWithModel) {
149		return $this;
150		}
151
152		return $this->swapOrderWithModel($swapWithModel);
153		}
154
155		/**
156		* Swaps the order of this model with the model 'above' this model.
157		*
158		* @return $this
159		*/
160	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...
161		{
162		$orderColumnName = $this->determineOrderColumnName();
163
164		$swapWithModel = $this->buildSortQuery()->limit(1)
165		->ordered('desc')
166		->where($orderColumnName, '<', $this->$orderColumnName)
167		->first();
168
169		if (! $swapWithModel) {
170		return $this;
171		}
172
173		return $this->swapOrderWithModel($swapWithModel);
174		}
175
176		/**
177		* Swap the order of this model with the order of another model.
178		*
179		* @param \Spatie\EloquentSortable\Sortable $otherModel
180		*
181		* @return $this
182		*/
183		public function swapOrderWithModel(Sortable $otherModel)
184		{
185		$orderColumnName = $this->determineOrderColumnName();
186
187		$oldOrderOfOtherModel = $otherModel->$orderColumnName;
188
189		$otherModel->$orderColumnName = $this->$orderColumnName;
190		$otherModel->save();
191
192		$this->$orderColumnName = $oldOrderOfOtherModel;
193		$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...
194
195		return $this;
196		}
197
198		/**
199		* Swap the order of two models.
200		*
201		* @param \Spatie\EloquentSortable\Sortable $model
202		* @param \Spatie\EloquentSortable\Sortable $otherModel
203		*/
204		public static function swapOrder(Sortable $model, Sortable $otherModel)
205		{
206		$model->swapOrderWithModel($otherModel);
207		}
208
209		/**
210		* Moves this model to the first position.
211		*
212		* @return $this
213		*/
214		public function moveToStart()
215		{
216		$firstModel = $this->buildSortQuery()->limit(1)
217		->ordered()
218		->first();
219
220		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...
221		return $this;
222		}
223
224		$orderColumnName = $this->determineOrderColumnName();
225
226		$this->$orderColumnName = $firstModel->$orderColumnName;
227		$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...
228
229		$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...
230
231		return $this;
232		}
233
234		/**
235		* Moves this model to the last position.
236		*
237		* @return $this
238		*/
239		public function moveToEnd()
240		{
241		$maxOrder = $this->getHighestOrderNumber();
242
243		$orderColumnName = $this->determineOrderColumnName();
244
245		if ($this->$orderColumnName === $maxOrder) {
246		return $this;
247		}
248
249		$oldOrder = $this->$orderColumnName;
250
251		$this->$orderColumnName = $maxOrder;
252		$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...
253
254		$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...
255		->where($orderColumnName, '>', $oldOrder)
256		->decrement($orderColumnName);
257
258		return $this;
259		}
260
261		/**
262		* Build eloquent builder of sortable.
263		*
264		* @return \Illuminate\Database\Eloquent\Builder
265		*/
266		public function buildSortQuery()
267		{
268		if ($this->shouldSortByGroup() && $groupColumnName = $this->determineGroupColumnName()) {
269		return static::query()->where($groupColumnName, $this->getGroupColumnValue());
270		} else {
271		return static::query();
272		}
273		}
274		}
275

spatie / eloquent-sortable

Pull Request — master (#56)

SortableTrait A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

17 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like