Feature | Add Generics For Query / LazyQuery

composer.json

@@ -13,7 +13,7 @@
     "homepage": "https://github.com/saloonphp/xml-wrangler",
     "require": {
         "php": "^8.1",
-        "veewee/xml": "^2.11.1",
+        "veewee/xml": "^2.11.2",
         "spatie/array-to-xml": "^3.2",
         "ext-dom": "*"
     },

src/LazyQuery.php

@@ -7,6 +7,11 @@
 use Generator;
 use Illuminate\Support\LazyCollection;
 
+/**
+ * @template TReturnType
+ *
+ * @extends \Saloon\XmlWrangler\Query<TReturnType>
+ */
 class LazyQuery extends Query
 {
     /**
@@ -30,7 +35,7 @@ public function lazy(): Generator
      *
      * Requires illuminate/support
      *
-     * @return LazyCollection<int, mixed>
+     * @return LazyCollection<int, TReturnType>
      * @throws \Saloon\XmlWrangler\Exceptions\QueryAlreadyReadException
      */
     public function collectLazy(): LazyCollection

src/Query.php

@@ -10,6 +10,9 @@
 use Saloon\XmlWrangler\Exceptions\QueryAlreadyReadException;
 use Saloon\XmlWrangler\Exceptions\MultipleNodesFoundException;
 
+/**
+ * @template TReturnType
+ */
 class Query
 {
     /**
@@ -39,7 +42,7 @@ public function __construct(string $searchTerm, Generator $data)
     /**
      * Return the node as an array
      *
-     * @return array<string, mixed>
+     * @return array<string, TReturnType>
      * @throws \Saloon\XmlWrangler\Exceptions\QueryAlreadyReadException
      */
     public function get(): array
@@ -54,7 +57,7 @@ public function get(): array
      *
      * Requires illuminate/support
      *
-     * @return Collection<string, mixed>
+     * @return Collection<string, TReturnType>
      * @throws \Saloon\XmlWrangler\Exceptions\QueryAlreadyReadException
      */
     public function collect(): Collection
@@ -65,6 +68,7 @@ public function collect(): Collection
     /**
      * Retrieve the first value in the node
      *
+     * @return TReturnType
      * @throws \Saloon\XmlWrangler\Exceptions\QueryAlreadyReadException
      */
     public function first(): mixed
@@ -81,6 +85,7 @@ public function first(): mixed
     /**
      * Retrieve the first value in the node or fail
      *
+     * @return TReturnType
      * @throws \Saloon\XmlWrangler\Exceptions\MissingNodeException
      * @throws \Saloon\XmlWrangler\Exceptions\QueryAlreadyReadException
      */
@@ -94,7 +99,7 @@ public function firstOrFail(): mixed
      *
      * Throws an exception if none exist or more than one exists.
      *
-     * @return string|null
+     * @return ?TReturnType
      * @throws \Saloon\XmlWrangler\Exceptions\MissingNodeException
      * @throws \Saloon\XmlWrangler\Exceptions\MultipleNodesFoundException
      * @throws \Saloon\XmlWrangler\Exceptions\QueryAlreadyReadException

src/XmlReader.php

@@ -186,6 +186,7 @@ public function elements(): array
      * Find an element from the XML
      *
      * @param array<string, string> $withAttributes
+     * @return \Saloon\XmlWrangler\LazyQuery<Element>
      * @throws \Saloon\XmlWrangler\Exceptions\XmlReaderException
      * @throws \Throwable
      * @throws \VeeWee\Xml\Encoding\Exception\EncodingException
@@ -277,6 +278,7 @@ public function element(string $name, array $withAttributes = []): LazyQuery
     /**
      * Search for an element with xpath
      *
+     * @return \Saloon\XmlWrangler\Query<Element>
      * @throws \Throwable
      * @throws \VeeWee\Xml\Encoding\Exception\EncodingException
      */
@@ -340,6 +342,7 @@ public function values(): array
      * Find and retrieve value of element
      *
      * @param array<string, string> $attributes
+     * @return \Saloon\XmlWrangler\LazyQuery<mixed>
      * @throws \Saloon\XmlWrangler\Exceptions\XmlReaderException
      * @throws \Throwable
      */
@@ -353,6 +356,7 @@ public function value(string $name, array $attributes = []): LazyQuery
     /**
      * Find and retrieve value of element
      *
+     * @return \Saloon\XmlWrangler\Query<mixed>
      * @throws \Saloon\XmlWrangler\Exceptions\XmlReaderException
      * @throws \Throwable
      * @throws \VeeWee\Xml\Encoding\Exception\EncodingException

tests/Feature/XmlReaderTest.php

@@ -445,7 +445,7 @@
     ]);
 });
 
-test('root namespaces are removed from the element searches', function () {
+test('root namespaces are removed from xpath queries', function () {
     $reader = XmlReader::fromString(
         <<<XML
 <container xmlns="http://symfony.com/schema/dic/services" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd">
@@ -460,6 +460,8 @@
 XML
     );
 
+    // Element should keep the xmlns
+
     $element = $reader->element('container.services.service', ['id' => 'service_container'])->sole();
 
     expect($element)->toEqual(
@@ -499,6 +501,7 @@
             'class' => 'Symfony\Component\DependencyInjection\ContainerInterface',
             'public' => 'true',
             'synthetic' => 'true',
+            'xmlns' => 'http://symfony.com/schema/dic/services',
         ])
     );
 
@@ -550,15 +553,3 @@
 
     expect($mappedXpathTag)->toBe('1');
 });
-
-test('can test large xml files', function () {
-    $file = '/Users/samcarre/Documents/XML/psd7003.xml';
-
-    $reader = XmlReader::fromFile($file);
-
-    $values = $reader->value('refinfo')->lazy();
-
-    foreach ($values as $value) {
-        dd($value);
-    }
-})->skip();