Move page models into new Models\Pages namespace to make them more distinct from auxiliary helper models

CHANGELOG.md

@@ -21,6 +21,9 @@ This serves two purposes:
 1. People can see what changes they might expect in upcoming releases
 2. At release time, you can move the Unreleased section changes into a new release version section.
 
+This release mainly makes internal changes to the Framework API. If you are an end user, most of the changes are not relevant.
+However, if you are a package developer, or if you have published Blade views or otherwise extended Hyde you may want to take a look as there are internal breaking changes.
+
 ### Added
 - Added Hyde::makeTitle() helper, an improved version of Hyde::titleFromSlug()
 - Added new helper method render() to MarkdownDocuments to compile the Markdown to HTML, fixes https://github.com/hydephp/develop/issues/109
@@ -30,6 +33,10 @@ This serves two purposes:
 - Updates the codebase to use the new Hyde::makeTitle() helper
 - Several internal changes to how page models are structured, https://github.com/hydephp/develop/pull/122
 - Internal: Separate the MarkdownDocument into a dedicated abstract page class, https://github.com/hydephp/develop/pull/126
+- Moved `Hyde\Framework\Models\BladePage` to new namespace `Hyde\Framework\Models\Pages\BladePage`
+- Moved `Hyde\Framework\Models\MarkdownPage` to new namespace `Hyde\Framework\Models\Pages\MarkdownPage`
+- Moved `Hyde\Framework\Models\MarkdownPost` to new namespace `Hyde\Framework\Models\Pages\MarkdownPost`
+- Moved `Hyde\Framework\Models\DocumentationPage` to new namespace `Hyde\Framework\Models\Pages\DocumentationPage`
 
 ### Deprecated
 - Deprecated Hyde::titleFromSlug(), use Hyde::makeTitle() instead

packages/framework/resources/views/components/article-excerpt.blade.php

@@ -1,47 +1,48 @@
 @php
-/** @var \Hyde\Framework\Models\MarkdownPost $post */
+    /** @var \Hyde\Framework\Models\Pages\MarkdownPost $post */
 @endphp
 
 <article class="mt-4 mb-8" itemscope itemtype="http://schema.org/Article">
     <meta itemprop="identifier" content="{{ $post->slug }}">
-@if(Hyde::uriPath())
-    <meta itemprop="url" content="{{ Hyde::uriPath('posts/' . $post->slug) }}">
-@endif
-
-	<header>
-		<a href="posts/{{ Hyde::pageLink($post->slug . '.html') }}" class="block w-fit">
-			<h2 class="text-2xl font-bold text-gray-700 hover:text-gray-900 dark:text-gray-200 dark:hover:text-white transition-colors duration-75">
-				{{ $post->matter['title'] ?? $post->title }}
-			</h2>
-		</a>
-	</header>
+    @if(Hyde::uriPath())
+        <meta itemprop="url" content="{{ Hyde::uriPath('posts/' . $post->slug) }}">
+    @endif
 
-	<footer>
-@isset($post->date)
-		<span class="opacity-75">
+    <header>
+        <a href="posts/{{ Hyde::pageLink($post->slug . '.html') }}" class="block w-fit">
+            <h2 class="text-2xl font-bold text-gray-700 hover:text-gray-900 dark:text-gray-200 dark:hover:text-white transition-colors duration-75">
+                {{ $post->matter['title'] ?? $post->title }}
+            </h2>
+        </a>
+    </header>
+
+    <footer>
+        @isset($post->date)
+            <span class="opacity-75">
 			<span itemprop="dateCreated datePublished">
 				{{ $post->date->short }}</span>{{ isset($post->author) ? ',' : '' }}
 		</span>
-@endisset
-@isset($post->author)
-		<span itemprop="author" itemscope itemtype="http://schema.org/Person">
+        @endisset
+        @isset($post->author)
+            <span itemprop="author" itemscope itemtype="http://schema.org/Person">
 			<span class="opacity-75">by</span>
 			<span itemprop="name">
 				{{ $post->author->name ?? $post->author->username }}
 			</span>
 		</span>
-@endisset
-	</footer>
-	
-@isset($post->matter['description'])
-	<section role="doc-abstract" aria-label="Excerpt">
-		<p class="leading-relaxed my-1">
-			{{ $post->matter['description'] }}
-		</p>
-	</section>
-@endisset
+        @endisset
+    </footer>
+
+    @isset($post->matter['description'])
+        <section role="doc-abstract" aria-label="Excerpt">
+            <p class="leading-relaxed my-1">
+                {{ $post->matter['description'] }}
+            </p>
+        </section>
+    @endisset
 
-	<footer>
-		<a href="posts/{{ Hyde::pageLink($post->slug . '.html') }}" class="text-indigo-500 hover:underline font-medium">Read post</a>
-	</footer>
+    <footer>
+        <a href="posts/{{ Hyde::pageLink($post->slug . '.html') }}" class="text-indigo-500 hover:underline font-medium">
+            Read post</a>
+    </footer>
 </article>

packages/framework/resources/views/components/blog-post-feed.blade.php

@@ -1,3 +1,3 @@
-@foreach(\Hyde\Framework\Models\MarkdownPost::getLatestPosts() as $post)
-	@include('hyde::components.article-excerpt')
+@foreach(\Hyde\Framework\Models\Pages\MarkdownPost::getLatestPosts() as $post)
+    @include('hyde::components.article-excerpt')
 @endforeach

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

@@ -1,13 +1,19 @@
 @php
-	$page = new \Hyde\Framework\Models\DocumentationPage([], '', 'Search', 'search');
-	$title = 'Search';
-	$currentPage = $page->getCurrentPagePath();
-	$markdown = '';
+    $page = new \Hyde\Framework\Models\Pages\DocumentationPage([], '', 'Search', 'search');
+    $title = 'Search';
+    $currentPage = $page->getCurrentPagePath();
+    $markdown = '';
 @endphp
 
 @extends('hyde::layouts.docs')
 @section('content')
-	<h1>Search the documentation site</h1>
-	<style>#searchMenuButton{display:none!important;}#search-results{max-height:unset!important;}</style>
-	@include('hyde::components.docs.search-input')
+    <h1>Search the documentation site</h1>
+    <style>#searchMenuButton {
+            display: none !important;
+        }
+
+        #search-results {
+            max-height: unset !important;
+        }</style>
+    @include('hyde::components.docs.search-input')
 @endsection

packages/framework/src/Actions/CreatesNewPageSourceFile.php

@@ -6,9 +6,9 @@
 use Hyde\Framework\Exceptions\FileConflictException;
 use Hyde\Framework\Exceptions\UnsupportedPageTypeException;
 use Hyde\Framework\Hyde;
-use Hyde\Framework\Models\BladePage;
-use Hyde\Framework\Models\DocumentationPage;
-use Hyde\Framework\Models\MarkdownPage;
+use Hyde\Framework\Models\Pages\BladePage;
+use Hyde\Framework\Models\Pages\DocumentationPage;
+use Hyde\Framework\Models\Pages\MarkdownPage;
 use Illuminate\Support\Str;
 
 /**

packages/framework/src/Actions/GeneratesDocumentationSearchIndexFile.php

@@ -5,7 +5,7 @@
 use Hyde\Framework\Concerns\InteractsWithDirectories;
 use Hyde\Framework\Contracts\ActionContract;
 use Hyde\Framework\Hyde;
-use Hyde\Framework\Models\DocumentationPage;
+use Hyde\Framework\Models\Pages\DocumentationPage;
 use Hyde\Framework\Models\Parsers\DocumentationPageParser;
 use Hyde\Framework\Services\CollectionService;
 use Illuminate\Support\Collection;

packages/framework/src/Commands/HydeBuildStaticSiteCommand.php

@@ -8,10 +8,10 @@
 use Hyde\Framework\Concerns\Internal\TransfersMediaAssetsForBuildCommands;
 use Hyde\Framework\Helpers\Features;
 use Hyde\Framework\Hyde;
-use Hyde\Framework\Models\BladePage;
-use Hyde\Framework\Models\DocumentationPage;
-use Hyde\Framework\Models\MarkdownPage;
-use Hyde\Framework\Models\MarkdownPost;
+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\Services\BuildHookService;
 use Hyde\Framework\Services\CollectionService;
 use Hyde\Framework\Services\DiscoveryService;

packages/framework/src/Commands/HydeMakePageCommand.php

@@ -4,9 +4,9 @@
 
 use Hyde\Framework\Actions\CreatesNewPageSourceFile;
 use Hyde\Framework\Exceptions\UnsupportedPageTypeException;
-use Hyde\Framework\Models\BladePage;
-use Hyde\Framework\Models\DocumentationPage;
-use Hyde\Framework\Models\MarkdownPage;
+use Hyde\Framework\Models\Pages\BladePage;
+use Hyde\Framework\Models\Pages\DocumentationPage;
+use Hyde\Framework\Models\Pages\MarkdownPage;
 use LaravelZero\Framework\Commands\Command;
 
 /**

packages/framework/src/Concerns/FacadeHelpers/HydeSmartDocsFacade.php

@@ -3,7 +3,7 @@
 namespace Hyde\Framework\Concerns\FacadeHelpers;
 
 use Hyde\Framework\Helpers\Features;
-use Hyde\Framework\Models\DocumentationPage;
+use Hyde\Framework\Models\Pages\DocumentationPage;
 
 /**
  * Provide static facade methods, and instance helpers for HydeSmartDocs.
@@ -16,7 +16,7 @@ trait HydeSmartDocsFacade
     /**
      * Create a new HydeSmartDocs instance, process, and return it.
      *
-     * @param  DocumentationPage  $page  The source page object
+     * @param  \Hyde\Framework\Models\Pages\DocumentationPage  $page  The source page object
      * @param  string  $html  compiled HTML content
      * @return static new processed instance
      */

packages/framework/src/Concerns/GeneratesPageMetadata.php

@@ -3,7 +3,7 @@
 namespace Hyde\Framework\Concerns;
 
 use Hyde\Framework\Hyde;
-use Hyde\Framework\Models\MarkdownPost;
+use Hyde\Framework\Models\Pages\MarkdownPost;
 
 /**
  * Generates metadata for page models that have front matter.

packages/framework/src/Concerns/HasPageMetadata.php

@@ -4,7 +4,7 @@
 
 use Hyde\Framework\Helpers\Meta;
 use Hyde\Framework\Hyde;
-use Hyde\Framework\Models\MarkdownPost;
+use Hyde\Framework\Models\Pages\MarkdownPost;
 use Hyde\Framework\Services\RssFeedService;
 use Hyde\Framework\Services\SitemapService;
 

packages/framework/src/Concerns/Internal/FileHelpers.php

@@ -2,7 +2,7 @@
 
 namespace Hyde\Framework\Concerns\Internal;
 
-use Hyde\Framework\Models\DocumentationPage;
+use Hyde\Framework\Models\Pages\DocumentationPage;
 
 /**
  * Offloads file helper methods for the Hyde Facade.

packages/framework/src/Concerns/Internal/FluentPathHelpers.php

@@ -2,10 +2,10 @@
 
 namespace Hyde\Framework\Concerns\Internal;
 
-use Hyde\Framework\Models\BladePage;
-use Hyde\Framework\Models\DocumentationPage;
-use Hyde\Framework\Models\MarkdownPage;
-use Hyde\Framework\Models\MarkdownPost;
+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\Services\DiscoveryService;
 use Hyde\Framework\StaticPageBuilder;
 

packages/framework/src/Concerns/Markdown/HasConfigurableMarkdownFeatures.php

@@ -4,7 +4,7 @@
 
 use Hyde\Framework\Helpers\Features;
 use Hyde\Framework\Helpers\Markdown;
-use Hyde\Framework\Models\DocumentationPage;
+use Hyde\Framework\Models\Pages\DocumentationPage;
 
 /**
  * Allow the Markdown service to have configurable features.

packages/framework/src/Contracts/AbstractMarkdownPage.php

@@ -12,9 +12,9 @@
  *
  * Extends the AbstractPage class to provide relevant
  * helpers for Markdown-based page model classes.
- * @see \Hyde\Framework\Models\MarkdownPage
- * @see \Hyde\Framework\Models\MarkdownPost
- * @see \Hyde\Framework\Models\DocumentationPage
+ * @see \Hyde\Framework\Models\Pages\MarkdownPage
+ * @see \Hyde\Framework\Models\Pages\MarkdownPost
+ * @see \Hyde\Framework\Models\Pages\DocumentationPage
  * @see \Hyde\Framework\Contracts\AbstractPage
  *
  * @test \Hyde\Framework\Testing\Feature\AbstractPageTest

packages/framework/src/HydeServiceProvider.php

@@ -5,10 +5,10 @@
 use Composer\InstalledVersions;
 use Hyde\Framework\Concerns\RegistersDefaultDirectories;
 use Hyde\Framework\Contracts\AssetServiceContract;
-use Hyde\Framework\Models\BladePage;
-use Hyde\Framework\Models\DocumentationPage;
-use Hyde\Framework\Models\MarkdownPage;
-use Hyde\Framework\Models\MarkdownPost;
+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\Services\AssetService;
 use Illuminate\Support\ServiceProvider;
 

packages/framework/src/Models/BladePage.php → packages/framework/src/Models/Pages/BladePage.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Hyde\Framework\Models;
+namespace Hyde\Framework\Models\Pages;
 
 use Hyde\Framework\Contracts\AbstractPage;
 use Hyde\Framework\Contracts\PageParserContract;

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

@@ -1,6 +1,6 @@
 <?php
 
-namespace Hyde\Framework\Models;
+namespace Hyde\Framework\Models\Pages;
 
 use Hyde\Framework\Concerns\HasTableOfContents;
 use Hyde\Framework\Contracts\AbstractMarkdownPage;

packages/framework/src/Models/MarkdownPage.php → packages/framework/src/Models/Pages/MarkdownPage.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Hyde\Framework\Models;
+namespace Hyde\Framework\Models\Pages;
 
 use Hyde\Framework\Contracts\AbstractMarkdownPage;
 use Hyde\Framework\Models\Parsers\MarkdownPageParser;

packages/framework/src/Models/MarkdownPost.php → packages/framework/src/Models/Pages/MarkdownPost.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Hyde\Framework\Models;
+namespace Hyde\Framework\Models\Pages;
 
 use Hyde\Framework\Concerns\GeneratesPageMetadata;
 use Hyde\Framework\Concerns\HasAuthor;

packages/framework/src/Models/Parsers/DocumentationPageParser.php

@@ -4,7 +4,7 @@
 
 use Hyde\Framework\Contracts\AbstractPageParser;
 use Hyde\Framework\Hyde;
-use Hyde\Framework\Models\DocumentationPage;
+use Hyde\Framework\Models\Pages\DocumentationPage;
 use Hyde\Framework\Services\MarkdownFileService;
 
 class DocumentationPageParser extends AbstractPageParser

packages/framework/src/Models/Parsers/MarkdownPageParser.php

@@ -4,7 +4,7 @@
 
 use Hyde\Framework\Contracts\AbstractPageParser;
 use Hyde\Framework\Hyde;
-use Hyde\Framework\Models\MarkdownPage;
+use Hyde\Framework\Models\Pages\MarkdownPage;
 use Hyde\Framework\Services\MarkdownFileService;
 
 /**

packages/framework/src/Models/Parsers/MarkdownPostParser.php

@@ -4,7 +4,7 @@
 
 use Hyde\Framework\Contracts\AbstractPageParser;
 use Hyde\Framework\Hyde;
-use Hyde\Framework\Models\MarkdownPost;
+use Hyde\Framework\Models\Pages\MarkdownPost;
 use Hyde\Framework\Services\MarkdownFileService;
 
 class MarkdownPostParser extends AbstractPageParser

packages/framework/src/Services/CollectionService.php

@@ -4,10 +4,10 @@
 
 use Hyde\Framework\Contracts\AbstractPage;
 use Hyde\Framework\Hyde;
-use Hyde\Framework\Models\BladePage;
-use Hyde\Framework\Models\DocumentationPage;
-use Hyde\Framework\Models\MarkdownPage;
-use Hyde\Framework\Models\MarkdownPost;
+use Hyde\Framework\Models\Pages\BladePage;
+use Hyde\Framework\Models\Pages\DocumentationPage;
+use Hyde\Framework\Models\Pages\MarkdownPage;
+use Hyde\Framework\Models\Pages\MarkdownPost;
 
 /**
  * Contains service methods to return helpful collections of arrays and lists.

packages/framework/src/Services/DiscoveryService.php

@@ -3,10 +3,10 @@
 namespace Hyde\Framework\Services;
 
 use Hyde\Framework\Contracts\AbstractPage;
-use Hyde\Framework\Models\BladePage;
-use Hyde\Framework\Models\DocumentationPage;
-use Hyde\Framework\Models\MarkdownPage;
-use Hyde\Framework\Models\MarkdownPost;
+use Hyde\Framework\Models\Pages\BladePage;
+use Hyde\Framework\Models\Pages\DocumentationPage;
+use Hyde\Framework\Models\Pages\MarkdownPage;
+use Hyde\Framework\Models\Pages\MarkdownPost;
 
 /**
  * The Discovery Service (previously called BuildService) provides

packages/framework/src/Services/HydeSmartDocs.php

@@ -3,7 +3,7 @@
 namespace Hyde\Framework\Services;
 
 use Hyde\Framework\Concerns\FacadeHelpers\HydeSmartDocsFacade;
-use Hyde\Framework\Models\DocumentationPage;
+use Hyde\Framework\Models\Pages\DocumentationPage;
 use Illuminate\Support\Str;
 
 /**

packages/framework/src/Services/RssFeedService.php

@@ -4,7 +4,7 @@
 
 use Hyde\Framework\Helpers\Features;
 use Hyde\Framework\Hyde;
-use Hyde\Framework\Models\MarkdownPost;
+use Hyde\Framework\Models\Pages\MarkdownPost;
 use SimpleXMLElement;
 
 /**