Better build pipeline

- Add stages
- Add psalm
- Add php-cs-fixer
- Use phpdbg for code coverage
- Disable phpdoc_to_comment in php-cs-fixer because it may break Psalm annotations

Author: scheb

.php_cs.dist

@@ -3,6 +3,7 @@
 $rules = [
     '@Symfony' => true,
     'native_function_invocation' => ['include' => ['@compiler_optimized'], 'scope' => 'namespaced'],
+    'phpdoc_to_comment' => false,
 ];
 
 $finder = PhpCsFixer\Finder::create()

.travis.yml

@@ -1,40 +1,68 @@
 language: php
 
-php:
-  - 7.1
-  - 7.2
-  - 7.3
-  - 7.4
-
-sudo: false
-
-matrix:
-  fast_finish: true
-  include:
-    - php: 7.1
-      env: COMPOSER_FLAGS="--prefer-lowest"
-    - php: 7.4
-      env: SYMFONY_VERSION=^3.4
-    - php: 7.4
-      env: SYMFONY_VERSION=^4.0
-    - php: 7.4
-      env: SYMFONY_VERSION=^5.0
+os:
+  - linux
 
 cache:
   directories:
     - $HOME/.composer/cache
+    - vendor
 
 before_install:
+  - if php -v | grep -q 'Xdebug'; then phpenv config-rm xdebug.ini; fi
   - if [ "$SYMFONY_VERSION" != "" ]; then composer require "symfony/symfony:${SYMFONY_VERSION}" --no-update; fi;
 
 install:
   - travis_retry composer update --prefer-dist --no-interaction --no-suggest $COMPOSER_FLAGS
 
 script:
-  - mkdir -p build/logs
-  - ./bin/phpunit --coverage-clover build/logs/clover.xml
-  - ./bin/phpcs --standard=php_cs.xml --ignore=*/vendor/* .
+  - ./bin/phpunit
+
+jobs:
+  include:
+    # Tests
+    - php: 7.1
+    - php: 7.2
+    - php: 7.3
+    - php: 7.4
+    - php: 7.1
+      env:
+          - COMPOSER_FLAGS="--prefer-lowest"
+    - php: 7.4
+      env:
+        - SYMFONY_VERSION=^3.4
+    - php: 7.4
+      env:
+        - SYMFONY_VERSION=^4.0
+    - php: 7.4
+      env:
+        - SYMFONY_VERSION=^5.0
+
+    # Metrics and Quality
+    - name: Code Coverage
+      php: 7.4
+      before_script:
+        - mkdir -p build/logs
+      script:
+        - phpdbg -qrr ./bin/phpunit --coverage-clover build/logs/clover.xml
+      after_script:
+        - travis_retry wget https://scrutinizer-ci.com/ocular.phar
+        - travis_retry php ocular.phar code-coverage:upload --format=php-clover build/logs/clover.xml
+
+    - name: Psalm
+      php: 7.4
+      script:
+        - ./bin/psalm --show-info=true
+
+    - name: PHP Code Style Sniffer
+      php: 7.4
+      script:
+        - ./bin/phpcs --standard=php_cs.xml --ignore=*/vendor/* .
 
-after_script:
- - travis_retry wget https://scrutinizer-ci.com/ocular.phar
- - travis_retry php ocular.phar code-coverage:upload --format=php-clover build/logs/clover.xml
+    - name: PHP Coding Standards Fixer
+      php: 7.4
+      before_script:
+          - travis_retry wget https://cs.symfony.com/download/php-cs-fixer-v2.phar -O php-cs-fixer
+          - chmod a+x php-cs-fixer
+      script:
+          - ./php-cs-fixer fix --dry-run --stop-on-violation --using-cache=no

CONTRIBUTING.md

@@ -32,3 +32,5 @@ Before you create a pull request, please make sure your changes fulfill the qual
 1) Install the dependencies with `composer install`
 2) Run the PHPUnit tests with `bin/phpunit`
 3) Run PHP CodeSniffer with `bin/phpcs --standard=php_cs.xml --ignore=/vendor/ .`
+4) Run Psalm with `bin/psalm`
+5) Ideally, run [PHP-CS-Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) (not provided with the library)

composer.json

@@ -29,11 +29,13 @@
     "require-dev": {
         "doctrine/lexer": "^1.0.1",
         "doctrine/orm": "^2.6",
-        "phpunit/phpunit": "^7.0|^8.0",
+        "phpunit/phpunit": "^7.0|^8.0|^9.0",
         "swiftmailer/swiftmailer": "^6.0",
         "symfony/yaml": "^3.4|^4.0|^5.0",
         "escapestudios/symfony2-coding-standard": "^3.9",
-        "squizlabs/php_codesniffer": "^3.5"
+        "squizlabs/php_codesniffer": "^3.5",
+        "vimeo/psalm": "^3.11",
+        "symfony/polyfill-php80": "^1.15"
     },
     "autoload": {
         "psr-4": {

psalm.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<psalm
+    resolveFromConfigFile="true"
+	errorLevel="3"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+>
+    <projectFiles>
+        <directory name="." />
+		<ignoreFiles>
+			<directory name="vendor" />
+			<directory name="Tests" />
+		</ignoreFiles>
+    </projectFiles>
+</psalm>