Skip to content

Avoid link with same ID's #152

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

Merged
merged 1 commit into from
Apr 13, 2023
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
55 changes: 55 additions & 0 deletions src/Renderers/TitleNodeRenderer.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<?php

declare(strict_types=1);

/*
* This file is part of the Docs Builder package.
* (c) Ryan Weaver <ryan@symfonycasts.com>
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace SymfonyDocsBuilder\Renderers;

use Doctrine\RST\Environment;
use Doctrine\RST\Nodes\TitleNode;
use Doctrine\RST\Renderers\NodeRenderer;
use Doctrine\RST\Templates\TemplateRenderer;

class TitleNodeRenderer implements NodeRenderer
{
/** @var TitleNode */
private $titleNode;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@javiereguiluz can we use typed properties?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's check that ... but do it in other PR so we can merge and deploy this one as soon as possible. Thanks.


/** @var TemplateRenderer */
private $templateRenderer;

private static $idUsagesCountByFilename = [];

public function __construct(TitleNode $titleNode, TemplateRenderer $templateRenderer)
{
$this->titleNode = $titleNode;
$this->templateRenderer = $templateRenderer;
}

public function render(): string
{
$filename = $this->titleNode->getEnvironment()->getCurrentFileName();
$id = $this->titleNode->getId();

$idUsagesCount = self::$idUsagesCountByFilename[$filename][$id] ?? 0;

if (0 === $idUsagesCount) {
$computedId = $this->titleNode->getId();
} else {
$computedId = Environment::slugify($this->titleNode->getValue()->getText().'-'.$idUsagesCount);
}

self::$idUsagesCountByFilename[$filename][$id] = $idUsagesCount + 1;

return $this->templateRenderer->render('header-title.html.twig', [
'titleNode' => $this->titleNode,
'id' => $computedId,
]);
}
}
10 changes: 10 additions & 0 deletions src/SymfonyHTMLFormat.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
use Doctrine\RST\Formats\Format;
use Doctrine\RST\Nodes\CodeNode;
use Doctrine\RST\Nodes\SpanNode;
use Doctrine\RST\Nodes\TitleNode;
use Doctrine\RST\Renderers\CallableNodeRendererFactory;
use Doctrine\RST\Renderers\NodeRendererFactory;
use Doctrine\RST\Templates\TemplateRenderer;
Expand Down Expand Up @@ -77,6 +78,15 @@ function (SpanNode $node) {
}
);

$nodeRendererFactories[TitleNode::class] = new CallableNodeRendererFactory(
function (TitleNode $node) {
return new Renderers\TitleNodeRenderer(
$node,
$this->templateRenderer
);
}
);

return $nodeRendererFactories;
}
}
2 changes: 1 addition & 1 deletion src/Templates/default/html/header-title.html.twig
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<h{{ titleNode.level }} id="{{ titleNode.id }}"><a class="headerlink" href="#{{ titleNode.id }}" title="Permalink to this headline">{{ titleNode.value.render()|raw }}</a></h{{ titleNode.level }}>
<h{{ titleNode.level }} id="{{ id }}"><a class="headerlink" href="#{{ id }}" title="Permalink to this headline">{{ titleNode.value.render()|raw }}</a></h{{ titleNode.level }}>
4 changes: 2 additions & 2 deletions src/Templates/rtd/html/header-title.html.twig
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<h{{ titleNode.level }} id="{{ titleNode.id }}">
<h{{ titleNode.level }} id="{{ id }}">
{{ titleNode.value.render()|raw }}
<a class="headerlink" href="#{{ titleNode.id }}" title="Permalink to this headline">¶</a>
<a class="headerlink" href="#{{ id }}" title="Permalink to this headline">¶</a>
</h{{ titleNode.level }}>
10 changes: 10 additions & 0 deletions tests/IntegrationTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,19 @@
use Symfony\Component\Finder\Finder;
use SymfonyDocsBuilder\DocBuilder;
use SymfonyDocsBuilder\KernelFactory;
use SymfonyDocsBuilder\Renderers\TitleNodeRenderer;

class IntegrationTest extends AbstractIntegrationTest
{
public static function setUpBeforeClass(): void
{
$reflection = new \ReflectionClass(TitleNodeRenderer::class);
$property = $reflection->getProperty('idUsagesCountByFilename');
$property->setAccessible(true);

$property->setValue([]);
}

/**
* @dataProvider integrationProvider
*/
Expand Down
3 changes: 3 additions & 0 deletions tests/fixtures/expected/blocks/nodes/title.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,8 @@ <h2 id="zuo-ye-huan-jingwo-que-rensuru"><a class="headerlink" href="#zuo-ye-huan
<div class="section">
<h2 id="perevirka-robocogo-seredovisa"><a class="headerlink" href="#perevirka-robocogo-seredovisa" title="Permalink to this headline">Перевірка робочого середовища</a></h2>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit.</p>
<div class="section">
<h3 id="checking-your-work-environment-1"><a class="headerlink" href="#checking-your-work-environment-1" title="Permalink to this headline"><code translate="no" class="notranslate">Checking your Work Environment</code></a></h3>
</div>
</div>
</div>
3 changes: 3 additions & 0 deletions tests/fixtures/source/blocks/nodes/title.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,6 @@ Lorem ipsum dolor sit amet, consectetur adipisicing elit.
-----------------------------

Lorem ipsum dolor sit amet, consectetur adipisicing elit.

``Checking your Work Environment``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~