mirror of
https://github.com/ditkrg/active_model_serializers.git
synced 2026-01-22 22:06:50 +00:00
227 lines
7.5 KiB
HTML
227 lines
7.5 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<title>
|
|
Module: ActiveModelSerializers::Test::Serializer
|
|
|
|
— Documentation by YARD 0.8.7.6
|
|
|
|
</title>
|
|
|
|
<link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
|
|
|
|
<link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
|
|
|
|
<script type="text/javascript" charset="utf-8">
|
|
hasFrames = window.top.frames.main ? true : false;
|
|
relpath = '../../';
|
|
framesUrl = "../../frames.html#!ActiveModelSerializers/Test/Serializer.html";
|
|
</script>
|
|
|
|
|
|
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
|
|
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
|
|
|
|
|
</head>
|
|
<body>
|
|
<div id="header">
|
|
<div id="menu">
|
|
|
|
<a href="../../_index.html">Index (S)</a> »
|
|
<span class='title'><span class='object_link'><a href="../../ActiveModelSerializers.html" title="ActiveModelSerializers (module)">ActiveModelSerializers</a></span></span> » <span class='title'><span class='object_link'><a href="../Test.html" title="ActiveModelSerializers::Test (module)">Test</a></span></span>
|
|
»
|
|
<span class="title">Serializer</span>
|
|
|
|
|
|
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
</div>
|
|
|
|
<div id="search">
|
|
|
|
<a class="full_list_link" id="class_list_link"
|
|
href="../../class_list.html">
|
|
Class List
|
|
</a>
|
|
|
|
<a class="full_list_link" id="method_list_link"
|
|
href="../../method_list.html">
|
|
Method List
|
|
</a>
|
|
|
|
<a class="full_list_link" id="file_list_link"
|
|
href="../../file_list.html">
|
|
File List
|
|
</a>
|
|
|
|
</div>
|
|
<div class="clear"></div>
|
|
</div>
|
|
|
|
<iframe id="search_frame"></iframe>
|
|
|
|
<div id="content"><h1>Module: ActiveModelSerializers::Test::Serializer
|
|
|
|
|
|
|
|
</h1>
|
|
|
|
<dl class="box">
|
|
|
|
|
|
|
|
<dt class="r1">Extended by:</dt>
|
|
<dd class="r1">ActiveSupport::Concern</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dt class="r2 last">Defined in:</dt>
|
|
<dd class="r2 last">lib/active_model_serializers/test/serializer.rb</dd>
|
|
|
|
</dl>
|
|
<div class="clear"></div>
|
|
|
|
<h2>Defined Under Namespace</h2>
|
|
<p class="children">
|
|
|
|
|
|
|
|
|
|
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Serializer/AssertSerializer.html" title="ActiveModelSerializers::Test::Serializer::AssertSerializer (class)">AssertSerializer</a></span>
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>
|
|
Instance Method Summary
|
|
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
</h2>
|
|
|
|
<ul class="summary">
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#assert_serializer-instance_method" title="#assert_serializer (instance method)">- (Object) <strong>assert_serializer</strong>(expectation, message = nil) </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>Asserts that the request was rendered with the appropriate serializers.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<div id="instance_method_details" class="method_details_list">
|
|
<h2>Instance Method Details</h2>
|
|
|
|
|
|
<div class="method_details first">
|
|
<h3 class="signature first" id="assert_serializer-instance_method">
|
|
|
|
- (<tt>Object</tt>) <strong>assert_serializer</strong>(expectation, message = nil)
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Asserts that the request was rendered with the appropriate serializers.</p>
|
|
|
|
<pre class="code ruby"><code class="ruby"><span class='comment'># assert that the "PostSerializer" serializer was rendered
|
|
</span><span class='id identifier rubyid_assert_serializer'>assert_serializer</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>PostSerializer</span><span class='tstring_end'>"</span></span>
|
|
|
|
<span class='comment'># return a custom error message
|
|
</span><span class='id identifier rubyid_assert_serializer'>assert_serializer</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>PostSerializer</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>PostSerializer not rendered</span><span class='tstring_end'>"</span></span>
|
|
|
|
<span class='comment'># assert that the instance of PostSerializer was rendered
|
|
</span><span class='id identifier rubyid_assert_serializer'>assert_serializer</span> <span class='const'>PostSerializer</span>
|
|
|
|
<span class='comment'># assert that the "PostSerializer" serializer was rendered
|
|
</span><span class='id identifier rubyid_assert_serializer'>assert_serializer</span> <span class='symbol'>:post_serializer</span>
|
|
|
|
<span class='comment'># assert that the rendered serializer starts with "Post"
|
|
</span><span class='id identifier rubyid_assert_serializer'>assert_serializer</span> <span class='tstring'><span class='regexp_beg'>%r{</span><span class='tstring_content'>\APost.+\Z</span><span class='regexp_end'>}</span></span>
|
|
|
|
<span class='comment'># assert that no serializer was rendered
|
|
</span><span class='id identifier rubyid_assert_serializer'>assert_serializer</span> <span class='kw'>nil</span>
|
|
</code></pre>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
32
|
|
33
|
|
34
|
|
35
|
|
36
|
|
37</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/test/serializer.rb', line 32</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_assert_serializer'>assert_serializer</span><span class='lparen'>(</span><span class='id identifier rubyid_expectation'>expectation</span><span class='comma'>,</span> <span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
<span class='ivar'>@assert_serializer</span><span class='period'>.</span><span class='id identifier rubyid_expectation'>expectation</span> <span class='op'>=</span> <span class='id identifier rubyid_expectation'>expectation</span>
|
|
<span class='ivar'>@assert_serializer</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='id identifier rubyid_message'>message</span>
|
|
<span class='ivar'>@assert_serializer</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span>
|
|
<span class='id identifier rubyid_assert'>assert</span><span class='lparen'>(</span><span class='ivar'>@assert_serializer</span><span class='period'>.</span><span class='id identifier rubyid_matches?'>matches?</span><span class='comma'>,</span> <span class='ivar'>@assert_serializer</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
|
|
<span class='kw'>end</span></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div id="footer">
|
|
Generated on Tue Jun 14 10:33:50 2016 by
|
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
0.8.7.6 (ruby-2.2.4).
|
|
</div>
|
|
|
|
</body>
|
|
</html> |