Merge pull request #2 from KaririCode-Framework/develop

Enhance Dotenv Component: Improved Parsing, Type Detection, and Unit Tests

Author: walmir-silva

.gitignore

@@ -63,3 +63,4 @@ tests/lista_de_arquivos.php
 tests/lista_de_arquivos_test.php
 lista_de_arquivos.txt
 lista_de_arquivos_tests.txt
+add_static_to_providers.php

README.md

@@ -1,11 +1,8 @@
 # KaririCode Framework: Dotenv Component
 
-[![en](https://img.shields.io/badge/lang-en-red.svg)](README.md)
-[![pt-br](https://img.shields.io/badge/lang-pt--br-green.svg)](README.pt-br.md)
+[![en](https://img.shields.io/badge/lang-en-red.svg)](README.md) [![pt-br](https://img.shields.io/badge/lang-pt--br-green.svg)](README.pt-br.md)
 
-![PHP](https://img.shields.io/badge/PHP-777BB4?style=for-the-badge&logo=php&logoColor=white)
-![Docker](https://img.shields.io/badge/Docker-2496ED?style=for-the-badge&logo=docker&logoColor=white)
-![PHPUnit](https://img.shields.io/badge/PHPUnit-3776AB?style=for-the-badge&logo=php&logoColor=white)
+![PHP](https://img.shields.io/badge/PHP-777BB4?style=for-the-badge&logo=php&logoColor=white) ![Docker](https://img.shields.io/badge/Docker-2496ED?style=for-the-badge&logo=docker&logoColor=white) ![PHPUnit](https://img.shields.io/badge/PHPUnit-3776AB?style=for-the-badge&logo=php&logoColor=white)
 
 A robust and flexible environment variable management component for the KaririCode Framework, providing advanced features for handling .env files in PHP applications.
 

README.pt-br.md

@@ -1,31 +1,28 @@
 # KaririCode Framework: Componente Dotenv
 
-[![en](https://img.shields.io/badge/lang-en-red.svg)](README.md)
-[![pt-br](https://img.shields.io/badge/lang-pt--br-green.svg)](README.pt-br.md)
+[![en](https://img.shields.io/badge/lang-en-red.svg)](README.md) [![pt-br](https://img.shields.io/badge/lang-pt--br-green.svg)](README.pt-br.md)
 
-![PHP](https://img.shields.io/badge/PHP-777BB4?style=for-the-badge&logo=php&logoColor=white)
-![Docker](https://img.shields.io/badge/Docker-2496ED?style=for-the-badge&logo=docker&logoColor=white)
-![PHPUnit](https://img.shields.io/badge/PHPUnit-3776AB?style=for-the-badge&logo=php&logoColor=white)
+![PHP](https://img.shields.io/badge/PHP-777BB4?style=for-the-badge&logo=php&logoColor=white) ![Docker](https://img.shields.io/badge/Docker-2496ED?style=for-the-badge&logo=docker&logoColor=white) ![PHPUnit](https://img.shields.io/badge/PHPUnit-3776AB?style=for-the-badge&logo=php&logoColor=white)
 
-Um componente robusto e flexível para gerenciamento de variáveis de ambiente do KaririCode Framework, fornecendo recursos avançados para manipulação de arquivos .env em aplicações PHP.
+Um componente robusto e flexível para gerenciamento de variáveis de ambiente no KaririCode Framework, fornecendo recursos avançados para lidar com arquivos .env em aplicações PHP.
 
-## Características
+## Funcionalidades
 
-- Análise e carregamento de variáveis de ambiente a partir de arquivos .env
+- Parse e carregamento de variáveis de ambiente a partir de arquivos .env
 - Suporte para interpolação de variáveis
 - **Detecção e conversão automática de tipos**
   - Detecta e converte tipos comuns (string, inteiro, float, booleano, array, JSON)
-  - Preserva os tipos de dados para uso mais preciso em sua aplicação
+  - Preserva tipos de dados para uso mais preciso em sua aplicação
 - **Sistema de tipos personalizável**
   - Extensível com detectores e conversores de tipos personalizados
   - Controle refinado sobre como suas variáveis de ambiente são processadas
 - Modo estrito para validação de nomes de variáveis
-- Fácil acesso às variáveis de ambiente através de uma função auxiliar global
+- Acesso fácil às variáveis de ambiente por meio de uma função auxiliar global
 - Suporte para estruturas de dados complexas (arrays e JSON) em variáveis de ambiente
 
 ## Instalação
 
-Para instalar o componente Dotenv do KaririCode em seu projeto, execute o seguinte comando:
+Para instalar o componente Dotenv do KaririCode no seu projeto, execute o seguinte comando:
 
 ```bash
 composer require kariricode/dotenv
@@ -46,10 +43,10 @@ KARIRI_APP_DEBUG=true
 KARIRI_APP_URL=https://kariricode.com
 KARIRI_MAIL_FROM_NAME="${KARIRI_APP_NAME}"
 KARIRI_JSON_CONFIG={"key": "value", "nested": {"subkey": "subvalue"}}
-KARIRI_ARRAY_CONFIG=["item1", "item2", "item com espaços"]
+KARIRI_ARRAY_CONFIG=["item1", "item2", "item with spaces"]
 ```
 
-2. No arquivo de inicialização da sua aplicação:
+2. No arquivo de bootstrap da sua aplicação:
 
 ```php
 <?php
@@ -84,28 +81,28 @@ O componente Dotenv do KaririCode detecta e converte automaticamente os seguinte
 Exemplo:
 
 ```env
-STRING_VAR=Olá Mundo
+STRING_VAR=Hello World
 INT_VAR=42
 FLOAT_VAR=3.14
 BOOL_VAR=true
 NULL_VAR=null
 ARRAY_VAR=["item1", "item2", "item3"]
-JSON_VAR={"chave": "valor", "aninhado": {"subchave": "subvalor"}}
+JSON_VAR={"key": "value", "nested": {"subkey": "subvalue"}}
 ```
 
-Quando acessadas usando a função `env()`, estas variáveis serão automaticamente convertidas para seus tipos PHP apropriados:
+Quando acessadas usando a função `env()`, essas variáveis serão automaticamente convertidas para seus tipos PHP apropriados:
 
 ```php
-$stringVar = env('STRING_VAR'); // string: "Olá Mundo"
+$stringVar = env('STRING_VAR'); // string: "Hello World"
 $intVar = env('INT_VAR');       // inteiro: 42
 $floatVar = env('FLOAT_VAR');   // float: 3.14
 $boolVar = env('BOOL_VAR');     // booleano: true
 $nullVar = env('NULL_VAR');     // null
 $arrayVar = env('ARRAY_VAR');   // array: ["item1", "item2", "item3"]
-$jsonVar = env('JSON_VAR');     // array: ["chave" => "valor", "aninhado" => ["subchave" => "subvalor"]]
+$jsonVar = env('JSON_VAR');     // array: ["key" => "value", "nested" => ["subkey" => "subvalue"]]
 ```
 
-Esta tipagem automática garante que você esteja trabalhando com os tipos de dados corretos em sua aplicação, reduzindo erros relacionados a tipos e melhorando a confiabilidade geral do código.
+Essa tipagem automática garante que você esteja trabalhando com os tipos corretos em sua aplicação, reduzindo erros relacionados a tipos e melhorando a confiabilidade geral do código.
 
 ### Uso Avançado
 
@@ -116,18 +113,18 @@ Crie detectores de tipo personalizados para lidar com formatos específicos:
 ```php
 use KaririCode\Dotenv\Type\Detector\AbstractTypeDetector;
 
-class DetectorPersonalizado extends AbstractTypeDetector
+class CustomDetector extends AbstractTypeDetector
 {
     public const PRIORITY = 100;
 
     public function detect(mixed $value): ?string
     {
         // Sua lógica de detecção aqui
-        // Retorne o tipo detectado como uma string, ou null se não for detectado
+        // Retorne o tipo detectado como uma string, ou null se não detectado
     }
 }
 
-$dotenv->addTypeDetector(new DetectorPersonalizado());
+$dotenv->addTypeDetector(new CustomDetector());
 ```
 
 #### Conversores de Tipo Personalizados
@@ -137,20 +134,20 @@ Crie conversores de tipo personalizados para lidar com tipos de dados específic
 ```php
 use KaririCode\Dotenv\Contract\TypeCaster;
 
-class ConversorPersonalizado implements TypeCaster
+class CustomCaster implements TypeCaster
 {
     public function cast(mixed $value): mixed
     {
         // Sua lógica de conversão aqui
     }
 }
 
-$dotenv->addTypeCaster('tipo_personalizado', new ConversorPersonalizado());
+$dotenv->addTypeCaster('custom_type', new CustomCaster());
 ```
 
 ## Desenvolvimento e Testes
 
-Para fins de desenvolvimento e testes, este pacote usa Docker e Docker Compose para garantir consistência em diferentes ambientes. Um Makefile é fornecido para facilitar a execução de comandos.
+Para fins de desenvolvimento e teste, este pacote utiliza Docker e Docker Compose para garantir consistência entre diferentes ambientes. Um Makefile é fornecido para conveniência.
 
 ### Pré-requisitos
 
@@ -173,7 +170,7 @@ Para fins de desenvolvimento e testes, este pacote usa Docker e Docker Compose p
    make setup-env
    ```
 
-3. Inicie os contêineres Docker:
+3. Inicie os containers Docker:
 
    ```bash
    make up
@@ -187,23 +184,23 @@ Para fins de desenvolvimento e testes, este pacote usa Docker e Docker Compose p
 ### Comandos Make Disponíveis
 
 - `make up`: Inicia todos os serviços em segundo plano
-- `make down`: Para e remove todos os contêineres
+- `make down`: Para e remove todos os containers
 - `make build`: Constrói as imagens Docker
-- `make shell`: Acessa o shell do contêiner PHP
+- `make shell`: Acessa o shell do container PHP
 - `make test`: Executa os testes
 - `make coverage`: Executa a cobertura de testes com formatação visual
 - `make cs-fix`: Executa o PHP CS Fixer para corrigir o estilo do código
 - `make quality`: Executa todos os comandos de qualidade (cs-check, test, security-check)
 
-Para uma lista completa dos comandos disponíveis, execute:
+Para uma lista completa de comandos disponíveis, execute:
 
 ```bash
 make help
 ```
 
 ## Licença
 
-Este projeto está licenciado sob a Licença MIT - veja o arquivo [LICENSE](LICENSE) para detalhes.
+Este projeto está licenciado sob a Licença MIT - veja o arquivo [LICENSE](LICENSE) para mais detalhes.
 
 ## Suporte e Comunidade
 
@@ -214,15 +211,8 @@ Este projeto está licenciado sob a Licença MIT - veja o arquivo [LICENSE](LICE
 ## Agradecimentos
 
 - A equipe do KaririCode Framework e contribuidores.
-- Inspirado por outras bibliotecas PHP Dotenv populares.
+- Inspirado por outras bibliotecas populares de Dotenv para PHP.
 
 ---
 
-## Agradecimentos
-
-- A equipe do KaririCode Framework e contribuidores.
-- Inspirado por outras bibliotecas PHP Dotenv populares.
-
----
-
-Construído com ❤️ pela equipe KaririCode. Capacitando desenvolvedores para construir aplicações PHP mais robustas e flexíveis.
+Construído com ❤️ pela equipe KaririCode. Capacitando desenvolvedores a criar aplicações PHP mais robustas e flexíveis.

create_structure.php

@@ -0,0 +1,46 @@
+<?php
+
+$structure = [
+    'tests/Unit/Contract' => ['DotenvTest.php'],
+    'tests/Unit/Loader' => ['ArrayLoaderTest.php', 'FileLoaderTest.php'],
+    'tests/Unit/Parser' => ['DefaultParserTest.php', 'StrictParserTest.php'],
+    'tests/Unit/Type/Caster' => [
+        'ArrayCasterTest.php',
+        'BooleanCasterTest.php',
+        'FloatCasterTest.php',
+        'IntegerCasterTest.php',
+        'JsonCasterTest.php',
+        'NullCasterTest.php',
+        'StringCasterTest.php',
+        'TypeCasterRegistryTest.php'
+    ],
+    'tests/Unit/Type/Detector' => [
+        'ArrayDetectorTest.php',
+        'BooleanDetectorTest.php',
+        'JsonDetectorTest.php',
+        'NullDetectorTest.php',
+        'NumericDetectorTest.php',
+        'StringDetectorTest.php',
+        'TypeDetectorRegistryTest.php'
+    ],
+    'tests/Unit' => ['DotenvTest.php', 'DotenvFactoryTest.php'],
+    'tests/Integration' => ['DotenvIntegrationTest.php', 'TypeSystemIntegrationTest.php'],
+    'tests/Functional' => ['DotenvFunctionalTest.php']
+];
+
+foreach ($structure as $dir => $files) {
+    // Cria o diretório, caso não exista
+    if (!is_dir($dir)) {
+        mkdir($dir, 0777, true);
+        echo "Diretório criado: $dir\n";
+    }
+
+    // Cria os arquivos dentro do diretório
+    foreach ($files as $file) {
+        $filePath = $dir . '/' . $file;
+        file_put_contents($filePath, "<?php\n\n// Test case for $file\n");
+        echo "Arquivo criado: $filePath\n";
+    }
+}
+
+echo "Estrutura de diretórios e arquivos criada com sucesso!\n";

docker-compose.yml

@@ -1,5 +1,3 @@
-version: "3.8"
-
 services:
   php:
     container_name: kariricode-dotenv

phpunit.xml

@@ -12,7 +12,8 @@
          colors="true">
         <php>
         <ini name="error_reporting" value="-1" />
-        <ini name="display_errors" value="1" />
+        <ini name="display_errors" value="On" />
+        <ini name="display_startup_errors" value="On" />
         <env name="KERNEL_CLASS" value="HeliusTelemetry\Tests\TestKernel"/>
         <env name="SYMFONY_DEPRECATIONS_HELPER" value="disabled"/>
         <server name="APP_ENV" value="test" force="true" />

src/Dotenv.php

@@ -25,15 +25,17 @@ public function load(): void
         $content = $this->loader->load();
         $parsed = $this->parser->parse($content);
 
-        foreach ($parsed as $key => $value) {
-            $processedValue = $this->typeSystem->processValue($value);
-            $this->setEnvironmentVariable($key, $processedValue);
+        if (!empty($parsed)) {
+            foreach ($parsed as $key => $value) {
+                $processedValue = $this->typeSystem->processValue($value);
+                $this->setEnvironmentVariable($key, $processedValue);
+            }
         }
     }
 
-    public function addTypeDetector(TypeDetector $caster): self
+    public function addTypeDetector(TypeDetector $detector): self
     {
-        $this->typeSystem->registerDetector($caster);
+        $this->typeSystem->registerDetector($detector);
 
         return $this;
     }

src/DotenvFactory.php

@@ -6,12 +6,13 @@
 
 use KaririCode\Dotenv\Loader\FileLoader;
 use KaririCode\Dotenv\Parser\DefaultParser;
+use KaririCode\Dotenv\Parser\StrictParser;
 
 class DotenvFactory
 {
     public static function create(string $path, bool $strict = false): Dotenv
     {
-        $parser = new DefaultParser($strict);
+        $parser = $strict ? new StrictParser() : new DefaultParser();
         $loader = new FileLoader($path);
 
         return new Dotenv($parser, $loader);

src/Loader/FileLoader.php

@@ -18,11 +18,11 @@ public function __construct(string $filePath)
 
     public function load(): string
     {
-        if (!$this->isFileReadable($this->filePath)) {
-            throw new InvalidFileException(sprintf('Unable to read the environment file at %s.', $this->filePath));
+        if (!file_exists($this->filePath)) {
+            throw new InvalidFileException(sprintf('The environment file %s does not exist.', $this->filePath));
         }
 
-        $contents = file_get_contents($this->filePath);
+        $contents = $this->getFileContents($this->filePath);
 
         if (false === $contents) {
             throw new InvalidFileException(sprintf('Unable to read the environment file at %s.', $this->filePath));
@@ -31,8 +31,8 @@ public function load(): string
         return $contents;
     }
 
-    private function isFileReadable(string $filePath): bool
+    protected function getFileContents(string $filePath): string|false
     {
-        return is_readable($filePath) && is_file($filePath);
+        return file_get_contents($filePath);
     }
 }