15. Ejercicio práctico – Versión 7
La versión 7 se basa en la versión 6 y externaliza en un archivo de configuración las constantes utilizadas en los scripts principales, a saber, los nombres de los archivos de datos y la lista de archivos PHP que se deben cargar. Como la versión 6, no contiene clases nuevas y utiliza las de la versión 5:
| version-07
├── Data
│ ├── config.json
│ ├── database-mysql.json
│ ├── database-pgsql.json
│ ├── errors.json
│ ├── results.json
│ ├── taxadmindata.json
│ └── taxpayersdata.json
├── Main
│ ├── MainCalculateTaxWithTaxAdminDataInDatabase.php
│ └── MainTransferAdminDataFromJsonFile2Database.php
└── Tests
├── BusinessTest.php
└── DaoTest.php
|
La carpeta [Data] contiene las descripciones de las dos bases de datos [dbtaxes-2019]: la base de datos MySQL de la versión 5 ([database-mysql.json]) y la base de datos PostgreSQL de la versión 6 ([database-pgsql.json]). En este último archivo, los nombres de las tablas ya no llevan como prefijo el esquema [public] (["tableBrackets": "tbbrackets"]).
15.1. Implementación
El archivo de configuración es el siguiente archivo JSON [Data/config.json]:
| {
"databaseFilename": "Data/database-pgsql.json",
"taxAdminDataFilename": "Data/taxadmindata.json",
"taxPayersDataFilename": "Data/taxpayersdata.json",
"resultsFilename": "Data/results.json",
"errorsFilename": "Data/errors.json",
"dependencies": {
"TaxException": "../version-05/Entities/TaxException.php",
"TaxAdminData": "../version-05/Entities/TaxAdminData.php",
"TaxPayerData": "../version-05/Entities/TaxPayerData.php",
"Database": "../version-05/Entities/Database.php",
"Utilities": "../version-05/Utilities/Utilities.php",
"InterfaceDao": "../version-05/Dao/InterfaceDao.php",
"TraitDao": "../version-05/Dao/TraitDao.php",
"DaoTaxWithTaxAdminDataInDatabase": "../version-05/Dao/DaoTaxWithTaxAdminDataInDatabase.php",
"InterfaceDao4TransferAdminData2Database": "../version-05/Dao/InterfaceDao4TransferAdminData2Database.php",
"DaoTransferAdminDataFromJsonFile2Database": "../version-05/Dao/DaoTransferAdminDataFromJsonFile2Database.php",
"InterfaceBusiness": "../version-05/Business/InterfaceBusiness.php",
"Business": "../version-05/Business/Business.php"
},
"dependencies4calculate": [
"TaxException",
"TaxAdminData",
"TaxPayerData",
"Database",
"Utilities",
"InterfaceDao",
"TraitDao",
"DaoTaxWithTaxAdminDataInDatabase",
"InterfaceBusiness",
"Business"
],
"dependencies4transfer": [
"TaxException",
"TaxAdminData",
"Database",
"Utilities",
"InterfaceDao4TransferAdminData2Database",
"DaoTransferAdminDataFromJsonFile2Database"
]
}
|
En esta configuración:
- líneas 2–6: las rutas de todos los archivos JSON de la aplicación. La base de datos utilizada es PostgreSQL;
- líneas 7–20: las rutas de todos los archivos PHP de la aplicación, con el formato [key => path]. Son los archivos de la versión 5;
- líneas 21–32: las dependencias para el cálculo del impuesto, en forma de una lista de claves del diccionario [dependencies];
- líneas 33–40: las dependencias para transferir los datos del archivo JSON [taxadmindata.json] a la base de datos, con el mismo formato.
Todas las rutas son relativas a la carpeta [version-07]. El curso de PHP 7 agregaba a este archivo una clave llamada [rootDirectory], que especificaba la ruta absoluta de la carpeta de la versión en la máquina del autor (["C:/Data/st-2019/dev/php7/poly/scripts-console/impots/version-07"]): había que modificarla en cada máquina nueva. Ahora los scripts calculan por sí mismos la ruta de esta carpeta a partir de la constante [__DIR__]. Por lo tanto, la carpeta [php8-oct-2026] puede colocarse en cualquier lugar.
El script para transferir los datos de administración de impuestos a la base de datos, [Main/MainTransferAdminDataFromJsonFile2Database.php], ahora es el siguiente:
| <?php
// respeto estricto de los tipos declarados de los parámetros y resultados de las funciones
declare(strict_types=1);
// espacio de nombres
namespace Application;
// la carpeta raíz de la versión 7: las rutas del archivo de configuración son relativas a esta carpeta
const ROOT_DIRECTORY = __DIR__ . "/..";
// ruta del archivo de configuración
const CONFIG_FILENAME = ROOT_DIRECTORY . "/Data/config.json";
// recuperamos la configuración
$config = json_decode(file_get_contents(CONFIG_FILENAME), true, flags: JSON_THROW_ON_ERROR);
// incluimos las dependencias necesarias para el script
foreach ($config["dependencies4transfer"] as $dependency) {
require_once ROOT_DIRECTORY . "/" . $config["dependencies"][$dependency];
}
// las rutas de los archivos de datos
$databaseFilename = ROOT_DIRECTORY . "/" . $config["databaseFilename"];
$taxAdminDataFilename = ROOT_DIRECTORY . "/" . $config["taxAdminDataFilename"];
try {
// creación de la capa [dao]
$dao = new DaoTransferAdminDataFromJsonFile2Database($databaseFilename, $taxAdminDataFilename);
// transferencia de los datos a la base de datos
$dao->transferAdminData2Database();
print "The data of the tax administration have been transferred into the database described by [{$config["databaseFilename"]}]\n";
} catch (TaxException $ex) {
// mostramos el error
print "Error no. {$ex->getCode()}: {$ex->getMessage()}\n";
}
// fin
print "Done\n";
|
Comentarios
El código sigue siendo el mismo que en la versión 6. La única diferencia es el uso del archivo [config.json] en lugar de las constantes:
- Línea 10: el directorio raíz de la versión 7, respecto del cual se miden las rutas del archivo de configuración. [__DIR__] es la carpeta [Main] del script; [__DIR__ . "/.."] es su carpeta padre, [version-07];
- línea 12: la ruta del archivo de configuración;
- línea 15: la función [file_get_contents] convierte el archivo [config.json] en una cadena. Luego, la función [json_decode] usa esta cadena para construir el arreglo asociativo [$config]. El segundo parámetro, [true], de la función [json_decode] especifica que se desea un arreglo asociativo en lugar de un objeto. Con la opción [JSON_THROW_ON_ERROR], un error de sintaxis en el archivo provoca una excepción [JsonException]. Aquí no intentamos manejar los errores de lectura del archivo de configuración: este archivo forma parte de la aplicación, y un error en este nivel es un error de programación que PHP informa por sí mismo. Los errores de datos (archivos de datos JSON, base de datos) siempre los informa una [TaxException];
- líneas 18–20: se incluyen las dependencias requeridas por el script de transferencia:
- [$config["dependencies4transfer"]] es la tabla de dependencias requeridas por el script de transferencia. Es una lista de claves;
- las rutas de los archivos que se van a incluir se encuentran en el diccionario [$config["dependencies"]] y llevan como prefijo el directorio raíz. Por ejemplo, la clave [TaxException] hace referencia al archivo [version-07/../version-05/Entities/TaxException.php];
- [require_once] (y no [require] como en el curso de PHP 7) garantiza que un archivo no se cargue dos veces, lo que provocaría el error fatal “Cannot redeclare class … (previously declared in …)”;
- líneas 23–24: las rutas completas de los archivos de datos. El curso de PHP 7 las almacenaba en constantes creadas con la función [define]. Las variables son suficientes;
- línea 31: se muestra el nombre del archivo que describe la base de datos utilizada. En una cadena entre comillas, el elemento de arreglo [$config["databaseFilename"]] debe ir entre llaves.
Resultados:
| > php MainTransferAdminDataFromJsonFile2Database.php
The data of the tax administration have been transferred into the database described by [Data/database-pgsql.json]
Done
|
Del mismo modo, el script de cálculo del impuesto queda como el siguiente [Main/MainCalculateTaxWithTaxAdminDataInDatabase.php]:
| <?php
// respeto estricto de los tipos declarados de los parámetros y resultados de las funciones
declare(strict_types=1);
// espacio de nombres
namespace Application;
// la carpeta raíz de la versión 7: las rutas del archivo de configuración son relativas a esta carpeta
const ROOT_DIRECTORY = __DIR__ . "/..";
// ruta del archivo de configuración
const CONFIG_FILENAME = ROOT_DIRECTORY . "/Data/config.json";
// recuperamos la configuración
$config = json_decode(file_get_contents(CONFIG_FILENAME), true, flags: JSON_THROW_ON_ERROR);
// incluimos las dependencias necesarias para el script
foreach ($config["dependencies4calculate"] as $dependency) {
require_once ROOT_DIRECTORY . "/" . $config["dependencies"][$dependency];
}
// las rutas de los archivos de datos
$databaseFilename = ROOT_DIRECTORY . "/" . $config["databaseFilename"];
$taxPayersDataFilename = ROOT_DIRECTORY . "/" . $config["taxPayersDataFilename"];
$resultsFilename = ROOT_DIRECTORY . "/" . $config["resultsFilename"];
$errorsFilename = ROOT_DIRECTORY . "/" . $config["errorsFilename"];
try {
// creación de la capa [dao]
$dao = new DaoTaxWithTaxAdminDataInDatabase($databaseFilename);
// creación de la capa [business]
$business = new Business($dao);
// cálculo del impuesto en modo por lotes
$business->executeBatchTaxes($taxPayersDataFilename, $resultsFilename, $errorsFilename);
print "The results have been saved in the file [{$config["resultsFilename"]}]\n";
} catch (TaxException $ex) {
// mostramos el error
print "Error no. {$ex->getCode()}: {$ex->getMessage()}\n";
}
// fin
print "Done\n";
|
- Líneas 18–20: esta vez se incluyen las dependencias para el cálculo del impuesto;
- líneas 23–26: las rutas de los archivos JSON de la aplicación;
- líneas 28–39: el resto del código es el mismo que en la versión 6.
Resultados:
| > php MainCalculateTaxWithTaxAdminDataInDatabase.php
The results have been saved in the file [Data/results.json]
Done
|
El archivo [Data/results.json] generado es idéntico al archivo [results.json] de las versiones 5 y 6.
Los nombres de los dos scripts han cambiado. En el curso de PHP 7, hacían referencia a PostgreSQL ([MainTransferAdminDataFromFile2PostgresSQLDatabase.php], [MainCalculateImpotsWithTaxAdminDataInPostgresDatabase.php]). Sin embargo, estos scripts ya no dependen de ningún SGBD específico: este se selecciona mediante la clave [databaseFilename] del archivo de configuración. Si en ese archivo reemplaza ["Data/database-pgsql.json"] por ["Data/database-mysql.json"] , el script de transferencia utilizará la base de datos MySQL sin cambiar una sola línea de código PHP:
| > php MainTransferAdminDataFromJsonFile2Database.php
The data of the tax administration have been transferred into the database described by [Data/database-mysql.json]
Done
|
Este es el beneficio de un archivo de configuración: se puede adaptar la aplicación a su entorno (SGBD, ubicación de los archivos, etc.) sin tocar el código. Volveremos a ver este archivo de configuración en las próximas versiones de la aplicación.
15.2. Pruebas con [PHPUnit]
Esta versión, como las anteriores, se valida con pruebas [PHPUnit]. Su entorno también se construye a partir del archivo de configuración.
15.2.1. Prueba de la capa [dao]
Las pruebas de la capa [dao] utilizarán las dos descripciones de bases de datos de la carpeta [Data]: así, usaremos las mismas pruebas para verificar que la capa [dao] funciona tanto con MySQL como con PostgreSQL. La prueba [Tests/DaoTest.php] es la siguiente:
| <?php
// respeto estricto de los tipos declarados de los parámetros y resultados de las funciones
declare(strict_types=1);
// espacio de nombres de las pruebas
namespace Application\Tests;
// las clases probadas
use Application\DaoTaxWithTaxAdminDataInDatabase;
use Application\DaoTransferAdminDataFromJsonFile2Database;
use Application\TaxAdminData;
// las clases de PHPUnit
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
final class DaoTest extends TestCase
{
// la carpeta raíz de la versión 7
private const string ROOT_DIRECTORY = __DIR__ . "/..";
// la configuración de la aplicación
private static array $config;
// se ejecuta una vez, antes de la primera prueba de la clase
#[\Override]
public static function setUpBeforeClass(): void
{
// recuperamos la configuración
self::$config = json_decode(file_get_contents(self::ROOT_DIRECTORY . "/Data/config.json"), true, flags: JSON_THROW_ON_ERROR);
// incluimos las dependencias del cálculo del impuesto y las de la transferencia de datos
$dependencies = array_unique([...self::$config["dependencies4calculate"], ...self::$config["dependencies4transfer"]]);
foreach ($dependencies as $dependency) {
require_once self::ROOT_DIRECTORY . "/" . self::$config["dependencies"][$dependency];
}
}
// las dos bases de datos
public static function databases(): array
{
// [archivo de descripción de la base de datos]
return [
"MySQL" => ["Data/database-mysql.json"],
"PostgreSQL" => ["Data/database-pgsql.json"],
];
}
// los datos de la administración tributaria leídos de la base de datos
#[DataProvider("databases")]
public function testTaxAdminData(string $databaseFilename): void
{
$dao = new DaoTaxWithTaxAdminDataInDatabase(self::ROOT_DIRECTORY . "/$databaseFilename");
$taxAdminData = $dao->getTaxAdminData();
// constantes de cálculo
$this->assertSame(1551.0, $taxAdminData->halfShareQfCeiling);
$this->assertSame(21037.0, $taxAdminData->singleIncomeCeilingForReduction);
$this->assertSame(42074.0, $taxAdminData->coupleIncomeCeilingForReduction);
$this->assertSame(3797.0, $taxAdminData->halfShareReductionValue);
$this->assertSame(1196.0, $taxAdminData->singleDiscountCeiling);
$this->assertSame(1970.0, $taxAdminData->coupleDiscountCeiling);
$this->assertSame(1595.0, $taxAdminData->singleTaxCeilingForDiscount);
$this->assertSame(2627.0, $taxAdminData->coupleTaxCeilingForDiscount);
$this->assertSame(12502.0, $taxAdminData->tenPercentAllowanceMax);
$this->assertSame(437.0, $taxAdminData->tenPercentAllowanceMin);
// tramos del impuesto
$this->assertSame([9964.0, 27519.0, 73779.0, 156244.0, 0.0], $taxAdminData->limits);
$this->assertSame([0.0, 0.14, 0.30, 0.41, 0.45], $taxAdminData->coeffR);
$this->assertSame([0.0, 1394.96, 5798.0, 13913.69, 20163.45], $taxAdminData->coeffN);
}
// la transferencia del archivo JSON a la base de datos, y luego la relectura de la base de datos
#[DataProvider("databases")]
public function testTransfer(string $databaseFilename): void
{
// los archivos JSON
$databaseFilename = self::ROOT_DIRECTORY . "/$databaseFilename";
$taxAdminDataFilename = self::ROOT_DIRECTORY . "/" . self::$config["taxAdminDataFilename"];
// transferencia
(new DaoTransferAdminDataFromJsonFile2Database($databaseFilename, $taxAdminDataFilename))->transferAdminData2Database();
// relectura de la base de datos por una capa [dao]
$dao = new DaoTaxWithTaxAdminDataInDatabase($databaseFilename);
// la base de datos contiene los datos del archivo JSON
$this->assertEquals(TaxAdminData::fromJsonFile($taxAdminDataFilename), $dao->getTaxAdminData());
}
}
|
Comentarios
- Líneas 10–12: se importan las clases probadas. La instrucción [use] no carga las clases; solo permite referirse a ellas por sus nombres cortos;
- línea 22: la configuración de la aplicación se almacena en un atributo estático (de clase);
- Líneas 26–35: el método estático [setUpBeforeClass] de [TestCase] se ejecuta una sola vez, antes de la primera prueba de la clase. Lee el archivo de configuración y carga los archivos de la aplicación. El curso de PHP 7 realizaba esta tarea en el nivel superior del archivo de prueba, fuera de la clase. Con PHPUnit, este código se ejecuta cuando PHPUnit carga el archivo, en un momento que no controlamos; el método [setUpBeforeClass] está diseñado para este fin;
- Línea 31: las pruebas de la capa [dao] requieren las dependencias del cálculo del impuesto (para la clase [DaoTaxWithTaxAdminDataInDatabase]) y de la transferencia (para la clase [DaoTransferAdminDataFromJsonFile2Database]). Las dos listas se combinan y luego la función [array_unique] elimina los duplicados;
- líneas 38–45: la fuente de datos: los archivos de descripción de las dos bases de datos;
- líneas 48–49: la prueba [testTaxAdminData] de la versión 5 se ejecuta una vez para cada una de las dos bases de datos;
- líneas 71–83: lo mismo se aplica a la prueba de transferencia de datos del archivo JSON a la base de datos.
15.2.2. Prueba de la capa [business]
La prueba [Tests/BusinessTest.php] es la de la versión 5 con un entorno construido a partir del archivo de configuración:
| <?php
// respeto estricto de los tipos declarados de los parámetros y resultados de las funciones
declare(strict_types=1);
// espacio de nombres de las pruebas
namespace Application\Tests;
// las clases probadas
use Application\DaoTaxWithTaxAdminDataInDatabase;
use Application\InterfaceBusiness;
use Application\Business;
// las clases de PHPUnit
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
final class BusinessTest extends TestCase
{
// la carpeta raíz de la versión 7
private const string ROOT_DIRECTORY = __DIR__ . "/..";
// la configuración de la aplicación
private static array $config;
// la capa [business] probada
private InterfaceBusiness $business;
// se ejecuta una vez, antes de la primera prueba de la clase
#[\Override]
public static function setUpBeforeClass(): void
{
// recuperamos la configuración
self::$config = json_decode(file_get_contents(self::ROOT_DIRECTORY . "/Data/config.json"), true, flags: JSON_THROW_ON_ERROR);
// incluimos las dependencias del cálculo del impuesto
foreach (self::$config["dependencies4calculate"] as $dependency) {
require_once self::ROOT_DIRECTORY . "/" . self::$config["dependencies"][$dependency];
}
}
// se ejecuta antes de cada prueba
#[\Override]
protected function setUp(): void
{
// creación de la capa [dao] sobre la base de datos de la configuración
$dao = new DaoTaxWithTaxAdminDataInDatabase(self::ROOT_DIRECTORY . "/" . self::$config["databaseFilename"]);
// creación de la capa [business]
$this->business = new Business($dao);
}
|
Comentarios
- Líneas 28–36: se lee el archivo de configuración y se cargan las dependencias para el cálculo del impuesto, igual que lo hace el script principal [MainCalculateTaxWithTaxAdminDataInDatabase];
- Línea 43: la capa [dao] utiliza la base de datos especificada en el archivo de configuración;
- El proveedor de datos [taxpayers] y el método [testCalculateTax], que no se muestran aquí, son los de la versión 4.
15.2.3. Ejecución de las pruebas
Deben estar iniciados los dos SGBD, MySQL y PostgreSQL. Los resultados de las pruebas son los siguientes:
| > php vendor/bin/phpunit scripts-console/tax/version-07/Tests --testdox
PHPUnit 12.5.37 by Sebastian Bergmann and contributors.
Runtime: PHP 8.5.11
Configuration: .../php8-oct-2026/phpunit.xml
............... 15 / 15 (100%)
Time: 00:00.602, Memory: 16.00 MB
Business (Application\Tests\Business)
✔ Calculate tax with data set "couple, 2 children, 55555"
✔ Calculate tax with data set "couple, 2 children, 50000"
✔ Calculate tax with data set "couple, 3 children, 50000"
✔ Calculate tax with data set "single, 2 children, 100000"
✔ Calculate tax with data set "single, 3 children, 100000"
✔ Calculate tax with data set "couple, 3 children, 100000"
✔ Calculate tax with data set "couple, 5 children, 100000"
✔ Calculate tax with data set "single, 0 children, 100000"
✔ Calculate tax with data set "couple, 2 children, 30000"
✔ Calculate tax with data set "single, 0 children, 200000"
✔ Calculate tax with data set "couple, 3 children, 200000"
Dao (Application\Tests\Dao)
✔ Tax admin data with data set "MySQL"
✔ Tax admin data with data set "PostgreSQL"
✔ Transfer with data set "MySQL"
✔ Transfer with data set "PostgreSQL"
OK (15 tests, 50 assertions)
|
- líneas 12–15: las pruebas de la capa [dao] se ejecutaron con cada una de las dos bases de datos;
- líneas 18–28: las 11 pruebas de la capa [business].
Hemos terminado las versiones de consola de la aplicación de cálculo del impuesto. La versión 8 la transformará en una aplicación cliente/servidor: la base de datos y el cálculo del impuesto residirán en un servidor web, consultado por los clientes. Incorporará las clases de la versión 5 y la técnica del archivo de configuración de la versión 7.