Replace Zend\Filter with a custom SimpleFilter

Author: mvriel

composer.json

@@ -15,7 +15,6 @@
         "nikic/php-parser":                  "~1.0",
         "phpdocumentor/reflection-docblock": "~2.0",
         "symfony/validator":                 "~2.2",
-        "zendframework/zend-filter":         "~2.1",
         "symfony/filesystem":                "~2.3"
     },
     "suggests": {

composer.lock

@@ -11,27 +11,27 @@
 
 namespace phpDocumentor\Descriptor\Filter;
 
-use Zend\Filter\FilterChain;
+use phpDocumentor\SimpleFilter\Chain;
 
 /**
  * Retrieves a series of filters to manipulate a specific Descriptor with during building.
  */
 class ClassFactory
 {
-    /** @var FilterChain[]  */
+    /** @var Chain[]  */
     protected $chains = array();
 
     /**
      * Retrieves the filters for a class with a given FQCN.
      *
      * @param string $fqcn
      *
-     * @return FilterChain
+     * @return Chain
      */
     public function getChainFor($fqcn)
     {
         if (!isset($this->chains[$fqcn])) {
-            $this->chains[$fqcn] = new FilterChain();
+            $this->chains[$fqcn] = new Chain();
         }
 
         return $this->chains[$fqcn];

src/phpDocumentor/Descriptor/Filter/ClassFactory.php

@@ -10,8 +10,7 @@
  */
 
 namespace phpDocumentor\Descriptor\Filter;
-
-use Zend\Filter\FilterInterface;
+use phpDocumentor\SimpleFilter\FilterInterface;
 
 /**
  * Filter used to manipulate a descriptor after being build.
@@ -46,7 +45,7 @@ public function __construct($factory)
      *
      * @return void
      */
-    public function attach($fqcn, $filter, $priority = self::DEFAULT_PRIORITY)
+    public function attach($fqcn, FilterInterface $filter, $priority = self::DEFAULT_PRIORITY)
     {
         $chain = $this->factory->getChainFor($fqcn);
         $chain->attach($filter, $priority);

src/phpDocumentor/Descriptor/Filter/Filter.php

@@ -13,12 +13,12 @@
 
 use phpDocumentor\Descriptor\DescriptorAbstract;
 use phpDocumentor\Descriptor\Analyzer;
-use Zend\Filter\AbstractFilter;
+use phpDocumentor\SimpleFilter\FilterInterface;
 
 /**
  * Strips any Descriptor if the ignore tag is present with that element.
  */
-class StripIgnore extends AbstractFilter
+class StripIgnore implements FilterInterface
 {
     /** @var Analyzer $analyzer */
     protected $analyzer;

src/phpDocumentor/Descriptor/Filter/StripIgnore.php

@@ -14,7 +14,7 @@
 use phpDocumentor\Descriptor\DescriptorAbstract;
 use phpDocumentor\Descriptor\ProjectDescriptor\Settings;
 use phpDocumentor\Descriptor\Analyzer;
-use Zend\Filter\AbstractFilter;
+use phpDocumentor\SimpleFilter\FilterInterface;
 
 /**
  * Filters a Descriptor when the @internal inline tag, or normal tag, is used.
@@ -27,7 +27,7 @@
  *
  * @link http://www.phpdoc.org/docs/latest/for-users/phpdoc/tags/internal.html
  */
-class StripInternal extends AbstractFilter
+class StripInternal implements FilterInterface
 {
     /** @var Analyzer $analyzer */
     protected $analyzer;

src/phpDocumentor/Descriptor/Filter/StripInternal.php

@@ -14,12 +14,12 @@
 use phpDocumentor\Descriptor\DescriptorAbstract;
 use phpDocumentor\Descriptor\Interfaces\VisibilityInterface;
 use phpDocumentor\Descriptor\Analyzer;
-use Zend\Filter\AbstractFilter;
+use phpDocumentor\SimpleFilter\FilterInterface;
 
 /**
  * Strips any Descriptor if their visibility is allowed according to the Analyzer.
  */
-class StripOnVisibility extends AbstractFilter
+class StripOnVisibility implements FilterInterface
 {
     /** @var Analyzer $analyzer */
     protected $analyzer;

src/phpDocumentor/Descriptor/Filter/StripOnVisibility.php

@@ -16,6 +16,8 @@
  */
 final class Chain implements FilterInterface, \Countable, \IteratorAggregate
 {
+    const DEFAULT_PRIORITY = 1000;
+
     /** @var \SplPriorityQueue  */
     private $innerQueue;
 
@@ -38,7 +40,7 @@ public function __construct()
      *
      * @return $this
      */
-    public function attach($filter, $priority = 1000)
+    public function attach($filter, $priority = self::DEFAULT_PRIORITY)
     {
         if ($filter instanceof FilterInterface) {
             $filter = array($filter, 'filter');

src/phpDocumentor/SimpleFilter/Chain.php

@@ -34,6 +34,6 @@ public function testGetChainForReturnsInstanceOfFilterChain()
     {
         $filterChain = $this->fixture->getChainFor('foo');
 
-        $this->assertInstanceOf('Zend\Filter\FilterChain', $filterChain);
+        $this->assertInstanceOf('phpDocumentor\SimpleFilter\Chain', $filterChain);
     }
 }

tests/unit/phpDocumentor/Descriptor/Filter/ClassFactoryTest.php

@@ -12,11 +12,10 @@
 namespace phpDocumentor\Descriptor\Filter;
 
 use \Mockery as m;
-use \Zend\Filter\FilterChain;
+use phpDocumentor\SimpleFilter\Chain;
 
 /**
  * Tests the functionality for the Filter class.
- * @group broken
  */
 class FilterTest extends \PHPUnit_Framework_TestCase
 {
@@ -25,8 +24,8 @@ class FilterTest extends \PHPUnit_Framework_TestCase
     /** @var ClassFactory|m\Mock */
     protected $classFactoryMock;
 
-    /** @var FilterChain|m\Mock */
-    protected $filterChainMock;
+    /** @var Chain|m\Mock */
+    protected $chainMock;
 
     /** @var Filter $fixture */
     protected $fixture;
@@ -37,7 +36,7 @@ class FilterTest extends \PHPUnit_Framework_TestCase
     protected function setUp()
     {
         $this->classFactoryMock = m::mock('phpDocumentor\Descriptor\Filter\ClassFactory');
-        $this->filterChainMock  = m::mock('Zend\Filter\FilterChain');
+        $this->chainMock        = m::mock(new Chain());
         $this->fixture          = new Filter($this->classFactoryMock);
     }
 
@@ -54,10 +53,10 @@ public function testClassFactoryIsSetUponConstruction()
      */
     public function testAttach()
     {
-        $filterMock = m::mock('Zend\Filter\FilterInterface');
+        $filterMock = m::mock('phpDocumentor\SimpleFilter\FilterInterface');
 
-        $this->filterChainMock->shouldReceive('attach')->with($filterMock, FilterChain::DEFAULT_PRIORITY);
-        $this->classFactoryMock->shouldReceive('getChainFor')->with(self::FQCN)->andReturn($this->filterChainMock);
+        $this->chainMock->shouldReceive('attach')->with($filterMock, Chain::DEFAULT_PRIORITY);
+        $this->classFactoryMock->shouldReceive('getChainFor')->with(self::FQCN)->andReturn($this->chainMock);
 
         $this->fixture->attach(self::FQCN, $filterMock);
     }
@@ -69,9 +68,9 @@ public function testFilter()
     {
         $filterableMock = m::mock('phpDocumentor\Descriptor\Filter\Filterable');
 
-        $this->filterChainMock->shouldReceive('filter')->with($filterableMock)->andReturn($filterableMock);
+        $this->chainMock->shouldReceive('filter')->with($filterableMock)->andReturn($filterableMock);
         $this->classFactoryMock
-            ->shouldReceive('getChainFor')->with(get_class($filterableMock))->andReturn($this->filterChainMock);
+            ->shouldReceive('getChainFor')->with(get_class($filterableMock))->andReturn($this->chainMock);
 
         $this->assertSame($filterableMock, $this->fixture->filter($filterableMock));
     }