Doc/processor

CONTRIBUTING.md

@@ -25,15 +25,15 @@ To set up the project locally for development:
 
 ### Clone the Repository
 
-```
-git clone https://github.com/sensiolabs/GotenbergBundle.git
-cd GotenbergBundle
+```shell
+$ git clone https://github.com/sensiolabs/GotenbergBundle.git
+$ cd GotenbergBundle
 ```
 
 ### Install Dependencies
 
-```
-composer install
+```shell
+$ composer install
 ```
 
 ## Testing
@@ -42,14 +42,14 @@ Ensure your changes work as expected by running the test suite:
 
 ### Run Tests
 
-```
-./vendor/bin/phpunit
+```shell
+$ ./vendor/bin/phpunit
 ```
 
 ### Run Tests with Coverage (optional)
 
-```
-./vendor/bin/phpunit --coverage-text
+```shell
+$ ./vendor/bin/phpunit --coverage-text
 ```
 
 ## Quality Assurance
@@ -60,24 +60,32 @@ Maintain high code quality by following these steps before submitting a pull req
 
 Check your code for style violations:
 
-```
-./vendor/bin/php-cs-fixer check --diff
+```shell
+$ PHP_CS_FIXER_IGNORE_ENV=1 ./vendor/bin/php-cs-fixer check --diff
 ```
 
 Eventually, you can fix the issues automatically:
 
-```
-./vendor/bin/php-cs-fixer fix --diff
+```shell
+$ PHP_CS_FIXER_IGNORE_ENV=1 ./vendor/bin/php-cs-fixer fix --diff
 ```
 
 ### Static Analysis
 
-```
-./vendor/bin/phpstan analyse
+```shell
+$ php -dmemory_limit=-1 ./vendor/bin/phpstan analyse --debug
 ```
 
 Detect potential issues in your code.
 
+### Dependencies
+
+```shell
+$ ./vendor/bin/composer-dependency-analyser --show-all-usages
+```
+
+Detect potential issues in composer.json dependencies.
+
 ### Fix Issues
 
 Address any warnings or errors reported by the tools above.
@@ -91,8 +99,8 @@ The project documentation is partially built from the source code.
 
 ### Update the documentation
 
-```
-php ./docs/generate.php
+```shell
+$ php ./docs/generate.php
 ``` 
 
 

README.md

@@ -220,6 +220,7 @@ class YourController
 ### Advanced Usage
 
 1. [Configuration](./docs/configuration.md)
+2. [Processing (saving for example)](./docs/processing.md)
 2. [Working with assets](./docs/assets.md)
 3. [Builders API](./docs/builders_api.md)
 4. [Async & Webhooks](./docs/webhook.md)

composer-dependency-analyser.php

@@ -13,6 +13,13 @@
     ->addPathToScan(__DIR__.'/src/Debug', isDev: true)
     ->addPathToScan(__DIR__.'/tests', isDev: true)
 
+    ->ignoreErrorsOnPackage('async-aws/s3', [
+        ErrorType::DEV_DEPENDENCY_IN_PROD,
+    ])
+    ->disableExtensionsAnalysis() // TODO : Bug waiting for https://github.com/shipmonk-rnd/composer-dependency-analyser/issues/217
+    ->ignoreErrorsOnPackage('league/flysystem', [
+        ErrorType::DEV_DEPENDENCY_IN_PROD,
+    ])
     ->ignoreErrorsOnPackage('symfony/routing', [
         ErrorType::DEV_DEPENDENCY_IN_PROD,
     ])

composer.json

@@ -33,12 +33,15 @@
         "symfony/mime": "^6.4 || ^7.0"
     },
     "require-dev": {
+        "ext-mbstring": "*",
+        "async-aws/s3": "^2.6",
         "friendsofphp/php-cs-fixer": "^3.41",
+        "league/flysystem": "^3.29",
         "phpstan/extension-installer": "^1.3",
         "phpstan/phpstan": "^1.10",
         "phpstan/phpstan-symfony": "^1.3",
         "phpunit/phpunit": "^10.4",
-        "shipmonk/composer-dependency-analyser": "^1.7",
+        "shipmonk/composer-dependency-analyser": "^1.8",
         "symfony/framework-bundle": "^6.4 || ^7.0",
         "symfony/http-client": "^6.4 || ^7.0",
         "symfony/monolog-bundle": "^3.10",
@@ -56,7 +59,9 @@
     },
     "suggest": {
         "symfony/monolog-bundle": "Enables logging througout the generating process.",
-        "symfony/twig-bundle": "Allows you to use Twig to render templates into PDF",
-        "monolog/monolog": "Enables logging througout the generating process."
+        "symfony/twig-bundle": "Allows you to use Twig to render templates into PDF.",
+        "monolog/monolog": "Enables logging througout the generating process.",
+        "async-aws/s3": "Upload any file to aws s3 compatible endpoints supporting multi part upload without memory overhead.",
+        "league/flysystem-bundle": "Upload any file using this filesystem abstraction package."
     }
 }

docs/configuration.md

@@ -8,8 +8,10 @@ The default configuration for the bundle looks like :
 
 Assuming you have the following client configured.
 
-```yaml
+<details>
+    <summary>app/config/framework.yaml</summary>
 
+```yaml
 # app/config/framework.yaml
 
 framework:
@@ -19,8 +21,13 @@ framework:
                 base_uri: 'http://localhost:3000'
 ```
 
+</details>
+
 Then
 
+<details>
+    <summary>app/config/sensiolabs_gotenberg.yaml</summary>
+
 ```yaml
 # app/config/sensiolabs_gotenberg.yaml
 
@@ -1237,6 +1244,8 @@ sensiolabs_gotenberg:
                         # - { name: 'X-Custom-Header', value: 'custom-header-value' }
 ```
 
+</details>
+
 > [!TIP]
 > For more information about the [PDF properties](https://gotenberg.dev/docs/routes#page-properties-chromium) 
 > or [screenshot properties](https://gotenberg.dev/docs/routes#screenshots-route).