Add DataProvider.entries()

Author: danon

.github/assets/example/entries.png

@@ -34,6 +34,7 @@ with `zip()`, `join()`, `cross()`, `pairs()`, `slice()`, `map()` and more.
    * [`DataProvider::dictionary()`](#dataproviderdictionary)
    * [`DataProvider.map()`](#dataprovidermap)
    * [`DataProvider.slice()`](#dataproviderslice)
+   * [`DataProvider.entries()`](#dataproviderentries)
 3. [Documentation](#documentation)
    * [Functionalities](#functionalities)
    * [Features](#features)
@@ -251,7 +252,7 @@ Provide multiple arguments for each a test. `DataProvider::tuples()` [names](#na
  * @test 
  * @dataProvider colors
  */
-public function test(string color, string $thing): void {
+public function test(string $color, string $thing): void {
   // your test here
 }
 
@@ -276,7 +277,7 @@ provided array key.
  * @test 
  * @dataProvider colors
  */
-public function test(string color): void {
+public function test(string $color): void {
   // your test here
 }
 
@@ -352,7 +353,7 @@ Remove leading or trailing rows from `DataProvider`.
  * @test 
  * @dataProvider limitedColors
  */
-public function test(string color, string $thing): void {
+public function test(string $color, string $thing): void {
   // your test here
 }
 
@@ -369,6 +370,31 @@ public function colors(): DataProvider {
 }
 ```
 
+### `DataProvider.entries()`
+
+Provide two arguments for each a test, from key-value pairs.
+`DataProvider::entries()` [names](#names) each row based on the key-value pair.
+
+```php
+/**
+ * @test 
+ * @dataProvider colors
+ */
+public function test(string $color, string $thing): void {
+  // your test here
+}
+
+public function colors(): DataProvider {
+  return DataProvider::entries(
+    'blue'   => 'sky', 
+    'yellow' => 'sun',
+    'red'    => 'apple',
+  );
+}
+```
+
+![entries.png](.github/assets/example/entries.png)
+
 # Documentation
 
 ### Functionalities
@@ -408,7 +434,7 @@ public function colors(): DataProvider {
  * @test 
  * @dataProvider colors
  */
-public function test(string color, string $thing): void {
+public function test(string $color, string $thing): void {
   // your test here
 }
 

ReadMe.md

@@ -6,6 +6,7 @@
 use TRegx\PhpUnit\DataProviders\Internal\Provider\DictionaryProvider;
 use TRegx\PhpUnit\DataProviders\Internal\Provider\DistinctPairsProvider;
 use TRegx\PhpUnit\DataProviders\Internal\Provider\DropProvider;
+use TRegx\PhpUnit\DataProviders\Internal\Provider\EntriesProvider;
 use TRegx\PhpUnit\DataProviders\Internal\Provider\JoinProvider;
 use TRegx\PhpUnit\DataProviders\Internal\Provider\ListProvider;
 use TRegx\PhpUnit\DataProviders\Internal\Provider\MapProvider;
@@ -37,6 +38,11 @@ public static function dictionary(array $dictionary): DataProvider
         return new DictionaryProvider($dictionary);
     }
 
+    public static function entries(array $dictionary): DataProvider
+    {
+        return new EntriesProvider($dictionary);
+    }
+
     public static function join(iterable $dataProvider, iterable ...$dataProviders): DataProvider
     {
         return new JoinProvider(\array_merge([$dataProvider], $dataProviders));

src/DataProvider.php

@@ -0,0 +1,25 @@
+<?php
+namespace TRegx\PhpUnit\DataProviders\Internal\Provider;
+
+use TRegx\PhpUnit\DataProviders\DataProvider;
+use TRegx\PhpUnit\DataProviders\Internal\Frame\DataRow;
+
+class EntriesProvider extends DataProvider
+{
+    /** @var mixed[] */
+    private $dictionary;
+
+    public function __construct(array $dictionary)
+    {
+        $this->dictionary = $dictionary;
+    }
+
+    protected function dataset(): array
+    {
+        $dataset = [];
+        foreach ($this->dictionary as $key => $value) {
+            $dataset[] = new DataRow([$key, $value], [true, true], [$key, $value]);
+        }
+        return $dataset;
+    }
+}

src/Internal/Provider/EntriesProvider.php

@@ -0,0 +1,30 @@
+<?php
+namespace Test\Unit\entry;
+
+use PHPUnit\Framework\TestCase;
+use Test\Fixture\Assertion\AssertsIteration;
+use TRegx\PhpUnit\DataProviders\DataProvider;
+
+class EntriesTest extends TestCase
+{
+    use AssertsIteration;
+
+    /**
+     * @test
+     */
+    public function shouldIterate()
+    {
+        $dictionary = DataProvider::entries([
+            'Eddard'  => 'Stark',
+            'Robert'  => 'Baratheon',
+            'Balon'   => 'Greyjoy',
+            'Rhaegar' => 'Targaryen',
+        ]);
+        $this->assertIteratesValues($dictionary, [
+            ['Eddard', 'Stark'],
+            ['Robert', 'Baratheon'],
+            ['Balon', 'Greyjoy'],
+            ['Rhaegar', 'Targaryen'],
+        ]);
+    }
+}

test/Unit/entry/EntriesTest.php

@@ -0,0 +1,30 @@
+<?php
+namespace Test\Unit\names;
+
+use PHPUnit\Framework\TestCase;
+use Test\Fixture\Assertion\AssertsIteration;
+use TRegx\PhpUnit\DataProviders\DataProvider;
+
+class EntriesTest extends TestCase
+{
+    use AssertsIteration;
+
+    /**
+     * @test
+     */
+    public function shouldName()
+    {
+        $dictionary = DataProvider::entries([
+            'Eddard'  => 'Stark',
+            'Robert'  => 'Baratheon',
+            'Balon'   => 'Greyjoy',
+            'Rhaegar' => 'Targaryen',
+        ]);
+        $this->assertIteratesNames($dictionary, [
+            "'Eddard', 'Stark'",
+            "'Robert', 'Baratheon'",
+            "'Balon', 'Greyjoy'",
+            "'Rhaegar', 'Targaryen'",
+        ]);
+    }
+}