<!DOCTYPE html>
<html lang="en">
<head>
<title>Matcher support for not Equatable Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<meta charset='utf-8'>
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>
</head>
<body>
<a title="Matcher support for not Equatable Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">SwiftyMocky 4.1.0-pre Docs</a> (86% documented)</p>
<p class="header-right"><a href="https://github.com/MakeAWishFoundation/SwiftyMocky"><img src="img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html">SwiftyMocky Reference</a>
<img id="carat" src="img/carat.png" />
Matcher support for not Equatable Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="Main%20Guides.html">Main Guides</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="overview.html">Overview</a>
</li>
<li class="nav-group-task">
<a href="installation.html">Installation</a>
</li>
<li class="nav-group-task">
<a href="setup-in-project.html">Setup in project</a>
</li>
<li class="nav-group-task">
<a href="mockfile.html">Mockfile</a>
</li>
<li class="nav-group-task">
<a href="command-line-interface.html">Command Line Interface</a>
</li>
<li class="nav-group-task">
<a href="supported-features.html">Supported features</a>
</li>
<li class="nav-group-task">
<a href="prototyping.html">Prototyping</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Additional%20Guides.html">Additional Guides</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="matcher-support-for-not-equatable.html">Matcher support for not Equatable</a>
</li>
<li class="nav-group-task">
<a href="handling-generics.html">Handling Generics</a>
</li>
<li class="nav-group-task">
<a href="examples.html">Examples</a>
</li>
<li class="nav-group-task">
<a href="legacy.html">Legacy</a>
</li>
<li class="nav-group-task">
<a href="add-xcode-generate-action.html">Add XCode generate action</a>
</li>
<li class="nav-group-task">
<a href="known-issues.html">Known issues</a>
</li>
<li class="nav-group-task">
<a href="changelog.html">CHANGELOG</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Global%20methods.html">Global methods</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Global%20methods.html#/s:11SwiftyMocky5Givenyyx_ABQzAA14StubbingPolicyOtAA4MockRzlF">Given(_:_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Global%20methods.html#/s:11SwiftyMocky5Givenyyxm_06StaticC0QzAA14StubbingPolicyOtAA0D4MockRzlF">Given(_:_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Global%20methods.html#/s:11SwiftyMocky7Performyyx_ABQztAA4MockRzlF">Perform(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Global%20methods.html#/s:11SwiftyMocky7Performyyxm_06StaticC0QztAA0D4MockRzlF">Perform(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Global%20methods.html#/s:11SwiftyMocky6Verify__4file4lineyx_ABQzs12StaticStringVSutAA4MockRzlF">Verify(_:_:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="Global%20methods.html#/s:11SwiftyMocky6Verify__4file4lineyxm_06StaticC0Qzs0F6StringVSutAA0F4MockRzlF">Verify(_:_:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="Global%20methods.html#/s:11SwiftyMocky6Verify___4file4lineyx_AA5CountOABQzs12StaticStringVSutAA4MockRzlF">Verify(_:_:_:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="Global%20methods.html#/s:11SwiftyMocky6Verify___4file4lineyxm_AA5CountO06StaticC0Qzs0G6StringVSutAA0G4MockRzlF">Verify(_:_:_:file:line:)</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Configuration.html">Configuration</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/StubbingPolicy.html">StubbingPolicy</a>
</li>
<li class="nav-group-task">
<a href="Enums/SequencingPolicy.html">SequencingPolicy</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Types.html">Types</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/Mock.html">Mock</a>
</li>
<li class="nav-group-task">
<a href="Protocols/StaticMock.html">StaticMock</a>
</li>
<li class="nav-group-task">
<a href="Enums/Parameter.html">Parameter</a>
</li>
<li class="nav-group-task">
<a href="Classes/Matcher.html">Matcher</a>
</li>
<li class="nav-group-task">
<a href="Classes/Matcher/ComparisonResult.html">– ComparisonResult</a>
</li>
<li class="nav-group-task">
<a href="Classes/Matcher/ParameterComparisonResult.html">– ParameterComparisonResult</a>
</li>
<li class="nav-group-task">
<a href="Protocols/Countable.html">Countable</a>
</li>
<li class="nav-group-task">
<a href="Enums/Count.html">Count</a>
</li>
<li class="nav-group-task">
<a href="Structs/Stubber.html">Stubber</a>
</li>
<li class="nav-group-task">
<a href="Structs/StubberThrows.html">StubberThrows</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Generics.html">Generics</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Structs/GenericAttribute.html">GenericAttribute</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Helpers.html">Helpers</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Helpers.html#/s:11SwiftyMocky20XCTAssertThrowsError_2of_4file4lineyxyKXK_q_mSSyXKs12StaticStringVSuts0E0R_r0_lF">XCTAssertThrowsError(_:of:_:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="Helpers.html#/s:11SwiftyMocky20XCTAssertThrowsError_5error_4file4lineyxyKXK_q_SSyXKs12StaticStringVSutSQR_s0E0R_r0_lF">XCTAssertThrowsError(_:error:_:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="Classes/MockyAssertion.html">MockyAssertion</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Internal.html">Internal</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Classes/SwiftyMockyTestObserver.html">SwiftyMockyTestObserver</a>
</li>
<li class="nav-group-task">
<a href="Classes/SwiftyMockyTestObserver.html">SwiftyMockyTestObserver</a>
</li>
<li class="nav-group-task">
<a href="Structs/FatalErrorUtil.html">FatalErrorUtil</a>
</li>
<li class="nav-group-task">
<a href="Protocols/WithSequencingPolicy.html">WithSequencingPolicy</a>
</li>
<li class="nav-group-task">
<a href="Protocols/WithStaticSequencingPolicy.html">WithStaticSequencingPolicy</a>
</li>
<li class="nav-group-task">
<a href="Protocols/WithStubbingPolicy.html">WithStubbingPolicy</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Int.html">Int</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Optional.html">Optional</a>
</li>
<li class="nav-group-task">
<a href="Extensions/UInt.html">UInt</a>
</li>
<li class="nav-group-task">
<a href="Enums/MockError.html">MockError</a>
</li>
<li class="nav-group-task">
<a href="Enums/StubProduct.html">StubProduct</a>
</li>
<li class="nav-group-task">
<a href="Classes/StubbedMethod.html">StubbedMethod</a>
</li>
<li class="nav-group-task">
<a href="Internal.html#/s:11SwiftyMocky7Failureys5NeverOSSF">Failure(_:)</a>
</li>
<li class="nav-group-task">
<a href="Internal.html#/s:11SwiftyMocky0B6Assert__4file4lineySbyXK_SSyXKs12StaticStringVSutF">MockyAssert(_:_:file:line:)</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Other%20Guides.html">Other Guides</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="contents.html">Contents</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Other%20Classes.html">Other Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Classes/ArgumentCaptor.html">ArgumentCaptor</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Other%20Enums.html">Other Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/MockScope.html">MockScope</a>
</li>
<li class="nav-group-task">
<a href="Enums/Utils.html">Utils</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Other%20Protocols.html">Other Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/TypeErasedValue.html">TypeErasedValue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Other%20Structs.html">Other Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Structs/TypeErasedAttribute.html">TypeErasedAttribute</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1 id='matcher-handling-parameters-that-are-not-equatable' class='heading'>Matcher - handling parameters that are not Equatable</h1>
<p>In some cases there is a need to specify return value (by <code>Given</code>) for a method, which parameters are not <strong><em>Equatable</em></strong>, or check (by Verify), whether a method was called with specific attribute which is not <strong><em>Equatable</em></strong>.</p>
<p>If you try to perform Given or Verify for explicit parameter, whereas its type is not Equatable, <strong>fatalError</strong> will occur. There are two options to handle attributes types, that are not <strong><em>Equatable</em></strong>:</p>
<p><strong>1) Use only wildcard .any parameters, or adopt Equatable</strong></p>
<p>Sometimes .any is enough, or you can provide Equatable implementation.</p>
<p><strong>2) Register comparator for that type in Matcher</strong></p>
<p>Every Mock has <code>matcher</code> variable, which is <code><a href="Classes/Matcher.html#/s:11SwiftyMocky7MatcherC7defaultACvpZ">Matcher.default</a></code> singleton instance by default.</p>
<p>Usage of <strong>Matcher</strong>:</p>
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">User</span> <span class="p">{</span>
<span class="k">let</span> <span class="nv">id</span><span class="p">:</span> <span class="kt">String</span>
<span class="k">let</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span>
<span class="p">}</span>
<span class="c1">// ...</span>
<span class="k">override</span> <span class="kd">func</span> <span class="nf">setUp</span><span class="p">()</span> <span class="p">{</span>
<span class="c1">// register all comparators for custom, non equatable attributes</span>
<span class="kt">Matcher</span><span class="o">.</span><span class="k">default</span><span class="o">.</span><span class="nf">register</span><span class="p">(</span><span class="kt">User</span><span class="o">.</span><span class="k">self</span><span class="p">)</span> <span class="p">{</span> <span class="n">lhs</span><span class="p">,</span><span class="n">rhs</span> <span class="o">-></span> <span class="kt">Bool</span> <span class="k">in</span>
<span class="k">return</span> <span class="n">lhs</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">rhs</span><span class="o">.</span><span class="n">id</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="kd">func</span> <span class="nf">testFetchUserDetails</span><span class="p">()</span> <span class="p">{</span>
<span class="c1">//...</span>
<span class="k">let</span> <span class="nv">john</span> <span class="o">=</span> <span class="kt">User</span><span class="p">(</span><span class="nv">id</span><span class="p">:</span> <span class="s">"Johny123"</span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span> <span class="s">"Johny"</span><span class="p">)</span>
<span class="c1">// now we can safely verify explicit parameter</span>
<span class="kt">Verify</span><span class="p">(</span><span class="n">mockNetwork</span><span class="p">,</span> <span class="o">.</span><span class="nf">fetchUserDetails</span><span class="p">(</span><span class="nv">for</span><span class="p">:</span> <span class="o">.</span><span class="nf">value</span><span class="p">(</span><span class="n">john</span><span class="p">)))</span>
<span class="p">}</span>
</code></pre>
<p>In most cases, you don’t have to register comparators for Equatable and Sequence types (as long as Sequence Elememnt is Equatable)</p>
<h2 id='matcher-for-generic-methods-in-mocks' class='heading'>Matcher for generic methods in Mocks</h2>
<p>As generic methods and mocks are breaking generic constraints, for that particular case you also have to register comparators for Equatable / Sequence types.</p>
<p>There are bunch of convenience registration methods, that will simplify registrations for that case.</p>
<p>See <strong>Generics</strong> section for more information.</p>
</section>
</section>
<section id="footer">
<p>Copyright © 2017 MakeAWishFoundation. All rights reserved.</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>