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

Refactor HydeKernel code to organized single-used traits
hydephp · Aug 26, 2022 · 9f91a20 · 9f91a20
2 parents 266d2cd + 8b63044
commit 9f91a20
Show file tree

Hide file tree

Showing 4 changed files with 146 additions and 107 deletions.
diff --git a/packages/framework/src/Foundation/Concerns/ForwardsFilesystem.php b/packages/framework/src/Foundation/Concerns/ForwardsFilesystem.php
@@ -0,0 +1,71 @@
+<?php
+
+namespace Hyde\Framework\Foundation\Concerns;
+
+/**
+ * @internal Single-use trait for the HydeKernel class.
+ *
+ * @see \Hyde\Framework\HydeKernel
+ */
+trait ForwardsFilesystem
+{
+    public function path(string $path = ''): string
+    {
+        return $this->filesystem->path($path);
+    }
+
+    public function vendorPath(string $path = ''): string
+    {
+        return $this->filesystem->vendorPath($path);
+    }
+
+    public function copy(string $from, string $to): bool
+    {
+        return $this->filesystem->copy($from, $to);
+    }
+
+    public function touch(string|array $path): bool
+    {
+        return $this->filesystem->touch($path);
+    }
+
+    public function unlink(string|array $path): bool
+    {
+        return $this->filesystem->unlink($path);
+    }
+
+    public function getModelSourcePath(string $model, string $path = ''): string
+    {
+        return $this->filesystem->getModelSourcePath($model, $path);
+    }
+
+    public function getBladePagePath(string $path = ''): string
+    {
+        return $this->filesystem->getBladePagePath($path);
+    }
+
+    public function getMarkdownPagePath(string $path = ''): string
+    {
+        return $this->filesystem->getMarkdownPagePath($path);
+    }
+
+    public function getMarkdownPostPath(string $path = ''): string
+    {
+        return $this->filesystem->getMarkdownPostPath($path);
+    }
+
+    public function getDocumentationPagePath(string $path = ''): string
+    {
+        return $this->filesystem->getDocumentationPagePath($path);
+    }
+
+    public function getSiteOutputPath(string $path = ''): string
+    {
+        return $this->filesystem->getSiteOutputPath($path);
+    }
+
+    public function pathToRelative(string $path): string
+    {
+        return $this->filesystem->pathToRelative($path);
+    }
+}
diff --git a/packages/framework/src/Foundation/Concerns/ForwardsHyperlinks.php b/packages/framework/src/Foundation/Concerns/ForwardsHyperlinks.php
@@ -0,0 +1,36 @@
+<?php
+
+namespace Hyde\Framework\Foundation\Concerns;
+
+/**
+ * @internal Single-use trait for the HydeKernel class.
+ *
+ * @see \Hyde\Framework\HydeKernel
+ */
+trait ForwardsHyperlinks
+{
+    public function formatHtmlPath(string $destination): string
+    {
+        return $this->hyperlinks->formatHtmlPath($destination);
+    }
+
+    public function relativeLink(string $destination): string
+    {
+        return $this->hyperlinks->relativeLink($destination);
+    }
+
+    public function image(string $name, bool $preferQualifiedUrl = false): string
+    {
+        return $this->hyperlinks->image($name, $preferQualifiedUrl);
+    }
+
+    public function hasSiteUrl(): bool
+    {
+        return $this->hyperlinks->hasSiteUrl();
+    }
+
+    public function url(string $path = '', ?string $default = null): string
+    {
+        return $this->hyperlinks->url($path, $default);
+    }
+}
diff --git a/packages/framework/src/Foundation/Concerns/ImplementsStringHelpers.php b/packages/framework/src/Foundation/Concerns/ImplementsStringHelpers.php
@@ -0,0 +1,24 @@
+<?php
+
+namespace Hyde\Framework\Foundation\Concerns;
+
+use Illuminate\Support\Str;
+
+/**
+ * @internal Single-use trait for the HydeKernel class.
+ *
+ * @see \Hyde\Framework\HydeKernel
+ */
+trait ImplementsStringHelpers
+{
+    public function makeTitle(string $slug): string
+    {
+        $alwaysLowercase = ['a', 'an', 'the', 'in', 'on', 'by', 'with', 'of', 'and', 'or', 'but'];
+
+        return ucfirst(str_ireplace(
+            $alwaysLowercase,
+            $alwaysLowercase,
+            Str::headline($slug)
+        ));
+    }
+}
diff --git a/packages/framework/src/HydeKernel.php b/packages/framework/src/HydeKernel.php
@@ -14,7 +14,6 @@
 use Hyde\Framework\Helpers\Features;
 use Illuminate\Contracts\Support\Arrayable;
 use Illuminate\Support\Facades\View;
-use Illuminate\Support\Str;
 use Illuminate\Support\Traits\Macroable;
 
 /**
@@ -30,8 +29,12 @@
  */
 class HydeKernel implements HydeKernelContract, Arrayable, \JsonSerializable
 {
-    use Macroable;
+    use Foundation\Concerns\ImplementsStringHelpers;
+    use Foundation\Concerns\ForwardsHyperlinks;
+    use Foundation\Concerns\ForwardsFilesystem;
+
     use JsonSerializesArrayable;
+    use Macroable;
 
     protected static HydeKernel $instance;
 
@@ -109,127 +112,25 @@ public function currentRoute(): ?RouteContract
 
     public function files(): FileCollection
     {
-        if (! $this->booted) {
-            $this->boot();
-        }
+        $this->needsToBeBooted();
 
         return $this->files;
     }
 
     public function pages(): PageCollection
     {
-        if (! $this->booted) {
-            $this->boot();
-        }
+        $this->needsToBeBooted();
 
         return $this->pages;
     }
 
     public function routes(): RouteCollection
     {
-        if (! $this->booted) {
-            $this->boot();
-        }
+        $this->needsToBeBooted();
 
         return $this->routes;
     }
 
-    public function makeTitle(string $slug): string
-    {
-        $alwaysLowercase = ['a', 'an', 'the', 'in', 'on', 'by', 'with', 'of', 'and', 'or', 'but'];
-
-        return ucfirst(str_ireplace(
-            $alwaysLowercase,
-            $alwaysLowercase,
-            Str::headline($slug)
-        ));
-    }
-
-    public function formatHtmlPath(string $destination): string
-    {
-        return $this->hyperlinks->formatHtmlPath($destination);
-    }
-
-    public function relativeLink(string $destination): string
-    {
-        return $this->hyperlinks->relativeLink($destination);
-    }
-
-    public function image(string $name, bool $preferQualifiedUrl = false): string
-    {
-        return $this->hyperlinks->image($name, $preferQualifiedUrl);
-    }
-
-    public function hasSiteUrl(): bool
-    {
-        return $this->hyperlinks->hasSiteUrl();
-    }
-
-    public function url(string $path = '', ?string $default = null): string
-    {
-        return $this->hyperlinks->url($path, $default);
-    }
-
-    public function path(string $path = ''): string
-    {
-        return $this->filesystem->path($path);
-    }
-
-    public function vendorPath(string $path = ''): string
-    {
-        return $this->filesystem->vendorPath($path);
-    }
-
-    public function copy(string $from, string $to): bool
-    {
-        return $this->filesystem->copy($from, $to);
-    }
-
-    public function touch(string|array $path): bool
-    {
-        return $this->filesystem->touch($path);
-    }
-
-    public function unlink(string|array $path): bool
-    {
-        return $this->filesystem->unlink($path);
-    }
-
-    public function getModelSourcePath(string $model, string $path = ''): string
-    {
-        return $this->filesystem->getModelSourcePath($model, $path);
-    }
-
-    public function getBladePagePath(string $path = ''): string
-    {
-        return $this->filesystem->getBladePagePath($path);
-    }
-
-    public function getMarkdownPagePath(string $path = ''): string
-    {
-        return $this->filesystem->getMarkdownPagePath($path);
-    }
-
-    public function getMarkdownPostPath(string $path = ''): string
-    {
-        return $this->filesystem->getMarkdownPostPath($path);
-    }
-
-    public function getDocumentationPagePath(string $path = ''): string
-    {
-        return $this->filesystem->getDocumentationPagePath($path);
-    }
-
-    public function getSiteOutputPath(string $path = ''): string
-    {
-        return $this->filesystem->getSiteOutputPath($path);
-    }
-
-    public function pathToRelative(string $path): string
-    {
-        return $this->filesystem->pathToRelative($path);
-    }
-
     /**
      * @inheritDoc
      *
@@ -245,4 +146,11 @@ public function toArray(): array
             'routes' => $this->routes(),
         ];
     }
+
+    protected function needsToBeBooted(): void
+    {
+        if (! $this->booted) {
+            $this->boot();
+        }
+    }
 }