tests/PHPUnit/PHPUnit/Framework/MockObject/Matcher/Parameters.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2010-2011, Sebastian Bergmann <sb@sebastian-bergmann.de>.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  *   * Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *
  15  *   * Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in
  17  *     the documentation and/or other materials provided with the
  18  *     distribution.
  19  *
  20  *   * Neither the name of Sebastian Bergmann nor the names of his
  21  *     contributors may be used to endorse or promote products derived
  22  *     from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  28  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * @package    PHPUnit_MockObject
  38  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  39  * @copyright  2010-2011 Sebastian Bergmann <sb@sebastian-bergmann.de>
  40  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  41  * @link       http://github.com/sebastianbergmann/phpunit-mock-objects
  42  * @since      File available since Release 1.0.0
  43  */
  44
  45 /**
  46  * Invocation matcher which looks for specific parameters in the invocations.
  47  *
  48  * Checks the parameters of all incoming invocations, the parameter list is
  49  * checked against the defined constraints in $parameters. If the constraint
  50  * is met it will return true in matches().
  51  *
  52  * @package    PHPUnit_MockObject
  53  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  54  * @copyright  2010-2011 Sebastian Bergmann <sb@sebastian-bergmann.de>
  55  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  56  * @version    Release: 1.0.8
  57  * @link       http://github.com/sebastianbergmann/phpunit-mock-objects
  58  * @since      Class available since Release 1.0.0
  59  */
  60 class PHPUnit_Framework_MockObject_Matcher_Parameters extends PHPUnit_Framework_MockObject_Matcher_StatelessInvocation
  61 {
  62     /**
  63      * @var array
  64      */
  65     protected $parameters = array();
  66
  67     /**
  68      * @var PHPUnit_Framework_MockObject_Invocation
  69      */
  70     protected $invocation;
  71
  72     /**
  73      * @param array $parameters
  74      */
  75     public function __construct(array $parameters)
  76     {
  77         foreach($parameters as $parameter) {
  78             if (!($parameter instanceof PHPUnit_Framework_Constraint)) {
  79                 $parameter = new PHPUnit_Framework_Constraint_IsEqual(
  80                   $parameter
  81                 );
  82             }
  83
  84             $this->parameters[] = $parameter;
  85         }
  86     }
  87
  88     /**
  89      * @return string
  90      */
  91     public function toString()
  92     {
  93         $text = 'with parameter';
  94
  95         foreach($this->parameters as $index => $parameter) {
  96             if ($index > 0) {
  97                 $text .= ' and';
  98             }
  99
 100             $text .= ' ' . $index . ' ' . $parameter->toString();
 101         }
 102
 103         return $text;
 104     }
 105
 106     /**
 107      * @param  PHPUnit_Framework_MockObject_Invocation $invocation
 108      * @return boolean
 109      */
 110     public function matches(PHPUnit_Framework_MockObject_Invocation $invocation)
 111     {
 112         $this->invocation = $invocation;
 113         $this->verify();
 114
 115         return count($invocation->parameters) < count($this->parameters);
 116     }
 117
 118     /**
 119      * Checks if the invocation $invocation matches the current rules. If it
 120      * does the matcher will get the invoked() method called which should check
 121      * if an expectation is met.
 122      *
 123      * @param  PHPUnit_Framework_MockObject_Invocation $invocation
 124      *         Object containing information on a mocked or stubbed method which
 125      *         was invoked.
 126      * @return bool
 127      * @throws PHPUnit_Framework_ExpectationFailedException
 128      */
 129     public function verify()
 130     {
 131         if ($this->invocation === NULL) {
 132             throw new PHPUnit_Framework_ExpectationFailedException(
 133               'Mocked method does not exist.'
 134             );
 135         }
 136
 137         if (count($this->invocation->parameters) < count($this->parameters)) {
 138             throw new PHPUnit_Framework_ExpectationFailedException(
 139               sprintf(
 140                 'Parameter count for invocation %s is too low.',
 141
 142                 $this->invocation->toString()
 143               )
 144             );
 145         }
 146
 147         foreach ($this->parameters as $i => $parameter) {
 148             if (!$parameter->evaluate($this->invocation->parameters[$i])) {
 149                 $parameter->fail(
 150                   $this->invocation->parameters[$i],
 151                   sprintf(
 152                     'Parameter %s for invocation %s does not match expected ' .
 153                     'value.',
 154
 155                     $i,
 156                     $this->invocation->toString()
 157                   )
 158                 );
 159             }
 160         }
 161     }
 162 }