Merge pull request #431 from hydephp/organize-and-restructure-code

Organize and restructure Foundation and Kernel code

Author: caendesilva

packages/framework/src/Foundation/BaseSystemCollection.php packages/framework/src/Foundation/Concerns/BaseFoundationCollection.php

@@ -1,18 +1,18 @@
 <?php
 
-namespace Hyde\Framework\Foundation;
+namespace Hyde\Framework\Foundation\Concerns;
 
 use Hyde\Framework\HydeKernel;
 use Illuminate\Support\Collection;
 
 /**
- * @internal Base class for the system collections.
+ * @internal Base class for the kernel auto-discovery collections.
  *
  * @see \Hyde\Framework\Foundation\FileCollection
  * @see \Hyde\Framework\Foundation\PageCollection
  * @see \Hyde\Framework\Foundation\RouteCollection
  */
-abstract class BaseSystemCollection extends Collection
+abstract class BaseFoundationCollection extends Collection
 {
     protected HydeKernel $kernel;
 

packages/framework/src/Foundation/Concerns/HandlesFoundationCollections.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Hyde\Framework\Foundation\Concerns;
+
+use Hyde\Framework\Foundation\FileCollection;
+use Hyde\Framework\Foundation\PageCollection;
+use Hyde\Framework\Foundation\RouteCollection;
+
+/**
+ * @internal Single-use trait for the HydeKernel class.
+ *
+ * @see \Hyde\Framework\HydeKernel
+ */
+trait HandlesFoundationCollections
+{
+    public function files(): FileCollection
+    {
+        $this->needsToBeBooted();
+
+        return $this->files;
+    }
+
+    public function pages(): PageCollection
+    {
+        $this->needsToBeBooted();
+
+        return $this->pages;
+    }
+
+    public function routes(): RouteCollection
+    {
+        $this->needsToBeBooted();
+
+        return $this->routes;
+    }
+
+    protected function needsToBeBooted(): void
+    {
+        if (! $this->booted) {
+            $this->boot();
+        }
+    }
+}

packages/framework/src/Foundation/Concerns/ManagesHydeKernel.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Hyde\Framework\Foundation\Concerns;
+
+use Hyde\Framework\Foundation\FileCollection;
+use Hyde\Framework\Foundation\PageCollection;
+use Hyde\Framework\Foundation\RouteCollection;
+use Hyde\Framework\HydeKernel;
+
+/**
+ * @internal Single-use trait for the HydeKernel class.
+ *
+ * @see \Hyde\Framework\HydeKernel
+ */
+trait ManagesHydeKernel
+{
+    public function boot(): void
+    {
+        $this->booted = true;
+
+        $this->files = FileCollection::boot($this);
+        $this->pages = PageCollection::boot($this);
+        $this->routes = RouteCollection::boot($this);
+    }
+
+    public static function getInstance(): HydeKernel
+    {
+        return static::$instance;
+    }
+
+    public static function setInstance(HydeKernel $instance): void
+    {
+        static::$instance = $instance;
+    }
+
+    public function setBasePath(string $basePath): void
+    {
+        $this->basePath = rtrim($basePath, '/\\');
+    }
+
+    public function getBasePath(): string
+    {
+        return $this->basePath;
+    }
+}

packages/framework/src/Foundation/FileCollection.php

@@ -3,6 +3,7 @@
 namespace Hyde\Framework\Foundation;
 
 use Hyde\Framework\Contracts\AbstractPage;
+use Hyde\Framework\Foundation\Concerns\BaseFoundationCollection;
 use Hyde\Framework\Helpers\Features;
 use Hyde\Framework\Models\File;
 use Hyde\Framework\Models\Pages\BladePage;
@@ -14,7 +15,7 @@
 /**
  * @see \Hyde\Framework\Foundation\FileCollection
  */
-final class FileCollection extends BaseSystemCollection
+final class FileCollection extends BaseFoundationCollection
 {
     public function getSourceFiles(?string $pageClass = null): self
     {

packages/framework/src/Foundation/PageCollection.php

@@ -4,6 +4,7 @@
 
 use Hyde\Framework\Contracts\PageContract;
 use Hyde\Framework\Exceptions\FileNotFoundException;
+use Hyde\Framework\Foundation\Concerns\BaseFoundationCollection;
 use Hyde\Framework\Helpers\Features;
 use Hyde\Framework\Models\Pages\BladePage;
 use Hyde\Framework\Models\Pages\DocumentationPage;
@@ -15,7 +16,7 @@
  * @see \Hyde\Framework\Foundation\RouteCollection
  * @see \Hyde\Framework\Testing\Feature\PageCollectionTest
  */
-final class PageCollection extends BaseSystemCollection
+final class PageCollection extends BaseFoundationCollection
 {
     public function getPage(string $sourcePath): PageContract
     {

packages/framework/src/Foundation/RouteCollection.php

@@ -4,6 +4,7 @@
 
 use Hyde\Framework\Contracts\PageContract;
 use Hyde\Framework\Contracts\RouteContract;
+use Hyde\Framework\Foundation\Concerns\BaseFoundationCollection;
 use Hyde\Framework\Models\Route;
 
 /**
@@ -29,7 +30,7 @@
  * determine where a source file will be compiled to, and where a compiled
  * file was generated from.
  */
-final class RouteCollection extends BaseSystemCollection
+final class RouteCollection extends BaseFoundationCollection
 {
     public function getRoutes(?string $pageClass = null): self
     {

packages/framework/src/HydeKernel.php

@@ -29,9 +29,11 @@
  */
 class HydeKernel implements HydeKernelContract, Arrayable, \JsonSerializable
 {
+    use Foundation\Concerns\HandlesFoundationCollections;
     use Foundation\Concerns\ImplementsStringHelpers;
     use Foundation\Concerns\ForwardsHyperlinks;
     use Foundation\Concerns\ForwardsFilesystem;
+    use Foundation\Concerns\ManagesHydeKernel;
 
     use JsonSerializesArrayable;
     use Macroable;
@@ -56,40 +58,11 @@ public function __construct(?string $basePath = null)
         $this->hyperlinks = new Hyperlinks($this);
     }
 
-    public function boot(): void
-    {
-        $this->booted = true;
-
-        $this->files = FileCollection::boot($this);
-        $this->pages = PageCollection::boot($this);
-        $this->routes = RouteCollection::boot($this);
-    }
-
-    public static function setInstance(HydeKernel $instance): void
-    {
-        static::$instance = $instance;
-    }
-
-    public static function getInstance(): HydeKernel
-    {
-        return static::$instance;
-    }
-
     public static function version(): string
     {
         return InstalledVersions::getPrettyVersion('hyde/framework') ?: 'unreleased';
     }
 
-    public function getBasePath(): string
-    {
-        return $this->basePath;
-    }
-
-    public function setBasePath(string $basePath): void
-    {
-        $this->basePath = rtrim($basePath, '/\\');
-    }
-
     public function features(): Features
     {
         return new Features;
@@ -110,27 +83,6 @@ public function currentRoute(): ?RouteContract
         return View::shared('currentRoute');
     }
 
-    public function files(): FileCollection
-    {
-        $this->needsToBeBooted();
-
-        return $this->files;
-    }
-
-    public function pages(): PageCollection
-    {
-        $this->needsToBeBooted();
-
-        return $this->pages;
-    }
-
-    public function routes(): RouteCollection
-    {
-        $this->needsToBeBooted();
-
-        return $this->routes;
-    }
-
     /**
      * @inheritDoc
      *
@@ -146,11 +98,4 @@ public function toArray(): array
             'routes' => $this->routes(),
         ];
     }
-
-    protected function needsToBeBooted(): void
-    {
-        if (! $this->booted) {
-            $this->boot();
-        }
-    }
 }

packages/framework/tests/Feature/FileCollectionTest.php

@@ -14,7 +14,7 @@
 
 /**
  * @covers \Hyde\Framework\Foundation\FileCollection
- * @covers \Hyde\Framework\Foundation\BaseSystemCollection
+ * @covers \Hyde\Framework\Foundation\Concerns\BaseFoundationCollection
  */
 class FileCollectionTest extends TestCase
 {

packages/framework/tests/Feature/PageCollectionTest.php

@@ -13,7 +13,7 @@
 
 /**
  * @covers \Hyde\Framework\Foundation\PageCollection
- * @covers \Hyde\Framework\Foundation\BaseSystemCollection
+ * @covers \Hyde\Framework\Foundation\Concerns\BaseFoundationCollection
  */
 class PageCollectionTest extends TestCase
 {

packages/framework/tests/Feature/RouteCollectionTest.php

@@ -14,7 +14,7 @@
 
 /**
  * @covers \Hyde\Framework\Foundation\RouteCollection
- * @covers \Hyde\Framework\Foundation\BaseSystemCollection
+ * @covers \Hyde\Framework\Foundation\Concerns\BaseFoundationCollection
  */
 class RouteCollectionTest extends TestCase
 {