lib/phpunit/classes/constraint_object_is_equal_with_exceptions.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 /**
  18  * Constraint that checks a simple object with an isEqual constrain, allowing for exceptions to be made for some fields.
  19  *
  20  * @package    core
  21  * @category   phpunit
  22  * @copyright  2015 Andrew Nicols <andrew@nicols.co.uk>
  23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24  */
  25
  26
  27 /**
  28  * Constraint that checks a simple object with an isEqual constrain, allowing for exceptions to be made for some fields.
  29  *
  30  * @package    core
  31  * @category   phpunit
  32  * @copyright  2015 Andrew Nicols <andrew@nicols.co.uk>
  33  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  34  */
  35 class phpunit_constraint_object_is_equal_with_exceptions extends PHPUnit\Framework\Constraint\Constraint {
  36
  37     /**
  38      * @var array $keys The list of exceptions.
  39      */
  40     protected $keys = array();
  41
  42     /**
  43      * @var mixed $value Need to keep it here because it became private for PHPUnit 7.x and up
  44      */
  45     protected $capturedvalue;
  46
  47     /**
  48      * @var \PHPUnit\Framework\Constraint\IsEqual $isequal original constraint to be used internally.
  49      */
  50     protected $isequal;
  51
  52     /**
  53      * Override constructor to capture value
  54      */
  55     public function __construct($value, float $delta = 0.0, int $maxDepth = 10, bool $canonicalize = false,
  56                                 bool $ignoreCase = false) {
  57         $this->isequal = new \PHPUnit\Framework\Constraint\IsEqual($value, $delta, $maxDepth, $canonicalize, $ignoreCase);
  58         $this->capturedvalue = $value;
  59     }
  60
  61     /**
  62      * Add an exception for the named key to use a different comparison
  63      * method. Any assertion provided by PHPUnit\Framework\Assert is
  64      * acceptable.
  65      *
  66      * @param string $key The key to except.
  67      * @param string $comparator The assertion to use.
  68      */
  69     public function add_exception($key, $comparator) {
  70         $this->keys[$key] = $comparator;
  71     }
  72
  73     /**
  74      * Evaluates the constraint for parameter $other
  75      *
  76      * If $shouldreturnesult is set to false (the default), an exception is thrown
  77      * in case of a failure. null is returned otherwise.
  78      *
  79      * If $shouldreturnesult is true, the result of the evaluation is returned as
  80      * a boolean value instead: true in case of success, false in case of a
  81      * failure.
  82      *
  83      * @param  mixed    $other              Value or object to evaluate.
  84      * @param  string   $description        Additional information about the test
  85      * @param  bool     $shouldreturnesult  Whether to return a result or throw an exception
  86      * @return mixed
  87      * @throws PHPUnit\Framework\ExpectationFailedException
  88      */
  89     public function evaluate($other, string $description = '', bool $shouldreturnesult = false): ?bool {
  90         foreach ($this->keys as $key => $comparison) {
  91             if (isset($other->$key) || isset($this->capturedvalue->$key)) {
  92                 // One of the keys is present, therefore run the comparison.
  93                 PHPUnit\Framework\Assert::$comparison($this->capturedvalue->$key, $other->$key);
  94
  95                 // Unset the keys, otherwise the standard evaluation will take place.
  96                 unset($other->$key);
  97                 unset($this->capturedvalue->$key);
  98             }
  99         }
 100
 101         // Run the IsEqual evaluation.
 102         return $this->isequal->evaluate($other, $description, $shouldreturnesult);
 103     }
 104
 105     // \PHPUnit\Framework\Constraint\IsEqual wrapping.
 106     public function toString(): string {
 107         return $this->isequal->toString();
 108     }
 109
 110 }