Tests/AbstractArrayDeclarationSniffTest: work around for TestCase::onConsecutiveCalls() deprecation

The `TestCase::onConsecutiveCalls()` is soft deprecated in PHPUnit 10, hard deprecated in PHPUnit 11 and will be removed in PHPUnit 12.

While it is not strictly necessary to address this deprecation now, I've chosen to do so anyway.

Note: the method call is not directly changed from `->will($this->onConsecutiveCalls(...))` to `->willReturn(...)` - which is the PHPUnit native recommendation -, as this would make the test incompatible with older PHPUnit versions.

Additionally, a previous fix to work around the deprecation of `InvocationMocker->withConsecutive()` already uses the `willReturnCallback()` method, so the return value expectations will now need to be set via the `ExpectWithConsecutiveArgs::setExpectationWithConsecutiveArgs()` method.

Refs:
* sebastianbergmann/phpunit 5423
* sebastianbergmann/phpunit 5424

Author: jrfnl

Tests/AbstractSniffs/AbstractArrayDeclaration/AbstractArrayDeclarationSniffTest.php

@@ -287,8 +287,9 @@ public function testMultiLineLongArrayKeysTrailingComma()
                 [self::$phpcsFile, $target + 7, $target + 8, 1],
                 [self::$phpcsFile, $target + 15, $target + 16, 2],
                 [self::$phpcsFile, $target + 23, $target + 24, 3],
-            ]
-        )->will($this->onConsecutiveCalls(null, null, true)); // Testing short-circuiting the loop.
+            ],
+            [null, null, true] // Testing short-circuiting the loop.
+        );
 
         $this->setExpectationWithConsecutiveArgs(
             $mockObj,

Tests/ExpectWithConsecutiveArgs.php

@@ -17,7 +17,15 @@
  * Previously, the `InvocationMocker->withConsecutive()` method could be used to test
  * this, but that method was removed in PHPUnit 10.0.
  *
+ * Furthermore, the use of `->will($this->onConsecutiveCalls(...))` was deprecated in PHPUnit 10/11
+ * and will be removed in PHPUnit 12.0. The typical replacement for this is `->willReturn(...)`.
+ * However, as this helper already uses `->willReturnCallback()`, if these two deprecations/removals
+ * collide in the same expectation setting, it would break, so this is now also worked around via the
+ * `$returnValues` parameter.
+ *
  * @since 1.0.7
+ * @since 1.1.0 Now also works round the deprecation of `->will($this->onConsecutiveCalls(...))`
+ *              via the new optional `$returnValues` parameter.
  */
 trait ExpectWithConsecutiveArgs
 {
@@ -30,11 +38,17 @@ trait ExpectWithConsecutiveArgs
      * @param string              $methodName   The name of the method on which to set the expectations.
      * @param array<array<mixed>> $expectedArgs Multi-dimentional array of arguments expected to be passed in
      *                                          consecutive calls.
+     * @param array<mixed>        $returnValues Optional. Array of values to return on consecutive calls.
      *
      * @return object Expectation object.
      */
-    final public function setExpectationWithConsecutiveArgs($mockObject, $countMatcher, $methodName, $expectedArgs)
-    {
+    final public function setExpectationWithConsecutiveArgs(
+        $mockObject,
+        $countMatcher,
+        $methodName,
+        $expectedArgs,
+        $returnValues = []
+    ) {
         $methodExpectation = $mockObject->expects($countMatcher)
             ->method($methodName);
 
@@ -48,12 +62,18 @@ final public function setExpectationWithConsecutiveArgs($mockObject, $countMatch
                 }
             }
 
-            return \call_user_func_array([$methodExpectation, 'withConsecutive'], $expectationsArray);
+            $methodExpectation = \call_user_func_array([$methodExpectation, 'withConsecutive'], $expectationsArray);
+
+            if (empty($returnValues)) {
+                return $methodExpectation;
+            }
+
+            return $methodExpectation->will(\call_user_func_array([$this, 'onConsecutiveCalls'], $returnValues));
         }
 
         // PHPUnit 10+.
         return $methodExpectation->willReturnCallback(
-            function () use (&$expectedArgs, $countMatcher, $methodName) {
+            function () use (&$expectedArgs, $countMatcher, $methodName, $returnValues) {
                 $actualArgs = \func_get_args();
                 $expected   = \array_shift($expectedArgs);
 
@@ -76,6 +96,10 @@ function () use (&$expectedArgs, $countMatcher, $methodName) {
                         $methodName
                     )
                 );
+
+                if (empty($returnValues) === false) {
+                    return $returnValues[($countMatcher->numberOfInvocations() - 1)];
+                }
             }
         );
     }