Merge remote-tracking branch 'origin/laravel-8-support'

Author: willpower232

.github/workflows/main.yml

@@ -1,26 +1,17 @@
-name: Unit tests
+name: Tests
 
 on: [push]
 
 jobs:
-  run:
-    runs-on: [ubuntu-latest]
+  build:
+    runs-on: ubuntu-latest
     strategy:
       matrix:
-        php-versions: ['7.1', '7.2', '7.3', '7.4']
-    name: Tests - ${{ matrix.php-versions }}
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v1
-
-    - name: Setup PHP
-      uses: shivammathur/setup-php@v1
-      with:
-        php-version: ${{ matrix.php-versions }}
-        coverage: xdebug
+        php: [7.3, 7.4, 8.0]
+        symfony_process: [3.4, 4.0, 5.0]
 
-    - name: Install deps
-      run: composer install
+    steps:
+      - uses: actions/checkout@v2
 
-    - name: Run tests
-      run: vendor/bin/phpunit -c phpunit.xml --coverage-clover=coverage.xml
+      - name: test against Symfony/Process ${{ matrix.symfony_process }} on PHP ${{ matrix.php }}
+        run: docker build . --build-arg PHP_VERSION=${{ matrix.php }} --build-arg SYMFONY_PROCESS=${{ matrix.symfony_process }}

.travis.yml

@@ -0,0 +1,26 @@
+ARG PHP_VERSION=8.0
+FROM php:$PHP_VERSION-cli-alpine
+
+RUN apk add git zip unzip autoconf make g++
+
+RUN if [ -z "${PHP_VERSION##7\.1*}" ]; then \
+    pecl install xdebug-2.9.8 && docker-php-ext-enable xdebug; \
+else \
+    pecl install xdebug && docker-php-ext-enable xdebug; \
+fi;
+
+RUN curl -sS https://getcomposer.org/installer | php \
+    && mv composer.phar /usr/local/bin/composer
+
+WORKDIR /package
+
+COPY composer.json ./
+
+ARG SYMFONY_PROCESS=5
+RUN composer require symfony/process ^$SYMFONY_PROCESS.0
+
+RUN composer install
+
+COPY . .
+
+RUN composer test

Dockerfile

@@ -1,6 +1,6 @@
 # PHP ChromePDF Renderer
 ![Unit tests](https://github.com/SynergiTech/chrome-pdf-php/workflows/Unit%20tests/badge.svg)
-[![Build Status](https://travis-ci.org/SynergiTech/chrome-pdf-php.svg?branch=master)](https://travis-ci.org/SynergiTech/chrome-pdf-php)
+[![Tests](https://github.com/SynergiTech/chrome-pdf-php/actions/workflows/main.yml/badge.svg)](https://github.com/SynergiTech/chrome-pdf-php/actions/workflows/main.yml)
 
 _For pre-V1 documentation [click here](https://github.com/SynergiTech/chrome-pdf-php/blob/v0/README.md)_
 

README.md

@@ -10,8 +10,8 @@
         }
     ],
     "require": {
-        "php": ">=7.1",
-        "symfony/process": "~3.4 || ~4.0",
+        "php": "^7.3|^8.0",
+        "symfony/process": "~3.4 || ~4.0 || ~5.0",
         "guzzlehttp/guzzle": "^6.3"
     },
     "autoload": {
@@ -22,6 +22,14 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^7.5 || ^8.4",
-        "friendsofphp/php-cs-fixer": "^2.15"
+        "friendsofphp/php-cs-fixer": "^2.15",
+        "phpstan/phpstan": "^0.12.83"
+    },
+    "scripts": {
+        "test": [
+            "Composer\\Config::disableProcessTimeout",
+            "phpunit",
+            "phpstan analyse"
+        ]
     }
 }

composer.json

@@ -0,0 +1,6 @@
+parameters:
+    paths:
+        - src
+    level: 8
+    ignoreErrors:
+        - '#Call to an undefined method object::mustRun\(\).#'

phpstan.neon

@@ -462,23 +462,23 @@ public function getLandscape(): ?bool
      * Renders a string of HTML to a PDF
      *
      * @param  string $content Content to render
-     * @return resource
+     * @return resource|null
      */
     abstract public function renderContent(string $content);
 
     /**
     * Renders a URL to a PDF
     *
-    * @param  string $content URL to render
-    * @return resource
+    * @param  string $url URL to render
+    * @return resource|null
     */
     abstract public function renderURL(string $url);
 
     /**
      * Renders a local file to a PDF
      *
-     * @param  string $content Local file to render
-     * @return resource
+     * @param  string $path Local file to render
+     * @return resource|null
      */
     abstract public function renderFile(string $path);
 }

src/AbstractPDF.php

@@ -22,7 +22,7 @@ class Browserless extends AbstractPDF
     */
     private $pdfEndpoint = '/pdf';
     /**
-     * @var object
+     * @var \GuzzleHttp\Client
      */
     private $client;
     /**
@@ -40,7 +40,7 @@ class Browserless extends AbstractPDF
 
     /**
      * @param string $apiKey api key from browserless.io
-     * @param object $client custom Guzzle client
+     * @param \GuzzleHttp\Client $client custom Guzzle client
      */
     public function __construct(string $apiKey = null, $client = null)
     {
@@ -149,7 +149,7 @@ public function getRotation(): ?int
     /**
      * Gets the payload of JSON options to be sent to browserless, minus the `url` or `html` property
      *
-     * @return array
+     * @return array<string, mixed>
      */
     public function getFormattedOptions(): array
     {
@@ -227,7 +227,7 @@ public function getFormattedOptions(): array
     }
 
     /**
-     * @param  array  $options
+     * @param  array<string, mixed>  $options
      * @return resource
      */
     private function render(array $options)
@@ -240,9 +240,10 @@ private function render(array $options)
                 'json' => $options,
             ]);
         } catch (\GuzzleHttp\Exception\ClientException $e) {
-            $body = $e->getResponse()->getBody();
-            $json = json_decode($body);
-            $message = $e->getResponse()->getBody();
+            $response = $e->getResponse();
+            $body = $response ? $response->getBody() : '';
+            $json = $response ? json_decode($body) : '';
+            $message = $body;
             if (json_last_error() === JSON_ERROR_NONE) {
                 $messages = [];
                 foreach ($json as $error) {

src/Browserless.php

@@ -16,7 +16,7 @@ class Chrome extends AbstractPDF
      * an array of temporary file handles
      * they are unlinked after rendering
      *
-     * @var array
+     * @var array<string>
      */
     private $handles = [];
 
@@ -43,7 +43,7 @@ public function __construct($binary = 'chrome-pdf', $processClass = null)
     /**
      * A factory for creating process classes, to execute the binary
      *
-     * @param  string $cmdline The command to run
+     * @param  array<string> $cmdline The command to run
      * @return object
      */
     public function createProcess($cmdline)
@@ -100,7 +100,7 @@ public function getMarginString(): ?string
     /**
      * Gets an array of options to pass to the command line
      *
-     * @return array
+     * @return array<mixed>
      */
     private function getCommandFlags(): array
     {
@@ -139,12 +139,12 @@ private function getCommandFlags(): array
             $opts[] = "--no-displayHeaderFooter";
         }
         if ($this->getHeader()) {
-            $headerFile = $this->getFileForString($this->getHeader());
+            $headerFile = $this->getFileForString($this->getHeader() ?: '');
             $opts[] = "--headerTemplate";
             $opts[] = $headerFile;
         }
         if ($this->getFooter()) {
-            $footerFile = $this->getFileForString($this->getFooter());
+            $footerFile = $this->getFileForString($this->getFooter() ?: '');
             $opts[] = "--footerTemplate";
             $opts[] = $footerFile;
         }
@@ -188,7 +188,7 @@ private function getCommandFlags(): array
      */
     private function getFileForString(string $content): string
     {
-        $tmpfile = tempnam(sys_get_temp_dir(), 'chromepdf');
+        $tmpfile = tempnam(sys_get_temp_dir(), 'chromepdf') ?: '';
         // Chrome must see the correct extension to load it as html
         rename($tmpfile, $tmpfile .= '.html');
         $this->handles[] = $tmpfile;
@@ -200,12 +200,12 @@ private function getFileForString(string $content): string
     /**
      * Execute the local renderer with the given options
      *
-     * @param  array $options
+     * @param  array<string> $options
      * @return string A path to a temporary file containing the rendered PDF
      */
     private function executeBinary(array $options): string
     {
-        $output = tempnam(sys_get_temp_dir(), 'chromepdf');
+        $output = tempnam(sys_get_temp_dir(), 'chromepdf') ?: '';
         $options[] = "--path";
         $options[] = $output;
         array_unshift($options, $this->binary, 'pdf');
@@ -229,7 +229,7 @@ public function renderContent(string $content)
         $opts[] = $file;
 
         $outputFile = $this->executeBinary($opts);
-        return fopen($outputFile, 'r');
+        return fopen($outputFile, 'r') ?: null;
     }
 
     /**
@@ -242,7 +242,7 @@ public function renderURL(string $url)
         $opts[] = $url;
 
         $outputFile = $this->executeBinary($opts);
-        return fopen($outputFile, 'r');
+        return fopen($outputFile, 'r') ?: null;
     }
 
     /**
@@ -255,6 +255,6 @@ public function renderFile(string $path)
         $opts[] = $path;
 
         $outputFile = $this->executeBinary($opts);
-        return fopen($outputFile, 'r');
+        return fopen($outputFile, 'r') ?: null;
     }
 }

src/Chrome.php

@@ -12,6 +12,7 @@
 
 use SynergiTech\ChromePDF\Browserless;
 use SynergiTech\ChromePDF\Browserless\APIException;
+use SynergiTech\ChromePDF\Chrome;
 use SynergiTech\ChromePDF\Test\TestCase;
 
 use PHPUnit\Framework\Constraint\ArraySubset;