Refactor

realFlowControl · Dec 28, 2020 · bfabe17 · bfabe17
1 parent 297a7d3
commit bfabe17
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 35 deletions.
diff --git a/.psalm/baseline.xml b/.psalm/baseline.xml
@@ -142,9 +142,6 @@
       <code>$expected</code>
       <code>$expected</code>
     </PossiblyInvalidArgument>
-    <RedundantCondition occurrences="1">
-      <code>assert($step['object'] instanceof TestCase)</code>
-    </RedundantCondition>
   </file>
   <file src="src/Framework/Assert/Functions.php">
     <MissingParamType occurrences="85">
@@ -1386,6 +1383,11 @@
       <code>ensureOperatorIsValid</code>
     </MissingThrowsDocblock>
   </file>
+  <file src="src/Util/Warning.php">
+    <RedundantCondition occurrences="1">
+      <code>assert($step['object'] instanceof TestCase)</code>
+    </RedundantCondition>
+  </file>
   <file src="src/Util/Xml.php">
     <ArgumentTypeCoercion occurrences="1">
       <code>$item</code>

diff --git a/src/Framework/Assert.php b/src/Framework/Assert.php
@@ -79,6 +79,7 @@
 use PHPUnit\Framework\Constraint\TraversableContainsIdentical;
 use PHPUnit\Framework\Constraint\TraversableContainsOnly;
 use PHPUnit\Util\Type;
+use PHPUnit\Util\Warning as WarningUtil;
 use PHPUnit\Util\Xml;
 use PHPUnit\Util\Xml\Loader as XmlLoader;
 
@@ -277,7 +278,9 @@ public static function assertCount(int $expectedCount, $haystack, string $messag
         }
 
         if ($haystack instanceof Generator) {
-            self::createWarning('Passing an argument of type Generator for the $haystack parameter is deprecated. Support for this will be removed in PHPUnit 11.');
+            (new WarningUtil)->createForTestCaseObjectOnCallStack(
+                'Passing an argument of type Generator for the $haystack parameter is deprecated. Support for this will be removed in PHPUnit 11.'
+            );
         }
 
         static::assertThat(
@@ -2516,20 +2519,4 @@ private static function isValidClassAttributeName(string $attributeName): bool
     {
         return (bool) preg_match('/[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*/', $attributeName);
     }
-
-    /**
-     * @codeCoverageIgnore
-     */
-    private static function createWarning(string $warning): void
-    {
-        foreach (debug_backtrace() as $step) {
-            if (isset($step['object']) && $step['object'] instanceof TestCase) {
-                assert($step['object'] instanceof TestCase);
-
-                $step['object']->addWarning($warning);
-
-                break;
-            }
-        }
-    }
 }
diff --git a/src/Framework/MockObject/Builder/InvocationMocker.php b/src/Framework/MockObject/Builder/InvocationMocker.php
@@ -12,7 +12,6 @@
 use function array_map;
 use function array_merge;
 use function count;
-use function debug_backtrace;
 use function in_array;
 use function is_string;
 use function strtolower;
@@ -36,7 +35,7 @@
 use PHPUnit\Framework\MockObject\Stub\ReturnStub;
 use PHPUnit\Framework\MockObject\Stub\ReturnValueMap;
 use PHPUnit\Framework\MockObject\Stub\Stub;
-use PHPUnit\Framework\TestCase;
+use PHPUnit\Util\Warning as WarningUtil;
 use Throwable;
 
 /**
@@ -197,19 +196,9 @@ public function withConsecutive(...$arguments): self
     {
         $this->ensureParametersCanBeConfigured();
 
-        $stack = debug_backtrace();
-
-        while (!empty($stack)) {
-            $frame = array_pop($stack);
-
-            if (isset($frame['object']) && $frame['object'] instanceof TestCase) {
-                $frame['object']->addWarning(
-                    'The withConsecutive() method has been deprecated. It will be removed in PHPUnit 11.'
-                );
-
-                break;
-            }
-        }
+        (new WarningUtil)->createForTestCaseObjectOnCallStack(
+            'The withConsecutive() method has been deprecated. It will be removed in PHPUnit 11.'
+        );
 
         $this->matcher->setParametersRule(new Rule\ConsecutiveParameters($arguments));
 

diff --git a/src/Util/Warning.php b/src/Util/Warning.php
@@ -0,0 +1,33 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\Util;
+
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @internal This class is not covered by the backward compatibility promise for PHPUnit
+ *
+ * @codeCoverageIgnore
+ */
+final class Warning
+{
+    public function createForTestCaseObjectOnCallStack(string $warning): void
+    {
+        foreach (debug_backtrace() as $step) {
+            if (isset($step['object']) && $step['object'] instanceof TestCase) {
+                assert($step['object'] instanceof TestCase);
+
+                $step['object']->addWarning($warning);
+
+                break;
+            }
+        }
+    }
+}