Merge pull request #29 from srdante/sort-key-per-column-direction

Implement Sort Key per-column direction feature

Author: Carl Sverre

README.md

@@ -248,6 +248,17 @@ Schema::create('table', function (Blueprint $table) {
 });
 ```
 
+You may also define the sort key direction per-column using the following syntax:
+
+```php
+Schema::create('table', function (Blueprint $table) {
+    $table->string('f_name');
+    $table->string('l_name');
+
+    $table->sortKey([['f_name', 'asc'], ['l_name', 'desc']]);
+});
+```
+
 ### Unique Keys
 
 You can add an `unique key` to your tables using the standalone `unique` method, or fluently by appending `unique` to the column definition.

src/Schema/Blueprint/ModifiesIndexes.php

@@ -15,7 +15,7 @@ trait ModifiesIndexes
      */
     public function shardKey($columns)
     {
-        return $this->indexCommand('shardKey', $columns, null);
+        return $this->indexCommand('shardKey', $columns, 'shardKeyDummyName');
     }
 
     /**
@@ -25,7 +25,7 @@ public function shardKey($columns)
      */
     public function sortKey($columns, $direction = 'asc')
     {
-        $command = $this->indexCommand('sortKey', $columns, null);
+        $command = $this->indexCommand('sortKey', $columns, 'sortKeyDummyName');
         $command->direction = $direction;
 
         return $command;

src/Schema/Grammar.php

@@ -11,6 +11,7 @@
 use Illuminate\Database\Schema\Grammars\MySqlGrammar;
 use Illuminate\Support\Fluent;
 use Illuminate\Support\Str;
+use InvalidArgumentException;
 use SingleStore\Laravel\Schema\Blueprint as SingleStoreBlueprint;
 use SingleStore\Laravel\Schema\Grammar\CompilesKeys;
 use SingleStore\Laravel\Schema\Grammar\ModifiesColumns;
@@ -185,6 +186,24 @@ protected function compileKey(Blueprint $blueprint, Fluent $command, $type)
      */
     protected function columnizeWithDirection(array $columns, string $direction)
     {
+        if ($columns === array_filter($columns, 'is_array')) {
+            $columnNames = array_map(function ($column) {
+                return $this->wrap($column[0]);
+            }, $columns);
+
+            $columnDirections = array_map(function ($column) {
+                return $column[1];
+            }, $columns);
+
+            return implode(', ', array_map(function ($column, $direction) {
+                return "$column $direction";
+            }, $columnNames, $columnDirections));
+        }
+
+        if (array_filter($columns, 'is_array') !== []) {
+            throw new InvalidArgumentException('You must set the direction for each sort key column or use the second parameter to set the direction for all sort key columns');
+        }
+
         $wrapped = array_map([$this, 'wrap'], $columns);
 
         return implode(', ', array_map(function ($column) use ($direction) {

tests/Hybrid/CreateTable/SortKeysTest.php

@@ -5,6 +5,7 @@
 
 namespace SingleStore\Laravel\Tests\Hybrid\CreateTable;
 
+use InvalidArgumentException;
 use SingleStore\Laravel\Schema\Blueprint;
 use SingleStore\Laravel\Tests\BaseTest;
 use SingleStore\Laravel\Tests\Hybrid\HybridTestHelpers;
@@ -82,6 +83,64 @@ public function it_adds_a_dual_sort_key()
         );
     }
 
+    /** @test */
+    public function it_adds_a_dual_sort_key_with_desc_direction()
+    {
+        $blueprint = $this->createTable(function (Blueprint $table) {
+            $table->string('f_name');
+            $table->string('l_name');
+            $table->sortKey(['f_name', 'l_name'], 'desc');
+        });
+
+        $this->assertCreateStatement(
+            $blueprint,
+            'create table `test` (`f_name` varchar(255) not null, `l_name` varchar(255) not null, sort key(`f_name` desc, `l_name` desc))'
+        );
+    }
+
+    /** @test */
+    public function it_adds_a_dual_sort_key_with_different_directions()
+    {
+        $blueprint = $this->createTable(function (Blueprint $table) {
+            $table->string('f_name');
+            $table->string('l_name');
+            $table->sortKey([['f_name', 'asc'], ['l_name', 'desc']]);
+        });
+
+        $this->assertCreateStatement(
+            $blueprint,
+            'create table `test` (`f_name` varchar(255) not null, `l_name` varchar(255) not null, sort key(`f_name` asc, `l_name` desc))'
+        );
+    }
+
+    /** @test */
+    public function it_cannot_add_a_dual_sort_key_with_only_one_direction()
+    {
+        $this->expectException(InvalidArgumentException::class);
+
+        $blueprint = $this->createTable(function (Blueprint $table) {
+            $table->string('f_name');
+            $table->string('l_name');
+            $table->sortKey(['f_name', ['l_name', 'desc']]);
+        });
+
+        $blueprint->toSql($this->getConnection(), $this->getGrammar());
+    }
+
+    /** @test */
+    public function it_cannot_add_a_dual_sort_key_with_only_one_direction_desc()
+    {
+        $this->expectException(InvalidArgumentException::class);
+
+        $blueprint = $this->createTable(function (Blueprint $table) {
+            $table->string('f_name');
+            $table->string('l_name');
+            $table->sortKey(['f_name', ['l_name', 'asc']], 'desc');
+        });
+
+        $blueprint->toSql($this->getConnection(), $this->getGrammar());
+    }
+
     /** @test */
     public function shard_and_sort_keys()
     {