Merge pull request #1733 from hydephp/datacollections-improvements

[1.x] DataCollections improvements

RELEASE_NOTES.md

@@ -31,6 +31,7 @@ This serves two purposes:
 - Fixed explicitly set front matter navigation group behavior being dependent on subdirectory configuration, fixing https://github.com/hydephp/develop/issues/1515 in https://github.com/hydephp/develop/pull/1703
 - Fixed DataCollections file finding method not being able to be overridden https://github.com/hydephp/develop/issues/1716 in https://github.com/hydephp/develop/pull/1717
 - Fixed PHP warning when trying to parse a Markdown file with just front matter without body https://github.com/hydephp/develop/issues/1705 in https://github.com/hydephp/develop/pull/1728
+- Yaml data files no longer need to start with triple dashes to be parsed by DataCollections in https://github.com/hydephp/develop/pull/1733
 
 ### Security
 - in case of vulnerabilities.

docs/digging-deeper/collections.md

@@ -129,14 +129,10 @@ Here is an approximation of the data types contained by the variable created abo
 Assuming the Yaml document looks like this:
 
 ```yaml
----
 name: "John Doe"
 email: "[email protected]"
 ```
 
->warning Note that the Yaml file should start with `---` to be parsed correctly.
-
-
 ## Json Collections
 
 ### Usage

packages/framework/src/Support/DataCollections.php

@@ -5,6 +5,8 @@
 namespace Hyde\Support;
 
 use Hyde\Facades\Filesystem;
+use Symfony\Component\Yaml\Yaml;
+use Hyde\Markdown\Models\FrontMatter;
 use Hyde\Framework\Actions\MarkdownFileParser;
 use Hyde\Framework\Concerns\InteractsWithDirectories;
 use Illuminate\Support\Collection;
@@ -68,7 +70,16 @@ public static function yaml(string $name): static
         static::needsDirectory(static::$sourceDirectory);
 
         return new static(static::findFiles($name, ['yaml', 'yml'])->mapWithKeys(function (string $file): array {
-            return [static::makeIdentifier($file) => MarkdownFileParser::parse($file)->matter()];
+            $content = Filesystem::get($file);
+
+            if (str_starts_with($content, '---')) {
+                $content = Str::between($content, '---', '---');
+            }
+
+            $parsed = Yaml::parse($content) ?: [];
+            $matter = new FrontMatter($parsed);
+
+            return [static::makeIdentifier($file) => $matter];
         }));
     }
 

packages/framework/tests/Feature/DataCollectionTest.php

@@ -34,11 +34,23 @@ public function testYamlCollections()
     {
         $this->directory('resources/collections/foo');
         $this->markdown('resources/collections/foo/foo.yaml', matter: ['title' => 'Foo']);
-        $this->file('resources/collections/foo/bar.yml');
+        $this->file('resources/collections/foo/bar.yml', "---\ntitle: Bar\n---");
+        $this->file('resources/collections/foo/baz.yml');
 
         $this->assertEquals(new DataCollections([
             'foo/foo.yaml' => new FrontMatter(['title' => 'Foo']),
-            'foo/bar.yml' => new FrontMatter([]),
+            'foo/bar.yml' => new FrontMatter(['title' => 'Bar']),
+            'foo/baz.yml' => new FrontMatter([]),
+        ]), DataCollections::yaml('foo'));
+    }
+
+    public function testYamlCollectionsWithoutTripleDashes()
+    {
+        $this->directory('resources/collections/foo');
+        $this->file('resources/collections/foo/foo.yml', 'title: Foo');
+
+        $this->assertEquals(new DataCollections([
+            'foo/foo.yml' => new FrontMatter(['title' => 'Foo']),
         ]), DataCollections::yaml('foo'));
     }