Skip to content

15. Exercício prático – Versão 7

A versão 7 se baseia na versão 6, externalizando as constantes usadas nos scripts principais, a saber, os nomes dos arquivos de dados e a lista de arquivos PHP a carregar, em um arquivo de configuração. Como a versão 6, ela não contém nenhuma classe nova e usa as da versão 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

A pasta [Data] contém as descrições dos dois bancos de dados [dbtaxes-2019]: o banco de dados MySQL da versão 5 ([database-mysql.json]) e o banco de dados PostgreSQL da versão 6 ([database-pgsql.json]). Neste último arquivo, os nomes das tabelas não são mais prefixados com o esquema [public] (["tableBrackets": "tbbrackets"]).

15.1. Implementação

O arquivo de configuração é o seguinte arquivo 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"
    ]
}

Nesta configuração:

  • linhas 2–6: os caminhos de todos os arquivos JSON da aplicação. O banco de dados usado é o PostgreSQL;
  • linhas 7–20: os caminhos de todos os arquivos PHP da aplicação, na forma [chave => caminho]. Esses são os arquivos da versão 5;
  • linhas 21–32: as dependências para o cálculo do imposto, na forma de uma lista de chaves do dicionário [dependencies];
  • linhas 33–40: as dependências para a transferência dos dados do arquivo JSON [taxadmindata.json] para o banco de dados, no mesmo formato.

Todos os caminhos são relativos à pasta [version-07]. O curso de PHP 7 adicionava a esse arquivo uma chave chamada [rootDirectory], especificando o caminho absoluto da pasta da versão na máquina do autor (["C:/Data/st-2019/dev/php7/poly/scripts-console/impots/version-07"]): ela precisava ser modificada em cada nova máquina. Os scripts agora calculam esse caminho por conta própria com base na constante [__DIR__]. A pasta [php8-oct-2026] pode, portanto, ser colocada em qualquer lugar.

O script de transferência dos dados de administração fiscal para o banco de dados, [Main/MainTransferAdminDataFromJsonFile2Database.php], agora é o seguinte:

<?php

// respeito estrito aos tipos declarados dos parâmetros e resultados das funções
declare(strict_types=1);

// namespace
namespace Application;

// a pasta raiz da versão 7: os caminhos do arquivo de configuração são relativos a esta pasta
const ROOT_DIRECTORY = __DIR__ . "/..";
// caminho do arquivo de configuração
const CONFIG_FILENAME = ROOT_DIRECTORY . "/Data/config.json";

// recuperamos a configuração
$config = json_decode(file_get_contents(CONFIG_FILENAME), true, flags: JSON_THROW_ON_ERROR);

// incluímos as dependências necessárias ao script
foreach ($config["dependencies4transfer"] as $dependency) {
    require_once ROOT_DIRECTORY . "/" . $config["dependencies"][$dependency];
}

// os caminhos dos arquivos de dados
$databaseFilename = ROOT_DIRECTORY . "/" . $config["databaseFilename"];
$taxAdminDataFilename = ROOT_DIRECTORY . "/" . $config["taxAdminDataFilename"];

try {
    // criação da camada [dao]
    $dao = new DaoTransferAdminDataFromJsonFile2Database($databaseFilename, $taxAdminDataFilename);
    // transferência dos dados para o banco de dados
    $dao->transferAdminData2Database();
    print "The data of the tax administration have been transferred into the database described by [{$config["databaseFilename"]}]\n";
} catch (TaxException $ex) {
    // exibimos o erro
    print "Error no. {$ex->getCode()}: {$ex->getMessage()}\n";
}
// fim
print "Done\n";

Comentários

O código continua o mesmo da versão 6. A única diferença é o uso do arquivo [config.json] em vez das constantes:

  • Linha 10: o diretório raiz da versão 7, em relação ao qual os caminhos do arquivo de configuração são medidos. [__DIR__] é a pasta [Main] do script; [__DIR__ . "/.."] é sua pasta pai, [version-07];
  • linha 12: o caminho do arquivo de configuração;
  • linha 15: a função [file_get_contents] converte o arquivo [config.json] em uma string. A função [json_decode] usa então essa string para construir o array associativo [$config]. O segundo parâmetro, [true], da função [json_decode] especifica que se deseja um array associativo em vez de um objeto. Com a opção [JSON_THROW_ON_ERROR], um erro de sintaxe no arquivo dispara uma exceção [JsonException]. Não tentamos tratar aqui os erros de leitura do arquivo de configuração: esse arquivo faz parte da aplicação, e um erro nesse nível é um erro de programação que o próprio PHP reporta. Os erros de dados (arquivos de dados JSON, banco de dados) são sempre reportados por uma [TaxException];
  • linhas 18–20: as dependências exigidas pelo script de transferência são incluídas:
    • [$config["dependencies4transfer"]] é a tabela de dependências exigidas pelo script de transferência. É uma lista de chaves;
    • os caminhos dos arquivos a incluir estão no dicionário [$config["dependencies"]] e são prefixados com o diretório raiz. Por exemplo, a chave [TaxException] refere-se ao arquivo [version-07/../version-05/Entities/TaxException.php];
    • [require_once] (e não [require] como no curso de PHP 7) garante que um arquivo não seja carregado duas vezes, o que causaria o erro fatal "Cannot redeclare class … (previously declared in …)";
  • linhas 23–24: os caminhos completos dos arquivos de dados. O curso de PHP 7 os armazenava em constantes criadas pela função [define]. Variáveis são suficientes;
  • linha 31: o nome do arquivo que descreve o banco de dados em uso é exibido. Em uma string entre aspas duplas, o elemento de array [$config["databaseFilename"]] deve ser colocado entre chaves.

Resultados:

1
2
3
> php MainTransferAdminDataFromJsonFile2Database.php
The data of the tax administration have been transferred into the database described by [Data/database-pgsql.json]
Done

Da mesma forma, o script de cálculo do imposto passa a ser o seguinte [Main/MainCalculateTaxWithTaxAdminDataInDatabase.php]:

<?php

// respeito estrito aos tipos declarados dos parâmetros e resultados das funções
declare(strict_types=1);

// namespace
namespace Application;

// a pasta raiz da versão 7: os caminhos do arquivo de configuração são relativos a esta pasta
const ROOT_DIRECTORY = __DIR__ . "/..";
// caminho do arquivo de configuração
const CONFIG_FILENAME = ROOT_DIRECTORY . "/Data/config.json";

// recuperamos a configuração
$config = json_decode(file_get_contents(CONFIG_FILENAME), true, flags: JSON_THROW_ON_ERROR);

// incluímos as dependências necessárias ao script
foreach ($config["dependencies4calculate"] as $dependency) {
    require_once ROOT_DIRECTORY . "/" . $config["dependencies"][$dependency];
}

// os caminhos dos arquivos de dados
$databaseFilename = ROOT_DIRECTORY . "/" . $config["databaseFilename"];
$taxPayersDataFilename = ROOT_DIRECTORY . "/" . $config["taxPayersDataFilename"];
$resultsFilename = ROOT_DIRECTORY . "/" . $config["resultsFilename"];
$errorsFilename = ROOT_DIRECTORY . "/" . $config["errorsFilename"];

try {
    // criação da camada [dao]
    $dao = new DaoTaxWithTaxAdminDataInDatabase($databaseFilename);
    // criação da camada [business]
    $business = new Business($dao);
    // cálculo do imposto em modo batch
    $business->executeBatchTaxes($taxPayersDataFilename, $resultsFilename, $errorsFilename);
    print "The results have been saved in the file [{$config["resultsFilename"]}]\n";
} catch (TaxException $ex) {
    // exibimos o erro
    print "Error no. {$ex->getCode()}: {$ex->getMessage()}\n";
}
// fim
print "Done\n";
  • Linhas 18–20: desta vez, as dependências do cálculo do imposto são incluídas;
  • linhas 23–26: os caminhos dos arquivos JSON da aplicação;
  • linhas 28–39: o restante do código é o mesmo da versão 6.

Resultados:

1
2
3
> php MainCalculateTaxWithTaxAdminDataInDatabase.php
The results have been saved in the file [Data/results.json]
Done

O arquivo [Data/results.json] gerado é idêntico ao arquivo [results.json] das versões 5 e 6.

Os nomes dos dois scripts mudaram. No curso de PHP 7, eles faziam referência ao PostgreSQL ([MainTransferAdminDataFromFile2PostgresSQLDatabase.php], [MainCalculateImpotsWithTaxAdminDataInPostgresDatabase.php]). No entanto, esses scripts não dependem mais de nenhum SGBD específico: ele é selecionado pela chave [databaseFilename] do arquivo de configuração. Se você substituir ["Data/database-pgsql.json"] por ["Data/database-mysql.json"] nesse arquivo, o script de transferência usará o banco de dados MySQL sem alterar uma única linha de código PHP:

1
2
3
> php MainTransferAdminDataFromJsonFile2Database.php
The data of the tax administration have been transferred into the database described by [Data/database-mysql.json]
Done

Esse é o benefício de um arquivo de configuração: é possível adaptar a aplicação ao seu ambiente (SGBD, localização dos arquivos etc.) sem mexer no código. Voltaremos a ver esse arquivo de configuração nas próximas versões da aplicação.

15.2. Testes com [PHPUnit]

Esta versão, como as anteriores, é validada por testes [PHPUnit]. O ambiente deles também é construído com base no arquivo de configuração.

15.2.1. Teste da camada [dao]

Os testes da camada [dao] usarão as duas descrições de banco de dados da pasta [Data]: assim, usaremos os mesmos testes para verificar que a camada [dao] funciona tanto com o MySQL quanto com o PostgreSQL. O teste [Tests/DaoTest.php] é o seguinte:

<?php

// respeito estrito aos tipos declarados dos parâmetros e resultados das funções
declare(strict_types=1);

// namespace dos testes
namespace Application\Tests;

// as classes testadas
use Application\DaoTaxWithTaxAdminDataInDatabase;
use Application\DaoTransferAdminDataFromJsonFile2Database;
use Application\TaxAdminData;
// as classes do PHPUnit
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;

final class DaoTest extends TestCase
{
    // a pasta raiz da versão 7
    private const string ROOT_DIRECTORY = __DIR__ . "/..";
    // a configuração da aplicação
    private static array $config;

    // executado uma vez, antes do primeiro teste da classe
    #[\Override]
    public static function setUpBeforeClass(): void
    {
        // recuperamos a configuração
        self::$config = json_decode(file_get_contents(self::ROOT_DIRECTORY . "/Data/config.json"), true, flags: JSON_THROW_ON_ERROR);
        // incluímos as dependências do cálculo do imposto e as da transferência de dados
        $dependencies = array_unique([...self::$config["dependencies4calculate"], ...self::$config["dependencies4transfer"]]);
        foreach ($dependencies as $dependency) {
            require_once self::ROOT_DIRECTORY . "/" . self::$config["dependencies"][$dependency];
        }
    }

    // os dois bancos de dados
    public static function databases(): array
    {
        // [arquivo de descrição do banco de dados]
        return [
            "MySQL" => ["Data/database-mysql.json"],
            "PostgreSQL" => ["Data/database-pgsql.json"],
        ];
    }

    // os dados da administração tributária lidos do banco de dados
    #[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);
        // faixas de tributação
        $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);
    }

    // a transferência do arquivo JSON para o banco de dados, depois a releitura do banco de dados
    #[DataProvider("databases")]
    public function testTransfer(string $databaseFilename): void
    {
        // os arquivos JSON
        $databaseFilename = self::ROOT_DIRECTORY . "/$databaseFilename";
        $taxAdminDataFilename = self::ROOT_DIRECTORY . "/" . self::$config["taxAdminDataFilename"];
        // transferência
        (new DaoTransferAdminDataFromJsonFile2Database($databaseFilename, $taxAdminDataFilename))->transferAdminData2Database();
        // releitura do banco de dados por uma camada [dao]
        $dao = new DaoTaxWithTaxAdminDataInDatabase($databaseFilename);
        // o banco de dados contém os dados do arquivo JSON
        $this->assertEquals(TaxAdminData::fromJsonFile($taxAdminDataFilename), $dao->getTaxAdminData());
    }
}

Comentários

  • Linhas 10–12: as classes testadas são importadas. A instrução [use] não carrega as classes; ela apenas permite referir-se a elas por seus nomes curtos;
  • linha 22: a configuração da aplicação é armazenada em um atributo estático (de classe);
  • Linhas 26–35: o método estático [setUpBeforeClass] de [TestCase] é executado uma vez, antes do primeiro teste da classe. Ele lê o arquivo de configuração e carrega os arquivos da aplicação. O curso de PHP 7 realizava essa tarefa no nível superior do arquivo de teste, fora da classe. Com o PHPUnit, esse código é executado quando o PHPUnit carrega o arquivo, em um momento que não está sob nosso controle; o método [setUpBeforeClass] foi concebido para essa finalidade;
  • Linha 31: os testes da camada [dao] exigem dependências do cálculo do imposto (para a classe [DaoTaxWithTaxAdminDataInDatabase]) e da transferência (para a classe [DaoTransferAdminDataFromJsonFile2Database]). As duas listas são combinadas, e depois a função [array_unique] remove as duplicatas;
  • linhas 38–45: a fonte de dados: os arquivos de descrição dos dois bancos de dados;
  • linhas 48–49: o teste [testTaxAdminData] da versão 5 é executado uma vez para cada um dos dois bancos de dados;
  • linhas 71–83: o mesmo vale para o teste de transferência dos dados do arquivo JSON para o banco de dados.

15.2.2. Teste da camada [business]

O teste [Tests/BusinessTest.php] é o teste da versão 5 com um ambiente construído a partir do arquivo de configuração:

<?php

// respeito estrito aos tipos declarados dos parâmetros e resultados das funções
declare(strict_types=1);

// namespace dos testes
namespace Application\Tests;

// as classes testadas
use Application\DaoTaxWithTaxAdminDataInDatabase;
use Application\InterfaceBusiness;
use Application\Business;
// as classes do PHPUnit
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;

final class BusinessTest extends TestCase
{
    // a pasta raiz da versão 7
    private const string ROOT_DIRECTORY = __DIR__ . "/..";
    // a configuração da aplicação
    private static array $config;
    // a camada [business] testada
    private InterfaceBusiness $business;

    // executado uma vez, antes do primeiro teste da classe
    #[\Override]
    public static function setUpBeforeClass(): void
    {
        // recuperamos a configuração
        self::$config = json_decode(file_get_contents(self::ROOT_DIRECTORY . "/Data/config.json"), true, flags: JSON_THROW_ON_ERROR);
        // incluímos as dependências do cálculo do imposto
        foreach (self::$config["dependencies4calculate"] as $dependency) {
            require_once self::ROOT_DIRECTORY . "/" . self::$config["dependencies"][$dependency];
        }
    }

    // executado antes de cada teste
    #[\Override]
    protected function setUp(): void
    {
        // criação da camada [dao] sobre o banco de dados da configuração
        $dao = new DaoTaxWithTaxAdminDataInDatabase(self::ROOT_DIRECTORY . "/" . self::$config["databaseFilename"]);
        // criação da camada [business]
        $this->business = new Business($dao);
    }

Comentários

  • Linhas 28–36: o arquivo de configuração é lido e as dependências do cálculo do imposto são carregadas, exatamente como faz o script principal [MainCalculateTaxWithTaxAdminDataInDatabase];
  • Linha 43: a camada [dao] usa o banco de dados especificado pelo arquivo de configuração;
  • O data provider [taxpayers] e o método [testCalculateTax], não mostrados aqui, são os da versão 4.

15.2.3. Execução dos testes

Os dois SGBDs, MySQL e PostgreSQL, devem estar iniciados. Os resultados dos testes são os seguintes:

> 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)
  • linhas 12–15: os testes da camada [dao] foram executados com cada um dos dois bancos de dados;
  • linhas 18–28: os 11 testes da camada [business].

Concluímos agora as versões console da aplicação de cálculo do imposto. A versão 8 a transformará em uma aplicação cliente/servidor: o banco de dados e o cálculo do imposto residirão em um servidor web, consultado por clientes. Ela incorporará as classes da versão 5 e a técnica do arquivo de configuração da versão 7.