Throw a dedicated exception for non-existing directory

xelan · xelan · commit 48d5f94cda13 · 2019-03-28T12:28:31.000+01:00
Makes Finder::in() throw a DirectoryNotFoundException instead of an InvalidArgumentException if one of the directories is not found.
This behavior is more consistent with the AccessDeniedException for files which are unreadable due to insufficient permissions.
To keep BC, the new exception class inherits from InvalidArgumentException.
diff --git a/src/Symfony/Component/Finder/Exception/DirectoryNotFoundException.php b/src/Symfony/Component/Finder/Exception/DirectoryNotFoundException.php
@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Finder\Exception;
+
+/**
+ * @author Andreas Erhard <andreas.erhard@i-med.ac.at>
+ */
+class DirectoryNotFoundException extends \InvalidArgumentException
+{
+}
diff --git a/src/Symfony/Component/Finder/Finder.php b/src/Symfony/Component/Finder/Finder.php
@@ -13,6 +13,7 @@
 
 use Symfony\Component\Finder\Comparator\DateComparator;
 use Symfony\Component\Finder\Comparator\NumberComparator;
+use Symfony\Component\Finder\Exception\DirectoryNotFoundException;
 use Symfony\Component\Finder\Iterator\CustomFilterIterator;
 use Symfony\Component\Finder\Iterator\DateRangeFilterIterator;
 use Symfony\Component\Finder\Iterator\DepthRangeFilterIterator;
@@ -585,7 +586,7 @@ public function ignoreUnreadableDirs($ignore = true)
      *
      * @return $this
      *
-     * @throws \InvalidArgumentException if one of the directories does not exist
+     * @throws DirectoryNotFoundException if one of the directories does not exist
      */
     public function in($dirs)
     {
@@ -597,7 +598,7 @@ public function in($dirs)
             } elseif ($glob = glob($dir, (\defined('GLOB_BRACE') ? GLOB_BRACE : 0) | GLOB_ONLYDIR)) {
                 $resolvedDirs = array_merge($resolvedDirs, array_map([$this, 'normalizeDir'], $glob));
             } else {
-                throw new \InvalidArgumentException(sprintf('The "%s" directory does not exist.', $dir));
+                throw new DirectoryNotFoundException(sprintf('The "%s" directory does not exist.', $dir));
             }
         }
 
diff --git a/src/Symfony/Component/Finder/Tests/FinderTest.php b/src/Symfony/Component/Finder/Tests/FinderTest.php
@@ -888,14 +888,23 @@ public function testIn()
     }
 
     /**
-     * @expectedException \InvalidArgumentException
+     * @expectedException \Symfony\Component\Finder\Exception\DirectoryNotFoundException
      */
     public function testInWithNonExistentDirectory()
     {
         $finder = new Finder();
         $finder->in('foobar');
     }
 
+    /**
+     * @expectedException \InvalidArgumentException
+     */
+    public function testInWithNonExistentDirectoryLegacyException()
+    {
+        $finder = new Finder();
+        $finder->in('foobar');
+    }
+
     public function testInWithGlob()
     {
         $finder = $this->buildFinder();

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`
`14`	`14`	`use Symfony\Component\Finder\Comparator\DateComparator;`
`15`	`15`	`use Symfony\Component\Finder\Comparator\NumberComparator;`
	`16`	`+use Symfony\Component\Finder\Exception\DirectoryNotFoundException;`
`16`	`17`	`use Symfony\Component\Finder\Iterator\CustomFilterIterator;`
`17`	`18`	`use Symfony\Component\Finder\Iterator\DateRangeFilterIterator;`
`18`	`19`	`use Symfony\Component\Finder\Iterator\DepthRangeFilterIterator;`
`@@ -585,7 +586,7 @@ public function ignoreUnreadableDirs($ignore = true)`
`585`	`586`	`*`
`586`	`587`	`* @return $this`
`587`	`588`	`*`
`588`		`- * @throws \InvalidArgumentException if one of the directories does not exist`
	`589`	`+ * @throws DirectoryNotFoundException if one of the directories does not exist`
`589`	`590`	`*/`
`590`	`591`	`public function in($dirs)`
`591`	`592`	`{`
`@@ -597,7 +598,7 @@ public function in($dirs)`
`597`	`598`	`} elseif ($glob = glob($dir, (\defined('GLOB_BRACE') ? GLOB_BRACE : 0) \| GLOB_ONLYDIR)) {`
`598`	`599`	`$resolvedDirs = array_merge($resolvedDirs, array_map([$this, 'normalizeDir'], $glob));`
`599`	`600`	`} else {`
`600`		`- throw new \InvalidArgumentException(sprintf('The "%s" directory does not exist.', $dir));`
	`601`	`+ throw new DirectoryNotFoundException(sprintf('The "%s" directory does not exist.', $dir));`
`601`	`602`	`}`
`602`	`603`	`}`
`603`	`604`
Original file line number	Diff line number	Diff line change
`@@ -888,14 +888,23 @@ public function testIn()`
`888`	`888`	`}`
`889`	`889`
`890`	`890`	`/**`
`891`		`- * @expectedException \InvalidArgumentException`
	`891`	`+ * @expectedException \Symfony\Component\Finder\Exception\DirectoryNotFoundException`
`892`	`892`	`*/`
`893`	`893`	`public function testInWithNonExistentDirectory()`
`894`	`894`	`{`
`895`	`895`	`$finder = new Finder();`
`896`	`896`	`$finder->in('foobar');`
`897`	`897`	`}`
`898`	`898`
	`899`	`+ /**`
	`900`	`+ * @expectedException \InvalidArgumentException`
	`901`	`+ */`
	`902`	`+ public function testInWithNonExistentDirectoryLegacyException()`
	`903`	`+ {`
	`904`	`+ $finder = new Finder();`
	`905`	`+ $finder->in('foobar');`
	`906`	`+ }`
	`907`	`+`
`899`	`908`	`public function testInWithGlob()`
`900`	`909`	`{`
`901`	`910`	`$finder = $this->buildFinder();`