Merge pull request #132 from jaapio/feature/single-type-arguments

Arguments are now single typed

Author: jaapio

phive.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-  <phar name="phpstan" version="^0.9.1" installed="0.10.2" location="./tools/phpstan" copy="true"/>
-  <phar name="phpunit" version="^6.0" installed="6.5.5" location="./tools/phpunit" copy="true"/>
+  <phar name="phpstan" version="^0.9.1" installed="0.10.7" location="./tools/phpstan" copy="true"/>
+  <phar name="phpunit" version="^6.0" installed="6.5.13" location="./tools/phpunit" copy="true"/>
 </phive>

phpstan.neon

@@ -1,5 +1,7 @@
 parameters:
     ignoreErrors:
+
+        - '#Method phpDocumentor\\Reflection\\File\\LocalFile::\md5\(\) should return string but returns string\|false\.#'
         #
         # all these $fqsen errors indicate the need for a decorator class around PhpParser\Node to hold the public $fqsen that Reflection is giving it)
         #

src/phpDocumentor/Reflection/File/LocalFile.php

@@ -32,6 +32,10 @@ final class LocalFile implements File
      */
     public function __construct(string $path)
     {
+        if (!file_exists($path)) {
+            throw new \InvalidArgumentException(sprintf('File "%s" does not exist', $path));
+        }
+
         $this->path = $path;
     }
 

src/phpDocumentor/Reflection/Php/Argument.php

@@ -14,6 +14,9 @@
 
 namespace phpDocumentor\Reflection\Php;
 
+use phpDocumentor\Reflection\Type;
+use phpDocumentor\Reflection\Types\Mixed_;
+
 /**
  * Descriptor representing a single Argument of a method or function.
  */
@@ -22,37 +25,42 @@ final class Argument
     /**
      * @var string name of the Argument
      */
-    private $name = null;
+    private $name;
 
     /**
-     * @var mixed[] an array of normalized types that should be in this Argument
+     * @var Type a normalized type that should be in this Argument
      */
-    private $types = [];
+    private $type;
 
     /**
      * @var string|null the default value for an argument or null if none is provided
      */
-    private $default = null;
+    private $default;
 
     /**
      * @var bool whether the argument passes the parameter by reference instead of by value
      */
-    private $byReference = false;
+    private $byReference;
 
     /**
      * @var boolean Determines if this Argument represents a variadic argument
      */
-    private $isVariadic = false;
+    private $isVariadic;
 
     /**
      * Initializes the object.
      */
-    public function __construct(string $name, ?string $default = null, bool $byReference = false, bool $isVariadic = false)
+    public function __construct(string $name, ?Type $type = null, ?string $default = null, bool $byReference = false, bool $isVariadic = false)
     {
         $this->name = $name;
         $this->default = $default;
         $this->byReference = $byReference;
         $this->isVariadic = $isVariadic;
+        if ($type === null) {
+            $type = new Mixed_();
+        }
+
+        $this->type = $type;
     }
 
     /**
@@ -63,21 +71,9 @@ public function getName(): string
         return $this->name;
     }
 
-    /**
-     * @return mixed[]
-     */
-    public function getTypes(): array
-    {
-        return $this->types;
-    }
-
-    /**
-     * Add a type.
-     * @param mixed $type
-     */
-    public function addType($type): void
+    public function getType(): ?Type
     {
-        $this->types[] = $type;
+        return $this->type;
     }
 
     public function getDefault(): ?string

src/phpDocumentor/Reflection/Php/Factory/Argument.php

@@ -71,13 +71,12 @@ protected function doCreate($object, StrategyContainer $strategies, ?Context $co
             $default = $this->valueConverter->prettyPrintExpr($object->default);
         }
 
-        $argumentDescriptor = new ArgumentDescriptor((string) $object->var->name, $default, $object->byRef, $object->variadic);
-
+        $type = null;
         if (!empty($object->type)) {
-            $argumentDescriptor->addType($this->createType($object));
+            $type = $this->createType($object);
         }
 
-        return $argumentDescriptor;
+        return new ArgumentDescriptor((string) $object->var->name, $type, $default, $object->byRef, $object->variadic);
     }
 
     private function createType(Param $arg, ?Context $context = null): Type

tests/component/ProjectCreationTest.php

@@ -105,7 +105,7 @@ public function testWithNamespacedClass()
         );
 
         $this->assertEquals('style', $methods['\\Luigi\\Pizza::__construct()']->getArguments()[0]->getName());
-        $this->assertEquals([new Object_(new Fqsen('\\Luigi\\Pizza\Style'))], $methods['\\Luigi\\Pizza::__construct()']->getArguments()[0]->getTypes());
+        $this->assertEquals(new Object_(new Fqsen('\\Luigi\\Pizza\Style')), $methods['\\Luigi\\Pizza::__construct()']->getArguments()[0]->getType());
     }
 
     public function testDocblockOfMethodIsProcessed()

tests/unit/phpDocumentor/Reflection/File/LocalFileTest.php

@@ -38,6 +38,15 @@ public function testMd5()
         $this->assertEquals(md5_file(__FILE__), $file->md5());
     }
 
+    /**
+     * @covers ::__construct
+     * @expectedException \InvalidArgumentException
+     */
+    public function testNotExistingFileThrowsException()
+    {
+        new LocalFile('aa');
+    }
+
     /**
      * @covers ::path
      */

tests/unit/phpDocumentor/Reflection/Php/ArgumentTest.php

@@ -12,26 +12,32 @@
 
 namespace phpDocumentor\Reflection\Php;
 
+use phpDocumentor\Reflection\Types\Mixed_;
+use phpDocumentor\Reflection\Types\String_;
 use PHPUnit\Framework\TestCase;
 
 /**
  * Tests the functionality for the Argument class.
- * @coversDefaultClass phpDocumentor\Reflection\Php\Argument
+ * @coversDefaultClass \phpDocumentor\Reflection\Php\Argument
  */
 class ArgumentTest extends TestCase
 {
     /**
-     * @covers ::getTypes
-     * @covers ::addType
+     * @covers ::getType
      */
     public function testGetTypes()
     {
-        $argument = new Argument('myArgument', 'myDefaultValue', true, true);
-        $this->assertSame([], $argument->getTypes());
+        $argument = new Argument('myArgument', null, 'myDefaultValue', true, true);
+        $this->assertInstanceOf(Mixed_::class, $argument->getType());
 
-        $argument->addType(1);
-
-        $this->assertSame([1], $argument->getTypes());
+        $argument = new Argument(
+            'myArgument',
+            new String_(),
+            'myDefaultValue',
+            true,
+            true
+        );
+        $this->assertEquals(new String_(), $argument->getType());
     }
 
     /**
@@ -50,10 +56,10 @@ public function testGetName()
      */
     public function testGetDefault()
     {
-        $argument = new Argument('myArgument', 'myDefaultValue', true, true);
+        $argument = new Argument('myArgument', null, 'myDefaultValue', true, true);
         $this->assertEquals('myDefaultValue', $argument->getDefault());
 
-        $argument = new Argument('myArgument', null, true, true);
+        $argument = new Argument('myArgument', null, null, true, true);
         $this->assertNull($argument->getDefault());
     }
 
@@ -63,10 +69,10 @@ public function testGetDefault()
      */
     public function testGetWhetherArgumentIsPassedByReference()
     {
-        $argument = new Argument('myArgument', 'myDefaultValue', true, true);
+        $argument = new Argument('myArgument', null, 'myDefaultValue', true, true);
         $this->assertTrue($argument->isByReference());
 
-        $argument = new Argument('myArgument', null, false, true);
+        $argument = new Argument('myArgument', null, null, false, true);
         $this->assertFalse($argument->isByReference());
     }
 
@@ -76,10 +82,10 @@ public function testGetWhetherArgumentIsPassedByReference()
      */
     public function testGetWhetherArgumentisVariadic()
     {
-        $argument = new Argument('myArgument', 'myDefaultValue', true, true);
+        $argument = new Argument('myArgument', null, 'myDefaultValue', true, true);
         $this->assertTrue($argument->isVariadic());
 
-        $argument = new Argument('myArgument', 'myDefaultValue', true, false);
+        $argument = new Argument('myArgument', null, 'myDefaultValue', true, false);
         $this->assertFalse($argument->isVariadic());
     }
 }