Add PHP Coding Standards Fixer in CI (#1196)

* Update composer.json * Update .gitignore * Update php.yml * Apply PHPCSFixer fixes * Switch to php-cs-fixer/shim * Create .php-cs-fixer.dist.php

Author: jbelien

.github/workflows/php.yml

@@ -49,4 +49,19 @@ jobs:
  - name: Install dependencies
  run: composer install --no-progress
  - name: Run PHPStan
- run: composer run-script analyse
+ run: composer run-script analyse
+
+ php-cs-fixer:
+ runs-on: ubuntu-latest
+ name: PHP CS Fixer
+ steps:
+ - uses: actions/checkout@v3
+ - name: Use PHP 8.2
+ uses: shivammathur/setup-php@v2
+ with:
+ php-version: 8.2
+ extensions: curl
+ - name: Install dependencies
+ run: composer install --no-progress
+ - name: Run PHPStan
+ run: composer run-script cs

.gitignore

@@ -3,5 +3,5 @@ composer.lock
 composer.phar
 phpunit.xml
 .phpunit.result.cache
-php-cs-fixer.phar
+.php-cs-fixer.cache
 .puli/

.php-cs-fixer.dist.php

@@ -0,0 +1,11 @@
+<?php
+
+$finder = (new PhpCsFixer\Finder())
+ ->in('src')
+;
+
+return (new PhpCsFixer\Config())
+ ->setRules([
+ '@Symfony' => true,
+ ])
+ ->setFinder($finder);

composer.json

@@ -36,6 +36,7 @@
  "geoip2/geoip2": "~2.0",
  "nyholm/nsa": "^1.1",
  "nyholm/psr7": "^1.0",
+ "php-cs-fixer/shim": "^3.22",
  "php-http/curl-client": "^2.2",
  "php-http/message": "^1.0",
  "php-http/mock-client": "^1.0",
@@ -82,6 +83,8 @@
  },
  "scripts": {
  "analyse": "vendor/bin/phpstan analyse",
+ "cs": "vendor/bin/php-cs-fixer fix -v --dry-run",
+ "cs:fix": "vendor/bin/php-cs-fixer fix -v",
  "test": "vendor/bin/phpunit"
  }
 }

src/Common/Assert.php

@@ -17,8 +17,7 @@
 class Assert
 {
  /**
- * @param float $value
- * @param string $message
+ * @param float $value
  */
  public static function latitude($value, string $message = '')
  {
@@ -29,8 +28,7 @@ public static function latitude($value, string $message = '')
  }
 
  /**
- * @param float $value
- * @param string $message
+ * @param float $value
  */
  public static function longitude($value, string $message = '')
  {
@@ -40,10 +38,6 @@ public static function longitude($value, string $message = '')
  }
  }
 
- /**
- * @param mixed $value
- * @param string $message
- */
  public static function notNull($value, string $message = '')
  {
  if (null === $value) {
@@ -56,10 +50,6 @@ private static function typeToString($value): string
  return is_object($value) ? get_class($value) : gettype($value);
  }
 
- /**
- * @param $value
- * @param $message
- */
  private static function float($value, string $message)
  {
  if (!is_float($value)) {

src/Common/Collection.php

@@ -26,30 +26,20 @@
 interface Collection extends \IteratorAggregate, \Countable
 {
  /**
- * @return Location
- *
  * @throws CollectionIsEmpty
  */
  public function first(): Location;
 
- /**
- * @return bool
- */
  public function isEmpty(): bool;
 
  /**
  * @return Location[]
  */
  public function slice(int $offset, int $length = null);
 
- /**
- * @return bool
- */
  public function has(int $index): bool;
 
  /**
- * @return Location
- *
  * @throws OutOfBounds
  */
  public function get(int $index): Location;

src/Common/Dumper/AbstractArrayDumper.php

@@ -19,11 +19,6 @@
  */
 abstract class AbstractArrayDumper
 {
- /**
- * @param Location $location
- *
- * @return array
- */
  protected function getArray(Location $location): array
  {
  $properties = array_filter($location->toArray(), function ($value) {

src/Common/Dumper/AbstractDumper.php

@@ -16,11 +16,6 @@
 
 abstract class AbstractDumper
 {
- /**
- * @param Location $address
- *
- * @return string
- */
  protected function formatName(Location $address): string
  {
  $name = [];

src/Common/Dumper/Dumper.php

@@ -22,10 +22,6 @@ interface Dumper
  /**
  * Dumps an `Location` object as a string representation of
  * the implemented format.
- *
- * @param Location $location
- *
- * @return mixed
  */
  public function dump(Location $location);
 }

src/Common/Dumper/GeoArray.php

@@ -19,9 +19,6 @@
  */
 final class GeoArray extends AbstractArrayDumper implements Dumper
 {
- /**
- * {@inheritdoc}
- */
  public function dump(Location $location): array
  {
  return $this->getArray($location);