Merge pull request #398 from hydephp/improve-serialization

Improve model serializations

Author: caendesilva

RELEASE_NOTES.md

@@ -15,6 +15,7 @@ The RoutingService class remains for compatibility with existing code, but now o
 - The page and route collections are now stored as properties of the HydeKernel
 - Adds an option to the `Hyde::image()` helper to request the returned image path use the configured base URL if it's set
 - Adds a new `save()` method to Markdown-based pages, to save the page object to the filesystem
+- Added new internal helpers to improve serialization of object models
 
 ### Changed
 - Removed constructor from RoutingServiceContract interface

packages/framework/src/Concerns/JsonSerializesArrayable.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Hyde\Framework\Concerns;
+
+trait JsonSerializesArrayable
+{
+    /** @inheritDoc */
+    public function jsonSerialize()
+    {
+        return $this->toArray();
+    }
+}

packages/framework/src/Helpers/Features.php

@@ -2,7 +2,10 @@
 
 namespace Hyde\Framework\Helpers;
 
+use Hyde\Framework\Concerns\JsonSerializesArrayable;
 use Hyde\Framework\Hyde;
+use Illuminate\Contracts\Support\Arrayable;
+use Illuminate\Support\Str;
 
 /**
  * Allows features to be enabled and disabled in a simple object-oriented manner.
@@ -12,8 +15,10 @@
  * Based entirely on Laravel Jetstream (License MIT)
  * @see https://jetstream.laravel.com/
  */
-class Features
+class Features implements Arrayable, \JsonSerializable
 {
+    use JsonSerializesArrayable;
+
     /**
      * Determine if the given specified is enabled.
      *
@@ -154,4 +159,17 @@ public static function rss(): bool
             && config('hyde.generate_rss_feed', true)
             && extension_loaded('simplexml');
     }
+
+    /** @inheritDoc */
+    public function toArray()
+    {
+        $array = [];
+        foreach (get_class_methods(static::class) as $method) {
+            if (str_starts_with($method, 'has')) {
+                $array[Str::kebab(substr($method, 3))] = static::{$method}();
+            }
+        }
+
+        return $array;
+    }
 }

packages/framework/src/HydeKernel.php

@@ -3,11 +3,13 @@
 namespace Hyde\Framework;
 
 use Composer\InstalledVersions;
+use Hyde\Framework\Concerns\JsonSerializesArrayable;
 use Hyde\Framework\Contracts\HydeKernelContract;
 use Hyde\Framework\Contracts\RouteContract;
 use Hyde\Framework\Foundation\Filesystem;
 use Hyde\Framework\Foundation\Hyperlinks;
 use Hyde\Framework\Helpers\Features;
+use Illuminate\Contracts\Support\Arrayable;
 use Illuminate\Support\Facades\View;
 use Illuminate\Support\Str;
 use Illuminate\Support\Traits\Macroable;
@@ -23,9 +25,10 @@
  *
  * @link https://hydephp.com/
  */
-class HydeKernel implements HydeKernelContract
+class HydeKernel implements HydeKernelContract, Arrayable, \JsonSerializable
 {
     use Macroable;
+    use JsonSerializesArrayable;
 
     protected string $basePath;
     protected Filesystem $filesystem;
@@ -207,4 +210,15 @@ public function pathToRelative(string $path): string
     {
         return $this->filesystem->pathToRelative($path);
     }
+
+    /** @inheritDoc */
+    public function toArray()
+    {
+        return [
+            'basePath' => $this->basePath,
+            'features' => $this->features(),
+            'pages' => $this->pages(),
+            'routes' => $this->routes(),
+        ];
+    }
 }

packages/framework/src/Models/FrontMatter.php

@@ -3,6 +3,7 @@
 namespace Hyde\Framework\Models;
 
 use Hyde\Framework\Actions\ConvertsArrayToFrontMatter;
+use Hyde\Framework\Concerns\JsonSerializesArrayable;
 use Illuminate\Contracts\Support\Arrayable;
 use Illuminate\Support\Arr;
 
@@ -19,8 +20,10 @@
  *
  * @see \Hyde\Framework\Testing\Unit\FrontMatterModelTest
  */
-class FrontMatter implements Arrayable, \Stringable
+class FrontMatter implements Arrayable, \Stringable, \JsonSerializable
 {
+    use JsonSerializesArrayable;
+
     public array $data;
 
     public function __construct(array $matter = [])

packages/framework/src/Models/Route.php

@@ -2,19 +2,23 @@
 
 namespace Hyde\Framework\Models;
 
+use Hyde\Framework\Concerns\JsonSerializesArrayable;
 use Hyde\Framework\Contracts\PageContract;
 use Hyde\Framework\Contracts\RouteContract;
 use Hyde\Framework\Contracts\RouteFacadeContract;
 use Hyde\Framework\Exceptions\RouteNotFoundException;
 use Hyde\Framework\Hyde;
 use Hyde\Framework\Services\RoutingService;
+use Illuminate\Contracts\Support\Arrayable;
 use Illuminate\Support\Collection;
 
 /**
  * @see \Hyde\Framework\Testing\Feature\RouteTest
  */
-class Route implements RouteContract, RouteFacadeContract, \Stringable
+class Route implements RouteContract, RouteFacadeContract, \Stringable, \JsonSerializable, Arrayable
 {
+    use JsonSerializesArrayable;
+
     /**
      * The source model for the route.
      *
@@ -36,6 +40,16 @@ public function __construct(PageContract $sourceModel)
         $this->routeKey = $this->constructRouteKey();
     }
 
+    /** @inheritDoc */
+    public function toArray()
+    {
+        return [
+            'routeKey' => $this->routeKey,
+            'sourceModelPath' => $this->sourceModel->getSourcePath(),
+            'sourceModelType' => $this->sourceModel::class,
+        ];
+    }
+
     /** @inheritDoc */
     public function getPageType(): string
     {

packages/framework/tests/Feature/RouteCollectionTest.php

@@ -41,7 +41,7 @@ public function test_boot_method_discovers_all_pages()
         $this->assertEquals([
             '404' => (new Route(new BladePage('404'))),
             'index' => (new Route(new BladePage('index'))),
-        ], $collection->toArray());
+        ], $collection->all());
     }
 
     public function test_boot_method_discovers_all_page_types()
@@ -63,7 +63,7 @@ public function test_boot_method_discovers_all_page_types()
             'markdown' => (new Route(new MarkdownPage('markdown'))),
             'posts/post' => (new Route(new MarkdownPost('post'))),
             'docs/docs' => (new Route(new DocumentationPage('docs'))),
-        ], $collection->toArray());
+        ], $collection->all());
 
         $this->restoreDefaultPages();
     }