add symfony bundle

Author: gilles-g

composer.json

@@ -1,19 +1,22 @@
 {
-    "name": "spiriitlabs/rustsheet",
+    "name": "spiriitlabs/excel-rust",
     "require": {
         "symfony/filesystem": "5.4 | 6.4 | 7.*",
         "symfony/process": "5.4 | 6.4 | 7.*",
         "symfony/serializer": "5.4 | 6.4 | 7.*",
         "flix-tech/avro-php": "^5.0",
         "symfony/options-resolver": "5.4 | 6.4 | 7.*",
-        "psr/log": "^3.0"
+        "psr/log": "^3.0",
+        "symfony/framework-bundle": "6.4 | 7.*",
+        "symfony/string": "6.4 | 7.*"
     },
     "require-dev": {
-        "phpunit/phpunit": "11.*",
+        "phpunit/phpunit": "10.*",
         "symfony/var-dumper": "5.4 | 6.4 | 7.*",
         "friendsofphp/php-cs-fixer": "^3.64",
         "phpstan/phpstan": "^1.12",
-        "rector/rector": "^1.2"
+        "rector/rector": "^1.2",
+        "matthiasnoback/symfony-dependency-injection-test": "^6.0"
     },
     "autoload": {
         "psr-4": {

examples/WorkbookFactoryStub.php

@@ -0,0 +1,22 @@
+<?php
+
+use Spiriit\Rustsheet\Structure\Workbook;
+use Spiriit\Rustsheet\WorkbookBuilder;
+use Spiriit\Tests\Fixtures\MyExcel;
+
+require __DIR__.'/../vendor/autoload.php';
+
+class WorkbookFactoryStub implements \Spiriit\Rustsheet\WorkbookFactoryInterface
+{
+
+    public function create(string $name): array
+    {
+        $excel = new MyExcel();
+
+        $builder = new WorkbookBuilder(new Workbook('made_avro.xlsx'));
+
+        $excel->buildSheet($builder);
+
+        return $builder->build();
+    }
+}

examples/example_avro.php

@@ -1,20 +1,26 @@
 <?php
 
 require __DIR__.'/../vendor/autoload.php';
+require __DIR__.'/WorkbookFactoryStub.php';
 
 use Spiriit\Rustsheet\ExcelRust;
-use Spiriit\Rustsheet\WorkbookFactory;
 use Spiriit\Tests\Fixtures\MyExcel;
 use Psr\Log\NullLogger;
 
+
 @unlink($output = __DIR__.'/../myexcel.xlsx');
 
-$excelGeneratorFromAvro = new ExcelRust(
-    workbookFactory: new WorkbookFactory(),
-    rustGenLocation: __DIR__ . '/../vendor/bin/excel_gen'
+$factory = new WorkbookFactoryStub();
+
+$excelRust = new ExcelRust(
+    workbookFactory: $factory,
+    rustGenLocation: __DIR__ . '/../excel_gen',
+    defaultOutputFolder: __DIR__.'/../',
 );
-$excelGeneratorFromAvro->setLogger(new NullLogger());
+$excelRust->setLogger(new NullLogger());
+
+$output = $excelRust->generateExcelFromAvro(MyExcel::class);
 
-$excelGeneratorFromAvro->generateExcelFromAvro(new MyExcel());
+// echo $output;
 
 @unlink($output);

examples/example_html.php

@@ -1,21 +1,24 @@
 <?php
 
 require __DIR__.'/../vendor/autoload.php';
+require __DIR__.'/WorkbookFactoryStub.php';
 
 use Spiriit\Rustsheet\ExcelRust;
-use Spiriit\Rustsheet\WorkbookFactory;
 use Psr\Log\NullLogger;
 
 @unlink($output = 'myexcel_html.xlsx');
 
-$avroFactory = new ExcelRust(
-    workbookFactory: new WorkbookFactory(),
-    rustGenLocation: __DIR__ . '/../vendor/bin/excel_gen'
+$factory = new WorkbookFactoryStub();
+
+$excelRust = new ExcelRust(
+    workbookFactory: $factory,
+    rustGenLocation: __DIR__ . '/../excel_gen',
+    defaultOutputFolder: __DIR__.'/../',
 );
-$avroFactory->setLogger(new NullLogger());
+$excelRust->setLogger(new NullLogger());
 
 $htmlFile = __DIR__.DIRECTORY_SEPARATOR.'fixtures.html';
 
-$avroFactory->generateExcelFromHtml($htmlFile, $output);
+$excelRust->generateExcelFromHtml($htmlFile, $output);
 
 @unlink($output = 'myexcel_html.xlsx');

phpunit.xml.dist

@@ -4,6 +4,7 @@
          xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.0/phpunit.xsd"
          backupGlobals="false" colors="true"
          bootstrap="vendor/autoload.php"
+         displayDetailsOnTestsThatTriggerWarnings="true"
          cacheDirectory=".phpunit.cache">
   <php>
     <ini name="error_reporting" value="-1"/>

src/Attributes/AsExcelRust.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the SpiriitLabs php-excel-rust package.
+ * Copyright (c) SpiriitLabs <https://www.spiriit.com/>
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Spiriit\Rustsheet\Attributes;
+
+#[\Attribute(\Attribute::TARGET_CLASS)]
+class AsExcelRust
+{
+    public function __construct(
+        private readonly ?string $name = null,
+        private readonly ?string $outputName = null,
+    ) {
+    }
+
+    public function serviceConfig(): array
+    {
+        return [
+            'key' => $this->name,
+            'outputName' => $this->outputName,
+        ];
+    }
+}

src/ExcelInterface.php

@@ -9,11 +9,7 @@
 
 namespace Spiriit\Rustsheet;
 
-use Symfony\Component\OptionsResolver\OptionsResolver;
-
 interface ExcelInterface
 {
     public function buildSheet(WorkbookBuilder $builder): void;
-
-    public function configureOptions(OptionsResolver $resolver): void;
 }

src/ExcelRust.php

@@ -14,6 +14,8 @@
 use Spiriit\Rustsheet\ExportAvro\ExportAvro;
 use Symfony\Component\Process\Process;
 
+use function Symfony\Component\String\u;
+
 class ExcelRust implements LoggerAwareInterface
 {
     use LoggerAwareTrait;
@@ -22,20 +24,29 @@ class ExcelRust implements LoggerAwareInterface
     public const RUST_GEN_HTML = 'rust_gen_html';
 
     public function __construct(
-        private WorkbookFactory $workbookFactory,
+        private WorkbookFactoryInterface $workbookFactory,
         private string $rustGenLocation,
+        private string $defaultOutputFolder,
     ) {
     }
 
-    public function generateExcelFromAvro(ExcelInterface $excel): void
+    public function generateExcelFromAvro(string $name): string
     {
-        $results = $this->buildExcel($excel);
-        $filenameOutput = $results['filename'];
+        $results = $this->buildExcel($name);
+
+        $filenameOutput = u($this->defaultOutputFolder)
+            ->append(\DIRECTORY_SEPARATOR)
+            ->append($results['filename'])
+            ->ensureEnd('.xlsx')
+            ->toString();
+
         unset($results['filename']);
 
         $avro = $this->exportAvro($results);
 
         $this->execute($avro, $filenameOutput, self::RUST_GEN_AVRO);
+
+        return $filenameOutput;
     }
 
     public function generateExcelFromHtml(string $htmlFile, string $filenameOutput): void
@@ -65,9 +76,9 @@ private function execute(string $filePath, string $filenameOutput, string $rustG
         ]);
     }
 
-    private function buildExcel(ExcelInterface $excel): array
+    private function buildExcel(string $name): array
     {
-        return $this->workbookFactory->create($excel);
+        return $this->workbookFactory->create($name);
     }
 
     private function exportAvro(array $results)

src/Symfony/Bundle/DependencyInjection/Compiler/ExcelInterfacePass.php

@@ -0,0 +1,56 @@
+<?php
+
+/*
+ * This file is part of the SpiriitLabs php-excel-rust package.
+ * Copyright (c) SpiriitLabs <https://www.spiriit.com/>
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Spiriit\Rustsheet\Symfony\Bundle\DependencyInjection\Compiler;
+
+use Spiriit\Rustsheet\WorkbookFactory;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\Compiler\ServiceLocatorTagPass;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Exception\LogicException;
+use Symfony\Component\DependencyInjection\Reference;
+
+class ExcelInterfacePass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container)
+    {
+        if (!$container->hasDefinition(WorkbookFactory::class)) {
+            return;
+        }
+
+        $excelsReferences = [];
+        $excelsNames = [];
+        $excelsConfig = [];
+
+        foreach ($container->findTaggedServiceIds('spiriit_excel_rust.excel_rust') as $id => $tags) {
+            $definition = $container->findDefinition($id);
+
+            $name = $definition->getClass();
+
+            foreach ($tags as $tag) {
+                if (!\array_key_exists('key', $tag)) {
+                    if (\in_array($name, $excelsNames, true)) {
+                        throw new LogicException(\sprintf('Failed creating the "%s" excel with the automatic name "%s": another excel already has this name. To fix this, give the excel an explicit name (hint: using "%s" will override the existing excel).', $fqcn, $name, $name));
+                    }
+
+                    $tag['key'] = $name;
+                }
+
+                $excelsConfig[$tag['key']] = $tag;
+                $excelsReferences[$tag['key']] = new Reference($id);
+                $excelsNames[] = $tag['key'];
+            }
+        }
+
+        $factoryDefinition = $container->findDefinition(WorkbookFactory::class);
+
+        $factoryDefinition->setArgument(0, ServiceLocatorTagPass::register($container, $excelsReferences));
+        $factoryDefinition->setArgument(1, $excelsConfig);
+    }
+}

src/Symfony/Bundle/DependencyInjection/Configuration.php

@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the SpiriitLabs php-excel-rust package.
+ * Copyright (c) SpiriitLabs <https://www.spiriit.com/>
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Spiriit\Rustsheet\Symfony\Bundle\DependencyInjection;
+
+use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
+
+class Configuration implements ConfigurationInterface
+{
+    public function getConfigTreeBuilder(): TreeBuilder
+    {
+        $treeBuilder = new TreeBuilder('spiriit_excel_rust');
+        $rootNode = $treeBuilder->getRootNode();
+
+        $rootNode
+            ->children()
+              ->scalarNode('rust_binary')
+                ->info('The rust binary path')
+                ->isRequired()
+              ->end()
+              ->scalarNode('default_output_folder')
+                ->info('The default folder for output excel')
+                ->defaultValue('/tmp')
+            ->end()
+        ;
+
+        return $treeBuilder;
+    }
+}