[FEAT] add withoutGlobalScopes to setNewOrder method (#167)

* [FEAT] add withoutGlobalScopes to setNewOrder method

* [FEAT] add withoutGlobalScopes to setNewOrder method

* [FEAT]  test it can set new order without global scope

* Update README.md

* Update README.md

* [MOD] add modifyQuery with a callback instead of withoutGlobalScope for setting a new order

* Update README.md

* Update README.md

* [FIX] fix missing modification of sqlite to mysql driver

---------

Co-authored-by: Freek Van der Herten <[email protected]>

README.md

@@ -134,6 +134,20 @@ Optionally you can pass the starting order number as the second argument.
 MyModel::setNewOrder([3,1,2], 10);
 ```
 
+You can modify the query that will be executed by passing a closure as the fourth argument.
+
+```php
+/**
+ * the record for model id 3 will have order_column value 11
+ * the record for model id 1 will have order_column value 12
+ * the record for model id 2 will have order_column value 13
+ */
+MyModel::setNewOrder([3,1,2], 10, null, function($query) {
+    $query->withoutGlobalScope(new ActiveScope);
+});
+```
+
+
 To sort using a column other than the primary key, use the `setNewOrderByCustomColumn`-method.
 
 ```php

src/SortableTrait.php

@@ -40,7 +40,7 @@ public function scopeOrdered(Builder $query, string $direction = 'asc')
         return $query->orderBy($this->determineOrderColumnName(), $direction);
     }
 
-    public static function setNewOrder($ids, int $startOrder = 1, string $primaryKeyColumn = null): void
+    public static function setNewOrder($ids, int $startOrder = 1, string $primaryKeyColumn = null, callable $modifyQuery = null): void
     {
         if (! is_array($ids) && ! $ids instanceof ArrayAccess) {
             throw new InvalidArgumentException('You must pass an array or ArrayAccess object to setNewOrder');
@@ -56,6 +56,9 @@ public static function setNewOrder($ids, int $startOrder = 1, string $primaryKey
 
         foreach ($ids as $id) {
             static::withoutGlobalScope(SoftDeletingScope::class)
+                ->when(is_callable($modifyQuery), function($query) use ($modifyQuery) {
+                    return $modifyQuery($query);
+                })
                 ->where($primaryKeyColumn, $id)
                 ->update([$orderColumnName => $startOrder++]);
         }

tests/DummyWithGlobalScope.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Spatie\EloquentSortable\Test;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+use Spatie\EloquentSortable\Sortable;
+use Spatie\EloquentSortable\SortableTrait;
+
+class DummyWithGlobalScope extends Model implements Sortable
+{
+    use SortableTrait;
+
+    protected $table = 'dummies';
+    protected $guarded = [];
+    public $timestamps = false;
+
+    /**
+     * The "booting" method of the model.
+     *
+     * @return void
+     */
+    protected static function boot()
+    {
+        parent::boot();
+
+        parent::addGlobalScope('ActiveScope', function(Builder $builder) {
+            $builder->where('is_active', true);
+        });
+    }
+}

tests/SortableTest.php

@@ -78,6 +78,22 @@ public function it_can_set_a_new_order_by_custom_column_from_collection()
         }
     }
 
+    /** @test */
+    public function it_can_set_new_order_without_global_scopes_models()
+    {
+        $this->setUpIsActiveFieldForGlobalScope();
+
+        $newOrder = Collection::make(Dummy::all()->pluck('id'))->shuffle()->toArray();
+
+        DummyWithGlobalScope::setNewOrder($newOrder, 1, null, function($query) {
+            $query->withoutGlobalScope('ActiveScope');
+        });
+
+        foreach (Dummy::orderBy('order_column')->get() as $i => $dummy) {
+            $this->assertEquals($newOrder[$i], $dummy->id);
+        }
+    }
+
     /** @test */
     public function it_can_set_a_new_order_with_trashed_models()
     {

tests/TestCase.php

@@ -62,4 +62,11 @@ protected function setUpSoftDeletes()
             $table->softDeletes();
         });
     }
+
+    protected function setUpIsActiveFieldForGlobalScope()
+    {
+        $this->app['db']->connection()->getSchemaBuilder()->table('dummies', function (Blueprint $table) {
+            $table->boolean('is_active')->default(false);
+        });
+    }
 }