Add Doctrine types (#65)

* Move DB config to phpunit.xml

* Add test

* Implementation

* Ignore PhpStan error

* add geometrycollection type

* dont register if doctrine isn't available

* Formatting

Co-authored-by: Matan Yadaev <[email protected]>

Author: MatanYadaev

composer.json

@@ -17,6 +17,7 @@
     "phayes/geophp": "^1.2"
   },
   "require-dev": {
+    "doctrine/dbal": "^3.4",
     "friendsofphp/php-cs-fixer": "^3.0",
     "jubeki/laravel-code-style": "^1.0",
     "nunomaduro/larastan": "^1.0|^2.0",
@@ -48,5 +49,12 @@
     }
   },
   "minimum-stability": "dev",
-  "prefer-stable": true
+  "prefer-stable": true,
+  "extra": {
+    "laravel": {
+      "providers": [
+        "MatanYadaev\\EloquentSpatial\\EloquentSpatialServiceProvider"
+      ]
+    }
+  }
 }

phpstan.neon

@@ -12,6 +12,9 @@ parameters:
     		-
     			message: '#^Access to an undefined property Pest\\Expectation\|Pest\\Support\\Extendable\:\:\$.+\.$#'
     			path: tests/*.php
+    		-
+    			message: '#^Call to an undefined method Pest\\Expectation\:\:.+\(\)\.$#'
+    			path: tests/*.php
     excludePaths:
         - ./src/Factory.php
     checkMissingIterableValueType: true

phpunit.xml

@@ -28,4 +28,8 @@
   <logging>
     <junit outputFile="build/report.junit.xml"/>
   </logging>
+  <php>
+    <env name="DB_DATABASE" value="laravel_eloquent_spatial_test"/>
+    <env name="DB_USERNAME" value="root"/>
+  </php>
 </phpunit>

src/Doctrine/GeometryCollectionType.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MatanYadaev\EloquentSpatial\Doctrine;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\Type;
+
+class GeometryCollectionType extends Type
+{
+  public function getSQLDeclaration(array $column, AbstractPlatform $platform): string
+  {
+    // @codeCoverageIgnoreStart
+    return 'geometrycollection';
+    // @codeCoverageIgnoreEnd
+  }
+
+  public function getName(): string
+  {
+    return 'geometrycollection';
+  }
+}

src/Doctrine/LineStringType.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MatanYadaev\EloquentSpatial\Doctrine;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\Type;
+
+class LineStringType extends Type
+{
+  public function getSQLDeclaration(array $column, AbstractPlatform $platform): string
+  {
+    // @codeCoverageIgnoreStart
+    return 'linestring';
+    // @codeCoverageIgnoreEnd
+  }
+
+  public function getName(): string
+  {
+    return 'linestring';
+  }
+}

src/Doctrine/MultiLineStringType.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MatanYadaev\EloquentSpatial\Doctrine;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\Type;
+
+class MultiLineStringType extends Type
+{
+  public function getSQLDeclaration(array $column, AbstractPlatform $platform): string
+  {
+    // @codeCoverageIgnoreStart
+    return 'multilinestring';
+    // @codeCoverageIgnoreEnd
+  }
+
+  public function getName(): string
+  {
+    return 'multilinestring';
+  }
+}

src/Doctrine/MultiPointType.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MatanYadaev\EloquentSpatial\Doctrine;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\Type;
+
+class MultiPointType extends Type
+{
+  public function getSQLDeclaration(array $column, AbstractPlatform $platform): string
+  {
+    // @codeCoverageIgnoreStart
+    return 'multipoint';
+    // @codeCoverageIgnoreEnd
+  }
+
+  public function getName(): string
+  {
+    return 'multipoint';
+  }
+}

src/Doctrine/MultiPolygonType.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MatanYadaev\EloquentSpatial\Doctrine;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\Type;
+
+class MultiPolygonType extends Type
+{
+  public function getSQLDeclaration(array $column, AbstractPlatform $platform): string
+  {
+    // @codeCoverageIgnoreStart
+    return 'multipolygon';
+    // @codeCoverageIgnoreEnd
+  }
+
+  public function getName(): string
+  {
+    return 'multipolygon';
+  }
+}

src/Doctrine/PointType.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MatanYadaev\EloquentSpatial\Doctrine;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\Type;
+
+class PointType extends Type
+{
+  public function getSQLDeclaration(array $column, AbstractPlatform $platform): string
+  {
+    // @codeCoverageIgnoreStart
+    return 'point';
+    // @codeCoverageIgnoreEnd
+  }
+
+  public function getName(): string
+  {
+    return 'point';
+  }
+}

src/Doctrine/PolygonType.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MatanYadaev\EloquentSpatial\Doctrine;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\Type;
+
+class PolygonType extends Type
+{
+  public function getSQLDeclaration(array $column, AbstractPlatform $platform): string
+  {
+    // @codeCoverageIgnoreStart
+    return 'polygon';
+    // @codeCoverageIgnoreEnd
+  }
+
+  public function getName(): string
+  {
+    return 'polygon';
+  }
+}

src/EloquentSpatialServiceProvider.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MatanYadaev\EloquentSpatial;
+
+use Illuminate\Database\Connection;
+use Illuminate\Database\DatabaseServiceProvider;
+use Illuminate\Support\Facades\DB;
+use MatanYadaev\EloquentSpatial\Doctrine\GeometryCollectionType;
+use MatanYadaev\EloquentSpatial\Doctrine\LineStringType;
+use MatanYadaev\EloquentSpatial\Doctrine\MultiLineStringType;
+use MatanYadaev\EloquentSpatial\Doctrine\MultiPointType;
+use MatanYadaev\EloquentSpatial\Doctrine\MultiPolygonType;
+use MatanYadaev\EloquentSpatial\Doctrine\PointType;
+use MatanYadaev\EloquentSpatial\Doctrine\PolygonType;
+
+class EloquentSpatialServiceProvider extends DatabaseServiceProvider
+{
+  public function boot(): void
+  {
+    /** @var Connection $connection */
+    $connection = DB::connection();
+
+    if ($connection->isDoctrineAvailable()) {
+      $this->registerDoctrineTypes($connection);
+    }
+  }
+
+  protected function registerDoctrineTypes(Connection $connection): void
+  {
+    $geometries = [
+      'point' => PointType::class,
+      'linestring' => LineStringType::class,
+      'multipoint' => MultiPointType::class,
+      'polygon' => PolygonType::class,
+      'multilinestring' => MultiLineStringType::class,
+      'multipolygon' => MultiPolygonType::class,
+      'geometrycollection' => GeometryCollectionType::class,
+      'geomcollection' => GeometryCollectionType::class,
+    ];
+
+    foreach ($geometries as $type => $class) {
+      DB::registerDoctrineType($class, $type, $type);
+      $connection->registerDoctrineType($class, $type, $type);
+    }
+  }
+}

tests/DoctrineTypesTest.php

@@ -0,0 +1,44 @@
+<?php
+
+use Illuminate\Support\Facades\DB;
+use MatanYadaev\EloquentSpatial\Doctrine\GeometryCollectionType;
+use MatanYadaev\EloquentSpatial\Doctrine\LineStringType;
+use MatanYadaev\EloquentSpatial\Doctrine\MultiLineStringType;
+use MatanYadaev\EloquentSpatial\Doctrine\MultiPointType;
+use MatanYadaev\EloquentSpatial\Doctrine\MultiPolygonType;
+use MatanYadaev\EloquentSpatial\Doctrine\PointType;
+use MatanYadaev\EloquentSpatial\Doctrine\PolygonType;
+
+it('uses custom Doctrine types for spatial columns', function (): void {
+  $doctrineSchemaManager = DB::connection()->getDoctrineSchemaManager();
+
+  $columns = $doctrineSchemaManager->listTableColumns('test_places');
+
+  expect($columns['point']->getType())
+    ->toBeInstanceOf(PointType::class)
+    ->getName()->toBe('point');
+
+  expect($columns['line_string']->getType())
+    ->toBeInstanceOf(LineStringType::class)
+    ->getName()->toBe('linestring');
+
+  expect($columns['multi_point']->getType())
+    ->toBeInstanceOf(MultiPointType::class)
+    ->getName()->toBe('multipoint');
+
+  expect($columns['polygon']->getType())
+    ->toBeInstanceOf(PolygonType::class)
+    ->getName()->toBe('polygon');
+
+  expect($columns['multi_line_string']->getType())
+    ->toBeInstanceOf(MultiLineStringType::class)
+    ->getName()->toBe('multilinestring');
+
+  expect($columns['multi_polygon']->getType())
+    ->toBeInstanceOf(MultiPolygonType::class)
+    ->getName()->toBe('multipolygon');
+
+  expect($columns['geometry_collection']->getType())
+    ->toBeInstanceOf(GeometryCollectionType::class)
+    ->getName()->toBe('geometrycollection');
+});

tests/TestCase.php

@@ -2,7 +2,8 @@
 
 namespace MatanYadaev\EloquentSpatial\Tests;
 
-use Illuminate\Support\Facades\Config;
+use Illuminate\Support\ServiceProvider;
+use MatanYadaev\EloquentSpatial\EloquentSpatialServiceProvider;
 use Orchestra\Testbench\TestCase as Orchestra;
 
 class TestCase extends Orchestra
@@ -14,15 +15,14 @@ protected function setUp(): void
     $this->loadMigrationsFrom(__DIR__.'/database/migrations');
   }
 
-  public function getEnvironmentSetUp($app): void
+  /**
+   * @param $app
+   * @return class-string<ServiceProvider>[]
+   */
+  protected function getPackageProviders($app): array
   {
-    Config::set('database.default', 'mysql');
-    Config::set('database.connections.mysql', [
-      'driver' => 'mysql',
-      'host' => '127.0.0.1',
-      'port' => env('DB_PORT', 3306),
-      'database' => 'laravel_eloquent_spatial_test',
-      'username' => 'root',
-    ]);
+    return [
+      EloquentSpatialServiceProvider::class,
+    ];
   }
 }