ArraySubset.php

<?php

namespace Illuminate\Foundation\Testing\Constraints;

use ArrayObject;
use PHPUnit\Framework\Constraint\Constraint;
use PHPUnit\Runner\Version;
use SebastianBergmann\Comparator\ComparisonFailure;
use Traversable;

if (class_exists(Version::class) && (int) Version::series()[0] >= 9) {
    /**
     * @internal This class is not meant to be used or overwritten outside the framework itself.
     */
    final class ArraySubset extends Constraint
    {
        /**
         * @var iterable
         */
        private $subset;

        /**
         * @var bool
         */
        private $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);
            $this->subset = $this->toArray($this->subset);

            $patched = array_replace_recursive($other, $this->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.
         *
         * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
         *
         * @return string
         */
        public function toString(): string
        {
            return 'has the subset '.$this->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
         */
        private 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);
            }

            // Keep BC even if we know that array would not be the expected one
            return (array) $other;
        }
    }
} else {
    /**
     * @internal This class is not meant to be used or overwritten outside the framework itself.
     */
    final class ArraySubset extends Constraint
    {
        /**
         * @var iterable
         */
        private $subset;

        /**
         * @var bool
         */
        private $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)
        {
            // type cast $other & $this->subset as an array to allow
            // support in standard array functions.
            $other = $this->toArray($other);
            $this->subset = $this->toArray($this->subset);

            $patched = array_replace_recursive($other, $this->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);
            }
        }

        /**
         * Returns a string representation of the constraint.
         *
         * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
         *
         * @return string
         */
        public function toString(): string
        {
            return 'has the subset '.$this->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
         */
        private 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);
            }

            // Keep BC even if we know that array would not be the expected one
            return (array) $other;
        }
    }
}