tests/PHPUnit/PHPUnit/Framework/MockObject/Matcher/InvokedCount.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 checks if a method has been invoked a certain amount
  47  * of times.
  48  * If the number of invocations exceeds the value it will immediately throw an
  49  * exception,
  50  * If the number is less it will later be checked in verify() and also throw an
  51  * exception.
  52  *
  53  * @package    PHPUnit_MockObject
  54  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  55  * @copyright  2010-2011 Sebastian Bergmann <sb@sebastian-bergmann.de>
  56  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  57  * @version    Release: 1.0.8
  58  * @link       http://github.com/sebastianbergmann/phpunit-mock-objects
  59  * @since      Class available since Release 1.0.0
  60  */
  61 class PHPUnit_Framework_MockObject_Matcher_InvokedCount extends PHPUnit_Framework_MockObject_Matcher_InvokedRecorder
  62 {
  63     /**
  64      * @var integer
  65      */
  66     protected $expectedCount;
  67
  68     /**
  69      * @param interger $expectedCount
  70      */
  71     public function __construct($expectedCount)
  72     {
  73         $this->expectedCount = $expectedCount;
  74     }
  75
  76     /**
  77      * @return string
  78      */
  79     public function toString()
  80     {
  81         return 'invoked ' . $this->expectedCount . ' time(s)';
  82     }
  83
  84     /**
  85      * @param  PHPUnit_Framework_MockObject_Invocation $invocation
  86      * @throws PHPUnit_Framework_ExpectationFailedException
  87      */
  88     public function invoked(PHPUnit_Framework_MockObject_Invocation $invocation)
  89     {
  90         parent::invoked($invocation);
  91
  92         $count = $this->getInvocationCount();
  93
  94         if ($count > $this->expectedCount) {
  95             $message = $invocation->toString() . ' ';
  96
  97             switch ($this->expectedCount) {
  98                 case 0: {
  99                     $message .= 'was not expected to be called.';
 100                 }
 101                 break;
 102
 103                 case 1: {
 104                     $message .= 'was not expected to be called more than once.';
 105                 }
 106                 break;
 107
 108                 default: {
 109                     $message .= sprintf(
 110                       'was not expected to be called more than %d times.',
 111
 112                       $this->expectedCount
 113                     );
 114                 }
 115             }
 116
 117             throw new PHPUnit_Framework_ExpectationFailedException($message);
 118         }
 119     }
 120
 121     /**
 122      * Verifies that the current expectation is valid. If everything is OK the
 123      * code should just return, if not it must throw an exception.
 124      *
 125      * @throws PHPUnit_Framework_ExpectationFailedException
 126      */
 127     public function verify()
 128     {
 129         $count = $this->getInvocationCount();
 130
 131         if ($count !== $this->expectedCount) {
 132             throw new PHPUnit_Framework_ExpectationFailedException(
 133               sprintf(
 134                 'Method was expected to be called %d times, ' .
 135                 'actually called %d times.',
 136
 137                 $this->expectedCount,
 138                 $count
 139               )
 140             );
 141         }
 142     }
 143 }