<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
<title>Class: Caricature::Expectation</title>
<link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
<script src="../js/jquery.js" type="text/javascript"
charset="utf-8"></script>
<script src="../js/thickbox-compressed.js" type="text/javascript"
charset="utf-8"></script>
<script src="../js/quicksearch.js" type="text/javascript"
charset="utf-8"></script>
<script src="../js/darkfish.js" type="text/javascript"
charset="utf-8"></script>
</head>
<body class="class">
<div id="metadata">
<div id="file-metadata">
<div id="file-list-section" class="section">
<h3 class="section-header">In Files</h3>
<div class="section-body">
<ul>
<li><a href="../lib/caricature/expectation_rb.html?TB_iframe=true&height=550&width=785"
class="thickbox" title="lib/caricature/expectation.rb">lib/caricature/expectation.rb</a></li>
</ul>
</div>
</div>
</div>
<div id="class-metadata">
<!-- Parent Class -->
<div id="parent-class-section" class="section">
<h3 class="section-header">Parent</h3>
<p class="link"><a href="../Object.html">Object</a></p>
</div>
<!-- Namespace Contents -->
<!-- Method Quickref -->
<div id="method-list-section" class="section">
<h3 class="section-header">Methods</h3>
<ul class="link-list">
<li><a href="#M000038">::new</a></li>
<li><a href="#M000044">#call_super?</a></li>
<li><a href="#M000045">#execute</a></li>
<li><a href="#M000040">#has_error_args?</a></li>
<li><a href="#M000041">#has_return_value?</a></li>
<li><a href="#M000042">#super_before?</a></li>
</ul>
</div>
<!-- Included Modules -->
<div id="includes-section" class="section">
<h3 class="section-header">Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="Interception.html">Caricature::Interception</a></li>
</ul>
</div>
</div>
<div id="project-metadata">
<div id="fileindex-section" class="section project-section">
<h3 class="section-header">Files</h3>
<ul>
<li class="file"><a href="../README_markdown.html">README.markdown</a></li>
</ul>
</div>
<div id="classindex-section" class="section project-section">
<h3 class="section-header">Class Index
<span class="search-toggle"><img src="../images/find.png"
height="16" width="16" alt="[+]"
title="show/hide quicksearch" /></span></h3>
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
<fieldset>
<legend>Quicksearch</legend>
<input type="text" name="quicksearch" value=""
class="quicksearch-field" />
</fieldset>
</form>
<ul class="link-list">
<li><a href="../Caricature.html">Caricature</a></li>
<li><a href="../Caricature/ArgumentRecording.html">Caricature::ArgumentRecording</a></li>
<li><a href="../Caricature/ClrClassDescriptor.html">Caricature::ClrClassDescriptor</a></li>
<li><a href="../Caricature/ClrClassMessenger.html">Caricature::ClrClassMessenger</a></li>
<li><a href="../Caricature/ClrInterfaceDescriptor.html">Caricature::ClrInterfaceDescriptor</a></li>
<li><a href="../Caricature/ClrInterfaceIsolator.html">Caricature::ClrInterfaceIsolator</a></li>
<li><a href="../Caricature/ClrInterfaceMessenger.html">Caricature::ClrInterfaceMessenger</a></li>
<li><a href="../Caricature/ClrIsolator.html">Caricature::ClrIsolator</a></li>
<li><a href="../Caricature/Expectation.html">Caricature::Expectation</a></li>
<li><a href="../Caricature/ExpectationBuilder.html">Caricature::ExpectationBuilder</a></li>
<li><a href="../Caricature/ExpectationSyntax.html">Caricature::ExpectationSyntax</a></li>
<li><a href="../Caricature/Expectations.html">Caricature::Expectations</a></li>
<li><a href="../Caricature/Interception.html">Caricature::Interception</a></li>
<li><a href="../Caricature/Interception/ClassMethods.html">Caricature::Interception::ClassMethods</a></li>
<li><a href="../Caricature/Isolation.html">Caricature::Isolation</a></li>
<li><a href="../Caricature/Isolator.html">Caricature::Isolator</a></li>
<li><a href="../Caricature/MemberDescriptor.html">Caricature::MemberDescriptor</a></li>
<li><a href="../Caricature/Messenger.html">Caricature::Messenger</a></li>
<li><a href="../Caricature/MethodCallRecorder.html">Caricature::MethodCallRecorder</a></li>
<li><a href="../Caricature/MethodCallRecording.html">Caricature::MethodCallRecording</a></li>
<li><a href="../Caricature/RubyIsolator.html">Caricature::RubyIsolator</a></li>
<li><a href="../Caricature/RubyMessenger.html">Caricature::RubyMessenger</a></li>
<li><a href="../Caricature/RubyObjectDescriptor.html">Caricature::RubyObjectDescriptor</a></li>
<li><a href="../Caricature/TypeDescriptor.html">Caricature::TypeDescriptor</a></li>
<li><a href="../Caricature/Verification.html">Caricature::Verification</a></li>
<li><a href="../System.html">System</a></li>
<li><a href="../System/String.html">System::String</a></li>
<li><a href="../System/Type.html">System::Type</a></li>
<li><a href="../Array.html">Array</a></li>
<li><a href="../Class.html">Class</a></li>
<li><a href="../Hash.html">Hash</a></li>
<li><a href="../Module.html">Module</a></li>
<li><a href="../Object.html">Object</a></li>
<li><a href="../String.html">String</a></li>
</ul>
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
</div>
</div>
</div>
<div id="documentation">
<h1 class="class">Caricature::Expectation</h1>
<div id="description">
<p>
A description of an expectation. An expectation has the power to call the
proxy method or completely ignore it
</p>
</div>
<!-- Constants -->
<!-- Attributes -->
<div id="attribute-method-details" class="method-section section">
<h3 class="section-header">Attributes</h3>
<div id="method-name-attribute-method" class="method-detail">
<a name="method_name"></a>
<div class="method-heading attribute-method-heading">
<span class="method-name">method_name</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>
gets the <a href="Expectation.html#method_name">method_name</a> to which
this expectation needs to listen to
</p>
</div>
</div>
<div id="args-attribute-method" class="method-detail">
<a name="args"></a>
<div class="method-heading attribute-method-heading">
<span class="method-name">args</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>
the arguments that this expectation needs to be constrained by
</p>
</div>
</div>
<div id="error-args-attribute-method" class="method-detail">
<a name="error_args"></a>
<div class="method-heading attribute-method-heading">
<span class="method-name">error_args</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>
the <a href="Expectation.html#error_args">error_args</a> that this
expectation will raise an error with
</p>
</div>
</div>
<div id="return-value-attribute-method" class="method-detail">
<a name="return_value"></a>
<div class="method-heading attribute-method-heading">
<span class="method-name">return_value</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>
the value that this expecation will return when executed
</p>
</div>
</div>
<div id="super-attribute-method" class="method-detail">
<a name="super"></a>
<div class="method-heading attribute-method-heading">
<span class="method-name">super</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>
indicator for the mode to call the super <tt>:before</tt>, <tt>:after</tt>
and <tt>nil</tt>
</p>
</div>
</div>
</div>
<!-- Methods -->
<div id="public-class-method-details" class="method-section section">
<h3 class="section-header">Public Class Methods</h3>
<div id="new-method" class="method-detail ">
<a name="M000038"></a>
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(method_name, args, error_args, return_value, super_mode)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>
Initializes a new instance of an expectation
</p>
<div class="method-source-code"
id="new-source">
<pre>
<span class="ruby-comment cmt"># File lib/caricature/expectation.rb, line 102</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">method_name</span>, <span class="ruby-identifier">args</span>, <span class="ruby-identifier">error_args</span>, <span class="ruby-identifier">return_value</span>, <span class="ruby-identifier">super_mode</span>)
<span class="ruby-ivar">@method_name</span>, <span class="ruby-ivar">@args</span>, <span class="ruby-ivar">@error_args</span>, <span class="ruby-ivar">@return_value</span>, <span class="ruby-ivar">@super</span> =
<span class="ruby-identifier">method_name</span>, <span class="ruby-identifier">args</span>, <span class="ruby-identifier">error_args</span>, <span class="ruby-identifier">return_value</span>, <span class="ruby-identifier">super_mode</span>
<span class="ruby-ivar">@any_args</span> = <span class="ruby-keyword kw">true</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
</div>
<div id="public-instance-method-details" class="method-section section">
<h3 class="section-header">Public Instance Methods</h3>
<div id="call-super--method" class="method-detail ">
<a name="M000044"></a>
<div class="method-heading">
<span class="method-name">call_super?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>
indicates whether super needs to be called somewhere
</p>
<div class="method-source-code"
id="call-super--source">
<pre>
<span class="ruby-comment cmt"># File lib/caricature/expectation.rb, line 124</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">call_super?</span>
<span class="ruby-operator">!</span><span class="ruby-ivar">@super</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div id="execute-method" class="method-detail ">
<a name="M000045"></a>
<div class="method-heading">
<span class="method-name">execute</span><span
class="method-args">(*margs)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>
executes this expectation with its configuration
</p>
<div class="method-source-code"
id="execute-source">
<pre>
<span class="ruby-comment cmt"># File lib/caricature/expectation.rb, line 129</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">execute</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">margs</span>)
<span class="ruby-identifier">ags</span> = <span class="ruby-identifier">any_args?</span> <span class="ruby-value">? </span>(<span class="ruby-identifier">margs</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-value">? </span><span class="ruby-operator">:</span><span class="ruby-identifier">any</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">margs</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">args</span>
<span class="ruby-identifier">actual_raise</span> <span class="ruby-operator">*</span><span class="ruby-ivar">@error_args</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">has_error_args?</span>
<span class="ruby-keyword kw">return</span> <span class="ruby-identifier">return_value</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">has_return_value?</span>
<span class="ruby-keyword kw">nil</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div id="has-error-args--method" class="method-detail ">
<a name="M000040"></a>
<div class="method-heading">
<span class="method-name">has_error_args?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>
indicates whether this expecation will raise an event.
</p>
<div class="method-source-code"
id="has-error-args--source">
<pre>
<span class="ruby-comment cmt"># File lib/caricature/expectation.rb, line 109</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">has_error_args?</span>
<span class="ruby-operator">!</span><span class="ruby-ivar">@error_args</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div id="has-return-value--method" class="method-detail ">
<a name="M000041"></a>
<div class="method-heading">
<span class="method-name">has_return_value?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>
indicates whether this expectation will return a value.
</p>
<div class="method-source-code"
id="has-return-value--source">
<pre>
<span class="ruby-comment cmt"># File lib/caricature/expectation.rb, line 114</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">has_return_value?</span>
<span class="ruby-operator">!</span><span class="ruby-ivar">@return_value</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div id="super-before--method" class="method-detail ">
<a name="M000042"></a>
<div class="method-heading">
<span class="method-name">super_before?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>
call the super before the expectation
</p>
<div class="method-source-code"
id="super-before--source">
<pre>
<span class="ruby-comment cmt"># File lib/caricature/expectation.rb, line 119</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">super_before?</span>
<span class="ruby-ivar">@super</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:before</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
</div>
</div>
<div id="rdoc-debugging-section-dump" class="debugging-section">
<p>Disabled; run with --debug to generate this.</p>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
Rdoc Generator</a> 1.1.6</small>.</p>
</div>
</body>
</html>