Make behavior of PHP and GitHub references consistent (#191)

Author: wouterj

src/Reference/MethodReference.php

@@ -30,20 +30,19 @@ public function getName(): string
 
     public function resolve(Environment $environment, string $data): ResolvedReference
     {
-        $className = explode('::', $data)[0];
-        $className = str_replace('\\\\', '\\', $className);
-
-        if (!u($data)->containsAny('::')) {
+        $data = u($data);
+        if (!$data->containsAny('::')) {
             throw new \RuntimeException(sprintf('Malformed method reference "%s" in file "%s"', $data, $environment->getCurrentFileName()));
         }
 
-        $methodName = explode('::', $data)[1];
+        [$className, $methodName] = $data->split('::', 2);
+        $className = $className->replace('\\\\', '\\');
 
         $scrollTextFragment = sprintf('#:~:text=%s', rawurlencode('function '.$methodName));
         return new ResolvedReference(
             $environment->getCurrentFileName(),
             $methodName.'()',
-            sprintf('%s/%s.php%s', $this->symfonyRepositoryUrl, str_replace('\\', '/', $className), $scrollTextFragment),
+            sprintf('%s/%s.php%s', $this->symfonyRepositoryUrl, $className->replace('\\', '/'), $scrollTextFragment),
             [],
             [
                 'title' => sprintf('%s::%s()', $className, $methodName),

src/Reference/PhpClassReference.php

@@ -12,6 +12,7 @@
 use Doctrine\RST\Environment;
 use Doctrine\RST\References\Reference;
 use Doctrine\RST\References\ResolvedReference;
+use function Symfony\Component\String\u;
 
 class PhpClassReference extends Reference
 {
@@ -29,14 +30,15 @@ public function getName(): string
 
     public function resolve(Environment $environment, string $data): ResolvedReference
     {
-        $classnamePath = str_replace('\\', '-', strtolower($data));
+        $className = u($data)->replace('\\\\', '\\');
+
         return new ResolvedReference(
             $environment->getCurrentFileName(),
-            $data,
-            sprintf('%s/class.%s.php', $this->phpDocUrl, $classnamePath),
+            $className->afterLast('\\'),
+            sprintf('%s/class.%s.php', $this->phpDocUrl, $className->replace('\\', '-')->lower()),
             [],
             [
-                'title' => $data,
+                'title' => $className,
             ]
         );
     }

src/Reference/PhpMethodReference.php

@@ -12,6 +12,7 @@
 use Doctrine\RST\Environment;
 use Doctrine\RST\References\Reference;
 use Doctrine\RST\References\ResolvedReference;
+use function Symfony\Component\String\u;
 
 class PhpMethodReference extends Reference
 {
@@ -29,15 +30,21 @@ public function getName(): string
 
     public function resolve(Environment $environment, string $data): ResolvedReference
     {
-        [$class, $method] = explode('::', $data, 2);
+        $data = u($data);
+        if (!$data->containsAny('::')) {
+            throw new \RuntimeException(sprintf('Malformed method reference "%s" in file "%s"', $data, $environment->getCurrentFileName()));
+        }
+
+        [$className, $methodName] = $data->split('::', 2);
+        $className = $className->replace('\\\\', '\\');
 
         return new ResolvedReference(
             $environment->getCurrentFileName(),
-            $data.'()',
-            sprintf('%s/%s.%s.php', $this->phpDocUrl, strtolower($class), strtolower($method)),
+            $methodName.'()',
+            sprintf('%s/%s.%s.php', $this->phpDocUrl, $className->replace('\\', '-')->lower(), $methodName->lower()),
             [],
             [
-                'title' => $class,
+                'title' => sprintf('%s::%s()', $className, $methodName),
             ]
         );
     }

tests/fixtures/expected/blocks/references/php-class.html

@@ -1,2 +1,2 @@
 <p><a href="https://secure.php.net/manual/en/class.arrayaccess.php" class="reference external" title="ArrayAccess" rel="external noopener noreferrer" target="_blank">ArrayAccess</a></p>
-<p><a href="https://secure.php.net/manual/en/class.bcmath-number.php" class="reference external" title="BcMath\Number" rel="external noopener noreferrer" target="_blank">BcMath\Number</a></p>
+<p><a href="https://secure.php.net/manual/en/class.bcmath-number.php" class="reference external" title="BcMath\Number" rel="external noopener noreferrer" target="_blank">Number</a></p>

tests/fixtures/expected/blocks/references/php-method.html

@@ -1 +1,2 @@
-<p><a href="https://secure.php.net/manual/en/locale.getdefault.php" class="reference external" title="Locale" rel="external noopener noreferrer" target="_blank">Locale::getDefault()</a></p>
+<p><a href="https://secure.php.net/manual/en/locale.getdefault.php" class="reference external" title="Locale::getDefault()" rel="external noopener noreferrer" target="_blank">getDefault()</a></p>
+<p><a href="https://secure.php.net/manual/en/bcmath-number.add.php" class="reference external" title="BcMath\Number::add()" rel="external noopener noreferrer" target="_blank">add()</a></p>

tests/fixtures/expected/main/datetime.html

@@ -79,7 +79,7 @@ <h3 id="the-date-format-option">
 methods: <a href="https://github.com/symfony/symfony/blob/4.0/src/Symfony/Component/BrowserKit/Client.php#:~:text=function%20doRequest" class="reference external" title="Symfony\Component\BrowserKit\Client::doRequest()" rel="external noopener noreferrer" target="_blank">doRequest()</a>.
 Or a namespace: <a href="https://github.com/symfony/symfony/blob/4.0/src/Symfony/Component/Validator/Constraints" class="reference external" title="Symfony\Component\Validator\Constraints" rel="external noopener noreferrer" target="_blank">Constraints</a>.
 Or a PHP function: <a href="https://secure.php.net/manual/en/function.parse-ini-file.php" class="reference external" title="parse_ini_file" rel="external noopener noreferrer" target="_blank">parse_ini_file</a>.
-Or a PHP method! <a href="https://secure.php.net/manual/en/locale.getdefault.php" class="reference external" title="Locale" rel="external noopener noreferrer" target="_blank">Locale::getDefault()</a>.</p>
+Or a PHP method! <a href="https://secure.php.net/manual/en/locale.getdefault.php" class="reference external" title="Locale::getDefault()" rel="external noopener noreferrer" target="_blank">getDefault()</a>.</p>
             </div>
         </div>
         <div class="section">

tests/fixtures/source/blocks/references/php-class.rst

@@ -1,4 +1,4 @@
 
 :phpclass:`ArrayAccess`
 
-:phpclass:`BcMath\Number`
+:phpclass:`BcMath\\Number`

tests/fixtures/source/blocks/references/php-method.rst

@@ -1,2 +1,4 @@
 
 :phpmethod:`Locale::getDefault`
+
+:phpmethod:`BcMath\\Number::add`