Merge pull request #65 from eclipxe13/php8.0

Version 2.15.0 (PHP 8.0 compatibility)

Author: eclipxe13

.appveyor.yml

@@ -14,11 +14,9 @@ cache:
 ## Build matrix for lowest and highest possible targets
 environment:
     matrix:
-        - php: 7.0
-        - php: 7.1
-        - php: 7.2
         - php: 7.3
         - php: 7.4
+        - php: 8.0
 
 init:
     - SET PATH=c:\tools\php;C:\tools\composer;C:\OpenSSL-v111-Win64\bin;%PATH%
@@ -77,18 +75,17 @@ install:
           # setup c:\tools\php\php.ini
           if (Test-Path c:\tools\php\php.ini-production) {
               Copy-Item -Path c:\tools\php\php.ini-production -Destination c:\tools\php\php.ini
-              [string]$php_ext_prefix=$(if ($Env:php -lt "7.2") {"php_"} else {""})
               Add-Content c:\tools\php\php.ini "`
                   `n; PHP Custom config `
                   date.timezone=UTC `
                   extension_dir=ext `
                   memory_limit=1G `
-                  extension=${php_ext_prefix}openssl `
-                  extension=${php_ext_prefix}mbstring `
-                  extension=${php_ext_prefix}fileinfo `
-                  extension=${php_ext_prefix}curl `
-                  extension=${php_ext_prefix}xsl `
-                  extension=${php_ext_prefix}soap `
+                  extension=openssl `
+                  extension=mbstring `
+                  extension=fileinfo `
+                  extension=curl `
+                  extension=xsl `
+                  extension=soap `
                   "
           }
 
@@ -115,8 +112,8 @@ install:
           }
     # install project dependences and list available tools
     - cd c:\projects\project
+    - composer remove genkgo/xsl squizlabs/php_codesniffer friendsofphp/php-cs-fixer phpstan/phpstan --dev --no-interaction --no-progress --no-update
     - appveyor-retry composer install --prefer-dist --no-progress --no-interaction --ansi
-    - dir vendor\bin
     # sat-xml resources as a dependency
     - ps: |
           appveyor-retry appveyor DownloadFile https://github.com/phpcfdi/resources-sat-xml/archive/master.zip -Filename c:\projects\project\build\sat-xml.zip
@@ -126,8 +123,4 @@ install:
 ## Run the actual test
 test_script:
     - cd c:\projects\project
-    - vendor\bin\phpcs.bat -sp src tests
-    - vendor\bin\php-cs-fixer.bat fix --dry-run --verbose
-    - if "%php%"=="7.0" vendor\bin\phpunit.bat --verbose
-    - if not "%php%"=="7.0" vendor\bin\phpunit.bat --testdox --verbose
-    - if "%php%"=="7.3" vendor\bin\phpstan.bat analyse --no-progress --level max src/ tests/
+    - vendor\bin\phpunit.bat --testdox --verbose

.travis.yml

@@ -3,7 +3,7 @@ language: php
 dist: xenial
 
 # php compatibility
-php: ["7.0", "7.1", "7.2", "7.3", "7.4"]
+php: ["7.3", "7.4", "8.0"]
 
 branches:
     except:
@@ -25,26 +25,29 @@ env:
 
 before_script:
     - phpenv config-rm xdebug.ini || true
-    - travis_retry composer install --no-interaction --prefer-dist
-    - travis_retry npm install
-    - travis_retry pip install --user mkdocs
-    - travis_retry bash tests/resource-sat-xml-download build/
-
-script:
-    - vendor/bin/phpcs -sp src/ tests/
-    - vendor/bin/php-cs-fixer fix --using-cache=no --dry-run --verbose
-    - | # create code coverage file
-        if [[ $TRAVIS_PHP_VERSION == $FULL_BUILD_PHP_VERSION ]]; then
-            php -dzend_extension=xdebug.so vendor/bin/phpunit --testdox --verbose --coverage-clover="$COVERAGE_FILE"
-        else
-            vendor/bin/phpunit --testdox --verbose
+    - travis_retry composer self-update --2 --no-interaction
+    - | # only require full development dependencies on FULL_BUILD_PHP_VERSION
+        if [[ $TRAVIS_PHP_VERSION != $FULL_BUILD_PHP_VERSION ]]; then
+            composer remove squizlabs/php_codesniffer friendsofphp/php-cs-fixer phpstan/phpstan --dev --no-interaction --no-progress --no-update
         fi
-    - | # only check phpstan on FULL_BUILD_PHP_VERSION
+    - travis_retry composer update --no-interaction --prefer-dist
+    - | # only install full development dependencies on FULL_BUILD_PHP_VERSION
         if [[ $TRAVIS_PHP_VERSION == $FULL_BUILD_PHP_VERSION ]]; then
-            vendor/bin/phpstan --no-progress analyse --level max src/ tests/
+            travis_retry npm install
+            travis_retry pip install --user mkdocs
         fi
-    - node node_modules/markdownlint-cli/markdownlint.js *.md docs/
-    - ~/.local/bin/mkdocs build --strict --site-dir build/docs
+    - travis_retry bash tests/resource-sat-xml-download build/
+
+script:
+    # only phpunit without coverage
+    - if [[ $TRAVIS_PHP_VERSION != $FULL_BUILD_PHP_VERSION ]]; then vendor/bin/phpunit --testdox --verbose; fi
+    # full build
+    - if [[ $TRAVIS_PHP_VERSION == $FULL_BUILD_PHP_VERSION ]]; then vendor/bin/phpcs -sp src/ tests/; fi
+    - if [[ $TRAVIS_PHP_VERSION == $FULL_BUILD_PHP_VERSION ]]; then vendor/bin/php-cs-fixer fix --using-cache=no --dry-run --verbose; fi
+    - if [[ $TRAVIS_PHP_VERSION == $FULL_BUILD_PHP_VERSION ]]; then php -dzend_extension=xdebug.so vendor/bin/phpunit --testdox --verbose --coverage-clover="$COVERAGE_FILE"; fi
+    - if [[ $TRAVIS_PHP_VERSION == $FULL_BUILD_PHP_VERSION ]]; then vendor/bin/phpstan --no-progress analyse src/ tests/; fi
+    - if [[ $TRAVIS_PHP_VERSION == $FULL_BUILD_PHP_VERSION ]]; then node node_modules/markdownlint-cli/markdownlint.js *.md docs/; fi
+    - if [[ $TRAVIS_PHP_VERSION == $FULL_BUILD_PHP_VERSION ]]; then ~/.local/bin/mkdocs build --strict --site-dir build/docs; fi
 
 after_script:
     - | # upload test covegare to scrutinizer

README.md

@@ -16,7 +16,7 @@
 This library provides helper objects to work with Mexican CFDI (Comprobante Fiscal Digital por Internet).
 
 :mexico: Visita la **documentación en español** de esta librería en [Read the docs][documentation].
-También te esperamos en el [canal #phpcfdi de discord](https://discord.gg/aFGYXvX).
+También te esperamos en el canal [#phpcfdi de discord](https://discord.gg/aFGYXvX).
 
 The documentation related to this library and its API is documented in [Read the docs][documentation].
 It is written in **spanish language** since is the language of the intented audience.
@@ -40,7 +40,7 @@ CFDI y herramientas del SAT. Y próximamente el lugar donde publicaremos la vers
     - Calculate `Comprobante` sums based on the list of `Conceptos`.
     - Retrieve the CFDI version information.
 - Keep a local copy of the tree of XSD and XSLT file dependences from SAT.
-- Keep a local copy of certificates to avoid download them each time.
+- Keep a local copy of certificates to avoid downloads them each time.
 - Check the SAT WebService to get the status of a CFDI (*Estado*, *EsCancelable* y *EstatusCancelacion*) without WSDL.
 
 
@@ -65,12 +65,20 @@ composer require eclipxe/cfdiutils
 
 ## PHP Support
 
-This library is compatible with PHP versions 7.0 and above.
+This library is compatible with **PHP 7.2 and above**.
 Please, try to use the full potential of the language like type declarations.
 
 The intented support is to be aligned with oldest *Active support* PHP Branch.
 See <https://www.php.net/supported-versions.php> for more details.
 
+| CfdiUtils | PHP Supported versions   | Since      |
+| --------- | ------------------------ | ---------- |
+| 1.0       | 7.0, 7.1                 | 2017-09-27 |
+| 2.0       | 7.0, 7.1                 | 2018-01-01 |
+| 2.0.1     | 7.0, 7.1, 7.2            | 2018-01-03 |
+| 2.8.1     | 7.0, 7.1, 7.2, 7.3       | 2019-03-05 |
+| 2.12.7    | 7.0, 7.1, 7.2, 7.3, 7.4  | 2019-12-04 |
+| 2.15.0    | 7.3, 7.4, 8.0            | 2021-03-17 |
 
 ## Contributing
 

composer.json

@@ -24,7 +24,7 @@
         "optimize-autoloader": true
     },
     "require": {
-        "php": ">=7.0",
+        "php": ">=7.3",
         "ext-libxml": "*",
         "ext-dom": "*",
         "ext-xsl": "*",
@@ -42,11 +42,11 @@
         "genkgo/xsl": "Allows usage of Genkgo/Xsl transformations"
     },
     "require-dev": {
-        "genkgo/xsl": "^0.6",
-        "phpunit/phpunit": "^6.2|^7.3",
+        "genkgo/xsl": "dev-master",
+        "phpunit/phpunit": "^9.5",
         "squizlabs/php_codesniffer": "^3.0",
         "friendsofphp/php-cs-fixer": "^2.4",
-        "phpstan/phpstan": "^0.9|^0.10|^0.11"
+        "phpstan/phpstan": "^0.12"
     },
     "autoload": {
         "psr-4": {
@@ -65,21 +65,21 @@
             "@dev:docs"
         ],
         "dev:check-style": [
-            "vendor/bin/php-cs-fixer fix --dry-run --verbose",
-            "vendor/bin/phpcs --colors -sp src/ tests/"
+            "@php vendor/bin/php-cs-fixer fix --dry-run --verbose",
+            "@php vendor/bin/phpcs --colors -sp src/ tests/"
         ],
         "dev:fix-style": [
-            "vendor/bin/php-cs-fixer fix --verbose",
-            "vendor/bin/phpcbf --colors -sp src/ tests/"
+            "@php vendor/bin/php-cs-fixer fix --verbose",
+            "@php vendor/bin/phpcbf --colors -sp src/ tests/"
         ],
         "dev:docs": [
             "node_modules/markdownlint-cli/markdownlint.js *.md docs/",
             "mkdocs build --strict --site-dir build/docs"
         ],
         "dev:test": [
             "@dev:check-style",
-            "vendor/bin/phpunit --testdox --verbose --stop-on-failure",
-            "vendor/bin/phpstan analyse --no-progress --level max src/ tests/"
+            "@php vendor/bin/phpunit --testdox --verbose --stop-on-failure",
+            "@php vendor/bin/phpstan analyse --no-progress src/ tests/"
         ],
         "dev:coverage": [
             "@php -dzend_extension=xdebug.so vendor/bin/phpunit --coverage-text --coverage-html build/coverage/html/"

docs/CHANGELOG.md

@@ -28,6 +28,44 @@
 - Change visibility of `CfdiUtils\Cleaner\Cleaner#removeIncompleteSchemaLocation()` to private.
 
 
+## Version 2.15.0 2021-03-17
+
+Improvements:
+
+- Include validation web service version 1.3 new response `ValidacionEFOS` as
+  `StatusResponse::getValidationEfos() string` and `StatusResponse::isEfosListed() bool`.
+- Update `ConsultaCFDIServiceSAT.svc.xml`. It is unused, but exists for compatibility.
+
+General:
+
+- Upgrade to PHPUnit 9.5 and upgrade test suite.
+- Test classes are declared as final.
+- Remove support for PHP 7.0, PHP 7.1 and PHP 7.2.
+- Compatilize with PHP 8.0 / OpenSSL:
+    - openssl functions does not return resources but objects.
+    - On deprecated functions run only if PHP version is lower than 8.0 and put annotations for `phpcs`.
+
+Bugfixes:
+
+- Validation `SELLO04` fails when there are special caracters like `é` and `LC_CTYPE` is not setup.
+- Fix `COMPIMPUESTOSC01` description typo.
+
+There are some soft backwards incompatibility changes:
+
+- Method __construct() of class CfdiUtils\Validate\Cfdi33\Standard\FechaComprobante became final
+- Method __construct() of class CfdiUtils\Validate\Cfdi33\RecepcionPagos\Pago became final
+- The return type of CfdiUtils\Validate\Cfdi33\RecepcionPagos\Pago#getValidators() changed from no type to array
+- The parameter $decimals of CfdiUtils\Utils\Format::number() changed from no type to a non-contravariant int
+- The parameter $content of CfdiUtils\Cleaner\Cleaner::staticClean() changed from no type to a non-contravariant string.
+
+Development environment:
+
+- AppVeyor: Only run PHPUnit
+- Travis-CI: On PHP != 7.4 only run PHPUnit
+- Travis-CI: On PHP == 7.4 run all the build commands
+- PHPStan: Upgrade to version 0.12, downgrade level to 5.
+
+
 ## Version 2.14.2 2021-03-16
 
 ### `FormaPago` on `N - Nómina`

docs/TODO.md

@@ -1,14 +1,15 @@
 # Lista de tareas pendientes e ideas
 
-- Compatibilidad con PHP 7.4
-- Firma de CfdiUtils\Utils\Format::number el argumento $decimals debe ser entero
+- Incrementar la cobertura de PHPStan al nivel máximo.
 
 ## Verificar problemas conocidos
 
 ### Descarga de certificados desde <https://rdc.sat.gob.mx/rccf/> por certificados vencidos
 
 Ver: <https://www.phpcfdi.com/sat/problemas-conocidos/descarga-certificados/#problemas-de-caducidad-de-certificados>
 
+*Actualización 2020-10-08*: Este problema se vuelve a presentar.
+
 *Actualización 2020-07-18*: Desde 2019-10-24 este problema parece solucionado.
 
 La descarga de certificados desde `https://rdc.sat.gob.mx/rccf/` falla por un error de configuración
@@ -68,7 +69,7 @@ ideas than need a solution:
 ## Validation rules for Pagos
 
 The validation rules for "Complemento de Recepción de pagos" are included since version 2.6 but
-they require more cases of use and a better understanding of the rules published by SAT.
+they require more cases of use, and a better understanding of the rules published by SAT.
 
 
 ## Validation rules for ComercioExterior

docs/componentes/estado-sat.md

@@ -64,11 +64,11 @@ y cambiar la URL.
 ## Datos que entrega la consulta
 
 El servicio entrega cuatro valores: estado de la consulta, estado del cfdi,
-estado de cancelabilidad y estado de cancelación.
+estado de cancelabilidad, estado de cancelación y validación EFOS.
 
 ### CodigoEstatus (estado de consulta)
 
-Este estado está relacionado a la solicitud de información al SAT. No al CFDI.
+Este estado está relacionado con la solicitud de información al SAT. No al CFDI.
 
 - `S - Comprobante obtenido satisfactoriamente`
 - `N - 601: La expresión impresa proporcionada no es válida`
@@ -102,6 +102,16 @@ Se refiere al estado de la cancelación solicitada previamente.
 - `Cancelado con aceptación`: Cancelado con el consentimiento del receptor.
 - `Solicitud rechazada`: No se realizó la cancelación por rechazo.
 
+### ValidacionEFOS (estado del emisor en la lista de EFOS)
+
+El WebService del SAT devuelve dos códigos que asumimos se refieren al emisor del CFDI:
+
+- 200: No se enctró en el listado de EFOS.
+- 100: Se encontró en el listado de EFOS.
+
+Desconocemos si el código se refiere a si estaba listado en el momento de la emisión del CFDI,
+al momento de ser reportado el CFDI al SAT o al momento de consulta.
+
 ## Estados mutuamente excluyentes
 
 CodigoEstatus | Estado        | EsCancelable              | EstatusCancelacion       | Explicación
@@ -156,10 +166,11 @@ $service = new WebService();
 $response = $service->request($request);
 
 // obtener las respuestas
-$response->getCode(); // S - ...
-$response->getCfdi(); // Vigente
-$response->getCancellable(); // Cancelable con aceptación
-$response->getCancellationStatus(); // En proceso
+echo $response->getCode(); // S - ...
+echo $response->getCfdi(); // Vigente
+echo $response->getCancellable(); // Cancelable con aceptación
+echo $response->getCancellationStatus(); // En proceso
+echo $response->getValidationEfos(); // 200
 ```
 
 ## Problema con el webservice del SAT

docs/index.md

@@ -11,7 +11,7 @@
 [![Coverage Status][badge-coverage]][coverage]
 [![Total Downloads][badge-downloads]][downloads]
 
-[`eclipxe/CfdiUtils`](https://github.com/eclipxe13/CfdiUtils)
+El proyecto [`eclipxe/CfdiUtils`](https://github.com/eclipxe13/CfdiUtils)
 es una librería de PHP para leer, validar y crear CFDI 3.3.
 
 Mira el archivo [README][] para información rápida (en inglés).
@@ -26,7 +26,7 @@ México, en proyectos privados o proyectos libres como el futuro "BuzonCFDI".
 Esta librería se ha liberado como software libre para ayudar a otros desarrolladores a
 trabajar con CFDI y también para obtener su ayuda, todo lo que la comunidad pueda
 contribuir será bien apreciado. Tenemos una comunidad activa y dinámica, nos puedes
-encontrar en el [canal #phpcfdi de discord][discord].
+encontrar en el canal [#phpcfdi de discord][discord].
 
 No olvides visitar <https://www.phpcfdi.com> donde contamos con muchas más librerías relacionadas con
 CFDI y herramientas del SAT. Y próximamente el lugar donde publicaremos la versión `3.y.z`.

phpstan.neon.dist

@@ -1,3 +1,4 @@
 parameters:
+    level: 5
     inferPrivatePropertyTypeFromConstructor: true
 

src/CfdiUtils/CadenaOrigen/GenkgoXslBuilder.php

@@ -3,6 +3,8 @@
 namespace CfdiUtils\CadenaOrigen;
 
 use DOMDocument;
+use Genkgo\Xsl\Cache\NullCache;
+use Genkgo\Xsl\Exception\TransformationException;
 use Genkgo\Xsl\XsltProcessor;
 
 class GenkgoXslBuilder extends DOMBuilder
@@ -16,12 +18,15 @@ public function __construct()
 
     protected function transform(DOMDocument $xml, DOMDocument $xsl): string
     {
-        $xslt = new XSLTProcessor();
+        $xslt = new XSLTProcessor(new NullCache());
         $xslt->importStyleSheet($xsl);
 
-        // this error silenced call is intentional, avoid transformation errors except when return false
-        /** @var string|null|false $transform */
-        $transform = @$xslt->transformToXML($xml);
+        try {
+            /** @var string|null|false $transform */
+            $transform = $xslt->transformToXML($xml);
+        } catch (TransformationException $exception) {
+            throw new XsltBuildException('Error while transforming the xslt content', 0, $exception);
+        }
         if (null === $transform || false === $transform) {
             throw $this->createLibXmlErrorOrMessage('Error while transforming the xslt content');
         }