wip

composer.json

@@ -25,10 +25,12 @@
         "laravel/scout": "^9.4",
         "nunomaduro/larastan": "^2.0",
         "orchestra/testbench": "^8.0",
+        "pestphp/pest": "^2.20",
+        "pestphp/pest-plugin-laravel": "^2.2",
         "phpstan/extension-installer": "^1.1",
         "phpstan/phpstan-deprecation-rules": "^1.0",
         "phpstan/phpstan-phpunit": "^1.0",
-        "phpunit/phpunit": "^9.0"
+        "phpunit/phpunit": "^10.0"
     },
     "extra": {
         "laravel": {

phpunit.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+>
+    <testsuites>
+        <testsuite name="Test Suite">
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+    <source>
+        <include>
+            <directory suffix=".php">./app</directory>
+            <directory suffix=".php">./src</directory>
+        </include>
+    </source>
+</phpunit>

src/Contracts/Driver.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Orbit\Contracts;
+
+use SplFileInfo;
+
+interface Driver
+{
+    /**
+     * Use the given file to generate an array of model attributes.
+     */
+    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;
+}

src/Contracts/Orbital.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Orbit\Contracts;
+
+use Illuminate\Database\Schema\Blueprint;
+
+interface Orbital
+{
+    public static function schema(Blueprint $table): void;
+}

src/Drivers/Driver.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Orbit\Drivers;
+
+use Orbit\Contracts\Driver as DriverContract;
+
+abstract class Driver implements DriverContract
+{
+    //
+}

src/Drivers/Markdown.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Orbit\Drivers;
+
+use Spatie\YamlFrontMatter\YamlFrontMatter;
+use SplFileInfo;
+use Symfony\Component\Yaml\Yaml;
+
+class Markdown extends Driver
+{
+    public function parse(string $fileContents): array
+    {
+        $document = YamlFrontMatter::parse($fileContents);
+
+        return [
+            ...$document->matter(),
+            'content' => trim($document->body()),
+        ];
+    }
+
+    public function compile(array $attributes): string
+    {
+        $content = $attributes['content'] ?? null;
+
+        unset($attributes['content']);
+
+        return sprintf("---\n%s\n---\n\n%s", Yaml::dump($attributes), $content);
+    }
+}

src/OrbitServiceProvider.php

@@ -2,6 +2,8 @@
 
 namespace Orbit;
 
+use Illuminate\Filesystem\Filesystem;
+use Spatie\LaravelPackageTools\Commands\InstallCommand;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 
@@ -10,6 +12,17 @@ class OrbitServiceProvider extends PackageServiceProvider
     public function configurePackage(Package $package): void
     {
         $package
-            ->name('orbit');
+            ->name('orbit')
+            ->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'));
+                    })
+                    ->askToStarRepoOnGitHub('ryangjchandler/orbit');
+            });
     }
 }

tests/Pest.php

@@ -0,0 +1,45 @@
+<?php
+
+/*
+|--------------------------------------------------------------------------
+| Test Case
+|--------------------------------------------------------------------------
+|
+| The closure you provide to your test functions is always bound to a specific PHPUnit test
+| case class. By default, that class is "PHPUnit\Framework\TestCase". Of course, you may
+| need to change it using the "uses()" function to bind a different classes or traits.
+|
+*/
+
+// uses(Tests\TestCase::class)->in('Feature');
+
+/*
+|--------------------------------------------------------------------------
+| Expectations
+|--------------------------------------------------------------------------
+|
+| When you're writing tests, you often need to check that values meet certain conditions. The
+| "expect()" function gives you access to a set of "expectations" methods that you can use
+| to assert different things. Of course, you may extend the Expectation API at any time.
+|
+*/
+
+expect()->extend('toBeOne', function () {
+    return $this->toBe(1);
+});
+
+/*
+|--------------------------------------------------------------------------
+| Functions
+|--------------------------------------------------------------------------
+|
+| While Pest is very powerful out-of-the-box, you may have some testing code specific to your
+| project that you don't want to repeat in every file. Here you can also expose helpers as
+| global functions to help you to reduce the number of lines of code in your test files.
+|
+*/
+
+function something()
+{
+    // ..
+}

tests/TestCase.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Tests;
+
+use PHPUnit\Framework\TestCase as BaseTestCase;
+
+abstract class TestCase extends BaseTestCase
+{
+    //
+}

tests/Unit/Drivers/MarkdownTest.php

@@ -0,0 +1,31 @@
+<?php
+
+use Orbit\Drivers\Markdown;
+use PHPUnit\Framework\TestCase;
+
+uses(TestCase::class);
+
+it('can parse a markdown file into an array of attributes', function () {
+    $markdown = <<<'MD'
+    ---
+    name: Ryan
+    categories: [1, 'foo']
+    published_at: 2023-09-30 00:00:00
+    is_published: true
+    ---
+
+    # Here is the content of the file!
+    MD;
+
+    $driver = new Markdown();
+
+    expect($driver->parse($markdown))
+        ->toBeArray()
+        ->toBe([
+            'name' => 'Ryan',
+            'categories' => [1, 'foo'],
+            'published_at' => 1696032000,
+            'is_published' => true,
+            'content' => '# Here is the content of the file!',
+        ]);
+});