Merge pull request #24 from srdante/sort-key-desc

Implement sortKey direction argument

Author: Carl Sverre

README.md

@@ -217,6 +217,20 @@ Schema::create('table', function (Blueprint $table) {
 
 ```
 
+Sort keys by default works only for `asc` sort queries. If you would like to create a sort key with `desc` order, you can set the key direction.
+
+```php
+Schema::create('table', function (Blueprint $table) {
+    $table->string('name');
+
+    $table->sortKey('name', 'desc');
+});
+
+Schema::create('table', function (Blueprint $table) {
+    $table->string('name')->sortKey('desc');
+});
+```
+
 ### Series Timestamps
 To denote a column as a series timestamp, use the `seriesTimestamp` column modifier.
 

src/Schema/Blueprint/InlinesIndexes.php

@@ -81,7 +81,8 @@ protected function inlineCreateIndexStatements($statements)
     protected function indexCommands()
     {
         return $this->commandsNamed(array_merge(
-            $this->singleStoreIndexes, $this->mysqlIndexes
+            $this->singleStoreIndexes,
+            $this->mysqlIndexes
         ));
     }
 
@@ -116,7 +117,12 @@ protected function addFluentSingleStoreIndexes()
         foreach ($this->columns as $column) {
             foreach ($this->singleStoreIndexes as $index) {
                 if (isset($column->{$index})) {
-                    $this->{$index}($column->name, ($column->{$index} === true ? null : $column->{$index}));
+                    if ($column->{$index} === true) {
+                        $this->{$index}($column->name);
+                    } else {
+                        $this->{$index}($column->name, $column->{$index});
+                    }
+
                     $column->{$index} = false;
                 }
             }

src/Schema/Blueprint/ModifiesIndexes.php

@@ -11,22 +11,24 @@ trait ModifiesIndexes
 {
     /**
      * @param $columns
-     * @param $name
      * @return \Illuminate\Support\Fluent
      */
-    public function shardKey($columns, $name = null)
+    public function shardKey($columns)
     {
-        return $this->indexCommand('shardKey', $columns, $name);
+        return $this->indexCommand('shardKey', $columns, null);
     }
 
     /**
      * @param $columns
-     * @param $name
+     * @param $direction
      * @return \Illuminate\Support\Fluent
      */
-    public function sortKey($columns, $name = null)
+    public function sortKey($columns, $direction = 'asc')
     {
-        return $this->indexCommand('sortKey', $columns, $name);
+        $command = $this->indexCommand('sortKey', $columns, null);
+        $command->direction = $direction;
+
+        return $command;
     }
 
     /**

src/Schema/Grammar/CompilesKeys.php

@@ -17,7 +17,7 @@ public function compileShardKey(Blueprint $blueprint, Fluent $command)
 
     public function compileSortKey(Blueprint $blueprint, Fluent $command)
     {
-        return "sort key({$this->columnize($command->columns)})";
+        return "sort key({$this->columnize($command->columns)} {$command->direction})";
     }
 
     public function compileSpatialIndex(Blueprint $blueprint, Fluent $command)

tests/Hybrid/CreateTable/SortKeysTest.php

@@ -23,7 +23,21 @@ public function it_adds_a_sort_key_standalone()
 
         $this->assertCreateStatement(
             $blueprint,
-            'create table `test` (`name` varchar(255) not null, sort key(`name`))'
+            'create table `test` (`name` varchar(255) not null, sort key(`name` asc))'
+        );
+    }
+
+    /** @test */
+    public function it_adds_a_sort_key_with_desc_direction_standalone()
+    {
+        $blueprint = $this->createTable(function (Blueprint $table) {
+            $table->string('name');
+            $table->sortKey('name', 'desc');
+        });
+
+        $this->assertCreateStatement(
+            $blueprint,
+            'create table `test` (`name` varchar(255) not null, sort key(`name` desc))'
         );
     }
 
@@ -36,7 +50,20 @@ public function it_adds_a_sort_key_fluent()
 
         $this->assertCreateStatement(
             $blueprint,
-            'create table `test` (`name` varchar(255) not null, sort key(`name`))'
+            'create table `test` (`name` varchar(255) not null, sort key(`name` asc))'
+        );
+    }
+
+    /** @test */
+    public function it_adds_a_sort_key_with_desc_direction_fluent()
+    {
+        $blueprint = $this->createTable(function (Blueprint $table) {
+            $table->string('name')->sortKey('desc');
+        });
+
+        $this->assertCreateStatement(
+            $blueprint,
+            'create table `test` (`name` varchar(255) not null, sort key(`name` desc))'
         );
     }
 
@@ -51,7 +78,7 @@ public function it_adds_a_dual_sort_key()
 
         $this->assertCreateStatement(
             $blueprint,
-            'create table `test` (`f_name` varchar(255) not null, `l_name` varchar(255) not null, sort key(`f_name`, `l_name`))'
+            'create table `test` (`f_name` varchar(255) not null, `l_name` varchar(255) not null, sort key(`f_name`, `l_name` asc))'
         );
     }
 
@@ -64,7 +91,7 @@ public function shard_and_sort_keys()
 
         $this->assertCreateStatement(
             $blueprint,
-            'create table `test` (`name` varchar(255) not null, shard key(`name`), sort key(`name`))'
+            'create table `test` (`name` varchar(255) not null, shard key(`name`), sort key(`name` asc))'
         );
     }
 }