Merge pull request #44 from ryangjchandler/fix/hidden-props-not-storing

fix: `$hidden` properties not being stored on disk

src/Concerns/Orbital.php

@@ -127,6 +127,7 @@ public function migrate()
  $columns = $schema->getColumnListing($table);
 
  $driver->all(static::getOrbitalPath())
+ ->filter()
  ->map(function ($row) use ($columns) {
  return collect($row)
  ->filter(fn ($_, $key) => in_array($key, $columns))

src/Drivers/FileDriver.php

@@ -67,6 +67,13 @@ protected function filepath(string $directory, string $key): string
  return $directory . DIRECTORY_SEPARATOR . $key . '.' . $this->extension();
  }
 
+ protected function getModelAttributes(Model $model)
+ {
+ return collect($model->getAttributes())
+ ->map(fn ($_, $key) => $model->{$key})
+ ->toArray();
+ }
+
  abstract protected function extension(): string;
 
  abstract protected function dumpContent(Model $model): string;

src/Drivers/Json.php

@@ -9,14 +9,20 @@ class Json extends FileDriver
 {
  protected function dumpContent(Model $model): string
  {
- $data = array_filter($model->attributesToArray());
+ $data = array_filter($this->getModelAttributes($model));
 
  return json_encode($data, JSON_PRETTY_PRINT);
  }
 
  protected function parseContent(SplFileInfo $file): array
  {
- return json_decode(file_get_contents($file->getPathname()), true);
+ $contents = file_get_contents($file->getPathname());
+
+ if (! $contents) {
+ return [];
+ }
+
+ return json_decode($contents, true);
  }
 
  protected function extension(): string

src/Drivers/Markdown.php

@@ -14,7 +14,7 @@ class Markdown extends FileDriver
 
  protected function dumpContent(Model $model): string
  {
- $matter = array_filter($model->attributesToArray(), function ($value, $key) {
+ $matter = array_filter($this->getModelAttributes($model), function ($value, $key) {
  return $key !== 'content' && $value !== null;
  }, ARRAY_FILTER_USE_BOTH);
 

src/Drivers/MarkdownJson.php

@@ -10,7 +10,7 @@ class MarkdownJson extends Markdown
 {
  protected function dumpContent(Model $model): string
  {
- $matter = array_filter($model->attributesToArray(), function ($value, $key) {
+ $matter = array_filter($this->getModelAttributes($model), function ($value, $key) {
  return $key !== 'content' && $value !== null;
  }, ARRAY_FILTER_USE_BOTH);
 

src/Drivers/Yaml.php

@@ -10,7 +10,7 @@ class Yaml extends FileDriver
 {
  protected function dumpContent(Model $model): string
  {
- $data = array_filter($model->getAttributes());
+ $data = array_filter($this->getModelAttributes($model));
 
  return SymfonyYaml::dump($data);
  }

tests/AdvancedOrbitalTest.php

@@ -2,6 +2,7 @@
 
 namespace Orbit\Tests;
 
+use Orbit\Tests\Fixtures\Post;
 use Orbit\Tests\Fixtures\CustomKey;
 use Orbit\Tests\Fixtures\JsonModel;
 use Orbit\Tests\Fixtures\MarkdownJsonModel;
@@ -14,6 +15,7 @@ public function tearDown(): void
  CustomKey::all()->each->delete();
  JsonModel::all()->each->delete();
  YamlModel::all()->each->delete();
+ Post::all()->each->delete();
  }
 
  public function test_it_can_create_files_using_custom_primary_key()
@@ -67,4 +69,18 @@ public function test_it_can_use_markdown_json_driver()
 
  $this->assertFileExists(__DIR__.'/content/markdown_json_models/'.$md->getKey().'.md');
  }
+
+ public function test_it_writes_hidden_columns()
+ {
+ $post = Post::create([
+ 'title' => 'Ryan',
+ 'slug' => 'ryan',
+ ]);
+
+ $this->assertFileExists($path = __DIR__.'/content/posts/'.$post->getKey().'.md');
+
+ $contents = file_get_contents($path);
+
+ $this->assertStringContainsString('slug', $contents);
+ }
 }

tests/Fixtures/Post.php

@@ -12,10 +12,15 @@ class Post extends Model
 
  protected $guarded = [];
 
+ protected $hidden = [
+ 'slug',
+ ];
+
  public static function schema(Blueprint $table)
  {
  $table->id();
  $table->string('title');
+ $table->string('slug')->nullable();
  $table->text('content')->nullable();
  }
 }

tests/SoftDeletesTest.php

@@ -23,7 +23,7 @@ public function test_it_will_update_deleted_at_when_deleting()
 
  $file = file_get_contents(__DIR__.'/content/soft_deleted_posts/'.$post->id.'.md');
 
- $this->assertStringContainsString(sprintf('deleted_at: \'%s\'', $post->deleted_at->toIsoString()), $file);
+ $this->assertStringContainsString(sprintf('deleted_at: %s', $post->deleted_at->toIso8601String()), $file);
  }
 
  public function test_it_will_delete_file_when_force_deleting()
@@ -38,7 +38,7 @@ public function test_it_will_delete_file_when_force_deleting()
 
  $file = file_get_contents(__DIR__.'/content/soft_deleted_posts/'.$post->id.'.md');
 
- $this->assertStringContainsString(sprintf('deleted_at: \'%s\'', $post->deleted_at->toIsoString()), $file);
+ $this->assertStringContainsString(sprintf('deleted_at: %s', $post->deleted_at->toIso8601String()), $file);
 
  $post->forceDelete();
 
@@ -57,7 +57,7 @@ public function test_it_will_remove_deleted_at_when_restoring_file()
 
  $file = file_get_contents(__DIR__.'/content/soft_deleted_posts/'.$post->id.'.md');
 
- $this->assertStringContainsString(sprintf('deleted_at: \'%s\'', $post->deleted_at->toIsoString()), $file);
+ $this->assertStringContainsString(sprintf('deleted_at: %s', $post->deleted_at->toIso8601String()), $file);
 
  $post->restore();