[Release] KaririCode Transformer v1.0.0 🚀

[walmir-silva]

Overview

This PR introduces the first stable release of KaririCode Transformer, a robust and flexible data transformation component for PHP applications. The component provides a comprehensive set of transformers for common data manipulation needs, with a focus on type safety and ease of use.

What's Included

Core Components

1. Base Infrastructure

   • Transform attribute for property-based transformations
   • Transformer service with registry integration
   • Abstract transformer processor with validation support
   • Comprehensive error handling and reporting

2. String Transformers

   • CaseTransformer (camel, snake, pascal, kebab)
   • MaskTransformer (phone, CPF, CNPJ)
   • SlugTransformer (URL-friendly strings)
   • TemplateTransformer (variable substitution)

3. Data Transformers

   • DateTransformer (format and timezone conversion)
   • NumberTransformer (locale-aware formatting)
   • JsonTransformer (encoding/decoding)

4. Array Transformers

   • ArrayFlattenTransformer (nested array flattening)
   • ArrayGroupTransformer (key-based grouping)
   • ArrayKeyTransformer (key case transformation)
   • ArrayMapTransformer (key mapping)

5. Composite Transformers

   • ChainTransformer (sequential transformations)
   • ConditionalTransformer (conditional processing)

Documentation

• Comprehensive README in English and Brazilian Portuguese
• Detailed usage examples with output samples
• Configuration guides for each transformer
• Real-world application examples
• Integration guides with other KaririCode components

Tests

• Unit tests for all transformers
• Integration tests for complex scenarios
• Type validation tests
• Error handling tests

Technical Details

Dependencies

• PHP 8.3+
• ext-mbstring
• ext-json
• kariricode/contract
• kariricode/processor-pipeline
• kariricode/property-inspector

Breaking Changes

• N/A (Initial Release)

Type Safety

• Strict type declarations throughout
• Property type validation
• Return type validation
• Configuration option validation

Testing Instructions

1. Install dependencies:

composer install

2. Run test suite:

make test

3. Check test coverage:

make coverage

Example Usage

class DataFormatter
{
    #[Transform(
        processors: ['date' => ['inputFormat' => 'd/m/Y', 'outputFormat' => 'Y-m-d']]
    )]
    private string $date = '25/12/2024';

    #[Transform(
        processors: ['number' => ['decimals' => 2, 'decimalPoint' => ',', 'thousandsSeparator' => '.']]
    )]
    private float $price = 1234.56;

    #[Transform(
        processors: ['mask' => ['type' => 'phone']]
    )]
    private string $phone = '11999887766';
}