wip

TODO.md

@@ -1,7 +1,7 @@
 # Todo
 
-* [ ] Model database initialisation.
-* [ ] Create new file for new models.
+* [x] Model database initialisation.
+* [x] Create new file for new models.
 * [ ] Update file when updating a model.
 * [ ] Delete file when deleting a model.
 * [ ] Add support for soft deletes.  

composer.json

@@ -25,7 +25,7 @@
         "laravel/pint": "^1.13",
         "laravel/scout": "^9.4",
         "nunomaduro/larastan": "^2.0",
-        "orchestra/testbench": "^8.0",
+        "orchestra/testbench": "^8.12",
         "pestphp/pest": "^2.20",
         "pestphp/pest-plugin-laravel": "^2.2",
         "phpstan/extension-installer": "^1.1",
@@ -48,7 +48,7 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "Orbit\\Tests\\": "tests/"
+            "Tests\\": "tests/"
         }
     },
     "minimum-stability": "dev",

config/orbit.php

@@ -0,0 +1,10 @@
+<?php
+
+return [
+
+    'paths' => [
+        'database' => base_path('framework/cache/orbit/database.sqlite'),
+        'content' => base_path('content'),
+    ],
+
+];

src/Actions/InitialiseOrbitalTable.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Orbit\Actions;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Schema\Blueprint;
+use Orbit\Contracts\Orbit;
+
+class InitialiseOrbitalTable
+{
+    public function hasTable(Orbit & Model $model): bool
+    {
+        $schemaBuilder = $model->resolveConnection()->getSchemaBuilder();
+
+        return $schemaBuilder->hasTable($model->getTable());
+    }
+
+    public function migrate(Orbit & Model $model): void
+    {
+        $table = $model->getTable();
+        $schemaBuilder = $model->resolveConnection()->getSchemaBuilder();
+
+        if ($schemaBuilder->hasTable($table)) {
+            $schemaBuilder->drop($table);
+        }
+
+        $blueprint = null;
+
+        $schemaBuilder->create($table, static function (Blueprint $table) use (&$blueprint, $model) {
+            $blueprint = $table;
+
+            $model->schema($blueprint);
+
+            if ($model->usesTimestamps()) {
+                $blueprint->timestamps();
+            }
+        });
+    }
+}

src/Actions/MaybeCreateOrbitDirectories.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Orbit\Actions;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Filesystem\Filesystem;
+use Orbit\Contracts\Orbit;
+
+class MaybeCreateOrbitDirectories
+{
+    public function execute(Orbit & Model $model)
+    {
+        $fs = new Filesystem();
+
+        $fs->ensureDirectoryExists(config('orbit.paths.content'));
+        $fs->ensureDirectoryExists(dirname(config('orbit.paths.database')));
+
+        if (! $fs->exists(config('orbit.paths.database'))) {
+            $fs->put(config('orbit.paths.database'), '');
+        }
+
+        $modelDirectory = config('orbit.paths.content') . DIRECTORY_SEPARATOR . $model->getTable();
+
+        $fs->ensureDirectoryExists($modelDirectory);
+    }
+}

src/Actions/SaveCompiledAttributesToFile.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Orbit\Actions;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Filesystem\Filesystem;
+use Orbit\Contracts\Driver;
+use Orbit\Contracts\Orbit;
+
+class SaveCompiledAttributesToFile
+{
+    public function execute(Orbit & Model $model, string $compiledAttributes, Driver $driver): void
+    {
+        $directory = config('orbit.paths.content') . DIRECTORY_SEPARATOR . $model->getTable();
+        $filename = "{$model->getKey()}.{$driver->extension()}";
+
+        $fs = new Filesystem();
+        $fs->put($directory . DIRECTORY_SEPARATOR . $filename, $compiledAttributes);
+    }
+}

src/Concerns/Orbital.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace Orbit\Concerns;
+
+use Illuminate\Database\Eloquent\Model;
+use Orbit\Actions\InitialiseOrbitalTable;
+use Orbit\Actions\MaybeCreateOrbitDirectories;
+use Orbit\Actions\SaveCompiledAttributesToFile;
+use Orbit\Contracts\Driver;
+use Orbit\Contracts\Orbit;
+use Orbit\Drivers\Markdown;
+use Orbit\Exceptions\InvalidDriverException;
+use Orbit\Support\ModelAttributeFormatter;
+
+/**
+ * @mixin \Illuminate\Database\Eloquent\Model
+ * @mixin \Orbit\Contracts\Orbit
+ */
+trait Orbital
+{
+    public static function bootOrbital()
+    {
+        $model = new static();
+        $maybeCreateOrbitDirectories = new MaybeCreateOrbitDirectories();
+        $maybeCreateOrbitDirectories->execute($model);
+
+        $driver = $model->getOrbitDriver();
+
+        if (!class_exists($driver)) {
+            throw InvalidDriverException::make($driver);
+        }
+
+        $driver = app($driver);
+
+        if (!$driver instanceof Driver) {
+            throw InvalidDriverException::make($driver::class);
+        }
+
+        $initialiseOrbitTable = new InitialiseOrbitalTable();
+
+        if (! $initialiseOrbitTable->hasTable($model)) {
+            $initialiseOrbitTable->migrate($model);
+        }
+
+        $saveCompiledAttributesToFile = new SaveCompiledAttributesToFile();
+
+        static::created(function (Orbit & Model $model) use ($driver, $saveCompiledAttributesToFile) {
+            $model->refresh();
+
+            $attributes = ModelAttributeFormatter::format($model, $model->getAttributes());
+            $compiledAttributes = $driver->compile($attributes);
+
+            $saveCompiledAttributesToFile->execute($model, $compiledAttributes, $driver);
+        });
+    }
+
+    public static function resolveConnection($connection = null)
+    {
+        return static::$resolver->connection('orbit');
+    }
+
+    public function getConnectionName()
+    {
+        return 'orbit';
+    }
+
+    public function getOrbitDriver(): string
+    {
+        return Markdown::class;
+    }
+}

src/Contracts/Driver.php

@@ -13,4 +13,9 @@ public function parse(string $fileContents): array;
      * Use the given array of attributes to generate the contents of a file.
      */
     public function compile(array $attributes): string;
+
+    /**
+     * Specify the file extension used by this driver.
+     */
+    public function extension(): string;
 }

src/Contracts/Orbital.php → src/Contracts/Orbit.php

@@ -4,12 +4,12 @@
 
 use Illuminate\Database\Schema\Blueprint;
 
-interface Orbital
+interface Orbit
 {
     /**
      * Define the structure of your Orbital model.
      */
-    public static function schema(Blueprint $table): void;
+    public function schema(Blueprint $table): void;
 
     /**
      * Declare which driver the Orbital should use.

src/Drivers/Markdown.php

@@ -25,4 +25,9 @@ public function compile(array $attributes): string
 
         return sprintf("---\n%s\n---\n\n%s", Yaml::dump($attributes), $content);
     }
+
+    public function extension(): string
+    {
+        return 'md';
+    }
 }

src/Exceptions/InvalidDriverException.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Orbit\Exceptions;
+
+use Exception;
+
+class InvalidDriverException extends Exception
+{
+    public static function make(string $driver): static
+    {
+        return new static("Driver {$driver} is invalid or does not implements the \\Orbit\\Contracts\\Driver interface.");
+    }
+}

src/OrbitServiceProvider.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Config\Repository;
 use Illuminate\Filesystem\Filesystem;
+use Orbit\Actions\MaybeCreateOrbitDirectories;
 use Spatie\LaravelPackageTools\Commands\InstallCommand;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
@@ -17,14 +18,12 @@ public function configurePackage(Package $package): void
             ->hasInstallCommand(function (InstallCommand $command) {
                 $command
                     ->startWith(function () {
-                        $fs = new Filesystem();
-
-                        $fs->ensureDirectoryExists(base_path('content'));
-                        $fs->ensureDirectoryExists(storage_path('framework/cache/orbit'));
-                        $fs->ensureDirectoryExists(storage_path('framework/cache/orbit/database.sqlite'));
+                        $maybeCreateOrbitDirectories = new MaybeCreateOrbitDirectories();
+                        $maybeCreateOrbitDirectories->execute();
                     })
                     ->askToStarRepoOnGitHub('ryangjchandler/orbit');
-            });
+            })
+            ->hasConfigFile();
     }
 
     public function packageRegistered()
@@ -33,7 +32,7 @@ public function packageRegistered()
 
         $config->set('database.connections.orbit', [
             'driver' => 'sqlite',
-            'database' => base_path('framework/cache/orbit/database.sqlite'),
+            'database' => $config->get('orbit.paths.database'),
             'foreign_key_constraints' => false,
         ]);
     }

src/Support/ModelAttributeFormatter.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Orbit\Support;
+
+use BackedEnum;
+use Illuminate\Database\Eloquent\Model;
+use Orbit\Contracts\Orbit;
+
+class ModelAttributeFormatter
+{
+    public static function format(Orbit & Model $model, array $attributes): array
+    {
+        $formatted = [];
+
+        foreach ($attributes as $key => $value) {
+            $value = $model->{$key};
+
+            $formatted[$key] = match (true) {
+                $value instanceof BackedEnum => $value->value,
+                default => $value,
+            };
+        }
+
+        return $formatted;
+    }
+}

testbench.yaml

@@ -0,0 +1,2 @@
+providers:
+  - Orbit\OrbitServiceProvider

tests/Feature/Orbital/CreateTest.php

@@ -0,0 +1,17 @@
+<?php
+
+use Tests\Fixtures\Models\Post;
+
+it('creates a new file when a model is created', function () {
+    $post = Post::create([
+        'title' => 'Example Post',
+    ]);
+
+    expect(base_path("content/posts/{$post->id}.md"))
+        ->toBeFile()
+        ->and(file_get_contents(base_path("content/posts/{$post->id}.md")))
+        ->toContain(<<<MD
+        id: $post->id
+        title: 'Example Post'
+        MD);
+});

tests/Fixtures/Models/Post.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Tests\Fixtures\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Schema\Blueprint;
+use Orbit\Concerns\Orbital;
+use Orbit\Contracts\Orbit;
+
+class Post extends Model implements Orbit
+{
+    use Orbital;
+
+    protected $guarded = [];
+
+    public function schema(Blueprint $table): void
+    {
+        $table->id();
+        $table->string('title');
+        $table->longText('content')->nullable();
+    }
+}