Fix scoping of PSR-0 based packages with global classes (#279)

theofidry · web-flow · commit bb5eb48e6f6a · 2018-11-04T00:30:40.000+01:00
Fix scoping of PSR-0 based packages with global classes #279
diff --git a/Makefile b/Makefile
@@ -62,7 +62,7 @@ tm: bin/phpunit
 
 .PHONY: e2e
 e2e:	## Run end-to-end tests
-e2e: e2e_004 e2e_005 e2e_011 e2e_013 e2e_014 e2e_015 e2e_016 e2e_017 e2e_018 e2e_019 e2e_020 e2e_021 e2e_022 e2e_023 e2e_024 e2e_025 e2e_026 e2e_027 e2e_028
+e2e: e2e_004 e2e_005 e2e_011 e2e_013 e2e_014 e2e_015 e2e_016 e2e_017 e2e_018 e2e_019 e2e_020 e2e_021 e2e_022 e2e_023 e2e_024 e2e_025 e2e_026 e2e_027 e2e_028 e2e_029
 
 PHPSCOPER=bin/php-scoper.phar
 
@@ -316,6 +316,24 @@ e2e_028: bin/php-scoper.phar fixtures/set028-symfony/vendor
 
 	diff fixtures/set028-symfony/expected-output build/set028-symfony/output
 
+.PHONY: e2e_029
+e2e_029:	## Run end-to-end tests for the fixture set 029 — EasyRdf
+e2e_029: bin/php-scoper fixtures/set029-easy-rdf/vendor
+	php $(PHPSCOPER) add-prefix \
+		--working-dir=fixtures/set029-easy-rdf \
+		--output-dir=../../build/set029-easy-rdf \
+		--no-config \
+		--force \
+		--no-interaction \
+		--stop-on-failure
+
+	php fixtures/set029-easy-rdf/main.php > fixtures/set029-easy-rdf/expected-output
+
+	composer --working-dir=build/set029-easy-rdf dump-autoload --no-dev
+	php build/set029-easy-rdf/main.php > build/set029-easy-rdf/output
+
+	diff fixtures/set029-easy-rdf/expected-output build/set029-easy-rdf/output
+
 .PHONY: tb
 BLACKFIRE=blackfire
 tb:	## Run Blackfire profiling
@@ -417,6 +435,10 @@ fixtures/set028-symfony/vendor: fixtures/set028-symfony/composer.lock
 	composer --working-dir=fixtures/set028-symfony install --no-dev --no-scripts
 	touch $@
 
+fixtures/set029-easy-rdf/vendor: fixtures/set029-easy-rdf/composer.lock
+	composer --working-dir=fixtures/set029-easy-rdf install --no-dev
+	touch $@
+
 composer.lock: composer.json
 	@echo composer.lock is not up to date.
 
@@ -468,6 +490,9 @@ fixtures/set027-laravel/composer.lock: fixtures/set027-laravel/composer.json
 fixtures/set028-symfony/composer.lock: fixtures/set028-symfony/composer.json
 	@echo fixtures/set028-symfony/composer.lock is not up to date.
 
+fixtures/set029-easy-rdf/composer.lock: fixtures/set029-easy-rdf/composer.json
+	@echo fixtures/set029-easy-rdf/composer.lock is not up to date.
+
 bin/php-scoper.phar: bin/php-scoper src vendor scoper.inc.php box.json.dist
 	$(BOX) compile
 	touch $@
diff --git a/fixtures/set029-easy-rdf/composer.json b/fixtures/set029-easy-rdf/composer.json
@@ -0,0 +1,5 @@
+{
+    "require": {
+        "easyrdf/easyrdf": "^0.9.1"
+    }
+}
diff --git a/fixtures/set029-easy-rdf/composer.lock b/fixtures/set029-easy-rdf/composer.lock
diff --git a/fixtures/set029-easy-rdf/expected-output b/fixtures/set029-easy-rdf/expected-output
@@ -0,0 +1 @@
+14
diff --git a/fixtures/set029-easy-rdf/foaf.rdf b/fixtures/set029-easy-rdf/foaf.rdf
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<rdf:RDF
+	xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+	xmlns:foaf="http://xmlns.com/foaf/0.1/"
+	xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"
+>
+  <foaf:PersonalProfileDocument rdf:about="">
+    <rdfs:label>Joe Bloggs' FOAF File</rdfs:label>
+    <foaf:maker rdf:resource="http://www.example.com/joe#me" />
+    <foaf:primaryTopic rdf:resource="http://www.example.com/joe#me" />
+  </foaf:PersonalProfileDocument>
+
+  <foaf:Person rdf:about="http://www.example.com/joe#me">
+    <foaf:title>Mr</foaf:title>
+    <foaf:name xml:lang="en">Joe Bloggs</foaf:name>
+    <foaf:firstName>Joe</foaf:firstName>
+    <foaf:family_name>Bloggs</foaf:family_name>
+    <foaf:homepage rdf:resource="http://www.example.com/joe/" />
+    <foaf:currentProject>
+      <foaf:Project>
+        <foaf:name>Joe's Current Project</foaf:name>
+        <foaf:homepage rdf:resource="http://www.example.com/project" />
+      </foaf:Project>
+    </foaf:currentProject>
+  </foaf:Person>
+</rdf:RDF>
diff --git a/fixtures/set029-easy-rdf/main.php b/fixtures/set029-easy-rdf/main.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+$autoload = __DIR__.'/vendor/scoper-autoload.php';
+
+if (false === file_exists($autoload)) {
+    $autoload = __DIR__.'/vendor/autoload.php';
+}
+
+require_once $autoload;
+
+$foaf = new EasyRdf_Graph();
+$count = $foaf->parseFile(__DIR__.'/foaf.rdf');
+
+echo $count.PHP_EOL;
diff --git a/specs/class/abstract.php b/specs/class/abstract.php
@@ -72,6 +72,7 @@ public function a()
     }
     public abstract function b();
 }
+\class_alias('Humbug\\A', 'A', \false);
 
 PHP
         ,
diff --git a/specs/class/anonymous.php b/specs/class/anonymous.php
@@ -130,9 +130,11 @@ public function test() {
 interface B
 {
 }
+\class_alias('Humbug\\B', 'B', \false);
 interface C
 {
 }
+\class_alias('Humbug\\C', 'C', \false);
 new class
 {
     public function test()
@@ -160,6 +162,7 @@ public function test()
         };
     }
 }
+\class_alias('Humbug\\A', 'A', \false);
 
 PHP
         ,
diff --git a/specs/class/final.php b/specs/class/final.php
@@ -58,6 +58,7 @@ final class A {}
 final class A
 {
 }
+\class_alias('Humbug\\A', 'A', \false);
 
 PHP
     ],
diff --git a/specs/class/interface.php b/specs/class/interface.php
@@ -77,13 +77,16 @@ public function a();
 class C
 {
 }
+\class_alias('Humbug\\C', 'C', \false);
 class D
 {
 }
+\class_alias('Humbug\\D', 'D', \false);
 interface A extends \Humbug\C, \Humbug\D, \Iterator
 {
     public function a();
 }
+\class_alias('Humbug\\A', 'A', \false);
 
 PHP
     ],
diff --git a/specs/class/regular.php b/specs/class/regular.php
@@ -68,6 +68,7 @@ public function a()
     {
     }
 }
+\class_alias('Humbug\\A', 'A', \false);
 
 PHP
     ],
diff --git a/specs/class/trait.php b/specs/class/trait.php
@@ -128,6 +128,7 @@ class B
         E::f as private;
     }
 }
+\class_alias('Humbug\\B', 'B', \false);
 
 PHP
     ],
diff --git a/src/PhpParser/NodeVisitor/ClassAliasStmtAppender.php b/src/PhpParser/NodeVisitor/ClassAliasStmtAppender.php
@@ -113,7 +113,10 @@ private function createNamespaceStmts(array $stmts, Stmt $stmt): array
 
         if (false === ($originalName instanceof FullyQualified)
             || $this->whitelist->belongsToWhitelistedNamespace((string) $originalName)
-            || false === $this->whitelist->isSymbolWhitelisted((string) $originalName)
+            || (
+                false === $this->whitelist->isSymbolWhitelisted((string) $originalName)
+                && false === $this->whitelist->isGlobalWhitelistedClass((string) $originalName)
+            )
         ) {
             return $stmts;
         }
diff --git a/src/Scoper/Composer/AutoloadPrefixer.php b/src/Scoper/Composer/AutoloadPrefixer.php
@@ -19,7 +19,9 @@
 use function array_map;
 use function is_array;
 use function is_string;
+use function rtrim;
 use function str_replace;
+use function strpos;
 
 /**
  * @private
@@ -56,10 +58,23 @@ private static function prefixAutoloadStatements(stdClass $autoload, string $pre
         }
 
         if (isset($autoload->{'psr-0'})) {
-            $autoload->{'psr-4'} = self::mergePSR0And4(
+            [$psr4, $classMap] = self::transformPsr0ToPsr4AndClassmap(
                 (array) $autoload->{'psr-0'},
-                (array) ($autoload->{'psr-4'} ?? new stdClass())
+                (array) ($autoload->{'psr-4'} ?? new stdClass()),
+                (array) ($autoload->{'classmap'} ?? new stdClass())
             );
+
+            if ([] === $psr4) {
+                unset($autoload->{'psr-4'});
+            } else {
+                $autoload->{'psr-4'} = $psr4;
+            }
+
+            if ([] === $classMap) {
+                unset($autoload->{'classmap'});
+            } else {
+                $autoload->{'classmap'} = $classMap;
+            }
         }
         unset($autoload->{'psr-0'});
 
@@ -87,30 +102,36 @@ private static function prefixAutoload(array $autoload, string $prefix, Whitelis
     }
 
     /**
-     * @param (string|string[])[] $psr0
-     * @param (string|string[])[] $psr4
-     *
-     * @return (string|string[])[]
+     * @param array<string, (string|string[])> $psr0
+     * @param (string|string[])[]              $psr4
+     * @param string[]                         $classMap
      */
-    private static function mergePSR0And4(array $psr0, array $psr4): array
+    private static function transformPsr0ToPsr4AndClassmap(array $psr0, array $psr4, array $classMap): array
     {
         foreach ($psr0 as $namespace => $path) {
             //Append backslashes, if needed, since psr-0 does not require this
             if ('\\' !== substr($namespace, -1)) {
                 $namespace .= '\\';
             }
 
-            $path = self::updatePSR0Path($path, (string) $namespace);
+            if (false !== strpos($namespace, '_')) {
+                $classMap[] = $path;
+
+                continue;
+            }
+
+            $path = self::updatePSR0Path($path, $namespace);
 
             if (!isset($psr4[$namespace])) {
                 $psr4[$namespace] = $path;
 
                 continue;
             }
-            $psr4[$namespace] = self::mergeNamespaces((string) $namespace, $path, $psr4);
+
+            $psr4[$namespace] = self::mergeNamespaces($namespace, $path, $psr4);
         }
 
-        return $psr4;
+        return [$psr4, $classMap];
     }
 
     /**
@@ -120,7 +141,10 @@ private static function mergePSR0And4(array $psr0, array $psr4): array
      */
     private static function updatePSR0Path($path, string $namespace)
     {
-        $namespaceForPsr = str_replace('\\', '/', $namespace);
+        $namespaceForPsr = rtrim(
+            str_replace('\\', '/', $namespace),
+            '/'
+        );
 
         if (false === is_array($path)) {
             if ('/' !== substr($path, -1)) {
diff --git a/tests/Scoper/Composer/JsonFileScoperTest.php b/tests/Scoper/Composer/JsonFileScoperTest.php

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +    "require": {
 +        "easyrdf/easyrdf": "^0.9.1"
 +    }
 +}
Original file line number	Diff line number	Diff line change
`@@ -72,6 +72,7 @@ public function a()`
`72`	`72`	`}`
`73`	`73`	`public abstract function b();`
`74`	`74`	`}`
	`75`	`+\class_alias('Humbug\\A', 'A', \false);`
`75`	`76`
`76`	`77`	`PHP`
`77`	`78`	`,`
Original file line number	Diff line number	Diff line change
`@@ -130,9 +130,11 @@ public function test() {`
`130`	`130`	`interface B`
`131`	`131`	`{`
`132`	`132`	`}`
	`133`	`+\class_alias('Humbug\\B', 'B', \false);`
`133`	`134`	`interface C`
`134`	`135`	`{`
`135`	`136`	`}`
	`137`	`+\class_alias('Humbug\\C', 'C', \false);`
`136`	`138`	`new class`
`137`	`139`	`{`
`138`	`140`	`public function test()`
`@@ -160,6 +162,7 @@ public function test()`
`160`	`162`	`};`
`161`	`163`	`}`
`162`	`164`	`}`
	`165`	`+\class_alias('Humbug\\A', 'A', \false);`
`163`	`166`
`164`	`167`	`PHP`
`165`	`168`	`,`
Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,7 @@ final class A {}`
`58`	`58`	`final class A`
`59`	`59`	`{`
`60`	`60`	`}`
	`61`	`+\class_alias('Humbug\\A', 'A', \false);`
`61`	`62`
`62`	`63`	`PHP`
`63`	`64`	`],`
Original file line number	Diff line number	Diff line change
`@@ -77,13 +77,16 @@ public function a();`
`77`	`77`	`class C`
`78`	`78`	`{`
`79`	`79`	`}`
	`80`	`+\class_alias('Humbug\\C', 'C', \false);`
`80`	`81`	`class D`
`81`	`82`	`{`
`82`	`83`	`}`
	`84`	`+\class_alias('Humbug\\D', 'D', \false);`
`83`	`85`	`interface A extends \Humbug\C, \Humbug\D, \Iterator`
`84`	`86`	`{`
`85`	`87`	`public function a();`
`86`	`88`	`}`
	`89`	`+\class_alias('Humbug\\A', 'A', \false);`
`87`	`90`
`88`	`91`	`PHP`
`89`	`92`	`],`