active_model_serializers/ActiveModel/Serializer/Caching.html
2016-06-16 09:05:14 -05:00

638 lines
28 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: ActiveModel::Serializer::Caching
&mdash; 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#!ActiveModel/Serializer/Caching.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 (C)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../ActiveModel.html" title="ActiveModel (module)">ActiveModel</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Serializer.html" title="ActiveModel::Serializer (class)">Serializer</a></span></span>
&raquo;
<span class="title">Caching</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: ActiveModel::Serializer::Caching
</h1>
<dl class="box">
<dt class="r1">Extended by:</dt>
<dd class="r1">ActiveSupport::Concern</dd>
<dt class="r2">Included in:</dt>
<dd class="r2"><span class='object_link'><a href="../Serializer.html" title="ActiveModel::Serializer (class)">ActiveModel::Serializer</a></span></dd>
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/active_model/serializer/caching.rb</dd>
</dl>
<div class="clear"></div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Caching/ClassMethods.html" title="ActiveModel::Serializer::Caching::ClassMethods (module)">ClassMethods</a></span>
</p>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="CALLER_FILE-constant" class="">CALLER_FILE =
<div class="docstring">
<div class="discussion">
<p>Matches</p>
<pre class="code ruby"><code class="ruby"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>c:/git/emberjs/ember-crm-backend/app/serializers/lead_serializer.rb:1:in `&lt;top (required)&gt;&#39;</span><span class='tstring_end'>&quot;</span></span>
<span class='const'>AND</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/c/git/emberjs/ember-crm-backend/app/serializers/lead_serializer.rb:1:in `&lt;top (required)&gt;&#39;</span><span class='tstring_end'>&quot;</span></span>
<span class='const'>AS</span>
<span class='id identifier rubyid_c'>c</span><span class='op'>/</span><span class='id identifier rubyid_git'>git</span><span class='op'>/</span><span class='id identifier rubyid_emberjs'>emberjs</span><span class='op'>/</span><span class='id identifier rubyid_ember'>ember</span><span class='op'>-</span><span class='id identifier rubyid_crm'>crm</span><span class='op'>-</span><span class='id identifier rubyid_backend'>backend</span><span class='op'>/</span><span class='id identifier rubyid_app'>app</span><span class='op'>/</span><span class='id identifier rubyid_serializers'>serializers</span><span class='op'>/</span><span class='id identifier rubyid_lead_serializer'>lead_serializer</span><span class='period'>.</span><span class='id identifier rubyid_rb'>rb</span>
</code></pre>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>
\A # start of string
.+ # file path (one or more characters)
(?= # stop previous match when
:\d+ # a colon is followed by one or more digits
:in # followed by a colon followed by in
)
</span><span class='regexp_end'>/x</span></span></pre></dd>
</dl>
<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="#cache_key-instance_method" title="#cache_key (instance method)">- (Object) <strong>cache_key</strong>(adapter_instance) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch-instance_method" title="#fetch (instance method)">- (Object) <strong>fetch</strong>(adapter_instance, cache_options = serializer_class._cache_options) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_attributes-instance_method" title="#fetch_attributes (instance method)">- (Object) <strong>fetch_attributes</strong>(fields, cached_attributes, adapter_instance) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>INSTANCE METHODS.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_attributes_fragment-instance_method" title="#fetch_attributes_fragment (instance method)">- (Object) <strong>fetch_attributes_fragment</strong>(adapter_instance) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>1.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#object_cache_key-instance_method" title="#object_cache_key (instance method)">- (Object) <strong>object_cache_key</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Use object&#39;s cache_key if available, else derive a key from the object
Pass the `key` option to the `cache` declaration or override this method to
customize the cache key.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#serializer_class-instance_method" title="#serializer_class (instance method)">- (Object) <strong>serializer_class</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></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="cache_key-instance_method">
- (<tt>Object</tt>) <strong>cache_key</strong>(adapter_instance)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
256
257
258
259
260
261
262
263
264</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/caching.rb', line 256</span>
<span class='kw'>def</span> <span class='id identifier rubyid_cache_key'>cache_key</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='ivar'>@cache_key</span> <span class='kw'>if</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='ivar'>@cache_key</span><span class='rparen'>)</span>
<span class='id identifier rubyid_parts'>parts</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_parts'>parts</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_object_cache_key'>object_cache_key</span>
<span class='id identifier rubyid_parts'>parts</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='period'>.</span><span class='id identifier rubyid_cache_key'>cache_key</span>
<span class='id identifier rubyid_parts'>parts</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_serializer_class'>serializer_class</span><span class='period'>.</span><span class='id identifier rubyid__cache_digest'>_cache_digest</span> <span class='kw'>unless</span> <span class='id identifier rubyid_serializer_class'>serializer_class</span><span class='period'>.</span><span class='id identifier rubyid__skip_digest?'>_skip_digest?</span>
<span class='ivar'>@cache_key</span> <span class='op'>=</span> <span class='id identifier rubyid_parts'>parts</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch-instance_method">
- (<tt>Object</tt>) <strong>fetch</strong>(adapter_instance, cache_options = serializer_class._cache_options)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
220
221
222
223
224
225
226
227
228</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/caching.rb', line 220</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='comma'>,</span> <span class='id identifier rubyid_cache_options'>cache_options</span> <span class='op'>=</span> <span class='id identifier rubyid_serializer_class'>serializer_class</span><span class='period'>.</span><span class='id identifier rubyid__cache_options'>_cache_options</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_serializer_class'>serializer_class</span><span class='period'>.</span><span class='id identifier rubyid_cache_store'>cache_store</span>
<span class='id identifier rubyid_serializer_class'>serializer_class</span><span class='period'>.</span><span class='id identifier rubyid_cache_store'>cache_store</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_cache_key'>cache_key</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_cache_options'>cache_options</span><span class='rparen'>)</span> <span class='kw'>do</span>
<span class='kw'>yield</span>
<span class='kw'>end</span>
<span class='kw'>else</span>
<span class='kw'>yield</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_attributes-instance_method">
- (<tt>Object</tt>) <strong>fetch_attributes</strong>(fields, cached_attributes, adapter_instance)
</h3><div class="docstring">
<div class="discussion">
<p>INSTANCE METHODS</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
205
206
207
208
209
210
211
212
213
214
215
216
217
218</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/caching.rb', line 205</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_attributes'>fetch_attributes</span><span class='lparen'>(</span><span class='id identifier rubyid_fields'>fields</span><span class='comma'>,</span> <span class='id identifier rubyid_cached_attributes'>cached_attributes</span><span class='comma'>,</span> <span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_serializer_class'>serializer_class</span><span class='period'>.</span><span class='id identifier rubyid_cache_enabled?'>cache_enabled?</span>
<span class='id identifier rubyid_key'>key</span> <span class='op'>=</span> <span class='id identifier rubyid_cache_key'>cache_key</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='rparen'>)</span>
<span class='id identifier rubyid_cached_attributes'>cached_attributes</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span> <span class='kw'>do</span>
<span class='id identifier rubyid_serializer_class'>serializer_class</span><span class='period'>.</span><span class='id identifier rubyid_cache_store'>cache_store</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_serializer_class'>serializer_class</span><span class='period'>.</span><span class='id identifier rubyid__cache_options'>_cache_options</span><span class='rparen'>)</span> <span class='kw'>do</span>
<span class='id identifier rubyid_attributes'>attributes</span><span class='lparen'>(</span><span class='id identifier rubyid_fields'>fields</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_serializer_class'>serializer_class</span><span class='period'>.</span><span class='id identifier rubyid_fragment_cache_enabled?'>fragment_cache_enabled?</span>
<span class='id identifier rubyid_fetch_attributes_fragment'>fetch_attributes_fragment</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_attributes'>attributes</span><span class='lparen'>(</span><span class='id identifier rubyid_fields'>fields</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_attributes_fragment-instance_method">
- (<tt>Object</tt>) <strong>fetch_attributes_fragment</strong>(adapter_instance)
</h3><div class="docstring">
<div class="discussion">
<ol><li>
<p>Determine cached fields from serializer class options</p>
</li><li>
<p>Get non_cached_fields and fetch cache_fields</p>
</li><li>
<p>Merge the two hashes using adapter_instance#fragment_cache</p>
</li></ol>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/caching.rb', line 233</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_attributes_fragment'>fetch_attributes_fragment</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='rparen'>)</span>
<span class='id identifier rubyid_serializer_class'>serializer_class</span><span class='period'>.</span><span class='id identifier rubyid__cache_options'>_cache_options</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_serializer_class'>serializer_class</span><span class='period'>.</span><span class='id identifier rubyid__cache_options'>_cache_options</span><span class='lbracket'>[</span><span class='symbol'>:key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_serializer_class'>serializer_class</span><span class='period'>.</span><span class='id identifier rubyid__cache_key'>_cache_key</span> <span class='kw'>if</span> <span class='id identifier rubyid_serializer_class'>serializer_class</span><span class='period'>.</span><span class='id identifier rubyid__cache_key'>_cache_key</span>
<span class='id identifier rubyid_fields'>fields</span> <span class='op'>=</span> <span class='id identifier rubyid_serializer_class'>serializer_class</span><span class='period'>.</span><span class='id identifier rubyid_fragmented_attributes'>fragmented_attributes</span>
<span class='id identifier rubyid_non_cached_fields'>non_cached_fields</span> <span class='op'>=</span> <span class='id identifier rubyid_fields'>fields</span><span class='lbracket'>[</span><span class='symbol'>:non_cached</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
<span class='id identifier rubyid_non_cached_hash'>non_cached_hash</span> <span class='op'>=</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='lparen'>(</span><span class='id identifier rubyid_non_cached_fields'>non_cached_fields</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='id identifier rubyid_include_directive'>include_directive</span> <span class='op'>=</span> <span class='const'>JSONAPI</span><span class='op'>::</span><span class='const'>IncludeDirective</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_non_cached_fields'>non_cached_fields</span> <span class='op'>-</span> <span class='id identifier rubyid_non_cached_hash'>non_cached_hash</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='rparen'>)</span>
<span class='id identifier rubyid_non_cached_hash'>non_cached_hash</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span> <span class='id identifier rubyid_resource_relationships'>resource_relationships</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='label'>include_directive:</span> <span class='id identifier rubyid_include_directive'>include_directive</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='rparen'>)</span>
<span class='id identifier rubyid_cached_fields'>cached_fields</span> <span class='op'>=</span> <span class='id identifier rubyid_fields'>fields</span><span class='lbracket'>[</span><span class='symbol'>:cached</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
<span class='id identifier rubyid_key'>key</span> <span class='op'>=</span> <span class='id identifier rubyid_cache_key'>cache_key</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='rparen'>)</span>
<span class='id identifier rubyid_cached_hash'>cached_hash</span> <span class='op'>=</span>
<span class='id identifier rubyid_serializer_class'>serializer_class</span><span class='period'>.</span><span class='id identifier rubyid_cache_store'>cache_store</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_serializer_class'>serializer_class</span><span class='period'>.</span><span class='id identifier rubyid__cache_options'>_cache_options</span><span class='rparen'>)</span> <span class='kw'>do</span>
<span class='id identifier rubyid_hash'>hash</span> <span class='op'>=</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='lparen'>(</span><span class='id identifier rubyid_cached_fields'>cached_fields</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='id identifier rubyid_include_directive'>include_directive</span> <span class='op'>=</span> <span class='const'>JSONAPI</span><span class='op'>::</span><span class='const'>IncludeDirective</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_cached_fields'>cached_fields</span> <span class='op'>-</span> <span class='id identifier rubyid_hash'>hash</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='rparen'>)</span>
<span class='id identifier rubyid_hash'>hash</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span> <span class='id identifier rubyid_resource_relationships'>resource_relationships</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='label'>include_directive:</span> <span class='id identifier rubyid_include_directive'>include_directive</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='comment'># Merge both results
</span> <span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='period'>.</span><span class='id identifier rubyid_fragment_cache'>fragment_cache</span><span class='lparen'>(</span><span class='id identifier rubyid_cached_hash'>cached_hash</span><span class='comma'>,</span> <span class='id identifier rubyid_non_cached_hash'>non_cached_hash</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="object_cache_key-instance_method">
- (<tt>Object</tt>) <strong>object_cache_key</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Use object&#39;s cache_key if available, else derive a key from the object
Pass the `key` option to the `cache` declaration or override this method to
customize the cache key</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
268
269
270
271
272
273
274
275
276
277
278</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/caching.rb', line 268</span>
<span class='kw'>def</span> <span class='id identifier rubyid_object_cache_key'>object_cache_key</span>
<span class='kw'>if</span> <span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:cache_key</span><span class='rparen'>)</span>
<span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_cache_key'>cache_key</span>
<span class='kw'>elsif</span> <span class='lparen'>(</span><span class='id identifier rubyid_serializer_cache_key'>serializer_cache_key</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_serializer_class'>serializer_class</span><span class='period'>.</span><span class='id identifier rubyid__cache_key'>_cache_key</span> <span class='op'>||</span> <span class='id identifier rubyid_serializer_class'>serializer_class</span><span class='period'>.</span><span class='id identifier rubyid__cache_options'>_cache_options</span><span class='lbracket'>[</span><span class='symbol'>:key</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='id identifier rubyid_object_time_safe'>object_time_safe</span> <span class='op'>=</span> <span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_updated_at'>updated_at</span>
<span class='id identifier rubyid_object_time_safe'>object_time_safe</span> <span class='op'>=</span> <span class='id identifier rubyid_object_time_safe'>object_time_safe</span><span class='period'>.</span><span class='id identifier rubyid_strftime'>strftime</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>%Y%m%d%H%M%S%9N</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_object_time_safe'>object_time_safe</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:strftime</span><span class='rparen'>)</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_serializer_cache_key'>serializer_cache_key</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>-</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_object_time_safe'>object_time_safe</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>else</span>
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>UndefinedCacheKey</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_content'> must define #cache_key, or the &#39;key:&#39; option must be passed into &#39;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_serializer_class'>serializer_class</span><span class='embexpr_end'>}</span><span class='tstring_content'>.cache&#39;</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="serializer_class-instance_method">
- (<tt>Object</tt>) <strong>serializer_class</strong>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
280
281
282</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/caching.rb', line 280</span>
<span class='kw'>def</span> <span class='id identifier rubyid_serializer_class'>serializer_class</span>
<span class='ivar'>@serializer_class</span> <span class='op'>||=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Thu Jun 16 09:05:08 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>