php-mockery-doc 0.9.4-1build1 / usr / share / doc / php-mockery / html / reference / object_recording.html

This file is indexed.

/usr/share/doc/php-mockery/html/reference/object_recording.html is in php-mockery-doc 0.9.4-1build1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Mock Object Recording &mdash; Mockery Docs 0.9 documentation</title>
  

  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  

  

  
    <link rel="top" title="Mockery Docs 0.9 documentation" href="../index.html"/>
        <link rel="up" title="Reference" href="index.html"/>
        <link rel="next" title="Dealing with Final Classes/Methods" href="final_methods_classes.html"/>
        <link rel="prev" title="Mocking Demeter Chains And Fluent Interfaces" href="demeter_chains.html"/> 

  
  <script src="../_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="../index.html" class="icon icon-home"> Mockery Docs
          

          
          </a>

          
            
            
              <div class="version">
                0.9
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
                <ul>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/index.html">Getting Started</a></li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="startup_methods.html">Quick Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="expectations.html">Expectation Declarations</a></li>
<li class="toctree-l2"><a class="reference internal" href="argument_validation.html">Argument Validation</a></li>
<li class="toctree-l2"><a class="reference internal" href="partial_mocks.html">Creating Partial Mocks</a></li>
<li class="toctree-l2"><a class="reference internal" href="public_properties.html">Mocking Public Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="public_static_properties.html">Mocking Public Static Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="pass_by_reference_behaviours.html">Preserving Pass-By-Reference Method Parameter Behaviour</a></li>
<li class="toctree-l2"><a class="reference internal" href="demeter_chains.html">Mocking Demeter Chains And Fluent Interfaces</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="">Mock Object Recording</a></li>
<li class="toctree-l2"><a class="reference internal" href="final_methods_classes.html">Dealing with Final Classes/Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="magic_methods.html">PHP Magic Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="mockery/index.html">Mockery</a></li>
<li class="toctree-l2"><a class="reference internal" href="index.html#mockery-reference">Mockery Reference</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../cookbook/index.html">Cookbook</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="../index.html">Mockery Docs</a>
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          

 



<div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="../index.html">Docs</a> &raquo;</li>
      
          <li><a href="index.html">Reference</a> &raquo;</li>
      
    <li>Mock Object Recording</li>
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="../_sources/reference/object_recording.txt" rel="nofollow"> View page source</a>
          
        
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="mock-object-recording">
<span id="index-0"></span><h1>Mock Object Recording<a class="headerlink" href="#mock-object-recording" title="Permalink to this headline"></a></h1>
<p>In certain cases, you may find that you are testing against an already
established pattern of behaviour, perhaps during refactoring. Rather then hand
crafting mock object expectations for this behaviour, you could instead use
the existing source code to record the interactions a real object undergoes
onto a mock object as expectations - expectations you can then verify against
an alternative or refactored version of the source code.</p>
<p>To record expectations, you need a concrete instance of the class to be
mocked.  This can then be used to create a partial mock to which is given the
necessary code to execute the object interactions to be recorded. A simple
example is outline below (we use a closure for passing instructions to the
mock).</p>
<p>Here we have a very simple setup, a class (<code class="docutils literal"><span class="pre">SubjectUser</span></code>) which uses another
class (<code class="docutils literal"><span class="pre">Subject</span></code>) to retrieve some value. We want to record as expectations
on our mock (which will replace <code class="docutils literal"><span class="pre">Subject</span></code> later) all the calls and return
values of a Subject instance when interacting with <code class="docutils literal"><span class="pre">SubjectUser</span></code>.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="x">class Subject</span>
<span class="x">{</span>

<span class="x">    public function execute() {</span>
<span class="x">        return &#39;executed!&#39;;</span>
<span class="x">    }</span>

<span class="x">}</span>

<span class="x">class SubjectUser</span>
<span class="x">{</span>

<span class="x">    public function use(Subject $subject) {</span>
<span class="x">        return $subject-&gt;execute();</span>
<span class="x">    }</span>

<span class="x">}</span>
</pre></div>
</div>
<p>Here&#8217;s the test case showing the recording:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="x">class SubjectUserTest extends PHPUnit_Framework_TestCase</span>
<span class="x">{</span>

<span class="x">    public function tearDown()</span>
<span class="x">    {</span>
<span class="x">        \Mockery::close();</span>
<span class="x">    }</span>

<span class="x">    public function testSomething()</span>
<span class="x">    {</span>
<span class="x">        $mock = \Mockery::mock(new Subject);</span>
<span class="x">        $mock-&gt;shouldExpect(function ($subject) {</span>
<span class="x">            $user = new SubjectUser;</span>
<span class="x">            $user-&gt;use($subject);</span>
<span class="x">        });</span>

<span class="x">        /**</span>
<span class="x">        * Assume we have a replacement SubjectUser called NewSubjectUser.</span>
<span class="x">        * We want to verify it behaves identically to SubjectUser, i.e.</span>
<span class="x">        * it uses Subject in the exact same way</span>
<span class="x">        */</span>
<span class="x">        $newSubject = new NewSubjectUser;</span>
<span class="x">        $newSubject-&gt;use($mock);</span>
<span class="x">    }</span>

<span class="x">}</span>
</pre></div>
</div>
<p>After the <code class="docutils literal"><span class="pre">\Mockery::close()</span></code> call in <code class="docutils literal"><span class="pre">tearDown()</span></code> validates the mock
object, we should have zero exceptions if <code class="docutils literal"><span class="pre">NewSubjectUser</span></code> acted on
<cite>Subject</cite> in a similar way to <code class="docutils literal"><span class="pre">SubjectUser</span></code>. By default the order of calls
are not enforced, and loose argument matching is enabled, i.e. arguments may
be equal (<code class="docutils literal"><span class="pre">==</span></code>) but not necessarily identical (<code class="docutils literal"><span class="pre">===</span></code>).</p>
<p>If you wished to be more strict, for example ensuring the order of calls and
the final call counts were identical, or ensuring arguments are completely
identical, you can invoke the recorder&#8217;s strict mode from the closure block,
e.g.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="x">$mock-&gt;shouldExpect(function ($subject) {</span>
<span class="x">    $subject-&gt;shouldBeStrict();</span>
<span class="x">    $user = new SubjectUser;</span>
<span class="x">    $user-&gt;use($subject);</span>
<span class="x">});</span>
</pre></div>
</div>
</div>


           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="final_methods_classes.html" class="btn btn-neutral float-right" title="Dealing with Final Classes/Methods" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="demeter_chains.html" class="btn btn-neutral" title="Mocking Demeter Chains And Fluent Interfaces" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2014, Pádraic Brady, Dave Marshall, Wouter, Graham Campbell.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'../',
            VERSION:'0.9',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true
        };
    </script>
      <script type="text/javascript" src="../_static/jquery.js"></script>
      <script type="text/javascript" src="../_static/underscore.js"></script>
      <script type="text/javascript" src="../_static/doctools.js"></script>

  

  
  
    <script type="text/javascript" src="../_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>

APT Browse - Built by Thomas Orozco.