Merge pull request #20 from eclipxe13/master

Fix double extension on cfdi zip archives

Author: eclipxe13

docs/CHANGELOG.md

@@ -1,21 +1,29 @@
 # CHANGELOG
 
-## About SemVer
+## Acerca de los números de versiones
 
-In summary, [SemVer](https://semver.org/) can be viewed as ` Breaking . Feature . Fix `, where:
+Respetamos el estándar [Versionado Semántico 2.0.0](https://semver.org/lang/es/).
 
-- Breaking version = includes incompatible changes to the API
-- Feature version = adds new feature(s) in a backwards-compatible manner
-- Fix version = includes backwards-compatible bug fixes
+En resumen, [SemVer](https://semver.org/) es un sistema de versiones de tres componentes `X.Y.Z`
+que nombraremos así: ` Breaking . Feature . Fix `, donde:
 
-**Version `0.x.x` doesn't have to apply any of the SemVer rules**
+- `Breaking`: Rompe la compatibilidad de código con versiones anteriores.
+- `Feature`: Agrega una nueva característica que es compatible con lo anterior.
+- `Fix`: Incluye algún cambio (generalmente correcciones) que no agregan nueva funcionalidad.
+
+**Importante:** Las reglas de SEMVER no aplican si estás usando una rama (por ejemplo `master-dev`)
+o estás usando una versión cero (por ejemplo `0.18.4`).
+
+## Version 0.3.1 2020-06-04
+
+- Se corrige el problema de que recientemente los archivos ZIP de consultas de CFDI vienen con doble extensión,
+  por ejemplo `aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee.xml.xml`.
 
 ## Version 0.3.0 2020-05-01
 
 - Se actualizan las dependencias `php: >=7.3` y `phpunit: ^9.1`.
 - Se actualiza `php-cs-fixer` para usar `@PHP73Migration`.
 
-
 ## Version 0.2.6 2020-04-11
 
 - Se actualizan los tests para que usen el RFC `EKU9003173C9`.
@@ -61,7 +69,7 @@ In summary, [SemVer](https://semver.org/) can be viewed as ` Breaking . Feature
 
 ## Version 0.2.2 2019-08-20
 
-- Make sure that when constructing a `DateTime` it fails with an exception.
+- Make sure when constructing a `DateTime` that it fails with an exception.
 - Improve code coverage.
 
 

docs/TODO.md

@@ -1,9 +1,15 @@
 # phpcfdi/sat-ws-descarga-masiva To Do List
 
-- Generar excepciones del proyecto en lugar de excepciones genéricas
+- Generar excepciones del proyecto en lugar de excepciones genéricas.
 
 - Mover el script de consumo con credenciales válidas a su propio proyecto dependiente de este.
 
+- Los objetos CfdiPackageReader y MetadataPackageReader deberían de utilizar objetos independientes para
+  el filtrado, las forma de estructurarlo a través de un AbstractPackageReader no es la mejor opción.
+  Un ejemplo claro es la imposibilidad de crear tests unitarios correctos, porque el objeto encargado
+  de leer las entradas del archivo zip comparte la responsabilidad de filtrar por nombre o por contenido, estas
+  últimas dos responsabilidades deberían ser independientes.
+
 - Llevar el code coverage a 100% con test unitarios
     2020-05-01: Version 0.3.0 93%
     2019-12-06: Version 0.2.4 92%

src/PackageReader/CfdiPackageReader.php

@@ -8,7 +8,9 @@ class CfdiPackageReader extends AbstractPackageReader
 {
     protected function filterEntryFilename(string $filename): bool
     {
-        if (boolval(preg_match('/^[\w\-]{36}\.xml$/i', $filename))) {
+        // this regexp means that start with al least 1 char that is not "/" or "\"
+        // and continues and ends with ".xml". So x.xml x.xml.xml are valid, but not a/x.xml
+        if (boolval(preg_match('/^[^\/\\\\]+\.xml$/i', $filename))) {
             return true;
         }
         return false;

tests/Unit/PackageReader/CfdiPackageReaderTest.php

@@ -8,6 +8,18 @@
 use PhpCfdi\SatWsDescargaMasiva\Tests\TestCase;
 use RuntimeException;
 
+/**
+ * This tests uses the Zip file located at tests/_files/zip/cfdi.zip that contains:
+ *
+ * __MACOSX/ // commonly generated by MacOS when open the file
+ * __MACOSX/.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee.xml // commonly generated by MacOS when open the file
+ * aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee.xml // valid cfdi with common name
+ * aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee.xml.xml // valid cfdi with double extension (oh my SAT!)
+ * 00000000-0000-0000-0000-000000000000.xml // file with correct name but not a cfdi
+ * empty-file // zero bytes file
+ * other.txt // file with incorrect extension and incorrect content
+ *
+ */
 class CfdiPackageReaderTest extends TestCase
 {
     public function testReaderZipWhenTheContentIsInvalid(): void
@@ -32,14 +44,33 @@ public function testReaderZipWhenTheContentValid(): void
 
     public function testReaderZipWithOtherFiles(): void
     {
-        $expectedNumberCfdis = 1;
+        $expectedNumberCfdis = 2;
 
         $filename = $this->filePath('zip/cfdi.zip');
         $cfdiPackageReader = new CfdiPackageReader($filename);
 
         $this->assertCount($expectedNumberCfdis, $cfdiPackageReader);
     }
 
+    public function testReaderZipWithOtherFilesAndDoubleXmlExtension(): void
+    {
+        // there are 2 valid files:
+        // "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee.xml" and
+        // "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee.xml.xml"
+        $expectedFilenames = [
+            'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee.xml',
+            'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee.xml.xml',
+        ];
+        sort($expectedFilenames);
+
+        $filename = $this->filePath('zip/cfdi.zip');
+        $cfdiPackageReader = new CfdiPackageReader($filename);
+
+        $filenames = array_keys(iterator_to_array($cfdiPackageReader->fileContents()));
+        sort($filenames);
+        $this->assertEquals($expectedFilenames, $filenames);
+    }
+
     public function testReaderCfdiInZip(): void
     {
         $expectedCfdi = $this->fileContents('zip/cfdi.xml');