Merge pull request #1178 from hydephp/update-frontmatter-get-method-to-return-data-instead-of-object

emmadesilva · web-flow · commit f7b8160c4189 · 2023-03-02T18:34:22.000+01:00
Update FrontMatter::get method to return data array instead of $this
diff --git a/packages/framework/src/Framework/Concerns/InteractsWithFrontMatter.php b/packages/framework/src/Framework/Concerns/InteractsWithFrontMatter.php
@@ -34,7 +34,11 @@ public function data(string $key = null, mixed $default = null): mixed
      */
     public function matter(string $key = null, mixed $default = null): mixed
     {
-        return $this->matter->get($key, $default);
+        if ($key) {
+            return $this->matter->get($key, $default);
+        }
+
+        return $this->matter;
     }
 
     /**
diff --git a/packages/framework/src/Markdown/Models/FrontMatter.php b/packages/framework/src/Markdown/Models/FrontMatter.php
@@ -54,7 +54,7 @@ public function get(string $key = null, mixed $default = null): mixed
             return Arr::get($this->data, $key, $default);
         }
 
-        return $this;
+        return $this->data;
     }
 
     public function set(string $key, mixed $value): static
diff --git a/packages/framework/tests/Unit/FrontMatterModelTest.php b/packages/framework/tests/Unit/FrontMatterModelTest.php
@@ -55,16 +55,16 @@ public function test_magic_get_method_returns_null_if_property_does_not_exist()
         $this->assertNull($matter->foo);
     }
 
-    public function test_get_method_returns_self_when_no_argument_is_specified()
+    public function test_get_method_returns_data_when_no_argument_is_specified()
     {
         $matter = new FrontMatter();
-        $this->assertSame($matter, $matter->get());
+        $this->assertSame([], $matter->get());
     }
 
-    public function test_get_method_returns_self_when_no_argument_is_specified_with_data()
+    public function test_get_method_returns_data_when_no_argument_is_specified_with_data()
     {
         $matter = new FrontMatter(['foo' => 'bar']);
-        $this->assertSame($matter, $matter->get());
+        $this->assertSame(['foo' => 'bar'], $matter->get());
     }
 
     public function test_get_method_returns_null_if_specified_front_matter_key_does_not_exist()

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,11 @@ public function data(string $key = null, mixed $default = null): mixed`
`34`	`34`	`*/`
`35`	`35`	`public function matter(string $key = null, mixed $default = null): mixed`
`36`	`36`	`{`
`37`		`- return $this->matter->get($key, $default);`
	`37`	`+ if ($key) {`
	`38`	`+ return $this->matter->get($key, $default);`
	`39`	`+ }`
	`40`	`+`
	`41`	`+ return $this->matter;`
`38`	`42`	`}`
`39`	`43`
`40`	`44`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ public function get(string $key = null, mixed $default = null): mixed`
`54`	`54`	`return Arr::get($this->data, $key, $default);`
`55`	`55`	`}`
`56`	`56`
`57`		`- return $this;`
	`57`	`+ return $this->data;`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`public function set(string $key, mixed $value): static`
Original file line number	Diff line number	Diff line change
`@@ -55,16 +55,16 @@ public function test_magic_get_method_returns_null_if_property_does_not_exist()`
`55`	`55`	`$this->assertNull($matter->foo);`
`56`	`56`	`}`
`57`	`57`
`58`		`- public function test_get_method_returns_self_when_no_argument_is_specified()`
	`58`	`+ public function test_get_method_returns_data_when_no_argument_is_specified()`
`59`	`59`	`{`
`60`	`60`	`$matter = new FrontMatter();`
`61`		`- $this->assertSame($matter, $matter->get());`
	`61`	`+ $this->assertSame([], $matter->get());`
`62`	`62`	`}`
`63`	`63`
`64`		`- public function test_get_method_returns_self_when_no_argument_is_specified_with_data()`
	`64`	`+ public function test_get_method_returns_data_when_no_argument_is_specified_with_data()`
`65`	`65`	`{`
`66`	`66`	`$matter = new FrontMatter(['foo' => 'bar']);`
`67`		`- $this->assertSame($matter, $matter->get());`
	`67`	`+ $this->assertSame(['foo' => 'bar'], $matter->get());`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`public function test_get_method_returns_null_if_specified_front_matter_key_does_not_exist()`