ditkrg/active_model_serializers
4
0
Fork 0
mirror of https://github.com/ditkrg/active_model_serializers.git synced 2026-01-23 14:29:31 +00:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
active_model_serializers/ActiveModel/Serializer/Caching/ClassMethods.html
Benjamin Fleischer e4258b6db9 Generating docs for version 0.10.0 at ref 0e46d20.
2016-06-16 09:05:14 -05:00

1300 lines
42 KiB
HTML
Raw Permalink Blame History

<!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::ClassMethods
&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/ClassMethods.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'><span class='object_link'><a href="../Caching.html" title="ActiveModel::Serializer::Caching (module)">Caching</a></span></span>
&raquo;
<span class="title">ClassMethods</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::ClassMethods
</h1>
<dl class="box">
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/active_model/serializer/caching.rb</dd>
</dl>
<div class="clear"></div>
<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_digest-instance_method" title="#_cache_digest (instance method)">- (Object) <strong>_cache_digest</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#_skip_digest%3F-instance_method" title="#_skip_digest? (instance method)">- (Boolean) <strong>_skip_digest?</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#cache-instance_method" title="#cache (instance method)">- (Object) <strong>cache</strong>(options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Enables a serializer to be automatically cached.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#cache_enabled%3F-instance_method" title="#cache_enabled? (instance method)">- (Boolean) <strong>cache_enabled?</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#cache_read_multi-instance_method" title="#cache_read_multi (instance method)">- (Hash) <strong>cache_read_multi</strong>(collection_serializer, adapter_instance, include_directive) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Read cache from cache_store.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#cache_store-instance_method" title="#cache_store (instance method)">- (nil, ...) <strong>cache_store</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The canonical method for getting the cache store for the serializer.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#digest_caller_file-instance_method" title="#digest_caller_file (instance method)">- (Object) <strong>digest_caller_file</strong>(caller_line) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Hashes contents of file for <code>_cache_digest</code>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fragment_cache_enabled%3F-instance_method" title="#fragment_cache_enabled? (instance method)">- (Boolean) <strong>fragment_cache_enabled?</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fragmented_attributes-instance_method" title="#fragmented_attributes (instance method)">- (Object) <strong>fragmented_attributes</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#inherited-instance_method" title="#inherited (instance method)">- (Object) <strong>inherited</strong>(base) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#object_cache_key-instance_method" title="#object_cache_key (instance method)">- (String<sup>?</sup>) <strong>object_cache_key</strong>(serializer, adapter_instance) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The cache_key of the serializer or nil.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#object_cache_keys-instance_method" title="#object_cache_keys (instance method)">- (Array) <strong>object_cache_keys</strong>(collection_serializer, adapter_instance, include_directive) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Find all cache_key for the collection_serializer.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#perform_caching-instance_method" title="#perform_caching (instance method)">- (true, false) <strong>perform_caching</strong> </a>
(also: #perform_caching?)
</span>
<span class="summary_desc"><div class='inline'>
<p>Value is from ActiveModelSerializers.config.perform_caching.</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="_cache_digest-instance_method">
- (<tt>Object</tt>) <strong>_cache_digest</strong>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
48
49
50
51</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/caching.rb', line 48</span>
<span class='kw'>def</span> <span class='id identifier rubyid__cache_digest'>_cache_digest</span>
<span class='kw'>return</span> <span class='ivar'>@_cache_digest</span> <span class='kw'>if</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='ivar'>@_cache_digest</span><span class='rparen'>)</span>
<span class='ivar'>@_cache_digest</span> <span class='op'>=</span> <span class='id identifier rubyid_digest_caller_file'>digest_caller_file</span><span class='lparen'>(</span><span class='id identifier rubyid__cache_digest_file_path'>_cache_digest_file_path</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="_skip_digest?-instance_method">
- (<tt>Boolean</tt>) <strong>_skip_digest?</strong>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
67
68
69</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/caching.rb', line 67</span>
<span class='kw'>def</span> <span class='id identifier rubyid__skip_digest?'>_skip_digest?</span>
<span class='id identifier rubyid__cache_options'>_cache_options</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid__cache_options'>_cache_options</span><span class='lbracket'>[</span><span class='symbol'>:skip_digest</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="cache-instance_method">
- (<tt>Object</tt>) <strong>cache</strong>(options = {})
</h3><div class="docstring">
<div class="discussion">
<div class="note todo">
<strong>TODO:</strong>
<div class='inline'>
<p>require less code comments. See</p>
</div>
</div>
<p>Enables a serializer to be automatically cached</p>
<p>Sets <code>::_cache</code> object to
<code>ActionController::Base.cache_store</code></p>
<pre class="code ruby"><code class="ruby">when Rails.configuration.action_controller.perform_caching</code></pre>
<p><a
href="https://github.com/rails-api/active_model_serializers/pull/1249#issuecomment-146567837">github.com/rails-api/active_model_serializers/pull/1249#issuecomment-146567837</a></p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<pre class="example code"><code><span class='kw'>class</span> <span class='const'>PostSerializer</span> <span class='op'>&lt;</span> <span class='const'>ActiveModel</span><span class='op'>::</span><span class='const'>Serializer</span>
<span class='id identifier rubyid_cache'>cache</span> <span class='label'>key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>post</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>expires_in:</span> <span class='int'>3</span><span class='period'>.</span><span class='id identifier rubyid_hours'>hours</span>
<span class='id identifier rubyid_attributes'>attributes</span> <span class='symbol'>:title</span><span class='comma'>,</span> <span class='symbol'>:body</span>
<span class='id identifier rubyid_has_many'>has_many</span> <span class='symbol'>:comments</span>
<span class='kw'>end</span></code></pre>
</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>options</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
&mdash;
<div class='inline'>
<p>with valid keys: cache_store : @see ::_cache key : @see
::_cache_key only : @see ::_cache_only except : @see
::_cache_except skip_digest : does not include digest in cache_key all
else : @see ::_cache_options</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
105
106
107
108
109
110
111
112
113
114</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/caching.rb', line 105</span>
<span class='kw'>def</span> <span class='id identifier rubyid_cache'>cache</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid__cache'>_cache</span> <span class='op'>=</span>
<span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:cache_store</span><span class='rparen'>)</span> <span class='op'>||</span>
<span class='const'>ActiveModelSerializers</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_cache_store'>cache_store</span> <span class='op'>||</span>
<span class='const'>ActiveSupport</span><span class='op'>::</span><span class='const'>Cache</span><span class='period'>.</span><span class='id identifier rubyid_lookup_store'>lookup_store</span><span class='lparen'>(</span><span class='symbol'>:null_store</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid__cache_key'>_cache_key</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:key</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid__cache_only'>_cache_only</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:only</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid__cache_except'>_cache_except</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:except</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid__cache_options'>_cache_options</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> <span class='op'>?</span> <span class='kw'>nil</span> <span class='op'>:</span> <span class='id identifier rubyid_options'>options</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="cache_enabled?-instance_method">
- (<tt>Boolean</tt>) <strong>cache_enabled?</strong>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
150
151
152</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/caching.rb', line 150</span>
<span class='kw'>def</span> <span class='id identifier rubyid_cache_enabled?'>cache_enabled?</span>
<span class='id identifier rubyid_perform_caching?'>perform_caching?</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_cache_store'>cache_store</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='id identifier rubyid__cache_only'>_cache_only</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='id identifier rubyid__cache_except'>_cache_except</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="cache_read_multi-instance_method">
- (<tt>Hash</tt>) <strong>cache_read_multi</strong>(collection_serializer, adapter_instance, include_directive)
</h3><div class="docstring">
<div class="discussion">
<p>Read cache from cache_store</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
161
162
163
164
165
166
167
168
169</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/caching.rb', line 161</span>
<span class='kw'>def</span> <span class='id identifier rubyid_cache_read_multi'>cache_read_multi</span><span class='lparen'>(</span><span class='id identifier rubyid_collection_serializer'>collection_serializer</span><span class='comma'>,</span> <span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='comma'>,</span> <span class='id identifier rubyid_include_directive'>include_directive</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='kw'>if</span> <span class='const'>ActiveModelSerializers</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_cache_store'>cache_store</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span>
<span class='id identifier rubyid_keys'>keys</span> <span class='op'>=</span> <span class='id identifier rubyid_object_cache_keys'>object_cache_keys</span><span class='lparen'>(</span><span class='id identifier rubyid_collection_serializer'>collection_serializer</span><span class='comma'>,</span> <span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='comma'>,</span> <span class='id identifier rubyid_include_directive'>include_directive</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='kw'>if</span> <span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span>
<span class='const'>ActiveModelSerializers</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_cache_store'>cache_store</span><span class='period'>.</span><span class='id identifier rubyid_read_multi'>read_multi</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_keys'>keys</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="cache_store-instance_method">
- (<tt>nil</tt>, ...) <strong>cache_store</strong>
</h3><div class="docstring">
<div class="discussion">
<p>The canonical method for getting the cache store for the serializer.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>nil</tt>)</span>
&mdash;
<div class='inline'>
<p>when _cache is not set (i.e. when `cache` has not been called)</p>
</div>
</li>
<li>
<span class='type'>(<tt>._cache</tt>)</span>
&mdash;
<div class='inline'>
<p>when _cache is not the NullStore</p>
</div>
</li>
<li>
<span class='type'>(<tt><span class='object_link'><a href="../../../ActiveModelSerializers.html" title="ActiveModelSerializers (module)">ActiveModelSerializers</a></span>.config.cache_store</tt>)</span>
&mdash;
<div class='inline'>
<p>when _cache is the NullStore. This is so we can use `cache` being called to
mean the serializer should be cached even if
ActiveModelSerializers.config.cache_store has not yet been set. That means
that when _cache is the NullStore and
ActiveModelSerializers.config.cache_store is configured, `cache_store`
becomes `ActiveModelSerializers.config.cache_store`.</p>
</div>
</li>
<li>
<span class='type'>(<tt>nil</tt>)</span>
&mdash;
<div class='inline'>
<p>when _cache is the NullStore and ActiveModelSerializers.config.cache_store
is nil.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
140
141
142
143
144
145
146
147
148</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/caching.rb', line 140</span>
<span class='kw'>def</span> <span class='id identifier rubyid_cache_store'>cache_store</span>
<span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='id identifier rubyid__cache'>_cache</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='kw'>return</span> <span class='id identifier rubyid__cache'>_cache</span> <span class='kw'>if</span> <span class='id identifier rubyid__cache'>_cache</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span> <span class='op'>!=</span> <span class='const'>ActiveSupport</span><span class='op'>::</span><span class='const'>Cache</span><span class='op'>::</span><span class='const'>NullStore</span>
<span class='kw'>if</span> <span class='const'>ActiveModelSerializers</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_cache_store'>cache_store</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid__cache'>_cache</span> <span class='op'>=</span> <span class='const'>ActiveModelSerializers</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_cache_store'>cache_store</span>
<span class='kw'>else</span>
<span class='kw'>nil</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="digest_caller_file-instance_method">
- (<tt>Object</tt>) <strong>digest_caller_file</strong>(caller_line)
</h3><div class="docstring">
<div class="discussion">
<p>Hashes contents of file for <code>_cache_digest</code></p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
54
55
56
57
58
59
60
61
62
63
64
65</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/caching.rb', line 54</span>
<span class='kw'>def</span> <span class='id identifier rubyid_digest_caller_file'>digest_caller_file</span><span class='lparen'>(</span><span class='id identifier rubyid_caller_line'>caller_line</span><span class='rparen'>)</span>
<span class='id identifier rubyid_serializer_file_path'>serializer_file_path</span> <span class='op'>=</span> <span class='id identifier rubyid_caller_line'>caller_line</span><span class='lbracket'>[</span><span class='const'>CALLER_FILE</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_serializer_file_contents'>serializer_file_contents</span> <span class='op'>=</span> <span class='const'>IO</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='id identifier rubyid_serializer_file_path'>serializer_file_path</span><span class='rparen'>)</span>
<span class='const'>Digest</span><span class='op'>::</span><span class='const'>MD5</span><span class='period'>.</span><span class='id identifier rubyid_hexdigest'>hexdigest</span><span class='lparen'>(</span><span class='id identifier rubyid_serializer_file_contents'>serializer_file_contents</span><span class='rparen'>)</span>
<span class='kw'>rescue</span> <span class='const'>TypeError</span><span class='comma'>,</span> <span class='const'>Errno</span><span class='op'>::</span><span class='const'>ENOENT</span>
<span class='id identifier rubyid_warn'>warn</span> <span class='heredoc_beg'>&lt;&lt;-EOF</span><span class='period'>.</span><span class='id identifier rubyid_strip_heredoc'>strip_heredoc</span>
<span class='tstring_content'> Cannot digest non-existent file: &#39;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_caller_line'>caller_line</span><span class='embexpr_end'>}</span><span class='tstring_content'>&#39;.
Please set `::_cache_digest` of the serializer
if you&#39;d like to cache it.
</span><span class='heredoc_end'> EOF
</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fragment_cache_enabled?-instance_method">
- (<tt>Boolean</tt>) <strong>fragment_cache_enabled?</strong>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
154
155
156
157</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/caching.rb', line 154</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fragment_cache_enabled?'>fragment_cache_enabled?</span>
<span class='id identifier rubyid_perform_caching?'>perform_caching?</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_cache_store'>cache_store</span> <span class='op'>&amp;&amp;</span>
<span class='lparen'>(</span><span class='id identifier rubyid__cache_only'>_cache_only</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='id identifier rubyid__cache_except'>_cache_except</span> <span class='op'>||</span> <span class='op'>!</span><span class='id identifier rubyid__cache_only'>_cache_only</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid__cache_except'>_cache_except</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fragmented_attributes-instance_method">
- (<tt>Object</tt>) <strong>fragmented_attributes</strong>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
71
72
73
74
75
76
77
78
79
80</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/caching.rb', line 71</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fragmented_attributes'>fragmented_attributes</span>
<span class='id identifier rubyid_cached'>cached</span> <span class='op'>=</span> <span class='id identifier rubyid__cache_only'>_cache_only</span> <span class='op'>?</span> <span class='id identifier rubyid__cache_only'>_cache_only</span> <span class='op'>:</span> <span class='id identifier rubyid__attributes'>_attributes</span> <span class='op'>-</span> <span class='id identifier rubyid__cache_except'>_cache_except</span>
<span class='id identifier rubyid_cached'>cached</span> <span class='op'>=</span> <span class='id identifier rubyid_cached'>cached</span><span class='period'>.</span><span class='id identifier rubyid_map!'>map!</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_field'>field</span><span class='op'>|</span> <span class='id identifier rubyid__attributes_keys'>_attributes_keys</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_field'>field</span><span class='comma'>,</span> <span class='id identifier rubyid_field'>field</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_non_cached'>non_cached</span> <span class='op'>=</span> <span class='id identifier rubyid__attributes'>_attributes</span> <span class='op'>-</span> <span class='id identifier rubyid_cached'>cached</span>
<span class='id identifier rubyid_non_cached'>non_cached</span> <span class='op'>=</span> <span class='id identifier rubyid_non_cached'>non_cached</span><span class='period'>.</span><span class='id identifier rubyid_map!'>map!</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_field'>field</span><span class='op'>|</span> <span class='id identifier rubyid__attributes_keys'>_attributes_keys</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_field'>field</span><span class='comma'>,</span> <span class='id identifier rubyid_field'>field</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='lbrace'>{</span>
<span class='label'>cached:</span> <span class='id identifier rubyid_cached'>cached</span><span class='comma'>,</span>
<span class='label'>non_cached:</span> <span class='id identifier rubyid_non_cached'>non_cached</span>
<span class='rbrace'>}</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="inherited-instance_method">
- (<tt>Object</tt>) <strong>inherited</strong>(base)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
42
43
44
45
46</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/caching.rb', line 42</span>
<span class='kw'>def</span> <span class='id identifier rubyid_inherited'>inherited</span><span class='lparen'>(</span><span class='id identifier rubyid_base'>base</span><span class='rparen'>)</span>
<span class='kw'>super</span>
<span class='id identifier rubyid_caller_line'>caller_line</span> <span class='op'>=</span> <span class='id identifier rubyid_caller'>caller</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_base'>base</span><span class='period'>.</span><span class='id identifier rubyid__cache_digest_file_path'>_cache_digest_file_path</span> <span class='op'>=</span> <span class='id identifier rubyid_caller_line'>caller_line</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>String</tt><sup>?</sup>) <strong>object_cache_key</strong>(serializer, adapter_instance)
</h3><div class="docstring">
<div class="discussion">
<p>Returns the cache_key of the serializer or nil</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
&mdash;
<div class='inline'>
<p>the cache_key of the serializer or nil</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
197
198
199
200
201</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/caching.rb', line 197</span>
<span class='kw'>def</span> <span class='id identifier rubyid_object_cache_key'>object_cache_key</span><span class='lparen'>(</span><span class='id identifier rubyid_serializer'>serializer</span><span class='comma'>,</span> <span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_serializer'>serializer</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_serializer'>serializer</span><span class='period'>.</span><span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span>
<span class='id identifier rubyid_serializer'>serializer</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_cache_enabled?'>cache_enabled?</span> <span class='op'>?</span> <span class='id identifier rubyid_serializer'>serializer</span><span class='period'>.</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='op'>:</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="object_cache_keys-instance_method">
- (<tt>Array</tt>) <strong>object_cache_keys</strong>(collection_serializer, adapter_instance, include_directive)
</h3><div class="docstring">
<div class="discussion">
<p>Find all cache_key for the collection_serializer</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>serializers</span>
<span class='type'>(<tt><span class='object_link'><a href="../CollectionSerializer.html" title="ActiveModel::Serializer::CollectionSerializer (class)">ActiveModel::Serializer::CollectionSerializer</a></span></tt>)</span>
</li>
<li>
<span class='name'>adapter_instance</span>
<span class='type'>(<tt><span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html" title="ActiveModelSerializers::Adapter::Base (class)">ActiveModelSerializers::Adapter::Base</a></span></tt>)</span>
</li>
<li>
<span class='name'>include_directive</span>
<span class='type'>(<tt>JSONAPI::IncludeDirective</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array</tt>)</span>
&mdash;
<div class='inline'>
<p>all cache_key of collection_serializer</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/caching.rb', line 176</span>
<span class='kw'>def</span> <span class='id identifier rubyid_object_cache_keys'>object_cache_keys</span><span class='lparen'>(</span><span class='id identifier rubyid_collection_serializer'>collection_serializer</span><span class='comma'>,</span> <span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='comma'>,</span> <span class='id identifier rubyid_include_directive'>include_directive</span><span class='rparen'>)</span>
<span class='id identifier rubyid_cache_keys'>cache_keys</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_collection_serializer'>collection_serializer</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_serializer'>serializer</span><span class='op'>|</span>
<span class='id identifier rubyid_cache_keys'>cache_keys</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_object_cache_key'>object_cache_key</span><span class='lparen'>(</span><span class='id identifier rubyid_serializer'>serializer</span><span class='comma'>,</span> <span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='rparen'>)</span>
<span class='id identifier rubyid_serializer'>serializer</span><span class='period'>.</span><span class='id identifier rubyid_associations'>associations</span><span class='lparen'>(</span><span class='id identifier rubyid_include_directive'>include_directive</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_association'>association</span><span class='op'>|</span>
<span class='kw'>if</span> <span class='id identifier rubyid_association'>association</span><span class='period'>.</span><span class='id identifier rubyid_serializer'>serializer</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:each</span><span class='rparen'>)</span>
<span class='id identifier rubyid_association'>association</span><span class='period'>.</span><span class='id identifier rubyid_serializer'>serializer</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_sub_serializer'>sub_serializer</span><span class='op'>|</span>
<span class='id identifier rubyid_cache_keys'>cache_keys</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_object_cache_key'>object_cache_key</span><span class='lparen'>(</span><span class='id identifier rubyid_sub_serializer'>sub_serializer</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='kw'>else</span>
<span class='id identifier rubyid_cache_keys'>cache_keys</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_object_cache_key'>object_cache_key</span><span class='lparen'>(</span><span class='id identifier rubyid_association'>association</span><span class='period'>.</span><span class='id identifier rubyid_serializer'>serializer</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='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_cache_keys'>cache_keys</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span><span class='period'>.</span><span class='id identifier rubyid_uniq'>uniq</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="perform_caching-instance_method">
- (<tt>true</tt>, <tt>false</tt>) <strong>perform_caching</strong>
<span class="aliases">Also known as:
<span class="names"><span id='perform_caching?-instance_method'>perform_caching?</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Value is from ActiveModelSerializers.config.perform_caching. Is used to
globally enable or disable all serializer caching, just like
Rails.configuration.action_controller.perform_caching, which is its default
value in a Rails application. Memoizes value of config first time it is
called with a non-nil value. rubocop:disable Style/ClassVars</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
123
124
125
126</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/caching.rb', line 123</span>
<span class='kw'>def</span> <span class='id identifier rubyid_perform_caching'>perform_caching</span>
<span class='kw'>return</span> <span class='cvar'>@@perform_caching</span> <span class='kw'>if</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='cvar'>@@perform_caching</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='cvar'>@@perform_caching</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='cvar'>@@perform_caching</span> <span class='op'>=</span> <span class='const'>ActiveModelSerializers</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_perform_caching'>perform_caching</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Thu Jun 16 09:05:09 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>
Reference in New Issue View Git Blame Copy Permalink