docs.php

#!/usr/bin/env php
<?php

declare(strict_types=1);

use Flow\Documentation\{FunctionCollector, FunctionsExtractor, MethodCollector, MethodsExtractor};
use Flow\ETL\Attribute\Module;
use Flow\ETL\DataFrame\GroupedDataFrame;
use Flow\ETL\{DataFrame, Flow};
use Flow\ETL\Function\ScalarFunctionChain;
use Symfony\Component\Console\Application;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\{InputArgument, InputInterface};
use Symfony\Component\Console\Output\OutputInterface;

require __DIR__ . '/../vendor/autoload.php';

if (version_compare(PHP_VERSION, '8.4', '>=')) {
    print PHP_EOL . 'Building docs can be run only on the lowest supported version of PHP: 8.3' . PHP_EOL;

    exit(1);
}

if (false === in_array(PHP_SAPI, ['cli', 'phpdbg', 'embed'], true)) {
    print PHP_EOL . 'This app may only be invoked from a command line, got "' . PHP_SAPI . '"' . PHP_EOL;

    exit(1);
}

ini_set('memory_limit', -1);

$application = new Application('Flow-PHP - Documentation');

$application->add(new class extends Command {
    public function configure() : void
    {
        $this
            ->setName('dsl:dump')
            ->setDescription('Dump DSL into json file.')
            ->addOption('repository-root-path', null, InputArgument::OPTIONAL, 'Repository root path.', dirname(__DIR__) . '/')
            ->addArgument('output', InputArgument::REQUIRED, 'Where to dump dsl.');
    }

    public function execute(InputInterface $input, OutputInterface $output) : int
    {

        $paths = [
            __DIR__ . '/../src/core/etl/src/Flow/ETL/DSL/functions.php',
            __DIR__ . '/../src/adapter/etl-adapter-avro/src/Flow/ETL/Adapter/Avro/functions.php',
            __DIR__ . '/../src/adapter/etl-adapter-chartjs/src/Flow/ETL/Adapter/ChartJS/functions.php',
            __DIR__ . '/../src/adapter/etl-adapter-csv/src/Flow/ETL/Adapter/CSV/functions.php',
            __DIR__ . '/../src/adapter/etl-adapter-doctrine/src/Flow/ETL/Adapter/Doctrine/functions.php',
            __DIR__ . '/../src/adapter/etl-adapter-excel/src/Flow/ETL/Adapter/Excel/DSL/functions.php',
            __DIR__ . '/../src/adapter/etl-adapter-elasticsearch/src/Flow/ETL/Adapter/Elasticsearch/functions.php',
            __DIR__ . '/../src/adapter/etl-adapter-google-sheet/src/Flow/ETL/Adapter/GoogleSheet/functions.php',
            __DIR__ . '/../src/adapter/etl-adapter-http/src/Flow/ETL/Adapter/Http/DSL/functions.php',
            __DIR__ . '/../src/adapter/etl-adapter-json/src/Flow/ETL/Adapter/JSON/functions.php',
            __DIR__ . '/../src/adapter/etl-adapter-parquet/src/Flow/ETL/Adapter/Parquet/functions.php',
            __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/lib/postgresql/src/Flow/PostgreSql/DSL/schema.php',
            __DIR__ . '/../src/lib/postgresql/src/Flow/PostgreSql/DSL/query.php',
            __DIR__ . '/../src/lib/postgresql/src/Flow/PostgreSql/DSL/condition.php',
            __DIR__ . '/../src/lib/postgresql/src/Flow/PostgreSql/DSL/parser.php',
            __DIR__ . '/../src/lib/postgresql/src/Flow/PostgreSql/DSL/client.php',
            __DIR__ . '/../src/lib/postgresql/src/Flow/PostgreSql/Migrations/DSL/functions.php',
            __DIR__ . '/../src/lib/telemetry/src/Flow/Telemetry/DSL/functions.php',
            __DIR__ . '/../src/lib/azure-sdk/src/Flow/Azure/SDK/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/bridge/monolog/telemetry/src/Flow/Bridge/Monolog/Telemetry/DSL/functions.php',
            __DIR__ . '/../src/bridge/symfony/http-foundation-telemetry/src/Flow/Bridge/Symfony/HttpFoundationTelemetry/DSL/functions.php',
            __DIR__ . '/../src/bridge/symfony/telemetry-bundle/src/Flow/Bridge/Symfony/TelemetryBundle/DSL/functions.php',
            __DIR__ . '/../src/bridge/psr7/telemetry/src/Flow/Bridge/Psr7/Telemetry/DSL/functions.php',
            __DIR__ . '/../src/bridge/psr18/telemetry/src/Flow/Bridge/Psr18/Telemetry/DSL/functions.php',
            __DIR__ . '/../src/bridge/telemetry/otlp/src/Flow/Bridge/Telemetry/OTLP/DSL/functions.php',
        ];

        $extractor = new FunctionsExtractor(
            $input->getOption('repository-root-path'),
            new FunctionCollector()
        );

        $normalizedFunctions = [];

        foreach ($extractor->extract($paths) as $function) {
            if (($attribute = $function->attributes->findByName('DocumentationDSL')) !== null) {

                if ($attribute->arguments['module'] === Module::DEPRECATED) {
                    continue;
                }
            }

            $normalizedFunctions[] = $function->normalize();
        }

        \file_put_contents(__DIR__ . '/../' . \ltrim((string) $input->getArgument('output'), '/'), \json_encode($normalizedFunctions));

        return Command::SUCCESS;
    }
});

$application->add(new class extends Command {
    public function configure() : void
    {
        $this
            ->setName('api:dump')
            ->setDescription('Dump API methods from classes into json file.')
            ->addArgument('output', InputArgument::REQUIRED, 'Where to dump methods.');
    }

    public function execute(InputInterface $input, OutputInterface $output) : int
    {
        $repositoryRootPath = dirname(__DIR__) . '/';

        $classes = [
            ScalarFunctionChain::class,
            Flow::class,
            DataFrame::class,
            GroupedDataFrame::class,
        ];

        $normalizedMethods = [];

        foreach ($classes as $className) {
            $extractor = new MethodsExtractor(
                $repositoryRootPath,
                $className,
                new MethodCollector()
            );

            foreach ($extractor->extract() as $method) {
                $normalizedMethods[] = $method->normalize();
            }
        }

        \file_put_contents(__DIR__ . '/../' . \ltrim((string) $input->getArgument('output'), '/'), \json_encode($normalizedMethods));

        return Command::SUCCESS;
    }
});

$application->run();