Moved all Types into dedicated Flow/Types namespace for flow-php/types component

Author: norberttech

.github/workflows/monorepo-split.yml

@@ -42,6 +42,8 @@ jobs:
             split_repository: 'filesystem'
           - local_path: 'src/lib/snappy'
             split_repository: 'snappy'
+          - local_path: 'src/lib/types'
+            split_repository: 'types'
 
           - local_path: 'src/adapter/etl-adapter-avro'
             split_repository: 'etl-adapter-avro'

bin/docs.php

@@ -47,6 +47,7 @@ public function execute(InputInterface $input, OutputInterface $output) : int
             __DIR__ . '/../src/adapter/etl-adapter-text/src/Flow/ETL/Adapter/Text/functions.php',
             __DIR__ . '/../src/adapter/etl-adapter-xml/src/Flow/ETL/Adapter/XML/functions.php',
             __DIR__ . '/../src/lib/filesystem/src/Flow/Filesystem/DSL/functions.php',
+            __DIR__ . '/../src/lib/types/src/Flow/Types/DSL/functions.php',
             __DIR__ . '/../src/bridge/filesystem/azure/src/Flow/Filesystem/Bridge/Azure/DSL/functions.php',
             __DIR__ . '/../src/bridge/filesystem/async-aws/src/Flow/Filesystem/Bridge/AsyncAWS/DSL/functions.php',
             __DIR__ . '/../src/lib/azure-sdk/src/Flow/Azure/SDK/DSL/functions.php',

composer.json

@@ -122,6 +122,7 @@
                 "src/lib/parquet-viewer/src/Flow",
                 "src/lib/parquet/src/Flow",
                 "src/lib/snappy/src/Flow",
+                "src/lib/types/src/Flow",
                 "src/tools/documentation/src/Flow"
             ],
             "Flow\\Doctrine\\Bulk\\": [
@@ -154,6 +155,7 @@
             "src/lib/filesystem/src/Flow/Filesystem/DSL/functions.php",
             "src/lib/parquet/src/Flow/Parquet/functions.php",
             "src/lib/parquet/src/stubs.php",
+            "src/lib/types/src/Flow/Types/DSL/functions.php",
             "src/lib/snappy/polyfill.php"
         ]
     },
@@ -187,6 +189,7 @@
                 "src/lib/parquet-viewer/tests/Flow",
                 "src/lib/parquet/tests/Flow",
                 "src/lib/snappy/tests/Flow",
+                "src/lib/types/tests/Flow",
                 "src/tools/documentation/tests/Flow"
             ],
             "Flow\\Doctrine\\Bulk\\Tests\\": [
@@ -227,6 +230,7 @@
             "@test:lib:parquet",
             "@test:lib:parquet-viewer",
             "@test:lib:snappy",
+            "@test:lib:types",
             "@test:bridge:filesystem-azure",
             "@test:bridge:filesystem-async-aws",
             "@test:bridge:monolog-http",
@@ -276,6 +280,9 @@
         "test:lib:snappy": [
             "tools/phpunit/vendor/bin/phpunit --testsuite=lib-snappy-integration --log-junit ./var/phpunit/logs/lib-snappy-integration.junit.xml --coverage-clover=./var/phpunit/coverage/clover/lib-snappy-integration.coverage.xml --coverage-html=./var/phpunit/coverage/html/lib-snappy-integration"
         ],
+        "test:lib:types": [
+            "tools/phpunit/vendor/bin/phpunit --testsuite=lib-types-unit --log-junit ./var/phpunit/logs/lib-types-unit.junit.xml --coverage-clover=./var/phpunit/coverage/clover/lib-types-unit.coverage.xml --coverage-html=./var/phpunit/coverage/html/lib-types-unit"
+        ],
         "test:bridge:filesystem-azure": [
             "tools/phpunit/vendor/bin/phpunit --testsuite=bridge-filesystem-azure-unit --log-junit ./var/phpunit/logs/bridge-filesystem-azure-unit.junit.xml --coverage-clover=./var/phpunit/coverage/clover/bridge-filesystem-azure-unit.coverage.xml --coverage-html=./var/phpunit/coverage/html/bridge-filesystem-azure-unit",
             "tools/phpunit/vendor/bin/phpunit --testsuite=bridge-filesystem-azure-integration --log-junit ./var/phpunit/logs/bridge-filesystem-azure-integration.junit.xml --coverage-clover=./var/phpunit/coverage/clover/bridge-filesystem-azure-integration.coverage.xml --coverage-html=./var/phpunit/coverage/html/bridge-filesystem-azure-integration"
@@ -403,6 +410,7 @@
             "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/lib.parquet.xml",
             "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/lib.parquet-viewer.xml",
             "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/lib.snappy.xml",
+            "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/lib.types.xml",
             "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/adapter.chartjs.xml",
             "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/adapter.csv.xml",
             "./tools/phpdocumentor/vendor/bin/phpdoc --config=./phpdoc/adapter.doctrine.xml",

documentation/components/libs/types.md

@@ -0,0 +1,9 @@
+# Types
+
+- [⬅️️ Back](../../introduction.md)
+
+## Installation
+
+```
+composer require flow-php/types:~--FLOW_PHP_VERSION--
+```

examples/topics/data_frame/reorder_columns/code.php

@@ -17,12 +17,6 @@
     str_entry,
     struct_entry,
     to_stream,
-    type_float,
-    type_int,
-    type_list,
-    type_map,
-    type_string,
-    type_structure,
     uuid_entry};
 
 require __DIR__ . '/vendor/autoload.php';
@@ -43,8 +37,8 @@
             str_entry('string_b', 'string'),
             uuid_entry('uuid', '06143adb-3009-45c8-a4f0-c7016f97cab7'),
             json_entry('json', ['id' => 1, 'status' => 'NEW']),
-            list_entry('list', [1, 2, 3], type_list(type_int())),
-            map_entry('map', [0 => 'zero', 1 => 'one', 2 => 'two'], type_map(type_int(), type_string())),
+            list_entry('list', [1, 2, 3], \Flow\Types\DSL\type_list(\Flow\Types\DSL\type_integer())),
+            map_entry('map', [0 => 'zero', 1 => 'one', 2 => 'two'], \Flow\Types\DSL\type_map(\Flow\Types\DSL\type_integer(), \Flow\Types\DSL\type_string())),
             struct_entry(
                 'struct',
                 [
@@ -54,14 +48,14 @@
                     'country' => 'country',
                     'location' => ['lat' => 1.5, 'lon' => 1.5],
                 ],
-                type_structure([
-                    'street' => type_string(),
-                    'city' => type_string(),
-                    'zip' => type_string(),
-                    'country' => type_string(),
-                    'location' => type_structure([
-                        'lat' => type_float(),
-                        'lon' => type_float(),
+                \Flow\Types\DSL\type_structure([
+                    'street' => \Flow\Types\DSL\type_string(),
+                    'city' => \Flow\Types\DSL\type_string(),
+                    'zip' => \Flow\Types\DSL\type_string(),
+                    'country' => \Flow\Types\DSL\type_string(),
+                    'location' => \Flow\Types\DSL\type_structure([
+                        'lat' => \Flow\Types\DSL\type_float(),
+                        'lon' => \Flow\Types\DSL\type_float(),
                     ]),
                 ]),
             ),

manifest.json

@@ -135,6 +135,11 @@
       "name" : "flow-php/snappy",
       "path": "src/lib/snappy",
       "type": "lib"
+    },
+    {
+      "name" : "flow-php/types",
+      "path": "src/lib/types",
+      "type": "lib"
     }
   ]
 }

phpdoc/lib.snappy.xml

@@ -6,15 +6,15 @@
 >
     <title>Flow PHP</title>
     <paths>
-        <output>./../web/landing/build/documentation/api/lib/rdls</output>
-        <cache>./../var/phpdocumentor/cache/lib/rdls</cache>
+        <output>./../web/landing/build/documentation/api/lib/snappy</output>
+        <cache>./../var/phpdocumentor/cache/lib/snappy</cache>
     </paths>
     <version number="1.x">
         <api format="php">
             <source dsn="./../">
-                <path>src/lib/rdls/src</path>
+                <path>src/lib/snappy/src</path>
             </source>
-            <output>rdls</output>
+            <output>snappy</output>
             <default-package-name>Snappy</default-package-name>
             <visibility>public</visibility>
             <include-source>false</include-source>

phpdoc/lib.types.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<phpdocumentor
+        configVersion="3"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xmlns="https://www.phpdoc.org"
+>
+    <title>Flow PHP</title>
+    <paths>
+        <output>./../web/landing/build/documentation/api/lib/types</output>
+        <cache>./../var/phpdocumentor/cache/lib/types</cache>
+    </paths>
+    <version number="1.x">
+        <api format="php">
+            <source dsn="./../">
+                <path>src/lib/types/src</path>
+            </source>
+            <output>types</output>
+            <default-package-name>Types</default-package-name>
+            <visibility>public</visibility>
+            <include-source>false</include-source>
+        </api>
+    </version>
+    <setting name="template.color" value="orange"/>
+</phpdocumentor>

phpstan.neon

@@ -46,6 +46,7 @@ parameters:
         - src/lib/parquet/src
         - src/lib/parquet-viewer/src
         - src/lib/snappy/src
+        - src/lib/types/src
         - src/tools/documentation/src
         - src/core/etl/tests
         - src/cli/tests

phpunit.xml.dist

@@ -75,6 +75,9 @@
     <testsuite name="snappy-integration">
       <directory>src/lib/snappy/tests/Flow/Snappy/Tests/Integration</directory>
     </testsuite>
+    <testsuite name="types-unit">
+      <directory>src/lib/types/tests/Flow/Types/Tests/Unit</directory>
+    </testsuite>
     <testsuite name="bridge-filesystem-azure-unit">
       <directory>src/bridge/filesystem/azure/tests/Flow/Filesystem/Bridge/Azure/Tests/Unit</directory>
     </testsuite>