Merge pull request #339 from ergebnis/feature/trimmed

Enhancement: Implement DataProvider\StringProvider::trimmed()

.github/workflows/integrate.yaml

@@ -11,7 +11,7 @@ on: # yamllint disable-line rule:truthy
 env:
   ERGEBNIS_BOT_NAME: "ergebnis-bot"
   MIN_COVERED_MSI: 93
-  MIN_MSI: 91
+  MIN_MSI: 92
   PHP_EXTENSIONS: "mbstring"
 
 jobs:

Makefile

@@ -1,5 +1,5 @@
 MIN_COVERED_MSI:=93
-MIN_MSI:=91
+MIN_MSI:=92
 
 .PHONY: it
 it: coding-standards static-code-analysis tests ## Runs the coding-standards, static-code-analysis, and tests targets

README.md

@@ -166,6 +166,7 @@ For examples, see [`Ergebnis\Test\Util\Test\Unit\DataProvider\NullProviderTest`]
 * `arbitrary()` provides arbitrary `string`s
 * `blank()` provides `string`s consisting of whitespace characters only
 * `empty()` provides an empty `string`
+* `trimmed()` provides non-empty `strings` without leading and trailing whitespace
 * `untrimmed()` provides `string`s with leading and trailing whitespace
 
 For examples, see [`Ergebnis\Test\Util\Test\Unit\DataProvider\StringProviderTest`](test/Unit/DataProvider/StringProviderTest.php).

psalm-baseline.xml

@@ -28,7 +28,8 @@
   </file>
   <file src="src/DataProvider/StringProvider.php">
     <MixedArgumentTypeCoercion occurrences="2"/>
-    <MoreSpecificReturnType occurrences="4">
+    <MoreSpecificReturnType occurrences="5">
+      <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>

src/DataProvider/StringProvider.php

@@ -48,6 +48,17 @@ public static function empty(): \Generator
         });
     }
 
+    /**
+     * @return \Generator<string, array{0: string}>
+     */
+    public static function trimmed(): \Generator
+    {
+        yield from self::provideDataForValuesWhere(self::values(), static function (string $value): bool {
+            return \trim($value) === $value
+                && '' !== \trim($value);
+        });
+    }
+
     /**
      * @return \Generator<string, array{0: string}>
      */

test/Unit/DataProvider/StringProviderTest.php

@@ -116,6 +116,32 @@ public function testUntrimmedProvidesUntrimmedString(string $value): void
         self::assertNotSame('', \trim($value));
     }
 
+    /**
+     * @dataProvider \Ergebnis\Test\Util\DataProvider\StringProvider::trimmed()
+     *
+     * @param mixed $value
+     */
+    public function testTrimmedProvidesString($value): void
+    {
+        self::assertIsString($value);
+    }
+
+    public function testTrimmedReturnsGeneratorThatProvidesStringsThatAreTrimmed(): void
+    {
+        $specifications = [
+            'string-arbitrary-sentence' => Util\DataProvider\Specification\Closure::create(static function (string $value): bool {
+                return '' !== $value && '' !== \trim($value);
+            }),
+            'string-arbitrary-word' => Util\DataProvider\Specification\Closure::create(static function (string $value): bool {
+                return '' !== $value && '' !== \trim($value);
+            }),
+        ];
+
+        $provider = StringProvider::trimmed();
+
+        self::assertProvidesDataSetsForValuesSatisfyingSpecifications($specifications, $provider);
+    }
+
     public function testUntrimmedReturnsGeneratorThatProvidesUntrimmedStrings(): void
     {
         $specifications = [