Add Coding standards check for Github Actions (#2222)

* Add Coding standards check for Github Actions

* Fix @var

* Upgrade to php-cs-fixer 3.0

* Apply php-cs-fixer

Author: franmomu

.github/workflows/coding-standards.yml

@@ -0,0 +1,28 @@
+name: "Coding Standards"
+
+on:
+  pull_request: null
+
+jobs:
+  coding-standards:
+    name: "Coding Standards"
+    runs-on: "ubuntu-20.04"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v2"
+
+      - name: "Install PHP"
+        uses: "shivammathur/setup-php@v2"
+        with:
+          coverage: "none"
+          php-version: "7.4"
+
+      - name: "Install dependencies with Composer"
+        uses: "ramsey/composer-install@v1"
+        with:
+          dependency-versions: "highest"
+
+      - name: "Run PHP-CS-Fixer"
+        run: "bin/php-cs-fixer fix --ansi --verbose --diff --dry-run"
+

.gitignore

@@ -2,7 +2,7 @@
 bin
 vendor
 
-.php_cs.cache
+.php-cs-fixer.cache
 composer.lock
 tests/phpunit.xml
 tests/temp/*.php

.php_cs.dist renamed to .php-cs-fixer.dist.php

@@ -7,12 +7,14 @@
         __DIR__ . '/tests',
     ]);
 
-return PhpCsFixer\Config::create()
+$config = new PhpCsFixer\Config();
+return $config
     ->setRules([
         '@PSR2' => true,
         '@Symfony' => true,
         'array_syntax' => ['syntax' => 'short'],
         'ordered_imports' => ['sort_algorithm' => 'alpha'],
         'phpdoc_summary' => false,
+        'phpdoc_to_comment' => false,
     ])
     ->setFinder($finder);

composer.json

@@ -50,7 +50,7 @@
         "doctrine/doctrine-bundle": "^2.3",
         "doctrine/mongodb-odm": "^2.0",
         "doctrine/orm": "^2.6.3",
-        "friendsofphp/php-cs-fixer": "^2.16",
+        "friendsofphp/php-cs-fixer": "^3.0",
         "phpunit/phpunit": "^8.5",
         "symfony/cache": "^4.4 || ^5.0",
         "symfony/yaml": "^4.1"

example/em.php

@@ -14,7 +14,7 @@
     'driver' => 'pdo_mysql',
 ];
 if (!file_exists(__DIR__.'/../vendor/autoload.php')) {
-    die('cannot find vendors, read README.md how to use composer');
+    exit('cannot find vendors, read README.md how to use composer');
 }
 // First of all autoloading of vendors
 $loader = require __DIR__.'/../vendor/autoload.php';

src/Blameable/Mapping/Driver/Annotation.php

@@ -19,7 +19,7 @@ class Annotation extends AbstractAnnotationDriver
     /**
      * Annotation field is blameable
      */
-    const BLAMEABLE = 'Gedmo\\Mapping\\Annotation\\Blameable';
+    public const BLAMEABLE = 'Gedmo\\Mapping\\Annotation\\Blameable';
 
     /**
      * List of types which are valid for blame

src/DoctrineExtensions.php

@@ -2,6 +2,7 @@
 
 namespace Gedmo;
 
+use function class_exists;
 use Doctrine\Common\Annotations\AnnotationReader;
 use Doctrine\Common\Annotations\AnnotationRegistry;
 use Doctrine\Common\Annotations\PsrCachedReader;
@@ -12,7 +13,6 @@
 use Doctrine\ORM\Mapping\Driver as DriverORM;
 use Doctrine\Persistence\Mapping\Driver\MappingDriverChain;
 use Symfony\Component\Cache\Adapter\ArrayAdapter;
-use function class_exists;
 
 /**
  * Version class allows to checking the dependencies required
@@ -26,7 +26,7 @@ final class DoctrineExtensions
     /**
      * Current version of extensions
      */
-    const VERSION = '3.1.0';
+    public const VERSION = '3.1.0';
 
     /**
      * Hooks all extensions metadata mapping drivers

src/IpTraceable/Mapping/Driver/Annotation.php

@@ -19,7 +19,7 @@ class Annotation extends AbstractAnnotationDriver
     /**
      * Annotation field is ipTraceable
      */
-    const IP_TRACEABLE = 'Gedmo\\Mapping\\Annotation\\IpTraceable';
+    public const IP_TRACEABLE = 'Gedmo\\Mapping\\Annotation\\IpTraceable';
 
     /**
      * List of types which are valid for IP

src/Loggable/LoggableListener.php

@@ -19,17 +19,17 @@ class LoggableListener extends MappedEventSubscriber
     /**
      * Create action
      */
-    const ACTION_CREATE = 'create';
+    public const ACTION_CREATE = 'create';
 
     /**
      * Update action
      */
-    const ACTION_UPDATE = 'update';
+    public const ACTION_UPDATE = 'update';
 
     /**
      * Remove action
      */
-    const ACTION_REMOVE = 'remove';
+    public const ACTION_REMOVE = 'remove';
 
     /**
      * Username for identification

src/Loggable/Mapping/Driver/Annotation.php

@@ -21,12 +21,12 @@ class Annotation extends AbstractAnnotationDriver
     /**
      * Annotation to define that this object is loggable
      */
-    const LOGGABLE = 'Gedmo\\Mapping\\Annotation\\Loggable';
+    public const LOGGABLE = 'Gedmo\\Mapping\\Annotation\\Loggable';
 
     /**
      * Annotation to define that this property is versioned
      */
-    const VERSIONED = 'Gedmo\\Mapping\\Annotation\\Versioned';
+    public const VERSIONED = 'Gedmo\\Mapping\\Annotation\\Versioned';
 
     /**
      * {@inheritdoc}