tests/PHPUnit/Framework/MockObject/Builder/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/MethodNameMatch.php';
  50 require_once 'PHPUnit/Framework/MockObject/Matcher.php';
  51 require_once 'PHPUnit/Framework/MockObject/Stub.php';
  52
  53 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  54
  55 /**
  56  * Builder for mocked or stubbed invocations.
  57  *
  58  * Provides methods for building expectations without having to resort to
  59  * instantiating the various matchers manually. These methods also form a
  60  * more natural way of reading the expectation. This class should be together
  61  * with the test case PHPUnit_Framework_MockObject_TestCase.
  62  *
  63  * @category   Testing
  64  * @package    PHPUnit
  65  * @author     Jan Borsodi <jb@ez.no>
  66  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  67  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  68  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  69  * @version    Release: 3.3.17
  70  * @link       http://www.phpunit.de/
  71  * @since      Class available since Release 3.0.0
  72  */
  73 class PHPUnit_Framework_MockObject_Builder_InvocationMocker implements PHPUnit_Framework_MockObject_Builder_MethodNameMatch
  74 {
  75     protected $collection;
  76
  77     protected $matcher;
  78
  79     public function __construct(PHPUnit_Framework_MockObject_Stub_MatcherCollection $collection, PHPUnit_Framework_MockObject_Matcher_Invocation $invocationMatcher)
  80     {
  81         $this->collection = $collection;
  82         $this->matcher    = new PHPUnit_Framework_MockObject_Matcher($invocationMatcher);
  83
  84         $this->collection->addMatcher($this->matcher);
  85     }
  86
  87     public function getMatcher()
  88     {
  89         return $this->matcher;
  90     }
  91
  92     public function id($id)
  93     {
  94         $this->collection->registerId($id, $this);
  95
  96         return $this;
  97     }
  98
  99     public function will(PHPUnit_Framework_MockObject_Stub $stub)
 100     {
 101         $this->matcher->stub = $stub;
 102
 103         return $this;
 104     }
 105
 106     public function after($id)
 107     {
 108         $this->matcher->afterMatchBuilderId = $id;
 109
 110         return $this;
 111     }
 112
 113     public function with()
 114     {
 115         $args = func_get_args();
 116
 117         if ($this->matcher->methodNameMatcher === NULL) {
 118             throw new RuntimeException('Method name matcher is not defined, cannot define parameter matcher without one');
 119         }
 120
 121         if ( $this->matcher->parametersMatcher !== NULL) {
 122             throw new RuntimeException('Parameter matcher is already defined, cannot redefine');
 123         }
 124
 125         $this->matcher->parametersMatcher = new PHPUnit_Framework_MockObject_Matcher_Parameters($args);
 126
 127         return $this;
 128     }
 129
 130     public function withAnyParameters()
 131     {
 132         if ($this->matcher->methodNameMatcher === NULL) {
 133             throw new RuntimeException('Method name matcher is not defined, cannot define parameter matcher without one');
 134         }
 135
 136         if ($this->matcher->parametersMatcher !== NULL) {
 137             throw new RuntimeException('Parameter matcher is already defined, cannot redefine');
 138         }
 139
 140         $this->matcher->parametersMatcher = new PHPUnit_Framework_MockObject_Matcher_AnyParameters();
 141
 142         return $this;
 143     }
 144
 145     public function method($constraint)
 146     {
 147         if ($this->matcher->methodNameMatcher !== NULL) {
 148             throw new RuntimeException('Method name matcher is already defined, cannot redefine');
 149         }
 150
 151         $this->matcher->methodNameMatcher = new PHPUnit_Framework_MockObject_Matcher_MethodName($constraint);
 152
 153         return $this;
 154     }
 155 }
 156 ?>