Merge pull request #205 from hydephp/204-go-over-router-namespaces-before-release

caendesilva · web-flow · commit 643706576753 · 2022-07-09T20:46:38.000+02:00
Update Router namespaces
diff --git a/packages/framework/resources/views/layouts/navigation.blade.php b/packages/framework/resources/views/layouts/navigation.blade.php
@@ -1,29 +1,42 @@
 @php
-$navigation = \Hyde\Framework\Modules\Navigation\NavigationMenu::create($page->getRoute());
+	$navigation = \Hyde\Framework\Models\NavigationMenu::create($page->getRoute());
 @endphp
 
-<nav aria-label="Main navigation" id="main-navigation" class="flex flex-wrap items-center justify-between p-4 shadow-lg sm:shadow-xl md:shadow-none dark:bg-gray-800">
+<nav aria-label="Main navigation" id="main-navigation"
+	 class="flex flex-wrap items-center justify-between p-4 shadow-lg sm:shadow-xl md:shadow-none dark:bg-gray-800">
 	<div class="flex flex-grow items-center flex-shrink-0 text-gray-700 dark:text-gray-200">
 		@include('hyde::components.navigation.navigation-brand')
 
 		<div class="ml-auto">
-		@include('hyde::components.navigation.theme-toggle-button')
+			@include('hyde::components.navigation.theme-toggle-button')
 		</div>
 	</div>
 
 	<div class="block md:hidden">
-		<button id="navigation-toggle-button" class="flex items-center px-3 py-1 hover:text-gray-700 dark:text-gray-200" aria-label="Toggle navigation menu">
-			<svg title="Open Navigation Menu" class="dark:fill-gray-200" style="display: block;" id="open-main-navigation-menu-icon" xmlns="http://www.w3.org/2000/svg" height="24" viewBox="0 0 24 24" width="24"><title>Open Menu</title><path d="M0 0h24v24H0z" fill="none"/><path d="M3 18h18v-2H3v2zm0-5h18v-2H3v2zm0-7v2h18V6H3z"/></svg>
-			<svg title="Close Navigation Menu" class="dark:fill-gray-200" style="display: none;" id="close-main-navigation-menu-icon" xmlns="http://www.w3.org/2000/svg" height="24" viewBox="0 0 24 24" width="24"><title>Close Menu</title> <path d="M0 0h24v24H0z" fill="none"></path> <path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"></path> </svg>
+		<button id="navigation-toggle-button" class="flex items-center px-3 py-1 hover:text-gray-700 dark:text-gray-200"
+				aria-label="Toggle navigation menu">
+			<svg title="Open Navigation Menu" class="dark:fill-gray-200" style="display: block;"
+				 id="open-main-navigation-menu-icon" xmlns="http://www.w3.org/2000/svg" height="24" viewBox="0 0 24 24"
+				 width="24"><title>Open Menu</title>
+				<path d="M0 0h24v24H0z" fill="none"/>
+				<path d="M3 18h18v-2H3v2zm0-5h18v-2H3v2zm0-7v2h18V6H3z"/>
+			</svg>
+			<svg title="Close Navigation Menu" class="dark:fill-gray-200" style="display: none;"
+				 id="close-main-navigation-menu-icon" xmlns="http://www.w3.org/2000/svg" height="24" viewBox="0 0 24 24"
+				 width="24"><title>Close Menu</title>
+				<path d="M0 0h24v24H0z" fill="none"></path>
+				<path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"></path>
+			</svg>
 		</button>
 	</div>
 
-	<div id="main-navigation-links" class="w-full hidden md:flex flex-grow md:flex-grow-0 md:items-center md:w-auto px-6 -mx-4 border-t mt-3 pt-3 md:border-none md:mt-0 md:py-0 border-gray-200 dark:border-gray-700">
+	<div id="main-navigation-links"
+		 class="w-full hidden md:flex flex-grow md:flex-grow-0 md:items-center md:w-auto px-6 -mx-4 border-t mt-3 pt-3 md:border-none md:mt-0 md:py-0 border-gray-200 dark:border-gray-700">
 		<ul aria-label="Navigation links" class="md:flex-grow md:flex justify-end">
 			@foreach ($navigation->items as $item)
-			<li class="md:mx-2">
-				@include('hyde::components.navigation.navigation-link')
-			</li>
+				<li class="md:mx-2">
+					@include('hyde::components.navigation.navigation-link')
+				</li>
 			@endforeach
 		</ul>
 	</div>
diff --git a/packages/framework/src/Concerns/CanBeInNavigation.php b/packages/framework/src/Concerns/CanBeInNavigation.php
@@ -112,7 +112,7 @@ public function navigationMenuTitle(): string
      * If an item returns a route collection,
      * it will automatically be made into a dropdown.
      *
-     * @return \Illuminate\Support\Collection<\Hyde\Framework\Modules\Routing\Route>
+     * @return \Illuminate\Support\Collection<\Hyde\Framework\Models\Route>
      */
     // public function navigationMenuChildren(): Collection;
 }
diff --git a/packages/framework/src/Contracts/AbstractPage.php b/packages/framework/src/Contracts/AbstractPage.php
@@ -4,7 +4,7 @@
 
 use Hyde\Framework\Concerns\CanBeInNavigation;
 use Hyde\Framework\Concerns\HasPageMetadata;
-use Hyde\Framework\Modules\Routing\Route;
+use Hyde\Framework\Models\Route;
 use Hyde\Framework\Services\CollectionService;
 use Illuminate\Support\Collection;
 
diff --git a/packages/framework/src/Contracts/PageContract.php b/packages/framework/src/Contracts/PageContract.php
@@ -2,7 +2,6 @@
 
 namespace Hyde\Framework\Contracts;
 
-use Hyde\Framework\Modules\Routing\RouteContract;
 use Illuminate\Support\Collection;
 
 interface PageContract
@@ -115,7 +114,7 @@ public function getCurrentPagePath(): string;
     /**
      * Get the route for the page.
      *
-     * @return \Hyde\Framework\Modules\Routing\RouteContract
+     * @return \Hyde\Framework\Contracts\RouteContract
      */
     public function getRoute(): RouteContract;
 }
diff --git a/packages/framework/src/Contracts/RouteContract.php b/packages/framework/src/Contracts/RouteContract.php
@@ -1,16 +1,14 @@
 <?php
 
-namespace Hyde\Framework\Modules\Routing;
-
-use Hyde\Framework\Contracts\PageContract;
+namespace Hyde\Framework\Contracts;
 
 /**
  * This contract defines the methods that a Route object must implement.
  * These methods are each applied to the single route instance.
  *
  * In Hyde, the route models also serve as a facade for all routes, see the dedicated interface:
  *
- * @see \Hyde\Framework\Modules\Routing\RouteFacadeContract for the static facade methods.
+ * @see \Hyde\Framework\Contracts\RouteFacadeContract for the static facade methods.
  */
 interface RouteContract
 {
diff --git a/packages/framework/src/Contracts/RouteFacadeContract.php b/packages/framework/src/Contracts/RouteFacadeContract.php
@@ -1,14 +1,13 @@
 <?php
 
-namespace Hyde\Framework\Modules\Routing;
+namespace Hyde\Framework\Contracts;
 
-use Hyde\Framework\Contracts\PageContract;
 use Illuminate\Support\Collection;
 
 /**
  * This contract defines the static facade methods for the Route class.
  *
- * @see \Hyde\Framework\Modules\Routing\RouteContract for the interface that each route model must implement.
+ * @see \Hyde\Framework\Contracts\RouteContract for the interface that each route model must implement.
  */
 interface RouteFacadeContract
 {
@@ -18,46 +17,46 @@ interface RouteFacadeContract
      * Alias for static::getFromKey().
      *
      * @param  string  $routeKey  Example: posts/foo.md
-     * @return \Hyde\Framework\Modules\Routing\RouteContract
+     * @return \Hyde\Framework\Contracts\RouteContract
      *
-     * @throws \Hyde\Framework\Modules\Routing\RouteNotFoundException
+     * @throws \Hyde\Framework\Exceptions\RouteNotFoundException
      */
     public static function get(string $routeKey): RouteContract;
 
     /**
      * Get a route from the Router index for the specified route key.
      *
      * @param  string  $routeKey  Example: posts/foo.md
-     * @return \Hyde\Framework\Modules\Routing\RouteContract
+     * @return \Hyde\Framework\Contracts\RouteContract
      *
-     * @throws \Hyde\Framework\Modules\Routing\RouteNotFoundException
+     * @throws \Hyde\Framework\Exceptions\RouteNotFoundException
      */
     public static function getFromKey(string $routeKey): RouteContract;
 
     /**
      * Get a route from the Router index for the specified source file path.
      *
      * @param  string  $sourceFilePath  Example: _posts/foo.md
-     * @return \Hyde\Framework\Modules\Routing\RouteContract
+     * @return \Hyde\Framework\Contracts\RouteContract
      *
-     * @throws \Hyde\Framework\Modules\Routing\RouteNotFoundException
+     * @throws \Hyde\Framework\Exceptions\RouteNotFoundException
      */
     public static function getFromSource(string $sourceFilePath): RouteContract;
 
     /**
      * Get a route from the Router index for the supplied page model.
      *
      * @param  \Hyde\Framework\Contracts\PageContract  $page
-     * @return \Hyde\Framework\Modules\Routing\RouteContract
+     * @return \Hyde\Framework\Contracts\RouteContract
      *
-     * @throws \Hyde\Framework\Modules\Routing\RouteNotFoundException
+     * @throws \Hyde\Framework\Exceptions\RouteNotFoundException
      */
     public static function getFromModel(PageContract $page): RouteContract;
 
     /**
      * Get all routes from the Router index.
      *
-     * @return \Illuminate\Support\Collection<\Hyde\Framework\Modules\Routing\RouteContract>
+     * @return \Illuminate\Support\Collection<\Hyde\Framework\Contracts\RouteContract>
      */
     public static function all(): Collection;
 }
diff --git a/packages/framework/src/Contracts/RouterContract.php b/packages/framework/src/Contracts/RouterContract.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Hyde\Framework\Modules\Routing;
+namespace Hyde\Framework\Contracts;
 
 use Illuminate\Support\Collection;
 
@@ -21,15 +21,15 @@ public static function getInstance(): RouterContract;
     /**
      * Get the routes discovered by the router.
      *
-     * @return \Illuminate\Support\Collection<\Hyde\Framework\Modules\Routing\RouteContract>
+     * @return \Illuminate\Support\Collection<\Hyde\Framework\Contracts\RouteContract>
      */
     public function getRoutes(): Collection;
 
     /**
      * Get all discovered routes for the given page class.
      *
      * @param  class-string<\Hyde\Framework\Contracts\PageContract>  $pageClass
-     * @return \Illuminate\Support\Collection<\Hyde\Framework\Modules\Routing\RouteContract>
+     * @return \Illuminate\Support\Collection<\Hyde\Framework\Contracts\RouteContract>
      */
     public function getRoutesForModel(string $pageClass): Collection;
 }
diff --git a/packages/framework/src/Exceptions/RouteNotFoundException.php b/packages/framework/src/Exceptions/RouteNotFoundException.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Hyde\Framework\Modules\Routing;
+namespace Hyde\Framework\Exceptions;
 
 class RouteNotFoundException extends \Exception
 {
diff --git a/packages/framework/src/Facades/Route.php b/packages/framework/src/Facades/Route.php
@@ -3,12 +3,12 @@
 namespace Hyde\Framework\Facades;
 
 use Hyde\Framework\Contracts\PageContract;
-use Hyde\Framework\Modules\Routing\Route as RouteModel;
-use Hyde\Framework\Modules\Routing\RouteFacadeContract;
+use Hyde\Framework\Contracts\RouteFacadeContract;
+use Hyde\Framework\Models\Route as RouteModel;
 use Illuminate\Support\Collection;
 
 /**
- * @see \Hyde\Framework\Modules\Routing\Route
+ * @see \Hyde\Framework\Models\Route
  * @see \Hyde\Framework\Testing\Feature\RouteFacadeTest
  */
 class Route implements RouteFacadeContract
diff --git a/packages/framework/src/Models/NavItem.php b/packages/framework/src/Models/NavItem.php
@@ -3,8 +3,7 @@
 namespace Hyde\Framework\Models;
 
 use Hyde\Framework\Contracts\PageContract;
-use Hyde\Framework\Facades\Route;
-use Hyde\Framework\Modules\Routing\RouteContract;
+use Hyde\Framework\Contracts\RouteContract;
 
 /**
  * Abstraction for a navigation menu item.
@@ -26,7 +25,7 @@ class NavItem
     /**
      * Create a new navigation menu item.
      *
-     * @param  \Hyde\Framework\Modules\Routing\RouteContract|null  $route
+     * @param  \Hyde\Framework\Contracts\RouteContract|null  $route
      * @param  string  $title
      * @param  int  $priority
      * @param  bool  $hidden
diff --git a/packages/framework/src/Models/NavigationMenu.php b/packages/framework/src/Models/NavigationMenu.php
@@ -1,11 +1,9 @@
 <?php
 
-namespace Hyde\Framework\Modules\Navigation;
+namespace Hyde\Framework\Models;
 
-use Hyde\Framework\Models\NavItem;
-use Hyde\Framework\Modules\Routing\Route;
-use Hyde\Framework\Modules\Routing\RouteContract;
-use Hyde\Framework\Modules\Routing\Router;
+use Hyde\Framework\Contracts\RouteContract;
+use Hyde\Framework\Router;
 use Illuminate\Support\Collection;
 
 /**
diff --git a/packages/framework/src/Models/Route.php b/packages/framework/src/Models/Route.php
@@ -1,9 +1,13 @@
 <?php
 
-namespace Hyde\Framework\Modules\Routing;
+namespace Hyde\Framework\Models;
 
 use Hyde\Framework\Contracts\PageContract;
+use Hyde\Framework\Contracts\RouteContract;
+use Hyde\Framework\Contracts\RouteFacadeContract;
+use Hyde\Framework\Exceptions\RouteNotFoundException;
 use Hyde\Framework\Hyde;
+use Hyde\Framework\Router;
 use Illuminate\Support\Collection;
 
 /**
diff --git a/packages/framework/src/Router.php b/packages/framework/src/Router.php
@@ -1,13 +1,16 @@
 <?php
 
-namespace Hyde\Framework\Modules\Routing;
+namespace Hyde\Framework;
 
 use Hyde\Framework\Contracts\PageContract;
+use Hyde\Framework\Contracts\RouteContract;
+use Hyde\Framework\Contracts\RouterContract;
 use Hyde\Framework\Helpers\Features;
 use Hyde\Framework\Models\Pages\BladePage;
 use Hyde\Framework\Models\Pages\DocumentationPage;
 use Hyde\Framework\Models\Pages\MarkdownPage;
 use Hyde\Framework\Models\Pages\MarkdownPost;
+use Hyde\Framework\Models\Route;
 use Illuminate\Support\Collection;
 
 /**
@@ -42,7 +45,7 @@ class Router implements RouterContract
     /**
      * The routes discovered by the router.
      *
-     * @var \Illuminate\Support\Collection<\Hyde\Framework\Modules\Routing\RouteContract>
+     * @var \Illuminate\Support\Collection<\Hyde\Framework\Contracts\RouteContract>
      */
     protected Collection $routes;
 
diff --git a/packages/framework/src/Services/BuildService.php b/packages/framework/src/Services/BuildService.php
@@ -3,9 +3,9 @@
 namespace Hyde\Framework\Services;
 
 use Hyde\Framework\Concerns\InteractsWithDirectories;
+use Hyde\Framework\Contracts\RouteContract as Route;
 use Hyde\Framework\Hyde;
-use Hyde\Framework\Modules\Routing\RouteContract as Route;
-use Hyde\Framework\Modules\Routing\Router;
+use Hyde\Framework\Router;
 use Hyde\Framework\StaticPageBuilder;
 use Illuminate\Console\Concerns\InteractsWithIO;
 use Illuminate\Console\OutputStyle;
diff --git a/packages/framework/src/Services/RebuildService.php b/packages/framework/src/Services/RebuildService.php
@@ -2,7 +2,7 @@
 
 namespace Hyde\Framework\Services;
 
-use Hyde\Framework\Modules\Routing\Route;
+use Hyde\Framework\Models\Route;
 use Hyde\Framework\StaticPageBuilder;
 
 /**
diff --git a/packages/framework/tests/Feature/AbstractPageTest.php b/packages/framework/tests/Feature/AbstractPageTest.php
@@ -14,7 +14,7 @@
 use Hyde\Framework\Models\Pages\MarkdownPost;
 use Hyde\Framework\Models\Parsers\MarkdownPageParser;
 use Hyde\Framework\Models\Parsers\MarkdownPostParser;
-use Hyde\Framework\Modules\Routing\Route;
+use Hyde\Framework\Models\Route;
 use Hyde\Testing\TestCase;
 
 /**
diff --git a/packages/framework/tests/Feature/NavigationMenuTest.php b/packages/framework/tests/Feature/NavigationMenuTest.php
@@ -3,14 +3,14 @@
 namespace Hyde\Framework\Testing\Feature;
 
 use Hyde\Framework\Hyde;
+use Hyde\Framework\Models\NavigationMenu;
 use Hyde\Framework\Models\NavItem;
-use Hyde\Framework\Modules\Navigation\NavigationMenu;
-use Hyde\Framework\Modules\Routing\Route;
+use Hyde\Framework\Models\Route;
 use Hyde\Testing\TestCase;
 use Illuminate\Support\Collection;
 
 /**
- * @covers \Hyde\Framework\Modules\Navigation\NavigationMenu
+ * @covers \Hyde\Framework\Models\NavigationMenu
  */
 class NavigationMenuTest extends TestCase
 {
diff --git a/packages/framework/tests/Feature/RouteFacadeTest.php b/packages/framework/tests/Feature/RouteFacadeTest.php
@@ -4,7 +4,7 @@
 
 use Hyde\Framework\Facades\Route;
 use Hyde\Framework\Models\Pages\BladePage;
-use Hyde\Framework\Modules\Routing\Route as BaseRoute;
+use Hyde\Framework\Models\Route as BaseRoute;
 use Hyde\Testing\TestCase;
 
 /**
diff --git a/packages/framework/tests/Feature/RouteTest.php b/packages/framework/tests/Feature/RouteTest.php
@@ -2,19 +2,19 @@
 
 namespace Hyde\Framework\Testing\Feature;
 
+use Hyde\Framework\Contracts\RouteContract;
+use Hyde\Framework\Exceptions\RouteNotFoundException;
 use Hyde\Framework\Hyde;
 use Hyde\Framework\Models\Pages\BladePage;
 use Hyde\Framework\Models\Pages\DocumentationPage;
 use Hyde\Framework\Models\Pages\MarkdownPage;
 use Hyde\Framework\Models\Pages\MarkdownPost;
-use Hyde\Framework\Modules\Routing\Route;
-use Hyde\Framework\Modules\Routing\RouteContract;
-use Hyde\Framework\Modules\Routing\RouteNotFoundException;
-use Hyde\Framework\Modules\Routing\Router;
+use Hyde\Framework\Models\Route;
+use Hyde\Framework\Router;
 use Hyde\Testing\TestCase;
 
 /**
- * @covers \Hyde\Framework\Modules\Routing\Route
+ * @covers \Hyde\Framework\Models\Route
  */
 class RouteTest extends TestCase
 {
diff --git a/packages/framework/tests/Feature/RouterTest.php b/packages/framework/tests/Feature/RouterTest.php
diff --git a/packages/framework/tests/Unit/NavItemTest.php b/packages/framework/tests/Unit/NavItemTest.php
diff --git a/packages/framework/tests/Unit/RouteNotFoundExceptionTest.php b/packages/framework/tests/Unit/RouteNotFoundExceptionTest.php

Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@ public function navigationMenuTitle(): string`
`112`	`112`	`* If an item returns a route collection,`
`113`	`113`	`* it will automatically be made into a dropdown.`
`114`	`114`	`*`
`115`		`- * @return \Illuminate\Support\Collection<\Hyde\Framework\Modules\Routing\Route>`
	`115`	`+ * @return \Illuminate\Support\Collection<\Hyde\Framework\Models\Route>`
`116`	`116`	`*/`
`117`	`117`	`// public function navigationMenuChildren(): Collection;`
`118`	`118`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,6 @@`
`2`	`2`
`3`	`3`	`namespace Hyde\Framework\Contracts;`
`4`	`4`
`5`		`-use Hyde\Framework\Modules\Routing\RouteContract;`
`6`	`5`	`use Illuminate\Support\Collection;`
`7`	`6`
`8`	`7`	`interface PageContract`
`@@ -115,7 +114,7 @@ public function getCurrentPagePath(): string;`
`115`	`114`	`/**`
`116`	`115`	`* Get the route for the page.`
`117`	`116`	`*`
`118`		`- * @return \Hyde\Framework\Modules\Routing\RouteContract`
	`117`	`+ * @return \Hyde\Framework\Contracts\RouteContract`
`119`	`118`	`*/`
`120`	`119`	`public function getRoute(): RouteContract;`
`121`	`120`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,16 +1,14 @@`
`1`	`1`	`<?php`
`2`	`2`
`3`		`-namespace Hyde\Framework\Modules\Routing;`
`4`		`-`
`5`		`-use Hyde\Framework\Contracts\PageContract;`
	`3`	`+namespace Hyde\Framework\Contracts;`
`6`	`4`
`7`	`5`	`/**`
`8`	`6`	`* This contract defines the methods that a Route object must implement.`
`9`	`7`	`* These methods are each applied to the single route instance.`
`10`	`8`	`*`
`11`	`9`	`* In Hyde, the route models also serve as a facade for all routes, see the dedicated interface:`
`12`	`10`	`*`
`13`		`- * @see \Hyde\Framework\Modules\Routing\RouteFacadeContract for the static facade methods.`
	`11`	`+ * @see \Hyde\Framework\Contracts\RouteFacadeContract for the static facade methods.`
`14`	`12`	`*/`
`15`	`13`	`interface RouteContract`
`16`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`<?php`
`2`	`2`
`3`		`-namespace Hyde\Framework\Modules\Routing;`
	`3`	`+namespace Hyde\Framework\Exceptions;`
`4`	`4`
`5`	`5`	`class RouteNotFoundException extends \Exception`
`6`	`6`	`{`