merged branch jfsimon/finder-iterator-keys-fix (PR #6911)

fabpot · fabpot · commit ef5300d63788 · 2013-01-29T21:31:06.000+01:00
This PR was merged into the master branch. Commits ------- ef593fa [Finder] Fixed iterator keys d16e28a [Finder] Added iterator keys test Discussion ---------- [Finder] Fixes iterator keys | Q | A | ------------- | --- | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #6891 | License | MIT Previous PR I did on finder introduced a BR break (finder iterator keys must be the pathname of the file, not an incremented index). This PR adds a test to ensure this wont be broken again and fixes the BC break.
diff --git a/src/Symfony/Component/Finder/Iterator/FilePathsIterator.php b/src/Symfony/Component/Finder/Iterator/FilePathsIterator.php
@@ -40,6 +40,11 @@ class FilePathsIterator extends \ArrayIterator
      */
     private $subPathname;
 
+    /**
+     * @var SplFileInfo
+     */
+    private $current;
+
     /**
      * @param array  $paths   List of paths returned by shell command
      * @param string $baseDir Base dir for relative path building
@@ -70,21 +75,27 @@ public function __call($name, array $arguments)
      */
     public function current()
     {
-        return new SplFileInfo(parent::current(), $this->subPath, $this->subPathname);
+        return $this->current;
+    }
+
+    /**
+     * @return string
+     */
+    public function key()
+    {
+        return $this->current->getPathname();
     }
 
     public function next()
     {
         parent::next();
-
-        $this->buildSubPath();
+        $this->buildProperties();
     }
 
     public function rewind()
     {
         parent::rewind();
-
-        $this->buildSubPath();
+        $this->buildProperties();
     }
 
     /**
@@ -103,7 +114,7 @@ public function getSubPathname()
         return $this->subPathname;
     }
 
-    private function buildSubPath()
+    private function buildProperties()
     {
         $absolutePath = parent::current();
 
@@ -114,5 +125,7 @@ private function buildSubPath()
         } else {
             $this->subPath = $this->subPathname = '';
         }
+
+        $this->current = new SplFileInfo(parent::current(), $this->subPath, $this->subPathname);
     }
 }
diff --git a/src/Symfony/Component/Finder/Tests/FinderTest.php b/src/Symfony/Component/Finder/Tests/FinderTest.php
@@ -576,6 +576,19 @@ public function testMultipleLocations(Adapter\AdapterInterface $adapter)
         $this->assertEquals(1, count($finder));
     }
 
+    /**
+     * Iterator keys must be the file pathname.
+     *
+     * @dataProvider getAdaptersTestData
+     */
+    public function testIteratorKeys(Adapter\AdapterInterface $adapter)
+    {
+        $finder = $this->buildFinder($adapter)->in(self::$tmpDir);
+        foreach ($finder as $key => $file) {
+            $this->assertEquals($file->getPathname(), $key);
+        }
+    }
+
     public function testAdaptersOrdering()
     {
         $finder = Finder::create()

Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,11 @@ class FilePathsIterator extends \ArrayIterator`
`40`	`40`	`*/`
`41`	`41`	`private $subPathname;`
`42`	`42`
	`43`	`+ /**`
	`44`	`+ * @var SplFileInfo`
	`45`	`+ */`
	`46`	`+ private $current;`
	`47`	`+`
`43`	`48`	`/**`
`44`	`49`	`* @param array $paths List of paths returned by shell command`
`45`	`50`	`* @param string $baseDir Base dir for relative path building`
`@@ -70,21 +75,27 @@ public function __call($name, array $arguments)`
`70`	`75`	`*/`
`71`	`76`	`public function current()`
`72`	`77`	`{`
`73`		`- return new SplFileInfo(parent::current(), $this->subPath, $this->subPathname);`
	`78`	`+ return $this->current;`
	`79`	`+ }`
	`80`	`+`
	`81`	`+ /**`
	`82`	`+ * @return string`
	`83`	`+ */`
	`84`	`+ public function key()`
	`85`	`+ {`
	`86`	`+ return $this->current->getPathname();`
`74`	`87`	`}`
`75`	`88`
`76`	`89`	`public function next()`
`77`	`90`	`{`
`78`	`91`	`parent::next();`
`79`		`-`
`80`		`- $this->buildSubPath();`
	`92`	`+ $this->buildProperties();`
`81`	`93`	`}`
`82`	`94`
`83`	`95`	`public function rewind()`
`84`	`96`	`{`
`85`	`97`	`parent::rewind();`
`86`		`-`
`87`		`- $this->buildSubPath();`
	`98`	`+ $this->buildProperties();`
`88`	`99`	`}`
`89`	`100`
`90`	`101`	`/**`
`@@ -103,7 +114,7 @@ public function getSubPathname()`
`103`	`114`	`return $this->subPathname;`
`104`	`115`	`}`
`105`	`116`
`106`		`- private function buildSubPath()`
	`117`	`+ private function buildProperties()`
`107`	`118`	`{`
`108`	`119`	`$absolutePath = parent::current();`
`109`	`120`
`@@ -114,5 +125,7 @@ private function buildSubPath()`
`114`	`125`	`} else {`
`115`	`126`	`$this->subPath = $this->subPathname = '';`
`116`	`127`	`}`
	`128`	`+`
	`129`	`+ $this->current = new SplFileInfo(parent::current(), $this->subPath, $this->subPathname);`
`117`	`130`	`}`
`118`	`131`	`}`