Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ergebnis/data-provider
👓 Provides a composer package with generic data providers for use with phpunit/phpunit.
https://github.com/ergebnis/data-provider
data-provider phpunit
Last synced: 4 days ago
JSON representation
👓 Provides a composer package with generic data providers for use with phpunit/phpunit.
- Host: GitHub
- URL: https://github.com/ergebnis/data-provider
- Owner: ergebnis
- License: mit
- Created: 2021-11-25T19:46:21.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T17:15:18.000Z (3 months ago)
- Last Synced: 2024-10-24T00:48:09.955Z (3 months ago)
- Topics: data-provider, phpunit
- Language: PHP
- Size: 3.1 MB
- Stars: 27
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# data-provider
[](https://github.com/ergebnis/data-provider/actions)
[](https://github.com/ergebnis/data-provider/actions)
[](https://github.com/ergebnis/data-provider/actions)
[](https://github.com/ergebnis/data-provider/actions)
[](https://codecov.io/gh/ergebnis/data-provider)
[](https://packagist.org/packages/ergebnis/data-provider)
[](https://packagist.org/packages/ergebnis/data-provider)
[](https://packagist.org/packages/ergebnis/data-provider)
This project provides a [`composer`](https://getcomposer.org) package with generic data providers for use with [`phpunit/phpunit`](https://github.com/sebastianbergmann/phpunit).
## Installation
Run
```sh
composer require ergebnis/data-provider
```
## Usage
This package provides the following generic data providers:
- [`Ergebnis\DataProvider\BoolProvider`](https://github.com/ergebnis/data-provider#dataproviderboolprovider)
- [`Ergebnis\DataProvider\FloatProvider`](https://github.com/ergebnis/data-provider#dataproviderfloatprovider)
- [`Ergebnis\DataProvider\IntProvider`](https://github.com/ergebnis/data-provider#dataproviderintprovider)
- [`Ergebnis\DataProvider\NullProvider`](https://github.com/ergebnis/data-provider#dataprovidernullprovider)
- [`Ergebnis\DataProvider\ObjectProvider`](https://github.com/ergebnis/data-provider#dataproviderobjectprovider)
- [`Ergebnis\DataProvider\ResourceProvider`](https://github.com/ergebnis/data-provider#dataproviderresourceprovider)
- [`Ergebnis\DataProvider\StringProvider`](https://github.com/ergebnis/data-provider#dataproviderstringprovider)
- [`Ergebnis\DataProvider\UuidProvider`](https://github.com/ergebnis/data-provider#dataprovideruuidprovider)
Since it is possible to use multiple [`@dataProvider` annotations](https://docs.phpunit.de/en/10.4/annotations.html#dataprovider) or [`PHPUnit\Framework\Attribute\DataProviderExternal` attributes](https://docs.phpunit.de/en/10.4/attributes.html#dataproviderexternal) for test methods, these generic data providers allow for reuse and composition of data providers:
```php
expectException(\InvalidArgumentException::class);
$this->expectExceptionMessage('Value can not be an empty or blank string.');
UserName::fromString($value);
}
#[Framework\DataProviderExternal(DataProvider\StringProvider::class, 'blank')]
#[Framework\DataProviderExternal(DataProvider\StringProvider::class, 'empty')]
public function testFromNameRejectsInvalidValueWithAttribute(string $value): void
{
$this->expectException(\InvalidArgumentException::class);
$this->expectExceptionMessage('Value can not be an empty or blank string.');
UserName::fromString($value);
}
}
```
#### `DataProvider\BoolProvider`
- `arbitrary()` provides `true`, `false`
- `false()` provides `false`
- `true()` provides `true`
For examples, see [`Ergebnis\DataProvider\Test\Unit\BoolProviderTest`](test/Unit/BoolProviderTest.php).
#### `DataProvider\FloatProvider`
- `arbitrary()` provides arbitrary `float`s
- `greaterThanOne()` provides `int`s greater than `1.0`
- `greaterThanZero()` provides `int`s greater than `0.0`
- `lessThanOne()` provides `int`s less than `1.0`
- `lessThanZero()` provides `int`s less than `0.0`
- `one()` provides `1.0`
- `zero()` provides `0.0`
For examples, see [`Ergebnis\DataProvider\Test\Unit\FloatProviderTest`](test/Unit/FloatProviderTest.php).
#### `DataProvider\IntProvider`
- `arbitrary()` provides arbitrary `int`s
- `greaterThanOne()` provides `int`s greater than `1`
- `greaterThanZero()` provides `int`s greater than `0`
- `lessThanOne()` provides `int`s less than `1`
- `lessThanZero()` provides `int`s less than `0`
- `one()` provides `1`
- `zero()` provides `0`
For examples, see [`Ergebnis\DataProvider\Test\Unit\IntProviderTest`](test/Unit/IntProviderTest.php).
#### `DataProvider\NullProvider`
- `null()` provides `null`
For examples, see [`Ergebnis\DataProvider\Test\Unit\NullProviderTest`](test/Unit/NullProviderTest.php).
#### `DataProvider\ObjectProvider`
- `object()` provides an instance of `stdClass`
For examples, see [`Ergebnis\DataProvider\Test\Unit\ObjectProviderTest`](test/Unit/ObjectProviderTest.php).
#### `DataProvider\ResourceProvider`
- `resource()` provides a `resource`
For examples, see [`Ergebnis\DataProvider\Test\Unit\ResourceProviderTest`](test/Unit/ResourceProviderTest.php).
#### `DataProvider\StringProvider`
- `arbitrary()` provides arbitrary `string`s
- `blank()` provides `string`s consisting of whitespace characters only
- `empty()` provides an empty `string`
- `trimmed()` provides non-empty, non-blank `strings` without leading and trailing whitespace
- `untrimmed()` provides non-empty, non-blank `string`s with additional leading and trailing whitespace
- `withWhitespace()` provides non-empty, non-blank, trimmed `string`s containing whitespace
For examples, see [`Ergebnis\DataProvider\Test\Unit\StringProviderTest`](test/Unit/StringProviderTest.php).
#### `DataProvider\UuidProvider`
- `arbitrary()` provides lower- and upper-case UUIDs
- `caseLower()` provides a lower-case UUIDs
- `caseUpper()` provides an upper-case UUIDs
For examples, see [`Ergebnis\DataProvider\Test\Unit\UuidProviderTest`](test/Unit/UuidProviderTest.php).
## Changelog
The maintainers of this project record notable changes to this project in a [changelog](CHANGELOG.md).
## Contributing
The maintainers of this project suggest following the [contribution guide](.github/CONTRIBUTING.md).
## Code of Conduct
The maintainers of this project ask contributors to follow the [code of conduct](https://github.com/ergebnis/.github/blob/main/CODE_OF_CONDUCT.md).
## General Support Policy
The maintainers of this project provide limited support.
You can support the maintenance of this project by [sponsoring @localheinz](https://github.com/sponsors/localheinz) or [requesting an invoice for services related to this project](mailto:[email protected]?subject=ergebnis/data-provider:%20Requesting%20invoice%20for%20services).
## PHP Version Support Policy
This project supports PHP versions with [active and security support](https://www.php.net/supported-versions.php).
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](.github/SECURITY.md).
## License
This project uses the [MIT license](LICENSE.md).
## Social
Follow [@localheinz](https://twitter.com/intent/follow?screen_name=localheinz) and [@ergebnis](https://twitter.com/intent/follow?screen_name=ergebnis) on Twitter.