Enhancement: Import data providers from ergebnis/test-util

.php-cs-fixer.php

@@ -26,7 +26,9 @@
 
 $license->save();
 
-$config = PhpCsFixer\Config\Factory::fromRuleSet(new PhpCsFixer\Config\RuleSet\Php73($license->header()));
+$config = PhpCsFixer\Config\Factory::fromRuleSet(new PhpCsFixer\Config\RuleSet\Php73($license->header()), [
+ 'strict_comparison' => false,
+]);
 
 $config->getFinder()
  ->exclude([

CHANGELOG.md

@@ -6,6 +6,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## Unreleased
 
-For a full diff see [`1902cc2...main`][1902cc2...main].
+For a full diff see [`a5f2657...main`][a5f2657...main].
 
-[1902cc2...main]: https://github.com/ergebnis/data-provider/compare/1902cc2...main
+### Added
+
+* Imported data providers from [`ergebnis/test-util`](https://github.com/ergebnis/test-util) ([#1]), by [@localheinz]
+
+[a5f2657...main]: https://github.com/ergebnis/data-provider/compare/a5f2657...main
+
+[#1]: https://github.com/ergebnis/data-provider/pull/1
+
+[@localheinz]: https://github.com/localheinz

README.md

@@ -21,8 +21,103 @@ composer require --dev ergebnis/data-provider
 
 ## Usage
 
-:bulb: This is a great place for showing a few usage examples!
+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)
+
+Since it is possible to use multiple `@dataProvider` annotations for test methods, these generic data providers allow for reuse and composition of data providers:
+
+```php
+<?php
+
+declare(strict_types=1);
+
+namespace Example\Test;
+
+use PHPUnit\Framework;
+
+final class ExampleTest extends Framework\TestCase
+{
+ /**
+ * @dataProvider \Ergebnis\DataProvider\StringProvider::blank()
+ * @dataProvider \Ergebnis\DataProvider\StringProvider::empty()
+ */
+ public function testFromNameRejectsBlankOrEmptyStrings(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).
 ## Changelog
 
 Please have a look at [`CHANGELOG.md`](CHANGELOG.md).

composer.json

@@ -15,13 +15,13 @@
  }
  ],
  "require": {
- "php": "^7.3 || ^8.0"
+ "php": "^7.3 || ^8.0",
+ "fakerphp/faker": "^1.16.0"
  },
  "require-dev": {
  "ergebnis/composer-normalize": "^2.16.0",
  "ergebnis/license": "^1.1.0",
  "ergebnis/php-cs-fixer-config": "^3.2.1",
- "ergebnis/test-util": "^1.5.0",
  "phpunit/phpunit": "~9.5.10",
  "psalm/plugin-phpunit": "~0.16.1",
  "vimeo/psalm": "^4.13.1"