Rework RenameReplaceEntryStrategy to allow multiple strings

Author: stloyd

examples/topics/data_frame/cache/code.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-use function Flow\ETL\DSL\{config_builder, data_frame, filesystem_cache, from_cache, ref, to_stream};
+use function Flow\ETL\DSL\{config_builder, data_frame, filesystem_cache, from_cache, ref, rename_replace, to_stream};
 use Flow\ETL\Adapter\Http\DynamicExtractor\NextRequestFactory;
 use Flow\ETL\Adapter\Http\PsrHttpClientDynamicExtractor;
 use Http\Client\Curl\Client;
@@ -41,7 +41,7 @@ public function create(?ResponseInterface $previousResponse = null) : ?RequestIn
     ->withEntry('unpacked', ref('response_body')->jsonDecode())
     ->select('unpacked')
     ->withEntry('unpacked', ref('unpacked')->unpack())
-    ->renameAll('unpacked.', '')
+    ->renameEach(rename_replace('unpacked.', ''))
     ->drop('unpacked')
     ->select('name', 'html_url', 'blog', 'login', 'public_repos', 'followers', 'created_at')
     ->write(to_stream(__DIR__ . '/output.txt', truncate: false))

examples/topics/data_frame/rename_columns/code.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-use function Flow\ETL\DSL\{data_frame, from_array, to_stream};
+use function Flow\ETL\DSL\{data_frame, from_array, rename_replace, to_stream};
 
 require __DIR__ . '/vendor/autoload.php';
 
@@ -13,7 +13,7 @@
         ['id' => 3, 'name' => 'Jane', 'joined_id' => 3, 'joined_status' => 'active'],
     ]))
     ->rename('id', 'user_id')
-    ->renameAll('joined_', '')
+    ->renameEach(rename_replace('joined.', ''))
     ->collect()
     ->write(to_stream(__DIR__ . '/output.txt', truncate: false))
     ->run();

examples/topics/data_reading/http_dynamic/code.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-use function Flow\ETL\DSL\{data_frame, ref, to_stream};
+use function Flow\ETL\DSL\{data_frame, ref, rename_replace, to_stream};
 use Flow\ETL\Adapter\Http\DynamicExtractor\NextRequestFactory;
 use Flow\ETL\Adapter\Http\PsrHttpClientDynamicExtractor;
 use Http\Client\Curl\Client;
@@ -34,7 +34,7 @@ public function create(?Message\ResponseInterface $previousResponse = null) : ?M
     ->read($from_github_api)
     ->withEntry('unpacked', ref('response_body')->jsonDecode())
     ->withEntry('unpacked', ref('unpacked')->unpack())
-    ->renameAll('unpacked.', '')
+    ->renameEach(rename_replace('unpacked.', ''))
     ->drop('unpacked')
     ->select('name', 'html_url', 'blog', 'login', 'public_repos', 'followers', 'created_at')
     ->write(to_stream(__DIR__ . '/output.txt', truncate: false))

src/core/etl/src/Flow/ETL/DSL/functions.php

@@ -354,8 +354,12 @@ function rename_style(Style $style) : Transformer\Rename\RenameCaseEntryStrategy
     return new Transformer\Rename\RenameCaseEntryStrategy($style);
 }
 
+/**
+ * @param array<string>|string $search
+ * @param array<string>|string $replace
+ */
 #[DocumentationDSL(module: Module::CORE, type: DSLType::TRANSFORMER)]
-function rename_replace(string $search, string $replace) : Transformer\Rename\RenameReplaceEntryStrategy
+function rename_replace(string|array $search, string|array $replace) : Transformer\Rename\RenameReplaceEntryStrategy
 {
     return new Transformer\Rename\RenameReplaceEntryStrategy($search, $replace);
 }

src/core/etl/src/Flow/ETL/Row/Formatter/ASCIISchemaFormatter.php

@@ -4,7 +4,7 @@
 
 namespace Flow\ETL\Row\Formatter;
 
-use function Flow\ETL\DSL\{df, from_array, ref, to_output};
+use function Flow\ETL\DSL\{df, from_array, ref, rename_replace, to_output};
 use Flow\ETL\Exception\RuntimeException;
 use Flow\ETL\PHP\Type\Logical\StructureType;
 use Flow\ETL\PHP\Type\Type;
@@ -24,7 +24,7 @@ public function format(Schema $schema) : string
             df()
                 ->read(from_array($schema->normalize()))
                 ->withEntry('type', ref('type')->unpack())
-                ->renameAll('type.', '')
+                ->renameEach(rename_replace('type.', ''))
                 ->rename('ref', 'name')
                 ->collect()
                 ->select('name', 'type', 'nullable', 'metadata')

src/core/etl/src/Flow/ETL/Transformer/Rename/RenameReplaceEntryStrategy.php

@@ -8,9 +8,13 @@
 
 final readonly class RenameReplaceEntryStrategy implements RenameEntryStrategy
 {
+    /**
+     * @param array<string>|string $search
+     * @param array<string>|string $replace
+     */
     public function __construct(
-        private string $search,
-        private string $replace,
+        private string|array $search,
+        private string|array $replace,
     ) {
     }
 

src/core/etl/tests/Flow/ETL/Tests/Integration/DataFrame/RenameTest.php

@@ -83,6 +83,29 @@ public function test_rename_all_lower_case_i18n() : void
         );
     }
 
+    public function test_rename_all_multiple() : void
+    {
+        $rows = rows(
+            row(json_entry('array', ['id' => 1, 'name' => 'name', 'isActive' => true])),
+            row(json_entry('array', ['id' => 2, 'name' => 'name', 'isActive' => false])),
+        );
+
+        $ds = df()
+            ->read(from_rows($rows))
+            ->withEntry('row', ref('array')->unpack())
+            ->renameEach(rename_replace(['row.', 'isActive'], ['', 'active']))
+            ->drop('array')
+            ->getEachAsArray();
+
+        self::assertEquals(
+            [
+                ['id' => 1, 'name' => 'name', 'active' => true],
+                ['id' => 2, 'name' => 'name', 'active' => false],
+            ],
+            \iterator_to_array($ds)
+        );
+    }
+
     public function test_rename_all_to_ascii() : void
     {
         $rows = rows(row(int_entry('ÓSMY', 8)), row(int_entry('DZIEWIĄTY', 9)));

src/core/etl/tests/Flow/ETL/Tests/Integration/Function/ArrayUnpackTest.php

@@ -5,7 +5,7 @@
 namespace Flow\ETL\Tests\Integration\Function;
 
 use function Flow\ETL\DSL\data_frame;
-use function Flow\ETL\DSL\{from_array, ref, to_memory};
+use function Flow\ETL\DSL\{from_array, ref, rename_replace, to_memory};
 use Flow\ETL\Memory\ArrayMemory;
 use Flow\ETL\Tests\FlowTestCase;
 
@@ -23,7 +23,7 @@ public function test_array_unpack() : void
                 )
             )
             ->withEntry('array', ref('array')->unpack())
-            ->renameAll('array.', '')
+            ->renameEach(rename_replace('array.', ''))
             ->drop('array')
             ->write(to_memory($memory = new ArrayMemory()))
             ->run();

web/landing/resources/dsl.json

@@ -4,7 +4,7 @@
 
 namespace Flow\Website\Service;
 
-use function Flow\ETL\DSL\{config_builder, df, from_cache, lit, not, ref, to_memory};
+use function Flow\ETL\DSL\{config_builder, df, from_cache, lit, not, ref, rename_replace, to_memory};
 use Flow\ETL\Adapter\Http\PsrHttpClientDynamicExtractor;
 use Flow\ETL\Cache\Implementation\PSRSimpleCache;
 use Flow\ETL\Memory\ArrayMemory;
@@ -55,7 +55,7 @@ public function contributors() : array
                 ->select('unpacked')
                 ->withEntry('data', ref('unpacked')->expand())
                 ->withEntry('data', ref('data')->unpack())
-                ->renameAll('data.', '')
+                ->renameEach(rename_replace('data.', ''))
                 ->drop('unpacked', 'data')
                 ->filter(not(ref('login')->endsWith(lit('[bot]'))))
                 ->filter(not(ref('login')->equals(lit('aeon-automation'))))