Skip to content

Commit

Permalink
Implement category creation
Browse files Browse the repository at this point in the history
  • Loading branch information
caendesilva committed May 11, 2022
1 parent efdfcfc commit 70448b1
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 4 deletions.
24 changes: 20 additions & 4 deletions src/Concerns/HasDocumentationSidebarCategories.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,37 @@
*/
trait HasDocumentationSidebarCategories
{
protected array $categories = [];

public function hasCategories(): bool
{
// @todo: Implement hasCategories() method.
return false;
$this->assembleCategories();

return !empty($this->categories);
}

public function getCategories(): array
{
// @todo: Implement getCategories() method.
return [];
$this->assembleCategories();

return $this->categories;
}

public function getItemsInCategory(string $category): DocumentationSidebar
{
// @todo: Implement getItemsInCategory() method.
return new DocumentationSidebar();
}

protected function assembleCategories(): void
{
foreach ($this->sidebar as $item) {
if (isset($item->category)) {
// Add to the categories array if it doesn't exist.
if (! in_array($item->category, $this->categories)) {
$this->categories[] = $item->category;
}
}
}
}
}
28 changes: 28 additions & 0 deletions tests/Feature/Services/DocumentationSidebarServiceTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,34 @@ public function test_category_can_be_set_in_front_matter()
$this->assertEquals('bar', DocumentationSidebarService::get()->first()->category);
}

public function test_sidebar_categories_are_assembled_from_sidebar_items()
{
$service = (new DocumentationSidebarService)->createSidebar();
$service->addItem(new DocumentationSidebarItem('foo', 'foo', category: 'foo'));
$service->addItem(new DocumentationSidebarItem('bar', 'bar', category: 'foo'));
$service->addItem(new DocumentationSidebarItem('cat', 'cat', category: 'cat'));
$service->addItem(new DocumentationSidebarItem('hat', 'hat'));

$this->assertEquals(['foo', 'cat'], $service->getCategories());
}

public function test_has_categories_returns_false_if_no_categories_are_set()
{
$service = (new DocumentationSidebarService)->createSidebar();
$service->addItem(new DocumentationSidebarItem('foo', 'foo'));

$this->assertFalse($service->hasCategories());
}

public function test_has_categories_returns_true_if_at_least_one_category_is_set()
{
$service = (new DocumentationSidebarService)->createSidebar();
$service->addItem(new DocumentationSidebarItem('foo', 'foo', category: 'foo'));
$service->addItem(new DocumentationSidebarItem('bar', 'bar'));

$this->assertTrue($service->hasCategories());
}

protected function resetDocsDirectory(): void
{
File::deleteDirectory(Hyde::path('_docs'));
Expand Down

0 comments on commit 70448b1

Please sign in to comment.