Add ignore timestamp (#169)

* add the necessary config

* ignore timestamps if config is set and stop ignoring after setting new order

* add dummy model with timestamps

* add set up with timestamp

* test default behavior to make sure we haven't broken anything

* test it can set order without touching timestamps

* update readme to reflect config changes

README.md

@@ -62,6 +62,12 @@ return [
    * will automatically assign the highest order number to a new model
    */
   'sort_when_creating' => true,
+
+  /*
+   * Define if the timestamps should be ignored when sorting.
+   * When true, updated_at will not be updated when using setNewOrder
+   */
+  'ignore_timestamps' => false,
 ];
 ```
 

config/eloquent-sortable.php

@@ -11,4 +11,10 @@
      * When true, the package will automatically assign the highest order number to a new model
      */
     'sort_when_creating' => true,
+
+    /*
+     * Define if the timestamps should be ignored when sorting.
+     * When true, updated_at will not be updated when using setNewOrder
+     */
+    'ignore_timestamps' => false,
 ];

src/SortableTrait.php

@@ -54,6 +54,10 @@ public static function setNewOrder($ids, int $startOrder = 1, string $primaryKey
             $primaryKeyColumn = $model->getKeyName();
         }
 
+        if (config('eloquent-sortable.ignore_timestamps', false)) {
+            static::$ignoreTimestampsOn = array_values(array_merge(static::$ignoreTimestampsOn, [static::class]));
+        }
+
         foreach ($ids as $id) {
             static::withoutGlobalScope(SoftDeletingScope::class)
                 ->when(is_callable($modifyQuery), function ($query) use ($modifyQuery) {
@@ -62,6 +66,10 @@ public static function setNewOrder($ids, int $startOrder = 1, string $primaryKey
                 ->where($primaryKeyColumn, $id)
                 ->update([$orderColumnName => $startOrder++]);
         }
+
+        if (config('eloquent-sortable.ignore_timestamps', false)) {
+            static::$ignoreTimestampsOn = array_values(array_diff(static::$ignoreTimestampsOn, [static::class]));
+        }
     }
 
     public static function setNewOrderByCustomColumn(string $primaryKeyColumn, $ids, int $startOrder = 1)

tests/DummyWithTimestamps.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Spatie\EloquentSortable\Test;
+
+use Illuminate\Database\Eloquent\Model;
+use Spatie\EloquentSortable\Sortable;
+use Spatie\EloquentSortable\SortableTrait;
+
+class DummyWithTimestamps extends Model implements Sortable
+{
+    use SortableTrait;
+
+    protected $table = 'dummies';
+    protected $guarded = [];
+}

tests/SortableTest.php

@@ -42,6 +42,42 @@ public function it_can_set_a_new_order()
         }
     }
 
+    /** @test */
+    public function it_can_touch_timestamps_when_setting_a_new_order()
+    {
+        $this->setUpTimestamps();
+        DummyWithTimestamps::query()->update(['updated_at' => now()]);        
+        $originalTimestamps = DummyWithTimestamps::all()->pluck('updated_at');
+
+        $this->travelTo(now()->addMinute());
+
+        config()->set('eloquent-sortable.ignore_timestamps', false);
+        $newOrder = Collection::make(DummyWithTimestamps::all()->pluck('id'))->shuffle()->toArray();
+        DummyWithTimestamps::setNewOrder($newOrder);
+
+        foreach (DummyWithTimestamps::orderBy('order_column')->get() as $i => $dummy) {
+            $this->assertNotEquals($originalTimestamps[$i], $dummy->updated_at);
+        }
+    }
+
+    /** @test */
+    public function it_can_set_a_new_order_without_touching_timestamps()
+    {
+        $this->setUpTimestamps();
+        DummyWithTimestamps::query()->update(['updated_at' => now()]);        
+        $originalTimestamps = DummyWithTimestamps::all()->pluck('updated_at');
+
+        $this->travelTo(now()->addMinute());
+
+        config()->set('eloquent-sortable.ignore_timestamps', true);
+        $newOrder = Collection::make(DummyWithTimestamps::all()->pluck('id'))->shuffle()->toArray();
+        DummyWithTimestamps::setNewOrder($newOrder);
+
+        foreach (DummyWithTimestamps::orderBy('order_column')->get() as $i => $dummy) {
+            $this->assertEquals($originalTimestamps[$i], $dummy->updated_at);
+        }
+    }
+
     /** @test */
     public function it_can_set_a_new_order_by_custom_column()
     {

tests/TestCase.php

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