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

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2009, 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  * @category   Testing
  38  * @package    PHPUnit
  39  * @author     Jan Borsodi <jb@ez.no>
  40  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  42  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  43
  44  * @link       http://www.phpunit.de/
  45  * @since      File available since Release 3.0.0
  46  */
  47
  48 require_once 'PHPUnit/Framework.php';
  49 require_once 'PHPUnit/Util/Filter.php';
  50 require_once 'PHPUnit/Framework/MockObject/Matcher/Invocation.php';
  51 require_once 'PHPUnit/Framework/MockObject/Invocation.php';
  52
  53 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  54
  55 /**
  56  * Invocation matcher which checks if a method was invoked at a certain index.
  57  *
  58  * If the expected index number does not match the current invocation index it
  59  * will not match which means it skips all method and parameter matching. Only
  60  * once the index is reached will the method and parameter start matching and
  61  * verifying.
  62  *
  63  * If the index is never reached it will throw an exception in index.
  64  *
  65  * @category   Testing
  66  * @package    PHPUnit
  67  * @author     Jan Borsodi <jb@ez.no>
  68  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  69  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  70  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  71  * @version    Release: 3.3.17
  72  * @link       http://www.phpunit.de/
  73  * @since      Class available since Release 3.0.0
  74  */
  75 class PHPUnit_Framework_MockObject_Matcher_InvokedAtIndex implements PHPUnit_Framework_MockObject_Matcher_Invocation
  76 {
  77     protected $sequenceIndex;
  78
  79     protected $currentIndex = -1;
  80
  81     public function __construct($sequenceIndex)
  82     {
  83         $this->sequenceIndex = $sequenceIndex;
  84     }
  85
  86     public function toString()
  87     {
  88         return 'invoked at sequence index ' . $this->sequenceIndex;
  89     }
  90
  91     public function matches(PHPUnit_Framework_MockObject_Invocation $invocation)
  92     {
  93         $this->currentIndex++;
  94
  95         return $this->currentIndex == $this->sequenceIndex;
  96     }
  97
  98     public function invoked(PHPUnit_Framework_MockObject_Invocation $invocation)
  99     {
 100     }
 101
 102     public function verify()
 103     {
 104         if ($this->currentIndex < $this->sequenceIndex) {
 105             throw new PHPUnit_Framework_ExpectationFailedException(
 106               sprintf(
 107                 'The expected invocation at index %s was never reached.',
 108
 109                 $this->sequenceIndex
 110               )
 111             );
 112         }
 113     }
 114 }
 115 ?>