Merge pull request #8 from eclipxe13/maintenance-2023-06-15

Versión 0.1.6 2023-06-17

Author: eclipxe13

.github/workflows/build.yml

@@ -1,5 +1,6 @@
 name: build
 on:
+  workflow_dispatch:
   pull_request:
     branches: [ "main" ]
   push:
@@ -21,9 +22,9 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.1'
+          php-version: '8.2'
           coverage: none
-          tools: composer:v2, cs2pr, phpcs
+          tools: cs2pr, phpcs
         env:
           fail-fast: true
       - name: Code style (phpcs)
@@ -38,9 +39,9 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.1'
+          php-version: '8.2'
           coverage: none
-          tools: composer:v2, cs2pr, php-cs-fixer
+          tools: cs2pr, php-cs-fixer
         env:
           fail-fast: true
       - name: Code style (php-cs-fixer)
@@ -55,14 +56,15 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.1'
+          php-version: '8.2'
           coverage: none
           tools: composer:v2, phpstan
         env:
           fail-fast: true
       - name: Get composer cache directory
         id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+        shell: bash
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
       - name: Cache dependencies
         uses: actions/cache@v3
         with:
@@ -109,7 +111,8 @@ jobs:
           sudo apt-get install -y poppler-utils
       - name: Get composer cache directory
         id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+        shell: bash
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
       - name: Cache dependencies
         uses: actions/cache@v3
         with:
@@ -119,4 +122,4 @@ jobs:
       - name: Install project dependencies
         run: composer upgrade --no-interaction --no-progress --prefer-dist
       - name: Tests (phpunit)
-        run: vendor/bin/phpunit --testdox --verbose
+        run: vendor/bin/phpunit --testdox --verbose

.github/workflows/sonarcloud.yml

@@ -1,5 +1,6 @@
 name: sonarcloud
 on:
+  workflow_dispatch:
   push:
     branches: [ "main" ]
 
@@ -18,7 +19,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.1'
+          php-version: '8.2'
           coverage: xdebug
           tools: composer:v2
         env:
@@ -29,7 +30,7 @@ jobs:
           sudo apt-get install -y poppler-utils
       - name: Get composer cache directory
         id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
       - name: Cache dependencies
         uses: actions/cache@v3
         with:
@@ -57,15 +58,15 @@ jobs:
         id: check-secrets
         run: |
           if [ -n "${{ secrets.GITHUB_TOKEN }}" ]; then
-            echo "::set-output name=github::yes"
+            echo "github=yes" >> $GITHUB_OUTPUT
           else
-            echo "::set-output name=github::no"
+            echo "github=no" >> $GITHUB_OUTPUT
             echo "::warning ::GITHUB_TOKEN non set"
           fi
           if [ -n "${{ secrets.SONAR_TOKEN }}" ]; then
-            echo "::set-output name=sonar::yes"
+            echo "sonar=yes" >> $GITHUB_OUTPUT
           else
-            echo "::set-output name=sonar::no"
+            echo "sonar=no" >> $GITHUB_OUTPUT
             echo "::warning ::SONAR_TOKEN non set"
           fi
 
@@ -82,12 +83,12 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.1'
+          php-version: '8.2'
           coverage: none
           tools: composer:v2
       - name: Get composer cache directory
         id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
       - name: Cache dependencies
         uses: actions/cache@v3
         with:

.phive/phars.xml

@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-  <phar name="phpstan" version="^1.8.11" installed="1.8.11" location="./tools/phpstan" 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="php-cs-fixer" version="^3.12.0" installed="3.12.0" location="./tools/php-cs-fixer" copy="false"/>
-  <phar name="composer-require-checker" version="^4.2.0" installed="4.2.0" location="./tools/composer-require-checker" copy="false"/>
+  <phar name="phpstan" version="^1.10.19" installed="1.10.19" location="./tools/phpstan" copy="false"/>
+  <phar name="phpcs" version="^3.7.2" installed="3.7.2" location="./tools/phpcs" copy="false"/>
+  <phar name="phpcbf" version="^3.7.2" installed="3.7.2" location="./tools/phpcbf" copy="false"/>
+  <phar name="php-cs-fixer" version="^3.17.0" installed="3.17.0" location="./tools/php-cs-fixer" copy="false"/>
+  <phar name="composer-require-checker" version="^4.6.0" installed="4.6.0" location="./tools/composer-require-checker" copy="false"/>
 </phive>

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contribuciones
 
-Las contribuciones son bienvenidas. Aceptamos *Pull Requests* en [el repositorio GitHub][homepage].
+Las contribuciones son bienvenidas. Aceptamos *Pull Requests* en [el repositorio GitHub][project].
 
 Este proyecto se apega al siguiente [Código de Conducta][coc].
 Al participar en este proyecto y en su comunidad, deberás seguir este código.

LICENCE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 PhpCfdi https://www.phpcfdi.com/
+Copyright (c) 2022 - 2023 PhpCfdi https://www.phpcfdi.com/
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -180,7 +180,7 @@ sin temor a romper tu aplicación.
 
 ## Contribuciones
 
-Las contribuciones con bienvenidas. Por favor lee [CONTRIBUTING][] para más detalles
+Las contribuciones son bienvenidas. Por favor lee [CONTRIBUTING][] para más detalles
 y recuerda revisar el archivo de tareas pendientes [TODO][] y el archivo [CHANGELOG][].
 
 ## Copyright and License
@@ -209,7 +209,7 @@ and licensed for use under the MIT License (MIT). Please see [LICENSE][] for mor
 [badge-discord]: https://img.shields.io/discord/459860554090283019?logo=discord
 [badge-release]: https://img.shields.io/github/release/phpcfdi/csf-scraper.svg?logo=git
 [badge-license]: https://img.shields.io/github/license/phpcfdi/csf-scraper.svg?logo=open-source-initiative
-[badge-build]: https://img.shields.io/github/workflow/status/phpcfdi/csf-scraper/build/main?logo=github-actions
+[badge-build]: https://img.shields.io/github/actions/workflow/status/phpcfdi/csf-scraper/build.yml?branch=main&logo=github-actions
 [badge-reliability]: https://sonarcloud.io/api/project_badges/measure?project=phpcfdi_csf-scraper&metric=reliability_rating
 [badge-maintainability]: https://sonarcloud.io/api/project_badges/measure?project=phpcfdi_csf-scraper&metric=sqale_rating
 [badge-coverage]: https://img.shields.io/sonar/coverage/phpcfdi_csf-scraper/main?logo=sonarcloud&server=https%3A%2F%2Fsonarcloud.io

docs/CHANGELOG.md

@@ -11,6 +11,24 @@ versión, aunque sí su incorporación en la rama principal de trabajo, generalm
 
 ## Listado de cambios
 
+### Versión 0.1.6 2023-06-17
+
+- Se agrega el método `Scraper::getClient()` para obtener el cliente con el que fue construido el objeto.
+- Se corrige el nombre del método `PdfToTextConvertException::getOutput`, antes `getGetOutput`.
+- Se actualiza el año de licencia.
+- Se corrige la liga del proyecto en el archivo `CONTRIBUTING.md`.
+- Se actualiza la insignia de construcción en el archivo `README.md`.
+- Se actualiza el archivo de configuración de SonarCloud para excluir correctamente los archivos en `tests/_files`.
+- Para los flujos de trabajo:
+  - Se permite ejecutarlos a petición.
+  - Los trabajos se ejecutan en PHP 8.0.
+  - No se instala `composer` cuando no es necesario.
+  - Se sustituye la directiva `::set-output` con `$GITHUB_OUTPUT`.
+- Se actualizan las herramientas de desarrollo.
+- En las pruebas:
+  - Se crean mejores casos para el manejo de excepciones provenientes de la lectura de un archivo PDF.
+  - Se consigue el 100% de cobertura de código.
+
 ### Versión 0.1.5 2022-10-28
 
 #### Regímenes que terminan en punto `.`

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>src</file>
     <file>tests</file>

sonar-project.properties

@@ -4,7 +4,7 @@ sonar.sourceEncoding=UTF-8
 sonar.language=php
 sonar.sources=src
 sonar.tests=tests
-sonar.exclusions=vendor/,tools/,build/,tests/_files/
+sonar.test.exclusions=tests/_files/**/*
 sonar.working.directory=build/.scannerwork
 sonar.php.tests.reportPath=build/sonar-junit.xml
 sonar.php.coverage.reportPaths=build/sonar-coverage.xml

src/Exceptions/PdfReader/PdfToTextConvertException.php

@@ -33,7 +33,7 @@ public function getExitCode(): int
         return $this->exitCode;
     }
 
-    public function getGetOutput(): string
+    public function getOutput(): string
     {
         return $this->output;
     }