mermaid
Version:
Markdownish syntax for generating flowcharts, sequence diagrams and gantt charts.
188 lines (162 loc) • 17 kB
HTML
<html>
<head>
<title>Expectation.js</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<link rel="stylesheet" media="all" href="../../../../doc-style.css" />
<script src="../../../../doc-filelist.js"></script>
<script>
var relativeDir = "../../../../", thisFile = "Users/knut/Documents/source/mermaid/bower_components/jasmine/src/core/Expectation.js", defaultSidebar = true;
</script>
<script src="../../../../doc-script.js"></script>
<script src="../../../../mermaid.js"></script>
<link rel="stylesheet" href="../../../../mermaid.css" />
</head>
<body>
<div id="sidebar_wrapper">
<div id="sidebar_switch">
<span class="tree">Files</span>
<span class="headings">Headings</span>
</div>
<div id="tree"></div>
<div id="headings">
<div class="heading h1">
<a href="#Expectation.js">Expectation.js</a>
</div>
</div>
</div>
<div id="sidebar-toggle"></div>
<div id="container"><div class="background highlight"></div>
<table cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="docs">
<div class="pilwrap" id="Expectation.js">
<h1>
<a href="#Expectation.js" name="Expectation.js" class="pilcrow">¶</a>Expectation.js
</h1>
</div>
</td>
<td class="code highlight"></td>
</tr>
<tr>
<td class="docs">
<div class="pilwrap">
<a class="pilcrow" href="#section-1" id="section-1">¶</a>
</div>
</td>
<td class="code highlight"><div class="highlight"><pre><span class="nx">getJasmineRequireObj</span><span class="p">().</span><span class="nx">Expectation</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">matchers</span> <span class="o">=</span> <span class="p">{};</span>
<span class="kd">function</span> <span class="nx">Expectation</span><span class="p">(</span><span class="nx">options</span><span class="p">)</span> <span class="p">{</span>
<span class="k">this</span><span class="p">.</span><span class="nx">util</span> <span class="o">=</span> <span class="nx">options</span><span class="p">.</span><span class="nx">util</span> <span class="o">||</span> <span class="p">{</span> <span class="nx">buildFailureMessage</span><span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{}</span> <span class="p">};</span>
<span class="k">this</span><span class="p">.</span><span class="nx">customEqualityTesters</span> <span class="o">=</span> <span class="nx">options</span><span class="p">.</span><span class="nx">customEqualityTesters</span> <span class="o">||</span> <span class="p">[];</span>
<span class="k">this</span><span class="p">.</span><span class="nx">actual</span> <span class="o">=</span> <span class="nx">options</span><span class="p">.</span><span class="nx">actual</span><span class="p">;</span>
<span class="k">this</span><span class="p">.</span><span class="nx">addExpectationResult</span> <span class="o">=</span> <span class="nx">options</span><span class="p">.</span><span class="nx">addExpectationResult</span> <span class="o">||</span> <span class="kd">function</span><span class="p">(){};</span>
<span class="k">this</span><span class="p">.</span><span class="nx">isNot</span> <span class="o">=</span> <span class="nx">options</span><span class="p">.</span><span class="nx">isNot</span><span class="p">;</span>
<span class="k">for</span> <span class="p">(</span><span class="kd">var</span> <span class="nx">matcherName</span> <span class="k">in</span> <span class="nx">matchers</span><span class="p">)</span> <span class="p">{</span>
<span class="k">this</span><span class="p">[</span><span class="nx">matcherName</span><span class="p">]</span> <span class="o">=</span> <span class="nx">matchers</span><span class="p">[</span><span class="nx">matcherName</span><span class="p">];</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="nx">Expectation</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">wrapCompare</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">name</span><span class="p">,</span> <span class="nx">matcherFactory</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">args</span> <span class="o">=</span> <span class="nb">Array</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">slice</span><span class="p">.</span><span class="nx">call</span><span class="p">(</span><span class="nx">arguments</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
<span class="nx">expected</span> <span class="o">=</span> <span class="nx">args</span><span class="p">.</span><span class="nx">slice</span><span class="p">(</span><span class="mi">0</span><span class="p">),</span>
<span class="nx">message</span> <span class="o">=</span> <span class="s1">''</span><span class="p">;</span>
<span class="nx">args</span><span class="p">.</span><span class="nx">unshift</span><span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">actual</span><span class="p">);</span>
<span class="kd">var</span> <span class="nx">matcher</span> <span class="o">=</span> <span class="nx">matcherFactory</span><span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">util</span><span class="p">,</span> <span class="k">this</span><span class="p">.</span><span class="nx">customEqualityTesters</span><span class="p">),</span>
<span class="nx">matcherCompare</span> <span class="o">=</span> <span class="nx">matcher</span><span class="p">.</span><span class="nx">compare</span><span class="p">;</span>
<span class="kd">function</span> <span class="nx">defaultNegativeCompare</span><span class="p">()</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">result</span> <span class="o">=</span> <span class="nx">matcher</span><span class="p">.</span><span class="nx">compare</span><span class="p">.</span><span class="nx">apply</span><span class="p">(</span><span class="kc">null</span><span class="p">,</span> <span class="nx">args</span><span class="p">);</span>
<span class="nx">result</span><span class="p">.</span><span class="nx">pass</span> <span class="o">=</span> <span class="o">!</span><span class="nx">result</span><span class="p">.</span><span class="nx">pass</span><span class="p">;</span>
<span class="k">return</span> <span class="nx">result</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">if</span> <span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">isNot</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">matcherCompare</span> <span class="o">=</span> <span class="nx">matcher</span><span class="p">.</span><span class="nx">negativeCompare</span> <span class="o">||</span> <span class="nx">defaultNegativeCompare</span><span class="p">;</span>
<span class="p">}</span>
<span class="kd">var</span> <span class="nx">result</span> <span class="o">=</span> <span class="nx">matcherCompare</span><span class="p">.</span><span class="nx">apply</span><span class="p">(</span><span class="kc">null</span><span class="p">,</span> <span class="nx">args</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">result</span><span class="p">.</span><span class="nx">pass</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">result</span><span class="p">.</span><span class="nx">message</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">args</span><span class="p">.</span><span class="nx">unshift</span><span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">isNot</span><span class="p">);</span>
<span class="nx">args</span><span class="p">.</span><span class="nx">unshift</span><span class="p">(</span><span class="nx">name</span><span class="p">);</span>
<span class="nx">message</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">util</span><span class="p">.</span><span class="nx">buildFailureMessage</span><span class="p">.</span><span class="nx">apply</span><span class="p">(</span><span class="kc">null</span><span class="p">,</span> <span class="nx">args</span><span class="p">);</span>
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nb">Object</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">toString</span><span class="p">.</span><span class="nx">apply</span><span class="p">(</span><span class="nx">result</span><span class="p">.</span><span class="nx">message</span><span class="p">)</span> <span class="o">===</span> <span class="s1">'[object Function]'</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">message</span> <span class="o">=</span> <span class="nx">result</span><span class="p">.</span><span class="nx">message</span><span class="p">();</span>
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
<span class="nx">message</span> <span class="o">=</span> <span class="nx">result</span><span class="p">.</span><span class="nx">message</span><span class="p">;</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">expected</span><span class="p">.</span><span class="nx">length</span> <span class="o">==</span> <span class="mi">1</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">expected</span> <span class="o">=</span> <span class="nx">expected</span><span class="p">[</span><span class="mi">0</span><span class="p">];</span>
<span class="p">}</span>
</pre></div>
</td>
</tr>
<tr>
<td class="docs">
<div class="pilwrap">
<a class="pilcrow" href="#section-2" id="section-2">¶</a>
</div>
<p>TODO: how many of these params are needed?</p>
</td>
<td class="code highlight"><div class="highlight"><pre>
<span class="k">this</span><span class="p">.</span><span class="nx">addExpectationResult</span><span class="p">(</span>
<span class="nx">result</span><span class="p">.</span><span class="nx">pass</span><span class="p">,</span>
<span class="p">{</span>
<span class="nx">matcherName</span><span class="o">:</span> <span class="nx">name</span><span class="p">,</span>
<span class="nx">passed</span><span class="o">:</span> <span class="nx">result</span><span class="p">.</span><span class="nx">pass</span><span class="p">,</span>
<span class="nx">message</span><span class="o">:</span> <span class="nx">message</span><span class="p">,</span>
<span class="nx">actual</span><span class="o">:</span> <span class="k">this</span><span class="p">.</span><span class="nx">actual</span><span class="p">,</span>
<span class="nx">expected</span><span class="o">:</span> <span class="nx">expected</span> <span class="c1">// TODO: this may need to be arrayified/sliced</span>
<span class="p">}</span>
<span class="p">);</span>
<span class="p">};</span>
<span class="p">};</span>
<span class="nx">Expectation</span><span class="p">.</span><span class="nx">addCoreMatchers</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">matchers</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">prototype</span> <span class="o">=</span> <span class="nx">Expectation</span><span class="p">.</span><span class="nx">prototype</span><span class="p">;</span>
<span class="k">for</span> <span class="p">(</span><span class="kd">var</span> <span class="nx">matcherName</span> <span class="k">in</span> <span class="nx">matchers</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">matcher</span> <span class="o">=</span> <span class="nx">matchers</span><span class="p">[</span><span class="nx">matcherName</span><span class="p">];</span>
<span class="nx">prototype</span><span class="p">[</span><span class="nx">matcherName</span><span class="p">]</span> <span class="o">=</span> <span class="nx">prototype</span><span class="p">.</span><span class="nx">wrapCompare</span><span class="p">(</span><span class="nx">matcherName</span><span class="p">,</span> <span class="nx">matcher</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">};</span>
<span class="nx">Expectation</span><span class="p">.</span><span class="nx">addMatchers</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">matchersToAdd</span><span class="p">)</span> <span class="p">{</span>
<span class="k">for</span> <span class="p">(</span><span class="kd">var</span> <span class="nx">name</span> <span class="k">in</span> <span class="nx">matchersToAdd</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">matcher</span> <span class="o">=</span> <span class="nx">matchersToAdd</span><span class="p">[</span><span class="nx">name</span><span class="p">];</span>
<span class="nx">matchers</span><span class="p">[</span><span class="nx">name</span><span class="p">]</span> <span class="o">=</span> <span class="nx">Expectation</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">wrapCompare</span><span class="p">(</span><span class="nx">name</span><span class="p">,</span> <span class="nx">matcher</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">};</span>
<span class="nx">Expectation</span><span class="p">.</span><span class="nx">resetMatchers</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
<span class="k">for</span> <span class="p">(</span><span class="kd">var</span> <span class="nx">name</span> <span class="k">in</span> <span class="nx">matchers</span><span class="p">)</span> <span class="p">{</span>
<span class="k">delete</span> <span class="nx">matchers</span><span class="p">[</span><span class="nx">name</span><span class="p">];</span>
<span class="p">}</span>
<span class="p">};</span>
<span class="nx">Expectation</span><span class="p">.</span><span class="nx">Factory</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">options</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">options</span> <span class="o">=</span> <span class="nx">options</span> <span class="o">||</span> <span class="p">{};</span>
<span class="kd">var</span> <span class="nx">expect</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Expectation</span><span class="p">(</span><span class="nx">options</span><span class="p">);</span>
</pre></div>
</td>
</tr>
<tr>
<td class="docs">
<div class="pilwrap">
<a class="pilcrow" href="#section-3" id="section-3">¶</a>
</div>
<p>TODO: this would be nice as its own Object - NegativeExpectation
TODO: copy instead of mutate options</p>
</td>
<td class="code highlight"><div class="highlight"><pre>
<span class="nx">options</span><span class="p">.</span><span class="nx">isNot</span> <span class="o">=</span> <span class="kc">true</span><span class="p">;</span>
<span class="nx">expect</span><span class="p">.</span><span class="nx">not</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Expectation</span><span class="p">(</span><span class="nx">options</span><span class="p">);</span>
<span class="k">return</span> <span class="nx">expect</span><span class="p">;</span>
<span class="p">};</span>
<span class="k">return</span> <span class="nx">Expectation</span><span class="p">;</span>
<span class="p">};</span>
</pre></div>
</td>
</tr>
</tbody>
</table>
</div>
</body>
</html>