KaririCode Framework: ProcessorPipeline Component

A robust and flexible component for creating and managing processing pipelines in the KaririCode Framework, providing advanced features for handling complex data processing tasks in PHP applications.

Table of Contents

• Features
• Installation
• Usage
  • Basic Usage
  • Advanced Usage
• Integration with Other KaririCode Components
• Development and Testing
• License
• Support and Community
• Acknowledgements

Features

• Easy creation and management of processing pipelines
• Support for both simple and configurable processors
• Context-based processor registry for organized processor management
• Seamless integration with other KaririCode components (Serializer, Validator, Normalizer)
• Extensible architecture allowing custom processors
• Built on top of the KaririCode\Contract interfaces for maximum flexibility

Installation

The ProcessorPipeline component can be easily installed via Composer, which is the recommended dependency manager for PHP projects.

To install the ProcessorPipeline component in your project, run the following command in your terminal:

composer require kariricode/processor-pipeline

This command will automatically add ProcessorPipeline to your project and install all necessary dependencies.

Requirements

• PHP 8.1 or higher
• Composer

Manual Installation

If you prefer not to use Composer, you can download the source code directly from the GitHub repository and include it manually in your project. However, we strongly recommend using Composer for easier dependency management and updates.

After installation, you can start using ProcessorPipeline in your PHP project immediately. Make sure to include the Composer autoloader in your script:

require_once 'vendor/autoload.php';

Usage

Basic Usage

1. Define your processors:

use KaririCode\Contract\Processor\Processor;

class EmailNormalizer implements Processor
{
    public function process(mixed $input): string
    {
        return strtolower(trim($input));
    }
}

class EmailValidator implements Processor
{
    public function process(mixed $input): bool
    {
        return false !== filter_var($input, FILTER_VALIDATE_EMAIL);
    }
}

2. Set up the processor registry and builder:

use KaririCode\ProcessorPipeline\ProcessorRegistry;
use KaririCode\ProcessorPipeline\ProcessorBuilder;

$registry = new ProcessorRegistry();
$registry->register('user', 'emailNormalizer', new EmailNormalizer());
$registry->register('user', 'emailValidator', new EmailValidator());

$builder = new ProcessorBuilder($registry);

3. Build and use a pipeline:

$pipeline = $builder->buildPipeline('user', ['emailNormalizer', 'emailValidator']);

$email = '  [email protected]  ';
$normalizedEmail = $pipeline->process($email);
$isValid = $pipeline->process($normalizedEmail);

echo "Normalized: $normalizedEmail\n";
echo "Valid: " . ($isValid ? 'Yes' : 'No') . "\n";

Advanced Usage

Configurable Processors

Create configurable processors for more flexibility:

use KaririCode\Contract\Processor\ConfigurableProcessor;

class AgeValidator implements ConfigurableProcessor
{
    private int $minAge = 0;
    private int $maxAge = 120;

    public function configure(array $options): void
    {
        if (isset($options['minAge'])) {
            $this->minAge = $options['minAge'];
        }
        if (isset($options['maxAge'])) {
            $this->maxAge = $options['maxAge'];
        }
    }

    public function process(mixed $input): bool
    {
        return is_numeric($input) && $input >= $this->minAge && $input <= $this->maxAge;
    }
}

$registry->register('user', 'ageValidator', new AgeValidator());
$pipeline = $builder->buildPipeline('user', ['ageValidator' => ['minAge' => 18, 'maxAge' => 100]]);

Integration with Other KaririCode Components

The ProcessorPipeline component is designed to work seamlessly with other KaririCode components:

• KaririCode\Serializer: Use processors to transform data before or after serialization.
• KaririCode\Validator: Create validation pipelines for complex data structures.
• KaririCode\Normalizer: Build normalization pipelines for data cleaning and standardization.

Example using ProcessorPipeline with Validator:

use KaririCode\Validator\Validators\EmailValidator;
use KaririCode\Validator\Validators\NotEmptyValidator;

$registry->register('validation', 'email', new EmailValidator());
$registry->register('validation', 'notEmpty', new NotEmptyValidator());

$validationPipeline = $builder->buildPipeline('validation', ['notEmpty', 'email']);

$isValid = $validationPipeline->process($userInput);

Development and Testing

For development and testing purposes, this package uses Docker and Docker Compose to ensure consistency across different environments. A Makefile is provided for convenience.

Prerequisites

• Docker
• Docker Compose
• Make (optional, but recommended for easier command execution)

Development Setup

1. Clone the repository:

   git clone https://github.com/KaririCode-Framework/kariricode-processor-pipeline.git
   cd kariricode-processor-pipeline

2. Set up the environment:

   make setup-env

3. Start the Docker containers:

   make up

4. Install dependencies:

   make composer-install

Available Make Commands

• make up: Start all services in the background
• make down: Stop and remove all containers
• make build: Build Docker images
• make shell: Access the PHP container shell
• make test: Run tests
• make coverage: Run test coverage with visual formatting
• make cs-fix: Run PHP CS Fixer to fix code style
• make quality: Run all quality commands (cs-check, test, security-check)

For a full list of available commands, run:

make help

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support and Community

• Documentation: https://kariricode.org/docs/processor-pipeline
• Issue Tracker: GitHub Issues
• Community: KaririCode Club Community

Acknowledgements

• The KaririCode Framework team and contributors.
• Inspired by pipeline patterns and processing chains in software architecture.

---

Built with ❤️ by the KaririCode team. Empowering developers to create more robust and flexible PHP applications.