tests/PHPUnit/Framework/MockObject/InvocationMocker.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/Util/Filter.php';
  49 require_once 'PHPUnit/Framework/MockObject/Builder/InvocationMocker.php';
  50 require_once 'PHPUnit/Framework/MockObject/Builder/Match.php';
  51 require_once 'PHPUnit/Framework/MockObject/Builder/Namespace.php';
  52 require_once 'PHPUnit/Framework/MockObject/Matcher.php';
  53 require_once 'PHPUnit/Framework/MockObject/Stub.php';
  54 require_once 'PHPUnit/Framework/MockObject/Invocation.php';
  55 require_once 'PHPUnit/Framework/MockObject/Invokable.php';
  56
  57 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  58
  59 /**
  60  * Mocker for invocations which are sent from
  61  * PHPUnit_Framework_MockObject_MockObject objects.
  62  *
  63  * Keeps track of all expectations and stubs as well as registering
  64  * identifications for builders.
  65  *
  66  * @category   Testing
  67  * @package    PHPUnit
  68  * @author     Jan Borsodi <jb@ez.no>
  69  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  70  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  71  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  72  * @version    Release: 3.3.17
  73  * @link       http://www.phpunit.de/
  74  * @since      Class available since Release 3.0.0
  75  */
  76 class PHPUnit_Framework_MockObject_InvocationMocker implements PHPUnit_Framework_MockObject_Stub_MatcherCollection, PHPUnit_Framework_MockObject_Invokable, PHPUnit_Framework_MockObject_Builder_Namespace
  77 {
  78     protected $matchers = array();
  79
  80     protected $builderMap = array();
  81
  82     public function addMatcher(PHPUnit_Framework_MockObject_Matcher_Invocation $matcher)
  83     {
  84         $this->matchers[] = $matcher;
  85     }
  86
  87     public function lookupId($id)
  88     {
  89         if (isset($this->builderMap[$id])) {
  90             return $this->builderMap[$id];
  91         }
  92
  93         return NULL;
  94     }
  95
  96     public function registerId($id, PHPUnit_Framework_MockObject_Builder_Match $builder)
  97     {
  98         if (isset($this->builderMap[$id])) {
  99             throw new RuntimeException("Match builder with id <{$id}> is already registered.");
 100         }
 101
 102         $this->builderMap[$id] = $builder;
 103     }
 104
 105     public function expects(PHPUnit_Framework_MockObject_Matcher_Invocation $matcher)
 106     {
 107         $builder = new PHPUnit_Framework_MockObject_Builder_InvocationMocker($this, $matcher);
 108
 109         return $builder;
 110     }
 111
 112     public function invoke(PHPUnit_Framework_MockObject_Invocation $invocation)
 113     {
 114         $exception      = NULL;
 115         $hasReturnValue = FALSE;
 116
 117         if (strtolower($invocation->methodName) == '__tostring') {
 118             $returnValue = '';
 119         } else {
 120             $returnValue = NULL;
 121         }
 122
 123         foreach ($this->matchers as $match) {
 124             try {
 125                 if ($match->matches($invocation)) {
 126                     $value = $match->invoked($invocation);
 127
 128                     if (!$hasReturnValue) {
 129                         $returnValue    = $value;
 130                         $hasReturnValue = TRUE;
 131                     }
 132                 }
 133             }
 134
 135             catch (Exception $e) {
 136                 $exception = $e;
 137             }
 138         }
 139
 140         if ($exception !== NULL) {
 141             throw $exception;
 142         }
 143
 144         return $returnValue;
 145     }
 146
 147     public function matches(PHPUnit_Framework_MockObject_Invocation $invocation)
 148     {
 149         foreach($this->matchers as $matcher) {
 150             if (!$matcher->matches($invocation)) {
 151                 return FALSE;
 152             }
 153         }
 154
 155         return TRUE;
 156     }
 157
 158     public function verify()
 159     {
 160         foreach($this->matchers as $matcher) {
 161             $matcher->verify();
 162         }
 163     }
 164 }
 165 ?>