Moved and renamed resolvers, started on README

Author: mvriel

README.md

@@ -0,0 +1,14 @@
+TypeResolver and FqsenResolver
+==============================
+
+The specification on types in DocBlocks (PSR-5) describes various keywords and special constructs
+but also how to statically resolve the partial name of a Class into a Fully Qualified Class Name (FQCN).
+
+PSR-5 also introduces an additional way to describe deeper elements than Classes, Interfaces and Traits 
+called the Fully Qualified Structural Element Name (FQSEN). Using this it is possible to refer to methods,
+properties and class constants but also functions and global constants.
+
+This package provides two Resolvers that are capable of 
+
+1. determining the Type of a given expression and/or resolve any class names, and 
+2. resolve any partial Structural Element Names into Fully Qualified Structural Element names

src/FqsenFactory.php renamed to src/FqsenResolver.php

@@ -14,7 +14,7 @@
 
 use phpDocumentor\Reflection\Types\Context;
 
-class FqsenFactory
+class FqsenResolver
 {
     /** @var string Definition of the NAMESPACE operator in PHP */
     const OPERATOR_NAMESPACE = '\\';

src/Types/Resolver.php renamed to src/TypeResolver.php

@@ -10,12 +10,14 @@
  * @link      http://phpdoc.org
  */
 
-namespace phpDocumentor\Reflection\Types;
+namespace phpDocumentor\Reflection;
 
-use phpDocumentor\Reflection\FqsenFactory;
-use phpDocumentor\Reflection\Type;
+use phpDocumentor\Reflection\Types\Array_;
+use phpDocumentor\Reflection\Types\Compound;
+use phpDocumentor\Reflection\Types\Context;
+use phpDocumentor\Reflection\Types\Object_;
 
-final class Resolver
+final class TypeResolver
 {
     /** @var string Definition of the ARRAY operator for types */
     const OPERATOR_ARRAY = '[]';
@@ -48,17 +50,17 @@ final class Resolver
         'static' => 'phpDocumentor\Reflection\Types\Static_'
     );
 
-    /** @var FqsenFactory */
-    private $fqsenFactory;
+    /** @var FqsenResolver */
+    private $fqsenResolver;
 
     /**
      * Initializes this TypeResolver with the means to create and resolve Fqsen objects.
      *
-     * @param FqsenFactory $fqsenFactory
+     * @param FqsenResolver $fqsenResolver
      */
-    public function __construct(FqsenFactory $fqsenFactory = null)
+    public function __construct(FqsenResolver $fqsenResolver = null)
     {
-        $this->fqsenFactory = $fqsenFactory ?: new FqsenFactory();
+        $this->fqsenResolver = $fqsenResolver ?: new FqsenResolver();
     }
 
     /**
@@ -136,7 +138,7 @@ public function resolveFqsen($fqsen, Context $context = null)
             throw new \InvalidArgumentException('Attempted to resolve "' . $fqsen . '" but it appears to be empty');
         }
 
-        return $this->fqsenFactory->create($fqsen, $context);
+        return $this->fqsenResolver->create($fqsen, $context);
     }
     /**
      * Adds a keyword to the list of Keywords and associates it with a specific Value Object.
@@ -260,7 +262,7 @@ private function resolveKeyword($type)
      */
     private function resolveTypedObject($type, Context $context = null)
     {
-        return new Object_($this->fqsenFactory->create($type, $context));
+        return new Object_($this->fqsenResolver->create($type, $context));
     }
 
     /**
@@ -274,7 +276,7 @@ private function resolveTypedObject($type, Context $context = null)
      */
     private function resolvePartialStructuralElementName($type, Context $context = null)
     {
-        return new Object_($this->fqsenFactory->create($type, $context));
+        return new Object_($this->fqsenResolver->create($type, $context));
     }
 
     /**

tests/unit/Types/ResolverTest.php renamed to tests/unit/TypeResolverTest.php

@@ -10,15 +10,18 @@
  * @link      http://phpdoc.org
  */
 
-namespace phpDocumentor\Reflection\Types;
+namespace phpDocumentor\Reflection;
 
 use Mockery as m;
-use phpDocumentor\Reflection\Type;
+use phpDocumentor\Reflection\Types\Array_;
+use phpDocumentor\Reflection\Types\Compound;
+use phpDocumentor\Reflection\Types\Context;
+use phpDocumentor\Reflection\Types\Object_;
 
 /**
- * @coversDefaultClass phpDocumentor\Reflection\Types\Resolver
+ * @coversDefaultClass phpDocumentor\Reflection\TypeResolver
  */
-class ResolverTest extends \PHPUnit_Framework_TestCase
+class TypeResolverTest extends \PHPUnit_Framework_TestCase
 {
     /**
      * @param string $keyword
@@ -35,7 +38,7 @@ class ResolverTest extends \PHPUnit_Framework_TestCase
      */
     public function testResolvingKeywords($keyword, $expectedClass)
     {
-        $fixture = new Resolver();
+        $fixture = new TypeResolver();
 
         $resolvedType = $fixture->resolveType($keyword, new Context(''));
 
@@ -56,7 +59,7 @@ public function testResolvingKeywords($keyword, $expectedClass)
      */
     public function testResolvingFQSENs($fqsen)
     {
-        $fixture = new Resolver();
+        $fixture = new TypeResolver();
 
         /** @var Object_ $resolvedType */
         $resolvedType = $fixture->resolveType($fqsen, new Context(''));
@@ -77,7 +80,7 @@ public function testResolvingFQSENs($fqsen)
      */
     public function testResolvingRelativeQSENsBasedOnNamespace()
     {
-        $fixture = new Resolver();
+        $fixture = new TypeResolver();
 
         /** @var Object_ $resolvedType */
         $resolvedType = $fixture->resolveType('DocBlock', new Context('phpDocumentor\Reflection'));
@@ -97,7 +100,7 @@ public function testResolvingRelativeQSENsBasedOnNamespace()
      */
     public function testResolvingRelativeQSENsBasedOnNamespaceAlias()
     {
-        $fixture = new Resolver();
+        $fixture = new TypeResolver();
 
         /** @var Object_ $resolvedType */
         $resolvedType = $fixture->resolveType(
@@ -120,7 +123,7 @@ public function testResolvingRelativeQSENsBasedOnNamespaceAlias()
      */
     public function testResolvingTypedArrays()
     {
-        $fixture = new Resolver();
+        $fixture = new TypeResolver();
 
         /** @var Array_ $resolvedType */
         $resolvedType = $fixture->resolveType('string[]', new Context(''));
@@ -141,7 +144,7 @@ public function testResolvingTypedArrays()
      */
     public function testResolvingNestedTypedArrays()
     {
-        $fixture = new Resolver();
+        $fixture = new TypeResolver();
 
         /** @var Array_ $resolvedType */
         $resolvedType = $fixture->resolveType('string[][]', new Context(''));
@@ -172,7 +175,7 @@ public function testResolvingNestedTypedArrays()
      */
     public function testResolvingCompoundTypes()
     {
-        $fixture = new Resolver();
+        $fixture = new TypeResolver();
 
         /** @var Compound $resolvedType */
         $resolvedType = $fixture->resolveType('string|Reflection\DocBlock', new Context('phpDocumentor'));
@@ -210,7 +213,7 @@ public function testResolvingCompoundTypes()
      */
     public function testResolvingCompoundTypesWithTwoArrays()
     {
-        $fixture = new Resolver();
+        $fixture = new TypeResolver();
 
         /** @var Compound $resolvedType */
         $resolvedType = $fixture->resolveType('integer[]|string[]', new Context(''));
@@ -242,7 +245,7 @@ public function testAddingAKeyword()
         $typeMock = m::mock(Type::class);
 
         // Act
-        $fixture = new Resolver();
+        $fixture = new TypeResolver();
         $fixture->addKeyword('mock', get_class($typeMock));
 
         // Assert
@@ -258,7 +261,7 @@ public function testAddingAKeyword()
      */
     public function testAddingAKeywordFailsIfTypeClassDoesNotExist()
     {
-        $fixture = new Resolver();
+        $fixture = new TypeResolver();
         $fixture->addKeyword('mock', 'IDoNotExist');
     }
 
@@ -269,7 +272,7 @@ public function testAddingAKeywordFailsIfTypeClassDoesNotExist()
      */
     public function testAddingAKeywordFailsIfTypeClassDoesNotImplementTypeInterface()
     {
-        $fixture = new Resolver();
+        $fixture = new TypeResolver();
         $fixture->addKeyword('mock', 'stdClass');
     }
 
@@ -281,7 +284,7 @@ public function testAddingAKeywordFailsIfTypeClassDoesNotImplementTypeInterface(
      */
     public function testExceptionIsThrownIfTypeIsEmpty()
     {
-        $fixture = new Resolver();
+        $fixture = new TypeResolver();
         $fixture->resolveType(' ', new Context(''));
     }
 
@@ -293,7 +296,7 @@ public function testExceptionIsThrownIfTypeIsEmpty()
      */
     public function testExceptionIsThrownIfTypeIsNotAString()
     {
-        $fixture = new Resolver();
+        $fixture = new TypeResolver();
         $fixture->resolveType(['a'], new Context(''));
     }