merged branch jfsimon/finder-adapter-selection (PR #7212)

fabpot · fabpot · commit 06560dfb9e41 · 2013-02-28T15:06:37.000+01:00
This PR was squashed before being merged into the 2.2 branch (closes #7212). Commits ------- f40adbc [Finder] adds adapter selection/unselection capabilities Discussion ---------- [Finder] adds adapter selection/unselection capabilities As we have many issues with the native finder adapter, it would be good to: * permit selection of a particular adapter which will be choosed over the others until its unselection * permit unselection of adapters to get the finder select trhe best on (by priority) * have `PhpAdapter` selected by default This PR adds 2 methods to the `Finder`: * `setAdapter($adapter)`: selects an adapter by its name * `useBestAdapter()`: tells the finder to select best adapter by their priority | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes --------------------------------------------------------------------------- by jfsimon at 2013-02-28T14:05:25Z @fabpot I just applied all your good advices, there was no bad one :)
diff --git a/src/Symfony/Component/Finder/Finder.php b/src/Symfony/Component/Finder/Finder.php
@@ -69,6 +69,7 @@ public function __construct()
             ->addAdapter(new GnuFindAdapter())
             ->addAdapter(new BsdFindAdapter())
             ->addAdapter(new PhpAdapter(), -50)
+            ->setAdapter('php')
         ;
     }
 
@@ -97,11 +98,45 @@ public function addAdapter(Adapter\AdapterInterface $adapter, $priority = 0)
         $this->adapters[$adapter->getName()] = array(
             'adapter'  => $adapter,
             'priority' => $priority,
+            'selected' => false,
         );
 
         return $this->sortAdapters();
     }
 
+    /**
+     * Sets the selected adapter to the best one according to the current platform the code is run on.
+     *
+     * @return Finder The current Finder instance
+     */
+    public function useBestAdapter()
+    {
+        $this->resetAdapterSelection();
+
+        return $this->sortAdapters();
+    }
+
+    /**
+     * Selects the adapter to use.
+     *
+     * @param string $name
+     *
+     * @throws \InvalidArgumentException
+     *
+     * @return Finder The current Finder instance
+     */
+    public function setAdapter($name)
+    {
+        if (!isset($this->adapters[$name])) {
+            throw new \InvalidArgumentException(sprintf('Adapter "%s" does not exist.', $name));
+        }
+
+        $this->resetAdapterSelection();
+        $this->adapters[$name]['selected'] = true;
+
+        return $this->sortAdapters();
+    }
+
     /**
      * Removes all adapters registered in the finder.
      *
@@ -692,12 +727,16 @@ public function count()
         return iterator_count($this->getIterator());
     }
 
-    /*
+    /**
      * @return Finder The current Finder instance
      */
     private function sortAdapters()
     {
         uasort($this->adapters, function (array $a, array $b) {
+            if ($a['selected'] || $b['selected']) {
+                return $a['selected'] ? -1 : 1;
+            }
+
             return $a['priority'] > $b['priority'] ? -1 : 1;
         });
 
@@ -757,4 +796,16 @@ private function buildAdapter(AdapterInterface $adapter)
             ->setPath($this->paths)
             ->setNotPath($this->notPaths);
     }
+
+    /**
+     * Unselects all adapters.
+     */
+    private function resetAdapterSelection()
+    {
+        $this->adapters = array_map(function (array $properties) {
+            $properties['selected'] = false;
+
+            return $properties;
+        }, $this->adapters);
+    }
 }
diff --git a/src/Symfony/Component/Finder/Tests/FinderTest.php b/src/Symfony/Component/Finder/Tests/FinderTest.php
@@ -683,6 +683,21 @@ public function testPath(Adapter\AdapterInterface $adapter, $matchPatterns, $noM
         $this->assertIterator($this->toAbsoluteFixtures($expected), $finder);
     }
 
+    public function testAdapterSelection()
+    {
+        // test that by default, PhpAdapter is selected
+        $adapters = Finder::create()->getAdapters();
+        $this->assertTrue($adapters[0] instanceof Adapter\PhpAdapter);
+
+        // test another adapter selection
+        $adapters = Finder::create()->setAdapter('gnu_find')->getAdapters();
+        $this->assertTrue($adapters[0] instanceof Adapter\GnuFindAdapter);
+
+        // test that useBestAdapter method removes selection
+        $adapters = Finder::create()->useBestAdapter()->getAdapters();
+        $this->assertFalse($adapters[0] instanceof Adapter\PhpAdapter);
+    }
+
     public function getTestPathData()
     {
         $tests = array(
