Merge pull request #487 from hydephp/breaking-page-refactors

Merge getCurrentPagePath method into getRouteKey

Author: caendesilva

RELEASE_NOTES.md

@@ -23,6 +23,7 @@ In general, these changes should only affect those who have written custom code
 - Moved class NavItem into Navigation namespace
 - Moved class FindsContentLengthForImageObject into Constructors namespace
 - Merged interface RouteFacadeContract into existing interface RouteContract
+- Merged `getCurrentPagePath()` method into existing `getRouteKey()` method in PageContract and AbstractPage
 - Renamed HydeBuildStaticSiteCommand to HydeBuildSiteCommand
 - Renamed legacy FileCacheService to ViewDiffService
 - Renamed method `Hyde::getSiteOutputPath()` to `Hyde::sitePath()`
@@ -41,6 +42,8 @@ In general, these changes should only affect those who have written custom code
 - Removed deprecated and unused abstract class ActionCommand
 - Removed unused function `array_map_unique`
 - Removed interface RouteFacadeContract (merged into existing RouteContract)
+- Removed method `PageContract::getCurrentPagePath()` (merged into `getRouteKey()` in the same class)
+- Removed method `AbstractPage::getCurrentPagePath()` (merged into `getRouteKey()` in the same class)
 - Using absolute paths for site output directories is no longer supported (use build tasks to move files around after build if needed)
 
 ### Fixed

packages/framework/resources/views/pages/documentation-search.blade.php

@@ -1,7 +1,7 @@
 @php
 // Emulate a page object
 $page = Hyde\Framework\Models\Pages\DocumentationPage::make('search', ['title' => 'Search']);
-$currentPage = $page->getCurrentPagePath();
+$currentPage = $page->getRouteKey();
 $currentRoute = $page->getRoute();
 $markdown = '';
 @endphp

packages/framework/src/Actions/StaticPageBuilder.php

@@ -40,7 +40,7 @@ public function __construct(protected AbstractPage|PageContract $page, bool $sel
     public function __invoke(): string
     {
         view()->share('page', $this->page);
-        view()->share('currentPage', $this->page->getCurrentPagePath());
+        view()->share('currentPage', $this->page->getRouteKey());
         view()->share('currentRoute', $this->page->getRoute());
 
         $this->needsDirectory(Hyde::sitePath());

packages/framework/src/Concerns/AbstractPage.php

@@ -51,7 +51,7 @@ abstract class AbstractPage implements PageContract, CompilableContract, PageSch
     public function __construct(string $identifier = '', FrontMatter|array $matter = [])
     {
         $this->identifier = $identifier;
-        $this->routeKey = $this->getCurrentPagePath();
+        $this->routeKey = trim(static::getOutputDirectory().'/'.$this->identifier, '/');
 
         $this->matter = $matter instanceof FrontMatter ? $matter : new FrontMatter($matter);
         $this->constructPageSchemas();
@@ -151,13 +151,7 @@ public function getSourcePath(): string
     /** @inheritDoc */
     public function getOutputPath(): string
     {
-        return $this->getCurrentPagePath().'.html';
-    }
-
-    /** @inheritDoc */
-    public function getCurrentPagePath(): string
-    {
-        return trim(static::getOutputDirectory().'/'.$this->identifier, '/');
+        return $this->getRouteKey().'.html';
     }
 
     /** @inheritDoc */

packages/framework/src/Contracts/PageContract.php

@@ -120,19 +120,15 @@ public function getSourcePath(): string;
     public function getOutputPath(): string;
 
     /**
-     * Get the URI path relative to the site root.
+     * Get the route key for the page.
      *
-     * @example if the compiled page will be saved to _site/docs/index.html,
-     *          then this method will return 'docs/index'
+     * The route key is the URI path relative to the site root.
      *
-     * @return string URI path relative to the site root.
-     */
-    public function getCurrentPagePath(): string;
-
-    /**
-     * Get the route key for the page.
+     * For example, if the compiled page will be saved to _site/docs/index.html,
+     * then this method will return 'docs/index'. Route keys are used to
+     * identify pages, similar to how named routes work in Laravel.
      *
-     * @return string
+     * @return string URI path relative to the site root.
      */
     public function getRouteKey(): string;
 

packages/framework/src/Models/Pages/DocumentationPage.php

@@ -35,7 +35,7 @@ public function __construct(string $identifier = '', ?FrontMatter $matter = null
     }
 
     /** @inheritDoc */
-    public function getCurrentPagePath(): string
+    public function getRouteKey(): string
     {
         return trim(static::getOutputDirectory().'/'.basename($this->identifier), '/');
     }

packages/framework/tests/Feature/AbstractPageTest.php

@@ -156,21 +156,21 @@ public function test_get_output_location_trims_trailing_slashes_from_basename()
     public function test_get_current_page_path_returns_output_directory_and_basename()
     {
         $page = new MarkdownPage('foo');
-        $this->assertEquals('foo', $page->getCurrentPagePath());
+        $this->assertEquals('foo', $page->getRouteKey());
     }
 
     public function test_get_current_page_path_returns_output_directory_and_basename_for_configured_directory()
     {
         MarkdownPage::$outputDirectory = 'foo';
         $page = new MarkdownPage('bar');
-        $this->assertEquals('foo/bar', $page->getCurrentPagePath());
+        $this->assertEquals('foo/bar', $page->getRouteKey());
     }
 
     public function test_get_current_page_path_trims_trailing_slashes_from_directory_setting()
     {
         MarkdownPage::$outputDirectory = '/foo/\\';
         $page = new MarkdownPage('bar');
-        $this->assertEquals('foo/bar', $page->getCurrentPagePath());
+        $this->assertEquals('foo/bar', $page->getRouteKey());
     }
 
     public function test_get_output_path_returns_current_page_path_with_html_extension_appended()

packages/framework/tests/Feature/RouteTest.php

@@ -48,7 +48,7 @@ public function test_get_route_key_returns_page_path()
         $page = new MarkdownPage();
         $route = new Route($page);
 
-        $this->assertEquals($page->getCurrentPagePath(), $route->getRouteKey());
+        $this->assertEquals($page->getRouteKey(), $route->getRouteKey());
     }
 
     public function test_get_source_file_path_returns_page_source_path()

packages/framework/tests/Unit/DocumentationPageTest.php

@@ -25,11 +25,11 @@ public function test_can_generate_table_of_contents()
     public function test_can_get_current_page_path()
     {
         $page = DocumentationPage::make('foo');
-        $this->assertEquals('docs/foo', $page->getCurrentPagePath());
+        $this->assertEquals('docs/foo', $page->getRouteKey());
 
         config(['docs.output_directory' => 'documentation/latest/']);
         (new HydeServiceProvider($this->app))->register();
-        $this->assertEquals('documentation/latest/foo', $page->getCurrentPagePath());
+        $this->assertEquals('documentation/latest/foo', $page->getRouteKey());
     }
 
     public function test_can_get_online_source_path()

packages/framework/tests/Unit/MarkdownPostHelpersTest.php

@@ -13,7 +13,7 @@ class MarkdownPostHelpersTest extends TestCase
     public function test_get_current_page_path_returns_local_uri_path_for_post_slug()
     {
         $post = new MarkdownPost('foo-bar');
-        $this->assertEquals('posts/foo-bar', $post->getCurrentPagePath());
+        $this->assertEquals('posts/foo-bar', $post->getRouteKey());
     }
 
     public function test_get_canonical_link_returns_canonical_uri_path_for_post_slug()

projects/shelf/admin/src/AdminPage.php

@@ -23,7 +23,7 @@ public function __construct(string $view)
         $this->route = $this->request()?->get('route', 'dashboard') ?? 'dashboard';
     }
 
-    public function getCurrentPagePath(): string
+    public function getRouteKey(): string
     {
         return 'admin';
     }