Breaking: Rename subdirectories option to subdirectory_display

emmadesilva · emmadesilva · commit c06a475dfde5 · 2024-07-10T17:50:05.000+02:00
Breaking: Renames the `hyde.navigation.subdirectories` option to `hyde.navigation.subdirectory_display` to make its usage much clearer.
diff --git a/config/hyde.php b/config/hyde.php
@@ -364,7 +364,7 @@
 
         // How should pages in subdirectories be displayed in the menu?
         // You can choose between 'dropdown', 'flat', and 'hidden'.
-        'subdirectories' => 'hidden',
+        'subdirectory_display' => 'hidden',
     ],
 
     /*
diff --git a/docs/digging-deeper/navigation.md b/docs/digging-deeper/navigation.md
@@ -259,7 +259,7 @@ Within the Hyde config you can configure how subdirectories should be displayed
 ```php
 // filepath config/hyde.php
 'navigation' => [
-    'subdirectories' => 'dropdown'
+    'subdirectory_display' => 'dropdown'
 ]
 ```
 
@@ -279,7 +279,7 @@ For pages that can be in the main site menu, this feature needs to be enabled in
 // filepath config/hyde.php
 
 'navigation' => [
-    'subdirectories' => 'dropdown',
+    'subdirectory_display' => 'dropdown',
 ],
 ```
 
diff --git a/packages/framework/config/hyde.php b/packages/framework/config/hyde.php
@@ -364,7 +364,7 @@
 
         // How should pages in subdirectories be displayed in the menu?
         // You can choose between 'dropdown', 'flat', and 'hidden'.
-        'subdirectories' => 'hidden',
+        'subdirectory_display' => 'hidden',
     ],
 
     /*
diff --git a/packages/framework/src/Framework/Factories/NavigationDataFactory.php b/packages/framework/src/Framework/Factories/NavigationDataFactory.php
@@ -274,7 +274,7 @@ private function getSubdirectoryName(): string
 
     protected function getSubdirectoryConfiguration(): string
     {
-        return Config::getString('hyde.navigation.subdirectories', 'hidden');
+        return Config::getString('hyde.navigation.subdirectory_display', 'hidden');
     }
 
     /** @param class-string<\Hyde\Pages\Concerns\HydePage> $class */
diff --git a/packages/framework/src/Framework/Features/Navigation/NavigationMenuGenerator.php b/packages/framework/src/Framework/Features/Navigation/NavigationMenuGenerator.php
@@ -96,7 +96,7 @@ protected function usesGroups(): bool
 
             return $this->routes->first(fn (Route $route): bool => filled($route->getPage()->navigationMenuGroup())) !== null;
         } else {
-            return Config::getString('hyde.navigation.subdirectories', 'hidden') === 'dropdown';
+            return Config::getString('hyde.navigation.subdirectory_display', 'hidden') === 'dropdown';
         }
     }
 
diff --git a/packages/framework/tests/Feature/AutomaticNavigationConfigurationsTest.php b/packages/framework/tests/Feature/AutomaticNavigationConfigurationsTest.php
@@ -412,7 +412,7 @@ public function testMainNavigationDropdownLabelsCanBeSetInConfig()
 
     public function testMainNavigationAutomaticSubdirectoryDropdownLabelsCanBeSetInConfig()
     {
-        config(['hyde.navigation.subdirectories' => 'dropdown']);
+        config(['hyde.navigation.subdirectory_display' => 'dropdown']);
         config(['hyde.navigation.labels' => ['hello' => 'World']]);
 
         $this->assertMenuEquals(['World'], [
@@ -444,7 +444,7 @@ public function testPagesInSubdirectoriesAreNotAddedToNavigation()
 
     public function testPagesInSubdirectoriesAreAddedToNavigationWhenNavigationSubdirectoriesIsSetToFlat()
     {
-        config(['hyde.navigation.subdirectories' => 'flat']);
+        config(['hyde.navigation.subdirectory_display' => 'flat']);
 
         $this->assertMenuEquals(['Foo', 'Bar', 'Baz'], [
             new MarkdownPage('about/foo'),
@@ -455,7 +455,7 @@ public function testPagesInSubdirectoriesAreAddedToNavigationWhenNavigationSubdi
 
     public function testPagesInSubdirectoriesAreAddedAsDropdownsWhenNavigationSubdirectoriesIsSetToDropdown()
     {
-        config(['hyde.navigation.subdirectories' => 'dropdown']);
+        config(['hyde.navigation.subdirectory_display' => 'dropdown']);
 
         $this->assertMenuEquals([
             ['label' => 'About', 'children' => ['Foo', 'Bar', 'Baz']],
@@ -502,7 +502,7 @@ public function testMainNavigationMenuItemsWithSameLabelButDifferentGroupsAreNot
 
     public function testMainNavigationMenuDropdownItemsWithSameLabelButDifferentGroupsAreNotFiltered()
     {
-        config(['hyde.navigation.subdirectories' => 'dropdown']);
+        config(['hyde.navigation.subdirectory_display' => 'dropdown']);
 
         $this->assertMenuEquals([
             ['label' => 'One', 'children' => ['Foo']],
@@ -515,7 +515,7 @@ public function testMainNavigationMenuDropdownItemsWithSameLabelButDifferentGrou
 
     public function testMainNavigationMenuAutomaticDropdownItemsWithSameLabelButDifferentGroupsAreNotFiltered()
     {
-        config(['hyde.navigation.subdirectories' => 'dropdown']);
+        config(['hyde.navigation.subdirectory_display' => 'dropdown']);
 
         $this->assertMenuEquals([
             ['label' => 'One', 'children' => ['Foo']],
@@ -532,7 +532,7 @@ public function testConflictingSubdirectoryAndFrontMatterDropdownConfigurationGi
         // we run into a conflicting state where we don't know what the user intended. We solve this by giving
         // precedence to the subdirectory configuration. This is opinionated, but allows for good grouping.
 
-        config(['hyde.navigation.subdirectories' => 'dropdown']);
+        config(['hyde.navigation.subdirectory_display' => 'dropdown']);
 
         $this->assertMenuEquals([
             ['label' => 'Foo', 'children' => ['Child']],
@@ -543,7 +543,7 @@ public function testConflictingSubdirectoryAndFrontMatterDropdownConfigurationGi
 
     public function testCanMixSubdirectoryDropdownsWithFrontMatterDropdowns()
     {
-        config(['hyde.navigation.subdirectories' => 'dropdown']);
+        config(['hyde.navigation.subdirectory_display' => 'dropdown']);
 
         $this->assertMenuEquals([
             ['label' => 'Foo', 'children' => ['Bar', 'Baz']],
@@ -555,7 +555,7 @@ public function testCanMixSubdirectoryDropdownsWithFrontMatterDropdowns()
 
     public function testMainMenuAutomaticDropdownLabelsCanBeSetInConfig()
     {
-        config(['hyde.navigation.subdirectories' => 'dropdown']);
+        config(['hyde.navigation.subdirectory_display' => 'dropdown']);
         config(['hyde.navigation.labels' => ['foo' => 'Bar']]);
 
         $this->assertMenuEquals([
@@ -1110,7 +1110,7 @@ public function testSidebarCanMixSubdirectoryGroupsWithFrontMatterGroups()
 
     public function testMainNavigationDropdownPriorityCanBeSetInConfig()
     {
-        config(['hyde.navigation.subdirectories' => 'dropdown']);
+        config(['hyde.navigation.subdirectory_display' => 'dropdown']);
         config(['hyde.navigation.order' => ['foo' => 500]]);
 
         $this->assertMenuEquals(
@@ -1121,7 +1121,7 @@ public function testMainNavigationDropdownPriorityCanBeSetInConfig()
 
     public function testMainNavigationDropdownPriorityCanBeSetInConfigUsingDifferingCases()
     {
-        config(['hyde.navigation.subdirectories' => 'dropdown']);
+        config(['hyde.navigation.subdirectory_display' => 'dropdown']);
         config(['hyde.navigation.order' => ['hello-world' => 500]]);
 
         $expected = [['label' => 'Hello World', 'priority' => 500]];
@@ -1176,7 +1176,7 @@ public function testMainMenuNavigationItemCasingUsingFrontMatter()
 
     public function testMainMenuNavigationGroupCasing()
     {
-        config(['hyde.navigation.subdirectories' => 'dropdown']);
+        config(['hyde.navigation.subdirectory_display' => 'dropdown']);
 
         // When using subdirectory groupings, we try to format them the same way as the page titles
 
diff --git a/packages/framework/tests/Feature/HydePageTest.php b/packages/framework/tests/Feature/HydePageTest.php
@@ -1176,7 +1176,7 @@ public function testNavigationDataFactoryHidesPageFromNavigationWhenInASubdirect
 
     public function testNavigationDataFactoryHidesPageFromNavigationWhenInAAndConfigIsSetToHidden()
     {
-        config(['hyde.navigation.subdirectories' => 'hidden']);
+        config(['hyde.navigation.subdirectory_display' => 'hidden']);
 
         $page = MarkdownPage::make('foo/bar');
 
@@ -1186,7 +1186,7 @@ public function testNavigationDataFactoryHidesPageFromNavigationWhenInAAndConfig
 
     public function testNavigationDataFactoryDoesNotHidePageFromNavigationWhenInASubdirectoryAndAllowedInConfiguration()
     {
-        config(['hyde.navigation.subdirectories' => 'flat']);
+        config(['hyde.navigation.subdirectory_display' => 'flat']);
 
         $page = MarkdownPage::make('foo/bar');
 
@@ -1196,7 +1196,7 @@ public function testNavigationDataFactoryDoesNotHidePageFromNavigationWhenInASub
 
     public function testNavigationDataFactoryAllowsShowInNavigationAndSetsGroupWhenDropdownIsSelectedInConfig()
     {
-        config(['hyde.navigation.subdirectories' => 'dropdown']);
+        config(['hyde.navigation.subdirectory_display' => 'dropdown']);
 
         $page = MarkdownPage::make('foo/bar');
 
diff --git a/packages/framework/tests/Feature/NavigationMenuTest.php b/packages/framework/tests/Feature/NavigationMenuTest.php
@@ -239,7 +239,7 @@ public function testPagesInSubdirectoriesAreNotAddedToTheNavigationMenu()
 
     public function testPagesInSubdirectoriesCanBeAddedToTheNavigationMenuWithConfigFlatSetting()
     {
-        config(['hyde.navigation.subdirectories' => 'flat']);
+        config(['hyde.navigation.subdirectory_display' => 'flat']);
         $this->directory('_pages/foo');
         $this->file('_pages/foo/bar.md');
 
@@ -256,7 +256,7 @@ public function testPagesInSubdirectoriesCanBeAddedToTheNavigationMenuWithConfig
 
     public function testPagesInSubdirectoriesAreNotAddedToTheNavigationMenuWithConfigDropdownSetting()
     {
-        config(['hyde.navigation.subdirectories' => 'dropdown']);
+        config(['hyde.navigation.subdirectory_display' => 'dropdown']);
         $this->directory('_pages/foo');
         $this->file('_pages/foo/bar.md');
 
@@ -275,7 +275,7 @@ public function testPagesInSubdirectoriesAreNotAddedToTheNavigationMenuWithConfi
 
     public function testPagesInDropdownsDoNotGetAddedToTheMainNavigation()
     {
-        config(['hyde.navigation.subdirectories' => 'dropdown']);
+        config(['hyde.navigation.subdirectory_display' => 'dropdown']);
 
         Routes::push((new MarkdownPage('foo'))->getRoute());
         Routes::push((new MarkdownPage('bar/baz'))->getRoute());
diff --git a/packages/framework/tests/Feature/NumericalPageOrderingHelperTest.php b/packages/framework/tests/Feature/NumericalPageOrderingHelperTest.php
@@ -38,7 +38,7 @@ protected function setUp(): void
 
         $this->helper = new FilenamePrefixNavigationPriorityTestingHelper($this);
 
-        Config::set('hyde.navigation.subdirectories', 'dropdown');
+        Config::set('hyde.navigation.subdirectory_display', 'dropdown');
 
         // Todo: Replace kernel with mock class
         $this->withoutDefaultPages();
diff --git a/packages/framework/tests/Unit/NavigationDataFactoryUnitTest.php b/packages/framework/tests/Unit/NavigationDataFactoryUnitTest.php
@@ -248,7 +248,7 @@ public function testMakeGroupUsesFrontMatterGroupIfSet()
 
     public function testMakeGroupUsesFrontMatterGroupIfSetRegardlessOfSubdirectoryConfiguration()
     {
-        self::mockConfig(['hyde.navigation.subdirectories' => 'hidden']);
+        self::mockConfig(['hyde.navigation.subdirectory_display' => 'hidden']);
 
         $frontMatter = new FrontMatter(['navigation.group' => 'Test Group']);
         $coreDataObject = new CoreDataObject($frontMatter, new Markdown(), MarkdownPage::class, 'test.md', '', '', '');
@@ -259,7 +259,7 @@ public function testMakeGroupUsesFrontMatterGroupIfSetRegardlessOfSubdirectoryCo
 
     public function testMakeGroupDefaultsToNullIfFrontMatterGroupNotSetAndSubdirectoriesNotUsed()
     {
-        self::mockConfig(['hyde.navigation.subdirectories' => 'hidden']);
+        self::mockConfig(['hyde.navigation.subdirectory_display' => 'hidden']);
 
         $coreDataObject = new CoreDataObject(new FrontMatter(), new Markdown(), MarkdownPage::class, 'test.md', '', '', '');
         $factory = new NavigationConfigTestClass($coreDataObject);
diff --git a/packages/framework/tests/Unit/RelativeLinksAcrossPagesRetainsIntegrityTest.php b/packages/framework/tests/Unit/RelativeLinksAcrossPagesRetainsIntegrityTest.php
@@ -23,7 +23,7 @@ protected function setUp(): void
         parent::setUp();
 
         config(['hyde.enable_cache_busting' => false]);
-        config(['hyde.navigation.subdirectories' => 'flat']);
+        config(['hyde.navigation.subdirectory_display' => 'flat']);
 
         $this->needsDirectory('_pages/nested');
         $this->file('_pages/root.md');
diff --git a/packages/framework/tests/Unit/Views/NavigationHtmlLayoutsTest.php b/packages/framework/tests/Unit/Views/NavigationHtmlLayoutsTest.php
@@ -515,7 +515,7 @@ protected function sidebar(array $withPages = []): RenderedDocumentationSidebarM
 
     protected function useSubdirectoryConfig(string $option): static
     {
-        config(['hyde.navigation.subdirectories' => $option]);
+        config(['hyde.navigation.subdirectory_display' => $option]);
 
         return $this;
     }
diff --git a/packages/framework/tests/Unit/Views/NavigationMenuViewTest.php b/packages/framework/tests/Unit/Views/NavigationMenuViewTest.php
@@ -78,7 +78,7 @@ public function testNavigationMenuWithRootPages()
 
     public function testNavigationMenuWithDropdownPages()
     {
-        config(['hyde.navigation.subdirectories' => 'dropdown']);
+        config(['hyde.navigation.subdirectory_display' => 'dropdown']);
 
         $page = new MarkdownPage('page');
         $bar = new MarkdownPage('foo/bar');
@@ -104,7 +104,7 @@ public function testNavigationMenuWithDropdownPages()
 
     public function testNavigationMenuWithDropdownPagesWithRootGroupPage()
     {
-        config(['hyde.navigation.subdirectories' => 'dropdown']);
+        config(['hyde.navigation.subdirectory_display' => 'dropdown']);
 
         $foo = new MarkdownPage('foo');
         $bar = new MarkdownPage('foo/bar');

Original file line number	Diff line number	Diff line change
`@@ -274,7 +274,7 @@ private function getSubdirectoryName(): string`
`274`	`274`
`275`	`275`	`protected function getSubdirectoryConfiguration(): string`
`276`	`276`	`{`
`277`		`- return Config::getString('hyde.navigation.subdirectories', 'hidden');`
	`277`	`+ return Config::getString('hyde.navigation.subdirectory_display', 'hidden');`
`278`	`278`	`}`
`279`	`279`
`280`	`280`	`/** @param class-string<\Hyde\Pages\Concerns\HydePage> $class */`
Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,7 @@ protected function usesGroups(): bool`
`96`	`96`
`97`	`97`	`return $this->routes->first(fn (Route $route): bool => filled($route->getPage()->navigationMenuGroup())) !== null;`
`98`	`98`	`} else {`
`99`		`- return Config::getString('hyde.navigation.subdirectories', 'hidden') === 'dropdown';`
	`99`	`+ return Config::getString('hyde.navigation.subdirectory_display', 'hidden') === 'dropdown';`
`100`	`100`	`}`
`101`	`101`	`}`
`102`	`102`
Original file line number	Diff line number	Diff line change
`@@ -1176,7 +1176,7 @@ public function testNavigationDataFactoryHidesPageFromNavigationWhenInASubdirect`
`1176`	`1176`
`1177`	`1177`	`public function testNavigationDataFactoryHidesPageFromNavigationWhenInAAndConfigIsSetToHidden()`
`1178`	`1178`	`{`
`1179`		`- config(['hyde.navigation.subdirectories' => 'hidden']);`
	`1179`	`+ config(['hyde.navigation.subdirectory_display' => 'hidden']);`
`1180`	`1180`
`1181`	`1181`	`$page = MarkdownPage::make('foo/bar');`
`1182`	`1182`
`@@ -1186,7 +1186,7 @@ public function testNavigationDataFactoryHidesPageFromNavigationWhenInAAndConfig`
`1186`	`1186`
`1187`	`1187`	`public function testNavigationDataFactoryDoesNotHidePageFromNavigationWhenInASubdirectoryAndAllowedInConfiguration()`
`1188`	`1188`	`{`
`1189`		`- config(['hyde.navigation.subdirectories' => 'flat']);`
	`1189`	`+ config(['hyde.navigation.subdirectory_display' => 'flat']);`
`1190`	`1190`
`1191`	`1191`	`$page = MarkdownPage::make('foo/bar');`
`1192`	`1192`
`@@ -1196,7 +1196,7 @@ public function testNavigationDataFactoryDoesNotHidePageFromNavigationWhenInASub`
`1196`	`1196`
`1197`	`1197`	`public function testNavigationDataFactoryAllowsShowInNavigationAndSetsGroupWhenDropdownIsSelectedInConfig()`
`1198`	`1198`	`{`
`1199`		`- config(['hyde.navigation.subdirectories' => 'dropdown']);`
	`1199`	`+ config(['hyde.navigation.subdirectory_display' => 'dropdown']);`
`1200`	`1200`
`1201`	`1201`	`$page = MarkdownPage::make('foo/bar');`
`1202`	`1202`
Original file line number	Diff line number	Diff line change
`@@ -239,7 +239,7 @@ public function testPagesInSubdirectoriesAreNotAddedToTheNavigationMenu()`
`239`	`239`
`240`	`240`	`public function testPagesInSubdirectoriesCanBeAddedToTheNavigationMenuWithConfigFlatSetting()`
`241`	`241`	`{`
`242`		`- config(['hyde.navigation.subdirectories' => 'flat']);`
	`242`	`+ config(['hyde.navigation.subdirectory_display' => 'flat']);`
`243`	`243`	`$this->directory('_pages/foo');`
`244`	`244`	`$this->file('_pages/foo/bar.md');`
`245`	`245`
`@@ -256,7 +256,7 @@ public function testPagesInSubdirectoriesCanBeAddedToTheNavigationMenuWithConfig`
`256`	`256`
`257`	`257`	`public function testPagesInSubdirectoriesAreNotAddedToTheNavigationMenuWithConfigDropdownSetting()`
`258`	`258`	`{`
`259`		`- config(['hyde.navigation.subdirectories' => 'dropdown']);`
	`259`	`+ config(['hyde.navigation.subdirectory_display' => 'dropdown']);`
`260`	`260`	`$this->directory('_pages/foo');`
`261`	`261`	`$this->file('_pages/foo/bar.md');`
`262`	`262`
`@@ -275,7 +275,7 @@ public function testPagesInSubdirectoriesAreNotAddedToTheNavigationMenuWithConfi`
`275`	`275`
`276`	`276`	`public function testPagesInDropdownsDoNotGetAddedToTheMainNavigation()`
`277`	`277`	`{`
`278`		`- config(['hyde.navigation.subdirectories' => 'dropdown']);`
	`278`	`+ config(['hyde.navigation.subdirectory_display' => 'dropdown']);`
`279`	`279`
`280`	`280`	`Routes::push((new MarkdownPage('foo'))->getRoute());`
`281`	`281`	`Routes::push((new MarkdownPage('bar/baz'))->getRoute());`
Original file line number	Diff line number	Diff line change
`@@ -248,7 +248,7 @@ public function testMakeGroupUsesFrontMatterGroupIfSet()`
`248`	`248`
`249`	`249`	`public function testMakeGroupUsesFrontMatterGroupIfSetRegardlessOfSubdirectoryConfiguration()`
`250`	`250`	`{`
`251`		`- self::mockConfig(['hyde.navigation.subdirectories' => 'hidden']);`
	`251`	`+ self::mockConfig(['hyde.navigation.subdirectory_display' => 'hidden']);`
`252`	`252`
`253`	`253`	`$frontMatter = new FrontMatter(['navigation.group' => 'Test Group']);`
`254`	`254`	`$coreDataObject = new CoreDataObject($frontMatter, new Markdown(), MarkdownPage::class, 'test.md', '', '', '');`
`@@ -259,7 +259,7 @@ public function testMakeGroupUsesFrontMatterGroupIfSetRegardlessOfSubdirectoryCo`
`259`	`259`
`260`	`260`	`public function testMakeGroupDefaultsToNullIfFrontMatterGroupNotSetAndSubdirectoriesNotUsed()`
`261`	`261`	`{`
`262`		`- self::mockConfig(['hyde.navigation.subdirectories' => 'hidden']);`
	`262`	`+ self::mockConfig(['hyde.navigation.subdirectory_display' => 'hidden']);`
`263`	`263`
`264`	`264`	`$coreDataObject = new CoreDataObject(new FrontMatter(), new Markdown(), MarkdownPage::class, 'test.md', '', '', '');`
`265`	`265`	`$factory = new NavigationConfigTestClass($coreDataObject);`