Fix: Deprecate data providers

ergebnis · Jan 3, 2022 · 58c91cb · 58c91cb
1 parent 39268f6
commit 58c91cb
Show file tree

Hide file tree

Showing 11 changed files with 582 additions and 268 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## Unreleased
 
+### Changed
+
+- Deprecated all data providers ([#526]), by [@localheinz]
+
 For a full diff see [`1.5.0...main`][1.5.0...main].
 
 ## [`1.5.0`][1.5.0]
@@ -183,6 +187,7 @@ For a full diff see [`0.7.0...0.8.0`][0.7.0...0.8.0].
 [#374]: https://github.com/ergebnis/test-util/pull/374
 [#434]: https://github.com/ergebnis/test-util/pull/434
 [#435]: https://github.com/ergebnis/test-util/pull/435
+[#526]: https://github.com/ergebnis/test-util/pull/526
 
 [@dependabot]: https://github.com/dependabot
 [@ergebnis]: https://github.com/ergebnis

diff --git a/README.md b/README.md
@@ -99,6 +99,8 @@ In addition to the assertions made available by extending from `PHPUnit\Framewor
 
 ### Data Providers
 
+:exclamation: The data providers have been deprecated. Use [`ergebnis/data-provider`](https://github.com/ergebnis/data-provider) instead.
+
 This package provides the following generic data providers:
 
 * [`Ergebnis\Test\Util\DataProvider\BoolProvider`](https://github.com/ergebnis/test-util#dataproviderboolprovider)

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
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.6.4@97fe86c4e158b5a57c5150aa5055c38b5a809aab">
+<files psalm-version="4.17.0@6f4707aa41c9174353a6434bba3fc8840f981d9c">
   <file src="src/DataProvider/BoolProvider.php">
     <MoreSpecificReturnType occurrences="3">
       <code>\Generator&lt;string, array{0: bool}&gt;</code>
@@ -87,11 +87,63 @@
       <code>Util\Test\Util\DataProvider\Specification\Specification</code>
     </UnnecessaryVarAnnotation>
   </file>
+  <file src="test/Unit/DataProvider/BoolProviderTest.php">
+    <DeprecatedClass occurrences="3">
+      <code>BoolProvider::arbitrary()</code>
+      <code>BoolProvider::false()</code>
+      <code>BoolProvider::true()</code>
+    </DeprecatedClass>
+  </file>
+  <file src="test/Unit/DataProvider/FloatProviderTest.php">
+    <DeprecatedClass occurrences="7">
+      <code>FloatProvider::arbitrary()</code>
+      <code>FloatProvider::greaterThanOne()</code>
+      <code>FloatProvider::greaterThanZero()</code>
+      <code>FloatProvider::lessThanOne()</code>
+      <code>FloatProvider::lessThanZero()</code>
+      <code>FloatProvider::one()</code>
+      <code>FloatProvider::zero()</code>
+    </DeprecatedClass>
+  </file>
+  <file src="test/Unit/DataProvider/IntProviderTest.php">
+    <DeprecatedClass occurrences="7">
+      <code>IntProvider::arbitrary()</code>
+      <code>IntProvider::greaterThanOne()</code>
+      <code>IntProvider::greaterThanZero()</code>
+      <code>IntProvider::lessThanOne()</code>
+      <code>IntProvider::lessThanZero()</code>
+      <code>IntProvider::one()</code>
+      <code>IntProvider::zero()</code>
+    </DeprecatedClass>
+  </file>
+  <file src="test/Unit/DataProvider/NullProviderTest.php">
+    <DeprecatedClass occurrences="1">
+      <code>NullProvider::null()</code>
+    </DeprecatedClass>
+  </file>
+  <file src="test/Unit/DataProvider/ObjectProviderTest.php">
+    <DeprecatedClass occurrences="1">
+      <code>ObjectProvider::object()</code>
+    </DeprecatedClass>
+  </file>
   <file src="test/Unit/DataProvider/ResourceProviderTest.php">
+    <DeprecatedClass occurrences="1">
+      <code>ResourceProvider::resource()</code>
+    </DeprecatedClass>
     <MissingClosureParamType occurrences="1">
       <code>$value</code>
     </MissingClosureParamType>
   </file>
+  <file src="test/Unit/DataProvider/StringProviderTest.php">
+    <DeprecatedClass occurrences="6">
+      <code>StringProvider::arbitrary()</code>
+      <code>StringProvider::blank()</code>
+      <code>StringProvider::empty()</code>
+      <code>StringProvider::trimmed()</code>
+      <code>StringProvider::untrimmed()</code>
+      <code>StringProvider::withWhitespace()</code>
+    </DeprecatedClass>
+  </file>
   <file src="test/Unit/Exception/InvalidExcludeClassNameTest.php">
     <MixedInferredReturnType occurrences="1">
       <code>\Generator&lt;array&lt;null|array|bool|float|int|resource|\stdClass&gt;&gt;</code>
@@ -134,13 +186,6 @@
       <code>$classyName</code>
       <code>$classyName</code>
     </UnusedClosureParam>
-    <UnusedFunctionCall occurrences="5">
-      <code>\iterator_to_array</code>
-      <code>\iterator_to_array</code>
-      <code>\iterator_to_array</code>
-      <code>\iterator_to_array</code>
-      <code>\iterator_to_array</code>
-    </UnusedFunctionCall>
   </file>
   <file src="test/Util/DataProvider/Specification/Closure.php">
     <MissingClosureParamType occurrences="1">

diff --git a/src/DataProvider/BoolProvider.php b/src/DataProvider/BoolProvider.php
@@ -15,6 +15,10 @@
 
 use Ergebnis\Test\Util;
 
+/**
+ * @deprecated use ergebnis/data-provider instead
+ * @see https://github.com/ergebnis/data-provider
+ */
 final class BoolProvider
 {
     use Util\Helper;

diff --git a/src/DataProvider/FloatProvider.php b/src/DataProvider/FloatProvider.php
@@ -15,6 +15,10 @@
 
 use Ergebnis\Test\Util;
 
+/**
+ * @deprecated use ergebnis/data-provider instead
+ * @see https://github.com/ergebnis/data-provider
+ */
 final class FloatProvider
 {
     use Util\Helper;

diff --git a/src/DataProvider/IntProvider.php b/src/DataProvider/IntProvider.php
@@ -15,6 +15,10 @@
 
 use Ergebnis\Test\Util;
 
+/**
+ * @deprecated use ergebnis/data-provider instead
+ * @see https://github.com/ergebnis/data-provider
+ */
 final class IntProvider
 {
     use Util\Helper;

diff --git a/src/DataProvider/NullProvider.php b/src/DataProvider/NullProvider.php
@@ -15,6 +15,10 @@
 
 use Ergebnis\Test\Util;
 
+/**
+ * @deprecated use ergebnis/data-provider instead
+ * @see https://github.com/ergebnis/data-provider
+ */
 final class NullProvider
 {
     use Util\Helper;

diff --git a/src/DataProvider/ObjectProvider.php b/src/DataProvider/ObjectProvider.php
@@ -15,6 +15,10 @@
 
 use Ergebnis\Test\Util;
 
+/**
+ * @deprecated use ergebnis/data-provider instead
+ * @see https://github.com/ergebnis/data-provider
+ */
 final class ObjectProvider
 {
     use Util\Helper;

diff --git a/src/DataProvider/ResourceProvider.php b/src/DataProvider/ResourceProvider.php
@@ -15,6 +15,10 @@
 
 use Ergebnis\Test\Util;
 
+/**
+ * @deprecated use ergebnis/data-provider instead
+ * @see https://github.com/ergebnis/data-provider
+ */
 final class ResourceProvider
 {
     use Util\Helper;

diff --git a/src/DataProvider/StringProvider.php b/src/DataProvider/StringProvider.php
@@ -15,6 +15,10 @@
 
 use Ergebnis\Test\Util;
 
+/**
+ * @deprecated use ergebnis/data-provider instead
+ * @see https://github.com/ergebnis/data-provider
+ */
 final class StringProvider
 {
     use Util\Helper;