-
Notifications
You must be signed in to change notification settings - Fork 11.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
72af784
commit afca284
Showing
13 changed files
with
727 additions
and
612 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
139 changes: 139 additions & 0 deletions
139
src/Illuminate/Testing/Constraints/Concerns/ArraySubset.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,139 @@ | ||
<?php | ||
|
||
namespace Illuminate\Testing\Constraints\Concerns; | ||
|
||
use ArrayObject; | ||
use SebastianBergmann\Comparator\ComparisonFailure; | ||
use SebastianBergmann\Exporter\Exporter; | ||
use Traversable; | ||
|
||
trait ArraySubset | ||
{ | ||
/** | ||
* @var iterable | ||
*/ | ||
protected readonly iterable $subset; | ||
|
||
/** | ||
* @var bool | ||
*/ | ||
protected readonly bool $strict; | ||
|
||
/** | ||
* Create a new array subset constraint instance. | ||
* | ||
* @param iterable $subset | ||
* @param bool $strict | ||
* @return void | ||
*/ | ||
public function __construct(iterable $subset, bool $strict = false) | ||
{ | ||
$this->strict = $strict; | ||
$this->subset = $subset; | ||
} | ||
|
||
/** | ||
* Evaluates the constraint for parameter $other. | ||
* | ||
* If $returnResult is set to false (the default), an exception is thrown | ||
* in case of a failure. null is returned otherwise. | ||
* | ||
* If $returnResult is true, the result of the evaluation is returned as | ||
* a boolean value instead: true in case of success, false in case of a | ||
* failure. | ||
* | ||
* @param mixed $other | ||
* @param string $description | ||
* @param bool $returnResult | ||
* @return bool|null | ||
* | ||
* @throws \PHPUnit\Framework\ExpectationFailedException | ||
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException | ||
*/ | ||
public function evaluate($other, string $description = '', bool $returnResult = false): ?bool | ||
{ | ||
// type cast $other & $this->subset as an array to allow | ||
// support in standard array functions. | ||
$other = $this->toArray($other); | ||
$subset = $this->toArray($this->subset); | ||
|
||
$patched = array_replace_recursive($other, $subset); | ||
|
||
if ($this->strict) { | ||
$result = $other === $patched; | ||
} else { | ||
$result = $other == $patched; | ||
} | ||
|
||
if ($returnResult) { | ||
return $result; | ||
} | ||
|
||
if (! $result) { | ||
$f = new ComparisonFailure( | ||
$patched, | ||
$other, | ||
var_export($patched, true), | ||
var_export($other, true) | ||
); | ||
|
||
$this->fail($other, $description, $f); | ||
} | ||
|
||
return null; | ||
} | ||
|
||
/** | ||
* Returns a string representation of the constraint. | ||
* | ||
* @return string | ||
* | ||
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException | ||
*/ | ||
public function toString(): string | ||
{ | ||
return 'has the subset '.(new Exporter)->export($this->subset); | ||
} | ||
|
||
/** | ||
* Returns the description of the failure. | ||
* | ||
* The beginning of failure messages is "Failed asserting that" in most | ||
* cases. This method should return the second part of that sentence. | ||
* | ||
* @param mixed $other | ||
* @return string | ||
* | ||
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException | ||
*/ | ||
protected function failureDescription($other): string | ||
{ | ||
return 'an array '.$this->toString(); | ||
} | ||
|
||
/** | ||
* Returns the description of the failure. | ||
* | ||
* The beginning of failure messages is "Failed asserting that" in most | ||
* cases. This method should return the second part of that sentence. | ||
* | ||
* @param iterable $other | ||
* @return array | ||
*/ | ||
protected function toArray(iterable $other): array | ||
{ | ||
if (is_array($other)) { | ||
return $other; | ||
} | ||
|
||
if ($other instanceof ArrayObject) { | ||
return $other->getArrayCopy(); | ||
} | ||
|
||
if ($other instanceof Traversable) { | ||
return iterator_to_array($other); | ||
} | ||
|
||
return (array) $other; | ||
} | ||
} |
Oops, something went wrong.