Refactor core internals to use the Laravel Service Container

src/Concerns/Internal/FileHelpers.php

@@ -2,6 +2,8 @@
 
 namespace Hyde\Framework\Concerns\Internal;
 
+use Hyde\Framework\Core\HydeManagerContract;
+
 /**
  * Offloads file helper methods for the Hyde Facade.
  *
@@ -51,12 +53,28 @@ public static function docsIndexPath(): string|false
     public static function path(string $path = ''): string
     {
         if (empty($path)) {
-            return getcwd();
+            return static::getProjectRoot();
         }
 
         $path = trim($path, '/\\');
 
-        return getcwd().DIRECTORY_SEPARATOR.$path;
+        return static::getProjectRoot().DIRECTORY_SEPARATOR.$path;
+    }
+
+    /**
+     * Get the path to the Hyde root directory.
+     * Catches binding resolution errors allowing the function to
+     * be used in PHPUnit tests before the application is booted.
+     *
+     * @return string
+     */
+    public static function getProjectRoot(): string
+    {
+        try {
+            return app(HydeManagerContract::class)->hydeSystemManager()->getProjectRoot();
+        } catch (\Illuminate\Contracts\Container\BindingResolutionException) {
+            return getcwd();
+        }
     }
 
     /**

src/Core/HydeManager.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace Hyde\Framework\Core;
+
+/**
+ * The HydeManager bootstraps the Hyde Framework Core Services.
+ *
+ * To extend implementations, create a class that extends this class,
+ * and register it as the Singleton implementation of the Contract in a
+ * ServiceProvider extending the HydeServiceProvider and load it in app.php.
+ */
+class HydeManager implements HydeManagerContract
+{
+    protected HydeSystemManager $hydeSystemManager;
+    protected SourceLocationManager $sourceLocationManager;
+
+    public function __construct()
+    {
+        $this->bootstrap();
+    }
+
+    public function bootstrap(): void
+    {
+        $this->hydeSystemManager = new ($this->getHydeSystemManager());
+        $this->sourceLocationManager = new ($this->getSourceLocationManager());
+    }
+
+    public function getHydeSystemManager(): string
+    {
+        return HydeSystemProvider::class;
+    }
+
+    public function getSourceLocationManager(): string
+    {
+        return SourceLocationProvider::class;
+    }
+
+    public function hydeSystemManager(): HydeSystemManager
+    {
+        return $this->hydeSystemManager;
+    }
+
+    public function sourceLocationManager(): SourceLocationManager
+    {
+        return $this->sourceLocationManager;
+    }
+
+    /**
+     * Get the instantiated provider from the service container for the given contract.
+     */
+    public static function get(string $classImplementingContract)
+    {
+        return app()->get(HydeManagerContract::class)->{basename($classImplementingContract)}();
+    }
+}

src/Core/HydeManagerContract.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Hyde\Framework\Core;
+
+/**
+ * The Hyde Manager is the glue that holds Hyde services together.
+ * It's intended to act as an easy way to swap out implementations of
+ * various services to extend or modify the default Hyde behavior.
+ *
+ * The interface implementation should be lightweight on its own and
+ * instead of containing a large amount of logic, it should only instead
+ * contain methods specifying where a certain service should be loaded from.
+ * When extending the Hyde core, create a new ServiceProvider extending the
+ * HydeServiceProvider, and register your HydeManagerContract implementation.
+ * Then in the app config, swap out the default ServiceProvider with your own.
+ */
+interface HydeManagerContract
+{
+    /**
+     * Load all the core service implementations into the HydeManager.
+     */
+    public function bootstrap(): void;
+
+    /**
+     * =========================================================================
+     * Get the fully qualified class name of the manager implementation to use.
+     *
+     * Default return syntax: \Hyde\Framework\Core\ServiceManager::class
+     * =========================================================================
+     */
+    public function getHydeSystemManager(): string;
+
+    public function getSourceLocationManager(): string;
+
+    /**
+     * =========================================================================
+     * Get the manager implementation instantiated in the bootstrap process.
+     * =========================================================================.
+     */
+    public function hydeSystemManager(): HydeSystemManager;
+
+    public function sourceLocationManager(): SourceLocationManager;
+}

src/Core/HydeSystemManager.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Hyde\Framework\Core;
+
+interface HydeSystemManager
+{
+    /**
+     * Return the full path to the root of the application.
+     * Used to assemble all file paths in the Hyde::path() method.
+     */
+    public function getProjectRoot(): string;
+}

src/Core/HydeSystemProvider.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Hyde\Framework\Core;
+
+class HydeSystemProvider implements HydeSystemManager
+{
+    /**
+     * @inheritDoc
+     */
+    public function getProjectRoot(): string
+    {
+        return getcwd();
+    }
+}

src/HydeServiceProvider.php

@@ -4,6 +4,8 @@
 
 use Composer\InstalledVersions;
 use Hyde\Framework\Actions\CreatesDefaultDirectories;
+use Hyde\Framework\Core\HydeManager;
+use Hyde\Framework\Core\HydeManagerContract;
 use Illuminate\Support\ServiceProvider;
 
 /**
@@ -18,20 +20,34 @@ class HydeServiceProvider extends ServiceProvider
      */
     public function register()
     {
+        /**
+         * @deprecated
+         */
         $this->app->bind(
             'hyde.version',
             function () {
                 return InstalledVersions::getPrettyVersion('hyde/hyde') ?: 'unreleased';
             }
         );
 
+        /**
+         * @deprecated
+         */
         $this->app->bind(
             'framework.version',
             function () {
                 return InstalledVersions::getPrettyVersion('hyde/framework') ?: 'unreleased';
             }
         );
 
+        /**
+         * Register the HydeManager implementation class.
+         * Swap this out if you want to override the services.
+         */
+        $this->app->singleton(HydeManagerContract::class, function ($app) {
+            return new HydeManager();
+        });
+
         $this->commands([
             Commands\HydePublishHomepageCommand::class,
             Commands\HydeUpdateConfigsCommand::class,
@@ -54,7 +70,15 @@ function () {
      */
     public function boot()
     {
-        (new CreatesDefaultDirectories)->__invoke();
+        /**
+         * Creates the default directories required for Hyde to be able to process files.
+         * If you running the Framework in a non-standard environment that does not
+         * use the Framework to generate files automatically, such as in Buddy,
+         * you can disable this with the "hidden" config option seen below.
+         */
+        if (config('hyde.create_default_directories', true)) {
+            (new CreatesDefaultDirectories)->__invoke();
+        }
 
         $this->loadViewsFrom(__DIR__.'/../resources/views', 'hyde');
 

src/Services/BuildService.php

@@ -42,6 +42,8 @@ public static function getFileExtensionForModelFiles(string $model): string
 
     /**
      * Get the source directory path of a model.
+     *
+     * This is what powers the Hyde autodiscovery.
      */
     public static function getFilePathForModelClassFiles(string $model): string
     {