Merge pull request #12 from eclipxe13/maintenance-20221108

Maintenance (v2.5.0)
phpcfdi · Nov 8, 2022 · 2f50dde · 2f50dde
2 parents 67f8912 + fdec9e7
commit 2f50dde
Show file tree

Hide file tree

Showing 68 changed files with 182 additions and 141 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -13,11 +13,16 @@
 /.phive/                    export-ignore
 /build/                     export-ignore
 /tests/                     export-ignore
+/.dockerignore              export-ignore
 /.gitattributes             export-ignore
 /.gitignore                 export-ignore
 /.php-cs-fixer.dist.php     export-ignore
 /.scrutinizer.yml           export-ignore
+/Docker.README.md           export-ignore
+/Dockerfile                 export-ignore
 /phpcs.xml.dist             export-ignore
 /phpstan.neon.dist          export-ignore
 /phpunit.xml.dist           export-ignore
-/psalm.xml.dist             export-ignore
+
+# Do not count these files on github code language
+/tests/_files/**            linguist-detectable=false
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -18,13 +18,13 @@ jobs:
     runs-on: "ubuntu-latest"
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.0'
+          php-version: '8.1'
           coverage: none
-          tools: composer:v2, cs2pr, phpcs
+          tools: cs2pr, phpcs
         env:
           fail-fast: true
       - name: Code style (phpcs)
@@ -35,13 +35,13 @@ jobs:
     runs-on: "ubuntu-latest"
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.0'
+          php-version: '8.1'
           coverage: none
-          tools: composer:v2, cs2pr, php-cs-fixer
+          tools: cs2pr, php-cs-fixer
         env:
           fail-fast: true
       - name: Code style (php-cs-fixer)
@@ -52,11 +52,11 @@ jobs:
     runs-on: "ubuntu-latest"
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.0'
+          php-version: '8.1'
           coverage: none
           extensions: sqlite3
           tools: composer:v2, cs2pr, phpstan
@@ -66,7 +66,7 @@ jobs:
         id: composer-cache
         run: echo "::set-output name=dir::$(composer config cache-files-dir)"
       - name: Cache dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: ${{ steps.composer-cache.outputs.dir }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
@@ -81,10 +81,10 @@ jobs:
     runs-on: "ubuntu-latest"
     strategy:
       matrix:
-        php-versions: ['8.0', '8.1']
+        php-versions: [8.1', '8.2']
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
@@ -104,7 +104,7 @@ jobs:
         id: composer-cache
         run: echo "::set-output name=dir::$(composer config cache-files-dir)"
       - name: Cache dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: ${{ steps.composer-cache.outputs.dir }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}

diff --git a/.phive/phars.xml b/.phive/phars.xml
@@ -1,7 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-  <phar name="php-cs-fixer" version="^3.8.0" installed="3.8.0" location="./tools/php-cs-fixer" copy="false"/>
-  <phar name="phpcs" version="^3.6.2" installed="3.6.2" location="./tools/phpcs" copy="false"/>
-  <phar name="phpcbf" version="^3.6.2" installed="3.6.2" location="./tools/phpcbf" copy="false"/>
-  <phar name="phpstan" version="^1.5.3" installed="1.5.3" location="./tools/phpstan" copy="false"/>
+  <phar name="php-cs-fixer" version="^3.13.0" installed="3.13.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.9.1" installed="1.9.1" location="./tools/phpstan" copy="false"/>
+  <phar name="composer-normalize" version="^2.28.3" installed="2.28.3" location="./tools/composer-normalize" copy="false"/>
 </phive>
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -15,21 +15,20 @@
     ->setRules([
         '@PSR12' => true,
         '@PSR12:risky' => true,
-        '@PHP73Migration' => true,
-    '@PHP74Migration' => true,
-    '@PHP80Migration' => true,
+        '@PHP80Migration' => true,
         '@PHP80Migration:risky' => true,
         // symfony
         'class_attributes_separation' => true,
         'whitespace_after_comma_in_array' => true,
         'no_empty_statement' => true,
         'no_extra_blank_lines' => true,
         'function_typehint_space' => true,
+        'trailing_comma_in_multiline' => ['after_heredoc' => true, 'elements' => ['arrays']],
         'no_blank_lines_after_phpdoc' => true,
         'object_operator_without_whitespace' => true,
         'binary_operator_spaces' => true,
         'phpdoc_scalar' => true,
-        'no_trailing_comma_in_singleline_array' => true,
+        'no_trailing_comma_in_singleline' => true,
         'single_quote' => true,
         'no_singleline_whitespace_before_semicolons' => true,
         'no_unused_imports' => true,
@@ -38,14 +37,16 @@
         'concat_space' => ['spacing' => 'one'],
         'linebreak_after_opening_tag' => true,
         // symfony:risky
+        'no_alias_functions' => true,
         'self_accessor' => true,
         // contrib
         'not_operator_with_successor_space' => true,
+        'ordered_imports' => ['imports_order' => ['class', 'function', 'const']], // @PSR12 sort_algorithm: none
     ])
     ->setFinder(
         PhpCsFixer\Finder::create()
             ->in(__DIR__)
             ->append([__FILE__])
-            ->exclude(['vendor', 'tools', 'build']),
+            ->exclude(['tools', 'vendor', 'build'])
     )
 ;
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -81,13 +81,13 @@ composer dev:build
 
 The following tests must pass before we will accept a pull request.
 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`.
+Before you can run these, be sure to `composer install` or `composer update` and `phive update`.
 
 ```shell script
-vendor/bin/php-cs-fixer fix --verbose
-vendor/bin/phpcbf --colors -sp
+tools/php-cs-fixer fix --verbose
+tools/phpcbf --colors -sp
 vendor/bin/phpunit --testdox
-vendor/bin/phpstan.phar analyse --no-progress --level max
+tools/phpstan analyse --no-progress --level max
 mkdir -p build/files/
 bin/sat-catalogos-update dump-origins > build/files/origins.xml
 bin/sat-catalogos-update update-origins build/files/ -w build/files/database.sqlite3

diff --git a/README.md b/README.md
@@ -1,12 +1,12 @@
 # phpcfdi/sat-catalogos-populate
 
 [![Source Code][badge-source]][source]
+[![PHP Version][badge-php-version]][php-version]
 [![Latest Version][badge-release]][release]
 [![Software License][badge-license]][license]
 [![Build Status][badge-build]][build]
 [![Scrutinizer][badge-quality]][quality]
 [![Coverage Status][badge-coverage]][coverage]
-[![Total Downloads][badge-downloads]][downloads]
 
 > Herramienta para crear y actualizar los catálogos de SAT/CFDI en una base de datos SQLite3
 
@@ -21,8 +21,8 @@ the commands provided by this package, for more information check the [`README.D
 ```shell script
 git clone https://github.com/phpcfdi/sat-catalogos-populate.git
 docker build -t sat-catalogos-populate sat-catalogos-populate/
-docker run -it --rm sat-catalogos-populate /opt/bin/sat-catalogos-update --help
-``` 
+docker run -it --rm sat-catalogos-populate --help
+```
 
 ## Installation on local system
 
@@ -83,17 +83,17 @@ and licensed for use under the MIT License (MIT). Please see [LICENSE][] for mor
 [todo]: https://github.com/phpcfdi/sat-catalogos-populate/blob/master/docs/TODO.md
 
 [source]: https://github.com/phpcfdi/sat-catalogos-populate
+[php-version]: https://github.com/phpcfdi/sat-catalogos-populate/blob/master/composer.json
 [release]: https://github.com/phpcfdi/sat-catalogos-populate/releases
 [license]: https://github.com/phpcfdi/sat-catalogos-populate/blob/master/LICENSE
 [build]: https://github.com/phpcfdi/sat-catalogos-populate/actions/workflows/build.yml?query=branch:master
 [quality]: https://scrutinizer-ci.com/g/phpcfdi/sat-catalogos-populate/
 [coverage]: https://scrutinizer-ci.com/g/phpcfdi/sat-catalogos-populate/code-structure/master/code-coverage/src
-[downloads]: https://github.com/phpcfdi/sat-catalogos-populate
 
 [badge-source]: https://img.shields.io/badge/source-phpcfdi/sat--catalogos--populate-blue?style=flat-square
+[badge-php-version]: https://img.shields.io/badge/php-^8.1-blue?style=flat-square
 [badge-release]: https://img.shields.io/github/release/phpcfdi/sat-catalogos-populate?style=flat-square
 [badge-license]: https://img.shields.io/github/license/phpcfdi/sat-catalogos-populate?style=flat-square
 [badge-build]: https://img.shields.io/github/workflow/status/phpcfdi/sat-catalogos-populate/build/master?style=flat-square
 [badge-quality]: https://img.shields.io/scrutinizer/g/phpcfdi/sat-catalogos-populate/master?style=flat-square
 [badge-coverage]: https://img.shields.io/scrutinizer/coverage/g/phpcfdi/sat-catalogos-populate/master?style=flat-square
-[badge-downloads]: https://img.shields.io/github/downloads/phpcfdi/sat-catalogos-populate/total?style=flat-square
diff --git a/composer.json b/composer.json
@@ -1,34 +1,38 @@
 {
     "name": "phpcfdi/sat-catalogos-populate",
     "description": "Herramienta para crear y actualizar los catálogos de SAT/CFDI en una base de datos SQLite3",
-    "keywords": ["sat", "cfdi", "catalogos"],
-    "homepage": "https://github.com/phpcfdi/sat-catalogos-populate",
     "license": "MIT",
+    "keywords": [
+        "sat",
+        "cfdi",
+        "catalogos"
+    ],
     "authors": [
         {
             "name": "Carlos C Soto",
             "email": "[email protected]"
         }
     ],
+    "homepage": "https://github.com/phpcfdi/sat-catalogos-populate",
     "support": {
-        "source": "https://github.com/phpcfdi/sat-catalogos-populate",
-        "issues": "https://github.com/phpcfdi/sat-catalogos-populate/issues"
+        "issues": "https://github.com/phpcfdi/sat-catalogos-populate/issues",
+        "source": "https://github.com/phpcfdi/sat-catalogos-populate"
     },
     "require": {
-        "php": ">=8.0",
-        "ext-pdo": "*",
-        "ext-sqlite3": "*",
+        "php": ">=8.1",
+        "ext-dom": "*",
         "ext-json": "*",
+        "ext-pdo": "*",
         "ext-simplexml": "*",
-        "ext-dom": "*",
-        "psr/log": "^1.0",
+        "ext-sqlite3": "*",
         "guzzlehttp/guzzle": "^7.0",
         "psr/http-message": "^1.0",
+        "psr/log": "^1.0",
         "symfony/dom-crawler": "^5.2"
     },
     "require-dev": {
         "ext-fileinfo": "*",
-        "phpunit/phpunit": "^9.1.5"
+        "phpunit/phpunit": "^9.5"
     },
     "autoload": {
         "psr-4": {
@@ -44,29 +48,34 @@
         }
     },
     "scripts": {
-        "dev:build": ["@dev:fix-style", "@dev:test"],
+        "dev:build": [
+            "@dev:fix-style",
+            "@dev:test"
+        ],
         "dev:check-style": [
+            "@php tools/composer-normalize normalize --dry-run",
             "@php tools/php-cs-fixer fix --dry-run --verbose",
             "@php tools/phpcs --colors -sp"
         ],
+        "dev:coverage": [
+            "@php -dzend_extension=xdebug.so -dxdebug.mode=coverage vendor/bin/phpunit --testdox --coverage-html build/coverage/html/"
+        ],
         "dev:fix-style": [
+            "@php tools/composer-normalize normalize",
             "@php tools/php-cs-fixer fix --verbose",
             "@php tools/phpcbf --colors -sp"
         ],
         "dev:test": [
             "@dev:check-style",
-            "vendor/bin/phpunit --testdox --verbose --stop-on-failure",
+            "@php vendor/bin/phpunit --testdox --verbose --stop-on-failure",
             "@php tools/phpstan analyse --no-progress --no-interaction"
-        ],
-        "dev:coverage": [
-            "@php -dzend_extension=xdebug.so vendor/bin/phpunit --coverage-text --coverage-html build/coverage/html/"
         ]
     },
     "scripts-descriptions": {
         "dev:build": "DEV: run dev:fix-style and dev:tests, 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 dev:check-style, phpunit and phpstan",
-        "dev:coverage": "DEV: run phpunit with xdebug and storage coverage in build/coverage/html/"
+        "dev:check-style": "DEV: search for code style errors using composer-normalize, php-cs-fixer and phpcs",
+        "dev:coverage": "DEV: run phpunit with xdebug and storage coverage in build/coverage/html/",
+        "dev:fix-style": "DEV: fix code style errors using composer-normalize, php-cs-fixer and phpcbf",
+        "dev:test": "DEV: run dev:check-style, phpunit and phpstan"
     }
 }
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,5 +1,22 @@
 # phpcfdi/sat-catalogos-populate Changelog
 
+## Version 2.5.0 2022-11-08
+
+- Fix PHPStan issue: `str_getcsv` can return `array<scalar|null>`.
+- Update signature for `SeekableIterator::seek`.
+- `UrlResponse` can have a `Stringable|string` body property.
+- Move logic to create a UrlResponse from a PSR Response
+- Bump to PHP 8.1.
+- Add badge for PHP 8.1.
+- Remove badge for downloads.
+- Upgrade development tools.
+- Update GH workflow:
+  - Add PHP 8.2 to test matrix.
+  - Update GH actions to 8.1.
+  - Remove composer requierement when not needed.
+- Fix composer script `dev:coverage`.
+- Implement development tool `composer-normalize`.
+
 ## Version 2.4.2 2022-04-01
 
 - Fix *Carta Porte 2.0* injector *ProductosServicios* headers.

diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <ruleset name="EngineWorks">
-    <description>The EngineWorks (PSR-2 based) coding standard.</description>
+    <description>The EngineWorks (PSR-12 based) coding standard.</description>
 
     <file>bin</file>
     <file>src</file>

diff --git a/src/AbstractCsvInjector.php b/src/AbstractCsvInjector.php
@@ -20,7 +20,7 @@ abstract public function checkHeaders(CsvFile $csv): void;
 
     abstract public function dataTable(): DataTable;
 
-    public function __construct(private string $sourceFile)
+    public function __construct(private readonly string $sourceFile)
     {
     }
 

diff --git a/src/Commands/CliApplication.php b/src/Commands/CliApplication.php
@@ -57,7 +57,7 @@ public function run(string ...$arguments): int
             return 0;
         }
 
-        if (count(array_intersect(['-h', '--help'], $arguments)) > 0) {
+        if ([] !== array_intersect(['-h', '--help'], $arguments)) {
             $this->showHelp($command);
             return 0;
         }

diff --git a/src/Commands/UpdateOrigins.php b/src/Commands/UpdateOrigins.php
@@ -27,8 +27,8 @@ class UpdateOrigins implements CommandInterface
 
     public function __construct(
         string $originsFile,
-        private bool $updateOrigins,
-        private string $databaseLocation,
+        private readonly bool $updateOrigins,
+        private readonly string $databaseLocation,
         private LoggerInterface $logger
     ) {
         if ('' === $originsFile) {

diff --git a/src/Converters/CsvFolderJoinFiles.php b/src/Converters/CsvFolderJoinFiles.php
@@ -49,9 +49,9 @@ function ($path): array {
                     $file = basename($path);
                     $matches = [];
                     if (
-                        ! (bool) preg_match('/^[ ]*(.+)_Parte_([0-9]+)[ ]*\.csv$/', $file, $matches)
-                        && ! (bool) preg_match('/^[ ]*(.+) \(Parte ([0-9]+)\)[ ]*\.csv$/', $file, $matches)
-                        && ! (bool) preg_match('/^[ ]*(.+)_([0-9]+)[ ]*\.csv$/', $file, $matches)
+                        ! preg_match('/^ *(.+)_Parte_([0-9]+) *\.csv$/', $file, $matches)
+                        && ! preg_match('/^ *(.+) \(Parte ([0-9]+)\) *\.csv$/', $file, $matches)
+                        && ! preg_match('/^ *(.+)_([0-9]+) *\.csv$/', $file, $matches)
                     ) {
                         return [];
                     }
@@ -65,7 +65,7 @@ function ($path): array {
             )
         );
 
-        uasort($files, [$this, 'compareFiles']);
+        uasort($files, $this->compareFiles(...));
 
         $destinations = [];
         foreach ($files as $file) {
-Original file line number
+Diff line change
@@ Expand Up / @@ -20,7 +20,7 @@ abstract public function checkHeaders(CsvFile $csv): void; @@
         abstract public function dataTable(): DataTable;
-        public function __construct(private string $sourceFile)
+        public function __construct(private readonly string $sourceFile)
         {
         }
@@ Expand Down @@