3.0 (#15)

Padam87 · web-flow · commit 8bae2c933143 · 2017-12-13T21:36:33.000+01:00
* Updated dependencies, php compatibility, no longer tied to phantomjs

* Added docs for puppeteer

* Use composer's phpunit for travis

* Fixed phpunit test case namespace

* Fixed psr4 config
diff --git a/.travis.yml b/.travis.yml
@@ -1,16 +1,15 @@
 language: php
 
 php:
-  - 5.5
-  - 7.0
+  - 7.1
 
 matrix:
   fast_finish: true
 
 before_script:
   - composer update --dev
 
-script: phpunit
+script: vendor/bin/phpunit
 
 after_script:
   - php vendor/bin/coveralls -v
diff --git a/ConfigHelper.php b/ConfigHelper.php
@@ -7,58 +7,30 @@
 
 class ConfigHelper
 {
-    /**
-     * @var array
-     */
-    protected $config;
+    private $config;
+    private $projectDir;
 
-    /**
-     * @param array  $config
-     */
-    public function __construct(array $config)
+    public function __construct(string $projectDir, array $config)
     {
         $this->config = $config;
+        $this->projectDir = $projectDir;
     }
 
-    /**
-     * @param InputStream $input
-     * @param array       $arguments
-     *
-     * @return Process
-     */
-    public function buildProcess($input, $arguments = array())
+    public function buildProcess(InputStream $input, array $arguments = []): Process
     {
         $process = new Process(
             array_merge(
-                [$this->config['phantomjs']['callable']],
-                $this->processPhantomjsOptions(),
-                [ $this->config['script'] ],
+                [
+                    $this->config['script']['callable'],
+                    $this->projectDir . DIRECTORY_SEPARATOR . $this->config['script']['path']
+                ],
                 array_values(array_merge($this->config['arguments'], $arguments))
             ),
-            null, [], $input
+            null,
+            [],
+            $input
         );
 
         return $process;
     }
-
-    /**
-     * @return array
-     */
-    protected function processPhantomjsOptions()
-    {
-        $options = array();
-
-        foreach ($this->config['phantomjs']['options'] as $name => $value) {
-            if (is_numeric($name)) {
-                $options[] = $value;
-            } else {
-                if (is_bool($value)) {
-                    $value = ($value) ? 'true' : 'false';
-                }
-                $options[] = sprintf('%s=%s', $name, $value);
-            }
-        }
-
-        return $options;
-    }
 }
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -4,11 +4,12 @@
 
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
+use Symfony\Component\HttpKernel\Kernel;
 
 class Configuration implements ConfigurationInterface
 {
     /**
-     * {@inheritDoc}
+     * {@inheritdoc}
      */
     public function getConfigTreeBuilder()
     {
@@ -17,38 +18,16 @@ public function getConfigTreeBuilder()
 
         $rootNode
             ->children()
-                ->arrayNode('phantomjs')
+                ->arrayNode('script')
                     ->addDefaultsIfNotSet()
                     ->children()
-                        ->scalarNode('callable')->defaultValue('phantomjs')->end()
-                        ->arrayNode('options')
-                            ->info('http://phantomjs.org/api/command-line.html')
-                            ->defaultValue(
-                                [
-                                    '--output-encoding' => $this->isWin() ? 'ISO-8859-1' : 'UTF-8',
-                                ]
-                            )
-                            ->normalizeKeys(false)
-                            ->beforeNormalization()
-                                ->ifTrue(function ($v) {
-                                    return !isset($v['--output-encoding']);
-                                })
-                                ->then(function ($v) {
-                                    return array_merge(
-                                        [
-                                            '--output-encoding' => $this->isWin() ? 'ISO-8859-1' : 'UTF-8',
-                                        ],
-                                        $v
-                                    );
-                            })
-                            ->end()
-                            ->prototype('scalar')->end()
+                        ->scalarNode('callable')->defaultValue('node')->end()
+                        ->scalarNode('path')
+                            ->defaultValue($this->getAssetsDir() . DIRECTORY_SEPARATOR . 'rasterize.js')
+                            ->info('Relative to project dir')
                         ->end()
                     ->end()
                 ->end()
-                ->scalarNode('script')
-                    ->defaultValue('../web/bundles/padam87rasterize/js/rasterize.js')->info('Relative to root dir')
-                ->end()
                 ->arrayNode('arguments')
                     ->defaultValue(
                         [
@@ -71,8 +50,13 @@ public function getConfigTreeBuilder()
         return $treeBuilder;
     }
 
-    private function isWin()
+    private function getAssetsDir()
     {
-        return strtoupper(substr(PHP_OS, 0, 3)) === 'WIN';
+        switch (Kernel::MAJOR_VERSION) {
+            case 4:
+                return 'assets';
+            default:
+                return 'web';
+        }
     }
 }
diff --git a/README.md b/README.md
@@ -29,9 +29,12 @@ $response = new Response(
 
 [Configuration reference](Resources/docs/configuration_reference.md)
 
+**Providers**
+- [Puppeteer](Resources/docs/provider/puppeteer.md)
+- [PhantomJS](Resources/docs/provider/phantomjs.md)
+- [Other](Resources/docs/provider/other.md)
+
 **How to...**
  - [pass arguments to the javascript file?](Resources/docs/how_to_pass_arguments.md)
- - [ignore SSL errors?](Resources/docs/how_to_ignore_ssl_errors.md)
-
 
 
diff --git a/Rasterizer.php b/Rasterizer.php
@@ -7,40 +7,16 @@
 
 class Rasterizer
 {
-    /**
-     * @var ConfigHelper
-     */
     protected $configHelper;
-
-    /**
-     * @var Stopwatch
-     */
     protected $stopwatch;
 
-    /**
-     * @var array
-     */
-    protected $environment;
-
-    /**
-     * @param ConfigHelper $configHelper
-     * @param Stopwatch    $stopwatch
-     * @param string       $environment
-     */
-    public function __construct(ConfigHelper $configHelper, Stopwatch $stopwatch = null, $environment)
+    public function __construct(ConfigHelper $configHelper, Stopwatch $stopwatch = null)
     {
         $this->configHelper = $configHelper;
         $this->stopwatch = $stopwatch;
-        $this->environment = [ $environment ];
     }
 
-    /**
-     * @param string $html
-     * @param array  $arguments
-     *
-     * @return string
-     */
-    public function rasterize($html, $arguments = array())
+    public function rasterize(string $html, $arguments = []): string
     {
         if ($this->stopwatch instanceof Stopwatch) {
             $this->stopwatch->start('rasterizer');
@@ -49,7 +25,7 @@ public function rasterize($html, $arguments = array())
         $input = new InputStream();
 
         $process = $this->configHelper->buildProcess($input, $arguments);
-        $process->start(null, $this->environment);
+        $process->start(null, []);
 
         $input->write($html);
         $input->close();
diff --git a/Resources/config/services.xml b/Resources/config/services.xml
@@ -12,12 +12,12 @@
 
     <services>
         <service id="padam87_rasterize.config_helper" class="%padam87_rasterize.config_helper.class%">
+            <argument>%kernel.project_dir%</argument>
             <argument>%padam87_rasterize.config%</argument>
         </service>
         <service id="padam87_rasterize.rasterizer" class="%padam87_rasterize.rasterizer.class%" public="true">
             <argument type="service" id="padam87_rasterize.config_helper" />
             <argument type="service" id="debug.stopwatch" on-invalid="null" />
-            <argument>%kernel.environment%</argument>
         </service>
     </services>
 </container>
diff --git a/Resources/docs/configuration_reference.md b/Resources/docs/configuration_reference.md
@@ -4,11 +4,9 @@
 
 ```YAML
 padam87_rasterize:
-    phantomjs:
-        callable:             phantomjs
-        options:  # http://phantomjs.org/api/command-line.html
-            '--output-encoding': 'UTF-8' # will default to ISO-8859-1 on windows
-    script:               /bundles/padam87rasterize/js/rasterize.js # Relative to web dir
-    arguments: # You can define your own custom arguments. Will be added by default to every process.
-        format:              pdf # Default, will always be added, even if you remove it from here.
+    script:
+        callable: node
+        path: web\rasterize.js # Relative to project dir
+    arguments:
+        format: pdf # Default, will always be added, even if you remove it from here.
 ```
diff --git a/Resources/docs/how_to_ignore_ssl_errors.md b/Resources/docs/how_to_ignore_ssl_errors.md
diff --git a/Resources/docs/how_to_pass_arguments.md b/Resources/docs/how_to_pass_arguments.md
@@ -6,9 +6,7 @@ First, the configuration should be changed
 
 ```yaml
 padam87_rasterize:
-    script:               /js/my-rasterize.js
     arguments:
-        format: pdf
         orientation: portrait
 ```
 
@@ -17,24 +15,11 @@ Note that the orientation argument has been added, by default it will be set as
 A custom javascript is also necessary, to handle the newly received argument.
 
 ```js
-var page = require('webpage').create(),
-    system = require('system'),
-    format;
-
-format = system.args[1];
-orientation = system.args[2];
-
-system.stdin.setEncoding('UTF-8'); // force utf8 input encoding even when output is different
-var content = system.stdin.read();
-
-page.setContent(content, 'http://localhost');
-page.viewportSize = { width: 1920, height: 1080 };
-page.paperSize = { format: 'A4', orientation: orientation, border: '1cm' };
-
-page.onLoadFinished = function(success) {
-    page.render('/dev/stdout', {format: 'pdf'});
-    phantom.exit();
-};
+// ...
+const args = process.argv;
+const format = args[2];
+const orientation = args[3];
+// ...
 ```
 
 To change the orientation to `landscape`, you need to add one more parameter to the rasterizer call.
diff --git a/Resources/docs/install.md b/Resources/docs/install.md
@@ -13,6 +13,8 @@ $bundles = array(
 );
 ```
 
-### Install assets ###
+### Chose a provider ###
 
-`php app/console assets:install`
+- [Puppeteer](provider/puppeteer.md)
+- [PhantomJS](provider/phantomjs.md)
+- [Other](provider/other.md)
diff --git a/Resources/docs/provider/puppeteer.md b/Resources/docs/provider/puppeteer.md
@@ -0,0 +1,48 @@
+# Add puppeteer
+
+`yarn add puppeteer` or `npm i puppeteer`
+
+# Create a script
+- **Symfony 4:** assets/rasterize.js
+- **Symfony 3:** web/rasterize.js
+
+```js
+const puppeteer = require('puppeteer');
+const fs = require('fs');
+
+let stdinBuffer = fs.readFileSync(0 /* STDIN_FILENO */, 'utf8');
+let html = stdinBuffer.toString();
+
+const args = process.argv;
+const format = args[2];
+
+(async () => {
+    const browser = await puppeteer.launch({
+        ignoreHTTPSErrors: true
+    });
+    const page = await browser.newPage();
+
+    // https://github.com/GoogleChrome/puppeteer/issues/728
+    // await page.setContent(html);
+    // await page.waitForNavigation({ waitUntil: 'networkidle0' });
+
+    await page.goto('data:text/html,' + html, { waitUntil: 'networkidle0' });
+
+    if (format == 'pdf') {
+        await page.pdf({
+            path: 1, // STDOUT_FILENO
+            format: 'A4',
+            printBackground: true,
+            margin: { top: '1cm', right: '1cm', bottom: '1cm', left: '1cm' }
+        });
+    } else {
+        await page.screenshot({
+            path: 1, // STDOUT_FILENO
+            type: format,
+            quality: 100,
+        });
+    }
+
+    await browser.close();
+})();
+```
diff --git a/Resources/public/js/rasterize.js b/Resources/public/js/rasterize.js
diff --git a/Tests/ConfigHelperTest.php b/Tests/ConfigHelperTest.php
diff --git a/Tests/RasterizerTest.php b/Tests/RasterizerTest.php
diff --git a/composer.json b/composer.json
