Merge pull request #898 from hydephp/documentation-search-code-cleanups

emmadesilva · web-flow · commit b54b5a9fb09a · 2023-02-01T14:57:56.000+01:00
Documentation search code cleanups
diff --git a/packages/framework/src/Framework/Services/DocumentationSearchService.php b/packages/framework/src/Framework/Services/DocumentationSearchService.php
@@ -74,7 +74,7 @@ public function generatePageEntry(DocumentationPage $page): array
             'slug' => basename($page->identifier),
             'title' => $page->title,
             'content' => trim($this->getSearchContentForDocument($page)),
-            'destination' => $this->getDestinationForSlug(basename($page->identifier)),
+            'destination' => $this->formatDestination(basename($page->identifier)),
         ];
     }
 
@@ -92,13 +92,13 @@ protected function getSearchContentForDocument(DocumentationPage $page): string
         return (new ConvertsMarkdownToPlainText($page->markdown->body()))->execute();
     }
 
-    public function getDestinationForSlug(string $slug): string
+    protected function formatDestination(string $slug): string
     {
         if (config('site.pretty_urls', false) === true) {
-            return $slug !== 'index' ? $slug : '';
+            return $slug === 'index' ? '' : $slug;
         }
 
-        return $slug.'.html';
+        return "$slug.html";
     }
 
     public static function getFilePath(): string
diff --git a/packages/framework/tests/Feature/Services/DocumentationSearchServiceTest.php b/packages/framework/tests/Feature/Services/DocumentationSearchServiceTest.php
@@ -93,18 +93,20 @@ public function test_it_strips_markdown()
     public function test_get_destination_for_slug_returns_empty_string_for_index_when_pretty_url_is_enabled()
     {
         config(['site.pretty_urls' => true]);
+        $this->file('_docs/index.md');
 
         $this->assertSame('',
-            (new DocumentationSearchService())->getDestinationForSlug('index')
+            (new DocumentationSearchService())->run()->searchIndex->toArray()[0]['destination']
         );
     }
 
     public function test_get_destination_for_slug_returns_pretty_url_when_enabled()
     {
         config(['site.pretty_urls' => true]);
+        $this->file('_docs/foo.md');
 
         $this->assertSame('foo',
-            (new DocumentationSearchService())->getDestinationForSlug('foo')
+            (new DocumentationSearchService())->run()->searchIndex->toArray()[0]['destination']
         );
     }
 

Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ public function generatePageEntry(DocumentationPage $page): array`
`74`	`74`	`'slug' => basename($page->identifier),`
`75`	`75`	`'title' => $page->title,`
`76`	`76`	`'content' => trim($this->getSearchContentForDocument($page)),`
`77`		`- 'destination' => $this->getDestinationForSlug(basename($page->identifier)),`
	`77`	`+ 'destination' => $this->formatDestination(basename($page->identifier)),`
`78`	`78`	`];`
`79`	`79`	`}`
`80`	`80`
`@@ -92,13 +92,13 @@ protected function getSearchContentForDocument(DocumentationPage $page): string`
`92`	`92`	`return (new ConvertsMarkdownToPlainText($page->markdown->body()))->execute();`
`93`	`93`	`}`
`94`	`94`
`95`		`- public function getDestinationForSlug(string $slug): string`
	`95`	`+ protected function formatDestination(string $slug): string`
`96`	`96`	`{`
`97`	`97`	`if (config('site.pretty_urls', false) === true) {`
`98`		`- return $slug !== 'index' ? $slug : '';`
	`98`	`+ return $slug === 'index' ? '' : $slug;`
`99`	`99`	`}`
`100`	`100`
`101`		`- return $slug.'.html';`
	`101`	`+ return "$slug.html";`
`102`	`102`	`}`
`103`	`103`
`104`	`104`	`public static function getFilePath(): string`
Original file line number	Diff line number	Diff line change
`@@ -93,18 +93,20 @@ public function test_it_strips_markdown()`
`93`	`93`	`public function test_get_destination_for_slug_returns_empty_string_for_index_when_pretty_url_is_enabled()`
`94`	`94`	`{`
`95`	`95`	`config(['site.pretty_urls' => true]);`
	`96`	`+ $this->file('_docs/index.md');`
`96`	`97`
`97`	`98`	`$this->assertSame('',`
`98`		`- (new DocumentationSearchService())->getDestinationForSlug('index')`
	`99`	`+ (new DocumentationSearchService())->run()->searchIndex->toArray()[0]['destination']`
`99`	`100`	`);`
`100`	`101`	`}`
`101`	`102`
`102`	`103`	`public function test_get_destination_for_slug_returns_pretty_url_when_enabled()`
`103`	`104`	`{`
`104`	`105`	`config(['site.pretty_urls' => true]);`
	`106`	`+ $this->file('_docs/foo.md');`
`105`	`107`
`106`	`108`	`$this->assertSame('foo',`
`107`		`- (new DocumentationSearchService())->getDestinationForSlug('foo')`
	`109`	`+ (new DocumentationSearchService())->run()->searchIndex->toArray()[0]['destination']`
`108`	`110`	`);`
`109`	`111`	`}`
`110`	`112`