Show more search results when searching code (#1167)

frankdekker · web-flow · commit a68a4b407cac · 2025-08-24T10:56:26.000+02:00
* Add option to show more results after searching code

* Add option to show more results after searching code

* Add option to show more results after searching code

* Add option to show more results after searching code

* Add option to show more results after searching code

* Add option to show more results after searching code

* Add option to show more results after searching code

* Add option to show more results after searching code

* Add option to show more results after searching code

* Add option to show more results after searching code
diff --git a/src/Controller/App/Search/SearchCodeController.php b/src/Controller/App/Search/SearchCodeController.php
@@ -4,6 +4,7 @@
 namespace DR\Review\Controller\App\Search;
 
 use DR\Review\Controller\AbstractController;
+use DR\Review\Model\Search\SearchResultCollection;
 use DR\Review\Repository\Config\RepositoryRepository;
 use DR\Review\Request\Search\SearchCodeRequest;
 use DR\Review\Security\Role\Roles;
@@ -39,19 +40,19 @@ public function __invoke(SearchCodeRequest $request): array
         $extensions  = $request->getExtensions();
         if (strlen($searchQuery) < 5) {
             $this->addFlash('error', $this->translator->trans('search.much.be.minimum.5.characters'));
-            $files = [];
+            $results = new SearchResultCollection([], false);
         } else {
             $this->stopwatch?->start('file-search');
 
             $repositories = $this->repositoryRepository->findBy(['active' => true]);
-            $files        = $this->fileSearcher->find($searchQuery, $extensions, $repositories);
+            $results      = $this->fileSearcher->find($searchQuery, $extensions, $repositories, $request->isShowAll() ? null : 100);
 
             $this->stopwatch?->stop('file-search');
         }
 
         return [
-            'page_title'    => $this->translator->trans('code.search'),
-            'viewModel' => new SearchCodeViewModel($files, $searchQuery, $extensions === null ? null : implode(',', $extensions))
+            'page_title' => $this->translator->trans('code.search'),
+            'viewModel'  => new SearchCodeViewModel($results, $searchQuery, $extensions === null ? null : implode(',', $extensions))
         ];
     }
 }
diff --git a/src/Model/Search/SearchResultCollection.php b/src/Model/Search/SearchResultCollection.php
@@ -0,0 +1,32 @@
+<?php
+declare(strict_types=1);
+
+namespace DR\Review\Model\Search;
+
+readonly class SearchResultCollection
+{
+    /**
+     * @codeCoverageIgnore Simple DTO
+     *
+     * @param SearchResult[] $results
+     */
+    public function __construct(public array $results, public bool $moreResultsAvailable)
+    {
+    }
+
+    /**
+     * @return iterable<int, SearchResult[]>
+     */
+    public function iteratePerRepository(): iterable
+    {
+        $grouped = [];
+        foreach ($this->results as $result) {
+            $repoId             = (int)$result->repository->getId();
+            $grouped[$repoId]   ??= [];
+            $grouped[$repoId][] = $result;
+        }
+        foreach ($grouped as $repoId => $results) {
+            yield $repoId => $results;
+        }
+    }
+}
diff --git a/src/Request/Search/SearchCodeRequest.php b/src/Request/Search/SearchCodeRequest.php
@@ -24,13 +24,19 @@ public function getExtensions(): ?array
         return count($extensions) === 0 ? null : $extensions;
     }
 
+    public function isShowAll(): bool
+    {
+        return $this->request->query->getBoolean('all');
+    }
+
     protected function getValidationRules(): ?ValidationRules
     {
         return new ValidationRules(
             [
                 'query' => [
                     'search'    => 'required|string',
                     'extension' => 'string|regex:/^[a-zA-Z0-9]{1,5}(,[a-zA-Z0-9]{1,5})*$/',
+                    'all'       => 'string',
                 ]
             ]
         );
diff --git a/src/Service/Search/RipGrep/GitFileSearcher.php b/src/Service/Search/RipGrep/GitFileSearcher.php
@@ -4,7 +4,7 @@
 namespace DR\Review\Service\Search\RipGrep;
 
 use DR\Review\Entity\Repository\Repository;
-use DR\Review\Model\Search\SearchResult;
+use DR\Review\Model\Search\SearchResultCollection;
 use DR\Review\Service\Search\RipGrep\Command\RipGrepCommandBuilderFactory;
 use DR\Review\Service\Search\RipGrep\Command\RipGrepProcessExecutor;
 use DR\Review\Service\Search\RipGrep\Iterator\JsonDecodeIterator;
@@ -22,10 +22,8 @@ public function __construct(
     /**
      * @param non-empty-array<string> $extensions
      * @param Repository[]            $repositories
-     *
-     * @return SearchResult[]
      */
-    public function find(string $searchQuery, ?array $extensions, array $repositories): array
+    public function find(string $searchQuery, ?array $extensions, array $repositories, ?int $limit = null): SearchResultCollection
     {
         $command = $this->commandBuilderFactory->default();
         $command->search($searchQuery);
@@ -35,6 +33,6 @@ public function find(string $searchQuery, ?array $extensions, array $repositorie
 
         $jsonIterator = new JsonDecodeIterator($this->executor->execute($command, $this->gitCacheDirectory));
 
-        return $this->parser->parse($jsonIterator, $repositories);
+        return $this->parser->parse($jsonIterator, $repositories, $limit);
     }
 }
diff --git a/src/Service/Search/RipGrep/SearchResultLineFactory.php b/src/Service/Search/RipGrep/SearchResultLineFactory.php
@@ -14,7 +14,7 @@ class SearchResultLineFactory
     public function createContextFromEntry(array $entry): SearchResultLine
     {
         return new SearchResultLine(
-            $entry['data']['lines']['text'],
+            $entry['data']['lines']['text'] ?? '',
             $entry['data']['line_number'],
             SearchResultLineTypeEnum::Context
         );
@@ -26,7 +26,7 @@ public function createContextFromEntry(array $entry): SearchResultLine
     public function createMatchFromEntry(array $entry): SearchResultLine
     {
         return new SearchResultLine(
-            $entry['data']['lines']['text'],
+            $entry['data']['lines']['text'] ?? '',
             $entry['data']['line_number'],
             SearchResultLineTypeEnum::Match
         );
diff --git a/src/Service/Search/RipGrep/SearchResultLineParser.php b/src/Service/Search/RipGrep/SearchResultLineParser.php
@@ -4,7 +4,7 @@
 namespace DR\Review\Service\Search\RipGrep;
 
 use DR\Review\Entity\Repository\Repository;
-use DR\Review\Model\Search\SearchResult;
+use DR\Review\Model\Search\SearchResultCollection;
 use DR\Review\Service\Search\RipGrep\Iterator\JsonDecodeIterator;
 
 /**
@@ -22,13 +22,12 @@ public function __construct(
     /**
      * @param iterable<int, SearchResultEntry> $iterator
      * @param Repository[]                     $repositories
-     *
-     * @return SearchResult[]
      */
-    public function parse(iterable $iterator, array $repositories): array
+    public function parse(iterable $iterator, array $repositories, ?int $limit = null): SearchResultCollection
     {
-        $results = [];
-        $current = null;
+        $results              = [];
+        $current              = null;
+        $moreResultsAvailable = false;
         foreach ($iterator as $entry) {
             if ($entry['type'] === 'begin') {
                 $current = $this->resultFactory->create($entry['data']['path']['text'], $this->gitCacheDirectory, $repositories);
@@ -48,13 +47,12 @@ public function parse(iterable $iterator, array $repositories): array
                 $current->addLine($this->resultLineFactory->createMatchFromEntry($entry));
             }
 
-            // @codeCoverageIgnoreStart
-            if (count($results) >= 100) {
+            if ($limit !== null && count($results) >= $limit) {
+                $moreResultsAvailable = true;
                 break;
             }
-            // @codeCoverageIgnoreEnd
         }
 
-        return $results;
+        return new SearchResultCollection($results, $moreResultsAvailable);
     }
 }
diff --git a/src/ViewModel/App/Search/SearchCodeViewModel.php b/src/ViewModel/App/Search/SearchCodeViewModel.php
@@ -3,16 +3,14 @@
 
 namespace DR\Review\ViewModel\App\Search;
 
-use DR\Review\Model\Search\SearchResult;
+use DR\Review\Model\Search\SearchResultCollection;
 
 readonly class SearchCodeViewModel
 {
     /**
      * @codeCoverageIgnore Simple DTO
-     *
-     * @param SearchResult[] $files
      */
-    public function __construct(public array $files, public string $searchQuery, public ?string $fileExtension)
+    public function __construct(public SearchResultCollection $searchResults, public string $searchQuery, public ?string $fileExtension)
     {
     }
 }
diff --git a/templates/app/search/code.search.html.twig b/templates/app/search/code.search.html.twig
@@ -33,35 +33,50 @@
         </form>
     </div>
 
-    {% if viewModel.files %}
-    <div class="accordion" {{ stimulus_controller('accordion') }}>
-        {% for resultFile in viewModel.files %}
-            <div class="accordion-item" data-role="accordion-item">
-                <h2 class="accordion-header">
-                    <button class="accordion-button collapsed" type="button" {{ stimulus_action('accordion', 'toggle', 'click') }}>
+    {% if viewModel.searchResults.results|length > 0 %}
+        <div class="mb-3">
+            {% for results in viewModel.searchResults.iteratePerRepository %}
+                <div>
+                    <div class="mt-2 mb-1">
                         <span class="badge rounded-pill text-bg-primary me-2">
-                            {{ resultFile.repository.displayName }}
+                            {{ results[0].repository.displayName }}
                         </span>
-                        {{ resultFile.file.relativePathname }}
-                    </button>
-                </h2>
-                <div class="accordion-collapse collapse" data-role="accordion-collapse">
-                    <div class="accordion-body">
-                        <pre class="d-block">
-                            {%- for line in resultFile.lines -%}
-                                <div {% if line.type.value == 'match' %}class="bg-success-subtle"{% endif %}>
-                                    {#- show code line -#}
-                                    <span class="text-danger bg-light-gray d-inline-block code-search-line-number">
-                                        {{- line.lineNumber -}}
-                                    </span> {{ line.line -}}
+                    </div>
+                    <div class="accordion" {{ stimulus_controller('accordion') }}>
+                        {% for resultFile in results %}
+                            <div class="accordion-item" data-role="accordion-item">
+                                <h2 class="accordion-header">
+                                    <button class="accordion-button collapsed" type="button" {{ stimulus_action('accordion', 'toggle', 'click') }}>
+                                        {{ resultFile.file.relativePathname }}
+                                    </button>
+                                </h2>
+                                <div class="accordion-collapse collapse" data-role="accordion-collapse">
+                                    <div class="accordion-body">
+                                <pre class="d-block">
+                                    {%- for line in resultFile.lines -%}
+                                        <div {% if line.type.value == 'match' %}class="bg-success-subtle"{% endif %}>
+                                            {#- show code line -#}
+                                            <span class="text-danger bg-light-gray d-inline-block code-search-line-number">
+                                                {{- line.lineNumber -}}
+                                            </span> {{ line.line -}}
+                                        </div>
+                                    {%- endfor -%}
+                                </pre>
+                                    </div>
                                 </div>
-                            {%- endfor -%}
-                        </pre>
+                            </div>
+                        {% endfor %}
                     </div>
                 </div>
-            </div>
-        {% endfor %}
-    </div>
+            {% endfor %}
+            {% if viewModel.searchResults.moreResultsAvailable %}
+                <div class="mt-2">
+                    <a href="?search={{ viewModel.searchQuery|escape('url') }}&extension={{ viewModel.fileExtension|escape('url') }}&all=true"
+                       type="button"
+                       class="btn btn-outline-primary">{{ 'show.all'|trans }}</a>
+                </div>
+            {% endif %}
+        </div>
     {% else %}
         <div class="alert alert-warning">
             {{ 'no.matches.found'|trans }}
diff --git a/tests/Unit/Controller/App/Search/SearchCodeControllerTest.php b/tests/Unit/Controller/App/Search/SearchCodeControllerTest.php
@@ -6,15 +6,14 @@
 use DR\PHPUnitExtensions\Symfony\AbstractControllerTestCase;
 use DR\Review\Controller\App\Search\SearchCodeController;
 use DR\Review\Entity\Repository\Repository;
-use DR\Review\Model\Search\SearchResult;
+use DR\Review\Model\Search\SearchResultCollection;
 use DR\Review\Repository\Config\RepositoryRepository;
 use DR\Review\Request\Search\SearchCodeRequest;
 use DR\Review\Service\Search\RipGrep\GitFileSearcher;
 use DR\Review\ViewModel\App\Search\SearchCodeViewModel;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\MockObject\MockObject;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
-use Symfony\Component\Finder\SplFileInfo;
 use Symfony\Contracts\Translation\TranslatorInterface;
 use function DR\PHPUnitExtensions\Mock\consecutive;
 
@@ -41,6 +40,7 @@ public function testInvokeWithTooShortQuery(): void
         $request = $this->createMock(SearchCodeRequest::class);
         $request->method('getSearchQuery')->willReturn('fail');
         $request->method('getExtensions')->willReturn(null);
+        $request->method('isShowAll')->willReturn(false);
 
         $this->translator->expects($this->exactly(2))->method('trans')
             ->with(...consecutive(['search.much.be.minimum.5.characters'], ['code.search']))
@@ -51,7 +51,7 @@ public function testInvokeWithTooShortQuery(): void
         $result = ($this->controller)($request);
 
         static::assertEquals(
-            ['page_title' => 'translation2', 'viewModel' => new SearchCodeViewModel([], 'fail', null)],
+            ['page_title' => 'translation2', 'viewModel' => new SearchCodeViewModel(new SearchResultCollection([], false), 'fail', null)],
             $result
         );
     }
@@ -61,13 +61,16 @@ public function testInvokeWithSearch(): void
         $request = $this->createMock(SearchCodeRequest::class);
         $request->method('getSearchQuery')->willReturn('success');
         $request->method('getExtensions')->willReturn(['json', 'yaml']);
+        $request->method('isShowAll')->willReturn(false);
 
         $repository    = new Repository();
-        $searchResults = [new SearchResult($repository, new SplFileInfo('file', '', ''))];
+        $searchResults = static::createStub(SearchResultCollection::class);
 
         $this->translator->expects($this->once())->method('trans')->with('code.search')->willReturn('translation');
         $this->repositoryRepository->expects($this->once())->method('findBy')->with(['active' => true])->willReturn([$repository]);
-        $this->fileSearcher->expects($this->once())->method('find')->with('success', ['json', 'yaml'], [$repository])->willReturn($searchResults);
+        $this->fileSearcher->expects($this->once())->method('find')
+            ->with('success', ['json', 'yaml'], [$repository], 100)
+            ->willReturn($searchResults);
 
         $result = ($this->controller)($request);
 
diff --git a/tests/Unit/Model/Search/SearchResultCollectionTest.php b/tests/Unit/Model/Search/SearchResultCollectionTest.php
@@ -0,0 +1,33 @@
+<?php
+declare(strict_types=1);
+
+namespace DR\Review\Tests\Unit\Model\Search;
+
+use DR\Review\Entity\Repository\Repository;
+use DR\Review\Model\Search\SearchResult;
+use DR\Review\Model\Search\SearchResultCollection;
+use DR\Review\Tests\AbstractTestCase;
+use PHPUnit\Framework\Attributes\CoversClass;
+use Symfony\Component\Finder\SplFileInfo;
+
+#[CoversClass(SearchResultCollection::class)]
+class SearchResultCollectionTest extends AbstractTestCase
+{
+    public function testIteratePerRepositoryEmptyCollection(): void
+    {
+        $collection = new SearchResultCollection([], false);
+        $results    = iterator_to_array($collection->iteratePerRepository());
+        static::assertCount(0, $results);
+    }
+
+    public function testIteratePerRepository(): void
+    {
+        $repository = (new Repository())->setId(123);
+        $result     = new SearchResult($repository, new SplFileInfo('file', '', ''));
+
+        $collection = new SearchResultCollection([$result], false);
+
+        $results = iterator_to_array($collection->iteratePerRepository());
+        static::assertSame([123 => [$result]], $results);
+    }
+}
diff --git a/tests/Unit/Request/Search/SearchCodeRequestTest.php b/tests/Unit/Request/Search/SearchCodeRequestTest.php
@@ -27,6 +27,12 @@ public function testGetExtensions(): void
         static::assertSame(['json', 'yaml'], $this->validatedRequest->getExtensions());
     }
 
+    public function testGetIsShowAll(): void
+    {
+        $this->request->query->set('all', 'true');
+        static::assertTrue($this->validatedRequest->isShowAll());
+    }
+
     public function testGetExtensionsWithEmptyQuery(): void
     {
         static::assertNull($this->validatedRequest->getExtensions());
@@ -42,6 +48,7 @@ public function testGetValidationRules(): void
                 'query' => [
                     'search'    => 'required|string',
                     'extension' => 'string|regex:/^[a-zA-Z0-9]{1,5}(,[a-zA-Z0-9]{1,5})*$/',
+                    'all'       => 'string',
                 ]
             ]
         );
diff --git a/tests/Unit/Service/Search/RipGrep/GitFileSearcherTest.php b/tests/Unit/Service/Search/RipGrep/GitFileSearcherTest.php
diff --git a/tests/Unit/Service/Search/RipGrep/SearchResultLineParserTest.php b/tests/Unit/Service/Search/RipGrep/SearchResultLineParserTest.php
diff --git a/translations/messages+intl-icu.en.php b/translations/messages+intl-icu.en.php

Original file line number	Diff line number	Diff line change
`@@ -24,13 +24,19 @@ public function getExtensions(): ?array`
`24`	`24`	`return count($extensions) === 0 ? null : $extensions;`
`25`	`25`	`}`
`26`	`26`
	`27`	`+ public function isShowAll(): bool`
	`28`	`+ {`
	`29`	`+ return $this->request->query->getBoolean('all');`
	`30`	`+ }`
	`31`	`+`
`27`	`32`	`protected function getValidationRules(): ?ValidationRules`
`28`	`33`	`{`
`29`	`34`	`return new ValidationRules(`
`30`	`35`	`[`
`31`	`36`	`'query' => [`
`32`	`37`	`'search' => 'required\|string',`
`33`	`38`	`'extension' => 'string\|regex:/^[a-zA-Z0-9]{1,5}(,[a-zA-Z0-9]{1,5})*$/',`
	`39`	`+ 'all' => 'string',`
`34`	`40`	`]`
`35`	`41`	`]`
`36`	`42`	`);`
Original file line number	Diff line number	Diff line change
`@@ -3,16 +3,14 @@`
`3`	`3`
`4`	`4`	`namespace DR\Review\ViewModel\App\Search;`
`5`	`5`
`6`		`-use DR\Review\Model\Search\SearchResult;`
	`6`	`+use DR\Review\Model\Search\SearchResultCollection;`
`7`	`7`
`8`	`8`	`readonly class SearchCodeViewModel`
`9`	`9`	`{`
`10`	`10`	`/**`
`11`	`11`	`* @codeCoverageIgnore Simple DTO`
`12`		`- *`
`13`		`- * @param SearchResult[] $files`
`14`	`12`	`*/`
`15`		`- public function __construct(public array $files, public string $searchQuery, public ?string $fileExtension)`
	`13`	`+ public function __construct(public SearchResultCollection $searchResults, public string $searchQuery, public ?string $fileExtension)`
`16`	`14`	`{`
`17`	`15`	`}`
`18`	`16`	`}`