Merge pull request #2 from plank/1-navigation-model

Add base model linking functionality

composer.json

@@ -21,6 +21,7 @@
         "illuminate/contracts": "^10.0"
     },
     "require-dev": {
+        "doctrine/dbal": "^3.7",
         "laravel/pint": "^1.0",
         "nunomaduro/collision": "^7.8",
         "nunomaduro/larastan": "^2.0.1",

config/frontdesk.php

@@ -1,8 +1,17 @@
 <?php
 
-/*
- * You can place your custom package configuration in here.
- */
-return [
+use Plank\Frontdesk\Models\Hyperlink;
+use Plank\Frontdesk\Models\Menu;
+use Plank\Frontdesk\Tests\Database\Factories\HyperlinkFactory;
+use Plank\Frontdesk\Tests\Database\Factories\MenuFactory;
 
+return [
+    'models' => [
+        'hyperlink' => Hyperlink::class,
+        'menu' => Menu::class
+    ],
+    'factories' => [
+        'hyperlink' => HyperlinkFactory::class,
+        'menu' => MenuFactory::class
+    ]
 ];

database/migrations/create_hyperlinks_table.php.stub

@@ -0,0 +1,38 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration {
+    public function up()
+    {
+        Schema::create('hyperlinks', function (Blueprint $table) {
+            $table->id();
+            $table->unsignedBigInteger('parent_id')->nullable();
+            $table->morphs('linkable');
+            $table->foreignId('menu_id')
+                ->nullable()
+                ->references('id')
+                ->on('menus');
+            $table->string('title');
+            $table->unsignedInteger('order')->nullable();
+            $table->string('destination')->nullable(); // if this is null the link isn't clickable
+            $table->timestamps();
+        });
+
+        Schema::table('hyperlinks', function (Blueprint $table) {
+            $table->foreign('parent_id')
+                ->references("id")
+                ->on('hyperlinks');
+            // make the morph nullable in-case we want to link externally
+            $table->string('linkable_type')->nullable()->change();
+            $table->unsignedBigInteger('linkable_id')->nullable()->change();
+        });
+    }
+
+    public function down()
+    {
+        Schema::dropIfExists('hyperlinks');
+    }
+};

database/migrations/create_menuables_table.php.stub

@@ -0,0 +1,23 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    public function up()
+    {
+        Schema::create('menuables', function (Blueprint $table) {
+            $table->id();
+            $table->foreignId('menu_id')->references('id')->on('menus');
+            $table->morphs('menuable');
+            $table->integer('order')->nullable();
+        });
+    }
+
+    public function down()
+    {
+        Schema::dropIfExists('menuables');
+    }
+};

database/migrations/create_menus_table.php.stub

@@ -0,0 +1,22 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    public function up()
+    {
+        Schema::create('menus', function (Blueprint $table) {
+            $table->id();
+            $table->string('identifier');
+            $table->timestamps();
+        });
+    }
+
+    public function down()
+    {
+        Schema::dropIfExists('menus');
+    }
+};

phpunit.xml.dist

@@ -1,29 +1,24 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd"
-    backupGlobals="false"
-    bootstrap="vendor/autoload.php"
-    colors="true"
-    processIsolation="false"
-    stopOnFailure="false"
-    executionOrder="random"
-    failOnWarning="true"
-    failOnRisky="true"
-    failOnEmptyTestSuite="true"
-    beStrictAboutOutputDuringTests="true"
-    cacheDirectory=".phpunit.cache"
-    backupStaticProperties="false"
->
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd"
+         backupGlobals="false"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         processIsolation="false"
+         stopOnFailure="false"
+         executionOrder="random"
+         failOnWarning="true"
+         failOnRisky="true"
+         failOnEmptyTestSuite="true"
+         beStrictAboutOutputDuringTests="true"
+         cacheDirectory=".phpunit.cache"
+         backupStaticProperties="false">
     <testsuites>
         <testsuite name="Plank Test Suite">
             <directory>tests</directory>
         </testsuite>
     </testsuites>
     <coverage>
-        <include>
-            <directory suffix=".php">./src</directory>
-        </include>
         <report>
             <html outputDirectory="build/coverage"/>
             <text outputFile="build/coverage.txt"/>
@@ -33,4 +28,9 @@
     <logging>
         <junit outputFile="build/report.junit.xml"/>
     </logging>
+    <source>
+        <include>
+            <directory suffix=".php">./src</directory>
+        </include>
+    </source>
 </phpunit>

src/Concerns/HasMenus.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Plank\Frontdesk\Concerns;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\MorphToMany;
+use Plank\Frontdesk\Models\Menu;
+/**
+ * @mixin \Illuminate\Database\Eloquent\Model
+ *
+ * @property-read Collection<Menu> $menus
+ */
+trait HasMenus
+{
+    /**
+     * @return MorphToMany
+     */
+    public function menus(): MorphToMany
+    {
+        return $this->morphToMany(Menu::class, 'menuable')
+            ->orderByPivot('order');
+    }
+}

src/Concerns/IsLinkable.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Plank\Frontdesk\Concerns;
+
+use Illuminate\Database\Eloquent\Relations\MorphMany;
+use Plank\Frontdesk\Models\Hyperlink;
+
+/**
+ * @mixin \Illuminate\Database\Eloquent\Model
+ *
+ * @property-read \Illuminate\Database\Eloquent\Collection<Hyperlink> $hyperlinks
+ */
+trait IsLinkable
+{
+    public function hyperlinks(): MorphMany
+    {
+        return $this->morphMany(Hyperlink::class, 'linkable');
+    }
+}

src/Contracts/AggregatesLinks.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Plank\Frontdesk\Contracts;
+
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+
+/**
+ * @property-read Collection<Model&LinksToContent> $hyperlinks
+ * Could add $navs to this interface if you decide to implement it
+ */
+interface AggregatesLinks
+{
+    public function hyperlinks(): HasMany;
+}

src/Contracts/Linkable.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Plank\Frontdesk\Contracts;
+
+use Illuminate\Database\Eloquent\Casts\Attribute;
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\MorphMany;
+/**
+ * @property-read Collection<Model&LinksToContent> $hyperlinks
+ * @property-read string $linkTitle
+ * @property-read string $linkUrl
+ */
+interface Linkable
+{
+    public function hyperlinks(): MorphMany;
+
+    public function linkTitle(): Attribute;
+
+    public function linkUrl(): Attribute;
+}

src/Contracts/LinksToContent.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Plank\Frontdesk\Contracts;
+
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
+use Plank\Frontdesk\Models\Menu;
+
+/**
+ * @property int|string $id
+ * @property int|string $parent_id
+ * @property string $title
+ * @property string $destination
+ * @property-read Collection<Linkable> $linkable
+ * @property-read Collection<Menu> $menu
+ * @property-read Model&LinksToContent|null $parent
+ * @property-read Collection<Model&LinksToContent> $children
+ */
+interface LinksToContent
+{
+    public function linkable(): MorphTo;
+
+    public function menu(): BelongsTo;
+
+    public function parent(): BelongsTo;
+
+    public function children(): HasMany;
+}

src/Contracts/Menuable.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Plank\Frontdesk\Contracts;
+
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\MorphToMany;
+
+
+/**
+ * @property-read Collection<Model&AggregatesLinks> $menus
+ * Could add $navs to this interface if you decide to implement it
+ */
+interface Menuable
+{
+    public function menus(): MorphToMany;
+}

src/FrontdeskServiceProvider.php

@@ -12,6 +12,10 @@ public function configurePackage(Package $package): void
         $package
             ->name('frontdesk')
             ->hasConfigFile()
-            ->hasMigration('create_links_table');
+            ->hasMigrations([
+                'create_menus_table',
+                'create_menuables_table',
+                'create_hyperlinks_table',
+            ]);
     }
 }