Version 2.12.9

Author: eclipxe13

.appveyor.yml

@@ -122,7 +122,6 @@ install:
 ## Run the actual test
 test_script:
     - cd c:\projects\project
-    - vendor\bin\phplint.bat
     - 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

.gitattributes

@@ -19,7 +19,6 @@
 /.gitignore          export-ignore
 /.markdownlint.json  export-ignore
 /.php_cs.dist        export-ignore
-/.phplint.yml        export-ignore
 /.scrutinizer.yml    export-ignore
 /.travis.yml         export-ignore
 /mkdocs.yml          export-ignore

.phplint.yml

@@ -11,6 +11,7 @@ build:
     dependencies:
         override:
             - composer self-update --no-interaction --no-progress
+            - composer remove squizlabs/php_codesniffer friendsofphp/php-cs-fixer phpstan/phpstan --dev --no-interaction --no-progress --no-update
             - composer install --no-interaction
     nodes:
         analysis:

.scrutinizer.yml

@@ -29,7 +29,6 @@ before_script:
     - travis_retry pip install --user mkdocs
 
 script:
-    - vendor/bin/phplint
     - vendor/bin/phpcs -sp src/ tests/
     - vendor/bin/php-cs-fixer fix --using-cache=no --dry-run --verbose
     - | # create code coverage file

.travis.yml

@@ -44,7 +44,6 @@
     "require-dev": {
         "genkgo/xsl": "^0.6",
         "phpunit/phpunit": "^6.2|^7.3",
-        "overtrue/phplint": "^1.0",
         "squizlabs/php_codesniffer": "^3.0",
         "friendsofphp/php-cs-fixer": "^2.4",
         "phpstan/phpstan": "^0.9|^0.10|^0.11"
@@ -78,7 +77,6 @@
             "mkdocs build --strict --site-dir build/docs"
         ],
         "dev:test": [
-            "vendor/bin/phplint",
             "@dev:check-style",
             "vendor/bin/phpunit --testdox --verbose --stop-on-failure",
             "vendor/bin/phpstan analyse --no-progress --level max src/ tests/"
@@ -92,7 +90,7 @@
         "dev:check-style": "DEV: search for code style errors using php-cs-fixer and phpcs",
         "dev:fix-style": "DEV: fix code style errors using php-cs-fixer and phpcbf",
         "dev:docs": "DEV: search for code style errors unsing markdownlint and build docs using mkdocs",
-        "dev:test": "DEV: run phplint, dev:check-style, phpunit and phpstan",
+        "dev:test": "DEV: run dev:check-style, phpunit and phpstan",
         "dev:coverage": "DEV: run phpunit with xdebug and storage coverage in build/coverage/html/"
     }
 }

composer.json

@@ -28,6 +28,13 @@
 - Change visibility of `CfdiUtils\Cleaner\Cleaner#removeIncompleteSchemaLocation()` to private.
 
 
+## Version 2.12.9 2020-04-25
+
+- Review and fix `CreateComprobantePagosCaseTest`.
+- Add docblocks on `StatusResponse` and fix script `tests/estadosat.php`.
+- Remove `overtrue/phplint` from development dependences.
+
+
 ## Version 2.12.8 2020-01-07
 
 - Change License year to 2020.

docs/CHANGELOG.md

@@ -88,19 +88,19 @@ Este estado se debe entender como que el SAT reconoce el CFDI y su estado genera
 Se refiere a que si en el momento de la consulta el CFDI se puede cancelar.
 
 - `No cancelable`: No se puede cancelar, tal vez ya hay documentos relacionados.
-- `Cancelable sin aceptación`: Se puede cancelar de inmediato
+- `Cancelable sin aceptación`: Se puede cancelar de inmediato.
 - `Cancelable con aceptación`: Se puede cancelar pero se va a tener que esperar respuesta.
 
 ### EstatusCancelacion (estado de cancelación)
 
 Se refiere al estado de la cancelación solicitada previamente.
 
 - `(ninguno)`: El estado vacío es que no tiene estado de cancelación, porque no fue solicitada.
-- `Cancelado sin aceptación`: Se canceló y no fue necesaria la aceptación
-- `En proceso`: En espera de que el receptor la autorice
-- `Plazo vencido`: Cancelado por vencimiento de plazo en que el receptor podía denegarla
-- `Cancelado con aceptación`: Cancelado con el consentimiento del receptor
-- `Solicitud rechazada`: No cancelada.
+- `Cancelado sin aceptación`: Se canceló y no fue necesaria la aceptación.
+- `En proceso`: En espera de que el receptor la autorice.
+- `Plazo vencido`: Cancelado por vencimiento de plazo en que el receptor podía denegarla.
+- `Cancelado con aceptación`: Cancelado con el consentimiento del receptor.
+- `Solicitud rechazada`: No se realizó la cancelación por rechazo.
 
 ## Estados mutuamente excluyentes
 

docs/componentes/estado-sat.md

@@ -40,12 +40,6 @@ composer install
 
 ## Pruebas
 
-Para probar que todos los archivos no contienen errores de sintaxis
-
-```shell
-vendor/bin/phplint
-```
-
 Para probar que no se están violando las reglas de estilo
 
 ```shell

docs/contribuir/guia-desarrollador.md

@@ -28,21 +28,63 @@ public function __construct(
         $this->cancellationStatus = $cancellationStatus;
     }
 
+    /**
+     * Status request code, values:
+     * - S - Comprobante obtenido satisfactoriamente
+     * - N - 601: La expresión impresa proporcionada no es válida
+     * - N - 602: Comprobante no encontrado
+     *
+     * @see responseWasOk()
+     *
+     * @return string
+     */
     public function getCode(): string
     {
         return $this->code;
     }
 
+    /**
+     * Status about the CFDI, values:
+     * - `Vigente`: El comprobante está vigente al momento de la consulta
+     * - `Cancelado`: El comprobante está cancelado al momento de la consulta
+     * - `No Encontrado`: El comprobante no se encuentra en la base de datos del SAT
+     *
+     * @see isVigente()
+     * @see isNotFound()
+     * @see isCancelled()
+     *
+     * @return string
+     */
     public function getCfdi(): string
     {
         return $this->cfdi;
     }
 
+    /**
+     * Cancellable status, values:
+     * - `No cancelable`: No se puede cancelar, tal vez ya hay documentos relacionados.
+     * - `Cancelable sin aceptación`: Se puede cancelar de inmediato.
+     * - `Cancelable con aceptación`: Se puede cancelar pero se va a tener que esperar respuesta.
+     *
+     * @return string
+     */
     public function getCancellable(): string
     {
         return $this->cancellable;
     }
 
+    /**
+     * Cancellation process status, values:
+     *
+     * - `(ninguno)`: El estado vacío es que no tiene estado de cancelación, porque no fue solicitada.
+     * - `Cancelado sin aceptación`: Se canceló y no fue necesaria la aceptación.
+     * - `En proceso`: En espera de que el receptor la autorice.
+     * - `Plazo vencido`: Cancelado por vencimiento de plazo en que el receptor podía denegarla.
+     * - `Cancelado con aceptación`: Cancelado con el consentimiento del receptor.
+     * - `Solicitud rechazada`: No se realizó la cancelación por rechazo.
+     *
+     * @return string
+     */
     public function getCancellationStatus(): string
     {
         return $this->cancellationStatus;

src/CfdiUtils/ConsultaCfdiSat/StatusResponse.php

@@ -21,7 +21,7 @@ public function testMoveSatDefinitionsToComprobante()
         $comprobante = $creator->comprobante();
         $comprobante->addAttributes([
             'Fecha' => Format::datetime($fecha),
-            'TipoDeComprobante' => 'P', // ingreso
+            'TipoDeComprobante' => 'P', // pago
             'LugarExpedicion' => '52000',
             'Moneda' => 'XXX',
             'Total' => '0',
@@ -35,6 +35,7 @@ public function testMoveSatDefinitionsToComprobante()
             'RegimenFiscal' => '601',
         ]);
         $comprobante->addReceptor(['Rfc' => 'COSC8001137NA', 'UsoCFDI' => 'P01']);
+        // The concepto *must* have this content
         $comprobante->addConcepto([
             'ClaveProdServ' => '84111506',
             'Cantidad' => '1',
@@ -44,6 +45,8 @@ public function testMoveSatDefinitionsToComprobante()
             'Importe' => '0',
         ]);
 
+        // create and populate the "complemento de pagos"
+        // @see \CfdiUtils\Elements\Pagos10\Pagos
         $complementoPagos = new Pagos();
         $pago = $complementoPagos->addPago([
             'FechaPago' => Format::datetime($fechaPago),
@@ -76,25 +79,25 @@ public function testMoveSatDefinitionsToComprobante()
                 'ImpSaldoInsoluto' => '7000.00',
             ]
         );
+
+        // add the "complemento de pagos" ($complementoPagos) to the $comprobante
         $comprobante->addComplemento($complementoPagos);
 
         // add sello and validate to assert that the specimen does not have any errors
         $creator->addSello('file://' . $keyfile, '');
-        $findings = $creator->validate();
-        $this->assertFalse(
-            $findings->hasErrors() || $findings->hasWarnings(),
-            'Created document must not contain errors, fix your test specimen'
-        );
 
-        // this is after add sello to probe that it did not change it
+        // this is after add sello to probe that it did not change the cadena origen or the sello
         $creator->moveSatDefinitionsToComprobante();
+
+        // perform validations, it should not have any error nor warnings
+        $findings = $creator->validate();
         $this->assertFalse(
             $findings->hasErrors() || $findings->hasWarnings(),
-            'After moveSatDefinitionsToComprobante the document must not have any warnings or errors'
+            'Created document must not contain errors, fix your test specimen'
         );
 
+        // test that the file is the same as expected
         $expectedFile = $this->utilAsset('created-pago-with-ns-at-root.xml');
-        file_put_contents($expectedFile, $creator->asXml());
         $this->assertXmlStringEqualsXmlFile(
             $expectedFile,
             $creator->asXml(),

tests/CfdiUtilsTests/CreateComprobantePagosCaseTest.php

@@ -35,8 +35,8 @@
 
         print_r(array_filter([
             'file' => $file,
-            'Petición' => $response->getCfdi(),
-            'Estado CFDI' => $response->getCode(),
+            'Petición' => $response->getCode(),
+            'Estado CFDI' => $response->getCfdi(),
             'Cancelable' => $response->getCancellable(),
             'Estado cancelación' => $response->getCancellationStatus(),
         ]));