Add collation to getCollections and getViews

Although it's not displayed anywhere other than `db:table` for now, the `collation`
column is present in some of laravel's artisan dabase commands.

Author: paulinevos

src/Schema/Builder.php

@@ -15,6 +15,7 @@
 use function array_column;
 use function array_fill_keys;
 use function array_filter;
+use function array_key_exists;
 use function array_keys;
 use function array_map;
 use function array_merge;
@@ -26,6 +27,7 @@
 use function implode;
 use function in_array;
 use function is_array;
+use function is_bool;
 use function is_string;
 use function iterator_to_array;
 use function sort;
@@ -380,6 +382,9 @@ private function getCollectionRows(string $collectionType, $schema = null)
                 continue;
             }
 
+            $options = $collectionInfo->getOptions();
+            $collation = $options['collation'] ?? [];
+
             // Aggregation is not supported on views
             $stats = $collectionType !== 'view' ? $db->selectCollection($collectionName)->aggregate([
                 ['$collStats' => ['storageStats' => ['scale' => 1]]],
@@ -392,7 +397,7 @@ private function getCollectionRows(string $collectionType, $schema = null)
                 'schema_qualified_name' => $db->getDatabaseName() . '.' . $collectionName,
                 'size' => $stats[0]?->storageStats?->totalSize ?? null,
                 'comment' => null,
-                'collation' => null,
+                'collation' => $this->collationToString($collation),
                 'engine' => null,
             ];
         }
@@ -401,4 +406,30 @@ private function getCollectionRows(string $collectionType, $schema = null)
 
         return $collections;
     }
+
+    private function collationToString(array $collation): string
+    {
+        $map = [
+            'locale' => 'l',
+            'strength' => 's',
+            'caseLevel' => 'cl',
+            'caseFirst' => 'cf',
+            'numericOrdering' => 'no',
+            'alternate' => 'a',
+            'maxVariable' => 'mv',
+            'normalization' => 'n',
+            'backwards' => 'b',
+        ];
+
+        $parts = [];
+        foreach ($collation as $key => $value) {
+            if (array_key_exists($key, $map)) {
+                $shortKey = $map[$key];
+                $shortValue = is_bool($value) ? ($value ? '1' : '0') : $value;
+                $parts[] = $shortKey . '=' . $shortValue;
+            }
+        }
+
+        return implode(';', $parts);
+    }
 }

tests/SchemaTest.php

@@ -20,12 +20,15 @@
 
 class SchemaTest extends TestCase
 {
+    private const COLL_WITH_COLLATION = 'collection_with_collation';
+
     public function tearDown(): void
     {
         $database = $this->getConnection('mongodb')->getDatabase();
         assert($database instanceof Database);
         $database->dropCollection('newcollection');
         $database->dropCollection('newcollection_two');
+        $database->dropCollection(self::COLL_WITH_COLLATION);
         $database->dropCollection('test_view');
 
         parent::tearDown();
@@ -394,9 +397,17 @@ public function testHasColumns(): void
 
     public function testGetTables()
     {
+        $db = DB::connection('mongodb')->getDatabase();
+        $db->createCollection(self::COLL_WITH_COLLATION, [
+            'collation' => [
+                'locale' => 'fr',
+                'strength' => 2,
+            ],
+        ]);
+
         DB::connection('mongodb')->table('newcollection')->insert(['test' => 'value']);
         DB::connection('mongodb')->table('newcollection_two')->insert(['test' => 'value']);
-        DB::connection('mongodb')->getDatabase()->createCollection('test_view', ['viewOn' => 'newcollection']);
+        $db->createCollection('test_view', ['viewOn' => 'newcollection']);
         $dbName = DB::connection('mongodb')->getDatabaseName();
 
         $tables = Schema::getTables();
@@ -407,6 +418,7 @@ public function testGetTables()
             $this->assertArrayHasKey('name', $table);
             $this->assertArrayHasKey('size', $table);
             $this->assertArrayHasKey('schema', $table);
+            $this->assertArrayHasKey('collation', $table);
             $this->assertArrayHasKey('schema_qualified_name', $table);
             $this->assertNotEquals('test_view', $table['name'], 'Standard views should not be included in the result of getTables.');
 
@@ -416,6 +428,10 @@ public function testGetTables()
                 $this->assertEquals($dbName . '.newcollection', $table['schema_qualified_name']);
                 $found = true;
             }
+
+            if ($table['name'] === self::COLL_WITH_COLLATION) {
+                $this->assertEquals('l=fr;cl=0;cf=off;s=2;no=0;a=non-ignorable;mv=punct;n=0;b=0', $table['collation']);
+            }
         }
 
         if (! $found) {