Merge pull request #212 from PHPJasper/develop

update docs, minor corrections

Author: geekcom

README.md

@@ -94,10 +94,10 @@ With Docker CE and docker-compose installed just run:
 
 To execute tests:
 
-* `docker exec -it phpjasper ./vendor/bin/phpunit` or
-* `docker exec -it phpjasper ./vendor/bin/phpunit --testdox`
+* `docker exec -it phpjasper sudo composer test` or
+* `docker exec -it phpjasper sudo composer testdox`
 
-To see coverage of tests execute the file: `tests/logs/coverage/index.html`
+To see coverage manually of tests, execute the file: `tests/log/report/index.html`
 
 _Help us writing new tests, make a fork_ :)
 

composer.json

@@ -36,14 +36,14 @@
   },
   "scripts": {
     "phpcs": "phpcs --standard=PSR12 -n src",
+    "phpstan": "phpstan analyse src --level 0",
     "phpcbf": "phpcbf --standard=PSR12 -n src",
     "unit": "phpunit --coverage-clover ./tests/log/clover.xml --colors=always",
-    "unit-html": "php -d phar.readonly=0 vendor/bin/phpunit --coverage-html ./tests/log/ --colors=always",
-    "phpstan": "phpstan analyse src --level 0",
+    "testdox": "phpunit --testdox",
     "test": [
       "@phpcs",
-      "@unit",
-      "@phpstan"
+      "@phpstan",
+      "@unit"
     ]
   }
 }

docs/pt_BR/LEIA-ME_pt_BR.md

@@ -91,10 +91,10 @@ Com o Docker CE e o docker-compose instalados basta executar os comandos:
 
 Para rodar os testes dentro do container execute:
 
-* `docker exec -it phpjasper ./vendor/bin/phpunit` ou
-* `docker exec -it phpjasper ./vendor/bin/phpunit --testdox`
+* `docker exec -it phpjasper sudo composer test` ou
+* `docker exec -it phpjasper sudo composer testdox`
 
-Para ver o coverage basta executar o arquivo: `tests/logs/coverage/index.html`
+Para ver o coverage basta executar o arquivo: `tests/log/report/index.html`
 
 _Ajude-nos escrevendo novos testes, faça um fork_ :)
 

src/PHPJasper.php

@@ -15,6 +15,18 @@
 
 use PHPJasper\Exception;
 
+use function strtoupper;
+use function substr;
+use function is_file;
+use function realpath;
+use function join;
+use function array_merge;
+use function is_array;
+use function in_array;
+use function chdir;
+use function exec;
+use function is_dir;
+
 class PHPJasper
 {
 
@@ -127,6 +139,7 @@ public function process(string $input, string $output, array $options = [])
         $this->command .= ' -o ' . "\"$output\"";
 
         $this->command .= ' -f ' . join(' ', $options['format']);
+
         if ($options['params']) {
             $this->command .= ' -P ';
             foreach ($options['params'] as $key => $value) {
@@ -189,6 +202,7 @@ protected function validateFormat($format)
         if (!is_array($format)) {
             $format = [$format];
         }
+
         foreach ($format as $value) {
             if (!in_array($value, $this->formats)) {
                 throw new Exception\InvalidFormat();
@@ -231,6 +245,7 @@ public function execute($user = false)
 
         chdir($this->pathExecutable);
         exec($this->command, $output, $returnVar);
+
         if ($returnVar !== 0) {
             throw new Exception\ErrorCommandExecutable();
         }
@@ -275,6 +290,7 @@ protected function validateExecute()
         if (!$this->command) {
             throw new Exception\InvalidCommandExecutable();
         }
+
         if (!is_dir($this->pathExecutable)) {
             throw new Exception\InvalidResourceDirectory();
         }

tests/PHPJasperTest.php

@@ -20,6 +20,7 @@
 
 /**
  * @author Rafael Queiroz <rafaelfqf@gmail.com>
+ * @author Daniel Rodrigues <geekcom@php.net>
  */
 final class PHPJasperTest extends TestCase
 {