Update from flow-php/flow@3b7d2da

Author: flow-php

changelog/index.html

@@ -212,6 +212,9 @@ <h2>[Unreleased] - 2024-12-28</h2>
 <h3>Added</h3>
 <ul>
 <li>
+<a rel="noopener noreferrer" target="_blank" href="https://github.com/flow-php/flow/pull/1294">#1294</a> - <strong>Documentation building step to github actions workflow</strong> - <a rel="noopener noreferrer" target="_blank" href="https://github.com/norberttech">@norberttech</a>
+</li>
+<li>
 <a rel="noopener noreferrer" target="_blank" href="https://github.com/flow-php/flow/pull/1281">#1281</a> - <strong>S3 Filesystem based on Async AWS library</strong> - <a rel="noopener noreferrer" target="_blank" href="https://github.com/norberttech">@norberttech</a>
 </li>
 <li>
@@ -365,6 +368,9 @@ <h3>Changed</h3>
 <h3>Fixed</h3>
 <ul>
 <li>
+<a rel="noopener noreferrer" target="_blank" href="https://github.com/flow-php/flow/pull/1294">#1294</a> - <strong>Fixed broken documentation building script</strong> - <a rel="noopener noreferrer" target="_blank" href="https://github.com/norberttech">@norberttech</a>
+</li>
+<li>
 <a rel="noopener noreferrer" target="_blank" href="https://github.com/flow-php/flow/pull/1281">#1281</a> - <strong>Meilisearch pagination</strong> - <a rel="noopener noreferrer" target="_blank" href="https://github.com/norberttech">@norberttech</a>
 </li>
 <li>

data_reading/http_dynamic/index.html

@@ -362,7 +362,7 @@ <h2 class="text-xl mt-5 mb-5">Output</h2>
                 <button class="absolute top-[12px] right-[12px] bg-orange-100 rounded px-4 leading-9 [&.copied]:before:content-['Copied!'] before:absolute before:-translate-x-20" data-clipboard-target="#output" data-controller="clipboard"><img src="https://flow-php.com/assets/images/icons/copy-c890d86c179d4c56059b8a0e9c88cd23.svg" alt="copy code" width="20" height="20" class="inline"></button><pre class="rounded p-4 shadow-2xl shadow-gray rounded border-gray border-2"><code id="output" class="language-bash overflow-auto" data-controller="syntax-highlight">+----------+-----------------------------+---------------------+----------+--------------+-----------+----------------------+
 |     name |                    html_url |                blog |    login | public_repos | followers |           created_at |
 +----------+-----------------------------+---------------------+----------+--------------+-----------+----------------------+
-| Flow PHP | https://github.com/flow-php | http://flow-php.com | flow-php |           36 |       106 | 2020-10-26T18:40:27Z |
+| Flow PHP | https://github.com/flow-php | http://flow-php.com | flow-php |           37 |       106 | 2020-10-26T18:40:27Z |
 +----------+-----------------------------+---------------------+----------+--------------+-----------+----------------------+
 1 rows
 </code></pre>            </div>

documentation/components/bridges/filesystem-async-aws-bridge/index.html

@@ -365,6 +365,26 @@ <h1>Filesystem Async AWS</h1>
 
 $fstab = fstab($aws);
 </code></pre>
+<h2>Usage with Flow</h2>
+<p>To use the AWS S3 filesystem with Flow, you need to mount the filesystem to the configuration.
+This operation will mount the S3 filesystem to fstab instance available in the DataFrame runtime.</p>
+<pre class="language-php"><code class="language-php" data-controller="syntax-highlight">$config = config_builder()
+    -&gt;mount(
+        aws_s3_filesystem(
+            $_ENV['AWS_S3_BUCKET'],
+            aws_s3_client([
+                'region' =&gt; $_ENV['AWS_S3_REGION'],
+                'accessKeyId' =&gt; $_ENV['AWS_S3_KEY'],
+                'accessKeySecret' =&gt; $_ENV['AWS_S3_SECRET'],
+            ])
+        )
+    );
+    
+data_frame($config)
+    -&gt;read(from_csv(path('aws-s3://test.csv')))
+    -&gt;write(to_stream(__DIR__ . '/output.txt', truncate: false))
+    -&gt;run();    
+</code></pre>
 
 
             <hr class="!mt-8 !mb-8"/>

documentation/components/bridges/filesystem-azure-bridge/index.html

@@ -386,6 +386,30 @@ <h2>Usage</h2>
     $logger
 );
 </code></pre>
+<h2>Usage with Flow</h2>
+<p>To use the Azure Blob filesystem with Flow, you need to mount the filesystem to the configuration.
+This operation will mount the Azure Blob filesystem to fstab instance available in the DataFrame runtime.</p>
+<pre class="language-php"><code class="language-php" data-controller="syntax-highlight">$config = config_builder()
+    -&gt;mount(
+        azure_filesystem(
+            azure_blob_service(
+                azure_blob_service_config(
+                    $_ENV['AZURE_ACCOUNT'],
+                    $_ENV['AZURE_CONTAINER']
+                ),
+                azure_shared_key_authorization_factory(
+                    $_ENV['AZURE_ACCOUNT'],
+                    $_ENV['AZURE_ACCOUNT_KEY']
+                ),
+            )
+        )
+    );
+    
+data_frame($config)
+    -&gt;read(from_csv(path('azure-blob://test.csv')))
+    -&gt;write(to_stream(__DIR__ . '/output.txt', truncate: false))
+    -&gt;run();    
+</code></pre>
 
 
             <hr class="!mt-8 !mb-8"/>

documentation/example/data_reading/http_dynamic/index.html

@@ -395,7 +395,7 @@ <h2 class="text-xl mt-5 mb-5">Output</h2>
                     <button class="absolute top-[12px] right-[12px] bg-orange-100 rounded px-4 leading-9 [&.copied]:before:content-['Copied!'] before:absolute before:-translate-x-20" data-clipboard-target="#output" data-controller="clipboard"><img src="https://flow-php.com/assets/images/icons/copy-c890d86c179d4c56059b8a0e9c88cd23.svg" alt="copy code" width="20" height="20" class="inline"></button><pre class="rounded p-4 shadow-2xl shadow-gray rounded border-gray border-2"><code id="output" class="language-bash overflow-auto" data-controller="syntax-highlight">+----------+-----------------------------+---------------------+----------+--------------+-----------+----------------------+
 |     name |                    html_url |                blog |    login | public_repos | followers |           created_at |
 +----------+-----------------------------+---------------------+----------+--------------+-----------+----------------------+
-| Flow PHP | https://github.com/flow-php | http://flow-php.com | flow-php |           36 |       106 | 2020-10-26T18:40:27Z |
+| Flow PHP | https://github.com/flow-php | http://flow-php.com | flow-php |           37 |       106 | 2020-10-26T18:40:27Z |
 +----------+-----------------------------+---------------------+----------+--------------+-----------+----------------------+
 1 rows
 </code></pre>                </div>

documentation/example/filesystem/azure/index.html

@@ -352,8 +352,8 @@ <h2 class="text-xl mt-5 mb-5">Code</h2><div id="code" class="relative"><button c
 declare(strict_types=1);
 
 use function Flow\Azure\SDK\DSL\{azure_blob_service, azure_blob_service_config, azure_shared_key_authorization_factory};
-use function Flow\ETL\Adapter\CSV\to_csv;
-use function Flow\ETL\DSL\{config_builder, data_frame, from_array, overwrite};
+use function Flow\ETL\Adapter\CSV\{from_csv, to_csv};
+use function Flow\ETL\DSL\{config_builder, data_frame, from_array, overwrite, to_stream};
 use function Flow\Filesystem\Bridge\Azure\DSL\azure_filesystem;
 use function Flow\Filesystem\DSL\path;
 use Symfony\Component\Dotenv\Dotenv;
@@ -395,8 +395,40 @@ <h2 class="text-xl mt-5 mb-5">Code</h2><div id="code" class="relative"><button c
     -&gt;saveMode(overwrite())
     -&gt;write(to_csv(path(&#039;azure-blob://test.csv&#039;)))
     -&gt;run();
+
+data_frame($config)
+    -&gt;read(from_csv(path(&#039;azure-blob://test.csv&#039;)))
+    -&gt;write(to_stream(__DIR__ . &#039;/output.txt&#039;, truncate: false))
+    -&gt;run();
 </code></pre></div>            </div>
 
+                            <h2 class="text-xl mt-5 mb-5">Output</h2>
+                <div id="output" class="relative">
+                    <button class="absolute top-[12px] right-[12px] bg-orange-100 rounded px-4 leading-9 [&.copied]:before:content-['Copied!'] before:absolute before:-translate-x-20" data-clipboard-target="#output" data-controller="clipboard"><img src="https://flow-php.com/assets/images/icons/copy-c890d86c179d4c56059b8a0e9c88cd23.svg" alt="copy code" width="20" height="20" class="inline"></button><pre class="rounded p-4 shadow-2xl shadow-gray rounded border-gray border-2"><code id="output" class="language-bash overflow-auto" data-controller="syntax-highlight">+----+------+
+| id | name |
++----+------+
+|  1 | test |
++----+------+
+1 rows
++----+------+
+| id | name |
++----+------+
+|  2 | test |
++----+------+
+1 rows
++----+------+
+| id | name |
++----+------+
+|  3 | test |
++----+------+
+1 rows
++----+------+
+| id | name |
++----+------+
+|  4 | test |
++----+------+
+1 rows
+</code></pre>                </div>
 
             <div class="mt-5">
                 <script src="https://giscus.app/client.js"

documentation/example/filesystem/s3/index.html

@@ -346,21 +346,13 @@ <h2>Bridges</h2>
                 <h1>Example: S3</h1>
                 <h3>Topic: Filesystem</h3>
                 <hr class="hidden lg:block"/>
-                                    <h2 class="text-xl mt-5 mb-5">Description</h2>
-                    <article id="example-description"
-                             class="rounded px-4 pt-4 overflow-auto shadow-2xl shadow-gray rounded border-gray border-2 relative mb-10"
-                            data-controller="all-links-external"
-                    >
-                        <p>S3 or any S3 like filesystem is coming soon!</p>
-
-                    </article>
 
                 <h2 class="text-xl mt-5 mb-5">Code</h2><div id="code" class="relative"><button class="absolute top-[12px] right-[12px] bg-orange-100 rounded px-4 leading-9 [&.copied]:before:content-['Copied!'] before:absolute before:-translate-x-20" data-clipboard-target="#code" data-controller="clipboard"><img src="https://flow-php.com/assets/images/icons/copy-c890d86c179d4c56059b8a0e9c88cd23.svg" alt="copy code" width="20" height="20" class="inline"></button><pre class="rounded p-4 overflow-auto shadow-2xl shadow-gray rounded border-gray border-2"><code id="code" class="language-php" data-controller="syntax-highlight" >&lt;?php
 
 declare(strict_types=1);
 
-use function Flow\ETL\Adapter\CSV\to_csv;
-use function Flow\ETL\DSL\{config_builder, data_frame, from_array, overwrite};
+use function Flow\ETL\Adapter\CSV\{from_csv, to_csv};
+use function Flow\ETL\DSL\{config_builder, data_frame, from_array, overwrite, to_stream};
 use function Flow\Filesystem\Bridge\AsyncAWS\DSL\{aws_s3_client, aws_s3_filesystem};
 use function Flow\Filesystem\DSL\path;
 use Symfony\Component\Dotenv\Dotenv;
@@ -398,8 +390,40 @@ <h2 class="text-xl mt-5 mb-5">Code</h2><div id="code" class="relative"><button c
     -&gt;saveMode(overwrite())
     -&gt;write(to_csv(path(&#039;aws-s3://test.csv&#039;)))
     -&gt;run();
+
+data_frame($config)
+    -&gt;read(from_csv(path(&#039;aws-s3://test.csv&#039;)))
+    -&gt;write(to_stream(__DIR__ . &#039;/output.txt&#039;, truncate: false))
+    -&gt;run();
 </code></pre></div>            </div>
 
+                            <h2 class="text-xl mt-5 mb-5">Output</h2>
+                <div id="output" class="relative">
+                    <button class="absolute top-[12px] right-[12px] bg-orange-100 rounded px-4 leading-9 [&.copied]:before:content-['Copied!'] before:absolute before:-translate-x-20" data-clipboard-target="#output" data-controller="clipboard"><img src="https://flow-php.com/assets/images/icons/copy-c890d86c179d4c56059b8a0e9c88cd23.svg" alt="copy code" width="20" height="20" class="inline"></button><pre class="rounded p-4 shadow-2xl shadow-gray rounded border-gray border-2"><code id="output" class="language-bash overflow-auto" data-controller="syntax-highlight">+----+------+
+| id | name |
++----+------+
+|  1 | test |
++----+------+
+1 rows
++----+------+
+| id | name |
++----+------+
+|  2 | test |
++----+------+
+1 rows
++----+------+
+| id | name |
++----+------+
+|  3 | test |
++----+------+
+1 rows
++----+------+
+| id | name |
++----+------+
+|  4 | test |
++----+------+
+1 rows
+</code></pre>                </div>
 
             <div class="mt-5">
                 <script src="https://giscus.app/client.js"

documentation/example/filesystem/stdout/index.html

@@ -354,8 +354,7 @@ <h2 class="text-xl mt-5 mb-5">Description</h2>
                         <p>Stdout is a special type of filesystem allowing to
 write straight to stdout of the process.</p>
 <p><code>Stdout is a write-only filesystem. It is not possible to read from it.</code></p>
-<p>Its main purpose is to allow to allow web servers to stream
-data to the client without buffering it in memory.</p>
+<p>Its main purpose is to allow web servers to stream data to the client without buffering it in memory.</p>
 
                     </article>
 

filesystem/azure/index.html

@@ -295,8 +295,8 @@ <h2 class="text-xl mt-5 mb-5">Code</h2><div id="code" class="relative"><button c
 declare(strict_types=1);
 
 use function Flow\Azure\SDK\DSL\{azure_blob_service, azure_blob_service_config, azure_shared_key_authorization_factory};
-use function Flow\ETL\Adapter\CSV\to_csv;
-use function Flow\ETL\DSL\{config_builder, data_frame, from_array, overwrite};
+use function Flow\ETL\Adapter\CSV\{from_csv, to_csv};
+use function Flow\ETL\DSL\{config_builder, data_frame, from_array, overwrite, to_stream};
 use function Flow\Filesystem\Bridge\Azure\DSL\azure_filesystem;
 use function Flow\Filesystem\DSL\path;
 use Symfony\Component\Dotenv\Dotenv;
@@ -338,8 +338,40 @@ <h2 class="text-xl mt-5 mb-5">Code</h2><div id="code" class="relative"><button c
     -&gt;saveMode(overwrite())
     -&gt;write(to_csv(path(&#039;azure-blob://test.csv&#039;)))
     -&gt;run();
+
+data_frame($config)
+    -&gt;read(from_csv(path(&#039;azure-blob://test.csv&#039;)))
+    -&gt;write(to_stream(__DIR__ . &#039;/output.txt&#039;, truncate: false))
+    -&gt;run();
 </code></pre></div>            </div>
 
+                        <h2 class="text-xl mt-5 mb-5">Output</h2>
+            <div id="output" class="relative">
+                <button class="absolute top-[12px] right-[12px] bg-orange-100 rounded px-4 leading-9 [&.copied]:before:content-['Copied!'] before:absolute before:-translate-x-20" data-clipboard-target="#output" data-controller="clipboard"><img src="https://flow-php.com/assets/images/icons/copy-c890d86c179d4c56059b8a0e9c88cd23.svg" alt="copy code" width="20" height="20" class="inline"></button><pre class="rounded p-4 shadow-2xl shadow-gray rounded border-gray border-2"><code id="output" class="language-bash overflow-auto" data-controller="syntax-highlight">+----+------+
+| id | name |
++----+------+
+|  1 | test |
++----+------+
+1 rows
++----+------+
+| id | name |
++----+------+
+|  2 | test |
++----+------+
+1 rows
++----+------+
+| id | name |
++----+------+
+|  3 | test |
++----+------+
+1 rows
++----+------+
+| id | name |
++----+------+
+|  4 | test |
++----+------+
+1 rows
+</code></pre>            </div>
 
             <div class="mt-5">
                 <script src="https://giscus.app/client.js"

filesystem/s3/index.html

@@ -289,21 +289,13 @@ <h2 class="mb-4 text-2xl font-semibold tracking-wide">Examples:</h2>
             </nav>
 
             <div id="example" class="-mt-36 pt-36">
-                                    <h2 class="text-xl mt-5 mb-5">Description</h2>
-                    <article id="example-description"
-                             class="rounded px-4 pt-4 overflow-auto shadow-2xl shadow-gray rounded border-gray border-2 relative mb-10"
-                            data-controller="all-links-external"
-                    >
-                        <p>S3 or any S3 like filesystem is coming soon!</p>
-
-                    </article>
 
                 <h2 class="text-xl mt-5 mb-5">Code</h2><div id="code" class="relative"><button class="absolute top-[12px] right-[12px] bg-orange-100 rounded px-4 leading-9 [&.copied]:before:content-['Copied!'] before:absolute before:-translate-x-20" data-clipboard-target="#code" data-controller="clipboard"><img src="https://flow-php.com/assets/images/icons/copy-c890d86c179d4c56059b8a0e9c88cd23.svg" alt="copy code" width="20" height="20" class="inline"></button><pre class="rounded p-4 overflow-auto shadow-2xl shadow-gray rounded border-gray border-2"><code id="code" class="language-php" data-controller="syntax-highlight" >&lt;?php
 
 declare(strict_types=1);
 
-use function Flow\ETL\Adapter\CSV\to_csv;
-use function Flow\ETL\DSL\{config_builder, data_frame, from_array, overwrite};
+use function Flow\ETL\Adapter\CSV\{from_csv, to_csv};
+use function Flow\ETL\DSL\{config_builder, data_frame, from_array, overwrite, to_stream};
 use function Flow\Filesystem\Bridge\AsyncAWS\DSL\{aws_s3_client, aws_s3_filesystem};
 use function Flow\Filesystem\DSL\path;
 use Symfony\Component\Dotenv\Dotenv;
@@ -341,8 +333,40 @@ <h2 class="text-xl mt-5 mb-5">Code</h2><div id="code" class="relative"><button c
     -&gt;saveMode(overwrite())
     -&gt;write(to_csv(path(&#039;aws-s3://test.csv&#039;)))
     -&gt;run();
+
+data_frame($config)
+    -&gt;read(from_csv(path(&#039;aws-s3://test.csv&#039;)))
+    -&gt;write(to_stream(__DIR__ . &#039;/output.txt&#039;, truncate: false))
+    -&gt;run();
 </code></pre></div>            </div>
 
+                        <h2 class="text-xl mt-5 mb-5">Output</h2>
+            <div id="output" class="relative">
+                <button class="absolute top-[12px] right-[12px] bg-orange-100 rounded px-4 leading-9 [&.copied]:before:content-['Copied!'] before:absolute before:-translate-x-20" data-clipboard-target="#output" data-controller="clipboard"><img src="https://flow-php.com/assets/images/icons/copy-c890d86c179d4c56059b8a0e9c88cd23.svg" alt="copy code" width="20" height="20" class="inline"></button><pre class="rounded p-4 shadow-2xl shadow-gray rounded border-gray border-2"><code id="output" class="language-bash overflow-auto" data-controller="syntax-highlight">+----+------+
+| id | name |
++----+------+
+|  1 | test |
++----+------+
+1 rows
++----+------+
+| id | name |
++----+------+
+|  2 | test |
++----+------+
+1 rows
++----+------+
+| id | name |
++----+------+
+|  3 | test |
++----+------+
+1 rows
++----+------+
+| id | name |
++----+------+
+|  4 | test |
++----+------+
+1 rows
+</code></pre>            </div>
 
             <div class="mt-5">
                 <script src="https://giscus.app/client.js"