Merge pull request #378 from greg0ire/maintenance-work

Maintenance work

Author: greg0ire

.gitattributes

@@ -3,10 +3,8 @@
 /Tests export-ignore
 .doctrine-project.json export-ignore
 .gitattributes export-ignore
+/.github export-ignore
 .gitignore export-ignore
-.scrutinizer.yml export-ignore
-.travis.yml export-ignore
-composer.lock export-ignore
 phpcs.xml.dist export-ignore
 phpstan.neon export-ignore
 phpunit.xml.dist export-ignore

.github/workflows/continuous-integration.yml

@@ -0,0 +1,101 @@
+
+name: "Continuous Integration"
+
+on:
+  pull_request:
+    branches:
+      - "*.x"
+      - "master"
+  push:
+    branches:
+      - "*.x"
+      - "master"
+
+env:
+  fail-fast: true
+
+jobs:
+  phpunit:
+    name: "PHPUnit"
+    runs-on: "ubuntu-20.04"
+
+    strategy:
+      matrix:
+        php-version:
+          - "7.1"
+          - "7.2"
+          - "7.3"
+          - "7.4"
+        deps:
+          - "normal"
+        include:
+          - deps: "low"
+            php-version: "7.1"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v2"
+        with:
+          fetch-depth: 2
+
+      - name: "Install PHP with PCOV"
+        uses: "shivammathur/setup-php@v2"
+        if: "${{ matrix.php-version != '7.1' }}"
+        with:
+          php-version: "${{ matrix.php-version }}"
+          coverage: "pcov"
+          ini-values: "zend.assertions=1"
+
+      - name: "Install PHP with XDebug"
+        uses: "shivammathur/setup-php@v2"
+        if: "${{ matrix.php-version == '7.1' }}"
+        with:
+          php-version: "${{ matrix.php-version }}"
+          coverage: "xdebug"
+          ini-values: "zend.assertions=1"
+
+      - name: "Cache dependencies installed with composer"
+        uses: "actions/cache@v2"
+        with:
+          path: "~/.composer/cache"
+          key: "php-${{ matrix.php-version }}-composer-locked-${{ hashFiles('composer.lock') }}"
+          restore-keys: "php-${{ matrix.php-version }}-composer-locked-"
+
+      - name: "Install dependencies with composer"
+        run: "composer update --no-interaction --prefer-dist"
+        if: "${{ matrix.deps == 'normal' }}"
+
+      - name: "Install lowest possible dependencies with composer"
+        run: "composer update --no-interaction --prefer-dist --prefer-lowest"
+        if: "${{ matrix.deps == 'low' }}"
+
+      - name: "Run PHPUnit"
+        run: "vendor/bin/phpunit --coverage-clover=coverage.xml"
+
+      - name: "Upload coverage file"
+        uses: "actions/upload-artifact@v2"
+        with:
+          name: "phpunit-${{ matrix.deps }}-${{ matrix.php-version }}.coverage"
+          path: "coverage.xml"
+
+  upload_coverage:
+    name: "Upload coverage to Codecov"
+    runs-on: "ubuntu-20.04"
+    needs:
+      - "phpunit"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v2"
+        with:
+          fetch-depth: 2
+
+      - name: "Download coverage files"
+        uses: "actions/download-artifact@v2"
+        with:
+          path: "reports"
+
+      - name: "Upload to Codecov"
+        uses: "codecov/codecov-action@v1"
+        with:
+          directory: reports

.github/workflows/static-analysis.yml

@@ -0,0 +1,46 @@
+
+name: "Static Analysis"
+
+on:
+  pull_request:
+    branches:
+      - "*.x"
+      - "master"
+  push:
+    branches:
+      - "*.x"
+      - "master"
+
+jobs:
+  static-analysis-phpstan:
+    name: "Static Analysis with PHPStan"
+    runs-on: "ubuntu-20.04"
+
+    strategy:
+      matrix:
+        php-version:
+          - "7.4"
+
+    steps:
+      - name: "Checkout code"
+        uses: "actions/checkout@v2"
+
+      - name: "Install PHP"
+        uses: "shivammathur/setup-php@v2"
+        with:
+          coverage: "none"
+          php-version: "${{ matrix.php-version }}"
+          tools: "cs2pr"
+
+      - name: "Cache dependencies installed with composer"
+        uses: "actions/cache@v2"
+        with:
+          path: "~/.composer/cache"
+          key: "php-${{ matrix.php-version }}-composer-locked-${{ hashFiles('composer.lock') }}"
+          restore-keys: "php-${{ matrix.php-version }}-composer-locked-"
+
+      - name: "Install dependencies with composer"
+        run: "composer install --no-interaction --no-progress --no-suggest"
+
+      - name: "Run a static analysis with phpstan/phpstan"
+        run: "vendor/bin/phpstan analyse --error-format=checkstyle | cs2pr"

.gitignore

@@ -1,3 +1,5 @@
 /vendor/
+/composer.lock
 /.phpcs-cache
+/.phpunit.result.cache
 

.travis.yml

@@ -12,9 +12,9 @@
 use Symfony\Component\DependencyInjection\ContainerAwareInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
+
 use function error_get_last;
 use function is_dir;
-use function method_exists;
 use function mkdir;
 use function preg_match;
 use function sprintf;
@@ -25,11 +25,11 @@
  */
 abstract class DoctrineCommand extends BaseCommand
 {
-    public static function configureMigrations(ContainerInterface $container, Configuration $configuration) : void
+    public static function configureMigrations(ContainerInterface $container, Configuration $configuration): void
     {
         $dir = $configuration->getMigrationsDirectory();
 
-        if (empty($dir)) {
+        if ($dir === null) {
             $dir = $container->getParameter('doctrine_migrations.dir_name');
 
             if (! is_dir($dir) && ! @mkdir($dir, 0777, true) && ! is_dir($dir)) {
@@ -48,7 +48,7 @@ public static function configureMigrations(ContainerInterface $container, Config
             $pathPlaceholderArray = ['kernel.root_dir', 'kernel.cache_dir', 'kernel.logs_dir'];
 
             foreach ($pathPlaceholderArray as $pathPlaceholder) {
-                if (! $container->hasParameter($pathPlaceholder) || ! preg_match('/\%' . $pathPlaceholder . '\%/', $dir)) {
+                if (! $container->hasParameter($pathPlaceholder) || preg_match('/\%' . $pathPlaceholder . '\%/', $dir) === 0) {
                     continue;
                 }
 
@@ -68,16 +68,16 @@ public static function configureMigrations(ContainerInterface $container, Config
             $configuration->setMigrationsDirectory($dir);
         }
 
-        if (empty($configuration->getMigrationsNamespace())) {
+        if ($configuration->getMigrationsNamespace() === null) {
             $configuration->setMigrationsNamespace($container->getParameter('doctrine_migrations.namespace'));
         }
 
-        if (empty($configuration->getName())) {
+        if ($configuration->getName() === null) {
             $configuration->setName($container->getParameter('doctrine_migrations.name'));
         }
 
         // For backward compatibility, need use a table from parameters for overwrite the default configuration
-        if (! ($configuration instanceof AbstractFileConfiguration) || empty($configuration->getMigrationsTableName())) {
+        if (! ($configuration instanceof AbstractFileConfiguration) || $configuration->getMigrationsTableName() === '') {
             $configuration->setMigrationsTableName($container->getParameter('doctrine_migrations.table_name'));
         }
 
@@ -95,7 +95,7 @@ public static function configureMigrations(ContainerInterface $container, Config
             }
         }
 
-        if (method_exists($configuration, 'getCustomTemplate') && empty($configuration->getCustomTemplate())) {
+        if ($configuration->getCustomTemplate() === null) {
             $configuration->setCustomTemplate($container->getParameter('doctrine_migrations.custom_template'));
         }
 
@@ -125,7 +125,7 @@ public static function configureMigrations(ContainerInterface $container, Config
      *
      * Injects the container to migrations aware of it
      */
-    private static function injectContainerToMigrations(ContainerInterface $container, array $versions) : void
+    private static function injectContainerToMigrations(ContainerInterface $container, array $versions): void
     {
         foreach ($versions as $version) {
             $migration = $version->getMigration();

Command/DoctrineCommand.php

@@ -11,9 +11,10 @@
 use LogicException;
 use Symfony\Bundle\FrameworkBundle\Console\Application;
 use Symfony\Component\Console\Input\InputInterface;
-use Symfony\Component\DependencyInjection\ContainerInterface;
+
 use function assert;
 use function count;
+use function is_string;
 use function sprintf;
 
 /**
@@ -22,13 +23,11 @@
  */
 abstract class DoctrineCommandHelper extends BaseDoctrineCommandHelper
 {
-    public static function setApplicationHelper(Application $application, InputInterface $input) : void
+    public static function setApplicationHelper(Application $application, InputInterface $input): void
     {
         $container = $application->getKernel()->getContainer();
-        assert($container instanceof ContainerInterface);
-
-        /** @var Registry $doctrine */
-        $doctrine = $container->get('doctrine');
+        $doctrine  = $container->get('doctrine');
+        assert($doctrine instanceof Registry);
 
         $managerNames = $doctrine->getManagerNames();
 
@@ -42,25 +41,34 @@ public static function setApplicationHelper(Application $application, InputInter
             return;
         }
 
-        /** @var ConnectionHelper $dbHelper */
         $dbHelper = $application->getHelperSet()->get('db');
+        assert($dbHelper instanceof ConnectionHelper);
 
         $connection = $dbHelper->getConnection();
 
         if (! $connection instanceof PoolingShardConnection) {
             if (count($managerNames) === 0) {
+                $db = $input->getOption('db');
+                assert(is_string($db));
+
                 throw new LogicException(sprintf(
                     "Connection '%s' must implement shards configuration.",
-                    $input->getOption('db')
+                    $db
                 ));
             }
 
+            $em = $input->getOption('em');
+            assert(is_string($em));
+
             throw new LogicException(sprintf(
                 "Connection of EntityManager '%s' must implement shards configuration.",
-                $input->getOption('em')
+                $em
             ));
         }
 
-        $connection->connect($input->getOption('shard'));
+        $shard = $input->getOption('shard');
+        assert(is_string($shard));
+
+        $connection->connect($shard);
     }
 }

Command/Helper/DoctrineCommandHelper.php

@@ -10,7 +10,7 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
-use Symfony\Component\DependencyInjection\ContainerInterface;
+
 use function assert;
 
 /**
@@ -22,7 +22,7 @@ class MigrationsDiffDoctrineCommand extends DiffCommand
     /** @var string */
     protected static $defaultName = 'doctrine:migrations:diff';
 
-    protected function configure() : void
+    protected function configure(): void
     {
         parent::configure();
 
@@ -32,22 +32,21 @@ protected function configure() : void
             ->addOption('shard', null, InputOption::VALUE_REQUIRED, 'The shard connection to use for this command.');
     }
 
-    public function initialize(InputInterface $input, OutputInterface $output) : void
+    public function initialize(InputInterface $input, OutputInterface $output): void
     {
-        /** @var Application $application */
         $application = $this->getApplication();
+        assert($application instanceof Application);
 
         Helper\DoctrineCommandHelper::setApplicationHelper($application, $input);
 
         $configuration = $this->getMigrationConfiguration($input, $output);
         $container     = $application->getKernel()->getContainer();
-        assert($container instanceof ContainerInterface);
         DoctrineCommand::configureMigrations($container, $configuration);
 
         parent::initialize($input, $output);
     }
 
-    public function execute(InputInterface $input, OutputInterface $output) : ?int
+    public function execute(InputInterface $input, OutputInterface $output): ?int
     {
         // EM and DB options cannot be set at same time
         if ($input->getOption('em') !== null && $input->getOption('db') !== null) {