Merge pull request #725 from Majkl578/specialized-exceptions

Throw only specialized package-only exceptions

lib/Doctrine/Migrations/Configuration/AbstractFileConfiguration.php

@@ -5,10 +5,9 @@
 namespace Doctrine\Migrations\Configuration;
 
 use Doctrine\Migrations\Configuration\Exception\FileAlreadyLoaded;
+use Doctrine\Migrations\Configuration\Exception\FileNotFound;
 use Doctrine\Migrations\Configuration\Exception\InvalidConfigurationKey;
 use Doctrine\Migrations\Configuration\Exception\UnknownConfigurationValue;
-use Doctrine\Migrations\Exception\MigrationException;
-use InvalidArgumentException;
 use function dirname;
 use function file_exists;
 use function getcwd;
@@ -58,7 +57,9 @@ abstract class AbstractFileConfiguration extends Configuration
     /** @var bool */
     private $loaded = false;
 
-    /** @throws MigrationException */
+    /**
+     * @throws FileNotFound
+     */
     public function load(string $file) : void
     {
         if ($this->loaded) {
@@ -74,7 +75,7 @@ public function load(string $file) : void
         $this->file = $file;
 
         if (! file_exists($file)) {
-            throw new InvalidArgumentException('Given config file does not exist');
+            throw FileNotFound::new();
         }
 
         $this->doLoad($file);

lib/Doctrine/Migrations/Configuration/Connection/Loader/ArrayConnectionConfigurationLoader.php

@@ -7,7 +7,7 @@
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\DriverManager;
 use Doctrine\Migrations\Configuration\Connection\ConnectionLoaderInterface;
-use InvalidArgumentException;
+use Doctrine\Migrations\Configuration\Connection\Loader\Exception\InvalidConfiguration;
 use function file_exists;
 use function is_array;
 
@@ -31,7 +31,7 @@ public function __construct(?string $filename)
      * Read the input and return a Configuration, returns null if the config
      * is not supported.
      *
-     * @throws InvalidArgumentException
+     * @throws InvalidConfiguration
      */
     public function chosen() : ?Connection
     {
@@ -46,9 +46,7 @@ public function chosen() : ?Connection
         $params = include $this->filename;
 
         if (! is_array($params)) {
-            throw new InvalidArgumentException(
-                'The connection file has to return an array with database configuration parameters.'
-            );
+            throw InvalidConfiguration::invalidArrayConfiguration();
         }
 
         return DriverManager::getConnection($params);

lib/Doctrine/Migrations/Configuration/Connection/Loader/Exception/InvalidConfiguration.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Migrations\Configuration\Connection\Loader\Exception;
+
+use InvalidArgumentException;
+
+final class InvalidConfiguration extends InvalidArgumentException implements LoaderException
+{
+    public static function invalidArrayConfiguration() : self
+    {
+        return new self('The connection file has to return an array with database configuration parameters.');
+    }
+}

lib/Doctrine/Migrations/Configuration/Connection/Loader/Exception/LoaderException.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Migrations\Configuration\Connection\Loader\Exception;
+
+use Doctrine\Migrations\Exception\MigrationException;
+
+interface LoaderException extends MigrationException
+{
+}

lib/Doctrine/Migrations/Configuration/Exception/FileNotFound.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Migrations\Configuration\Exception;
+
+use InvalidArgumentException;
+
+final class FileNotFound extends InvalidArgumentException implements ConfigurationException
+{
+    public static function new() : self
+    {
+        return new self('Given config file does not exist');
+    }
+}

lib/Doctrine/Migrations/Exception/NoTablesFound.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Migrations\Exception;
+
+use RuntimeException;
+
+final class NoTablesFound extends RuntimeException implements MigrationException
+{
+    public static function new() : self
+    {
+        return new self('Your database schema does not contain any tables.');
+    }
+}

lib/Doctrine/Migrations/Exception/RollupFailed.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Migrations\Exception;
+
+use RuntimeException;
+
+final class RollupFailed extends RuntimeException implements MigrationException
+{
+    public static function noMigrationsFound() : self
+    {
+        return new self('No migrations found.');
+    }
+
+    public static function tooManyMigrations() : self
+    {
+        return new self('Too many migrations.');
+    }
+}

lib/Doctrine/Migrations/Finder/Exception/FinderException.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Migrations\Finder\Exception;
+
+interface FinderException
+{
+}

lib/Doctrine/Migrations/Finder/Exception/InvalidDirectory.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Migrations\Finder\Exception;
+
+use InvalidArgumentException;
+use function sprintf;
+
+final class InvalidDirectory extends InvalidArgumentException implements FinderException
+{
+    public static function new(string $directory) : self
+    {
+        return new self(sprintf('Cannot load migrations from "%s" because it is not a valid directory', $directory));
+    }
+}

lib/Doctrine/Migrations/Finder/Exception/NameIsReserved.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Migrations\Finder\Exception;
+
+use InvalidArgumentException;
+use const PHP_EOL;
+use function sprintf;
+
+final class NameIsReserved extends InvalidArgumentException implements FinderException
+{
+    public static function new(string $version) : self
+    {
+        return new self(sprintf(
+            'Cannot load a migrations with the name "%s" because it is a reserved number by Doctrine Migrations.'
+            . PHP_EOL
+            . "It's used to revert all migrations including the first one.",
+            $version
+        ));
+    }
+}

lib/Doctrine/Migrations/Finder/Finder.php

@@ -4,16 +4,15 @@
 
 namespace Doctrine\Migrations\Finder;
 
-use InvalidArgumentException;
+use Doctrine\Migrations\Finder\Exception\InvalidDirectory;
+use Doctrine\Migrations\Finder\Exception\NameIsReserved;
 use ReflectionClass;
-use const PHP_EOL;
 use const SORT_STRING;
 use function get_declared_classes;
 use function in_array;
 use function is_dir;
 use function ksort;
 use function realpath;
-use function sprintf;
 use function strlen;
 use function strncmp;
 use function substr;
@@ -28,15 +27,15 @@ protected static function requireOnce(string $path) : void
         require_once $path;
     }
 
+    /**
+     * @throws InvalidDirectory
+     */
     protected function getRealPath(string $directory) : string
     {
         $dir = realpath($directory);
 
         if ($dir === false || ! is_dir($dir)) {
-            throw new InvalidArgumentException(sprintf(
-                'Cannot load migrations from "%s" because it is not a valid directory',
-                $directory
-            ));
+            throw InvalidDirectory::new($directory);
         }
 
         return $dir;
@@ -46,6 +45,8 @@ protected function getRealPath(string $directory) : string
      * @param string[] $files
      *
      * @return string[]
+     *
+     * @throws NameIsReserved
      */
     protected function loadMigrations(array $files, ?string $namespace) : array
     {
@@ -61,11 +62,7 @@ protected function loadMigrations(array $files, ?string $namespace) : array
             $version = substr($class->getShortName(), 7);
 
             if ($version === '0') {
-                throw new InvalidArgumentException(sprintf(
-                    'Cannot load a migrations with the name "%s" because it is a reserved number by doctrine migrations' . PHP_EOL .
-                    'It\'s used to revert all migrations including the first one.',
-                    $version
-                ));
+                throw NameIsReserved::new($version);
             }
 
             $versions[$version] = $class->getName();

lib/Doctrine/Migrations/Generator/DiffGenerator.php

@@ -8,8 +8,8 @@
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Schema\AbstractSchemaManager;
 use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\Generator\Exception\NoChangesDetected;
 use Doctrine\Migrations\Provider\SchemaProviderInterface;
-use RuntimeException;
 use function preg_match;
 use function strpos;
 use function substr;
@@ -56,6 +56,9 @@ public function __construct(
         $this->migrationSqlGenerator = $migrationSqlGenerator;
     }
 
+    /**
+     * @throws NoChangesDetected
+     */
     public function generate(
         string $versionNumber,
         ?string $filterExpression,
@@ -83,7 +86,7 @@ public function generate(
         );
 
         if ($up === '' && $down === '') {
-            throw new RuntimeException('No changes detected in your mapping information.');
+            throw NoChangesDetected::new();
         }
 
         return $this->migrationGenerator->generateMigration(

lib/Doctrine/Migrations/Generator/Exception/GeneratorException.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Migrations\Generator\Exception;
+
+use Doctrine\Migrations\Exception\MigrationException;
+
+interface GeneratorException extends MigrationException
+{
+}

lib/Doctrine/Migrations/Generator/Exception/InvalidTemplateSpecified.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Migrations\Generator\Exception;
+
+use InvalidArgumentException;
+use function sprintf;
+
+final class InvalidTemplateSpecified extends InvalidArgumentException implements GeneratorException
+{
+    public static function notFoundOrNotReadable(string $path) : self
+    {
+        return new self(sprintf('The specified template "%s" cannot be found or is not readable.', $path));
+    }
+
+    public static function notReadable(string $path) : self
+    {
+        return new self(sprintf('The specified template "%s" could not be read.', $path));
+    }
+
+    public static function empty(string $path) : self
+    {
+        return new self(sprintf('The specified template "%s" is empty.', $path));
+    }
+}

lib/Doctrine/Migrations/Generator/Exception/NoChangesDetected.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Migrations\Generator\Exception;
+
+use RuntimeException;
+
+final class NoChangesDetected extends RuntimeException implements GeneratorException
+{
+    public static function new() : self
+    {
+        return new self('No changes detected in your mapping information.');
+    }
+}