← Back to branch summary

~tcuthbert/wordpress/openstack-objectstorage

« back to all changes in this revision

Viewing changes to vendor/phpunit/phpunit-mock-objects/src/Framework/MockObject/Matcher/ConsecutiveParameters.php

  • Committer: Jacek Nykis
  • Date: 2015-02-11 15:35:31 UTC
  • Revision ID: jacek.nykis@canonical.com-20150211153531-hmy6zi0ov2qfkl0b
Initial commit

Show diffs side-by-side

added added

removed removed

Lines of Context:
vendor/phpunit/phpunit-mock-objects/src/Framework/MockObject/Matcher/ConsecutiveParameters.php
 
1
<?php
 
2
/**
 
3
 * PHPUnit
 
4
 *
 
5
 * Copyright (c) 2010-2014, Sebastian Bergmann <sebastian@phpunit.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 <sebastian@phpunit.de>
 
39
 * @copyright  2010-2014 Sebastian Bergmann <sebastian@phpunit.de>
 
40
 * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
 
41
 * @link       http://github.com/sebastianbergmann/phpunit-mock-objects
 
42
 */
 
43
 
 
44
/**
 
45
 * Invocation matcher which looks for sets of specific parameters in the invocations.
 
46
 *
 
47
 * Checks the parameters of the incoming invocations, the parameter list is
 
48
 * checked against the defined constraints in $parameters. If the constraint
 
49
 * is met it will return true in matches().
 
50
 *
 
51
 * It takes a list of match groups and and increases a call index after each invocation.
 
52
 * So the first invocation uses the first group of constraints, the second the next and so on.
 
53
 *
 
54
 * @package    PHPUnit_MockObject
 
55
 * @author     Sebastian Bergmann <sebastian@phpunit.de>
 
56
 * @copyright  2010-2014 Sebastian Bergmann <sebastian@phpunit.de>
 
57
 * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
 
58
 * @version    Release: @package_version@
 
59
 * @link       http://github.com/sebastianbergmann/phpunit-mock-objects
 
60
 */
 
61
class PHPUnit_Framework_MockObject_Matcher_ConsecutiveParameters
 
62
  extends PHPUnit_Framework_MockObject_Matcher_StatelessInvocation
 
63
{
 
64
 
 
65
  /**
 
66
   * @var array
 
67
   */
 
68
  private $_parameterGroups = array();
 
69
 
 
70
  /**
 
71
   * @var array
 
72
   */
 
73
  private $_invocations = array();
 
74
 
 
75
  /**
 
76
   * @param array $parameterGroups
 
77
   */
 
78
  public function __construct(array $parameterGroups)
 
79
  {
 
80
      foreach ($parameterGroups as $index => $parameters) {
 
81
          foreach ($parameters as $parameter) {
 
82
              if (!($parameter instanceof \PHPUnit_Framework_Constraint))
 
83
              {
 
84
                  $parameter = new \PHPUnit_Framework_Constraint_IsEqual($parameter);
 
85
              }
 
86
              $this->_parameterGroups[$index][] = $parameter;
 
87
          }
 
88
      }
 
89
  }
 
90
 
 
91
    /**
 
92
     * @return string
 
93
     */
 
94
    public function toString()
 
95
    {
 
96
        $text = 'with consecutive parameters';
 
97
 
 
98
        return $text;
 
99
    }
 
100
 
 
101
  /**
 
102
   * @param PHPUnit_Framework_MockObject_Invocation $invocation
 
103
   * @return bool
 
104
   */
 
105
  public function matches(PHPUnit_Framework_MockObject_Invocation $invocation)
 
106
  {
 
107
      $this->_invocations[] = $invocation;
 
108
      $callIndex = count($this->_invocations) - 1;
 
109
      $this->verifyInvocation($invocation, $callIndex);
 
110
      return FALSE;
 
111
  }
 
112
 
 
113
  public function verify()
 
114
  {
 
115
      foreach ($this->_invocations as $callIndex => $invocation) {
 
116
        $this->verifyInvocation($invocation, $callIndex);
 
117
      }
 
118
  }
 
119
 
 
120
  /**
 
121
   * Verify a single invocation
 
122
   *
 
123
   * @param PHPUnit_Framework_MockObject_Invocation $invocation
 
124
   * @param int $callIndex
 
125
   * @throws PHPUnit_Framework_ExpectationFailedException
 
126
   */
 
127
  private function verifyInvocation(PHPUnit_Framework_MockObject_Invocation $invocation, $callIndex)
 
128
  {
 
129
 
 
130
      if (isset($this->_parameterGroups[$callIndex])) {
 
131
          $parameters = $this->_parameterGroups[$callIndex];
 
132
      } else {
 
133
        // no parameter assertion for this call index
 
134
        return;
 
135
      }
 
136
 
 
137
      if ($invocation === NULL) {
 
138
          throw new PHPUnit_Framework_ExpectationFailedException(
 
139
            'Mocked method does not exist.'
 
140
          );
 
141
      }
 
142
 
 
143
      if (count($invocation->parameters) < count($parameters)) {
 
144
          throw new PHPUnit_Framework_ExpectationFailedException(
 
145
              sprintf(
 
146
                'Parameter count for invocation %s is too low.',
 
147
                $invocation->toString()
 
148
              )
 
149
          );
 
150
      }
 
151
 
 
152
      foreach ($parameters as $i => $parameter) {
 
153
          $parameter->evaluate(
 
154
              $invocation->parameters[$i],
 
155
              sprintf(
 
156
                'Parameter %s for invocation #%d %s does not match expected ' .
 
157
                'value.',
 
158
                $i,
 
159
                $callIndex,
 
160
                $invocation->toString()
 
161
              )
 
162
          );
 
163
      }
 
164
  }
 
165
}