Merge pull request #59 from eclipxe13/maintenance

eclipxe13 · web-flow · commit 0da4ddd33918 · 2023-06-07T13:24:28.000-06:00
Compatibilidad PHP 8.2 y mantenimiento (versión  0.5.3)
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -21,7 +21,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.1'
+          php-version: '8.2'
           coverage: none
           tools: cs2pr, phpcs
         env:
@@ -38,7 +38,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.1'
+          php-version: '8.2'
           coverage: none
           tools: cs2pr, php-cs-fixer
         env:
@@ -55,14 +55,14 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.1'
+          php-version: '8.2'
           coverage: none
           tools: composer:v2, phpstan
         env:
           fail-fast: true
       - name: Get composer cache directory
         id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
       - name: Cache dependencies
         uses: actions/cache@v3
         with:
@@ -79,7 +79,7 @@ jobs:
     runs-on: "ubuntu-latest"
     strategy:
       matrix:
-        php-versions: ['7.3', '7.4', '8.0', '8.1']
+        php-versions: ['7.3', '7.4', '8.0', '8.1', '8.2']
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -93,7 +93,7 @@ jobs:
           fail-fast: true
       - name: Get composer cache directory
         id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
       - name: Cache dependencies
         uses: actions/cache@v3
         with:
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -10,22 +10,22 @@ on:
 jobs:
 
   tests-coverage:
-    name: Tests on PHP 8.1 (code coverage)
+    name: Tests on PHP 8.2 (code coverage)
     runs-on: "ubuntu-latest"
     steps:
       - name: Checkout
         uses: actions/checkout@v3
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.1'
+          php-version: '8.2'
           coverage: xdebug
           tools: composer:v2
         env:
           fail-fast: true
       - name: Get composer cache directory
         id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
       - name: Cache dependencies
         uses: actions/cache@v3
         with:
@@ -54,15 +54,15 @@ jobs:
         id: check-secrets
         run: |
           if [ -n "${{ secrets.GITHUB_TOKEN }}" ]; then
-            echo "::set-output name=github::yes"
+            echo "github=yes" >> $GITHUB_OUTPUT
           else
-            echo "::set-output name=github::no"
+            echo "github=no" >> $GITHUB_OUTPUT
             echo "::warning ::GITHUB_TOKEN non set"
           fi
           if [ -n "${{ secrets.SONAR_TOKEN }}" ]; then
-            echo "::set-output name=sonar::yes"
+            echo "sonar=yes" >> $GITHUB_OUTPUT
           else
-            echo "::set-output name=sonar::no"
+            echo "sonar=no" >> $GITHUB_OUTPUT
             echo "::warning ::SONAR_TOKEN non set"
           fi
 
@@ -79,12 +79,12 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.0'
+          php-version: '8.2'
           coverage: none
           tools: composer:v2
       - name: Get composer cache directory
         id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
       - name: Cache dependencies
         uses: actions/cache@v3
         with:
diff --git a/.phive/phars.xml b/.phive/phars.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-  <phar name="php-cs-fixer" version="^3.11.0" installed="3.11.0" location="./tools/php-cs-fixer" copy="false"/>
-  <phar name="phpcs" version="^3.7.1" installed="3.7.1" location="./tools/phpcs" copy="false"/>
-  <phar name="phpcbf" version="^3.7.1" installed="3.7.1" location="./tools/phpcbf" copy="false"/>
-  <phar name="phpstan" version="^1.8.6" installed="1.8.6" location="./tools/phpstan" copy="false"/>
+  <phar name="php-cs-fixer" version="^3.17.0" installed="3.17.0" location="./tools/php-cs-fixer" copy="false"/>
+  <phar name="phpcs" version="^3.7.2" installed="3.7.2" location="./tools/phpcs" copy="false"/>
+  <phar name="phpcbf" version="^3.7.2" installed="3.7.2" location="./tools/phpcbf" copy="false"/>
+  <phar name="phpstan" version="^1.10.17" installed="1.10.17" location="./tools/phpstan" copy="false"/>
 </phive>
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,6 +1,6 @@
 # Contribuciones
 
-Las contribuciones son bienvenidas. Aceptamos *Pull Requests* en el [repositorio GitHub][homepage].
+Las contribuciones son bienvenidas. Aceptamos *Pull Requests* en el [repositorio GitHub][project].
 
 Este proyecto se apega al siguiente [Código de Conducta][coc].
 Al participar en este proyecto y en su comunidad, deberás seguir este código.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 - 2022 PhpCfdi https://www.phpcfdi.com/
+Copyright (c) 2019 - 2023 PhpCfdi https://www.phpcfdi.com/
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -59,7 +59,7 @@ if (! $fiel->isValid()) {
 }
 
 // creación del web client basado en Guzzle que implementa WebClientInterface
-// para usarlo necesitas instalar guzzlehttp/guzzle pues no es una dependencia directa
+// para usarlo necesitas instalar guzzlehttp/guzzle, pues no es una dependencia directa
 $webClient = new GuzzleWebClient();
 
 // creación del objeto encargado de crear las solicitudes firmadas usando una FIEL
@@ -610,7 +610,7 @@ and licensed for use under the MIT License (MIT). Please see [LICENSE][] for mor
 [badge-php-version]: https://img.shields.io/packagist/php-v/phpcfdi/sat-ws-descarga-masiva?logo=php
 [badge-release]: https://img.shields.io/github/release/phpcfdi/sat-ws-descarga-masiva?logo=git
 [badge-license]: https://img.shields.io/github/license/phpcfdi/sat-ws-descarga-masiva?logo=open-source-initiative
-[badge-build]: https://img.shields.io/github/workflow/status/phpcfdi/sat-ws-descarga-masiva/build/main?logo=github-actions
+[badge-build]: https://img.shields.io/github/actions/workflow/status/phpcfdi/sat-ws-descarga-masiva/build.yml?branch=main&logo=github-actions
 [badge-reliability]: https://sonarcloud.io/api/project_badges/measure?project=phpcfdi_sat-ws-descarga-masiva&metric=reliability_rating
 [badge-maintainability]: https://sonarcloud.io/api/project_badges/measure?project=phpcfdi_sat-ws-descarga-masiva&metric=sqale_rating
 [badge-coverage]: https://img.shields.io/sonar/coverage/phpcfdi_sat-ws-descarga-masiva/main?logo=sonarcloud&server=https%3A%2F%2Fsonarcloud.io
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -14,6 +14,21 @@ que nombraremos así: ` Breaking . Feature . Fix `, donde:
 **Importante:** Las reglas de SEMVER no aplican si estás usando una rama (por ejemplo `main-dev`)
 o estás usando una versión cero (por ejemplo `0.18.4`).
 
+## Versión 0.5.3 2023-06-07
+
+- Se verifica la compatibilidad con PHP 8.2.
+- Se eliminan las llaves en la interpolación de variables (deprecado en PHP 8.2).
+- Se actualiza el año de la licencia.
+- Se modifican las pruebas para futura compatibilidad con PHPUnit 10.
+- Se corrige la exclusión de archivos en `sonar-project.properties`.
+- Se corrige el archivo `CONTRIBUTING.md` usando el ancla correcta del proyecto.
+- Se corrige la insignia de construcción `badge-build`.
+- En los flujos de trabajo
+  - Se agrega PHP 8.2 a la matriz de pruebas.
+  - Se ejecutan los trabajos en PHP 8.2.
+  - Se sustituye la directiva de GitHub `::set-output` por `$GITHUB_OUTPUT`.
+- Se actualizan las herramientas de desarrollo.
+
 ## Versión 0.5.2 2022-09-30
 
 #### Consulta por UUID
diff --git a/sonar-project.properties b/sonar-project.properties
@@ -4,7 +4,7 @@ sonar.sourceEncoding=UTF-8
 sonar.language=php
 sonar.sources=src
 sonar.tests=tests
-sonar.exclusions=vendor/,tools/,build/,tests/_files/
+sonar.test.exclusions=tests/_files/**/*
 sonar.working.directory=build/.scannerwork
 sonar.php.tests.reportPath=build/sonar-junit.xml
 sonar.php.coverage.reportPaths=build/sonar-coverage.xml
diff --git a/src/PackageReader/Internal/MetadataContent.php b/src/PackageReader/Internal/MetadataContent.php
@@ -6,7 +6,6 @@
 
 use Generator;
 use PhpCfdi\SatWsDescargaMasiva\PackageReader\MetadataItem;
-use SplTempFileObject;
 
 /**
  * Helper to iterate inside a Metadata CSV file
@@ -23,7 +22,7 @@ final class MetadataContent
 
     /**
      * The $iterator will be used in a foreach loop to create MetadataItems
-     * The first iteration must contain an array of header names that will be renames to lower case first letter
+     * The first iteration must contain an array of header names that will be renamed to lower case first letter
      * The next iterations must contain an array with data
      *
      * @param CsvReader $csvReader
@@ -36,7 +35,7 @@ public function __construct(CsvReader $csvReader, ThirdPartiesRecords $thirdPart
     }
 
     /**
-     * This method fix the content and create a SplTempFileObject to store the information
+     * This method apply the preprocessor fixes on the contents
      *
      * @param string $contents
      * @param ThirdPartiesRecords|null $thirdParties
diff --git a/src/RequestBuilder/FielRequestBuilder/FielRequestBuilder.php b/src/RequestBuilder/FielRequestBuilder/FielRequestBuilder.php
@@ -37,7 +37,7 @@ public function authorization(DateTime $created, DateTime $expires, string $secu
         $keyInfoData = <<<EOT
             <KeyInfo>
                 <o:SecurityTokenReference>
-                    <o:Reference URI="#${uuid}" ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3"/>
+                    <o:Reference URI="#$uuid" ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3"/>
                 </o:SecurityTokenReference>
             </KeyInfo>
             EOT;
@@ -57,10 +57,10 @@ public function authorization(DateTime $created, DateTime $expires, string $secu
                             <u:Created>{$created->formatSat()}</u:Created>
                             <u:Expires>{$expires->formatSat()}</u:Expires>
                         </u:Timestamp>
-                        <o:BinarySecurityToken u:Id="${uuid}" ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3" EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary">
-                            ${certificate}
+                        <o:BinarySecurityToken u:Id="$uuid" ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3" EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary">
+                            $certificate
                         </o:BinarySecurityToken>
-                        ${signatureData}
+                        $signatureData
                     </o:Security>
                 </s:Header>
                 <s:Body>
@@ -119,7 +119,7 @@ function (RfcMatch $rfcMatch): string {
                     },
                     iterator_to_array($rfcReceivers)
                 ));
-                $xmlRfcReceived = "<des:RfcReceptores>{$xmlRfcReceived}</des:RfcReceptores>";
+                $xmlRfcReceived = "<des:RfcReceptores>$xmlRfcReceived</des:RfcReceptores>";
             }
         }
 
@@ -141,8 +141,8 @@ function (string $name, string $value): string {
 
         $toDigestXml = <<<EOT
             <des:SolicitaDescarga xmlns:des="http://DescargaMasivaTerceros.sat.gob.mx">
-                <des:solicitud ${solicitudAttributesAsText}>
-                    ${xmlRfcReceived}
+                <des:solicitud $solicitudAttributesAsText>
+                    $xmlRfcReceived
                 </des:solicitud>
             </des:SolicitaDescarga>
             EOT;
@@ -153,9 +153,9 @@ function (string $name, string $value): string {
                 <s:Header/>
                 <s:Body>
                     <des:SolicitaDescarga>
-                        <des:solicitud ${solicitudAttributesAsText}>
-                            ${xmlRfcReceived}
-                            ${signatureData}
+                        <des:solicitud $solicitudAttributesAsText>
+                            $xmlRfcReceived
+                            $signatureData
                         </des:solicitud>
                     </des:SolicitaDescarga>
                 </s:Body>
@@ -172,7 +172,7 @@ public function verify(string $requestId): string
 
         $toDigestXml = <<<EOT
             <des:VerificaSolicitudDescarga xmlns:des="http://DescargaMasivaTerceros.sat.gob.mx">
-                <des:solicitud IdSolicitud="${xmlRequestId}" RfcSolicitante="${xmlRfc}"></des:solicitud>
+                <des:solicitud IdSolicitud="$xmlRequestId" RfcSolicitante="$xmlRfc"></des:solicitud>
             </des:VerificaSolicitudDescarga>
             EOT;
         $signatureData = $this->createSignature($toDigestXml);
@@ -182,8 +182,8 @@ public function verify(string $requestId): string
                 <s:Header/>
                 <s:Body>
                     <des:VerificaSolicitudDescarga>
-                        <des:solicitud IdSolicitud="${xmlRequestId}" RfcSolicitante="${xmlRfc}">
-                            ${signatureData}
+                        <des:solicitud IdSolicitud="$xmlRequestId" RfcSolicitante="$xmlRfc">
+                            $signatureData
                         </des:solicitud>
                     </des:VerificaSolicitudDescarga>
                 </s:Body>
@@ -200,7 +200,7 @@ public function download(string $packageId): string
 
         $toDigestXml = <<<EOT
             <des:PeticionDescargaMasivaTercerosEntrada xmlns:des="http://DescargaMasivaTerceros.sat.gob.mx">
-                <des:peticionDescarga IdPaquete="${xmlPackageId}" RfcSolicitante="${xmlRfcOwner}"></des:peticionDescarga>
+                <des:peticionDescarga IdPaquete="$xmlPackageId" RfcSolicitante="$xmlRfcOwner"></des:peticionDescarga>
             </des:PeticionDescargaMasivaTercerosEntrada>
             EOT;
         $signatureData = $this->createSignature($toDigestXml);
@@ -210,8 +210,8 @@ public function download(string $packageId): string
                 <s:Header/>
                 <s:Body>
                     <des:PeticionDescargaMasivaTercerosEntrada>
-                        <des:peticionDescarga IdPaquete="${xmlPackageId}" RfcSolicitante="${xmlRfcOwner}">
-                            ${signatureData}
+                        <des:peticionDescarga IdPaquete="$xmlPackageId" RfcSolicitante="$xmlRfcOwner">
+                            $signatureData
                         </des:peticionDescarga>
                     </des:PeticionDescargaMasivaTercerosEntrada>
                 </s:Body>
@@ -248,9 +248,9 @@ private function createSignature(string $toDigest, string $signedInfoUri = '', s
 
         return <<<EOT
             <Signature xmlns="http://www.w3.org/2000/09/xmldsig#">
-                ${signedInfo}
-                <SignatureValue>${signatureValue}</SignatureValue>
-                ${keyInfo}
+                $signedInfo
+                <SignatureValue>$signatureValue</SignatureValue>
+                $keyInfo
             </Signature>
             EOT;
     }
@@ -263,12 +263,12 @@ private function createSignedInfoCanonicalExclusive(string $digested, string $ur
             <SignedInfo xmlns="http://www.w3.org/2000/09/xmldsig#">
                 <CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"></CanonicalizationMethod>
                 <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"></SignatureMethod>
-                <Reference URI="${uri}">
+                <Reference URI="$uri">
                     <Transforms>
                         <Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"></Transform>
                     </Transforms>
                     <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"></DigestMethod>
-                    <DigestValue>${digested}</DigestValue>
+                    <DigestValue>$digested</DigestValue>
                 </Reference>
             </SignedInfo>
             EOT;
@@ -286,10 +286,10 @@ private function createKeyInfoData(): string
             <KeyInfo>
                 <X509Data>
                     <X509IssuerSerial>
-                        <X509IssuerName>${issuerName}</X509IssuerName>
-                        <X509SerialNumber>${serial}</X509SerialNumber>
+                        <X509IssuerName>$issuerName</X509IssuerName>
+                        <X509SerialNumber>$serial</X509SerialNumber>
                     </X509IssuerSerial>
-                    <X509Certificate>${certificate}</X509Certificate>
+                    <X509Certificate>$certificate</X509Certificate>
                 </X509Data>
             </KeyInfo>
             EOT;
diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -47,4 +47,41 @@ public static function xmlFormat(string $content): string
         $document->loadXML($content);
         return $document->saveXML() ?: '';
     }
+
+    /**
+     * @param mixed ...$arguments
+     * @return array{
+     *     number: int,
+     *     message: string,
+     *     file: string,
+     *     line: int,
+     *     return: mixed,
+     * }
+     */
+    public static function trapError(callable $function, ...$arguments): array
+    {
+        $capturedError = [
+            'number' => 0,
+            'message' => '',
+            'file' => '',
+            'line' => 0,
+        ];
+        set_error_handler(
+            function (int $errno, string $errstr, string $errfile = '', int $errline = 0) use (&$capturedError): bool {
+                $capturedError = [
+                    'number' => $errno,
+                    'message' => $errstr,
+                    'file' => $errfile,
+                    'line' => $errline,
+                ] + $capturedError;
+                return true;
+            }
+        );
+        try {
+            $capturedError['return'] = call_user_func($function, ...$arguments);
+        } finally {
+            restore_error_handler();
+        }
+        return $capturedError;
+    }
 }
diff --git a/tests/Unit/PackageReader/MetadataPackageReaderTest.php b/tests/Unit/PackageReader/MetadataPackageReaderTest.php
diff --git a/tests/Unit/Services/Download/DownloadResultTest.php b/tests/Unit/Services/Download/DownloadResultTest.php
