Add support for exposing namespaces (#608)

Author: theofidry

README.md

@@ -325,7 +325,7 @@ a PHPUnit PHAR with isolated code, you still want the PHAR to be able to
 understand the `PHPUnit\Framework\TestCase` class.
 
 Notes for the rework of the docs which are coming as I'm reviewing the tests:
-- excluded namespaces take precedence over exposing a symbol. For example, exposing the class `Acme\Foo` and excluding the namespace `Acme` will result in the class `Acme\Foo` to NOT be exposed, but excluded instead.
+- excluded namespaces take precedence over exposing a symbol/namespace. For example, exposing the class `Acme\Foo` and excluding the namespace `Acme` will result in the class `Acme\Foo` to NOT be exposed, but excluded instead.
 
 
 ### Constants & Classes & functions from the global namespace

specs/class/abstract.php

@@ -245,6 +245,37 @@ public abstract function b();
         PHP,
     ],
 
+    'Declaration in an exposed namespace' => [
+        'expose-namespaces' => ['Foo'],
+        'expected-recorded-classes' => [
+            ['Foo\A', 'Humbug\Foo\A'],
+        ],
+        'payload' => <<<'PHP'
+        <?php
+        
+        namespace Foo;
+        
+        abstract class A {
+            public function a() {}
+            abstract public function b();
+        }
+        ----
+        <?php
+        
+        namespace Humbug\Foo;
+        
+        abstract class A
+        {
+            public function a()
+            {
+            }
+            public abstract function b();
+        }
+        \class_alias('Humbug\\Foo\\A', 'Foo\\A', \false);
+        
+        PHP,
+    ],
+
     'Declaration of an exposed class in a namespace' => [
         'expose-classes' => ['Foo\A'],
         'expected-recorded-classes' => [

specs/const/const-declaration-with-global-exposed.php

@@ -194,4 +194,32 @@
 
         PHP,
     ],
+
+    'Exposed constants declaration in an exposed namespace' => [
+        'expose-namespaces' => ['Acme'],
+        'payload' => <<<'PHP'
+        <?php
+        
+        namespace Acme;
+        
+        const FOO_CONST = foo();
+        define('BAR_CONST', foo());
+        define('Acme\BAR_CONST', foo());
+        define(FOO_CONST, foo());
+        define(\FOO_CONST, foo());
+        define(\Acme\BAR_CONST, foo());
+        ----
+        <?php
+        
+        namespace Humbug\Acme;
+        
+        \define('Acme\\FOO_CONST', foo());
+        \define('BAR_CONST', foo());
+        \define('Acme\\BAR_CONST', foo());
+        \define(FOO_CONST, foo());
+        \define(\FOO_CONST, foo());
+        \define(\Acme\BAR_CONST, foo());
+        
+        PHP,
+    ],
 ];

specs/func-declaration/namespace.php

@@ -582,4 +582,28 @@ function foo() : ?\Humbug\X\Y
 
         PHP,
     ],
+
+    'Function declaration in an exposed namespace' => [
+        'expose-namespaces' => ['Acme'],
+        'expected-recorded-functions' => [
+            ['Acme\foo', 'Humbug\Acme\foo'],
+        ],
+        'payload' => <<<'PHP'
+        <?php
+        
+        namespace Acme;
+        
+        function foo() {}
+        
+        ----
+        <?php
+
+        namespace Humbug\Acme;
+        
+        function foo()
+        {
+        }
+
+        PHP,
+    ],
 ];

src/Configuration/SymbolsConfigurationFactory.php

@@ -48,6 +48,14 @@ public function createSymbolsConfiguration(array $config): SymbolsConfiguration
             ConfigurationKeys::EXCLUDE_NAMESPACES_KEYWORD,
         );
 
+        [
+            $exposedNamespaceNames,
+            $exposedNamespaceRegexes,
+        ] = $this->retrieveElements(
+            $config,
+            ConfigurationKeys::EXPOSE_NAMESPACES_KEYWORD,
+        );
+
         $legacyExposedElements = self::retrieveLegacyExposedElements($config);
 
         [
@@ -93,7 +101,10 @@ public function createSymbolsConfiguration(array $config): SymbolsConfiguration
                 $excludedNamespaceNames,
                 $excludedNamespaceRegexes,
             ),
-            null,
+            NamespaceRegistry::create(
+                $exposedNamespaceNames,
+                $exposedNamespaceRegexes,
+            ),
             SymbolRegistry::create(
                 array_merge(
                     $exposedClassNames,

src/Symbol/EnrichedReflector.php

@@ -32,6 +32,13 @@ public function belongsToExcludedNamespace(string $name): bool
             ->belongsToRegisteredNamespace($name);
     }
 
+    private function belongsToExposedNamespace(string $name): bool
+    {
+        return $this->symbolsConfiguration
+            ->getExposedNamespaces()
+            ->belongsToRegisteredNamespace($name);
+    }
+
     public function isFunctionInternal(string $name): bool
     {
         return $this->reflector->isFunctionInternal($name);
@@ -75,6 +82,7 @@ public function isExposedFunction(string $resolvedName): bool
                 || $this->symbolsConfiguration
                         ->getExposedFunctions()
                         ->matches($resolvedName)
+                || $this->belongsToExposedNamespace($resolvedName)
             );
     }
 
@@ -94,6 +102,7 @@ public function isExposedClass(string $resolvedName): bool
                 || $this->symbolsConfiguration
                     ->getExposedClasses()
                     ->matches($resolvedName)
+                || $this->belongsToExposedNamespace($resolvedName)
             );
     }
 
@@ -117,6 +126,7 @@ public function isExposedConstant(string $name): bool
                 || $this->symbolsConfiguration
                     ->getExposedConstants()
                     ->matches($name)
+                || $this->belongsToExposedNamespace($name)
             );
     }
 

tests/Configuration/ConfigurationFactoryTest.php

@@ -151,7 +151,9 @@ public function test_it_can_create_a_complete_configuration(): void
                         'Bar',
                     ],
                 ),
-                null,
+                NamespaceRegistry::create(
+                    ['PHPUnit\Runner'],
+                ),
                 SymbolRegistry::create(['Foo']),
                 SymbolRegistry::create(['Foo']),
                 SymbolRegistry::createForConstants(['Foo']),