Skip to content

Update tests and documentation for clarity and completeness #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 6, 2025
Merged

Update tests and documentation for clarity and completeness #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae1d0a1
Added unit tests for transformers
andrey-helldar Sep 6, 2025
becc8f8
Updated test descriptions for clarity and purpose across features and…
andrey-helldar Sep 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions docs/snippets/advanced-directive-array.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
<array_directive>

<user>
<name>Dr. Domenic Howell III</name>
<avatar>https://via.placeholder.com/640x480.png/00cc77?text=sed</avatar>
<avatar>https://via.placeholder.com/640x480.png/000077?text=aut</avatar>
<images name="nulla qui ipsum">https://via.placeholder.com/640x480.png/005511?text=aut</images>
<images name="ut necessitatibus cupiditate">https://via.placeholder.com/640x480.png/00dd99?text=sint</images>
<name>Brandi Shields</name>
<avatar>https://via.placeholder.com/640x480.png/00ddaa?text=aut</avatar>
<avatar>https://via.placeholder.com/640x480.png/005566?text=error</avatar>
<images name="nemo cumque consequatur">https://via.placeholder.com/640x480.png/0066dd?text=eveniet</images>
<images name="atque quaerat officiis">https://via.placeholder.com/640x480.png/0000aa?text=repudiandae</images>
</user>
<user>
<name>Dr. Cleveland Ryan</name>
<avatar>https://via.placeholder.com/640x480.png/001177?text=veritatis</avatar>
<avatar>https://via.placeholder.com/640x480.png/0066bb?text=dolorem</avatar>
<images name="consequuntur et veritatis">https://via.placeholder.com/640x480.png/00ffcc?text=quasi</images>
<images name="officia similique voluptatem">https://via.placeholder.com/640x480.png/00dd33?text=officia</images>
<name>Taya Vandervort</name>
<avatar>https://via.placeholder.com/640x480.png/000011?text=deserunt</avatar>
<avatar>https://via.placeholder.com/640x480.png/000088?text=iusto</avatar>
<images name="dolor cum perferendis">https://via.placeholder.com/640x480.png/00eecc?text=vero</images>
<images name="est vitae excepturi">https://via.placeholder.com/640x480.png/009955?text=ratione</images>
</user>

</array_directive>
10 changes: 5 additions & 5 deletions docs/snippets/advanced-directive-attributes.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
<?xml version="1.0" encoding="UTF-8"?>
<attributes_directive>

<company since="2014"/>
<company since="2003"/>
<url>https://example.com</url>

<user>
<name>Emelia Kessler</name>
<contact email="jocelyn.corwin@example.com" phone="555-000-1"/>
<name>Prof. Jaeden Hodkiewicz</name>
<contact email="kutch.santos@example.com" phone="555-000-1"/>
</user>
<user>
<name>Mr. Gerardo Cruickshank</name>
<contact email="eliseo.hills@example.net" phone="555-000-2"/>
<name>Miss Annetta Frami MD</name>
<contact email="okeefe.kristian@example.org" phone="555-000-2"/>
</user>

</attributes_directive>
8 changes: 4 additions & 4 deletions docs/snippets/advanced-directive-cdata.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
<cdata_directive>

<user>
<name><![CDATA[<h1>Alfred Glover</h1>]]></name>
<email>crooks.makayla@example.net</email>
<name><![CDATA[<h1>Mrs. Elsie Heathcote DVM</h1>]]></name>
<email>arielle43@example.net</email>
</user>
<user>
<name><![CDATA[<h1>Arno Nader</h1>]]></name>
<email>ofarrell@example.org</email>
<name><![CDATA[<h1>Davin Raynor MD</h1>]]></name>
<email>andreanne.jaskolski@example.com</email>
</user>

</cdata_directive>
8 changes: 4 additions & 4 deletions docs/snippets/advanced-directive-mixed.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
<mixed_directive>

<user>
<name>Dr. Tom Schaefer II</name>
<name>Veronica Hahn</name>
<some>
<first>Foo</first>
<second>brenna44@example.org</second>
<second>xauer@example.net</second>
</some>
</user>
<user>
<name>Vena Streich</name>
<name>Brett Weber</name>
<some>
<first>Foo</first>
<second>bechtelar.richmond@example.com</second>
<second>rrolfson@example.com</second>
</some>
</user>

Expand Down
8 changes: 4 additions & 4 deletions docs/snippets/advanced-directive-value.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
<value_directive>

<user>
<name>Gerda Bogisich</name>
<contact type="email">allie.heidenreich@example.net</contact>
<name>Arely Weber</name>
<contact type="email">chermann@example.net</contact>
</user>
<user>
<name>Trycia Connelly</name>
<contact type="email">ole.hayes@example.net</contact>
<name>Cali Corkery PhD</name>
<contact type="email">swalter@example.org</contact>
</user>

</value_directive>
8 changes: 4 additions & 4 deletions docs/snippets/advanced-element-attribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<attribute>

<user created_at="2025-09-05T23:28:57+00:00">
<user created_at="2025-09-06T00:27:10+00:00">
<id>1</id>
<name>Dr. Colin Thiel</name>
<name>Katharina Jacobi</name>
</user>
<user created_at="2025-09-05T23:28:57+00:00">
<user created_at="2025-09-06T00:27:10+00:00">
<id>2</id>
<name>Helga Auer</name>
<name>Kamron Lesch V</name>
</user>

</attribute>
4 changes: 2 additions & 2 deletions docs/snippets/advanced-element-header-footer.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@

<user>
<id>1</id>
<name>Emmy Dickens</name>
<name>Carmella Prohaska IV</name>
</user>
<user>
<id>2</id>
<name>Abraham Satterfield</name>
<name>Emiliano Shields II</name>
</user>

</header_footer>
Expand Down
4 changes: 2 additions & 2 deletions docs/snippets/advanced-element-info-before-false.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@

<user>
<id>1</id>
<name>Vidal Runte</name>
<name>Dr. Marshall Jakubowski Sr.</name>
</user>
<user>
<id>2</id>
<name>Marlee Breitenberg</name>
<name>Mafalda Trantow</name>
</user>

</info_method>
4 changes: 2 additions & 2 deletions docs/snippets/advanced-element-info.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@

<user>
<id>1</id>
<name>Mr. Milan Parker</name>
<name>Kaelyn Robel</name>
</user>
<user>
<id>2</id>
<name>Prof. Irving Kuvalis</name>
<name>Kailee Gutkowski</name>
</user>

</info_method>
4 changes: 2 additions & 2 deletions docs/snippets/advanced-element-root.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@

<user>
<id>1</id>
<name>Zechariah Greenholt</name>
<name>Mr. Jaylin Schmitt</name>
</user>
<user>
<id>2</id>
<name>Isaiah Hill I</name>
<name>Brenden Murazik DVM</name>
</user>

</foo>
48 changes: 24 additions & 24 deletions docs/snippets/receipt-instagram-feed.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,46 +6,46 @@

<item>
<g:id>1</g:id>
<g:title><![CDATA[quisquam reiciendis quidem ratione]]></g:title>
<g:description><![CDATA[Officia quis assumenda quibusdam ut est. Reiciendis cum nulla earum nobis adipisci. Sed temporibus quia tempore quaerat dicta aperiam.]]></g:description>
<g:link>https://example.com/products/laborum-non-autem-nemo-laboriosam-vel</g:link>
<g:image_link>https://via.placeholder.com/640x480.png/009955?text=doloremque</g:image_link>
<g:additional_image_link>https://via.placeholder.com/640x480.png/00bb00?text=voluptatem</g:additional_image_link>
<g:additional_image_link>https://via.placeholder.com/640x480.png/00bbdd?text=ut</g:additional_image_link>
<g:brand>ex</g:brand>
<g:title><![CDATA[amet suscipit aut corrupti]]></g:title>
<g:description><![CDATA[Eveniet odit ut est beatae quis. Qui autem voluptatem voluptate qui quam maiores. Est repellendus similique aliquid repudiandae alias. Hic ea et omnis ut.]]></g:description>
<g:link>https://example.com/products/inventore-velit-quasi-sed-enim-cupiditate</g:link>
<g:image_link>https://via.placeholder.com/640x480.png/0000aa?text=quis</g:image_link>
<g:additional_image_link>https://via.placeholder.com/640x480.png/0022ff?text=neque</g:additional_image_link>
<g:additional_image_link>https://via.placeholder.com/640x480.png/00eeee?text=est</g:additional_image_link>
<g:brand>quia</g:brand>
<g:condition>new</g:condition>
<g:availability>in stock</g:availability>
<g:price>103</g:price>
<g:sale_price>103</g:sale_price>
<g:price>953</g:price>
<g:sale_price>953</g:sale_price>
<g:item_group_id>12345</g:item_group_id>
<g:status>active</g:status>
<g:color><![CDATA[Red]]></g:color>
<g:size>17</g:size>
<g:color><![CDATA[OrangeRed]]></g:color>
<g:size>12</g:size>
<g:age_group>adult</g:age_group>
<g:material><![CDATA[aut]]></g:material>
<g:material><![CDATA[eum]]></g:material>
<g:pattern><![CDATA[regular]]></g:pattern>
<g:google_product_category>1000</g:google_product_category>
<g:fb_product_category>2000</g:fb_product_category>
</item>
<item>
<g:id>2</g:id>
<g:title><![CDATA[et voluptatibus itaque qui]]></g:title>
<g:description><![CDATA[Dolores temporibus doloremque alias nulla provident similique. Ipsa aspernatur eaque excepturi. Consequatur aut possimus iure ut.]]></g:description>
<g:link>https://example.com/products/deserunt-dicta-reiciendis-dolores-neque-mollitia</g:link>
<g:image_link>https://via.placeholder.com/640x480.png/0088dd?text=hic</g:image_link>
<g:additional_image_link>https://via.placeholder.com/640x480.png/0011cc?text=molestiae</g:additional_image_link>
<g:additional_image_link>https://via.placeholder.com/640x480.png/00bb11?text=eum</g:additional_image_link>
<g:brand>minus</g:brand>
<g:title><![CDATA[rem sunt exercitationem nulla]]></g:title>
<g:description><![CDATA[Et perferendis consequuntur voluptatem voluptatem nemo omnis quod. Qui est tempore numquam molestias consequatur nam. Quis quia dicta a. Quo incidunt facilis cum voluptatum quasi ut.]]></g:description>
<g:link>https://example.com/products/et-sunt-eligendi-quos-explicabo-et-qui</g:link>
<g:image_link>https://via.placeholder.com/640x480.png/002277?text=nesciunt</g:image_link>
<g:additional_image_link>https://via.placeholder.com/640x480.png/0022aa?text=natus</g:additional_image_link>
<g:additional_image_link>https://via.placeholder.com/640x480.png/0033dd?text=impedit</g:additional_image_link>
<g:brand>possimus</g:brand>
<g:condition>new</g:condition>
<g:availability>in stock</g:availability>
<g:price>990</g:price>
<g:sale_price>990</g:sale_price>
<g:price>292</g:price>
<g:sale_price>292</g:sale_price>
<g:item_group_id>12345</g:item_group_id>
<g:status>active</g:status>
<g:color><![CDATA[MediumSeaGreen]]></g:color>
<g:size>23</g:size>
<g:color><![CDATA[DarkGreen]]></g:color>
<g:size>49</g:size>
<g:age_group>adult</g:age_group>
<g:material><![CDATA[amet]]></g:material>
<g:material><![CDATA[molestias]]></g:material>
<g:pattern><![CDATA[regular]]></g:pattern>
<g:google_product_category>1000</g:google_product_category>
<g:fb_product_category>2000</g:fb_product_category>
Expand Down
4 changes: 2 additions & 2 deletions docs/snippets/receipt-sitemap-feed.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1" xmlns:video="http://www.google.com/schemas/sitemap-video/1.1" xmlns:news="http://www.google.com/schemas/sitemap-news/0.9">

<url>
<loc>https://example.com/products/et-dolor-rerum-maxime-qui</loc>
<loc>https://example.com/products/quidem-tempore-nulla-repudiandae-vero</loc>
<lastmod>2025-09-04T04:08:12+00:00</lastmod>
<priority>0.9</priority>
</url>
<url>
<loc>https://example.com/products/quibusdam-nisi-minima-facere-nostrum-consequatur-eligendi-natus</loc>
<loc>https://example.com/products/laudantium-porro-qui-rerum-incidunt-expedita</loc>
<lastmod>2025-09-04T04:08:12+00:00</lastmod>
<priority>0.9</priority>
</url>
Expand Down
50 changes: 25 additions & 25 deletions docs/snippets/receipt-yandex-feed.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,36 +17,36 @@
<offers>

<offer id="1" available="true" type="vendor.model">
<url>https://example.com/products/odit-error-voluptates-blanditiis-saepe-placeat</url>
<barcode>GD-+/ADU|]W</barcode>
<name>nam suscipit dolor dignissimos</name>
<description>Quasi magni consectetur quis. Nulla sunt vero vel quia qui autem. Qui aut quo enim quisquam et laudantium. Eos facilis autem sint asperiores temporibus.</description>
<url>https://example.com/products/quas-aut-omnis-dolorum-nulla-quo-nisi</url>
<barcode>GD-WG&amp;$VS</barcode>
<name>dolorum architecto doloremque voluptatem</name>
<description>Asperiores eum ab deleniti ipsum consequatur consequatur totam dolorum. Velit amet in ducimus quis non unde. Delectus magnam et rerum aut quibusdam enim natus.</description>
<delivery>true</delivery>
<price>708</price>
<price>145</price>
<currencyId>RUR</currencyId>
<vendor>animi</vendor>
<picture>https://via.placeholder.com/640x480.png/000099?text=ullam</picture>
<picture>https://via.placeholder.com/640x480.png/003399?text=alias</picture>
<picture>https://via.placeholder.com/640x480.png/009999?text=aut</picture>
<param name="Артикул">GD-+/ADU|]W</param>
<param name="Код цвета">0</param>
<param name="Пол">male</param>
<vendor>ea</vendor>
<picture>https://via.placeholder.com/640x480.png/003355?text=fugiat</picture>
<picture>https://via.placeholder.com/640x480.png/006622?text=laudantium</picture>
<picture>https://via.placeholder.com/640x480.png/00cc88?text=reiciendis</picture>
<param name="Артикул">GD-WG&amp;$VS</param>
<param name="Код цвета">7</param>
<param name="Пол">female</param>
</offer>
<offer id="2" available="true" type="vendor.model">
<url>https://example.com/products/deleniti-rerum-ratione-voluptas-ut-explicabo-ad-provident</url>
<barcode>GD-0TMMSV"</barcode>
<name>illum sint minima consequatur</name>
<description>Voluptate sed rerum rerum optio asperiores ipsam consequatur. Neque maxime et voluptatibus at id. Sequi praesentium eum dolores non itaque. Eos et ullam veniam ipsam et delectus.</description>
<offer id="2" available="false" type="vendor.model">
<url>https://example.com/products/distinctio-qui-ratione-consequatur-aspernatur-et</url>
<barcode>GD-%L;]UB</barcode>
<name>magnam consequatur harum cupiditate</name>
<description>Harum in ratione perspiciatis quo consequatur id a. Totam magnam et est iusto amet totam minus voluptatum. In cum minima explicabo consectetur minus ex praesentium. Nemo maiores laboriosam dicta.</description>
<delivery>true</delivery>
<price>756</price>
<price>618</price>
<currencyId>RUR</currencyId>
<vendor>nostrum</vendor>
<picture>https://via.placeholder.com/640x480.png/005511?text=ipsum</picture>
<picture>https://via.placeholder.com/640x480.png/001188?text=cumque</picture>
<picture>https://via.placeholder.com/640x480.png/007777?text=omnis</picture>
<param name="Артикул">GD-0TMMSV"</param>
<param name="Код цвета">6</param>
<param name="Пол">female</param>
<vendor>aut</vendor>
<picture>https://via.placeholder.com/640x480.png/00bb77?text=aut</picture>
<picture>https://via.placeholder.com/640x480.png/009933?text=voluptas</picture>
<picture>https://via.placeholder.com/640x480.png/00eeee?text=delectus</picture>
<param name="Артикул">GD-%L;]UB</param>
<param name="Код цвета">5</param>
<param name="Пол">male</param>
</offer>

</offers>
Expand Down
2 changes: 1 addition & 1 deletion tests/Feature/Console/Generation/EnsureDeleteTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

use function Pest\Laravel\artisan;

test('success', function () {
test('overwrites existing feed file and removes .draft during generation', function () {
$filesystem = new Filesystem;

$feed = Feed::firstOrFail();
Expand Down
2 changes: 1 addition & 1 deletion tests/Feature/Console/Generation/FoundTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

use function Pest\Laravel\artisan;

test('success', function (int $id) {
test('generates only the selected feed by ID', function (int $id) {
$command = artisan(FeedGenerateCommand::class, [
'feed' => $id,
]);
Expand Down
2 changes: 1 addition & 1 deletion tests/Feature/Docs/ElementTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

use function Pest\Laravel\artisan;

it('generate stub', function (string $feed, array $files = []) {
it('generates documentation stubs for feed examples', function (string $feed, array $files = []) {
$model = Feed::create([
'class' => $feed,
'title' => $feed,
Expand Down
2 changes: 1 addition & 1 deletion tests/Feature/Events/SuccessTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

use function Pest\Laravel\artisan;

test('success', function () {
test('dispatches FeedStarting and FeedFinished events for each generated feed', function () {
Event::fake();

artisan(FeedGenerateCommand::class)
Expand Down
2 changes: 1 addition & 1 deletion tests/Feature/Queries/Delete/SuccessTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
use function Pest\Laravel\assertDatabaseHas;
use function Pest\Laravel\assertDatabaseMissing;

test('success', function () {
test('soft deletes a feed and sets deleted_at', function () {
$feed = Feed::firstOrFail();

assertDatabaseHas(Feed::class, [
Expand Down
2 changes: 1 addition & 1 deletion tests/Feature/Queries/Restore/SuccessTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

use function Pest\Laravel\assertDatabaseHas;

test('success', function () {
test('restores a soft-deleted feed to active state', function () {
$feed = Feed::firstOrFail();
$feed->delete();

Expand Down
2 changes: 1 addition & 1 deletion tests/Feature/Queries/Restore/UnknownIdentifierTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

use function Pest\Laravel\assertDatabaseMissing;

test('success', function () {
test('does nothing when restoring a non-existent feed ID', function () {
app(FeedQuery::class)->restore(1000);

assertDatabaseMissing(Feed::class, [
Expand Down
Loading