Merge pull request #85 from TheDragonCode/1.x

Added support for `beforeInfo: false` parameter in root element handling and relevant documentation updates

Author: andrey-helldar

docs/snippets/advanced-element-attribute.xml

@@ -1,13 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <attribute>
 
-<user created_at="2025-09-05 00:25:08">
+<user created_at="2025-09-05 00:35:01">
   <id>1</id>
-  <name>Ms. Sunny Barrows</name>
+  <name>Gilda Moore</name>
 </user>
-<user created_at="2025-09-05 00:25:08">
+<user created_at="2025-09-05 00:35:01">
   <id>2</id>
-  <name>Liana Dooley Sr.</name>
+  <name>Prof. Jo Connelly</name>
 </user>
 
 </attribute>

docs/snippets/advanced-element-header-footer.xml

@@ -3,11 +3,11 @@
 
 <user>
   <id>1</id>
-  <name>Prof. Gabriel Botsford DDS</name>
+  <name>Judy Jacobs</name>
 </user>
 <user>
   <id>2</id>
-  <name>Myles Hammes</name>
+  <name>Ms. Lilliana Hettinger MD</name>
 </user>
 
 </header_footer>

docs/snippets/advanced-element-info-before-false.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Feeds;
+
+use App\Feeds\Info\InfoMethodFeedInfo;
+use App\Models\User;
+use DragonCode\LaravelFeed\Data\ElementData;
+use DragonCode\LaravelFeed\Feeds\Feed;
+use DragonCode\LaravelFeed\Feeds\Info\FeedInfo;
+use Illuminate\Database\Eloquent\Builder;
+
+class InfoMethodBeforeFalseTest extends Feed
+{
+    public function builder(): Builder
+    {
+        return User::query();
+    }
+
+    public function root(): ElementData
+    {
+        return new ElementData(
+            name      : 'info_method',
+            beforeInfo: false
+        );
+    }
+
+    public function info(): FeedInfo
+    {
+        return new InfoMethodFeedInfo;
+    }
+}

docs/snippets/advanced-element-info-before-false.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<company>Laravel</company>
+<url>https://example.com</url>
+
+<info_method>
+
+<user>
+  <id>1</id>
+  <name>Devyn Brekke</name>
+</user>
+<user>
+  <id>2</id>
+  <name>Trudie Conn</name>
+</user>
+
+</info_method>

docs/snippets/advanced-element-info.xml

@@ -6,11 +6,11 @@
 
 <user>
   <id>1</id>
-  <name>Tess Raynor</name>
+  <name>Dr. Stephen Donnelly DDS</name>
 </user>
 <user>
   <id>2</id>
-  <name>Ms. Georgiana Denesik IV</name>
+  <name>Miss Erika Mayert</name>
 </user>
 
 </info_method>

docs/snippets/advanced-element-root.php

@@ -27,7 +27,6 @@ public function root(): ElementData
 
                 'generated_at' => now(),
             ],
-            beforeInfo: false
         );
     }
 }

docs/snippets/advanced-element-root.xml

@@ -3,11 +3,11 @@
 
 <user>
   <id>1</id>
-  <name>Hudson Lehner</name>
+  <name>Shyann Brown</name>
 </user>
 <user>
   <id>2</id>
-  <name>Luella Beier</name>
+  <name>Einar Kassulke</name>
 </user>
 
 </foo>

docs/topics/advanced-usage.topic

@@ -71,6 +71,19 @@
             </p>
 
             <code-block lang="xml" src="advanced-element-info.xml" />
+
+            <p>
+                If it is necessary to change the procedure for the output of the root element relative to the
+                information block, set the <code>beforeInfo</code> parameter in the <code>root</code> method:
+            </p>
+
+            <code-block lang="php" src="advanced-element-info-before-false.php" include-lines="5-" />
+
+            <p>
+                This code will result in:
+            </p>
+
+            <code-block lang="xml" src="advanced-element-info-before-false.xml" />
         </chapter>
 
         <chapter title="Header &amp; footer" id="header_and_footer">

tests/Feature/Docs/ElementTest.php

@@ -6,12 +6,13 @@
 use DragonCode\LaravelFeed\Models\Feed;
 use Workbench\App\Feeds\Docs\AttributeFeed;
 use Workbench\App\Feeds\Docs\HeaderFooterFeed;
+use Workbench\App\Feeds\Docs\InfoMethodBeforeFalseTest;
 use Workbench\App\Feeds\Docs\InfoMethodFeed;
 use Workbench\App\Feeds\Docs\RootElementFeed;
 
 use function Pest\Laravel\artisan;
 
-it('generate stub', function (string $feed, array $files) {
+it('generate stub', function (string $feed, array $files = []) {
     $model = Feed::create([
         'class' => $feed,
         'title' => $feed,
@@ -38,6 +39,11 @@
         ],
     ],
 
+    'info before false' => [
+        'feed'  => InfoMethodBeforeFalseTest::class,
+        'files' => ['InfoMethodBeforeFalseTest' => 'advanced-element-info-before-false.php'],
+    ],
+
     'header & footer' => [
         'feed'  => HeaderFooterFeed::class,
         'files' => ['HeaderFooterFeed' => 'advanced-element-header-footer.php'],

workbench/app/Feeds/Docs/InfoMethodBeforeFalseTest.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Workbench\App\Feeds\Docs;
+
+use DragonCode\LaravelFeed\Data\ElementData;
+use DragonCode\LaravelFeed\Feeds\Feed;
+use DragonCode\LaravelFeed\Feeds\Info\FeedInfo;
+use Illuminate\Database\Eloquent\Builder;
+use Workbench\App\Feeds\Docs\Info\InfoMethodFeedInfo;
+use Workbench\App\Models\User;
+
+class InfoMethodBeforeFalseTest extends Feed
+{
+    public function builder(): Builder
+    {
+        return User::query();
+    }
+
+    public function root(): ElementData
+    {
+        return new ElementData(
+            name      : 'info_method',
+            beforeInfo: false
+        );
+    }
+
+    public function info(): FeedInfo
+    {
+        return new InfoMethodFeedInfo;
+    }
+
+    public function filename(): string
+    {
+        return '../../../../../../../../../docs/snippets/advanced-element-info-before-false.xml';
+    }
+}