refactor: reformat code with mago formatter / linter

Author: norberttech

bin/docs.php

@@ -3,14 +3,19 @@
 
 declare(strict_types=1);
 
-use Flow\Documentation\{FunctionCollector, FunctionsExtractor, MethodCollector, MethodsExtractor};
+use Flow\Documentation\FunctionCollector;
+use Flow\Documentation\FunctionsExtractor;
+use Flow\Documentation\MethodCollector;
+use Flow\Documentation\MethodsExtractor;
 use Flow\ETL\Attribute\Module;
+use Flow\ETL\DataFrame;
 use Flow\ETL\DataFrame\GroupedDataFrame;
-use Flow\ETL\{DataFrame, Flow};
+use Flow\ETL\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\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
 require __DIR__ . '/../vendor/autoload.php';
@@ -32,18 +37,23 @@
 $application = new Application('Flow-PHP - Documentation');
 
 $application->add(new class extends Command {
-    public function configure() : void
+    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__) . '/')
+            ->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
+    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',
@@ -71,23 +81,21 @@ public function execute(InputInterface $input, OutputInterface $output) : int
             __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/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()
-        );
+        $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;
                 }
@@ -96,22 +104,25 @@ public function execute(InputInterface $input, OutputInterface $output) : int
             $normalizedFunctions[] = $function->normalize();
         }
 
-        \file_put_contents(__DIR__ . '/../' . \ltrim((string) $input->getArgument('output'), '/'), \json_encode($normalizedFunctions));
+        \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
+    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
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         $repositoryRootPath = dirname(__DIR__) . '/';
 
@@ -125,18 +136,17 @@ public function execute(InputInterface $input, OutputInterface $output) : int
         $normalizedMethods = [];
 
         foreach ($classes as $className) {
-            $extractor = new MethodsExtractor(
-                $repositoryRootPath,
-                $className,
-                new MethodCollector()
-            );
+            $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));
+        \file_put_contents(
+            __DIR__ . '/../' . \ltrim((string) $input->getArgument('output'), '/'),
+            \json_encode($normalizedMethods),
+        );
 
         return Command::SUCCESS;
     }

composer.json

@@ -351,7 +351,7 @@
         ],
         "cs:php:fix": [
             "tools/mago/vendor/bin/mago format",
-            "tools/mago/vendor/bin/mago lint --fix"
+            "tools/mago/vendor/bin/mago lint --fix --potentially-unsafe --format-after-fix"
         ],
         "build:phar": [
             "bin/build-phar.sh",

mago.toml

@@ -20,6 +20,13 @@ enable-short-tags = false
 
 [linter]
 integrations = ["symfony", "phpunit"]
+excludes = [
+    "**/Flow/Parquet/ThriftModel/**",
+    "**/Flow/Parquet/Thrift/**",
+    "**/otlp/src/Opentelemetry/**",
+    "**/otlp/src/GPBMetadata/**",
+    "**/lib/postgresql/src/Flow/PostgreSql/Protobuf/**",
+]
 
 [linter.rules]
 cyclomatic-complexity = { enabled = false }
@@ -66,6 +73,29 @@ use-specific-assertions = { enabled = false }
 prefer-first-class-callable = { enabled = false }
 final-controller = { enabled = false }
 prefer-interface = { enabled = false }
+no-shorthand-ternary = { enabled = false }
+no-error-control-operator = { enabled = false }
+no-literal-password = { enabled = false }
+no-ini-set = { enabled = false }
+instanceof-stringable = { enabled = false }
+no-redundant-file = { enabled = false }
+no-sprintf-concat = { enabled = false }
+no-global = { enabled = false }
+no-redundant-method-override = { enabled = false }
 no-redundant-else = { enabled = true, level = "warning" }
-no-redundant-variable = { enabled = true, level = "warning" }
+# Bug in Mago 1.26 - revisit when resolved
+no-redundant-variable = { enabled = true, level = "warning", exclude = [
+    "**/Flow/ETL/Function/ScalarFunctionChain.php",
+    "**/Flow/ETL/DataFrame.php",
+    "**/Flow/ETL/Row/EntryReference.php",
+    "**/Flow/ETL/Sort/SortAlgorithms.php",
+    "**/Flow/PostgreSql/QueryBuilder/**",
+    "**/Flow/PostgreSql/Tests/Unit/QueryBuilder/Expression/MockExpression.php",
+    "**/Flow/PostgreSql/Explain/Plan/PlanNodeType.php",
+    "**/Flow/Filesystem/Path.php",
+    "**/CacheSpyClient.php",
+    "**/Tests/Unit/ObjectExtractorTest.php",
+    "**/array-dot/src/Flow/ArrayDot/array_dot.php",
+    "**/TracableHttpClientTest.php",
+] }
 strict-types = { enabled = true, level = "error" }

phpstan.neon

@@ -97,6 +97,7 @@ parameters:
         - src/cli/src/Flow/CLI/Command/*
         - src/core/etl/src/Flow/ETL/Formatter/ASCII/ASCIITable.php
         - src/core/etl/src/Flow/ETL/Formatter/ASCII/ASCIIValue.php
+        - src/core/etl/tests/Flow/ETL/Tests/Fixtures/empty.php
         - src/core/etl/src/Flow/ETL/Sort/ExternalSort/RowsMinHeap.php
         - src/adapter/etl-adapter-avro/*
         - src/adapter/etl-adapter-elasticsearch/src/Flow/ETL/Adapter/Elasticsearch/ElasticsearchPHP/SearchResults.php
@@ -190,6 +191,22 @@ parameters:
             path: src/core/etl/src/Flow/Calculator/Calculator.php
             identifier: argument.type
             reportUnmatched: false
+        -
+            path: src/adapter/etl-adapter-doctrine/src/Flow/ETL/Adapter/Doctrine/DbalKeySetExtractor.php
+            identifier: method.notFound
+            reportUnmatched: false
+        -
+            path: src/adapter/etl-adapter-doctrine/src/Flow/ETL/Adapter/Doctrine/DbalKeySetExtractor.php
+            identifier: function.alreadyNarrowedType
+            reportUnmatched: false
+        -
+            path: src/adapter/etl-adapter-doctrine/src/Flow/ETL/Adapter/Doctrine/DbalLimitOffsetExtractor.php
+            identifier: method.notFound
+            reportUnmatched: false
+        -
+            path: src/adapter/etl-adapter-doctrine/src/Flow/ETL/Adapter/Doctrine/DbalLimitOffsetExtractor.php
+            identifier: function.alreadyNarrowedType
+            reportUnmatched: false
 
 includes:
     - tools/phpstan/vendor/spaze/phpstan-disallowed-calls/extension.neon

src/adapter/etl-adapter-avro/src/Flow/ETL/Adapter/Avro/FlixTech/AvroExtractor.php

@@ -4,27 +4,34 @@
 
 namespace Flow\ETL\Adapter\Avro\FlixTech;
 
-use Flow\ETL\{Exception\RuntimeException, Extractor, FlowContext};
-use Flow\ETL\Extractor\{FileExtractor, Limitable, LimitableExtractor};
+use Flow\ETL\Exception\RuntimeException;
+use Flow\ETL\Extractor;
+use Flow\ETL\Extractor\FileExtractor;
+use Flow\ETL\Extractor\Limitable;
+use Flow\ETL\Extractor\LimitableExtractor;
 use Flow\ETL\Extractor\PathFiltering;
+use Flow\ETL\FlowContext;
 use Flow\Filesystem\Path;
 
 final class AvroExtractor implements Extractor, FileExtractor, LimitableExtractor
 {
     use Limitable;
     use PathFiltering;
 
-    public function __construct(private readonly Path $path)
-    {
-        throw new RuntimeException('Avro integration was abandoned due to lack of availability of good Avro libraries.');
+    public function __construct(
+        private readonly Path $path,
+    ) {
+        throw new RuntimeException(
+            'Avro integration was abandoned due to lack of availability of good Avro libraries.',
+        );
     }
 
-    public function extract(FlowContext $context) : \Generator
+    public function extract(FlowContext $context): \Generator
     {
         yield;
     }
 
-    public function source() : Path
+    public function source(): Path
     {
         return $this->path;
     }

src/adapter/etl-adapter-avro/src/Flow/ETL/Adapter/Avro/FlixTech/AvroLoader.php

@@ -4,8 +4,12 @@
 
 namespace Flow\ETL\Adapter\Avro\FlixTech;
 
-use Flow\ETL\{Exception\RuntimeException, FlowContext, Loader, Rows};
-use Flow\ETL\Loader\{Closure, FileLoader};
+use Flow\ETL\Exception\RuntimeException;
+use Flow\ETL\FlowContext;
+use Flow\ETL\Loader;
+use Flow\ETL\Loader\Closure;
+use Flow\ETL\Loader\FileLoader;
+use Flow\ETL\Rows;
 use Flow\ETL\Schema;
 use Flow\Filesystem\Path;
 use Flow\Filesystem\Path\Option;
@@ -19,20 +23,18 @@ public function __construct(
         Path $path,
         private ?Schema $schema = null,
     ) {
-        throw new RuntimeException('Avro integration was abandoned due to lack of availability of good Avro libraries.');
+        throw new RuntimeException(
+            'Avro integration was abandoned due to lack of availability of good Avro libraries.',
+        );
         $this->path = $path->setOptionWhenEmpty(Option::CONTENT_TYPE->value, ContentType::AVRO);
     }
 
-    public function closure(FlowContext $context) : void
-    {
-    }
+    public function closure(FlowContext $context): void {}
 
-    public function destination() : Path
+    public function destination(): Path
     {
         return $this->path;
     }
 
-    public function load(Rows $rows, FlowContext $context) : void
-    {
-    }
+    public function load(Rows $rows, FlowContext $context): void {}
 }

src/adapter/etl-adapter-avro/src/Flow/ETL/Adapter/Avro/functions.php

@@ -4,24 +4,24 @@
 
 namespace Flow\ETL\DSL\Adapter\Avro;
 
-use function Flow\Filesystem\DSL\path_real;
-use Flow\ETL\Adapter\Avro\FlixTech\{AvroExtractor, AvroLoader};
-use Flow\ETL\{Attribute\DocumentationDSL, Attribute\Module, Attribute\Type, Schema};
+use Flow\ETL\Adapter\Avro\FlixTech\AvroExtractor;
+use Flow\ETL\Adapter\Avro\FlixTech\AvroLoader;
+use Flow\ETL\Attribute\DocumentationDSL;
+use Flow\ETL\Attribute\Module;
+use Flow\ETL\Attribute\Type;
+use Flow\ETL\Schema;
 use Flow\Filesystem\Path;
 
+use function Flow\Filesystem\DSL\path_real;
+
 #[DocumentationDSL(module: Module::AVRO, type: Type::EXTRACTOR)]
-function from_avro(Path|string $path) : AvroExtractor
+function from_avro(Path|string $path): AvroExtractor
 {
-    return new AvroExtractor(
-        \is_string($path) ? path_real($path) : $path
-    );
+    return new AvroExtractor(\is_string($path) ? path_real($path) : $path);
 }
 
 #[DocumentationDSL(module: Module::AVRO, type: Type::LOADER)]
-function to_avro(Path|string $path, ?Schema $schema = null) : AvroLoader
+function to_avro(Path|string $path, ?Schema $schema = null): AvroLoader
 {
-    return new AvroLoader(
-        \is_string($path) ? path_real($path) : $path,
-        $schema
-    );
+    return new AvroLoader(\is_string($path) ? path_real($path) : $path, $schema);
 }