Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make behavior of PHP and GitHub references consistent #191

Merged
merged 1 commit into from
Apr 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions src/Reference/MethodReference.php
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand Down
10 changes: 6 additions & 4 deletions src/Reference/PhpClassReference.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand All @@ -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,
]
);
}
Expand Down
15 changes: 11 additions & 4 deletions src/Reference/PhpMethodReference.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand All @@ -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),
]
);
}
Expand Down
2 changes: 1 addition & 1 deletion tests/fixtures/expected/blocks/references/php-class.html
Original file line number Diff line number Diff line change
@@ -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>
3 changes: 2 additions & 1 deletion tests/fixtures/expected/blocks/references/php-method.html
Original file line number Diff line number Diff line change
@@ -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>
2 changes: 1 addition & 1 deletion tests/fixtures/expected/main/datetime.html
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down
2 changes: 1 addition & 1 deletion tests/fixtures/source/blocks/references/php-class.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@

:phpclass:`ArrayAccess`

:phpclass:`BcMath\Number`
:phpclass:`BcMath\\Number`
2 changes: 2 additions & 0 deletions tests/fixtures/source/blocks/references/php-method.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@

:phpmethod:`Locale::getDefault`

:phpmethod:`BcMath\\Number::add`