Whitelist classes belonging to the global namespace by default (#252)

humbug · Aug 3, 2018 · 356be9a · 356be9a
1 parent 2008685
commit 356be9a
Show file tree

Hide file tree

Showing 128 changed files with 747 additions and 160 deletions.
diff --git a/README.md b/README.md
@@ -137,6 +137,7 @@ return [
     'patchers' => [],                       // callable[]
     'whitelist' => [],                      // string[]
     'whitelist-global-constants' => true,   // bool
+    'whitelist-global-classes' => true,     // bool
     'whitelist-global-functions' => true,   // bool
 ];
 ```
@@ -270,11 +271,11 @@ a PHPUnit PHAR with isolated code, you still want the PHAR to be able to
 understand the `PHPUnit\Framework\TestCase` class.
 
 
-### Constants & functions from the global namespace
+### Constants & Classes & functions from the global namespace
 
-By default, PHP-Scoper will not prefix the user defined constants and functions
-belonging to the global namespace. You can however change that setting for them
-to be prefixed as usual unless explicitly whitelisted:
+By default, PHP-Scoper will prefix the user defined constants, classes and
+functions belonging to the global namespace. You can however change that
+setting for them to be prefixed as usual unless explicitly whitelisted:
 
 ```php
 <?php declare(strict_types=1);
@@ -283,6 +284,7 @@ to be prefixed as usual unless explicitly whitelisted:
 
 return [
     'whitelist-global-constants' => false,
+    'whitelist-global-classes' => false,
     'whitelist-global-functions' => false,
 ];
 ```

diff --git a/specs/class/abstract.php → class/abstract.php b/specs/class/abstract.php → class/abstract.php
@@ -19,6 +19,7 @@
         'prefix' => 'Humbug',
         'whitelist' => [],
         'whitelist-global-constants' => true,
+        'whitelist-global-classes' => false,
         'whitelist-global-functions' => true,
         'registered-classes' => [],
         'registered-functions' => [],
@@ -47,6 +48,35 @@ public abstract function b();
 PHP
     ,
 
+    'Declaration in the global namespace with global classes whitelisted' => [
+        'whitelist-global-classes' => true,
+        'registered-classes' => [
+            ['A', 'Humbug\A'],
+        ],
+        'payload' => <<<'PHP'
+<?php
+
+abstract class A {
+    public function a() {}
+    abstract public function b();
+}
+----
+<?php
+
+namespace Humbug;
+
+abstract class A
+{
+    public function a()
+    {
+    }
+    public abstract function b();
+}
+
+PHP
+        ,
+    ],
+
     'Declaration in the global namespace with the global namespace which is namespaced whitelisted' => [
         'whitelist' => ['\*'],
         'payload' => <<<'PHP'
@@ -154,6 +184,34 @@ public abstract function b();
 PHP
     ,
 
+    'Declaration in a namespace with global classes whitelisted' => [
+        'whitelist-global-classes' => true,
+        '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();
+}
+
+PHP
+        ,
+    ],
+
     'Declaration in a whitelisted namespace' => [
         'whitelist' => ['Foo\*'],
         'payload' => <<<'PHP'

diff --git a/specs/class/anonymous.php → class/anonymous.php b/specs/class/anonymous.php → class/anonymous.php
@@ -19,6 +19,7 @@
         'prefix' => 'Humbug',
         'whitelist' => [],
         'whitelist-global-constants' => true,
+        'whitelist-global-classes' => false,
         'whitelist-global-functions' => true,
         'registered-classes' => [],
         'registered-functions' => [],
@@ -90,6 +91,80 @@ public function test()
 PHP
     ,
 
+    'Declaration in the global namespace with global classes whitelisted' => [
+        'whitelist-global-classes' => true,
+        'registered-classes' => [
+            ['A', 'Humbug\A'],
+            ['B', 'Humbug\B'],
+            ['C', 'Humbug\C'],
+        ],
+        'payload' => <<<'PHP'
+<?php
+
+interface B {}
+interface C {}
+
+new class {
+    public function test() {}
+};
+new class extends A implements B, C, Iterator {};
+new class() {
+    public $foo;
+};
+new class($a, $b) extends A {
+    use T;
+};
+
+class A {
+    public function test() {
+        return new class($this) extends A {
+            const A = 'B';
+        };
+    }
+}
+----
+<?php
+
+namespace Humbug;
+
+interface B
+{
+}
+interface C
+{
+}
+new class
+{
+    public function test()
+    {
+    }
+};
+new class extends \Humbug\A implements \Humbug\B, \Humbug\C, \Iterator
+{
+};
+new class
+{
+    public $foo;
+};
+new class($a, $b) extends \Humbug\A
+{
+    use T;
+};
+class A
+{
+    public function test()
+    {
+        return new class($this) extends \Humbug\A
+        {
+            const A = 'B';
+        };
+    }
+}
+
+PHP
+        ,
+    ],
+
     'Declaration in the global namespace which is whitelisted' => [
         'whitelist' => ['\*'],
         'payload' => <<<'PHP'

diff --git a/specs/class/conditional.php → class/conditional.php b/specs/class/conditional.php → class/conditional.php
@@ -19,6 +19,7 @@
         'prefix' => 'Humbug',
         'whitelist' => [],
         'whitelist-global-constants' => true,
+        'whitelist-global-classes' => false,
         'whitelist-global-functions' => true,
         'registered-classes' => [],
         'registered-functions' => [],

diff --git a/specs/class/final.php → class/final.php b/specs/class/final.php → class/final.php
@@ -19,6 +19,7 @@
         'prefix' => 'Humbug',
         'whitelist' => [],
         'whitelist-global-constants' => true,
+        'whitelist-global-classes' => false,
         'whitelist-global-functions' => true,
         'registered-classes' => [],
         'registered-functions' => [],
@@ -40,6 +41,27 @@ final class A
 PHP
     ,
 
+    'Declaration in the global namespace with global classes whitelisted' => [
+        'whitelist-global-classes' => true,
+        'registered-classes' => [
+            ['A', 'Humbug\A'],
+        ],
+        'payload' => <<<'PHP'
+<?php
+
+final class A {}
+----
+<?php
+
+namespace Humbug;
+
+final class A
+{
+}
+
+PHP
+    ],
+
     'Declaration in a namespace' => <<<'PHP'
 <?php
 
@@ -58,6 +80,26 @@ final class A
 PHP
     ,
 
+    'Declaration in a namespace with global classes whitelisted' => [
+        'whitelist-global-classes' => true,
+        'payload' => <<<'PHP'
+<?php
+
+namespace Foo;
+
+final class A {}
+----
+<?php
+
+namespace Humbug\Foo;
+
+final class A
+{
+}
+
+PHP
+    ],
+
     'Declaration of a whitelisted final class' => [
         'whitelist' => ['Foo\A'],
         'registered-classes' => [

diff --git a/specs/class/interface.php → class/interface.php b/specs/class/interface.php → class/interface.php
@@ -19,6 +19,7 @@
         'prefix' => 'Humbug',
         'whitelist' => [],
         'whitelist-global-constants' => true,
+        'whitelist-global-classes' => false,
         'whitelist-global-functions' => true,
         'registered-classes' => [],
         'registered-functions' => [],
@@ -52,6 +53,41 @@ public function a();
 PHP
     ,
 
+    'Declaration in the global namespace with global classes whitelisted' => [
+        'whitelist-global-classes' => true,
+        'registered-classes' => [
+            ['A', 'Humbug\A'],
+            ['C', 'Humbug\C'],
+            ['D', 'Humbug\D'],
+        ],
+        'payload' => <<<'PHP'
+<?php
+
+class C {}
+class D {}
+
+interface A extends C, D, Iterator {
+    public function a();
+}
+----
+<?php
+
+namespace Humbug;
+
+class C
+{
+}
+class D
+{
+}
+interface A extends \Humbug\C, \Humbug\D, \Iterator
+{
+    public function a();
+}
+
+PHP
+    ],
+
     'Declaration in a namespace' => <<<'PHP'
 <?php
 
@@ -86,6 +122,42 @@ public function a();
 PHP
     ,
 
+    'Declaration in a namespace with global classes whitelisted' => [
+        'whitelist-global-classes' => true,
+        'payload' => <<<'PHP'
+<?php
+
+namespace Foo;
+
+use Iterator;
+
+class C {}
+class D {}
+
+interface A extends C, D, Iterator
+{
+    public function a();
+}
+----
+<?php
+
+namespace Humbug\Foo;
+
+use Iterator;
+class C
+{
+}
+class D
+{
+}
+interface A extends \Humbug\Foo\C, \Humbug\Foo\D, \Iterator
+{
+    public function a();
+}
+
+PHP
+    ],
+
     'Declaration of a whitelisted interface' => [
         'whitelist' => ['Foo\A'],
         'registered-classes' => [

diff --git a/specs/class/regular-extend.php → class/regular-extend.php b/specs/class/regular-extend.php → class/regular-extend.php
@@ -19,6 +19,7 @@
         'prefix' => 'Humbug',
         'whitelist' => [],
         'whitelist-global-constants' => true,
+        'whitelist-global-classes' => false,
         'whitelist-global-functions' => true,
         'registered-classes' => [],
         'registered-functions' => [],