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.

Sign up for GitHub

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

Jump to bottom

[1.x] Merge pull request #1081 from phpDocumentor/fix/deep-glob #1082

Merged
merged 1 commit into from
Sep 25, 2024
Merged

[1.x] Merge pull request #1081 from phpDocumentor/fix/deep-glob #1082

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions ...uides/src/Compiler/NodeTransformers/MenuNodeTransformers/GlobMenuEntryNodeTransformer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,9 @@
use function explode;
use function implode;
use function in_array;
use function is_string;
use function preg_match;
use function str_replace;
use function preg_replace;

final class GlobMenuEntryNodeTransformer extends AbstractMenuEntryNodeTransformer
{
Expand Down Expand Up @@ -137,7 +138,9 @@ private static function matches(string $actualFile, GlobMenuEntryNode $parsedMen
private static function isGlob(string $documentEntryFile, string $currentPath, string $file, string $prefix, array $globExclude): bool
{
if (!in_array($documentEntryFile, $globExclude, true)) {
$file = str_replace('*', '[^\/]*', $file);
$file = preg_replace('/(?<!\*)\*(?!\*)/', '[^\/]*', $file);
assert(is_string($file));
$file = preg_replace('/\*{2}/', '.*', $file);
$pattern = '`^' . $file . '$`';

return preg_match($pattern, $prefix . $documentEntryFile) > 0;
Expand Down
118 changes: 118 additions & 0 deletions tests/Integration/tests/toctree/toctree-glob-deep-level-3/expected/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
<!-- content start -->
<div class="section" id="document-title">
<h1>Document Title</h1>

<p>Lorem Ipsum Dolor.</p>

<div class="toc">
<ul class="menu-level">
<li class="toc-item">
<a href="/level-1-1/index.html#level-1-1">Level 1-1</a>


</li>
<li class="toc-item">
<a href="/level-1-1/level-2-1/index.html#level-2-1">Level 2-1</a>


</li>
<li class="toc-item">
<a href="/level-1-1/level-2-1/subpage1.html#subpage-1-level-2-1">Subpage 1, Level 2-1</a>


</li>
<li class="toc-item">
<a href="/level-1-1/level-2-1/subpage2.html#subpage-2-level-2-1">Subpage 2, Level 2-1</a>


</li>
<li class="toc-item">
<a href="/level-1-1/level-2-2/index.html#level-2-2">Level 2-2</a>


</li>
<li class="toc-item">
<a href="/level-1-1/level-2-2/subpage1.html#subpage-1-level-2-2">Subpage 1, Level 2-2</a>


</li>
<li class="toc-item">
<a href="/level-1-1/level-2-2/subpage2.html#subpage-1-level-2-2">Subpage 1, Level 2-2</a>


</li>
<li class="toc-item">
<a href="/level-1-1/subpage1.html#subpage-1-level-1-1">Subpage 1, Level 1-1</a>


</li>
<li class="toc-item">
<a href="/level-1-1/subpage2.html#subpage-2-level-1-1">Subpage 2, Level 1-1</a>


</li>
<li class="toc-item">
<a href="/level-1-2/index.html#level-1-2">Level 1-2</a>


</li>
<li class="toc-item">
<a href="/level-1-2/subpage1.html#subpage-1-level-1-2">Subpage 1, Level 1-2</a>


</li>
<li class="toc-item">
<a href="/level-1-2/subpage2.html#subpage-1-level-1-2">Subpage 1, Level 1-2</a>


</li>
<li class="toc-item">
<a href="/page1.html#page-1">Page 1</a>

<ul class="section-level-1">
<li class="toc-item">
<a href="/page1.html#page-1-level-2">Page 1 Level 2</a>

<ul class="section-level-2">
<li class="toc-item">
<a href="/page1.html#page-1-level-3">Page 1 Level 3</a>

<ul class="section-level-2">
<li class="toc-item">
<a href="/page1.html#page-1-level-4">Page 1 Level 4</a>


</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toc-item">
<a href="/page2.html#page-2">Page 2</a>

<ul class="section-level-1">
<li class="toc-item">
<a href="/page2.html#page-2-level-2">Page 2 Level 2</a>

<ul class="section-level-2">
<li class="toc-item">
<a href="/page2.html#page-2-level-3">Page 2 Level 3</a>

<ul class="section-level-2">
<li class="toc-item">
<a href="/page2.html#page-2-level-4">Page 2 Level 4</a>


</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- content end -->
10 changes: 10 additions & 0 deletions tests/Integration/tests/toctree/toctree-glob-deep-level-3/input/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
==============
Document Title
==============

Lorem Ipsum Dolor.

.. toctree::
:glob:

**
8 changes: 8 additions & 0 deletions ...s/Integration/tests/toctree/toctree-glob-deep-level-3/input/level-1-1/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
=========
Level 1-1
=========

Lorem Ipsum Dolor.

A Definition List
Some definition.
5 changes: 5 additions & 0 deletions ...ion/tests/toctree/toctree-glob-deep-level-3/input/level-1-1/level-2-1/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
=========
Level 2-1
=========

A Toctree with multiple whitespaces in the directive:
5 changes: 5 additions & 0 deletions .../tests/toctree/toctree-glob-deep-level-3/input/level-1-1/level-2-1/subpage1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
====================
Subpage 1, Level 2-1
====================

Lorem Ipsum Dolor.
5 changes: 5 additions & 0 deletions .../tests/toctree/toctree-glob-deep-level-3/input/level-1-1/level-2-1/subpage2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
====================
Subpage 2, Level 2-1
====================

Lorem Ipsum Dolor.
6 changes: 6 additions & 0 deletions ...ion/tests/toctree/toctree-glob-deep-level-3/input/level-1-1/level-2-2/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
=========
Level 2-2
=========

A Toctree with multiple whitespaces in the directive:

5 changes: 5 additions & 0 deletions .../tests/toctree/toctree-glob-deep-level-3/input/level-1-1/level-2-2/subpage1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
====================
Subpage 1, Level 2-2
====================

Lorem Ipsum Dolor.
5 changes: 5 additions & 0 deletions .../tests/toctree/toctree-glob-deep-level-3/input/level-1-1/level-2-2/subpage2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
====================
Subpage 1, Level 2-2
====================

Lorem Ipsum Dolor.
5 changes: 5 additions & 0 deletions ...ntegration/tests/toctree/toctree-glob-deep-level-3/input/level-1-1/subpage1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
====================
Subpage 1, Level 1-1
====================

Lorem Ipsum Dolor.
5 changes: 5 additions & 0 deletions ...ntegration/tests/toctree/toctree-glob-deep-level-3/input/level-1-1/subpage2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
====================
Subpage 2, Level 1-1
====================

Lorem Ipsum Dolor.
5 changes: 5 additions & 0 deletions ...s/Integration/tests/toctree/toctree-glob-deep-level-3/input/level-1-2/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
=========
Level 1-2
=========

A Toctree with multiple whitespaces in the directive:
5 changes: 5 additions & 0 deletions ...ntegration/tests/toctree/toctree-glob-deep-level-3/input/level-1-2/subpage1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
====================
Subpage 1, Level 1-2
====================

Lorem Ipsum Dolor.
5 changes: 5 additions & 0 deletions ...ntegration/tests/toctree/toctree-glob-deep-level-3/input/level-1-2/subpage2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
====================
Subpage 1, Level 1-2
====================

Lorem Ipsum Dolor.
14 changes: 14 additions & 0 deletions tests/Integration/tests/toctree/toctree-glob-deep-level-3/input/page1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
======
Page 1
======

Lorem Ipsum Dolor.

Page 1 Level 2
--------------

Page 1 Level 3
~~~~~~~~~~~~~~

Page 1 Level 4
""""""""""""""
14 changes: 14 additions & 0 deletions tests/Integration/tests/toctree/toctree-glob-deep-level-3/input/page2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
======
Page 2
======

Lorem Ipsum Dolor.

Page 2 Level 2
--------------

Page 2 Level 3
~~~~~~~~~~~~~~

Page 2 Level 4
""""""""""""""
Loading