Make Path and Options immutable

Author: norberttech

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

@@ -13,12 +13,14 @@
 
 final readonly class AvroLoader implements Closure, FileLoader, Loader
 {
+    private Path $path;
+
     public function __construct(
-        private Path $path,
+        Path $path,
         private ?Schema $schema = null,
     ) {
         throw new RuntimeException('Avro integration was abandoned due to lack of availability of good Avro libraries.');
-        $this->path->options()->setWhenEmpty(Option::CONTENT_TYPE->value, ContentType::AVRO);
+        $this->path = $path->setOptionWhenEmpty(Option::CONTENT_TYPE->value, ContentType::AVRO);
     }
 
     public function closure(FlowContext $context) : void

src/adapter/etl-adapter-avro/tests/Flow/ETL/Adapter/Avro/Tests/Integration/AvroTest.php

@@ -47,6 +47,6 @@ public function test_using_pattern_path() : void
     {
         $this->expectExceptionMessage("AvroLoader path can't be pattern, given: /path/*/pattern.avro");
 
-        to_avro(new Path('/path/*/pattern.avro'));
+        to_avro(Path::from('/path/*/pattern.avro'));
     }
 }

src/adapter/etl-adapter-chartjs/src/Flow/ETL/Adapter/ChartJS/ChartJSLoader.php

@@ -21,7 +21,7 @@ final class ChartJSLoader implements Closure, Loader
 
     public function __construct(private readonly Chart $type)
     {
-        $this->template = new Path(__DIR__ . '/Resources/template/full_page.html');
+        $this->template = Path::from(__DIR__ . '/Resources/template/full_page.html');
     }
 
     public function closure(FlowContext $context) : void

src/adapter/etl-adapter-csv/src/Flow/ETL/Adapter/CSV/CSVLoader.php

@@ -22,12 +22,13 @@ final class CSVLoader implements Closure, FileLoader, Loader
 
     private string $newLineSeparator = PHP_EOL;
 
+    private readonly Path $path;
+
     private string $separator = ',';
 
-    public function __construct(
-        private readonly Path $path,
-    ) {
-        $this->path->options()->setWhenEmpty(Option::CONTENT_TYPE->value, ContentType::CSV);
+    public function __construct(Path $path)
+    {
+        $this->path = $path->setOptionWhenEmpty(Option::CONTENT_TYPE, ContentType::CSV);
     }
 
     public function closure(FlowContext $context) : void

src/adapter/etl-adapter-csv/tests/Flow/ETL/Adapter/CSV/Tests/Unit/CSVLoaderTest.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Flow\ETL\Adapter\CSV\Tests\Unit;
+
+use function Flow\Filesystem\DSL\path;
+use Flow\ETL\Adapter\CSV\CSVLoader;
+use Flow\Filesystem\Path\Option;
+use Flow\Filesystem\Path\Option\ContentType;
+use PHPUnit\Framework\TestCase;
+
+final class CSVLoaderTest extends TestCase
+{
+    public function test_setting_content_type_on_path() : void
+    {
+        $loader = new CSVLoader(path(__DIR__ . '/file.csv'));
+
+        self::assertEquals($loader->destination()->getOption(Option::CONTENT_TYPE), ContentType::CSV);
+    }
+}

src/adapter/etl-adapter-excel/tests/Flow/ETL/Adapter/Excel/Tests/Unit/ExcelExtractorTest.php

@@ -25,6 +25,6 @@ public function test_non_local_file() : void
         $this->expectException(InvalidArgumentException::class);
         $this->expectExceptionMessage('Only local filesystem paths are supported by ExcelExtractor due to the limitation of underlying library.');
 
-        from_excel(new Path('remote://unknown_file.xlsx'));
+        from_excel(Path::from('remote://unknown_file.xlsx'));
     }
 }

src/adapter/etl-adapter-json/src/Flow/ETL/Adapter/JSON/JsonLinesLoader.php

@@ -15,9 +15,11 @@ final class JsonLinesLoader implements Closure, FileLoader, Loader
 
     private int $flags = JSON_THROW_ON_ERROR;
 
-    public function __construct(private readonly Path $path)
+    private readonly Path $path;
+
+    public function __construct(Path $path)
     {
-        $this->path->options()->setWhenEmpty(Option::CONTENT_TYPE->value, ContentType::JSON);
+        $this->path = $path->setOptionWhenEmpty(Option::CONTENT_TYPE->value, ContentType::JSON);
     }
 
     public function closure(FlowContext $context) : void

src/adapter/etl-adapter-json/src/Flow/ETL/Adapter/JSON/JsonLoader.php

@@ -15,16 +15,18 @@ final class JsonLoader implements Closure, FileLoader, Loader
 
     private int $flags = JSON_THROW_ON_ERROR;
 
+    private readonly Path $path;
+
     private bool $putRowsInNewLines = false;
 
     /**
      * @var array<string, int>
      */
     private array $writes = [];
 
-    public function __construct(private readonly Path $path)
+    public function __construct(Path $path)
     {
-        $this->path->options()->setWhenEmpty(Option::CONTENT_TYPE->value, ContentType::JSON);
+        $this->path = $path->setOptionWhenEmpty(Option::CONTENT_TYPE, ContentType::JSON);
     }
 
     public function closure(FlowContext $context) : void

src/adapter/etl-adapter-json/tests/Flow/ETL/Adapter/JSON/Tests/Unit/JsonLinesLoaderTest.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Flow\ETL\Adapter\JSON\Tests\Unit;
+
+use function Flow\Filesystem\DSL\path;
+use Flow\ETL\Adapter\JSON\JsonLinesLoader;
+use Flow\Filesystem\Path\Option;
+use Flow\Filesystem\Path\Option\ContentType;
+use PHPUnit\Framework\TestCase;
+
+final class JsonLinesLoaderTest extends TestCase
+{
+    public function test_setting_content_type_on_path() : void
+    {
+        $loader = new JsonLinesLoader(path(__DIR__ . '/file.json'));
+
+        self::assertEquals($loader->destination()->getOption(Option::CONTENT_TYPE), ContentType::JSON);
+    }
+}

src/adapter/etl-adapter-json/tests/Flow/ETL/Adapter/JSON/Tests/Unit/JsonLoaderTest.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Flow\ETL\Adapter\JSON\Tests\Unit;
+
+use function Flow\Filesystem\DSL\path;
+use Flow\ETL\Adapter\JSON\JsonLoader;
+use Flow\Filesystem\Path\Option;
+use Flow\Filesystem\Path\Option\ContentType;
+use PHPUnit\Framework\TestCase;
+
+final class JsonLoaderTest extends TestCase
+{
+    public function test_setting_content_type_on_path() : void
+    {
+        $loader = new JsonLoader(path(__DIR__ . '/file.json'));
+
+        self::assertEquals($loader->destination()->getOption(Option::CONTENT_TYPE), ContentType::JSON);
+    }
+}