init vitepress

gilles-g · gilles-g · commit 504daaf1330f · 2024-10-09T11:04:53.000+02:00
diff --git a/README.md b/README.md
@@ -22,16 +22,59 @@ Once the data is received, the Rust binary uses the **excelrust** library to cre
 
 `composer require spiriitlabs/rustsheet`
 
-# Two way for use
+# Download the last release of the rust binary
 
-## With WorkbookFactory
+Go at https://github.com/SpiriitLabs/excel_gen
 
-First create a class implements `ExcelInterface` and add attribute 'AsExcelRust'
+Save the binary somewhere
+
+# Symfony bundle
+
+Just active the bundle in your `bundles.php`
+
+```php
+Spiriit\Rustsheet\Symfony\Bundle\ExcelRustBundle::class => ['all' => true],
+```
+
+Create a file in the folder packages
+
+> config/packages/spiriit_excel_rust.yaml
+
+```yaml
+excel_rust:
+  rust_binary: '%rust_binary%' # path to rust binary
+  avro_codec: 'null' # default to null, because we don't need to compress the file
+```
+
+You need to use the `AsExcelRust` attribute
 
 ```php
 use Spiriit\Rustsheet\Attributes\AsExcelRust;
 
-#[AsExcelRust(outputName: "myexcel.xlsx")] // optionnal outputName
+#[AsExcelRust(name: 'my_super_excel')] // override name is optionnal
+class MyExcel implements ExcelInterface 
+{
+...
+}
+```
+
+```php
+class MyController
+{
+    public function __invoke(ExcelRust $excelRust)
+    {
+        $output = $excelRust->generateExcelFromAvro('MyExcel', __DIR__.'/myexcel_avro.xlsx');
+    }
+}
+```
+
+# Use the library in standalone
+
+## Use a builder
+
+First create a class implements `ExcelInterface` and add attribute 'AsExcelRust'
+
+```php
 class MyExcel implements ExcelInterface
 {
     public function buildSheet(WorkbookBuilder $builder): void
@@ -66,28 +109,34 @@ class MyExcel implements ExcelInterface
 Then create a new instance of ExcelRust and prepare the WorkbookFactory and the excel_rust binary:
 
 ```php
-    $excelGeneratorFromAvro = new ExcelRust(
-        workbookFactory: new WorkbookFactory(),
-        rustGenLocation: __DIR__ . '/../vendor/bin/excel_gen'
+    $factory = new \Spiriit\Rustsheet\WorkbookFactory();
+
+    $exportAvro = new ExportAvro(
+        schema: file_get_contents(__DIR__.'/../schema.json')
+    );
+    
+    $excelRust = new ExcelRust(
+        workbookFactory: $factory,
+        rustGenLocation: __DIR__ . '/path/to/excel_gen',
+        exportAvro: $exportAvro,
     );
-    $excelGeneratorFromAvro->setLogger(new NullLogger());
     
-    $excelGeneratorFromAvro->generateExcelFromAvro(new MyExcel());
+    $output = $excelRust->generateExcelFromAvro(new MyExcel(), __DIR__.'/myexcel_avro.xlsx');
+
 ```
 
 ## From HTML file
 
 ```php
-    $output = '/tmp/output.xlsx';
-    
-    $avroFactory = new ExcelRust(
-        workbookFactory: new WorkbookFactory(),
-        rustGenLocation: __DIR__ . '/../vendor/bin/excel_gen'
+    $factory = new \Spiriit\Rustsheet\WorkbookFactory();
+
+    $excelRust = new ExcelRust(
+        workbookFactory: $factory,
+        rustGenLocation: __DIR__ . '/path/to/excel_gen',
     );
-    $avroFactory->setLogger(new NullLogger());
     
-    $htmlFile = 'fixtures.html';
+    $htmlFile = 'test.html';
     
-    $avroFactory->generateExcelFromHtml($htmlFile, $output);
+    $excelRust->generateExcelFromHtml($htmlFile, $output);
 ```
 
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -2,19 +2,20 @@ import { defineConfig } from 'vitepress'
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
-  base: 'php-excel-rust',
+  base: '/',
   title: "Excel Rust",
   description: "Supercharge Excel generation in PHP with Rust's blazing speed!",
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
     nav: [
-      { text: 'Home', link: '/' },
-      { text: 'Examples', link: '/markdown-examples' }
+      { text: 'PHP', link: '/php-readme' },
+      { text: 'Symfony Bundle', link: '/symfony-bundle' },
+      { text: 'Rust', link: '/rust-excel' }
     ],
 
     sidebar: [
       {
-        text: 'Examples',
+        text: 'PHP',
         items: [
           { text: 'Markdown Examples', link: '/markdown-examples' },
           { text: 'Runtime API Examples', link: '/api-examples' }
@@ -23,7 +24,7 @@ export default defineConfig({
     ],
 
     socialLinks: [
-      { icon: 'github', link: 'https://github.com/vuejs/vitepress' }
+      { icon: 'github', link: 'https://github.com/SpiriitLabs/php-excel-rust' }
     ]
   }
 })
diff --git a/docs/index.md b/docs/index.md
@@ -7,18 +7,22 @@ hero:
   tagline: "PHP to Excel in less than a millisecond!"
   actions:
     - theme: brand
-      text: Markdown Examples
-      link: /markdown-examples
+      text: Getting started
+      link: /php-readme
     - theme: alt
-      text: API Examples
-      link: /api-examples
+      text: Rust
+      link: /rust-excel
 
 features:
-  - title: Feature A
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
-  - title: Feature B
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
-  - title: Feature C
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
+  - title: HTML to Excel 
+    icon:
+      src: /rust-logo-blk.svg
+    details: ~80x times faster than PHP phpoffice/phpspreadsheet for HTML file
+  - title: Generate Fast Excel
+    icon: 🚀
+    details: Fast generation of Excel! 3x times faster than phpoffice/phpspreadsheet
+  - title: Focus on Your Data
+    icon: 🗂️
+    details: Effortlessly create Excel with basic formats.
 ---
 
diff --git a/docs/php-readme.md b/docs/php-readme.md
diff --git a/docs/public/rust-logo-blk.svg b/docs/public/rust-logo-blk.svg
@@ -0,0 +1 @@
+<svg height="144" width="144" xmlns="http://www.w3.org/2000/svg"><path d="m71.05 23.68c-26.06 0-47.27 21.22-47.27 47.27s21.22 47.27 47.27 47.27 47.27-21.22 47.27-47.27-21.22-47.27-47.27-47.27zm-.07 4.2a3.1 3.11 0 0 1 3.02 3.11 3.11 3.11 0 0 1 -6.22 0 3.11 3.11 0 0 1 3.2-3.11zm7.12 5.12a38.27 38.27 0 0 1 26.2 18.66l-3.67 8.28c-.63 1.43.02 3.11 1.44 3.75l7.06 3.13a38.27 38.27 0 0 1 .08 6.64h-3.93c-.39 0-.55.26-.55.64v1.8c0 4.24-2.39 5.17-4.49 5.4-2 .23-4.21-.84-4.49-2.06-1.18-6.63-3.14-8.04-6.24-10.49 3.85-2.44 7.85-6.05 7.85-10.87 0-5.21-3.57-8.49-6-10.1-3.42-2.25-7.2-2.7-8.22-2.7h-40.6a38.27 38.27 0 0 1 21.41-12.08l4.79 5.02c1.08 1.13 2.87 1.18 4 .09zm-44.2 23.02a3.11 3.11 0 0 1 3.02 3.11 3.11 3.11 0 0 1 -6.22 0 3.11 3.11 0 0 1 3.2-3.11zm74.15.14a3.11 3.11 0 0 1 3.02 3.11 3.11 3.11 0 0 1 -6.22 0 3.11 3.11 0 0 1 3.2-3.11zm-68.29.5h5.42v24.44h-10.94a38.27 38.27 0 0 1 -1.24-14.61l6.7-2.98c1.43-.64 2.08-2.31 1.44-3.74zm22.62.26h12.91c.67 0 4.71.77 4.71 3.8 0 2.51-3.1 3.41-5.65 3.41h-11.98zm0 17.56h9.89c.9 0 4.83.26 6.08 5.28.39 1.54 1.26 6.56 1.85 8.17.59 1.8 2.98 5.4 5.53 5.4h16.14a38.27 38.27 0 0 1 -3.54 4.1l-6.57-1.41c-1.53-.33-3.04.65-3.37 2.18l-1.56 7.28a38.27 38.27 0 0 1 -31.91-.15l-1.56-7.28c-.33-1.53-1.83-2.51-3.36-2.18l-6.43 1.38a38.27 38.27 0 0 1 -3.32-3.92h31.27c.35 0 .59-.06.59-.39v-11.06c0-.32-.24-.39-.59-.39h-9.15zm-14.43 25.33a3.11 3.11 0 0 1 3.02 3.11 3.11 3.11 0 0 1 -6.22 0 3.11 3.11 0 0 1 3.2-3.11zm46.05.14a3.11 3.11 0 0 1 3.02 3.11 3.11 3.11 0 0 1 -6.22 0 3.11 3.11 0 0 1 3.2-3.11z"/><path d="m115.68 70.95a44.63 44.63 0 0 1 -44.63 44.63 44.63 44.63 0 0 1 -44.63-44.63 44.63 44.63 0 0 1 44.63-44.63 44.63 44.63 0 0 1 44.63 44.63zm-.84-4.31 6.96 4.31-6.96 4.31 5.98 5.59-7.66 2.87 4.78 6.65-8.09 1.32 3.4 7.46-8.19-.29 1.88 7.98-7.98-1.88.29 8.19-7.46-3.4-1.32 8.09-6.65-4.78-2.87 7.66-5.59-5.98-4.31 6.96-4.31-6.96-5.59 5.98-2.87-7.66-6.65 4.78-1.32-8.09-7.46 3.4.29-8.19-7.98 1.88 1.88-7.98-8.19.29 3.4-7.46-8.09-1.32 4.78-6.65-7.66-2.87 5.98-5.59-6.96-4.31 6.96-4.31-5.98-5.59 7.66-2.87-4.78-6.65 8.09-1.32-3.4-7.46 8.19.29-1.88-7.98 7.98 1.88-.29-8.19 7.46 3.4 1.32-8.09 6.65 4.78 2.87-7.66 5.59 5.98 4.31-6.96 4.31 6.96 5.59-5.98 2.87 7.66 6.65-4.78 1.32 8.09 7.46-3.4-.29 8.19 7.98-1.88-1.88 7.98 8.19-.29-3.4 7.46 8.09 1.32-4.78 6.65 7.66 2.87z" fill-rule="evenodd" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="3"/></svg>
diff --git a/docs/rust-excel.md b/docs/rust-excel.md
diff --git a/docs/symfony-bundle.md b/docs/symfony-bundle.md
@@ -0,0 +1 @@
+Symfony Bundle
diff --git a/examples/WorkbookFactoryStub.php b/examples/WorkbookFactoryStub.php
diff --git a/examples/example_avro.php b/examples/example_avro.php
@@ -1,16 +1,13 @@
 <?php
 
 require __DIR__.'/../vendor/autoload.php';
-require __DIR__.'/WorkbookFactoryStub.php';
 
 use Spiriit\Rustsheet\ExcelRust;
 use Spiriit\Tests\Fixtures\MyExcel;
 use Psr\Log\NullLogger;
 use Spiriit\Rustsheet\ExportAvro\ExportAvro;
 
-@unlink($output = __DIR__.'/../myexcel.xlsx');
-
-$factory = new WorkbookFactoryStub();
+$factory = new \Spiriit\Rustsheet\WorkbookFactory();
 
 $exportAvro = new ExportAvro(
     schema: file_get_contents(__DIR__.'/../schema.json')
diff --git a/examples/example_html.php b/examples/example_html.php
@@ -1,14 +1,13 @@
 <?php
 
 require __DIR__.'/../vendor/autoload.php';
-require __DIR__.'/WorkbookFactoryStub.php';
 
 use Spiriit\Rustsheet\ExcelRust;
 use Psr\Log\NullLogger;
 
 @unlink($output = __DIR__.'/myexcel_html.xlsx');
 
-$factory = new WorkbookFactoryStub();
+$factory = new \Spiriit\Rustsheet\WorkbookFactory();
 
 $excelRust = new ExcelRust(
     workbookFactory: $factory,
diff --git a/src/Attributes/AsExcelRust.php b/src/Attributes/AsExcelRust.php
@@ -14,15 +14,13 @@ 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,
         ];
     }
 }
diff --git a/src/ExcelInterface.php b/src/ExcelInterface.php
@@ -9,7 +9,11 @@
 
 namespace Spiriit\Rustsheet;
 
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
 interface ExcelInterface
 {
     public function buildSheet(WorkbookBuilder $builder): void;
+
+    public function configureOptions(OptionsResolver $resolver): void;
 }
diff --git a/src/ExcelRust.php b/src/ExcelRust.php
@@ -13,6 +13,7 @@
 use Psr\Log\LoggerAwareTrait;
 use Spiriit\Rustsheet\ExportAvro\ExportAvro;
 use Symfony\Component\Process\Process;
+use Webmozart\Assert\Assert;
 
 use function Symfony\Component\String\u;
 
@@ -41,6 +42,8 @@ public function generateExcelFromAvro(ExcelInterface|string $name, ?string $file
                 ->ensureEnd('.xlsx')
                 ->toString();
         } else {
+            Assert::notEmpty($filenameOutput, 'Filename output cannot be empty.');
+
             $filenameOutput = u($filenameOutput)
                 ->ensureEnd('.xlsx')
                 ->toString();
diff --git a/src/Symfony/Bundle/DependencyInjection/Compiler/ExcelInterfacePass.php b/src/Symfony/Bundle/DependencyInjection/Compiler/ExcelInterfacePass.php
@@ -26,7 +26,6 @@ public function process(ContainerBuilder $container)
 
         $excelsReferences = [];
         $excelsNames = [];
-        $excelsConfig = [];
 
         foreach ($container->findTaggedServiceIds('spiriit_excel_rust.excel_rust') as $id => $tags) {
             $definition = $container->findDefinition($id);
@@ -43,7 +42,6 @@ public function process(ContainerBuilder $container)
                     $tag['key'] = $name;
                 }
 
-                $excelsConfig[$tag['key']] = $tag;
                 $excelsReferences[$tag['key']] = new Reference($id);
                 $excelsNames[] = $tag['key'];
             }
@@ -52,6 +50,5 @@ public function process(ContainerBuilder $container)
         $factoryDefinition = $container->findDefinition(WorkbookServiceLocatorFactory::class);
 
         $factoryDefinition->setArgument(0, ServiceLocatorTagPass::register($container, $excelsReferences));
-        $factoryDefinition->setArgument(1, $excelsConfig);
     }
 }
diff --git a/src/Symfony/Bundle/WorkbookServiceLocatorFactory.php b/src/Symfony/Bundle/WorkbookServiceLocatorFactory.php
@@ -11,15 +11,17 @@
 
 use Spiriit\Rustsheet\ExcelInterface;
 use Spiriit\Rustsheet\Structure\Workbook;
+use Spiriit\Rustsheet\Traits\WorkbookFactoryTrait;
 use Spiriit\Rustsheet\WorkbookBuilder;
 use Spiriit\Rustsheet\WorkbookFactoryInterface;
 use Symfony\Component\DependencyInjection\ServiceLocator;
 
 class WorkbookServiceLocatorFactory implements WorkbookFactoryInterface
 {
+    use WorkbookFactoryTrait;
+
     public function __construct(
         private readonly ServiceLocator $excelSheets,
-        private array $config,
     ) {
     }
 
@@ -31,9 +33,9 @@ public function create(ExcelInterface|string $name): array
 
         $excel = $this->getsheet($name);
 
-        $outputName = $this->getOutputName($name);
+        $options = $this->getOptionsResolver($excel);
 
-        $builder = new WorkbookBuilder(new Workbook($outputName));
+        $builder = new WorkbookBuilder(new Workbook($options['filename']));
 
         $excel->buildSheet($builder);
 
@@ -48,13 +50,4 @@ private function getsheet(string $name): ExcelInterface
 
         return $this->excelSheets->get($name);
     }
-
-    private function getOutputName(string $name): string
-    {
-        if (null !== ($this->config[$name] ?? null)) {
-            return $this->config[$name]['outputName'];
-        }
-
-        return WorkbookFactoryInterface::DEFAULT_OUTPUT_NAME;
-    }
 }
diff --git a/src/Traits/WorkbookFactoryTrait.php b/src/Traits/WorkbookFactoryTrait.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace Spiriit\Rustsheet\Traits;
+
+use Spiriit\Rustsheet\ExcelInterface;
+use Spiriit\Rustsheet\WorkbookFactoryInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+trait WorkbookFactoryTrait
+{
+    protected function getOptionsResolver(ExcelInterface $excel): array
+    {
+        $resolver = new OptionsResolver();
+        $resolver->setDefaults([
+            'filename' => WorkbookFactoryInterface::DEFAULT_OUTPUT_NAME,
+        ]);
+
+        $excel->configureOptions($resolver);
+
+        return $resolver->resolve();
+    }
+}
diff --git a/src/WorkbookFactory.php b/src/WorkbookFactory.php
diff --git a/tests/Fixtures/MyExcel.php b/tests/Fixtures/MyExcel.php
