Add ECS

Author: BenMorel

.github/workflows/coding-standard.yml

@@ -0,0 +1,10 @@
+name: Coding Standard
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  coding-standard:
+    name: Coding Standard
+    uses: brick/coding-standard/.github/workflows/coding-standard.yml@main

.gitignore

@@ -1,3 +1,7 @@
 /vendor
 /composer.lock
 /.phpunit.cache
+
+/tools/*
+!/tools/ecs/composer.json
+!/tools/ecs/ecs.php

src/CompoundCurve.php

@@ -11,15 +11,23 @@
 use Brick\Geo\Exception\InvalidGeometryException;
 use Brick\Geo\Exception\NoSuchGeometryException;
 use Brick\Geo\Projector\Projector;
+use Countable;
+use IteratorAggregate;
 use Override;
 
+use function array_map;
+use function array_reduce;
+use function array_values;
+use function count;
+
 /**
  * A CompoundCurve is a collection of zero or more continuous CircularString or LineString instances.
  *
  * @template-implements \IteratorAggregate<int<0, max>, LineString|CircularString>
+ *
  * @final
  */
-class CompoundCurve extends Curve implements \Countable, \IteratorAggregate
+class CompoundCurve extends Curve implements Countable, IteratorAggregate
 {
     /**
      * The Curves that compose this CompoundCurve.
@@ -33,7 +41,7 @@ class CompoundCurve extends Curve implements \Countable, \IteratorAggregate
     /**
      * The coordinate system of each of the curves must match the one of the CompoundCurve.
      *
-     * @param CoordinateSystem             $cs     The coordinate system of the CompoundCurve.
+     * @param CoordinateSystem          $cs        The coordinate system of the CompoundCurve.
      * @param LineString|CircularString ...$curves The curves that compose the CompoundCurve.
      *
      * @throws EmptyGeometryException    If any of the input curves is empty.
@@ -71,20 +79,20 @@ public function __construct(CoordinateSystem $cs, LineString|CircularString ...$
     /**
      * Creates a non-empty CompoundCurve composed of the given curves.
      *
-     * @param LineString|CircularString    $curve1 The first curve.
+     * @param LineString|CircularString $curve1    The first curve.
      * @param LineString|CircularString ...$curveN The subsequent curves, if any.
      *
      * @throws EmptyGeometryException    If any of the input curves is empty.
      * @throws InvalidGeometryException  If the compound curve is not continuous.
      * @throws CoordinateSystemException If the curves use different coordinate systems.
      */
-    public static function of(LineString|CircularString $curve1, LineString|CircularString ...$curveN) : CompoundCurve
+    public static function of(LineString|CircularString $curve1, LineString|CircularString ...$curveN): CompoundCurve
     {
         return new CompoundCurve($curve1->coordinateSystem(), $curve1, ...$curveN);
     }
 
     #[Override]
-    public function startPoint() : Point
+    public function startPoint(): Point
     {
         if (count($this->curves) === 0) {
             throw new EmptyGeometryException('The CompoundCurve is empty and has no start point.');
@@ -94,7 +102,7 @@ public function startPoint() : Point
     }
 
     #[Override]
-    public function endPoint() : Point
+    public function endPoint(): Point
     {
         $count = count($this->curves);
 
@@ -108,7 +116,7 @@ public function endPoint() : Point
     /**
      * Returns the number of Curves in this CompoundCurve.
      */
-    public function numCurves() : int
+    public function numCurves(): int
     {
         return count($this->curves);
     }
@@ -120,7 +128,7 @@ public function numCurves() : int
      *
      * @throws NoSuchGeometryException If there is no Curve at this index.
      */
-    public function curveN(int $n) : LineString|CircularString
+    public function curveN(int $n): LineString|CircularString
     {
         if (! isset($this->curves[$n - 1])) {
             throw new NoSuchGeometryException('There is no Curve in this CompoundCurve at index ' . $n);
@@ -134,25 +142,25 @@ public function curveN(int $n) : LineString|CircularString
      *
      * @return list<LineString|CircularString>
      */
-    public function curves() : array
+    public function curves(): array
     {
         return $this->curves;
     }
 
     #[NoProxy, Override]
-    public function geometryType() : string
+    public function geometryType(): string
     {
         return 'CompoundCurve';
     }
 
     #[NoProxy, Override]
-    public function geometryTypeBinary() : int
+    public function geometryTypeBinary(): int
     {
         return Geometry::COMPOUNDCURVE;
     }
 
     #[Override]
-    public function getBoundingBox() : BoundingBox
+    public function getBoundingBox(): BoundingBox
     {
         return array_reduce(
             $this->curves,
@@ -165,7 +173,7 @@ public function getBoundingBox() : BoundingBox
      * @return list<list<list<float>>>
      */
     #[Override]
-    public function toArray() : array
+    public function toArray(): array
     {
         return array_map(
             fn (Curve $curve) => $curve->toArray(),
@@ -189,7 +197,7 @@ public function project(Projector $projector): CompoundCurve
      * Returns the number of curves in this CompoundCurve.
      */
     #[Override]
-    public function count() : int
+    public function count(): int
     {
         return count($this->curves);
     }
@@ -200,7 +208,7 @@ public function count() : int
      * @return ArrayIterator<int<0, max>, LineString|CircularString>
      */
     #[Override]
-    public function getIterator() : ArrayIterator
+    public function getIterator(): ArrayIterator
     {
         return new ArrayIterator($this->curves);
     }

tools/ecs/composer.json

@@ -0,0 +1,10 @@
+{
+    "require": {
+        "brick/coding-standard": "dev-main"
+    },
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
+    }
+}

tools/ecs/ecs.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+use PhpCsFixer\Fixer\ClassNotation\OrderedTypesFixer;
+use PhpCsFixer\Fixer\Phpdoc\PhpdocSummaryFixer;
+use PhpCsFixer\Fixer\Phpdoc\PhpdocTypesOrderFixer;
+use PhpCsFixer\Fixer\PhpUnit\PhpUnitStrictFixer;
+use PhpCsFixer\Fixer\Strict\StrictComparisonFixer;
+use Symplify\EasyCodingStandard\Config\ECSConfig;
+
+return static function (ECSConfig $ecsConfig): void {
+    $ecsConfig->import(__DIR__ . '/vendor/brick/coding-standard/ecs.php');
+
+    $libRootPath = __DIR__ . '/../../';
+
+    $ecsConfig->paths(
+        [
+            $libRootPath . '/src',
+            $libRootPath . '/tests',
+            __FILE__,
+        ],
+    );
+
+    $ecsConfig->skip([
+        $libRootPath . '/src/Proxy',
+
+        // We want to keep LineString|CircularString order
+        OrderedTypesFixer::class => null,
+        PhpdocTypesOrderFixer::class => null,
+
+        // CompoundCurve uses loose comparison intentionally when comparing points
+        StrictComparisonFixer::class => $libRootPath . '/src/CompoundCurve.php',
+
+        // AbstractWktReader uses WKT syntax in summaries, which should not be considered a sentence
+        PhpdocSummaryFixer::class => $libRootPath . '/src/Io/Internal/AbstractWktReader.php',
+
+        // GeoJsonReaderTest uses assertEquals() intentionally when comparing feature properties
+        PhpUnitStrictFixer::class => $libRootPath . '/tests/IO/GeoJsonReaderTest.php',
+    ]);
+};