Merge pull request #4 from eclipxe13/master

eclipxe13 · web-flow · commit 00fe9b2cb1f2 · 2019-10-24T15:25:40.000-05:00
Version 3.0.0
diff --git a/.gitattributes b/.gitattributes
@@ -3,11 +3,10 @@
 
 # Do not put this files on a distribution package (by .gitignore)
 /vendor              export-ignore
-/build               export-ignore
 /composer.lock       export-ignore
 
 # Do not put this files on a distribution package
-/docs/               export-ignore
+/build/              export-ignore
 /tests/              export-ignore
 /.gitattributes      export-ignore
 /.gitignore          export-ignore
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,3 @@
 # do not include this files on git
 /vendor
-/build
 /composer.lock
-.phpunit.result.cache
diff --git a/.phplint.yml b/.phplint.yml
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -6,15 +6,9 @@ filter:
 build:
   nodes:
     analysis:
-      environment:
-        php:
-          version: "7.3"
-      project_setup:
-        override: true
       tests:
         override:
           - php-scrutinizer-run --enable-security-analysis
-          - phpcs-run --standard=phpcs.xml.dist src/ tests/
           - command: vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover
             coverage:
               file: coverage.clover
diff --git a/.travis.yml b/.travis.yml
@@ -1,29 +1,33 @@
 language: php
 
-# This triggers builds to run on the new TravisCI infrastructure.
-# See: http://docs.travis-ci.com/user/workers/container-based-infrastructure/
-sudo: false
-
 # php compatibility
 php:
   - "7.2"
   - "7.3"
+  - "7.4snapshot"
+
+matrix:
+  allow_failures:
+    - php: "7.4snapshot"
+
+env:
+  global:
+    - PHP_CS_FIXER_FUTURE_MODE=1
+    - PHP_CS_FIXER_IGNORE_ENV=1
 
 cache:
   - directories:
     - $HOME/.composer
 
 before_script:
+  - phpenv config-rm xdebug.ini || true
   - travis_retry composer install --no-interaction --prefer-dist
-  - phpenv config-rm xdebug.ini
-  - mkdir -p build
 
 script:
-  - vendor/bin/phplint
-  - vendor/bin/php-cs-fixer fix --verbose
+  - vendor/bin/php-cs-fixer fix --dry-run --verbose
   - vendor/bin/phpcbf --colors -sp src/ tests/
   - vendor/bin/phpunit --testdox --verbose
-  - vendor/bin/phpstan.phar analyse --no-progress --level max src/ tests/
+  - vendor/bin/phpstan analyse --no-progress --verbose --level max src/ tests/
 
 notifications:
   email: false
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -9,7 +9,7 @@ By participating in this project and its community, you are expected to uphold t
 ## Team members
 
 * [Carlos C Soto](https://github.com/eclipxe13) - original author and maintainer
-* [GitHub constributors](https://github.com/phpcfdi/cfdi-expresiones/graphs/contributors)
+* [GitHub contributors](https://github.com/phpcfdi/cfdi-expresiones/graphs/contributors)
 
 ## Communication Channels
 
@@ -75,8 +75,8 @@ If any of these do not pass, it will result in a complete build failure.
 Before you can run these, be sure to `composer install` or `composer update`.
 
 ```shell
-vendor/bin/parallel-lint src/ tests/
 vendor/bin/phpcs -sp src/ tests/
 vendor/bin/php-cs-fixer fix -v --dry-run
 vendor/bin/phpunit --coverage-text
+vendor/bin/phpstan analyse --level max src/ tests/
 ```
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Carlos C Soto
+Copyright (c) 2019 PHPCFDI
 
 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
@@ -40,7 +40,6 @@ Ejemplo de expresión para RET 1.0:
 ?&re=XAXX010101000&nr=12345678901234567890%tt=1234567890.123456&id=ad662d33-6934-459c-a128-BDf0393f0f44
 ```
 
-
 ## Instalación
 
 Usa [composer](https://getcomposer.org/)
@@ -74,19 +73,21 @@ Esta librería se mantendrá compatible con al menos la versión con
 También utilizamos [Versionado Semántico 2.0.0](https://semver.org/lang/es/) por lo que puedes usar esta librería
 sin temor a romper tu aplicación.
 
+### Cambiar de la versión 2.0.0 a la versión 3.0.0
+
+La versión `3.0.0` agrega un método a la interfaz `ExpressionExtractorInterface` por lo que es necesario crear una
+versión mayor. Puedes actualizar con confianza si no creaste alguna clase que implemente `ExpressionExtractorInterface`.
 
 ## Contribuciones
 
 Las contribuciones con bienvenidas. Por favor lee [CONTRIBUTING][] para más detalles
 y recuerda revisar el archivo de tareas pendientes [TODO][] y el [CHANGELOG][].
 
-
 ## Copyright and License
 
-The phpcfdi/cfdi-expresiones library is copyright © [Carlos C Soto](http://eclipxe.com.mx/)
+The phpcfdi/cfdi-expresiones library is copyright © [PhpCfdi](https://www.phpcfdi.com/)
 and licensed for use under the MIT License (MIT). Please see [LICENSE][] for more information.
 
-
 [contributing]: https://github.com/phpcfdi/cfdi-expresiones/blob/master/CONTRIBUTING.md
 [changelog]: https://github.com/phpcfdi/cfdi-expresiones/blob/master/docs/CHANGELOG.md
 [todo]: https://github.com/phpcfdi/cfdi-expresiones/blob/master/docs/TODO.md
@@ -99,9 +100,9 @@ and licensed for use under the MIT License (MIT). Please see [LICENSE][] for mor
 [coverage]: https://scrutinizer-ci.com/g/phpcfdi/cfdi-expresiones/code-structure/master/code-coverage
 [downloads]: https://packagist.org/packages/phpcfdi/cfdi-expresiones
 
-[badge-source]: http://img.shields.io/badge/source-phpcfdi/cfdi--expresiones-blue.svg?style=flat-square
+[badge-source]: https://img.shields.io/badge/source-phpcfdi/cfdi--expresiones-blue.svg?style=flat-square
 [badge-release]: https://img.shields.io/github/release/phpcfdi/cfdi-expresiones.svg?style=flat-square
-[badge-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
+[badge-license]: https://img.shields.io/github/license/phpcfdi/cfdi-expresiones.svg?style=flat-square
 [badge-build]: https://img.shields.io/travis/phpcfdi/cfdi-expresiones/master.svg?style=flat-square
 [badge-quality]: https://img.shields.io/scrutinizer/g/phpcfdi/cfdi-expresiones/master.svg?style=flat-square
 [badge-coverage]: https://img.shields.io/scrutinizer/coverage/g/phpcfdi/cfdi-expresiones/master.svg?style=flat-square
diff --git a/build/.gitignore b/build/.gitignore
@@ -0,0 +1,2 @@
+*
+!.gitignore
diff --git a/composer.json b/composer.json
@@ -27,8 +27,7 @@
         "ext-dom": "*"
     },
     "require-dev": {
-        "phpunit/phpunit": "^8.0",
-        "overtrue/phplint": "^1.0",
+        "phpunit/phpunit": "^8.4",
         "squizlabs/php_codesniffer": "^3.0",
         "friendsofphp/php-cs-fixer": "^2.4",
         "phpstan/phpstan-shim": "^0.11"
@@ -54,10 +53,9 @@
             "vendor/bin/phpcbf --colors -sp src/ tests/"
         ],
         "dev:test": [
-            "vendor/bin/phplint",
+            "@dev:check-style",
             "vendor/bin/phpunit --testdox --verbose --stop-on-failure",
-            "find . -type f -name .phpunit.result.cache -delete",
-            "vendor/bin/phpstan analyse --verbose --level max src/ tests/"
+            "vendor/bin/phpstan analyse --verbose --no-progress --level max src/ tests/"
         ],
         "dev:coverage": [
             "@php -dzend_extension=xdebug.so vendor/bin/phpunit --coverage-text --coverage-html build/coverage/html/"
@@ -67,7 +65,7 @@
         "dev:build": "DEV: run dev:fix-style dev:tests and dev:docs, run before pull request",
         "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:test": "DEV: run phplint, 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/"
     }
 }
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,5 +1,20 @@
 # CHANGELOG
 
+Notice: This library follows [SEMVER 2.0.0](https://semver.org/spec/v2.0.0.html) convention.
+
+## Version 3.0.0 2019-10-24
+
+You should not have any trouble upgrading to from version `2.0.0` to `3.0.0` unless you are creating a concrete
+class that implements `ExpressionExtractorInterface`. 
+
+- [BC] Change interface of `ExpressionExtractorInterface` to add a new method `obtain(DOMDocument $document): array`
+  that returns the extracted values, this change remove this responsability from `extract` method.
+- [BC] Change `DiscoverExtractor::format()`, second argument must be `string`, was `mixed`.
+- Update continuous integration and development environment, mayor changes:
+    - Travis build on PHP version `7.4snapshot`.
+    - Scrutinizer decides which PHP version to run.
+    - Remove `overtrue/phplint`.
+
 ## Version 2.0.0 2019-03-28
 
 - Allows to create an expression with format fixes from specific types
@@ -11,7 +26,6 @@
     - `Retenciones10` uses `RET10`
 - Rename `ExpressionExtractor` to `DiscoverExtractor`, it makes more sense
 
-
 ## Version 1.0.0 2019-03-27
 
 - Create this package as is a common use between other packages
diff --git a/docs/TODO.md b/docs/TODO.md
@@ -1,3 +1,3 @@
 # phpcfdi/cfdi-expresiones To Do List
 
-- Poner el copyright correcto en cuanto esté el sitio de PhpCfdi
+- 2019-10-24: Nada pendiente aún.
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,6 +1,6 @@
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/8.0/phpunit.xsd"
-         bootstrap="./tests/bootstrap.php" colors="true" verbose="true" cacheTokens="false">
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/8.4/phpunit.xsd"
+         bootstrap="./tests/bootstrap.php" colors="true" verbose="true" cacheResultFile="build/phpunit.result.cache">
     <testsuites>
         <testsuite name="Default">
             <directory>./tests/</directory>
diff --git a/src/DiscoverExtractor.php b/src/DiscoverExtractor.php
@@ -23,9 +23,7 @@ public function __construct(ExpressionExtractorInterface ...$expressions)
         $this->expressions = $expressions;
     }
 
-    /**
-     * @return ExpressionExtractorInterface[];
-     */
+    /** @return ExpressionExtractorInterface[] */
     public function defaultExtractors(): array
     {
         return [
@@ -80,13 +78,19 @@ public function uniqueName(): string
         return 'discover';
     }
 
+    public function obtain(DOMDocument $document): array
+    {
+        $discovered = $this->getFirstMatch($document);
+        return $discovered->obtain($document);
+    }
+
     public function extract(DOMDocument $document): string
     {
         $discovered = $this->getFirstMatch($document);
         return $discovered->extract($document);
     }
 
-    public function format(array $values, $type = ''): string
+    public function format(array $values, string $type = ''): string
     {
         $extractor = $this->findByUniqueName($type);
         if (null === $extractor) {
diff --git a/src/ExpressionExtractorInterface.php b/src/ExpressionExtractorInterface.php
@@ -8,10 +8,35 @@
 
 interface ExpressionExtractorInterface
 {
+    /**
+     * Extractor (implementor) unique name
+     *
+     * @return string
+     */
     public function uniqueName(): string;
 
+    /**
+     * Check that the XML document matches with the extractor
+     *
+     * @param DOMDocument $document
+     * @return bool
+     */
     public function matches(DOMDocument $document): bool;
 
+    /**
+     * Obtain the relevant values from the given XML Document
+     *
+     * @param DOMDocument $document
+     * @return array
+     */
+    public function obtain(DOMDocument $document): array;
+
+    /**
+     * Format an expression based on given XML document
+     *
+     * @param DOMDocument $document
+     * @return string
+     */
     public function extract(DOMDocument $document): string;
 
     /**
diff --git a/src/Extractors/Comprobante32.php b/src/Extractors/Comprobante32.php
@@ -30,7 +30,7 @@ public function matches(DOMDocument $document): bool
         return $this->matchDetector->matches($document);
     }
 
-    public function extract(DOMDocument $document): string
+    public function obtain(DOMDocument $document): array
     {
         if (! $this->matches($document)) {
             throw new UnmatchedDocumentException('The document is not a CFDI 3.2');
@@ -42,12 +42,17 @@ public function extract(DOMDocument $document): string
         $rfcReceptor = $helper->getAttribute('cfdi:Comprobante', 'cfdi:Receptor', 'rfc');
         $total = $helper->getAttribute('cfdi:Comprobante', 'total');
 
-        return $this->format([
+        return [
             're' => $rfcEmisor,
             'rr' => $rfcReceptor,
             'tt' => $total,
             'id' => $uuid,
-        ]);
+        ];
+    }
+
+    public function extract(DOMDocument $document): string
+    {
+        return $this->format($this->obtain($document));
     }
 
     public function format(array $values): string
diff --git a/src/Extractors/Comprobante33.php b/src/Extractors/Comprobante33.php
@@ -30,7 +30,7 @@ public function matches(DOMDocument $document): bool
         return $this->matchDetector->matches($document);
     }
 
-    public function extract(DOMDocument $document): string
+    public function obtain(DOMDocument $document): array
     {
         if (! $this->matches($document)) {
             throw new UnmatchedDocumentException('The document is not a CFDI 3.3');
@@ -43,13 +43,18 @@ public function extract(DOMDocument $document): string
         $total = $helper->getAttribute('cfdi:Comprobante', 'Total');
         $sello = substr($helper->getAttribute('cfdi:Comprobante', 'Sello'), -8);
 
-        return $this->format([
+        return [
             'id' => $uuid,
             're' => $rfcEmisor,
             'rr' => $rfcReceptor,
             'tt' => $total,
-            'fe' => substr($sello, -8),
-        ]);
+            'fe' => $sello,
+        ];
+    }
+
+    public function extract(DOMDocument $document): string
+    {
+        return $this->format($this->obtain($document));
     }
 
     public function format(array $values): string
diff --git a/src/Extractors/Retenciones10.php b/src/Extractors/Retenciones10.php
@@ -36,7 +36,7 @@ public function matches(DOMDocument $document): bool
         return $this->matchDetector->matches($document);
     }
 
-    public function extract(DOMDocument $document): string
+    public function obtain(DOMDocument $document): array
     {
         if (! $this->matches($document)) {
             throw new UnmatchedDocumentException('The document is not a RET 1.0');
@@ -81,12 +81,17 @@ public function extract(DOMDocument $document): string
             $helper->getAttribute('retenciones:Retenciones', 'retenciones:Totales', 'montoTotOperacion')
         );
 
-        return $this->format([
+        return [
             're' => $rfcEmisor,
             $rfcReceptorKey => $rfcReceptor,
             'tt' => $this->formatTotal($total),
             'id' => $uuid,
-        ]);
+        ];
+    }
+
+    public function extract(DOMDocument $document): string
+    {
+        return $this->format($this->obtain($document));
     }
 
     public function format(array $values): string
diff --git a/tests/Unit/DiscoverExtractorTest.php b/tests/Unit/DiscoverExtractorTest.php
