Merge pull request #11 from MontealegreLuis/relative_names

Support for relative names in DocBlocks

.github/workflows/publish.yml

@@ -39,10 +39,12 @@ jobs:
           chmod +x box.phar
           ./box.phar compile -vv
           gpg -u [email protected] --detach-sign --output phuml.phar.asc phuml.phar
+          ls -alh phuml*
 
       - name: "Upload binaries to distribute phUML via PHIVE"
         uses: "svenstaro/upload-release-action@v2"
         with:
           repo_token: ${{ secrets.GITHUB_TOKEN }}
           file: phuml.phar*
           tag: ${{ github.ref }}
+          file_glob: true

.scrutinizer.yml

@@ -20,5 +20,4 @@ build:
 
 tools:
     external_code_coverage:
-        timeout: 600
-        runs: 3
+        timeout: 1200

Makefile

@@ -1,7 +1,6 @@
 SHELL = /bin/bash
 
 ARGS=""
-INFECTION_BADGE_API_KEY=""
 
 .PHONY: help
 help: ## Show help

README.md

@@ -3,7 +3,7 @@
 [![CI workflow](https://github.com/montealegreluis/phuml/actions/workflows/ci.yml/badge.svg)](https://github.com/montealegreluis/phuml/actions/workflows/ci.yml)
 [![Scrutinizer Code Quality][scrutinizer-badge]][scrutinizer]
 [![Code Coverage][coverage-badge]][coverage]
-[![Infection MSI](https://badge.stryker-mutator.io/github.com/montealegreluis/phuml/master)](https://dashboard.stryker-mutator.io/reports/github.com/montealegreluis/phuml/master)
+[![Infection MSI](https://badge.stryker-mutator.io/github.com/MontealegreLuis/phuml/master)](https://dashboard.stryker-mutator.io/reports/github.com/MontealegreLuis/phuml/master)
 [![Latest Stable Version][stable-badge]][packagist]
 [![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%208.0-8892BF.svg?style=flat-square)](https://php.net/)
 

docs/installation.md

@@ -1,5 +1,5 @@
 ---
-currentMenu: index
+currentMenu: installation
 ---
 
 # Installation

index.md

@@ -3,7 +3,7 @@
 ![CI workflow](https://github.com/montealegreluis/phuml/actions/workflows/ci.yml/badge.svg)
 [![Scrutinizer Code Quality][scrutinizer-badge]][scrutinizer]
 [![Code Coverage][coverage-badge]][coverage]
-[![Infection MSI](https://badge.stryker-mutator.io/github.com/montealegreluis/phuml/master)](https://dashboard.stryker-mutator.io/reports/github.com/montealegreluis/phuml/master)
+[![Infection MSI](https://badge.stryker-mutator.io/github.com/MontealegreLuis/phuml/master)](https://dashboard.stryker-mutator.io/reports/github.com/MontealegreLuis/phuml/master)
 [![Latest Stable Version][stable-badge]][packagist]
 [![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%208.0-8892BF.svg?style=flat-square)](https://php.net/)
 

src/Code/Name.php

@@ -21,6 +21,11 @@ public function __construct(string $name)
         $this->parts = explode('\\', trim($name));
     }
 
+    public function first(): string
+    {
+        return $this->parts[0];
+    }
+
     public function fullName(): string
     {
         return implode('\\', $this->parts);
@@ -40,4 +45,10 @@ public function __toString(): string
     {
         return $this->parts[count($this->parts) - 1];
     }
+
+    public function packageName(): string
+    {
+        $package = array_slice($this->parts, 0, -1);
+        return implode('\\', $package);
+    }
 }

src/Code/UseStatement.php

@@ -18,13 +18,23 @@ public function endsWith(Name $name): bool
         return str_ends_with(haystack: (string) $this->name, needle: $name->removeArraySuffix());
     }
 
+    public function includes(Name $name): bool
+    {
+        return str_ends_with(haystack: (string) $this->name, needle: $name->first());
+    }
+
     public function isAliasedAs(Name $name): bool
     {
         return $this->alias !== null && (string) $this->alias === $name->removeArraySuffix();
     }
 
     public function fullyQualifiedName(Name $name): string
     {
-        return $name->isArray() ? $this->name->fullName() . '[]' : $this->name->fullName();
+        return $name->isArray() ? "{$this->name->fullName()}[]" : $this->name->fullName();
+    }
+
+    public function merge(Name $name): string
+    {
+        return "{$this->name->packageName()}\\{$name->fullName()}";
     }
 }

src/Code/UseStatements.php

@@ -20,6 +20,9 @@ public function fullyQualifiedNameFor(Name $name): string
             if ($useStatement->endsWith($name)) {
                 return $useStatement->fullyQualifiedName($name);
             }
+            if ($useStatement->includes($name)) {
+                return $useStatement->merge($name);
+            }
             if ($useStatement->isAliasedAs($name)) {
                 return $useStatement->fullyQualifiedName($name);
             }

src/Parser/Code/Builders/TagType.php

@@ -30,7 +30,7 @@ public static function named(string $type): TagType
     }
 
     /** @param string[] $types */
-    public function __construct(private array $types, private bool $isNullable = false)
+    private function __construct(private array $types, private bool $isNullable = false)
     {
     }
 

src/Parser/Code/Builders/TagTypeFactory.php

@@ -14,6 +14,7 @@
 use phpDocumentor\Reflection\Type;
 use phpDocumentor\Reflection\Types\Compound;
 use phpDocumentor\Reflection\Types\Nullable;
+use phpDocumentor\Reflection\Types\Object_;
 
 final class TagTypeFactory
 {
@@ -88,7 +89,7 @@ private function resolveType(?Type $type): ?TagType
             $type === null => null,
             $type instanceof Nullable => TagType::nullable((string) $type->getActualType()),
             $type instanceof Compound => TagType::compound(array_map('strval', $type->getIterator()->getArrayCopy())),
-            default => TagType::named((string) $type)
+            default => TagType::named((string) ($type instanceof Object_ ? $type->getFqsen() : $type))
         };
     }
 }

tests/unit/Parser/Code/Builders/TagTypeTest.php

@@ -0,0 +1,39 @@
+<?php declare(strict_types=1);
+/**
+ * PHP version 8.0
+ *
+ * This source file is subject to the license that is bundled with this package in the file LICENSE.
+ */
+
+namespace PhUml\Parser\Code\Builders;
+
+use PHPUnit\Framework\TestCase;
+use PhUml\Code\Name;
+use PhUml\Code\UseStatement;
+use PhUml\Code\UseStatements;
+use PhUml\Code\Variables\TypeDeclaration;
+
+final class TagTypeTest extends TestCase
+{
+    /** @test */
+    function it_resolves_fully_qualified_names_from_relative_names()
+    {
+        $useStatements = new UseStatements([new UseStatement(new Name('PhpParser\Node'), null)]);
+        $tagType = TagType::named('Node\Param[]');
+
+        $type = $tagType->resolve($useStatements);
+
+        $this->assertEquals(TypeDeclaration::from('PhpParser\Node\Param[]'), $type);
+    }
+
+    /** @test */
+    function it_resolves_fully_qualified_names_from_relative_names_with_multiple_prefix()
+    {
+        $useStatements = new UseStatements([new UseStatement(new Name('PhpParser\Node'), null)]);
+        $tagType = TagType::named('Node\Another\Param[]');
+
+        $type = $tagType->resolve($useStatements);
+
+        $this->assertEquals(TypeDeclaration::from('PhpParser\Node\Another\Param[]'), $type);
+    }
+}