Support MariaDB (#52)

MatanYadaev · Matan Yadaev · web-flow · commit 88ffd7917bdf · 2022-09-07T00:02:39.000+03:00
* add mariadb to ci

* fix ci

* remove matrix fail-fast

* fix ci

* fix mariadb issue

* fix tests

* fix docs

* set fail-fast: false

* fix test

* fix phpstan

* fix code coverage

Co-authored-by: Matan Yadaev &lt;matan@zerolimits.io&gt;
diff --git a/.github/workflows/pest-coverage.yml b/.github/workflows/pest-coverage.yml
@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
 
     services:
-      mysql:
+      db:
         image: mysql:8.0
         env:
           MYSQL_ALLOW_EMPTY_PASSWORD: yes
@@ -33,5 +33,5 @@ jobs:
 
       - name: Execute tests
         env:
-          DB_PORT: ${{ job.services.mysql.ports['3306'] }}
+          DB_PORT: ${{ job.services.db.ports['3306'] }}
         run: XDEBUG_MODE=coverage ./vendor/bin/pest --coverage --min=100
diff --git a/.github/workflows/pest.yml b/.github/workflows/pest.yml
@@ -4,15 +4,16 @@ on: [ push, pull_request ]
 
 jobs:
   test:
-    name: Pest - PHP ${{ matrix.php }} - Laravel ${{ matrix.laravel }} - ${{ matrix.dependency-version }}
+    name: Pest - PHP ${{ matrix.php }} - Laravel ${{ matrix.laravel }} - DB ${{ matrix.db }} ${{ matrix.dependency-version }}
 
     runs-on: ubuntu-latest
 
     strategy:
-      fail-fast: true
+      fail-fast: false
       matrix:
         php: [ 8.1, 8.0 ]
         laravel: [ 9.*, 8.* ]
+        db: [ 'mysql:8.0', 'mariadb:10.9' ]
         # dependency-version: [prefer-lowest, prefer-stable]
         dependency-version: [ prefer-stable ]
         include:
@@ -22,8 +23,8 @@ jobs:
             testbench: 7.*
 
     services:
-      mysql:
-        image: mysql:8.0
+      db:
+        image: ${{ matrix.db }}
         env:
           MYSQL_ALLOW_EMPTY_PASSWORD: yes
           MYSQL_DATABASE: laravel_eloquent_spatial_test
@@ -48,5 +49,5 @@ jobs:
 
       - name: Execute tests
         env:
-          DB_PORT: ${{ job.services.mysql.ports['3306'] }}
+          DB_PORT: ${{ job.services.db.ports['3306'] }}
         run: vendor/bin/pest
diff --git a/.github/workflows/phpstan.yml b/.github/workflows/phpstan.yml
@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
 
     strategy:
-      fail-fast: true
+      fail-fast: false
       matrix:
         php: [ 8.1, 8.0 ]
 
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 
 Laravel package to work with spatial data types and functions.
 
-This package supports only MySQL 5.7 and 8.0.
+This package supports MySQL v8 and MariaDB v10.
 
 ## Installation
 
diff --git a/phpstan.neon b/phpstan.neon
@@ -12,6 +12,7 @@ parameters:
     		-
     			message: '#^Access to an undefined property Pest\\Expectation\|Pest\\Support\\Extendable\:\:\$.+\.$#'
     			path: tests/*.php
+    		- '#^Call to an undefined( static)? method .+\:\:isMaria\(\)\.$#'
     excludePaths:
         - ./src/Factory.php
     checkMissingIterableValueType: true
diff --git a/src/GeometryCast.php b/src/GeometryCast.php
@@ -71,19 +71,27 @@ public function set($model, string $key, $value, array $attributes): Expression|
 
     $wkt = $value->toWkt();
 
+    $isMariaDb = $model->getConnection()->isMaria();
+
+    if ($isMariaDb) {
+      // @codeCoverageIgnoreStart
+      return DB::raw("ST_GeomFromText('{$wkt}', {$value->srid})");
+      // @codeCoverageIgnoreEnd
+    }
+
     return DB::raw("ST_GeomFromText('{$wkt}', {$value->srid}, 'axis-order=long-lat')");
   }
 
   private function extractWktFromExpression(Expression $expression): string
   {
-    preg_match('/ST_GeomFromText\(\'(.+)\', .+, .+\)/', (string) $expression, $match);
+    preg_match('/ST_GeomFromText\(\'(.+)\', .+(, .+)?\)/', (string) $expression, $match);
 
     return $match[1];
   }
 
   private function extractSridFromExpression(Expression $expression): int
   {
-    preg_match('/ST_GeomFromText\(\'.+\', (.+), .+\)/', (string) $expression, $match);
+    preg_match('/ST_GeomFromText\(\'.+\', (.+)(, .+)?\)/', (string) $expression, $match);
 
     return (int) $match[1];
   }
diff --git a/src/SpatialBuilder.php b/src/SpatialBuilder.php
@@ -265,6 +265,14 @@ protected function toExpression(Geometry|string $geometryOrColumn): Expression
     if ($geometryOrColumn instanceof Geometry) {
       $wkt = $geometryOrColumn->toWkt();
 
+      $isMariaDb = $this->getConnection()->isMaria();
+
+      if ($isMariaDb) {
+        // @codeCoverageIgnoreStart
+        return DB::raw("ST_GeomFromText('{$wkt}', {$geometryOrColumn->srid})");
+        // @codeCoverageIgnoreEnd
+      }
+
       return DB::raw("ST_GeomFromText('{$wkt}', {$geometryOrColumn->srid}, 'axis-order=long-lat')");
     }
 
diff --git a/tests/Objects/GeometryTest.php b/tests/Objects/GeometryTest.php
@@ -1,6 +1,7 @@
 <?php
 
 use Illuminate\Database\QueryException;
+use Illuminate\Support\Facades\DB;
 use MatanYadaev\EloquentSpatial\Objects\LineString;
 use MatanYadaev\EloquentSpatial\Objects\Point;
 use MatanYadaev\EloquentSpatial\Tests\TestModels\TestPlace;
@@ -18,14 +19,14 @@
     $point = (new Point(91, 0, 4326));
     TestPlace::factory()->create(['point' => $point]);
   })->toThrow(QueryException::class);
-});
+})->skip(fn () => DB::isMaria());
 
 it('throws exception when generating geometry with invalid longitude', function (): void {
   expect(function (): void {
     $point = (new Point(0, 181, 4326));
     TestPlace::factory()->create(['point' => $point]);
   })->toThrow(QueryException::class);
-});
+})->skip(fn () => DB::isMaria());
 
 it('throws exception when generating geometry from other geometry WKT', function (): void {
   expect(function (): void {
diff --git a/tests/Objects/MultiLineStringTest.php b/tests/Objects/MultiLineStringTest.php
@@ -99,7 +99,7 @@
     ]),
   ]);
 
-  $multiLineStringFromWkt = MultiLineString::fromWkt('MULTILINESTRING((180 0, 179 1))', );
+  $multiLineStringFromWkt = MultiLineString::fromWkt('MULTILINESTRING((180 0, 179 1))');
 
   expect($multiLineStringFromWkt)->toEqual($multiLineString);
 });
diff --git a/tests/SpatialBuilderTest.php b/tests/SpatialBuilderTest.php
@@ -1,6 +1,7 @@
 <?php
 
 use Illuminate\Foundation\Testing\DatabaseMigrations;
+use Illuminate\Support\Facades\DB;
 use MatanYadaev\EloquentSpatial\Objects\LineString;
 use MatanYadaev\EloquentSpatial\Objects\Point;
 use MatanYadaev\EloquentSpatial\Objects\Polygon;
@@ -28,7 +29,18 @@
     ->firstOrFail();
 
   expect($testPlaceWithDistance->distance)->toBe(156897.79947260793);
-});
+})->skip(fn () => DB::isMaria());
+
+it('calculates distance between column and geometry - MariaDB', function (): void {
+  TestPlace::factory()->create(['point' => new Point(0, 0, 4326)]);
+
+  /** @var TestPlace $testPlaceWithDistance */
+  $testPlaceWithDistance = TestPlace::query()
+    ->withDistance('point', new Point(1, 1, 4326))
+    ->firstOrFail();
+
+  expect($testPlaceWithDistance->distance)->toBe(1.4142135623730951);
+})->skip(fn () => ! DB::isMaria());
 
 it('calculates distance with alias', function (): void {
   TestPlace::factory()->create(['point' => new Point(0, 0, 4326)]);
@@ -39,7 +51,18 @@
     ->firstOrFail();
 
   expect($testPlaceWithDistance->distance_in_meters)->toBe(156897.79947260793);
-});
+})->skip(fn () => DB::isMaria());
+
+it('calculates distance with alias - MariaDB', function (): void {
+  TestPlace::factory()->create(['point' => new Point(0, 0, 4326)]);
+
+  /** @var TestPlace $testPlaceWithDistance */
+  $testPlaceWithDistance = TestPlace::query()
+    ->withDistance('point', new Point(1, 1, 4326), 'distance_in_meters')
+    ->firstOrFail();
+
+  expect($testPlaceWithDistance->distance_in_meters)->toBe(1.4142135623730951);
+})->skip(fn () => ! DB::isMaria());
 
 it('filters by distance', function (): void {
   $pointWithinDistance = new Point(0, 0, 4326);
@@ -54,7 +77,22 @@
 
   expect($testPlacesWithinDistance)->toHaveCount(1);
   expect($testPlacesWithinDistance[0]->point)->toEqual($pointWithinDistance);
-});
+})->skip(fn () => DB::isMaria());
+
+it('filters by distance - MariaDB', function (): void {
+  $pointWithinDistance = new Point(0, 0, 4326);
+  $pointNotWithinDistance = new Point(50, 50, 4326);
+  TestPlace::factory()->create(['point' => $pointWithinDistance]);
+  TestPlace::factory()->create(['point' => $pointNotWithinDistance]);
+
+  /** @var TestPlace[] $testPlacesWithinDistance */
+  $testPlacesWithinDistance = TestPlace::query()
+    ->whereDistance('point', new Point(1, 1, 4326), '<', 2)
+    ->get();
+
+  expect($testPlacesWithinDistance)->toHaveCount(1);
+  expect($testPlacesWithinDistance[0]->point)->toEqual($pointWithinDistance);
+})->skip(fn () => ! DB::isMaria());
 
 it('orders by distance ASC', function (): void {
   $closerTestPlace = TestPlace::factory()->create(['point' => new Point(1, 1, 4326)]);
@@ -102,7 +140,18 @@
     ->firstOrFail();
 
   expect($testPlaceWithDistance->distance)->toBe(157249.59776850493);
-});
+})->skip(fn () => DB::isMaria());
+
+it('calculates distance sphere column and geometry - MariaDB', function (): void {
+  TestPlace::factory()->create(['point' => new Point(0, 0, 4326)]);
+
+  /** @var TestPlace $testPlaceWithDistance */
+  $testPlaceWithDistance = TestPlace::query()
+    ->withDistanceSphere('point', new Point(1, 1, 4326))
+    ->firstOrFail();
+
+  expect($testPlaceWithDistance->distance)->toBe(157249.0357231545);
+})->skip(fn () => ! DB::isMaria());
 
 it('calculates distance sphere with alias', function (): void {
   TestPlace::factory()->create(['point' => new Point(0, 0, 4326)]);
@@ -113,7 +162,18 @@
     ->firstOrFail();
 
   expect($testPlaceWithDistance->distance_in_meters)->toBe(157249.59776850493);
-});
+})->skip(fn () => DB::isMaria());
+
+it('calculates distance sphere with alias - MariaDB', function (): void {
+  TestPlace::factory()->create(['point' => new Point(0, 0, 4326)]);
+
+  /** @var TestPlace $testPlaceWithDistance */
+  $testPlaceWithDistance = TestPlace::query()
+    ->withDistanceSphere('point', new Point(1, 1, 4326), 'distance_in_meters')
+    ->firstOrFail();
+
+  expect($testPlaceWithDistance->distance_in_meters)->toBe(157249.0357231545);
+})->skip(fn () => ! DB::isMaria());
 
 it('filters distance sphere', function (): void {
   $pointWithinDistance = new Point(0, 0, 4326);

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ parameters:`
`12`	`12`	`-`
`13`	`13`	`message: '#^Access to an undefined property Pest\\Expectation\\|Pest\\Support\\Extendable\:\:\$.+\.$#'`
`14`	`14`	`path: tests/*.php`
	`15`	`+ - '#^Call to an undefined( static)? method .+\:\:isMaria\(\)\.$#'`
`15`	`16`	`excludePaths:`
`16`	`17`	`- ./src/Factory.php`
`17`	`18`	`checkMissingIterableValueType: true`
Original file line number	Diff line number	Diff line change
`@@ -71,19 +71,27 @@ public function set($model, string $key, $value, array $attributes): Expression\|`
`71`	`71`
`72`	`72`	`$wkt = $value->toWkt();`
`73`	`73`
	`74`	`+ $isMariaDb = $model->getConnection()->isMaria();`
	`75`	`+`
	`76`	`+ if ($isMariaDb) {`
	`77`	`+ // @codeCoverageIgnoreStart`
	`78`	`+ return DB::raw("ST_GeomFromText('{$wkt}', {$value->srid})");`
	`79`	`+ // @codeCoverageIgnoreEnd`
	`80`	`+ }`
	`81`	`+`
`74`	`82`	`return DB::raw("ST_GeomFromText('{$wkt}', {$value->srid}, 'axis-order=long-lat')");`
`75`	`83`	`}`
`76`	`84`
`77`	`85`	`private function extractWktFromExpression(Expression $expression): string`
`78`	`86`	`{`
`79`		`- preg_match('/ST_GeomFromText\(\'(.+)\', .+, .+\)/', (string) $expression, $match);`
	`87`	`+ preg_match('/ST_GeomFromText\(\'(.+)\', .+(, .+)?\)/', (string) $expression, $match);`
`80`	`88`
`81`	`89`	`return $match[1];`
`82`	`90`	`}`
`83`	`91`
`84`	`92`	`private function extractSridFromExpression(Expression $expression): int`
`85`	`93`	`{`
`86`		`- preg_match('/ST_GeomFromText\(\'.+\', (.+), .+\)/', (string) $expression, $match);`
	`94`	`+ preg_match('/ST_GeomFromText\(\'.+\', (.+)(, .+)?\)/', (string) $expression, $match);`
`87`	`95`
`88`	`96`	`return (int) $match[1];`
`89`	`97`	`}`