Merge pull request #69 from markjaquith/issue/67/nested-namespaces/fix

Limit replacements to the beginning of the namespace string

Author: coenjacobs

src/Replace/NamespaceReplacer.php

@@ -9,11 +9,20 @@ class NamespaceReplacer extends BaseReplacer
 
     public function replace($contents)
     {
-        $searchNamespace = addslashes($this->autoloader->getSearchNamespace());
-        $dependencyNamespace = addslashes($this->dep_namespace);
+        $searchNamespace = preg_quote($this->autoloader->getSearchNamespace(), '/');
+        $dependencyNamespace = preg_quote($this->dep_namespace, '/');
 
         return preg_replace_callback(
-            '/([^a-zA-Z0-9_\x7f-\xff])((?<!' . $dependencyNamespace . ')' . $searchNamespace . '[\\\|;])/U',
+            "
+            /                                # Start the pattern
+              ([^a-zA-Z0-9_\x7f-\xff])       # Match the non-class character before the namespace
+                (                            # Start the namespace matcher
+                  (?<!$dependencyNamespace)  # Does NOT start with the prefix
+                  (?<![a-zA-Z0-9_]\\\\)      # Not a class-allowed character followed by a slash
+                  $searchNamespace           # The namespace we're looking for
+                  [\\\|;]                    # Backslash, semicolon, or pipe
+                )                            # End the namespace matcher
+            /Ux",
             function ($matches) {
                 return $matches[1] . $this->dep_namespace . $matches[2];
             },

tests/replacers/NamespaceReplacerTest.php

@@ -7,65 +7,101 @@
 
 class NamespaceReplacerTest extends TestCase
 {
+    const PREFIX = 'My\\Mozart\\Prefix\\';
+
     /** @var NamespaceReplacer */
     public $replacer;
 
     protected function setUp(): void
     {
-        $autoloader = new Psr0();
-        $autoloader->namespace = 'Test\\Test';
+        $this->replacer = self::createReplacer('Test\\Test');
+    }
 
+    /**
+     * Creates a NamespaceReplacer, given a namespace and a prefix.
+     *
+     * @param string $namespace
+     * @param string $prefix
+     *
+     * @return Psr0
+     */
+    protected static function createReplacer(string $namespace, string $prefix = self::PREFIX) : NamespaceReplacer
+    {
+        $autoloader = new Psr0;
+        $autoloader->namespace = $namespace;
         $replacer = new NamespaceReplacer();
         $replacer->setAutoloader($autoloader);
-        $replacer->dep_namespace = 'Prefix\\';
-        $this->replacer = $replacer;
+        $replacer->dep_namespace = $prefix;
+
+        return $replacer;
     }
 
     /** @test */
     public function it_replaces_namespace_declarations(): void
     {
         $contents = 'namespace Test\\Test;';
         $contents = $this->replacer->replace($contents);
-        $this->assertEquals('namespace Prefix\\Test\\Test;', $contents);
+
+        $this->assertEquals('namespace My\\Mozart\\Prefix\\Test\\Test;', $contents);
     }
 
 
     /** @test */
     public function it_doesnt_replaces_namespace_inside_namespace(): void
     {
+        $replacer = self::createReplacer('Test');
 
-        $autoloader = new Psr0();
-        $autoloader->namespace = 'Test';
-
-        $replacer = new NamespaceReplacer();
-        $replacer->setAutoloader($autoloader);
-        $replacer->dep_namespace = 'Prefix\\';
-        $this->replacer = $replacer;
+        $contents = "namespace Test\\Something;\n\nuse Test\\Test;";
+        $contents = $replacer->replace($contents);
 
-        $contents ="namespace Test\\Something;\n\nuse Test\\Test;";
-        $contents = $this->replacer->replace($contents);
-        $this->assertEquals("namespace Prefix\\Test\\Something;\n\nuse Prefix\\Test\\Test;", $contents);
+        $this->assertEquals("namespace My\\Mozart\\Prefix\\Test\\Something;\n\nuse My\\Mozart\\Prefix\\Test\\Test;", $contents);
     }
 
     /** @test */
     public function it_replaces_partial_namespace_declarations(): void
     {
         $contents = 'namespace Test\\Test\\Another;';
         $contents = $this->replacer->replace($contents);
-        $this->assertEquals('namespace Prefix\\Test\\Test\\Another;', $contents);
+
+        $this->assertEquals('namespace My\\Mozart\\Prefix\\Test\\Test\\Another;', $contents);
     }
 
-    /** @test */
+	/** @test */
     public function it_doesnt_prefix_already_prefixed_namespace(): void
     {
-        $autoloader = new Psr0();
-        $autoloader->namespace = 'Test\\Another';
+        $replacer = self::createReplacer('Test\\Another');
 
-        $replacer = new NamespaceReplacer();
-        $replacer->setAutoloader($autoloader);
+        $contents = 'namespace My\\Mozart\\Prefix\\Test\\Another;';
+        $contents = $replacer->replace($contents);
 
-        $contents = 'namespace Prefix\\Test\\Another;';
-        $contents = $this->replacer->replace($contents);
-        $this->assertEquals('namespace Prefix\\Test\\Another;', $contents);
+        $this->assertEquals('namespace My\\Mozart\\Prefix\\Test\\Another;', $contents);
+    }
+
+    /** @test */
+    public function it_doesnt_double_replace_namespaces_that_also_exist_inside_another_namespace(): void
+    {
+        $chickenReplacer = self::createReplacer('Chicken');
+        $eggReplacer = self::createReplacer('Egg');
+
+        // This is a tricky situation. We are referencing Chicken\Egg,
+        // but Egg *also* exists as a separate top level class.
+        $contents = 'use Chicken\\Egg;';
+        $expected = 'use My\\Mozart\\Prefix\\Chicken\\Egg;';
+
+        // First, we test that eggReplacer(chickenReplacer()) yields the expected result.
+        $this->assertEquals($expected, $eggReplacer->replace($chickenReplacer->replace($contents)));
+
+        // Then, we test that chickenReplacer(eggReplacer()) yields the expected result.
+        $this->assertEquals($expected, $chickenReplacer->replace($eggReplacer->replace($contents)));
+
+        // Now we do the same thing, but with root-relative references.
+        $contents = 'use \\Chicken\\Egg;';
+        $expected = 'use \\My\\Mozart\\Prefix\\Chicken\\Egg;';
+
+        // First, we test that eggReplacer(chickenReplacer()) yields the expected result.
+        $this->assertEquals($expected, $eggReplacer->replace($chickenReplacer->replace($contents)));
+
+        // Then, we test that chickenReplacer(eggReplacer()) yields the expected result.
+        $this->assertEquals($expected, $chickenReplacer->replace($eggReplacer->replace($contents)));
     }
 }