Enhancement: Implement StringProvider::uuid()

ergebnis · Feb 10, 2022 · b966bac · b966bac
1 parent e1cff20
commit b966bac
Show file tree

Hide file tree

Showing 5 changed files with 50 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,7 +6,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## Unreleased
 
-For a full diff see [`1.1.0...main`][1.1.0...main].
+For a full diff see [`1.2.0...main`][1.2.0...main].
+
+## [`1.2.0`][1.2.0]
+
+For a full diff see [`1.1.0...1.2.0`][1.1.0...1.2.0].
+
+### Added
+
+- Added `StringProvider::uuid()` ([#40]), by [@localheinz]
 
 ## [`1.1.0`][1.1.0]
 
@@ -27,12 +35,15 @@ For a full diff see [`a5f2657...1.0.0`][a5f2657...1.0.0].
 
 [1.0.0]: https://github.com/ergebnis/data-provider/releases/tag/1.0.0
 [1.1.0]: https://github.com/ergebnis/data-provider/releases/tag/1.1.0
+[1.2.0]: https://github.com/ergebnis/data-provider/releases/tag/1.2.0
 
 [a5f2657...1.0.0]: https://github.com/ergebnis/data-provider/compare/a5f2657...1.0.0
 [1.0.0...1.1.0]: https://github.com/ergebnis/data-provider/compare/1.0.0...1.1.0
-[1.1.0...main]: https://github.com/ergebnis/data-provider/compare/1.1.0...main
+[1.1.0...1.2.0]: https://github.com/ergebnis/data-provider/compare/1.1.0...1.2.0
+[1.2.0...main]: https://github.com/ergebnis/data-provider/compare/1.2.0...main
 
 [#1]: https://github.com/ergebnis/data-provider/pull/1
 [#21]: https://github.com/ergebnis/data-provider/pull/21
+[#40]: https://github.com/ergebnis/data-provider/pull/40
 
 [@localheinz]: https://github.com/localheinz
diff --git a/README.md b/README.md
@@ -115,9 +115,11 @@ For examples, see [`Ergebnis\DataProvider\Test\Unit\ResourceProviderTest`](test/
 * `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
+* `uuid()` provides lower- and upper-case UUID `string`s
 * `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).

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="4.18.1@dda05fa913f4dc6eb3386f2f7ce5a45d37a71bcb">
+<files psalm-version="4.20.0@f82a70e7edfc6cf2705e9374c8a0b6a974a779ed">
   <file src="src/AbstractProvider.php">
     <MixedAssignment occurrences="1">
       <code>$value</code>
@@ -53,7 +53,8 @@
     </MoreSpecificReturnType>
   </file>
   <file src="src/StringProvider.php">
-    <MoreSpecificReturnType occurrences="6">
+    <MoreSpecificReturnType occurrences="7">
+      <code>\Generator&lt;string, array{0: string}&gt;</code>
       <code>\Generator&lt;string, array{0: string}&gt;</code>
       <code>\Generator&lt;string, array{0: string}&gt;</code>
       <code>\Generator&lt;string, array{0: string}&gt;</code>

diff --git a/src/StringProvider.php b/src/StringProvider.php
@@ -66,6 +66,16 @@ public static function untrimmed(): \Generator
         });
     }
 
+    /**
+     * @return \Generator<string, array{0: string}>
+     */
+    public static function uuid(): \Generator
+    {
+        yield from self::provideDataForValuesWhere(self::values(), static function (string $value): bool {
+            return 1 === \preg_match('/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/i', $value);
+        });
+    }
+
     /**
      * @return \Generator<string, array{0: string}>
      */
@@ -106,6 +116,11 @@ private static function values(): array
             'string-empty' => '',
         ];
 
+        $uuidValues = [
+            'string-uuid-case-lower' => \mb_strtolower($faker->uuid()),
+            'string-uuid-case-upper' => \mb_strtoupper($faker->uuid()),
+        ];
+
         /** @var array<string, string> $untrimmedValues */
         $untrimmedValues = \array_combine(
             \array_map(static function (string $key): string {
@@ -154,6 +169,7 @@ private static function values(): array
             $blankValues,
             $emptyValues,
             $untrimmedValues,
+            $uuidValues,
             $withWhitespaceValues,
         );
     }

diff --git a/test/Unit/StringProviderTest.php b/test/Unit/StringProviderTest.php
@@ -52,6 +52,8 @@ public function testArbitraryReturnsGeneratorThatProvidesArbitraryStrings(): voi
             'string-untrimmed-line-feed' => Test\Util\Specification\Pattern::create('/^\n{1,5}\w+\n{1,5}$/'),
             'string-untrimmed-space' => Test\Util\Specification\Pattern::create('/^\s{1,5}\w+\s{1,5}$/'),
             'string-untrimmed-tab' => Test\Util\Specification\Pattern::create('/^\t{1,5}\w+\t{1,5}$/'),
+            'string-uuid-case-lower' => Test\Util\Specification\Pattern::create('/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/'),
+            'string-uuid-case-upper' => Test\Util\Specification\Pattern::create('/^[A-F0-9]{8}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{12}$/'),
             'string-with-whitespace-carriage-return' => Test\Util\Specification\Pattern::create('/^\w+(\r+\w+){1,4}$/'),
             'string-with-whitespace-line-feed' => Test\Util\Specification\Pattern::create('/^\w+(\n+\w+){1,4}$/'),
             'string-with-whitespace-space' => Test\Util\Specification\Pattern::create('/^\w+(\s+\w+){1,4}$/'),
@@ -134,6 +136,8 @@ public function testTrimmedReturnsGeneratorThatProvidesStringsThatAreTrimmed():
             'string-arbitrary-word' => Test\Util\Specification\Closure::create(static function (string $value): bool {
                 return '' !== $value && '' !== \trim($value);
             }),
+            'string-uuid-case-lower' => Test\Util\Specification\Pattern::create('/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/'),
+            'string-uuid-case-upper' => Test\Util\Specification\Pattern::create('/^[A-F0-9]{8}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{12}$/'),
             'string-with-whitespace-carriage-return' => Test\Util\Specification\Pattern::create('/^\w+(\r+\w+){1,4}$/'),
             'string-with-whitespace-line-feed' => Test\Util\Specification\Pattern::create('/^\w+(\n+\w+){1,4}$/'),
             'string-with-whitespace-space' => Test\Util\Specification\Pattern::create('/^\w+(\s+\w+){1,4}$/'),
@@ -159,6 +163,18 @@ public function testUntrimmedReturnsGeneratorThatProvidesUntrimmedStrings(): voi
         self::assertProvidesDataSetsForValuesSatisfyingSpecifications($specifications, $provider);
     }
 
+    public function testUuidReturnsGeneratorThatProvidesUuidStrings(): void
+    {
+        $specifications = [
+            'string-uuid-case-lower' => Test\Util\Specification\Pattern::create('/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/'),
+            'string-uuid-case-upper' => Test\Util\Specification\Pattern::create('/^[A-F0-9]{8}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{12}$/'),
+        ];
+
+        $provider = StringProvider::uuid();
+
+        self::assertProvidesDataSetsForValuesSatisfyingSpecifications($specifications, $provider);
+    }
+
     public function testWithWhitespaceReturnsGeneratorThatProvidesTrimmedStringsWithWhitespace(): void
     {
         $specifications = [