Merge pull request #33 from JSignPdf/feat/add-php-cs

jeidison · web-flow · commit 1448e1ace564 · 2025-08-11T22:03:12.000-03:00
feat: add php cs
diff --git a/.github/workflows/lint-php-cs.yml b/.github/workflows/lint-php-cs.yml
@@ -0,0 +1,38 @@
+name: Lint php-cs
+
+on: pull_request
+
+permissions:
+  contents: read
+
+concurrency:
+  group: lint-php-cs-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    name: php-cs
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
+
+      - name: Set up php8.1
+        uses: shivammathur/setup-php@0f7f1d08e3e32076e51cae65eb0b0c871405b16e # v2.34.1
+        with:
+          php-version: 8.1
+          extensions: json, openssl
+          coverage: none
+          ini-file: development
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install dependencies
+        run: composer i
+
+      - name: Lint
+        run: composer run cs:check || ( echo 'Please run `composer run cs:fix` to format your code' && exit 1 )
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 .idea
 .vscode
 .phpunit.result.cache
+.php-cs-fixer.cache
 vendor
 /vendor-bin/**/vendor/
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+require_once './vendor-bin/coding-standard/vendor/autoload.php';
+
+use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;
+
+$config = new PhpCsFixer\Config();
+$config
+	->setParallelConfig(ParallelConfigFactory::detect())
+	->getFinder()
+	->ignoreVCSIgnored(true)
+	->notPath('vendor')
+	->notPath('vendor-bin')
+	->in(__DIR__);
+return $config;
diff --git a/composer.json b/composer.json
@@ -37,6 +37,8 @@
     }
   },
   "scripts": {
+		"cs:check": "php-cs-fixer fix --dry-run --diff",
+		"cs:fix": "php-cs-fixer fix",
     "test:unit": "vendor/bin/phpunit --no-coverage --colors=always --fail-on-warning --fail-on-risky --display-deprecations --display-phpunit-deprecations",
     "test:coverage": "XDEBUG_MODE=coverage vendor/bin/phpunit",
 		"psalm": "psalm --no-cache --threads=$(nproc)",
diff --git a/src/JSignFileService.php b/src/JSignFileService.php
@@ -7,7 +7,6 @@
  */
 class JSignFileService
 {
-
     public static function instance(): self
     {
         return new self();
@@ -31,8 +30,9 @@ public function storeFile(string $path, string $name, string $content): string
 
     public function deleteFile(string $path): void
     {
-        if (is_file($path))
+        if (is_file($path)) {
             unlink($path);
+        }
     }
 
     public function deleteTempFiles(string $pathTemp, string $name): void
@@ -41,8 +41,9 @@ public function deleteTempFiles(string $pathTemp, string $name): void
         $pathPdfFile       = "$pathTemp$name.pdf";
         $pathPdfSignedFile = "{$pathTemp}{$name}_signed.pdf";
         $tempFiles         = [$pathPfxFile, $pathPdfFile, $pathPdfSignedFile];
-        foreach ($tempFiles as $path)
+        foreach ($tempFiles as $path) {
             $this->deleteFile($path);
+        }
     }
 
 }
diff --git a/src/Runtime/JavaRuntimeService.php b/src/Runtime/JavaRuntimeService.php
@@ -100,7 +100,8 @@ private function downloadAndExtract(string $url, string $baseDir): void
         chmod($baseDir . '/bin/java', 0700);
     }
 
-    private function findRootDir(PharData $phar, string $rootDir): string {
+    private function findRootDir(PharData $phar, string $rootDir): string
+    {
         $files = new \RecursiveIteratorIterator($phar, \RecursiveIteratorIterator::CHILD_FIRST);
         $rootDir = realpath($rootDir);
         if (!is_string($rootDir) || empty($rootDir)) {
diff --git a/src/Sign/JSignParam.php b/src/Sign/JSignParam.php
@@ -116,12 +116,14 @@ public function setIsUseJavaInstalled(bool $isUseJavaInstalled): self
         return $this;
     }
 
-    public function setJavaPath(string $javaPath): self {
+    public function setJavaPath(string $javaPath): self
+    {
         $this->javaPath = $javaPath;
         return $this;
     }
 
-    public function getJavaPath(): string {
+    public function getJavaPath(): string
+    {
         return $this->javaPath;
     }
 
diff --git a/src/Sign/JSignService.php b/src/Sign/JSignService.php
@@ -50,8 +50,9 @@ public function sign(JSignParam $params): string
 
             return $fileSigned;
         } catch (Throwable $e) {
-            if ($params->getTempPath())
+            if ($params->getTempPath()) {
                 $this->fileService->deleteTempFiles($params->getTempPath(), $params->getTempName());
+            }
 
             throw new Exception($e->getMessage());
         }
@@ -66,8 +67,7 @@ private function repackCertificateIfPasswordIsUnicode(
         JSignParam $params,
         \OpenSSLCertificate|string $cert,
         \OpenSSLAsymmetricKey|\OpenSSLCertificate|string $pkey,
-    ): void
-    {
+    ): void {
         $detectedEncodingString = mb_detect_encoding($params->getPassword(), 'ASCII', true);
         if ($detectedEncodingString === false) {
             $password = md5(microtime());
@@ -132,7 +132,7 @@ private function storeTempFiles(JSignParam $params): array
 
     private function commandSign(JSignParam $params): string
     {
-        list ($pdf, $certificate) = $this->storeTempFiles($params);
+        list($pdf, $certificate) = $this->storeTempFiles($params);
         $java     = $this->javaCommand($params);
         $jSignPdf = $this->getjSignPdfJarPath($params);
 
@@ -154,8 +154,9 @@ private function getjSignPdfJarPath(JSignParam $params): string
 
     private function throwIf(bool $condition, string $message): void
     {
-        if ($condition)
+        if ($condition) {
             throw new Exception($message);
+        }
     }
 
     private function isPasswordCertificateValid(JSignParam $params): bool
@@ -221,14 +222,14 @@ private function safeExec(
         string $tempEncriptedOriginal,
         string $tempDecrypted,
         string $tempEncriptedRepacked,
-    ): void
-    {
+    ): void {
         $tempPassword = escapeshellarg($tempPassword);
         $tempEncriptedOriginal = escapeshellarg($tempEncriptedOriginal);
         $tempDecrypted = escapeshellarg($tempDecrypted);
         $tempEncriptedRepacked = escapeshellarg($tempEncriptedRepacked);
 
-        exec(<<<REPACK_COMMAND
+        exec(
+            <<<REPACK_COMMAND
             cat $tempPassword | openssl pkcs12 -legacy -in $tempEncriptedOriginal -nodes -out $tempDecrypted -passin stdin &&
             cat $tempPassword | openssl pkcs12 -in $tempDecrypted -export -out $tempEncriptedRepacked -passout stdin
             REPACK_COMMAND
diff --git a/tests/Builder/JSignParamBuilder.php b/tests/Builder/JSignParamBuilder.php
@@ -32,4 +32,4 @@ public function withDefault()
         return $params;
     }
 
-}
+}
diff --git a/tests/JSignPDFTest.php b/tests/JSignPDFTest.php
@@ -2,7 +2,8 @@
 
 namespace Jeidison\JSignPDF\Sign;
 
-function exec(string $command, ?array &$output = null, ?int &$return_var = null) {
+function exec(string $command, ?array &$output = null, ?int &$return_var = null)
+{
     global $mockExec;
     if ($mockExec) {
         $output = $mockExec;
diff --git a/tests/Runtime/JavaRuntimeServiceTest.php b/tests/Runtime/JavaRuntimeServiceTest.php
@@ -14,20 +14,23 @@
 class JavaRuntimeServiceTest extends TestCase
 {
     public string $testTmpDir = '';
-    protected function setUp(): void {
+    protected function setUp(): void
+    {
         $this->testTmpDir = sys_get_temp_dir() . '/jsignpdf_temp_dir_' . uniqid();
         mkdir(directory: $this->testTmpDir, recursive: true);
     }
 
-    public function testGetPathWhenJavaIsInstalled(): void {
+    public function testGetPathWhenJavaIsInstalled(): void
+    {
         $jsignParam = new JSignParam();
         $service = new JavaRuntimeService();
         $jsignParam->setIsUseJavaInstalled(true);
         $path = $service->getPath($jsignParam);
         $this->assertEquals('java', $path);
     }
 
-    public function testGetPathWithCustomAndValidJavaPath(): void {
+    public function testGetPathWithCustomAndValidJavaPath(): void
+    {
         $jsignParam = new JSignParam();
         $service = new JavaRuntimeService();
         vfsStream::setup('download');
@@ -40,7 +43,8 @@ public function testGetPathWithCustomAndValidJavaPath(): void {
         $this->assertEquals('vfs://download/bin/java', $path);
     }
 
-    public function testGetPathWithCustomAndInvalidJavaPath(): void {
+    public function testGetPathWithCustomAndInvalidJavaPath(): void
+    {
         $jsignParam = new JSignParam();
         $service = new JavaRuntimeService();
         $jsignParam->setJavaPath(__FILE__);
@@ -50,7 +54,8 @@ public function testGetPathWithCustomAndInvalidJavaPath(): void {
         $service->getPath($jsignParam);
     }
 
-    public function testGetPathWithDownloadUrlAndNotRealDirectory(): void {
+    public function testGetPathWithDownloadUrlAndNotRealDirectory(): void
+    {
         $jsignParam = new JSignParam();
         $service = new JavaRuntimeService();
         $root = vfsStream::setup('download');
@@ -65,7 +70,8 @@ public function testGetPathWithDownloadUrlAndNotRealDirectory(): void {
         $service->getPath($jsignParam);
     }
 
-    public function testGetPathWithDownloadUrlWithInvalidUrl(): void {
+    public function testGetPathWithDownloadUrlWithInvalidUrl(): void
+    {
         vfsStream::setup('download');
         mkdir('vfs://download/bin');
         touch('vfs://download/bin/java');
@@ -79,7 +85,8 @@ public function testGetPathWithDownloadUrlWithInvalidUrl(): void {
         $service->getPath($jsignParam);
     }
 
-    public function testGetPathWithDownloadUrlWith4xxError(): void {
+    public function testGetPathWithDownloadUrlWith4xxError(): void
+    {
         vfsStream::setup('download');
         mkdir('vfs://download/bin');
         touch('vfs://download/bin/java');
@@ -93,7 +100,8 @@ public function testGetPathWithDownloadUrlWith4xxError(): void {
         $service->getPath($jsignParam);
     }
 
-    public function testGetPathWithDownloadUrlWithInvalidGzipedFile(): void {
+    public function testGetPathWithDownloadUrlWithInvalidGzipedFile(): void
+    {
         vfsStream::setup('download');
         mkdir('vfs://download/bin');
         touch('vfs://download/bin/java');
@@ -119,7 +127,8 @@ public function testGetPathWithDownloadUrlWithInvalidGzipedFile(): void {
         $service->getPath($jsignParam);
     }
 
-    public function testGetPathWithDownloadUrlWithInvalidJavaPackage(): void {
+    public function testGetPathWithDownloadUrlWithInvalidJavaPackage(): void
+    {
         mkdir($this->testTmpDir . '/bin', 0755, true);
 
         $jsignParam = new JSignParam();
@@ -146,7 +155,8 @@ public function testGetPathWithDownloadUrlWithInvalidJavaPackage(): void {
         $service->getPath($jsignParam);
     }
 
-    public function testGetPathWithDownloadUrlWithInvalidVersion(): void {
+    public function testGetPathWithDownloadUrlWithInvalidVersion(): void
+    {
         $jsignParam = new JSignParam();
         $service = new JavaRuntimeService();
 
@@ -166,7 +176,8 @@ public function testGetPathWithDownloadUrlWithInvalidVersion(): void {
         $service->getPath($jsignParam);
     }
 
-    public function testGetPathWithDownloadUrlWithValidVersion(): void {
+    public function testGetPathWithDownloadUrlWithValidVersion(): void
+    {
         $jsignParam = new JSignParam();
         $service = new JavaRuntimeService();
 
@@ -183,7 +194,8 @@ public function testGetPathWithDownloadUrlWithValidVersion(): void {
         $this->assertEquals($jsignParam->getJavaPath(), $javaPath);
     }
 
-    public function testGetPathWithoutJavaFallback(): void {
+    public function testGetPathWithoutJavaFallback(): void
+    {
         mkdir($this->testTmpDir . '/bin', 0755, true);
 
         $jsignParam = new JSignParam();
diff --git a/vendor-bin/coding-standard/composer.json b/vendor-bin/coding-standard/composer.json
@@ -0,0 +1,10 @@
+{
+    "require-dev": {
+        "friendsofphp/php-cs-fixer": "^3.59"
+    },
+    "config": {
+        "platform": {
+            "php": "8.1"
+        }
+    }
+}
diff --git a/vendor-bin/coding-standard/composer.lock b/vendor-bin/coding-standard/composer.lock

Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,8 @@`
`37`	`37`	`}`
`38`	`38`	`},`
`39`	`39`	`"scripts": {`
	`40`	`+ "cs:check": "php-cs-fixer fix --dry-run --diff",`
	`41`	`+ "cs:fix": "php-cs-fixer fix",`
`40`	`42`	`"test:unit": "vendor/bin/phpunit --no-coverage --colors=always --fail-on-warning --fail-on-risky --display-deprecations --display-phpunit-deprecations",`
`41`	`43`	`"test:coverage": "XDEBUG_MODE=coverage vendor/bin/phpunit",`
`42`	`44`	`"psalm": "psalm --no-cache --threads=$(nproc)",`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,6 @@`
`7`	`7`	`*/`
`8`	`8`	`class JSignFileService`
`9`	`9`	`{`
`10`		`-`
`11`	`10`	`public static function instance(): self`
`12`	`11`	`{`
`13`	`12`	`return new self();`
`@@ -31,8 +30,9 @@ public function storeFile(string $path, string $name, string $content): string`
`31`	`30`
`32`	`31`	`public function deleteFile(string $path): void`
`33`	`32`	`{`
`34`		`- if (is_file($path))`
	`33`	`+ if (is_file($path)) {`
`35`	`34`	`unlink($path);`
	`35`	`+ }`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`public function deleteTempFiles(string $pathTemp, string $name): void`
`@@ -41,8 +41,9 @@ public function deleteTempFiles(string $pathTemp, string $name): void`
`41`	`41`	`$pathPdfFile = "$pathTemp$name.pdf";`
`42`	`42`	`$pathPdfSignedFile = "{$pathTemp}{$name}_signed.pdf";`
`43`	`43`	`$tempFiles = [$pathPfxFile, $pathPdfFile, $pathPdfSignedFile];`
`44`		`- foreach ($tempFiles as $path)`
	`44`	`+ foreach ($tempFiles as $path) {`
`45`	`45`	`$this->deleteFile($path);`
	`46`	`+ }`
`46`	`47`	`}`
`47`	`48`
`48`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,8 @@ private function downloadAndExtract(string $url, string $baseDir): void`
`100`	`100`	`chmod($baseDir . '/bin/java', 0700);`
`101`	`101`	`}`
`102`	`102`
`103`		`- private function findRootDir(PharData $phar, string $rootDir): string {`
	`103`	`+ private function findRootDir(PharData $phar, string $rootDir): string`
	`104`	`+ {`
`104`	`105`	`$files = new \RecursiveIteratorIterator($phar, \RecursiveIteratorIterator::CHILD_FIRST);`
`105`	`106`	`$rootDir = realpath($rootDir);`
`106`	`107`	`if (!is_string($rootDir) \|\| empty($rootDir)) {`
Original file line number	Diff line number	Diff line change
`@@ -116,12 +116,14 @@ public function setIsUseJavaInstalled(bool $isUseJavaInstalled): self`
`116`	`116`	`return $this;`
`117`	`117`	`}`
`118`	`118`
`119`		`- public function setJavaPath(string $javaPath): self {`
	`119`	`+ public function setJavaPath(string $javaPath): self`
	`120`	`+ {`
`120`	`121`	`$this->javaPath = $javaPath;`
`121`	`122`	`return $this;`
`122`	`123`	`}`
`123`	`124`
`124`		`- public function getJavaPath(): string {`
	`125`	`+ public function getJavaPath(): string`
	`126`	`+ {`
`125`	`127`	`return $this->javaPath;`
`126`	`128`	`}`
`127`	`129`
Original file line number	Diff line number	Diff line change
`@@ -32,4 +32,4 @@ public function withDefault()`
`32`	`32`	`return $params;`
`33`	`33`	`}`
`34`	`34`
`35`		`-}`
	`35`	`+}`