diogo/symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[Finder] Deprecate adapters and related classes

Browse Source
This commit is contained in:
Nicolas Grekas 2015-09-15 10:24:28 +02:00
parent 4d275b42da
commit c08cf4b7f6
20 changed files with 255 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/Symfony/Component/Finder/Adapter/AbstractAdapter.php
View File

@ -11,10 +11,14 @@
namespace Symfony\Component\Finder\Adapter;
@trigger_error('The '.__NAMESPACE__.'\AbstractAdapter class is deprecated since version 2.8 and will be removed in 3.0. Use directly the Finder class instead.', E_USER_DEPRECATED);
/**
* Interface for finder engine implementations.
*
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since 2.8, to be removed in 3.0. Use Finder instead.
*/
abstract class AbstractAdapter implements AdapterInterface
{

4
src/Symfony/Component/Finder/Adapter/AbstractFindAdapter.php
View File

@ -11,6 +11,8 @@
namespace Symfony\Component\Finder\Adapter;
@trigger_error('The '.__NAMESPACE__.'\AbstractFindAdapter class is deprecated since version 2.8 and will be removed in 3.0. Use directly the Finder class instead.', E_USER_DEPRECATED);
use Symfony\Component\Finder\Exception\AccessDeniedException;
use Symfony\Component\Finder\Iterator;
use Symfony\Component\Finder\Shell\Shell;
@ -23,6 +25,8 @@ use Symfony\Component\Finder\Comparator\DateComparator;
* Shell engine implementation using GNU find command.
*
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since 2.8, to be removed in 3.0. Use Finder instead.
*/
abstract class AbstractFindAdapter extends AbstractAdapter
{

2
src/Symfony/Component/Finder/Adapter/AdapterInterface.php
View File

@ -13,6 +13,8 @@ namespace Symfony\Component\Finder\Adapter;
/**
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since 2.8, to be removed in 3.0.
*/
interface AdapterInterface
{

4
src/Symfony/Component/Finder/Adapter/BsdFindAdapter.php
View File

@ -11,6 +11,8 @@
namespace Symfony\Component\Finder\Adapter;
@trigger_error('The '.__NAMESPACE__.'\BsdFindAdapter class is deprecated since version 2.8 and will be removed in 3.0. Use directly the Finder class instead.', E_USER_DEPRECATED);
use Symfony\Component\Finder\Shell\Shell;
use Symfony\Component\Finder\Shell\Command;
use Symfony\Component\Finder\Iterator\SortableIterator;
@ -20,6 +22,8 @@ use Symfony\Component\Finder\Expression\Expression;
* Shell engine implementation using BSD find command.
*
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since 2.8, to be removed in 3.0. Use Finder instead.
*/
class BsdFindAdapter extends AbstractFindAdapter
{

4
src/Symfony/Component/Finder/Adapter/GnuFindAdapter.php
View File

@ -11,6 +11,8 @@
namespace Symfony\Component\Finder\Adapter;
@trigger_error('The '.__NAMESPACE__.'\GnuFindAdapter class is deprecated since version 2.8 and will be removed in 3.0. Use directly the Finder class instead.', E_USER_DEPRECATED);
use Symfony\Component\Finder\Shell\Shell;
use Symfony\Component\Finder\Shell\Command;
use Symfony\Component\Finder\Iterator\SortableIterator;
@ -20,6 +22,8 @@ use Symfony\Component\Finder\Expression\Expression;
* Shell engine implementation using GNU find command.
*
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since 2.8, to be removed in 3.0. Use Finder instead.
*/
class GnuFindAdapter extends AbstractFindAdapter
{

4
src/Symfony/Component/Finder/Adapter/PhpAdapter.php
View File

@ -11,12 +11,16 @@
namespace Symfony\Component\Finder\Adapter;
@trigger_error('The '.__NAMESPACE__.'\PhpAdapter class is deprecated since version 2.8 and will be removed in 3.0. Use directly the Finder class instead.', E_USER_DEPRECATED);
use Symfony\Component\Finder\Iterator;
/**
* PHP finder engine implementation.
*
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since 2.8, to be removed in 3.0. Use Finder instead.
*/
class PhpAdapter extends AbstractAdapter
{

5
src/Symfony/Component/Finder/CHANGELOG.md
View File

@ -1,6 +1,11 @@
CHANGELOG
=========
2.8.0
-----
* deprecated adapters and related classes
2.5.0
-----
* added support for GLOB_BRACE in the paths passed to Finder::in()

4
src/Symfony/Component/Finder/Exception/AdapterFailureException.php
View File

@ -11,12 +11,16 @@
namespace Symfony\Component\Finder\Exception;
@trigger_error('The '.__NAMESPACE__.'\AdapterFailureException class is deprecated since version 2.8 and will be removed in 3.0.', E_USER_DEPRECATED);
use Symfony\Component\Finder\Adapter\AdapterInterface;
/**
* Base exception for all adapter failures.
*
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since 2.8, to be removed in 3.0.
*/
class AdapterFailureException extends \RuntimeException implements ExceptionInterface
{

4
src/Symfony/Component/Finder/Exception/OperationNotPermitedException.php
View File

@ -11,8 +11,12 @@
namespace Symfony\Component\Finder\Exception;
@trigger_error('The '.__NAMESPACE__.'\OperationNotPermitedException class is deprecated since version 2.8 and will be removed in 3.0.', E_USER_DEPRECATED);
/**
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since 2.8, to be removed in 3.0.
*/
class OperationNotPermitedException extends AdapterFailureException
{

4
src/Symfony/Component/Finder/Exception/ShellCommandFailureException.php
View File

@ -11,11 +11,15 @@
namespace Symfony\Component\Finder\Exception;
@trigger_error('The '.__NAMESPACE__.'\ShellCommandFailureException class is deprecated since version 2.8 and will be removed in 3.0.', E_USER_DEPRECATED);
use Symfony\Component\Finder\Adapter\AdapterInterface;
use Symfony\Component\Finder\Shell\Command;
/**
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since 2.8, to be removed in 3.0.
*/
class ShellCommandFailureException extends AdapterFailureException
{

143
src/Symfony/Component/Finder/Finder.php
View File

@ -62,7 +62,7 @@ class Finder implements \IteratorAggregate, \Countable
private $iterators = array();
private $contains = array();
private $notContains = array();
private $adapters = array();
private $adapters = null;
private $paths = array();
private $notPaths = array();
private $ignoreUnreadableDirs = false;
@ -75,13 +75,6 @@ class Finder implements \IteratorAggregate, \Countable
public function __construct()
{
$this->ignore = static::IGNORE_VCS_FILES | static::IGNORE_DOT_FILES;
$this
->addAdapter(new GnuFindAdapter())
->addAdapter(new BsdFindAdapter())
->addAdapter(new PhpAdapter(), -50)
->setAdapter('php')
;
}
/**
@ -103,9 +96,15 @@ class Finder implements \IteratorAggregate, \Countable
* @param int $priority Highest is selected first
*
* @return Finder The current Finder instance
*
* @deprecated since 2.8, to be removed in 3.0.
*/
public function addAdapter(AdapterInterface $adapter, $priority = 0)
{
@trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0.', E_USER_DEPRECATED);
$this->initDefaultAdapters();
$this->adapters[$adapter->getName()] = array(
'adapter' => $adapter,
'priority' => $priority,
@ -119,9 +118,15 @@ class Finder implements \IteratorAggregate, \Countable
* Sets the selected adapter to the best one according to the current platform the code is run on.
*
* @return Finder The current Finder instance
*
* @deprecated since 2.8, to be removed in 3.0.
*/
public function useBestAdapter()
{
@trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0.', E_USER_DEPRECATED);
$this->initDefaultAdapters();
$this->resetAdapterSelection();
return $this->sortAdapters();
@ -135,9 +140,15 @@ class Finder implements \IteratorAggregate, \Countable
* @throws \InvalidArgumentException
*
* @return Finder The current Finder instance
*
* @deprecated since 2.8, to be removed in 3.0.
*/
public function setAdapter($name)
{
@trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0.', E_USER_DEPRECATED);
$this->initDefaultAdapters();
if (!isset($this->adapters[$name])) {
throw new \InvalidArgumentException(sprintf('Adapter "%s" does not exist.', $name));
}
@ -152,9 +163,13 @@ class Finder implements \IteratorAggregate, \Countable
* Removes all adapters registered in the finder.
*
* @return Finder The current Finder instance
*
* @deprecated since 2.8, to be removed in 3.0.
*/
public function removeAdapters()
{
@trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0.', E_USER_DEPRECATED);
$this->adapters = array();
return $this;
@ -164,9 +179,15 @@ class Finder implements \IteratorAggregate, \Countable
* Returns registered adapters ordered by priority without extra information.
*
* @return AdapterInterface[]
*
* @deprecated since 2.8, to be removed in 3.0.
*/
public function getAdapters()
{
@trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0.', E_USER_DEPRECATED);
$this->initDefaultAdapters();
return array_values(array_map(function (array $adapter) {
return $adapter['adapter'];
}, $this->adapters));
@ -774,8 +795,6 @@ class Finder implements \IteratorAggregate, \Countable
* @param $dir
*
* @return \Iterator
*
* @throws \RuntimeException When none of the adapters are supported
*/
private function searchInDirectory($dir)
{
@ -787,18 +806,93 @@ class Finder implements \IteratorAggregate, \Countable
$this->notPaths[] = '#(^|/)\..+(/|$)#';
}
foreach ($this->adapters as $adapter) {
if ($adapter['adapter']->isSupported()) {
try {
return $this
->buildAdapter($adapter['adapter'])
->searchInDirectory($dir);
} catch (ExceptionInterface $e) {
if ($this->adapters) {
foreach ($this->adapters as $adapter) {
if ($adapter['adapter']->isSupported()) {
try {
return $this
->buildAdapter($adapter['adapter'])
->searchInDirectory($dir);
} catch (ExceptionInterface $e) {
}
}
}
}
throw new \RuntimeException('No supported adapter found.');
$minDepth = 0;
$maxDepth = PHP_INT_MAX;
foreach ($this->depths as $comparator) {
switch ($comparator->getOperator()) {
case '>':
$minDepth = $comparator->getTarget() + 1;
break;
case '>=':
$minDepth = $comparator->getTarget();
break;
case '<':
$maxDepth = $comparator->getTarget() - 1;
break;
case '<=':
$maxDepth = $comparator->getTarget();
break;
default:
$minDepth = $maxDepth = $comparator->getTarget();
}
}
$flags = \RecursiveDirectoryIterator::SKIP_DOTS;
if ($this->followLinks) {
$flags |= \RecursiveDirectoryIterator::FOLLOW_SYMLINKS;
}
$iterator = new Iterator\RecursiveDirectoryIterator($dir, $flags, $this->ignoreUnreadableDirs);
if ($this->exclude) {
$iterator = new Iterator\ExcludeDirectoryFilterIterator($iterator, $this->exclude);
}
$iterator = new \RecursiveIteratorIterator($iterator, \RecursiveIteratorIterator::SELF_FIRST);
if ($minDepth > 0 || $maxDepth < PHP_INT_MAX) {
$iterator = new Iterator\DepthRangeFilterIterator($iterator, $minDepth, $maxDepth);
}
if ($this->mode) {
$iterator = new Iterator\FileTypeFilterIterator($iterator, $this->mode);
}
if ($this->names || $this->notNames) {
$iterator = new Iterator\FilenameFilterIterator($iterator, $this->names, $this->notNames);
}
if ($this->contains || $this->notContains) {
$iterator = new Iterator\FilecontentFilterIterator($iterator, $this->contains, $this->notContains);
}
if ($this->sizes) {
$iterator = new Iterator\SizeRangeFilterIterator($iterator, $this->sizes);
}
if ($this->dates) {
$iterator = new Iterator\DateRangeFilterIterator($iterator, $this->dates);
}
if ($this->filters) {
$iterator = new Iterator\CustomFilterIterator($iterator, $this->filters);
}
if ($this->paths || $this->notPaths) {
$iterator = new Iterator\PathFilterIterator($iterator, $this->paths, $this->notPaths);
}
if ($this->sort) {
$iteratorAggregate = new Iterator\SortableIterator($iterator, $this->sort);
$iterator = $iteratorAggregate->getIterator();
}
return $iterator;
}
/**
@ -837,4 +931,17 @@ class Finder implements \IteratorAggregate, \Countable
return $properties;
}, $this->adapters);
}
private function initDefaultAdapters()
{
if (null === $this->adapters) {
$this->adapters = array();
$this
->addAdapter(new GnuFindAdapter())
->addAdapter(new BsdFindAdapter())
->addAdapter(new PhpAdapter(), -50)
->setAdapter('php')
;
}
}
}

4
src/Symfony/Component/Finder/Iterator/FilePathsIterator.php
View File

@ -11,12 +11,16 @@
namespace Symfony\Component\Finder\Iterator;
@trigger_error('The '.__NAMESPACE__.'\FilePathsIterator class is deprecated since version 2.8 and will be removed in 3.0.', E_USER_DEPRECATED);
use Symfony\Component\Finder\SplFileInfo;
/**
* Iterate over shell command result.
*
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since 2.8, to be removed in 3.0.
*/
class FilePathsIterator extends \ArrayIterator
{

4
src/Symfony/Component/Finder/Shell/Command.php
View File

@ -11,8 +11,12 @@
namespace Symfony\Component\Finder\Shell;
@trigger_error('The '.__NAMESPACE__.'\Command class is deprecated since version 2.8 and will be removed in 3.0.', E_USER_DEPRECATED);
/**
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since 2.8, to be removed in 3.0.
*/
class Command
{

4
src/Symfony/Component/Finder/Shell/Shell.php
View File

@ -11,8 +11,12 @@
namespace Symfony\Component\Finder\Shell;
@trigger_error('The '.__NAMESPACE__.'\Shell class is deprecated since version 2.8 and will be removed in 3.0.', E_USER_DEPRECATED);
/**
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since 2.8, to be removed in 3.0.
*/
class Shell
{

10
src/Symfony/Component/Finder/Tests/BsdFinderTest.php
View File

@ -12,10 +12,14 @@
namespace Symfony\Component\Finder\Tests;
use Symfony\Component\Finder\Adapter\BsdFindAdapter;
use Symfony\Component\Finder\Finder;
/**
* @group legacy
*/
class BsdFinderTest extends FinderTest
{
protected function getAdapter()
protected function buildFinder()
{
$adapter = new BsdFindAdapter();
@ -23,6 +27,8 @@ class BsdFinderTest extends FinderTest
$this->markTestSkipped(get_class($adapter).' is not supported.');
}
return $adapter;
return Finder::create()
->removeAdapters()
->addAdapter($adapter);
}
}

24
src/Symfony/Component/Finder/Tests/FinderTest.php
View File

@ -248,6 +248,7 @@ class FinderTest extends Iterator\RealIteratorTestCase
__DIR__.DIRECTORY_SEPARATOR.'BsdFinderTest.php',
__DIR__.DIRECTORY_SEPARATOR.'FinderTest.php',
__DIR__.DIRECTORY_SEPARATOR.'GnuFinderTest.php',
__DIR__.DIRECTORY_SEPARATOR.'PhpFinderTest.php',
__DIR__.DIRECTORY_SEPARATOR.'GlobTest.php',
);
@ -531,6 +532,9 @@ class FinderTest extends Iterator\RealIteratorTestCase
$this->assertIterator($this->toAbsoluteFixtures($expected), $finder);
}
/**
* @group legacy
*/
public function testAdaptersOrdering()
{
$finder = Finder::create()
@ -549,6 +553,9 @@ class FinderTest extends Iterator\RealIteratorTestCase
);
}
/**
* @group legacy
*/
public function testAdaptersChaining()
{
$iterator = new \ArrayIterator(array());
@ -603,6 +610,9 @@ class FinderTest extends Iterator\RealIteratorTestCase
$this->assertIterator($this->toAbsoluteFixtures($expected), $finder);
}
/**
* @group legacy
*/
public function testAdapterSelection()
{
// test that by default, PhpAdapter is selected
@ -725,18 +735,8 @@ class FinderTest extends Iterator\RealIteratorTestCase
}
}
/**
* @return AdapterInterface
*/
protected function getAdapter()
protected function buildFinder()
{
return new PhpAdapter();
}
private function buildFinder()
{
return Finder::create()
->removeAdapters()
->addAdapter($this->getAdapter());
return Finder::create();
}
}

10
src/Symfony/Component/Finder/Tests/GnuFinderTest.php
View File

@ -12,10 +12,14 @@
namespace Symfony\Component\Finder\Tests;
use Symfony\Component\Finder\Adapter\GnuFindAdapter;
use Symfony\Component\Finder\Finder;
/**
* @group legacy
*/
class GnuFinderTest extends FinderTest
{
protected function getAdapter()
protected function buildFinder()
{
$adapter = new GnuFindAdapter();
@ -23,6 +27,8 @@ class GnuFinderTest extends FinderTest
$this->markTestSkipped(get_class($adapter).' is not supported.');
}
return $adapter;
return Finder::create()
->removeAdapters()
->addAdapter($adapter);
}
}

3
src/Symfony/Component/Finder/Tests/Iterator/FilePathsIteratorTest.php
View File

@ -13,6 +13,9 @@ namespace Symfony\Component\Finder\Tests\Iterator;
use Symfony\Component\Finder\Iterator\FilePathsIterator;
/**
* @group legacy
*/
class FilePathsIteratorTest extends RealIteratorTestCase
{
/**

45
src/Symfony/Component/Finder/Tests/PhpFinderTest.php Normal file
View File

@ -0,0 +1,45 @@
<?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\Tests;
use Symfony\Component\Finder\Adapter\PhpAdapter;
use Symfony\Component\Finder\Finder;
/**
* @group legacy
*/
class PhpFinderTest extends FinderTest
{
public function testImplementationsAreSynchronized()
{
$adapterReflector = new \ReflectionMethod('Symfony\Component\Finder\Adapter\PhpAdapter', 'searchInDirectory');
$finderReflector = new \ReflectionMethod('Symfony\Component\Finder\Finder', 'searchInDirectory');
$adapterSource = array_slice(file($adapterReflector->getFileName()), $adapterReflector->getStartLine() + 1, $adapterReflector->getEndLine() - $adapterReflector->getStartLine() - 1);
$adapterSource = implode('', $adapterSource);
$adapterSource = str_replace(array('$this->minDepth', '$this->maxDepth'), array('$minDepth', '$maxDepth'), $adapterSource);
$finderSource = array_slice(file($finderReflector->getFileName()), $finderReflector->getStartLine() + 1, $finderReflector->getEndLine() - $finderReflector->getStartLine() - 1);
$finderSource = implode('', $finderSource);
$this->assertStringEndsWith($adapterSource, $finderSource);
}
protected function buildFinder()
{
$adapter = new PhpAdapter();
return Finder::create()
->removeAdapters()
->addAdapter($adapter);
}
}

3
src/Symfony/Component/Finder/Tests/Shell/CommandTest.php
View File

@ -13,6 +13,9 @@ namespace Symfony\Component\Finder\Tests\Shell;
use Symfony\Component\Finder\Shell\Command;
/**
* @group legacy
*/
class CommandTest extends \PHPUnit_Framework_TestCase
{
public function testCreate()