ergebnis/data-generator

Provides data generators.

1.0.0 2023-12-30 20:28 UTC

Requires

• php: ~8.1.0 || ~8.2.0 || ~8.3.0

Requires (Dev)

• ergebnis/composer-normalize: ^2.41.1
• ergebnis/data-provider: ^3.2.0
• ergebnis/license: ^2.4.0
• ergebnis/php-cs-fixer-config: ^6.17.0
• ergebnis/phpunit-slow-test-detector: ^2.9.0
• fakerphp/faker: ^1.23.0
• infection/infection: ~0.27.9
• phpunit/phpunit: ^10.5.5
• psalm/plugin-phpunit: ~0.18.4
• rector/rector: ~0.18.13
• roave/backward-compatibility-check: ^8.6.0
• vimeo/psalm: ^5.18.0

MIT

• Andreas Möller

README

This project provides a composer package with data generators.

Installation

Run

composer require ergebnis/data-generator

Usage

This project comes with the following data generators:

• Ergebnis\DataGenerator\ConcatenatingValueGenerator
• Ergebnis\DataGenerator\OptionalValueGenerator
• Ergebnis\DataGenerator\SequentialValueGenerator
• Ergebnis\DataGenerator\ValueGenerator

ConcatenatingValueGenerator

Use the ConcatenatingValueGenerator to generate values by concatenating values generated from one or more StringGenerators:

<?php

declare(strict_types=1);

use Ergebnis\DataGenerator;

$generator = new DataGenerator\ConcatenatingValueGenerator(
    new DataGenerator\ValueGenerator(
        'foo',
        'bar',
        'baz',
    ),
    new DataGenerator\ValueGenerator('-'),
    new DataGenerator\ValueGenerator(
        'qux',
        'quux',
    ),
);

foreach ($generator->generate() as $value) {
    echo $value . PHP_EOL
}

// foo-qux
// foo-quux
// bar-qux
// bar-quux
// baz-qux
// baz-quux

OptionalValueGenerator

Use the OptionalValueGenerator to generate an empty string and one or more values from a list of string values:

<?php

declare(strict_types=1);

use Ergebnis\DataGenerator;

$generator = new DataGenerator\OptionalValueGenerator(
    'foo',
    'bar',
    'baz',
);

foreach ($generator->generate() as $value) {
    echo $value . PHP_EOL
}

// empty string
// foo
// bar
// baz

SequentialValueGenerator

Use the SequentialValueGenerator to generate one or more values from one or more StringGenerators:

<?php

declare(strict_types=1);

use Ergebnis\DataGenerator;

$generator = new DataGenerator\SequentialValueGenerator(
    new DataGenerator\ValueGenerator(
        'foo',
        'bar',
        'baz',
    ),
    new DataGenerator\ValueGenerator(
      'qux',
      'quux',
    ),
);

foreach ($generator->generate() as $value) {
    echo $value . PHP_EOL
}

// foo
// bar
// baz
// qux
// quux

ValueGenerator

Use the ValueGenerator to generate one or more values from a list of string values:

<?php

declare(strict_types=1);

use Ergebnis\DataGenerator;

$generator = new DataGenerator\ValueGenerator(
    'foo',
    'bar',
    'baz',
);

foreach ($generator->generate() as $value) {
    echo $value . PHP_EOL
}

// foo
// bar
// baz

Changelog

The maintainers of this project record notable changes to this project in a changelog.

Contributing

The maintainers of this project suggest following the contribution guide.

Code of Conduct

The maintainers of this project ask contributors to follow the code of conduct.

General Support Policy

The maintainers of this project provide limited support.

You can support the maintenance of this project by sponsoring @localheinz or requesting an invoice for services related to this project.

PHP Version Support Policy

This project supports PHP versions with active and security support.

The maintainers of this project add support for a PHP version following its initial release and drop support for a PHP version when it has reached the end of security support.

Security Policy

This project has a security policy.

License

This project uses the MIT license.

Social

Follow @localheinz and @ergebnis on Twitter.