Improve Hyde title generation helper

CHANGELOG.md

@@ -22,19 +22,19 @@ This serves two purposes:
 2. At release time, you can move the Unreleased section changes into a new release version section.
 
 ### Added
-- for new features.
+- Added Hyde::makeTitle() helper, an improved version of Hyde::titleFromSlug()
 
 ### Changed
-- for changes in existing functionality.
+- Updates the codebase to use the new Hyde::makeTitle() helper
 
 ### Deprecated
-- for soon-to-be removed features.
+- Deprecated Hyde::titleFromSlug(), use Hyde::makeTitle() instead
 
 ### Removed
-- Remove unused `$withoutNavigation` variable from the app layout.
+- Remove unused `$withoutNavigation` variable from the app layout
 
 ### Fixed
-- for any bug fixes.
+- Fix style bug https://github.com/hydephp/develop/issues/117, Hyde title helper should not capitalize non-principal words
 
 ### Security
 - in case of vulnerabilities.

packages/framework/resources/views/components/docs/labeled-sidebar-navigation-menu.blade.php

@@ -1,7 +1,7 @@
 <ul id="sidebar-navigation-menu" role="list">
 	@foreach ($sidebar->getCategories() as $category)
 	<li class="sidebar-category" role="listitem">
-		<h4 class="sidebar-category-heading">{{ Hyde::titleFromSlug($category) }}</h4>
+		<h4 class="sidebar-category-heading">{{ Hyde::makeTitle($category) }}</h4>
 		<ul class="sidebar-category-list" role="list">
 			@foreach ($sidebar->getItemsInCategory($category) as $item)
 			<li @class([ 'sidebar-navigation-item' , 'active'=> $item->destination === basename($currentPage)]) role="listitem">

packages/framework/src/Actions/GeneratesNavigationMenu.php

@@ -143,7 +143,7 @@ public function getTitleFromSlug(string $slug): string
             return 'Home';
         }
 
-        return Hyde::titleFromSlug($slug);
+        return Hyde::makeTitle($slug);
     }
 
     /**

packages/framework/src/Concerns/HasDynamicTitle.php

@@ -20,7 +20,7 @@ public function findTitleForDocument(): string
         }
 
         return $this->findTitleTagInMarkdown($this->body)
-            ?: Hyde::titleFromSlug($this->slug);
+            ?: Hyde::makeTitle($this->slug);
     }
 
     /**

packages/framework/src/Helpers/HydeHelperFacade.php

@@ -2,6 +2,8 @@
 
 namespace Hyde\Framework\Helpers;
 
+use Illuminate\Support\Str;
+
 /**
  * Provides convenient access to Hyde helpers, through the main Hyde facade.
  *
@@ -18,4 +20,18 @@ public static function hasFeature(string $feature): bool
     {
         return Features::enabled($feature);
     }
+
+    /**
+     * @since 0.44.0-beta (renamed from titleFromSlug)
+     */
+    public static function makeTitle(string $slug): string
+    {
+        $alwaysLowercase = ['a', 'an', 'the', 'in', 'on', 'by', 'with', 'of', 'and', 'or', 'but'];
+
+        return ucfirst(str_ireplace(
+            $alwaysLowercase,
+            $alwaysLowercase,
+            Str::headline($slug)
+        ));
+    }
 }

packages/framework/src/Hyde.php

@@ -44,6 +44,9 @@ public static function setBasePath(string $path): void
         static::$basePath = $path;
     }
 
+    /**
+     * @deprecated v0.44.0-beta use Hyde::makeTitle() instead.
+     */
     public static function titleFromSlug(string $slug): string
     {
         return Str::title(str_replace('-', ' ', ($slug)));

packages/framework/src/Models/DocumentationSidebarItem.php

@@ -55,7 +55,7 @@ public static function parseFromFile(string $documentationPageSlug): static
         )->matter();
 
         return new static(
-            $matter['label'] ?? Hyde::titleFromSlug($documentationPageSlug),
+            $matter['label'] ?? Hyde::makeTitle($documentationPageSlug),
             $documentationPageSlug,
             $matter['priority'] ?? null,
             $matter['category'] ?? null,

packages/framework/tests/Unit/HydeHelperFacadeMakeTitleTest.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Hyde\Framework\Testing\Unit;
+
+use Hyde\Framework\Helpers\HydeHelperFacade;
+use Hyde\Testing\TestCase;
+
+class HydeHelperFacadeMakeTitleTest extends TestCase
+{
+    public function test_make_title_helper_parses_kebab_case_into_title()
+    {
+        $this->assertEquals('Hello World', HydeHelperFacade::makeTitle('hello-world'));
+    }
+
+    public function test_make_title_helper_parses_snake_case_into_title()
+    {
+        $this->assertEquals('Hello World', HydeHelperFacade::makeTitle('hello_world'));
+    }
+
+    public function test_make_title_helper_parses_camel_case_into_title()
+    {
+        $this->assertEquals('Hello World', HydeHelperFacade::makeTitle('helloWorld'));
+    }
+
+    public function test_make_title_helper_parses_pascal_case_into_title()
+    {
+        $this->assertEquals('Hello World', HydeHelperFacade::makeTitle('HelloWorld'));
+    }
+
+    public function test_make_title_helper_parses_title_case_into_title()
+    {
+        $this->assertEquals('Hello World', HydeHelperFacade::makeTitle('Hello World'));
+    }
+
+    public function test_make_title_helper_parses_title_case_with_spaces_into_title()
+    {
+        $this->assertEquals('Hello World', HydeHelperFacade::makeTitle('Hello World'));
+    }
+
+    public function test_make_title_helper_does_not_capitalize_auxiliary_words()
+    {
+        $this->assertEquals('The a an the in on by with of and or but',
+            HydeHelperFacade::makeTitle('the_a_an_the_in_on_by_with_of_and_or_but'));
+    }
+}