Merge pull request #973 from hydephp/add-baseRouteKey-helper-to-HydePage-class

emmadesilva · web-flow · commit f9542127a313 · 2023-02-11T18:46:15.000+01:00
Add static `HydePage::baseRouteKey()` helper method
diff --git a/packages/framework/src/Pages/Concerns/HydePage.php b/packages/framework/src/Pages/Concerns/HydePage.php
@@ -171,6 +171,14 @@ public static function path(string $path = ''): string
         return Hyde::path(unslash(static::sourceDirectory().'/'.unslash($path)));
     }
 
+    /**
+     * Get the route key base for the page model.
+     */
+    public static function baseRouteKey(): string
+    {
+        return static::outputDirectory();
+    }
+
     /**
      * Compile the page into static HTML.
      *
diff --git a/packages/framework/src/Support/Models/RouteKey.php b/packages/framework/src/Support/Models/RouteKey.php
@@ -42,6 +42,6 @@ public function get(): string
     public static function fromPage(string $pageClass, string $identifier): self
     {
         /** @var \Hyde\Pages\Concerns\HydePage $pageClass */
-        return new self(unslash($pageClass::outputDirectory().'/'.$identifier));
+        return new self(unslash($pageClass::baseRouteKey().'/'.$identifier));
     }
 }
diff --git a/packages/framework/tests/Feature/HydePageTest.php b/packages/framework/tests/Feature/HydePageTest.php
@@ -85,6 +85,14 @@ public function testPath()
         );
     }
 
+    public function testBaseRouteKey()
+    {
+        $this->assertSame(
+            TestPage::outputDirectory(),
+            TestPage::baseRouteKey()
+        );
+    }
+
     public function testGetSourcePath()
     {
         $this->assertSame(
diff --git a/packages/framework/tests/Unit/Pages/BaseHydePageUnitTest.php b/packages/framework/tests/Unit/Pages/BaseHydePageUnitTest.php
@@ -26,6 +26,8 @@ protected function mockPageDataFactory(): PageDataFactory
 
     abstract public function testPath();
 
+    abstract public function testBaseRouteKey();
+
     abstract public function testGetBladeView();
 
     abstract public function testSourcePath();
diff --git a/packages/framework/tests/Unit/Pages/BladePageUnitTest.php b/packages/framework/tests/Unit/Pages/BladePageUnitTest.php
@@ -29,6 +29,11 @@ public function testOutputDirectory()
         $this->assertSame('', BladePage::outputDirectory());
     }
 
+    public function testBaseRouteKey()
+    {
+        $this->assertSame('', BladePage::baseRouteKey());
+    }
+
     public function testFileExtension()
     {
         $this->assertSame('.blade.php', BladePage::fileExtension());
diff --git a/packages/framework/tests/Unit/Pages/DocumentationPageUnitTest.php b/packages/framework/tests/Unit/Pages/DocumentationPageUnitTest.php
@@ -30,6 +30,11 @@ public function testOutputDirectory()
         $this->assertSame('docs', DocumentationPage::outputDirectory());
     }
 
+    public function testBaseRouteKey()
+    {
+        $this->assertSame('docs', DocumentationPage::baseRouteKey());
+    }
+
     public function testFileExtension()
     {
         $this->assertSame('.md', DocumentationPage::fileExtension());
diff --git a/packages/framework/tests/Unit/Pages/HtmlPageUnitTest.php b/packages/framework/tests/Unit/Pages/HtmlPageUnitTest.php
@@ -35,6 +35,14 @@ public function testOutputDirectory()
         );
     }
 
+    public function testBaseRouteKey()
+    {
+        $this->assertSame(
+            '',
+            HtmlPage::baseRouteKey()
+        );
+    }
+
     public function testFileExtension()
     {
         $this->assertSame(
diff --git a/packages/framework/tests/Unit/Pages/InMemoryPageUnitTest.php b/packages/framework/tests/Unit/Pages/InMemoryPageUnitTest.php
@@ -38,6 +38,14 @@ public function testOutputDirectory()
         );
     }
 
+    public function testBaseRouteKey()
+    {
+        $this->assertSame(
+            '',
+            InMemoryPage::baseRouteKey()
+        );
+    }
+
     public function testFileExtension()
     {
         $this->assertSame(
diff --git a/packages/framework/tests/Unit/Pages/MarkdownPageUnitTest.php b/packages/framework/tests/Unit/Pages/MarkdownPageUnitTest.php
@@ -36,6 +36,14 @@ public function testOutputDirectory()
         );
     }
 
+    public function testBaseRouteKey()
+    {
+        $this->assertSame(
+            '',
+            MarkdownPage::baseRouteKey()
+        );
+    }
+
     public function testFileExtension()
     {
         $this->assertSame(
diff --git a/packages/framework/tests/Unit/Pages/MarkdownPostUnitTest.php b/packages/framework/tests/Unit/Pages/MarkdownPostUnitTest.php
@@ -36,6 +36,14 @@ public function testOutputDirectory()
         );
     }
 
+    public function testBaseRouteKey()
+    {
+        $this->assertSame(
+            'posts',
+            MarkdownPost::baseRouteKey()
+        );
+    }
+
     public function testFileExtension()
     {
         $this->assertSame(

Original file line number	Diff line number	Diff line change
`@@ -171,6 +171,14 @@ public static function path(string $path = ''): string`
`171`	`171`	`return Hyde::path(unslash(static::sourceDirectory().'/'.unslash($path)));`
`172`	`172`	`}`
`173`	`173`
	`174`	`+ /**`
	`175`	`+ * Get the route key base for the page model.`
	`176`	`+ */`
	`177`	`+ public static function baseRouteKey(): string`
	`178`	`+ {`
	`179`	`+ return static::outputDirectory();`
	`180`	`+ }`
	`181`	`+`
`174`	`182`	`/**`
`175`	`183`	`* Compile the page into static HTML.`
`176`	`184`	`*`
Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,6 @@ public function get(): string`
`42`	`42`	`public static function fromPage(string $pageClass, string $identifier): self`
`43`	`43`	`{`
`44`	`44`	`/** @var \Hyde\Pages\Concerns\HydePage $pageClass */`
`45`		`- return new self(unslash($pageClass::outputDirectory().'/'.$identifier));`
	`45`	`+ return new self(unslash($pageClass::baseRouteKey().'/'.$identifier));`
`46`	`46`	`}`
`47`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -85,6 +85,14 @@ public function testPath()`
`85`	`85`	`);`
`86`	`86`	`}`
`87`	`87`
	`88`	`+ public function testBaseRouteKey()`
	`89`	`+ {`
	`90`	`+ $this->assertSame(`
	`91`	`+ TestPage::outputDirectory(),`
	`92`	`+ TestPage::baseRouteKey()`
	`93`	`+ );`
	`94`	`+ }`
	`95`	`+`
`88`	`96`	`public function testGetSourcePath()`
`89`	`97`	`{`
`90`	`98`	`$this->assertSame(`
Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,11 @@ public function testOutputDirectory()`
`29`	`29`	`$this->assertSame('', BladePage::outputDirectory());`
`30`	`30`	`}`
`31`	`31`
	`32`	`+ public function testBaseRouteKey()`
	`33`	`+ {`
	`34`	`+ $this->assertSame('', BladePage::baseRouteKey());`
	`35`	`+ }`
	`36`	`+`
`32`	`37`	`public function testFileExtension()`
`33`	`38`	`{`
`34`	`39`	`$this->assertSame('.blade.php', BladePage::fileExtension());`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,11 @@ public function testOutputDirectory()`
`30`	`30`	`$this->assertSame('docs', DocumentationPage::outputDirectory());`
`31`	`31`	`}`
`32`	`32`
	`33`	`+ public function testBaseRouteKey()`
	`34`	`+ {`
	`35`	`+ $this->assertSame('docs', DocumentationPage::baseRouteKey());`
	`36`	`+ }`
	`37`	`+`
`33`	`38`	`public function testFileExtension()`
`34`	`39`	`{`
`35`	`40`	`$this->assertSame('.md', DocumentationPage::fileExtension());`
Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,14 @@ public function testOutputDirectory()`
`35`	`35`	`);`
`36`	`36`	`}`
`37`	`37`
	`38`	`+ public function testBaseRouteKey()`
	`39`	`+ {`
	`40`	`+ $this->assertSame(`
	`41`	`+ '',`
	`42`	`+ HtmlPage::baseRouteKey()`
	`43`	`+ );`
	`44`	`+ }`
	`45`	`+`
`38`	`46`	`public function testFileExtension()`
`39`	`47`	`{`
`40`	`48`	`$this->assertSame(`
Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,14 @@ public function testOutputDirectory()`
`38`	`38`	`);`
`39`	`39`	`}`
`40`	`40`
	`41`	`+ public function testBaseRouteKey()`
	`42`	`+ {`
	`43`	`+ $this->assertSame(`
	`44`	`+ '',`
	`45`	`+ InMemoryPage::baseRouteKey()`
	`46`	`+ );`
	`47`	`+ }`
	`48`	`+`
`41`	`49`	`public function testFileExtension()`
`42`	`50`	`{`
`43`	`51`	`$this->assertSame(`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,14 @@ public function testOutputDirectory()`
`36`	`36`	`);`
`37`	`37`	`}`
`38`	`38`
	`39`	`+ public function testBaseRouteKey()`
	`40`	`+ {`
	`41`	`+ $this->assertSame(`
	`42`	`+ '',`
	`43`	`+ MarkdownPage::baseRouteKey()`
	`44`	`+ );`
	`45`	`+ }`
	`46`	`+`
`39`	`47`	`public function testFileExtension()`
`40`	`48`	`{`
`41`	`49`	`$this->assertSame(`