mirror of
https://github.com/ditkrg/active_model_serializers.git
synced 2026-01-22 22:06:50 +00:00
Generating docs for version 0.10.0.
This commit is contained in:
Benjamin Fleischer
parent
a328599843
commit
0a4c212ccc
@ -106,9 +106,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:35 2016 by
|
||||
Generated on Mon Jun 13 21:53:36 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -339,9 +339,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:35 2016 by
|
||||
Generated on Mon Jun 13 21:53:36 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -165,9 +165,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:35 2016 by
|
||||
Generated on Mon Jun 13 21:53:36 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -80,7 +80,7 @@
|
||||
|
||||
<dt class="r1 last">Defined in:</dt>
|
||||
<dd class="r1 last">lib/active_model/serializer.rb<span class="defines">,<br />
|
||||
lib/active_model/serializer/type.rb,<br /> lib/active_model/serializer/null.rb,<br /> lib/active_model/serializer/meta.rb,<br /> lib/active_model/serializer/field.rb,<br /> lib/active_model/serializer/links.rb,<br /> lib/active_model/serializer/adapter.rb,<br /> lib/active_model/serializer/version.rb,<br /> lib/active_model/serializer/caching.rb,<br /> lib/active_model/serializer/fieldset.rb,<br /> lib/active_model/serializer/attribute.rb,<br /> lib/active_model/serializable_resource.rb,<br /> lib/active_model/serializer/reflection.rb,<br /> lib/active_model/serializer/attributes.rb,<br /> lib/active_model/serializer/association.rb,<br /> lib/active_model/serializer/include_tree.rb,<br /> lib/active_model/serializer/adapter/null.rb,<br /> lib/active_model/serializer/adapter/json.rb,<br /> lib/active_model/serializer/adapter/base.rb,<br /> lib/active_model/serializer/associations.rb,<br /> lib/active_model/serializer/configuration.rb,<br /> lib/active_model/serializer/adapter/json_api.rb,<br /> lib/active_model/serializer/adapter/attributes.rb,<br /> lib/active_model/serializer/has_one_reflection.rb,<br /> lib/active_model/serializer/has_many_reflection.rb,<br /> lib/active_model/serializer/singular_reflection.rb,<br /> lib/active_model/serializer/collection_reflection.rb,<br /> lib/active_model/serializer/belongs_to_reflection.rb,<br /> lib/active_model/serializer/collection_serializer.rb</span>
|
||||
lib/active_model/serializer/type.rb,<br /> lib/active_model/serializer/null.rb,<br /> lib/active_model/serializer/meta.rb,<br /> lib/active_model/serializer/field.rb,<br /> lib/active_model/serializer/links.rb,<br /> lib/active_model/serializer/adapter.rb,<br /> lib/active_model/serializer/version.rb,<br /> lib/active_model/serializer/caching.rb,<br /> lib/active_model/serializer/fieldset.rb,<br /> lib/active_model/serializer/attribute.rb,<br /> lib/active_model/serializer/reflection.rb,<br /> lib/active_model/serializable_resource.rb,<br /> lib/active_model/serializer/attributes.rb,<br /> lib/active_model/serializer/association.rb,<br /> lib/active_model/serializer/associations.rb,<br /> lib/active_model/serializer/adapter/json.rb,<br /> lib/active_model/serializer/adapter/null.rb,<br /> lib/active_model/serializer/adapter/base.rb,<br /> lib/active_model/serializer/configuration.rb,<br /> lib/active_model/serializer/adapter/json_api.rb,<br /> lib/active_model/serializer/has_one_reflection.rb,<br /> lib/active_model/serializer/adapter/attributes.rb,<br /> lib/active_model/serializer/singular_reflection.rb,<br /> lib/active_model/serializer/has_many_reflection.rb,<br /> lib/active_model/serializer/collection_reflection.rb,<br /> lib/active_model/serializer/belongs_to_reflection.rb,<br /> lib/active_model/serializer/collection_serializer.rb</span>
|
||||
</dd>
|
||||
|
||||
</dl>
|
||||
@ -120,9 +120,9 @@ subclassed to decorate a resource.</p>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:35 2016 by
|
||||
Generated on Mon Jun 13 21:53:35 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -1,123 +0,0 @@
|
||||
<!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>
|
||||
Class: ActiveModel::Railtie
|
||||
|
||||
— 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/Railtie.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 (R)</a> »
|
||||
<span class='title'><span class='object_link'><a href="../ActiveModel.html" title="ActiveModel (module)">ActiveModel</a></span></span>
|
||||
»
|
||||
<span class="title">Railtie</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>Class: ActiveModel::Railtie
|
||||
|
||||
|
||||
|
||||
</h1>
|
||||
|
||||
<dl class="box">
|
||||
|
||||
<dt class="r1">Inherits:</dt>
|
||||
<dd class="r1">
|
||||
<span class="inheritName">Rails::Railtie</span>
|
||||
|
||||
<ul class="fullTree">
|
||||
<li>Object</li>
|
||||
|
||||
<li class="next">Rails::Railtie</li>
|
||||
|
||||
<li class="next">ActiveModel::Railtie</li>
|
||||
|
||||
</ul>
|
||||
<a href="#" class="inheritanceTree">show all</a>
|
||||
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="r2 last">Defined in:</dt>
|
||||
<dd class="r2 last">lib/active_model/serializer/railtie.rb</dd>
|
||||
|
||||
</dl>
|
||||
<div class="clear"></div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Thu Oct 1 16:00:43 2015 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -126,9 +126,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:38 2016 by
|
||||
Generated on Mon Jun 13 21:53:38 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -103,7 +103,7 @@
|
||||
|
||||
<dt class="r2 last">Defined in:</dt>
|
||||
<dd class="r2 last">lib/active_model/serializer.rb<span class="defines">,<br />
|
||||
lib/active_model/serializer/type.rb,<br /> lib/active_model/serializer/null.rb,<br /> lib/active_model/serializer/meta.rb,<br /> lib/active_model/serializer/field.rb,<br /> lib/active_model/serializer/links.rb,<br /> lib/active_model/serializer/adapter.rb,<br /> lib/active_model/serializer/version.rb,<br /> lib/active_model/serializer/caching.rb,<br /> lib/active_model/serializer/fieldset.rb,<br /> lib/active_model/serializer/attribute.rb,<br /> lib/active_model/serializer/reflection.rb,<br /> lib/active_model/serializer/attributes.rb,<br /> lib/active_model/serializer/association.rb,<br /> lib/active_model/serializer/include_tree.rb,<br /> lib/active_model/serializer/adapter/null.rb,<br /> lib/active_model/serializer/adapter/json.rb,<br /> lib/active_model/serializer/adapter/base.rb,<br /> lib/active_model/serializer/associations.rb,<br /> lib/active_model/serializer/configuration.rb,<br /> lib/active_model/serializer/adapter/json_api.rb,<br /> lib/active_model/serializer/array_serializer.rb,<br /> lib/active_model/serializer/adapter/attributes.rb,<br /> lib/active_model/serializer/has_one_reflection.rb,<br /> lib/active_model/serializer/has_many_reflection.rb,<br /> lib/active_model/serializer/singular_reflection.rb,<br /> lib/active_model/serializer/collection_reflection.rb,<br /> lib/active_model/serializer/belongs_to_reflection.rb,<br /> lib/active_model/serializer/collection_serializer.rb</span>
|
||||
lib/active_model/serializer/type.rb,<br /> lib/active_model/serializer/null.rb,<br /> lib/active_model/serializer/meta.rb,<br /> lib/active_model/serializer/field.rb,<br /> lib/active_model/serializer/links.rb,<br /> lib/active_model/serializer/adapter.rb,<br /> lib/active_model/serializer/version.rb,<br /> lib/active_model/serializer/caching.rb,<br /> lib/active_model/serializer/fieldset.rb,<br /> lib/active_model/serializer/attribute.rb,<br /> lib/active_model/serializer/reflection.rb,<br /> lib/active_model/serializer/attributes.rb,<br /> lib/active_model/serializer/association.rb,<br /> lib/active_model/serializer/associations.rb,<br /> lib/active_model/serializer/adapter/json.rb,<br /> lib/active_model/serializer/adapter/null.rb,<br /> lib/active_model/serializer/adapter/base.rb,<br /> lib/active_model/serializer/configuration.rb,<br /> lib/active_model/serializer/adapter/json_api.rb,<br /> lib/active_model/serializer/array_serializer.rb,<br /> lib/active_model/serializer/has_one_reflection.rb,<br /> lib/active_model/serializer/adapter/attributes.rb,<br /> lib/active_model/serializer/singular_reflection.rb,<br /> lib/active_model/serializer/has_many_reflection.rb,<br /> lib/active_model/serializer/collection_reflection.rb,<br /> lib/active_model/serializer/belongs_to_reflection.rb,<br /> lib/active_model/serializer/collection_serializer.rb</span>
|
||||
</dd>
|
||||
|
||||
</dl>
|
||||
@ -121,7 +121,7 @@
|
||||
|
||||
|
||||
|
||||
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Serializer/ArraySerializer.html" title="ActiveModel::Serializer::ArraySerializer (class)">ArraySerializer</a></span>, <span class='object_link'><a href="Serializer/Association.html" title="ActiveModel::Serializer::Association (class)">Association</a></span>, <span class='object_link'><a href="Serializer/Attribute.html" title="ActiveModel::Serializer::Attribute (class)">Attribute</a></span>, <span class='object_link'><a href="Serializer/BelongsToReflection.html" title="ActiveModel::Serializer::BelongsToReflection (class)">BelongsToReflection</a></span>, <span class='object_link'><a href="Serializer/CollectionReflection.html" title="ActiveModel::Serializer::CollectionReflection (class)">CollectionReflection</a></span>, <span class='object_link'><a href="Serializer/CollectionSerializer.html" title="ActiveModel::Serializer::CollectionSerializer (class)">CollectionSerializer</a></span>, <span class='object_link'><a href="Serializer/ErrorSerializer.html" title="ActiveModel::Serializer::ErrorSerializer (class)">ErrorSerializer</a></span>, <span class='object_link'><a href="Serializer/ErrorsSerializer.html" title="ActiveModel::Serializer::ErrorsSerializer (class)">ErrorsSerializer</a></span>, <span class='object_link'><a href="Serializer/Field.html" title="ActiveModel::Serializer::Field (class)">Field</a></span>, <span class='object_link'><a href="Serializer/Fieldset.html" title="ActiveModel::Serializer::Fieldset (class)">Fieldset</a></span>, <span class='object_link'><a href="Serializer/HasManyReflection.html" title="ActiveModel::Serializer::HasManyReflection (class)">HasManyReflection</a></span>, <span class='object_link'><a href="Serializer/HasOneReflection.html" title="ActiveModel::Serializer::HasOneReflection (class)">HasOneReflection</a></span>, <span class='object_link'><a href="Serializer/IncludeTree.html" title="ActiveModel::Serializer::IncludeTree (class)">IncludeTree</a></span>, <span class='object_link'><a href="Serializer/Null.html" title="ActiveModel::Serializer::Null (class)">Null</a></span>, <span class='object_link'><a href="Serializer/Reflection.html" title="ActiveModel::Serializer::Reflection (class)">Reflection</a></span>, <span class='object_link'><a href="Serializer/SingularReflection.html" title="ActiveModel::Serializer::SingularReflection (class)">SingularReflection</a></span>
|
||||
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Serializer/ArraySerializer.html" title="ActiveModel::Serializer::ArraySerializer (class)">ArraySerializer</a></span>, <span class='object_link'><a href="Serializer/Association.html" title="ActiveModel::Serializer::Association (class)">Association</a></span>, <span class='object_link'><a href="Serializer/Attribute.html" title="ActiveModel::Serializer::Attribute (class)">Attribute</a></span>, <span class='object_link'><a href="Serializer/BelongsToReflection.html" title="ActiveModel::Serializer::BelongsToReflection (class)">BelongsToReflection</a></span>, <span class='object_link'><a href="Serializer/CollectionReflection.html" title="ActiveModel::Serializer::CollectionReflection (class)">CollectionReflection</a></span>, <span class='object_link'><a href="Serializer/CollectionSerializer.html" title="ActiveModel::Serializer::CollectionSerializer (class)">CollectionSerializer</a></span>, <span class='object_link'><a href="Serializer/ErrorSerializer.html" title="ActiveModel::Serializer::ErrorSerializer (class)">ErrorSerializer</a></span>, <span class='object_link'><a href="Serializer/ErrorsSerializer.html" title="ActiveModel::Serializer::ErrorsSerializer (class)">ErrorsSerializer</a></span>, <span class='object_link'><a href="Serializer/Field.html" title="ActiveModel::Serializer::Field (class)">Field</a></span>, <span class='object_link'><a href="Serializer/Fieldset.html" title="ActiveModel::Serializer::Fieldset (class)">Fieldset</a></span>, <span class='object_link'><a href="Serializer/HasManyReflection.html" title="ActiveModel::Serializer::HasManyReflection (class)">HasManyReflection</a></span>, <span class='object_link'><a href="Serializer/HasOneReflection.html" title="ActiveModel::Serializer::HasOneReflection (class)">HasOneReflection</a></span>, <span class='object_link'><a href="Serializer/Null.html" title="ActiveModel::Serializer::Null (class)">Null</a></span>, <span class='object_link'><a href="Serializer/Reflection.html" title="ActiveModel::Serializer::Reflection (class)">Reflection</a></span>, <span class='object_link'><a href="Serializer/SingularReflection.html" title="ActiveModel::Serializer::SingularReflection (class)">SingularReflection</a></span>
|
||||
|
||||
|
||||
</p>
|
||||
@ -130,10 +130,36 @@
|
||||
|
||||
<dl class="constants">
|
||||
|
||||
<dt id="SERIALIZABLE_HASH_VALID_KEYS-constant" class="">SERIALIZABLE_HASH_VALID_KEYS =
|
||||
<div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
<p class="tag_title">See Also:</p>
|
||||
<ul class="see">
|
||||
|
||||
<li><span class='object_link'><a href="#serializable_hash-instance_method" title="ActiveModel::Serializer#serializable_hash (method)">for more details on these valid keys.</a></span></li>
|
||||
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</dt>
|
||||
<dd><pre class="code"><span class='lbracket'>[</span><span class='symbol'>:only</span><span class='comma'>,</span> <span class='symbol'>:except</span><span class='comma'>,</span> <span class='symbol'>:methods</span><span class='comma'>,</span> <span class='symbol'>:include</span><span class='comma'>,</span> <span class='symbol'>:root</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
||||
|
||||
<dt id="VERSION-constant" class="">VERSION =
|
||||
|
||||
</dt>
|
||||
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>0.10.0.rc5</span><span class='tstring_end'>'</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
||||
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>0.10.0</span><span class='tstring_end'>'</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
||||
|
||||
<dt id="UndefinedCacheKey-constant" class="">UndefinedCacheKey =
|
||||
|
||||
</dt>
|
||||
<dd><pre class="code"><span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>StandardError</span><span class='rparen'>)</span></pre></dd>
|
||||
|
||||
</dl>
|
||||
|
||||
@ -147,12 +173,6 @@
|
||||
<p class="inherited"><span class='object_link'><a href="Serializer/Caching.html#CALLER_FILE-constant" title="ActiveModel::Serializer::Caching::CALLER_FILE (constant)">Caching::CALLER_FILE</a></span></p>
|
||||
|
||||
|
||||
|
||||
<h3 class="inherited">Constants included
|
||||
from <span class='object_link'><a href="Serializer/Associations.html" title="ActiveModel::Serializer::Associations (module)">Associations</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="Serializer/Associations.html#DEFAULT_INCLUDE_TREE-constant" title="ActiveModel::Serializer::Associations::DEFAULT_INCLUDE_TREE (constant)">Associations::DEFAULT_INCLUDE_TREE</a></span></p>
|
||||
|
||||
|
||||
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
||||
<ul class="summary">
|
||||
|
||||
@ -295,6 +315,50 @@
|
||||
<p>Find a serializer from a class and caches the lookup.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#include_directive_from_options-class_method" title="include_directive_from_options (class method)">+ (Object) <strong>include_directive_from_options</strong>(options) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="private note title">private</span>
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#serialization_adapter_instance-class_method" title="serialization_adapter_instance (class method)">+ (Object) <strong>serialization_adapter_instance</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="private note title">private</span>
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
@ -479,7 +543,51 @@ passed to `as_json` (:root, :only, :except, :methods, and :include).</p>
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#serializable_hash-instance_method" title="#serializable_hash (instance method)">- (Hash) <strong>serializable_hash</strong>(adapter_opts = nil) </a>
|
||||
<a href="#relationship_value_for-instance_method" title="#relationship_value_for (instance method)">- (Object) <strong>relationship_value_for</strong>(association, adapter_options, adapter_instance) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="private note title">private</span>
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#resource_relationships-instance_method" title="#resource_relationships (instance method)">- (Object) <strong>resource_relationships</strong>(adapter_options, options, adapter_instance) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="private note title">private</span>
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#serializable_hash-instance_method" title="#serializable_hash (instance method)">- (Hash) <strong>serializable_hash</strong>(adapter_options = nil, options = {}, adapter_instance = self.class.serialization_adapter_instance) </a>
|
||||
|
||||
|
||||
|
||||
@ -567,6 +675,11 @@ ActiveRecord::Base.</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 class="inherited">Methods included from <span class='object_link'><a href="Serializer/Caching.html" title="ActiveModel::Serializer::Caching (module)">Caching</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="Serializer/Caching.html#cache_key-instance_method" title="ActiveModel::Serializer::Caching#cache_key (method)">#cache_key</a></span>, <span class='object_link'><a href="Serializer/Caching.html#fetch-instance_method" title="ActiveModel::Serializer::Caching#fetch (method)">#fetch</a></span>, <span class='object_link'><a href="Serializer/Caching.html#fetch_attributes-instance_method" title="ActiveModel::Serializer::Caching#fetch_attributes (method)">#fetch_attributes</a></span>, <span class='object_link'><a href="Serializer/Caching.html#fetch_attributes_fragment-instance_method" title="ActiveModel::Serializer::Caching#fetch_attributes_fragment (method)">#fetch_attributes_fragment</a></span>, <span class='object_link'><a href="Serializer/Caching.html#object_cache_key-instance_method" title="ActiveModel::Serializer::Caching#object_cache_key (method)">#object_cache_key</a></span>, <span class='object_link'><a href="Serializer/Caching.html#serializer_class-instance_method" title="ActiveModel::Serializer::Caching#serializer_class (method)">#serializer_class</a></span></p>
|
||||
|
||||
|
||||
|
||||
@ -626,20 +739,20 @@ so that it calls the <code>scope</code>.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
104
|
||||
105
|
||||
106
|
||||
107
|
||||
108
|
||||
109
|
||||
110
|
||||
111
|
||||
112
|
||||
113
|
||||
114</pre>
|
||||
122
|
||||
123
|
||||
124
|
||||
125
|
||||
126
|
||||
127
|
||||
128
|
||||
129
|
||||
130
|
||||
131
|
||||
132</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 104</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 122</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_object'>object</span><span class='comma'>,</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_object'>object</span> <span class='op'>=</span> <span class='id identifier rubyid_object'>object</span>
|
||||
@ -690,12 +803,12 @@ so that it calls the <code>scope</code>.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
99
|
||||
100
|
||||
101</pre>
|
||||
117
|
||||
118
|
||||
119</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 99</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 117</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_object'>object</span>
|
||||
<span class='ivar'>@object</span>
|
||||
@ -733,12 +846,12 @@ so that it calls the <code>scope</code>.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
99
|
||||
100
|
||||
101</pre>
|
||||
117
|
||||
118
|
||||
119</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 99</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 117</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_root'>root</span>
|
||||
<span class='ivar'>@root</span>
|
||||
@ -776,12 +889,12 @@ so that it calls the <code>scope</code>.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
99
|
||||
100
|
||||
101</pre>
|
||||
117
|
||||
118
|
||||
119</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 99</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 117</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_scope'>scope</span>
|
||||
<span class='ivar'>@scope</span>
|
||||
@ -831,12 +944,12 @@ so that it calls the <code>scope</code>.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
51
|
||||
52
|
||||
53</pre>
|
||||
53
|
||||
54
|
||||
55</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 51</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 53</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_adapter'>adapter</span>
|
||||
<span class='const'>ActiveModelSerializers</span><span class='op'>::</span><span class='const'>Adapter</span><span class='period'>.</span><span class='id identifier rubyid_lookup'>lookup</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_adapter'>adapter</span><span class='rparen'>)</span>
|
||||
@ -881,8 +994,6 @@ returns:</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
85
|
||||
86
|
||||
87
|
||||
88
|
||||
89
|
||||
@ -893,10 +1004,12 @@ returns:</p>
|
||||
94
|
||||
95
|
||||
96
|
||||
97</pre>
|
||||
97
|
||||
98
|
||||
99</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 85</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 87</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_serializer_for'>get_serializer_for</span><span class='lparen'>(</span><span class='id identifier rubyid_klass'>klass</span><span class='rparen'>)</span>
|
||||
<span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>unless</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_serializer_lookup_enabled'>serializer_lookup_enabled</span>
|
||||
@ -914,6 +1027,104 @@ returns:</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="include_directive_from_options-class_method">
|
||||
|
||||
+ (<tt>Object</tt>) <strong>include_directive_from_options</strong>(options)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
<p class="note private">
|
||||
<strong>This method is part of a private API.</strong>
|
||||
You should avoid using this method if possible, as it may be removed or be changed in the future.
|
||||
</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
102
|
||||
103
|
||||
104
|
||||
105
|
||||
106
|
||||
107
|
||||
108
|
||||
109
|
||||
110</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 102</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_include_directive_from_options'>include_directive_from_options</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
<span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include_directive</span><span class='rbracket'>]</span>
|
||||
<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include_directive</span><span class='rbracket'>]</span>
|
||||
<span class='kw'>elsif</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include</span><span class='rbracket'>]</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_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>allow_wildcard:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
||||
<span class='kw'>else</span>
|
||||
<span class='const'>ActiveModelSerializers</span><span class='period'>.</span><span class='id identifier rubyid_default_include_directive'>default_include_directive</span>
|
||||
<span class='kw'>end</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="serialization_adapter_instance-class_method">
|
||||
|
||||
+ (<tt>Object</tt>) <strong>serialization_adapter_instance</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
<p class="note private">
|
||||
<strong>This method is part of a private API.</strong>
|
||||
You should avoid using this method if possible, as it may be removed or be changed in the future.
|
||||
</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
113
|
||||
114
|
||||
115</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 113</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_serialization_adapter_instance'>serialization_adapter_instance</span>
|
||||
<span class='ivar'>@serialization_adapter_instance</span> <span class='op'>||=</span> <span class='const'>ActiveModelSerializers</span><span class='op'>::</span><span class='const'>Adapter</span><span class='op'>::</span><span class='const'>Attributes</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
@ -993,18 +1204,18 @@ returns:</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
39
|
||||
40
|
||||
41
|
||||
42
|
||||
43
|
||||
44
|
||||
45
|
||||
46
|
||||
47</pre>
|
||||
47
|
||||
48
|
||||
49</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 39</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 41</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_serializer_for'>serializer_for</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</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'>if</span> <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:serializer_class</span><span class='rparen'>)</span>
|
||||
@ -1048,8 +1259,6 @@ returns:</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
60
|
||||
61
|
||||
62
|
||||
63
|
||||
64
|
||||
@ -1059,10 +1268,12 @@ returns:</p>
|
||||
68
|
||||
69
|
||||
70
|
||||
71</pre>
|
||||
71
|
||||
72
|
||||
73</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 60</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 62</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_serializer_lookup_chain_for'>serializer_lookup_chain_for</span><span class='lparen'>(</span><span class='id identifier rubyid_klass'>klass</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_chain'>chain</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
||||
@ -1108,12 +1319,12 @@ Serializer.get_serializer_for.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
75
|
||||
76
|
||||
77</pre>
|
||||
77
|
||||
78
|
||||
79</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 75</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 77</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_serializers_cache'>serializers_cache</span>
|
||||
<span class='ivar'>@serializers_cache</span> <span class='op'>||=</span> <span class='const'>ThreadSafe</span><span class='op'>::</span><span class='const'>Cache</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
|
||||
@ -1169,12 +1380,12 @@ JSON string includes a single root node.</code></pre>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
167
|
||||
168
|
||||
169</pre>
|
||||
185
|
||||
186
|
||||
187</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 167</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 185</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_as_json'>as_json</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter_opts'>adapter_opts</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_serializable_hash'>serializable_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter_opts'>adapter_opts</span><span class='rparen'>)</span>
|
||||
@ -1210,12 +1421,12 @@ JSON string includes a single root node.</code></pre>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
172
|
||||
173
|
||||
174</pre>
|
||||
190
|
||||
191
|
||||
192</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 172</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 190</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_json_key'>json_key</span>
|
||||
<span class='id identifier rubyid_root'>root</span> <span class='op'>||</span> <span class='id identifier rubyid__type'>_type</span> <span class='op'>||</span> <span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_model_name'>model_name</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_underscore'>underscore</span>
|
||||
@ -1240,24 +1451,20 @@ JSON string includes a single root node.</code></pre>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
176
|
||||
177
|
||||
178
|
||||
179
|
||||
180
|
||||
181
|
||||
182
|
||||
183
|
||||
184</pre>
|
||||
194
|
||||
195
|
||||
196
|
||||
197
|
||||
198
|
||||
199
|
||||
200</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 176</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 194</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_read_attribute_for_serialization'>read_attribute_for_serialization</span><span class='lparen'>(</span><span class='id identifier rubyid_attr'>attr</span><span class='rparen'>)</span>
|
||||
<span class='kw'>if</span> <span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='id identifier rubyid_attr'>attr</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_attr'>attr</span><span class='rparen'>)</span>
|
||||
<span class='kw'>elsif</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid__fragmented'>_fragmented</span>
|
||||
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid__fragmented'>_fragmented</span><span class='period'>.</span><span class='id identifier rubyid_read_attribute_for_serialization'>read_attribute_for_serialization</span><span class='lparen'>(</span><span class='id identifier rubyid_attr'>attr</span><span class='rparen'>)</span>
|
||||
<span class='kw'>else</span>
|
||||
<span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_read_attribute_for_serialization'>read_attribute_for_serialization</span><span class='lparen'>(</span><span class='id identifier rubyid_attr'>attr</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span>
|
||||
@ -1265,12 +1472,136 @@ JSON string includes a single root node.</code></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="relationship_value_for-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>relationship_value_for</strong>(association, adapter_options, adapter_instance)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
<p class="note private">
|
||||
<strong>This method is part of a private API.</strong>
|
||||
You should avoid using this method if possible, as it may be removed or be changed in the future.
|
||||
</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
215
|
||||
216
|
||||
217
|
||||
218
|
||||
219
|
||||
220
|
||||
221
|
||||
222
|
||||
223
|
||||
224
|
||||
225
|
||||
226
|
||||
227
|
||||
228
|
||||
229</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 215</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_relationship_value_for'>relationship_value_for</span><span class='lparen'>(</span><span class='id identifier rubyid_association'>association</span><span class='comma'>,</span> <span class='id identifier rubyid_adapter_options'>adapter_options</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='id identifier rubyid_association'>association</span><span class='period'>.</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:virtual_value</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_association'>association</span><span class='period'>.</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:virtual_value</span><span class='rbracket'>]</span>
|
||||
<span class='id identifier rubyid_association_serializer'>association_serializer</span> <span class='op'>=</span> <span class='id identifier rubyid_association'>association</span><span class='period'>.</span><span class='id identifier rubyid_serializer'>serializer</span>
|
||||
<span class='id identifier rubyid_association_object'>association_object</span> <span class='op'>=</span> <span class='id identifier rubyid_association_serializer'>association_serializer</span> <span class='op'>&&</span> <span class='id identifier rubyid_association_serializer'>association_serializer</span><span class='period'>.</span><span class='id identifier rubyid_object'>object</span>
|
||||
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_association_object'>association_object</span>
|
||||
|
||||
<span class='id identifier rubyid_relationship_value'>relationship_value</span> <span class='op'>=</span> <span class='id identifier rubyid_association_serializer'>association_serializer</span><span class='period'>.</span><span class='id identifier rubyid_serializable_hash'>serializable_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter_options'>adapter_options</span><span class='comma'>,</span> <span class='lbrace'>{</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'>if</span> <span class='id identifier rubyid_association'>association</span><span class='period'>.</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:polymorphic</span><span class='rbracket'>]</span> <span class='op'>&&</span> <span class='id identifier rubyid_relationship_value'>relationship_value</span>
|
||||
<span class='id identifier rubyid_polymorphic_type'>polymorphic_type</span> <span class='op'>=</span> <span class='id identifier rubyid_association_object'>association_object</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_underscore'>underscore</span>
|
||||
<span class='id identifier rubyid_relationship_value'>relationship_value</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='id identifier rubyid_polymorphic_type'>polymorphic_type</span><span class='comma'>,</span> <span class='id identifier rubyid_polymorphic_type'>polymorphic_type</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span> <span class='op'>=></span> <span class='id identifier rubyid_relationship_value'>relationship_value</span> <span class='rbrace'>}</span>
|
||||
<span class='kw'>end</span>
|
||||
|
||||
<span class='id identifier rubyid_relationship_value'>relationship_value</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="resource_relationships-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>resource_relationships</strong>(adapter_options, options, adapter_instance)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
<p class="note private">
|
||||
<strong>This method is part of a private API.</strong>
|
||||
You should avoid using this method if possible, as it may be removed or be changed in the future.
|
||||
</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
203
|
||||
204
|
||||
205
|
||||
206
|
||||
207
|
||||
208
|
||||
209
|
||||
210
|
||||
211
|
||||
212</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 203</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_resource_relationships'>resource_relationships</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter_options'>adapter_options</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='comma'>,</span> <span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_relationships'>relationships</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
||||
<span class='id identifier rubyid_include_directive'>include_directive</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:include_directive</span><span class='rparen'>)</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='id identifier rubyid_adapter_opts'>adapter_opts</span> <span class='op'>=</span> <span class='id identifier rubyid_adapter_options'>adapter_options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='label'>include_directive:</span> <span class='id identifier rubyid_include_directive'>include_directive</span><span class='lbracket'>[</span><span class='id identifier rubyid_association'>association</span><span class='period'>.</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_relationships'>relationships</span><span class='lbracket'>[</span><span class='id identifier rubyid_association'>association</span><span class='period'>.</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='id identifier rubyid_relationship_value_for'>relationship_value_for</span><span class='lparen'>(</span><span class='id identifier rubyid_association'>association</span><span class='comma'>,</span> <span class='id identifier rubyid_adapter_opts'>adapter_opts</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='id identifier rubyid_relationships'>relationships</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="serializable_hash-instance_method">
|
||||
|
||||
- (<tt>Hash</tt>) <strong>serializable_hash</strong>(adapter_opts = nil)
|
||||
- (<tt>Hash</tt>) <strong>serializable_hash</strong>(adapter_options = nil, options = {}, adapter_instance = self.class.serialization_adapter_instance)
|
||||
|
||||
|
||||
|
||||
@ -1286,9 +1617,8 @@ JSON string includes a single root node.</code></pre>
|
||||
<p>associations, similar to how ActiveModel::Serializers::JSON is used in
|
||||
ActiveRecord::Base.</p>
|
||||
|
||||
<p>TODO: Move to here the Attributes adapter logic for
|
||||
<tt>serializable_hash_for_single_resource(options)</tt> and include
|
||||
<code>ActiveModel::Serializers::JSON</code>. So that the below is true:</p>
|
||||
<p>TODO: Include <code>ActiveModel::Serializers::JSON</code>. So that the
|
||||
below is true:</p>
|
||||
|
||||
<pre class="code ruby"><code class="ruby">@param options [nil, Hash] The same valid options passed to `serializable_hash`
|
||||
(:only, :except, :methods, and :include).
|
||||
@ -1343,21 +1673,25 @@ ActiveRecord::Base.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
150
|
||||
151
|
||||
152
|
||||
153
|
||||
154
|
||||
155</pre>
|
||||
166
|
||||
167
|
||||
168
|
||||
169
|
||||
170
|
||||
171
|
||||
172
|
||||
173</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 150</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 166</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_serializable_hash'>serializable_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter_opts'>adapter_opts</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_adapter_opts'>adapter_opts</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
||||
<span class='id identifier rubyid_adapter_opts'>adapter_opts</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>include:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>*</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>adapter:</span> <span class='symbol'>:attributes</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter_opts'>adapter_opts</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_adapter'>adapter</span> <span class='op'>=</span> <span class='const'>ActiveModelSerializers</span><span class='op'>::</span><span class='const'>Adapter</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_adapter_opts'>adapter_opts</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_adapter'>adapter</span><span class='period'>.</span><span class='id identifier rubyid_serializable_hash'>serializable_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter_opts'>adapter_opts</span><span class='rparen'>)</span>
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_serializable_hash'>serializable_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter_options'>adapter_options</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_adapter_instance'>adapter_instance</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_serialization_adapter_instance'>serialization_adapter_instance</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_adapter_options'>adapter_options</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
||||
<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include_directive</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='const'>ActiveModel</span><span class='op'>::</span><span class='const'>Serializer</span><span class='period'>.</span><span class='id identifier rubyid_include_directive_from_options'>include_directive_from_options</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter_options'>adapter_options</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_cached_attributes'>cached_attributes</span> <span class='op'>=</span> <span class='id identifier rubyid_adapter_options'>adapter_options</span><span class='lbracket'>[</span><span class='symbol'>:cached_attributes</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
||||
<span class='id identifier rubyid_resource'>resource</span> <span class='op'>=</span> <span class='id identifier rubyid_fetch_attributes'>fetch_attributes</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:fields</span><span class='rbracket'>]</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='id identifier rubyid_relationships'>relationships</span> <span class='op'>=</span> <span class='id identifier rubyid_resource_relationships'>resource_relationships</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter_options'>adapter_options</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='comma'>,</span> <span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_relationships'>relationships</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
@ -1401,12 +1735,12 @@ ActiveRecord::Base.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
116
|
||||
117
|
||||
118</pre>
|
||||
134
|
||||
135
|
||||
136</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 116</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer.rb', line 134</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_success?'>success?</span>
|
||||
<span class='kw'>true</span>
|
||||
@ -1421,9 +1755,9 @@ ActiveRecord::Base.</p>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:37 2016 by
|
||||
Generated on Mon Jun 13 21:53:38 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -84,7 +84,7 @@
|
||||
|
||||
<dt class="r2 last">Defined in:</dt>
|
||||
<dd class="r2 last">lib/active_model/serializer/adapter.rb<span class="defines">,<br />
|
||||
lib/active_model/serializer/adapter/null.rb,<br /> lib/active_model/serializer/adapter/json.rb,<br /> lib/active_model/serializer/adapter/base.rb,<br /> lib/active_model/serializer/adapter/json_api.rb,<br /> lib/active_model/serializer/adapter/attributes.rb</span>
|
||||
lib/active_model/serializer/adapter/json.rb,<br /> lib/active_model/serializer/adapter/null.rb,<br /> lib/active_model/serializer/adapter/base.rb,<br /> lib/active_model/serializer/adapter/json_api.rb,<br /> lib/active_model/serializer/adapter/attributes.rb</span>
|
||||
</dd>
|
||||
|
||||
</dl>
|
||||
@ -147,9 +147,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:35 2016 by
|
||||
Generated on Mon Jun 13 21:53:36 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -188,7 +188,7 @@
|
||||
|
||||
|
||||
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html" title="ActiveModelSerializers::Adapter::Base (class)">ActiveModelSerializers::Adapter::Base</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#as_json-instance_method" title="ActiveModelSerializers::Adapter::Base#as_json (method)">#as_json</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#cache_check-instance_method" title="ActiveModelSerializers::Adapter::Base#cache_check (method)">#cache_check</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#cached_name-instance_method" title="ActiveModelSerializers::Adapter::Base#cached_name (method)">#cached_name</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#default_key_transform-class_method" title="ActiveModelSerializers::Adapter::Base.default_key_transform (method)">default_key_transform</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#fragment_cache-instance_method" title="ActiveModelSerializers::Adapter::Base#fragment_cache (method)">#fragment_cache</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#inherited-class_method" title="ActiveModelSerializers::Adapter::Base.inherited (method)">inherited</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#serializable_hash-instance_method" title="ActiveModelSerializers::Adapter::Base#serializable_hash (method)">#serializable_hash</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#transform-class_method" title="ActiveModelSerializers::Adapter::Base.transform (method)">transform</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#transform_key_casing%21-class_method" title="ActiveModelSerializers::Adapter::Base.transform_key_casing! (method)">transform_key_casing!</a></span></p>
|
||||
<p class="inherited"><span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#as_json-instance_method" title="ActiveModelSerializers::Adapter::Base#as_json (method)">#as_json</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#cache_key-class_method" title="ActiveModelSerializers::Adapter::Base.cache_key (method)">cache_key</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#cache_key-instance_method" title="ActiveModelSerializers::Adapter::Base#cache_key (method)">#cache_key</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#default_key_transform-class_method" title="ActiveModelSerializers::Adapter::Base.default_key_transform (method)">default_key_transform</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#fragment_cache-instance_method" title="ActiveModelSerializers::Adapter::Base#fragment_cache (method)">#fragment_cache</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#fragment_cache-class_method" title="ActiveModelSerializers::Adapter::Base.fragment_cache (method)">fragment_cache</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#inherited-class_method" title="ActiveModelSerializers::Adapter::Base.inherited (method)">inherited</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#serializable_hash-instance_method" title="ActiveModelSerializers::Adapter::Base#serializable_hash (method)">#serializable_hash</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#transform-class_method" title="ActiveModelSerializers::Adapter::Base.transform (method)">transform</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#transform_key_casing%21-class_method" title="ActiveModelSerializers::Adapter::Base.transform_key_casing! (method)">transform_key_casing!</a></span></p>
|
||||
<div id="constructor_details" class="method_details_list">
|
||||
<h2>Constructor Details</h2>
|
||||
|
||||
@ -239,9 +239,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:40 2016 by
|
||||
Generated on Mon Jun 13 21:53:40 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -145,7 +145,7 @@
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>A new instance of Base.</p>
|
||||
<p>:nocov:.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
@ -175,7 +175,7 @@
|
||||
|
||||
|
||||
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html" title="ActiveModelSerializers::Adapter::Base (class)">ActiveModelSerializers::Adapter::Base</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#as_json-instance_method" title="ActiveModelSerializers::Adapter::Base#as_json (method)">#as_json</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#cache_check-instance_method" title="ActiveModelSerializers::Adapter::Base#cache_check (method)">#cache_check</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#cached_name-instance_method" title="ActiveModelSerializers::Adapter::Base#cached_name (method)">#cached_name</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#default_key_transform-class_method" title="ActiveModelSerializers::Adapter::Base.default_key_transform (method)">default_key_transform</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#fragment_cache-instance_method" title="ActiveModelSerializers::Adapter::Base#fragment_cache (method)">#fragment_cache</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#inherited-class_method" title="ActiveModelSerializers::Adapter::Base.inherited (method)">inherited</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#serializable_hash-instance_method" title="ActiveModelSerializers::Adapter::Base#serializable_hash (method)">#serializable_hash</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#transform-class_method" title="ActiveModelSerializers::Adapter::Base.transform (method)">transform</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#transform_key_casing%21-class_method" title="ActiveModelSerializers::Adapter::Base.transform_key_casing! (method)">transform_key_casing!</a></span></p>
|
||||
<p class="inherited"><span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#as_json-instance_method" title="ActiveModelSerializers::Adapter::Base#as_json (method)">#as_json</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#cache_key-class_method" title="ActiveModelSerializers::Adapter::Base.cache_key (method)">cache_key</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#cache_key-instance_method" title="ActiveModelSerializers::Adapter::Base#cache_key (method)">#cache_key</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#default_key_transform-class_method" title="ActiveModelSerializers::Adapter::Base.default_key_transform (method)">default_key_transform</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#fragment_cache-instance_method" title="ActiveModelSerializers::Adapter::Base#fragment_cache (method)">#fragment_cache</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#fragment_cache-class_method" title="ActiveModelSerializers::Adapter::Base.fragment_cache (method)">fragment_cache</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#inherited-class_method" title="ActiveModelSerializers::Adapter::Base.inherited (method)">inherited</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#serializable_hash-instance_method" title="ActiveModelSerializers::Adapter::Base#serializable_hash (method)">#serializable_hash</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#transform-class_method" title="ActiveModelSerializers::Adapter::Base.transform (method)">transform</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#transform_key_casing%21-class_method" title="ActiveModelSerializers::Adapter::Base.transform_key_casing! (method)">transform_key_casing!</a></span></p>
|
||||
<div id="constructor_details" class="method_details_list">
|
||||
<h2>Constructor Details</h2>
|
||||
|
||||
@ -191,7 +191,7 @@
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Returns a new instance of Base</p>
|
||||
<p>:nocov:</p>
|
||||
|
||||
|
||||
</div>
|
||||
@ -205,12 +205,12 @@
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
10
|
||||
11
|
||||
12</pre>
|
||||
12
|
||||
13</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/adapter/base.rb', line 10</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/adapter/base.rb', line 11</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_serializer'>serializer</span><span class='comma'>,</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'>super</span><span class='lparen'>(</span><span class='const'>ActiveModelSerializers</span><span class='op'>::</span><span class='const'>Adapter</span><span class='op'>::</span><span class='const'>Base</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_serializer'>serializer</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
||||
@ -226,9 +226,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:39 2016 by
|
||||
Generated on Mon Jun 13 21:53:39 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -1,540 +0,0 @@
|
||||
<!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>
|
||||
Class: ActiveModel::Serializer::Adapter::CachedSerializer
|
||||
|
||||
— 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/Adapter/CachedSerializer.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> »
|
||||
<span class='title'><span class='object_link'><a href="../../../ActiveModel.html" title="ActiveModel (module)">ActiveModel</a></span></span> » <span class='title'><span class='object_link'><a href="../../Serializer.html" title="ActiveModel::Serializer (class)">Serializer</a></span></span> » <span class='title'><span class='object_link'><a href="../Adapter.html" title="ActiveModel::Serializer::Adapter (module)">Adapter</a></span></span>
|
||||
»
|
||||
<span class="title">CachedSerializer</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>Class: ActiveModel::Serializer::Adapter::CachedSerializer
|
||||
|
||||
|
||||
|
||||
</h1>
|
||||
|
||||
<dl class="box">
|
||||
|
||||
<dt class="r1">Inherits:</dt>
|
||||
<dd class="r1">
|
||||
<span class="inheritName">Object</span>
|
||||
|
||||
<ul class="fullTree">
|
||||
<li>Object</li>
|
||||
|
||||
<li class="next">ActiveModel::Serializer::Adapter::CachedSerializer</li>
|
||||
|
||||
</ul>
|
||||
<a href="#" class="inheritanceTree">show all</a>
|
||||
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="r2 last">Defined in:</dt>
|
||||
<dd class="r2 last">lib/active_model/serializer/adapter/cached_serializer.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_check-instance_method" title="#cache_check (instance method)">- (Object) <strong>cache_check</strong>(adapter_instance) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#cache_key-instance_method" title="#cache_key (instance method)">- (Object) <strong>cache_key</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#cached%3F-instance_method" title="#cached? (instance method)">- (Boolean) <strong>cached?</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#fragment_cached%3F-instance_method" title="#fragment_cached? (instance method)">- (Boolean) <strong>fragment_cached?</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#initialize-instance_method" title="#initialize (instance method)">- (CachedSerializer) <strong>initialize</strong>(serializer) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
<span class="note title constructor">constructor</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>A new instance of CachedSerializer.</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'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<div id="constructor_details" class="method_details_list">
|
||||
<h2>Constructor Details</h2>
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="initialize-instance_method">
|
||||
|
||||
- (<tt><span class='object_link'><a href="" title="ActiveModel::Serializer::Adapter::CachedSerializer (class)">CachedSerializer</a></span></tt>) <strong>initialize</strong>(serializer)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Returns a new instance of CachedSerializer</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
5
|
||||
6
|
||||
7
|
||||
8</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/adapter/cached_serializer.rb', line 5</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_serializer'>serializer</span><span class='rparen'>)</span>
|
||||
<span class='ivar'>@cached_serializer</span> <span class='op'>=</span> <span class='id identifier rubyid_serializer'>serializer</span>
|
||||
<span class='ivar'>@klass</span> <span class='op'>=</span> <span class='ivar'>@cached_serializer</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 id="instance_method_details" class="method_details_list">
|
||||
<h2>Instance Method Details</h2>
|
||||
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="cache_check-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>cache_check</strong>(adapter_instance)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
10
|
||||
11
|
||||
12
|
||||
13
|
||||
14
|
||||
15
|
||||
16
|
||||
17
|
||||
18
|
||||
19
|
||||
20</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/adapter/cached_serializer.rb', line 10</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_cache_check'>cache_check</span><span class='lparen'>(</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_cached?'>cached?</span>
|
||||
<span class='ivar'>@klass</span><span class='period'>.</span><span class='id identifier rubyid__cache'>_cache</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='comma'>,</span> <span class='ivar'>@klass</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='kw'>yield</span>
|
||||
<span class='kw'>end</span>
|
||||
<span class='kw'>elsif</span> <span class='id identifier rubyid_fragment_cached?'>fragment_cached?</span>
|
||||
<span class='const'>FragmentCache</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='comma'>,</span> <span class='ivar'>@cached_serializer</span><span class='comma'>,</span> <span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='period'>.</span><span class='id identifier rubyid_instance_options'>instance_options</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</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="cache_key-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>cache_key</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
30
|
||||
31
|
||||
32
|
||||
33
|
||||
34
|
||||
35</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/adapter/cached_serializer.rb', line 30</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_cache_key'>cache_key</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'><<</span> <span class='id identifier rubyid_object_cache_key'>object_cache_key</span>
|
||||
<span class='id identifier rubyid_parts'>parts</span> <span class='op'><<</span> <span class='ivar'>@klass</span><span class='period'>.</span><span class='id identifier rubyid__cache_digest'>_cache_digest</span> <span class='kw'>unless</span> <span class='ivar'>@klass</span><span class='period'>.</span><span class='id identifier rubyid__cache_options'>_cache_options</span> <span class='op'>&&</span> <span class='ivar'>@klass</span><span class='period'>.</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='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'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="cached?-instance_method">
|
||||
|
||||
- (<tt>Boolean</tt>) <strong>cached?</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">
|
||||
|
||||
|
||||
22
|
||||
23
|
||||
24</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/adapter/cached_serializer.rb', line 22</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_cached?'>cached?</span>
|
||||
<span class='ivar'>@klass</span><span class='period'>.</span><span class='id identifier rubyid__cache'>_cache</span> <span class='op'>&&</span> <span class='op'>!</span><span class='ivar'>@klass</span><span class='period'>.</span><span class='id identifier rubyid__cache_only'>_cache_only</span> <span class='op'>&&</span> <span class='op'>!</span><span class='ivar'>@klass</span><span class='period'>.</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="fragment_cached?-instance_method">
|
||||
|
||||
- (<tt>Boolean</tt>) <strong>fragment_cached?</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">
|
||||
|
||||
|
||||
26
|
||||
27
|
||||
28</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/adapter/cached_serializer.rb', line 26</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_fragment_cached?'>fragment_cached?</span>
|
||||
<span class='ivar'>@klass</span><span class='period'>.</span><span class='id identifier rubyid__cache_only'>_cache_only</span> <span class='op'>&&</span> <span class='op'>!</span><span class='ivar'>@klass</span><span class='period'>.</span><span class='id identifier rubyid__cache_except'>_cache_except</span> <span class='op'>||</span> <span class='op'>!</span><span class='ivar'>@klass</span><span class='period'>.</span><span class='id identifier rubyid__cache_only'>_cache_only</span> <span class='op'>&&</span> <span class='ivar'>@klass</span><span class='period'>.</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="object_cache_key-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>object_cache_key</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
37
|
||||
38
|
||||
39
|
||||
40
|
||||
41</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/adapter/cached_serializer.rb', line 37</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_object_cache_key'>object_cache_key</span>
|
||||
<span class='id identifier rubyid_object_time_safe'>object_time_safe</span> <span class='op'>=</span> <span class='ivar'>@cached_serializer</span><span class='period'>.</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'>'</span><span class='tstring_content'>%Y%m%d%H%M%S%9N</span><span class='tstring_end'>'</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='lparen'>(</span><span class='ivar'>@klass</span><span class='period'>.</span><span class='id identifier rubyid__cache_key'>_cache_key</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='ivar'>@klass</span><span class='period'>.</span><span class='id identifier rubyid__cache_key'>_cache_key</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@cached_serializer</span><span class='period'>.</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'>"</span></span> <span class='op'>:</span> <span class='ivar'>@cached_serializer</span><span class='period'>.</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'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Thu Oct 1 16:00:44 2015 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -1,378 +0,0 @@
|
||||
<!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>
|
||||
Class: ActiveModel::Serializer::Adapter::FragmentCache
|
||||
|
||||
— 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/Adapter/FragmentCache.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 (F)</a> »
|
||||
<span class='title'><span class='object_link'><a href="../../../ActiveModel.html" title="ActiveModel (module)">ActiveModel</a></span></span> » <span class='title'><span class='object_link'><a href="../../Serializer.html" title="ActiveModel::Serializer (class)">Serializer</a></span></span> » <span class='title'><span class='object_link'><a href="../Adapter.html" title="ActiveModel::Serializer::Adapter (module)">Adapter</a></span></span>
|
||||
»
|
||||
<span class="title">FragmentCache</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>Class: ActiveModel::Serializer::Adapter::FragmentCache
|
||||
|
||||
|
||||
|
||||
</h1>
|
||||
|
||||
<dl class="box">
|
||||
|
||||
<dt class="r1">Inherits:</dt>
|
||||
<dd class="r1">
|
||||
<span class="inheritName">Object</span>
|
||||
|
||||
<ul class="fullTree">
|
||||
<li>Object</li>
|
||||
|
||||
<li class="next">ActiveModel::Serializer::Adapter::FragmentCache</li>
|
||||
|
||||
</ul>
|
||||
<a href="#" class="inheritanceTree">show all</a>
|
||||
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="r2 last">Defined in:</dt>
|
||||
<dd class="r2 last">lib/active_model/serializer/adapter/fragment_cache.rb</dd>
|
||||
|
||||
</dl>
|
||||
<div class="clear"></div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
||||
<ul class="summary">
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#serializer-instance_method" title="#serializer (instance method)">- (Object) <strong>serializer</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="note title readonly">readonly</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Returns the value of attribute serializer.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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="#fetch-instance_method" title="#fetch (instance method)">- (Object) <strong>fetch</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#initialize-instance_method" title="#initialize (instance method)">- (FragmentCache) <strong>initialize</strong>(adapter, serializer, options) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
<span class="note title constructor">constructor</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>A new instance of FragmentCache.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<div id="constructor_details" class="method_details_list">
|
||||
<h2>Constructor Details</h2>
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="initialize-instance_method">
|
||||
|
||||
- (<tt><span class='object_link'><a href="" title="ActiveModel::Serializer::Adapter::FragmentCache (class)">FragmentCache</a></span></tt>) <strong>initialize</strong>(adapter, serializer, options)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Returns a new instance of FragmentCache</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
7
|
||||
8
|
||||
9
|
||||
10
|
||||
11</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/adapter/fragment_cache.rb', line 7</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter'>adapter</span><span class='comma'>,</span> <span class='id identifier rubyid_serializer'>serializer</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
<span class='ivar'>@instance_options</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span>
|
||||
<span class='ivar'>@adapter</span> <span class='op'>=</span> <span class='id identifier rubyid_adapter'>adapter</span>
|
||||
<span class='ivar'>@serializer</span> <span class='op'>=</span> <span class='id identifier rubyid_serializer'>serializer</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="instance_attr_details" class="attr_details">
|
||||
<h2>Instance Attribute Details</h2>
|
||||
|
||||
|
||||
<span id=""></span>
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="serializer-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>serializer</strong> <span class="extras">(readonly)</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Returns the value of attribute serializer</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
5
|
||||
6
|
||||
7</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/adapter/fragment_cache.rb', line 5</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_serializer'>serializer</span>
|
||||
<span class='ivar'>@serializer</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="instance_method_details" class="method_details_list">
|
||||
<h2>Instance Method Details</h2>
|
||||
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="fetch-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>fetch</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
13
|
||||
14
|
||||
15
|
||||
16
|
||||
17
|
||||
18
|
||||
19
|
||||
20
|
||||
21
|
||||
22
|
||||
23
|
||||
24
|
||||
25
|
||||
26
|
||||
27
|
||||
28
|
||||
29
|
||||
30
|
||||
31</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/adapter/fragment_cache.rb', line 13</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_fetch'>fetch</span>
|
||||
<span class='id identifier rubyid_klass'>klass</span> <span class='op'>=</span> <span class='id identifier rubyid_serializer'>serializer</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span>
|
||||
<span class='comment'># It will split the serializer into two, one that will be cached and other wont
|
||||
</span> <span class='id identifier rubyid_serializers'>serializers</span> <span class='op'>=</span> <span class='id identifier rubyid_fragment_serializer'>fragment_serializer</span><span class='lparen'>(</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_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_klass'>klass</span><span class='rparen'>)</span>
|
||||
|
||||
<span class='comment'># Instanciate both serializers
|
||||
</span> <span class='id identifier rubyid_cached_serializer'>cached_serializer</span> <span class='op'>=</span> <span class='id identifier rubyid_serializers'>serializers</span><span class='lbracket'>[</span><span class='symbol'>:cached</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_constantize'>constantize</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_serializer'>serializer</span><span class='period'>.</span><span class='id identifier rubyid_object'>object</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_non_cached_serializer'>non_cached_serializer</span> <span class='op'>=</span> <span class='id identifier rubyid_serializers'>serializers</span><span class='lbracket'>[</span><span class='symbol'>:non_cached</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_constantize'>constantize</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_serializer'>serializer</span><span class='period'>.</span><span class='id identifier rubyid_object'>object</span><span class='rparen'>)</span>
|
||||
|
||||
<span class='id identifier rubyid_cached_adapter'>cached_adapter</span> <span class='op'>=</span> <span class='id identifier rubyid_adapter'>adapter</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_cached_serializer'>cached_serializer</span><span class='comma'>,</span> <span class='id identifier rubyid_instance_options'>instance_options</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_non_cached_adapter'>non_cached_adapter</span> <span class='op'>=</span> <span class='id identifier rubyid_adapter'>adapter</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_non_cached_serializer'>non_cached_serializer</span><span class='comma'>,</span> <span class='id identifier rubyid_instance_options'>instance_options</span><span class='rparen'>)</span>
|
||||
|
||||
<span class='comment'># Get serializable hash from both
|
||||
</span> <span class='id identifier rubyid_cached_hash'>cached_hash</span> <span class='op'>=</span> <span class='id identifier rubyid_cached_adapter'>cached_adapter</span><span class='period'>.</span><span class='id identifier rubyid_serializable_hash'>serializable_hash</span>
|
||||
<span class='id identifier rubyid_non_cached_hash'>non_cached_hash</span> <span class='op'>=</span> <span class='id identifier rubyid_non_cached_adapter'>non_cached_adapter</span><span class='period'>.</span><span class='id identifier rubyid_serializable_hash'>serializable_hash</span>
|
||||
|
||||
<span class='comment'># Merge both results
|
||||
</span> <span class='id identifier rubyid_adapter'>adapter</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>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Thu Oct 1 16:00:44 2015 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -177,7 +177,7 @@
|
||||
|
||||
|
||||
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Json.html" title="ActiveModelSerializers::Adapter::Json (class)">ActiveModelSerializers::Adapter::Json</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Json.html#serializable_hash-instance_method" title="ActiveModelSerializers::Adapter::Json#serializable_hash (method)">#serializable_hash</a></span></p>
|
||||
<p class="inherited"><span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Json.html#meta-instance_method" title="ActiveModelSerializers::Adapter::Json#meta (method)">#meta</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Json.html#meta_key-instance_method" title="ActiveModelSerializers::Adapter::Json#meta_key (method)">#meta_key</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Json.html#serializable_hash-instance_method" title="ActiveModelSerializers::Adapter::Json#serializable_hash (method)">#serializable_hash</a></span></p>
|
||||
|
||||
|
||||
|
||||
@ -188,7 +188,7 @@
|
||||
|
||||
|
||||
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html" title="ActiveModelSerializers::Adapter::Base (class)">ActiveModelSerializers::Adapter::Base</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#as_json-instance_method" title="ActiveModelSerializers::Adapter::Base#as_json (method)">#as_json</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#cache_check-instance_method" title="ActiveModelSerializers::Adapter::Base#cache_check (method)">#cache_check</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#cached_name-instance_method" title="ActiveModelSerializers::Adapter::Base#cached_name (method)">#cached_name</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#default_key_transform-class_method" title="ActiveModelSerializers::Adapter::Base.default_key_transform (method)">default_key_transform</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#fragment_cache-instance_method" title="ActiveModelSerializers::Adapter::Base#fragment_cache (method)">#fragment_cache</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#inherited-class_method" title="ActiveModelSerializers::Adapter::Base.inherited (method)">inherited</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#serializable_hash-instance_method" title="ActiveModelSerializers::Adapter::Base#serializable_hash (method)">#serializable_hash</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#transform-class_method" title="ActiveModelSerializers::Adapter::Base.transform (method)">transform</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#transform_key_casing%21-class_method" title="ActiveModelSerializers::Adapter::Base.transform_key_casing! (method)">transform_key_casing!</a></span></p>
|
||||
<p class="inherited"><span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#as_json-instance_method" title="ActiveModelSerializers::Adapter::Base#as_json (method)">#as_json</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#cache_key-class_method" title="ActiveModelSerializers::Adapter::Base.cache_key (method)">cache_key</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#cache_key-instance_method" title="ActiveModelSerializers::Adapter::Base#cache_key (method)">#cache_key</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#default_key_transform-class_method" title="ActiveModelSerializers::Adapter::Base.default_key_transform (method)">default_key_transform</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#fragment_cache-instance_method" title="ActiveModelSerializers::Adapter::Base#fragment_cache (method)">#fragment_cache</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#fragment_cache-class_method" title="ActiveModelSerializers::Adapter::Base.fragment_cache (method)">fragment_cache</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#inherited-class_method" title="ActiveModelSerializers::Adapter::Base.inherited (method)">inherited</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#serializable_hash-instance_method" title="ActiveModelSerializers::Adapter::Base#serializable_hash (method)">#serializable_hash</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#transform-class_method" title="ActiveModelSerializers::Adapter::Base.transform (method)">transform</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#transform_key_casing%21-class_method" title="ActiveModelSerializers::Adapter::Base.transform_key_casing! (method)">transform_key_casing!</a></span></p>
|
||||
<div id="constructor_details" class="method_details_list">
|
||||
<h2>Constructor Details</h2>
|
||||
|
||||
@ -239,9 +239,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:39 2016 by
|
||||
Generated on Mon Jun 13 21:53:39 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -1,189 +0,0 @@
|
||||
<!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>
|
||||
Class: ActiveModel::Serializer::Adapter::Json::FragmentCache
|
||||
|
||||
— 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/Adapter/Json/FragmentCache.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 (F)</a> »
|
||||
<span class='title'><span class='object_link'><a href="../../../../ActiveModel.html" title="ActiveModel (module)">ActiveModel</a></span></span> » <span class='title'><span class='object_link'><a href="../../../Serializer.html" title="ActiveModel::Serializer (class)">Serializer</a></span></span> » <span class='title'><span class='object_link'><a href="../../Adapter.html" title="ActiveModel::Serializer::Adapter (module)">Adapter</a></span></span> » <span class='title'><span class='object_link'><a href="../Json.html" title="ActiveModel::Serializer::Adapter::Json (class)">Json</a></span></span>
|
||||
»
|
||||
<span class="title">FragmentCache</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>Class: ActiveModel::Serializer::Adapter::Json::FragmentCache
|
||||
|
||||
|
||||
|
||||
</h1>
|
||||
|
||||
<dl class="box">
|
||||
|
||||
<dt class="r1">Inherits:</dt>
|
||||
<dd class="r1">
|
||||
<span class="inheritName">Object</span>
|
||||
|
||||
<ul class="fullTree">
|
||||
<li>Object</li>
|
||||
|
||||
<li class="next">ActiveModel::Serializer::Adapter::Json::FragmentCache</li>
|
||||
|
||||
</ul>
|
||||
<a href="#" class="inheritanceTree">show all</a>
|
||||
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="r2 last">Defined in:</dt>
|
||||
<dd class="r2 last">lib/active_model/serializer/adapter/json/fragment_cache.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="#fragment_cache-instance_method" title="#fragment_cache (instance method)">- (Object) <strong>fragment_cache</strong>(cached_hash, non_cached_hash) </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="fragment_cache-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>fragment_cache</strong>(cached_hash, non_cached_hash)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
6
|
||||
7
|
||||
8</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/adapter/json/fragment_cache.rb', line 6</span>
|
||||
|
||||
<span class='kw'>def</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='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_cached_hash'>cached_hash</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Thu Oct 1 16:00:44 2015 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -177,7 +177,7 @@
|
||||
|
||||
|
||||
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/JsonApi.html" title="ActiveModelSerializers::Adapter::JsonApi (class)">ActiveModelSerializers::Adapter::JsonApi</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/JsonApi.html#default_key_transform-class_method" title="ActiveModelSerializers::Adapter::JsonApi.default_key_transform (method)">default_key_transform</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/JsonApi.html#failure_document-instance_method" title="ActiveModelSerializers::Adapter::JsonApi#failure_document (method)">#failure_document</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/JsonApi.html#fragment_cache-instance_method" title="ActiveModelSerializers::Adapter::JsonApi#fragment_cache (method)">#fragment_cache</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/JsonApi.html#serializable_hash-instance_method" title="ActiveModelSerializers::Adapter::JsonApi#serializable_hash (method)">#serializable_hash</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/JsonApi.html#success_document-instance_method" title="ActiveModelSerializers::Adapter::JsonApi#success_document (method)">#success_document</a></span></p>
|
||||
<p class="inherited"><span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/JsonApi.html#default_key_transform-class_method" title="ActiveModelSerializers::Adapter::JsonApi.default_key_transform (method)">default_key_transform</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/JsonApi.html#failure_document-instance_method" title="ActiveModelSerializers::Adapter::JsonApi#failure_document (method)">#failure_document</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/JsonApi.html#fragment_cache-instance_method" title="ActiveModelSerializers::Adapter::JsonApi#fragment_cache (method)">#fragment_cache</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/JsonApi.html#fragment_cache-class_method" title="ActiveModelSerializers::Adapter::JsonApi.fragment_cache (method)">fragment_cache</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/JsonApi.html#serializable_hash-instance_method" title="ActiveModelSerializers::Adapter::JsonApi#serializable_hash (method)">#serializable_hash</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/JsonApi.html#success_document-instance_method" title="ActiveModelSerializers::Adapter::JsonApi#success_document (method)">#success_document</a></span></p>
|
||||
|
||||
|
||||
|
||||
@ -189,7 +189,7 @@
|
||||
|
||||
|
||||
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html" title="ActiveModelSerializers::Adapter::Base (class)">ActiveModelSerializers::Adapter::Base</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#as_json-instance_method" title="ActiveModelSerializers::Adapter::Base#as_json (method)">#as_json</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#cache_check-instance_method" title="ActiveModelSerializers::Adapter::Base#cache_check (method)">#cache_check</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#cached_name-instance_method" title="ActiveModelSerializers::Adapter::Base#cached_name (method)">#cached_name</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#default_key_transform-class_method" title="ActiveModelSerializers::Adapter::Base.default_key_transform (method)">default_key_transform</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#fragment_cache-instance_method" title="ActiveModelSerializers::Adapter::Base#fragment_cache (method)">#fragment_cache</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#inherited-class_method" title="ActiveModelSerializers::Adapter::Base.inherited (method)">inherited</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#serializable_hash-instance_method" title="ActiveModelSerializers::Adapter::Base#serializable_hash (method)">#serializable_hash</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#transform-class_method" title="ActiveModelSerializers::Adapter::Base.transform (method)">transform</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#transform_key_casing%21-class_method" title="ActiveModelSerializers::Adapter::Base.transform_key_casing! (method)">transform_key_casing!</a></span></p>
|
||||
<p class="inherited"><span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#as_json-instance_method" title="ActiveModelSerializers::Adapter::Base#as_json (method)">#as_json</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#cache_key-class_method" title="ActiveModelSerializers::Adapter::Base.cache_key (method)">cache_key</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#cache_key-instance_method" title="ActiveModelSerializers::Adapter::Base#cache_key (method)">#cache_key</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#default_key_transform-class_method" title="ActiveModelSerializers::Adapter::Base.default_key_transform (method)">default_key_transform</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#fragment_cache-instance_method" title="ActiveModelSerializers::Adapter::Base#fragment_cache (method)">#fragment_cache</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#fragment_cache-class_method" title="ActiveModelSerializers::Adapter::Base.fragment_cache (method)">fragment_cache</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#inherited-class_method" title="ActiveModelSerializers::Adapter::Base.inherited (method)">inherited</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#serializable_hash-instance_method" title="ActiveModelSerializers::Adapter::Base#serializable_hash (method)">#serializable_hash</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#transform-class_method" title="ActiveModelSerializers::Adapter::Base.transform (method)">transform</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#transform_key_casing%21-class_method" title="ActiveModelSerializers::Adapter::Base.transform_key_casing! (method)">transform_key_casing!</a></span></p>
|
||||
<div id="constructor_details" class="method_details_list">
|
||||
<h2>Constructor Details</h2>
|
||||
|
||||
@ -240,9 +240,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:39 2016 by
|
||||
Generated on Mon Jun 13 21:53:39 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -1,127 +0,0 @@
|
||||
<!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::Adapter::JsonApi::ApiObjects
|
||||
|
||||
— 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/Adapter/JsonApi/ApiObjects.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 (A)</a> »
|
||||
<span class='title'><span class='object_link'><a href="../../../../ActiveModel.html" title="ActiveModel (module)">ActiveModel</a></span></span> » <span class='title'><span class='object_link'><a href="../../../Serializer.html" title="ActiveModel::Serializer (class)">Serializer</a></span></span> » <span class='title'><span class='object_link'><a href="../../Adapter.html" title="ActiveModel::Serializer::Adapter (module)">Adapter</a></span></span> » <span class='title'><span class='object_link'><a href="../JsonApi.html" title="ActiveModel::Serializer::Adapter::JsonApi (class)">JsonApi</a></span></span>
|
||||
»
|
||||
<span class="title">ApiObjects</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::Adapter::JsonApi::ApiObjects
|
||||
|
||||
|
||||
|
||||
</h1>
|
||||
|
||||
<dl class="box">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="r1 last">Defined in:</dt>
|
||||
<dd class="r1 last">lib/active_model/serializer/adapter/json_api.rb</dd>
|
||||
|
||||
</dl>
|
||||
<div class="clear"></div>
|
||||
|
||||
<h2>Overview</h2><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>TODO: if we like this abstraction and other API objects to it, then extract
|
||||
to its own file and require it.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><h2>Defined Under Namespace</h2>
|
||||
<p class="children">
|
||||
|
||||
|
||||
<strong class="modules">Modules:</strong> <span class='object_link'><a href="ApiObjects/JsonApi.html" title="ActiveModel::Serializer::Adapter::JsonApi::ApiObjects::JsonApi (module)">JsonApi</a></span>
|
||||
|
||||
|
||||
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Thu Oct 1 16:00:43 2015 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -1,329 +0,0 @@
|
||||
<!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::Adapter::JsonApi::ApiObjects::JsonApi
|
||||
|
||||
— 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/Adapter/JsonApi/ApiObjects/JsonApi.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 (J)</a> »
|
||||
<span class='title'><span class='object_link'><a href="../../../../../ActiveModel.html" title="ActiveModel (module)">ActiveModel</a></span></span> » <span class='title'><span class='object_link'><a href="../../../../Serializer.html" title="ActiveModel::Serializer (class)">Serializer</a></span></span> » <span class='title'><span class='object_link'><a href="../../../Adapter.html" title="ActiveModel::Serializer::Adapter (module)">Adapter</a></span></span> » <span class='title'><span class='object_link'><a href="../../JsonApi.html" title="ActiveModel::Serializer::Adapter::JsonApi (class)">JsonApi</a></span></span> » <span class='title'><span class='object_link'><a href="../ApiObjects.html" title="ActiveModel::Serializer::Adapter::JsonApi::ApiObjects (module)">ApiObjects</a></span></span>
|
||||
»
|
||||
<span class="title">JsonApi</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::Adapter::JsonApi::ApiObjects::JsonApi
|
||||
|
||||
|
||||
|
||||
</h1>
|
||||
|
||||
<dl class="box">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="r1 last">Defined in:</dt>
|
||||
<dd class="r1 last">lib/active_model/serializer/adapter/json_api.rb</dd>
|
||||
|
||||
</dl>
|
||||
<div class="clear"></div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2>
|
||||
Class Method Summary
|
||||
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
||||
</h2>
|
||||
|
||||
<ul class="summary">
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#add%21-class_method" title="add! (class method)">+ (Object) <strong>add!</strong>(hash) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#include_object%3F-class_method" title="include_object? (class method)">+ (Boolean) <strong>include_object?</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#object-class_method" title="object (class method)">+ (Object) <strong>object</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>TODO: see if we can cache this.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
<div id="class_method_details" class="method_details_list">
|
||||
<h2>Class Method Details</h2>
|
||||
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="add!-class_method">
|
||||
|
||||
+ (<tt>Object</tt>) <strong>add!</strong>(hash)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
20
|
||||
21
|
||||
22</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/adapter/json_api.rb', line 20</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_add!'>add!</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</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='lparen'>(</span><span class='id identifier rubyid_object'>object</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_include_object?'>include_object?</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="include_object?-class_method">
|
||||
|
||||
+ (<tt>Boolean</tt>) <strong>include_object?</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">
|
||||
|
||||
|
||||
24
|
||||
25
|
||||
26</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/adapter/json_api.rb', line 24</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_include_object?'>include_object?</span>
|
||||
<span class='const'>ActiveModel</span><span class='op'>::</span><span class='const'>Serializer</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_jsonapi_include_toplevel_object'>jsonapi_include_toplevel_object</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="object-class_method">
|
||||
|
||||
+ (<tt>Object</tt>) <strong>object</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>TODO: see if we can cache this</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
29
|
||||
30
|
||||
31
|
||||
32
|
||||
33
|
||||
34
|
||||
35
|
||||
36
|
||||
37
|
||||
38
|
||||
39</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/adapter/json_api.rb', line 29</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_object'>object</span>
|
||||
<span class='id identifier rubyid_object'>object</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
||||
<span class='label'>jsonapi:</span> <span class='lbrace'>{</span>
|
||||
<span class='label'>version:</span> <span class='const'>ActiveModel</span><span class='op'>::</span><span class='const'>Serializer</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_jsonapi_version'>jsonapi_version</span><span class='comma'>,</span>
|
||||
<span class='label'>meta:</span> <span class='const'>ActiveModel</span><span class='op'>::</span><span class='const'>Serializer</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_jsonapi_toplevel_meta'>jsonapi_toplevel_meta</span>
|
||||
<span class='rbrace'>}</span>
|
||||
<span class='rbrace'>}</span>
|
||||
<span class='id identifier rubyid_object'>object</span><span class='lbracket'>[</span><span class='symbol'>:jsonapi</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_reject!'>reject!</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid__'>_</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='op'>|</span> <span class='id identifier rubyid_v'>v</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span> <span class='rbrace'>}</span>
|
||||
|
||||
<span class='id identifier rubyid_object'>object</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Thu Oct 1 16:00:43 2015 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -1,205 +0,0 @@
|
||||
<!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>
|
||||
Class: ActiveModel::Serializer::Adapter::JsonApi::FragmentCache
|
||||
|
||||
— 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/Adapter/JsonApi/FragmentCache.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 (F)</a> »
|
||||
<span class='title'><span class='object_link'><a href="../../../../ActiveModel.html" title="ActiveModel (module)">ActiveModel</a></span></span> » <span class='title'><span class='object_link'><a href="../../../Serializer.html" title="ActiveModel::Serializer (class)">Serializer</a></span></span> » <span class='title'><span class='object_link'><a href="../../Adapter.html" title="ActiveModel::Serializer::Adapter (module)">Adapter</a></span></span> » <span class='title'><span class='object_link'><a href="../JsonApi.html" title="ActiveModel::Serializer::Adapter::JsonApi (class)">JsonApi</a></span></span>
|
||||
»
|
||||
<span class="title">FragmentCache</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>Class: ActiveModel::Serializer::Adapter::JsonApi::FragmentCache
|
||||
|
||||
|
||||
|
||||
</h1>
|
||||
|
||||
<dl class="box">
|
||||
|
||||
<dt class="r1">Inherits:</dt>
|
||||
<dd class="r1">
|
||||
<span class="inheritName">Object</span>
|
||||
|
||||
<ul class="fullTree">
|
||||
<li>Object</li>
|
||||
|
||||
<li class="next">ActiveModel::Serializer::Adapter::JsonApi::FragmentCache</li>
|
||||
|
||||
</ul>
|
||||
<a href="#" class="inheritanceTree">show all</a>
|
||||
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="r2 last">Defined in:</dt>
|
||||
<dd class="r2 last">lib/active_model/serializer/adapter/json_api/fragment_cache.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="#fragment_cache-instance_method" title="#fragment_cache (instance method)">- (Object) <strong>fragment_cache</strong>(root, cached_hash, non_cached_hash) </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="fragment_cache-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>fragment_cache</strong>(root, cached_hash, non_cached_hash)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
6
|
||||
7
|
||||
8
|
||||
9
|
||||
10
|
||||
11
|
||||
12
|
||||
13
|
||||
14
|
||||
15
|
||||
16</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/adapter/json_api/fragment_cache.rb', line 6</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_fragment_cache'>fragment_cache</span><span class='lparen'>(</span><span class='id identifier rubyid_root'>root</span><span class='comma'>,</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='id identifier rubyid_hash'>hash</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
||||
<span class='id identifier rubyid_core_cached'>core_cached</span> <span class='op'>=</span> <span class='id identifier rubyid_cached_hash'>cached_hash</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
|
||||
<span class='id identifier rubyid_core_non_cached'>core_non_cached</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_first'>first</span>
|
||||
<span class='id identifier rubyid_no_root_cache'>no_root_cache</span> <span class='op'>=</span> <span class='id identifier rubyid_cached_hash'>cached_hash</span><span class='period'>.</span><span class='id identifier rubyid_delete_if'>delete_if</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span> <span class='id identifier rubyid_key'>key</span> <span class='op'>==</span> <span class='id identifier rubyid_core_cached'>core_cached</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='rbrace'>}</span>
|
||||
<span class='id identifier rubyid_no_root_non_cache'>no_root_non_cache</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_delete_if'>delete_if</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span> <span class='id identifier rubyid_key'>key</span> <span class='op'>==</span> <span class='id identifier rubyid_core_non_cached'>core_non_cached</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='rbrace'>}</span>
|
||||
<span class='id identifier rubyid_cached_resource'>cached_resource</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_core_cached'>core_cached</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_core_cached'>core_cached</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_deep_merge'>deep_merge</span><span class='lparen'>(</span><span class='id identifier rubyid_core_non_cached'>core_non_cached</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id identifier rubyid_core_non_cached'>core_non_cached</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
|
||||
<span class='id identifier rubyid_hash'>hash</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_root'>root</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_root'>root</span> <span class='op'>=></span> <span class='id identifier rubyid_cached_resource'>cached_resource</span> <span class='rbrace'>}</span> <span class='op'>:</span> <span class='id identifier rubyid_cached_resource'>cached_resource</span>
|
||||
|
||||
<span class='id identifier rubyid_hash'>hash</span><span class='period'>.</span><span class='id identifier rubyid_deep_merge'>deep_merge</span> <span class='id identifier rubyid_no_root_non_cache'>no_root_non_cache</span><span class='period'>.</span><span class='id identifier rubyid_deep_merge'>deep_merge</span> <span class='id identifier rubyid_no_root_cache'>no_root_cache</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Thu Oct 1 16:00:44 2015 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -1,436 +0,0 @@
|
||||
<!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>
|
||||
Class: ActiveModel::Serializer::Adapter::JsonApi::PaginationLinks
|
||||
|
||||
— 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/Adapter/JsonApi/PaginationLinks.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 (P)</a> »
|
||||
<span class='title'><span class='object_link'><a href="../../../../ActiveModel.html" title="ActiveModel (module)">ActiveModel</a></span></span> » <span class='title'><span class='object_link'><a href="../../../Serializer.html" title="ActiveModel::Serializer (class)">Serializer</a></span></span> » <span class='title'><span class='object_link'><a href="../../Adapter.html" title="ActiveModel::Serializer::Adapter (module)">Adapter</a></span></span> » <span class='title'><span class='object_link'><a href="../JsonApi.html" title="ActiveModel::Serializer::Adapter::JsonApi (class)">JsonApi</a></span></span>
|
||||
»
|
||||
<span class="title">PaginationLinks</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>Class: ActiveModel::Serializer::Adapter::JsonApi::PaginationLinks
|
||||
|
||||
|
||||
|
||||
</h1>
|
||||
|
||||
<dl class="box">
|
||||
|
||||
<dt class="r1">Inherits:</dt>
|
||||
<dd class="r1">
|
||||
<span class="inheritName">Object</span>
|
||||
|
||||
<ul class="fullTree">
|
||||
<li>Object</li>
|
||||
|
||||
<li class="next">ActiveModel::Serializer::Adapter::JsonApi::PaginationLinks</li>
|
||||
|
||||
</ul>
|
||||
<a href="#" class="inheritanceTree">show all</a>
|
||||
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="r2 last">Defined in:</dt>
|
||||
<dd class="r2 last">lib/active_model/serializer/adapter/json_api/pagination_links.rb</dd>
|
||||
|
||||
</dl>
|
||||
<div class="clear"></div>
|
||||
|
||||
|
||||
<h2>Constant Summary</h2>
|
||||
|
||||
<dl class="constants">
|
||||
|
||||
<dt id="FIRST_PAGE-constant" class="">FIRST_PAGE =
|
||||
|
||||
</dt>
|
||||
<dd><pre class="code"><span class='int'>1</span></pre></dd>
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
||||
<ul class="summary">
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#collection-instance_method" title="#collection (instance method)">- (Object) <strong>collection</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="note title readonly">readonly</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Returns the value of attribute collection.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#context-instance_method" title="#context (instance method)">- (Object) <strong>context</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="note title readonly">readonly</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Returns the value of attribute context.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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="#initialize-instance_method" title="#initialize (instance method)">- (PaginationLinks) <strong>initialize</strong>(collection, context) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
<span class="note title constructor">constructor</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>A new instance of PaginationLinks.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#serializable_hash-instance_method" title="#serializable_hash (instance method)">- (Object) <strong>serializable_hash</strong>(options = {}) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<div id="constructor_details" class="method_details_list">
|
||||
<h2>Constructor Details</h2>
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="initialize-instance_method">
|
||||
|
||||
- (<tt><span class='object_link'><a href="" title="ActiveModel::Serializer::Adapter::JsonApi::PaginationLinks (class)">PaginationLinks</a></span></tt>) <strong>initialize</strong>(collection, context)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Returns a new instance of PaginationLinks</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
10
|
||||
11
|
||||
12
|
||||
13</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/adapter/json_api/pagination_links.rb', line 10</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_collection'>collection</span><span class='comma'>,</span> <span class='id identifier rubyid_context'>context</span><span class='rparen'>)</span>
|
||||
<span class='ivar'>@collection</span> <span class='op'>=</span> <span class='id identifier rubyid_collection'>collection</span>
|
||||
<span class='ivar'>@context</span> <span class='op'>=</span> <span class='id identifier rubyid_context'>context</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="instance_attr_details" class="attr_details">
|
||||
<h2>Instance Attribute Details</h2>
|
||||
|
||||
|
||||
<span id=""></span>
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="collection-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>collection</strong> <span class="extras">(readonly)</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Returns the value of attribute collection</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
8
|
||||
9
|
||||
10</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/adapter/json_api/pagination_links.rb', line 8</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_collection'>collection</span>
|
||||
<span class='ivar'>@collection</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
|
||||
<span id=""></span>
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="context-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>context</strong> <span class="extras">(readonly)</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Returns the value of attribute context</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
8
|
||||
9
|
||||
10</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/adapter/json_api/pagination_links.rb', line 8</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_context'>context</span>
|
||||
<span class='ivar'>@context</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="instance_method_details" class="method_details_list">
|
||||
<h2>Instance Method Details</h2>
|
||||
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="serializable_hash-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>serializable_hash</strong>(options = {})
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
15
|
||||
16
|
||||
17
|
||||
18
|
||||
19
|
||||
20
|
||||
21</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/adapter/json_api/pagination_links.rb', line 15</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_serializable_hash'>serializable_hash</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='id identifier rubyid_pages_from'>pages_from</span><span class='period'>.</span><span class='id identifier rubyid_each_with_object'>each_with_object</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_hash'>hash</span><span class='op'>|</span>
|
||||
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_query_parameters'>query_parameters</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='label'>page:</span> <span class='lbrace'>{</span> <span class='label'>number:</span> <span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='label'>size:</span> <span class='id identifier rubyid_collection'>collection</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='rbrace'>}</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_query'>to_query</span>
|
||||
|
||||
<span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_url'>url</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>?</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
||||
<span class='kw'>end</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Thu Oct 1 16:00:44 2015 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -188,7 +188,7 @@
|
||||
|
||||
|
||||
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html" title="ActiveModelSerializers::Adapter::Base (class)">ActiveModelSerializers::Adapter::Base</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#as_json-instance_method" title="ActiveModelSerializers::Adapter::Base#as_json (method)">#as_json</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#cache_check-instance_method" title="ActiveModelSerializers::Adapter::Base#cache_check (method)">#cache_check</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#cached_name-instance_method" title="ActiveModelSerializers::Adapter::Base#cached_name (method)">#cached_name</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#default_key_transform-class_method" title="ActiveModelSerializers::Adapter::Base.default_key_transform (method)">default_key_transform</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#fragment_cache-instance_method" title="ActiveModelSerializers::Adapter::Base#fragment_cache (method)">#fragment_cache</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#inherited-class_method" title="ActiveModelSerializers::Adapter::Base.inherited (method)">inherited</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#serializable_hash-instance_method" title="ActiveModelSerializers::Adapter::Base#serializable_hash (method)">#serializable_hash</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#transform-class_method" title="ActiveModelSerializers::Adapter::Base.transform (method)">transform</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#transform_key_casing%21-class_method" title="ActiveModelSerializers::Adapter::Base.transform_key_casing! (method)">transform_key_casing!</a></span></p>
|
||||
<p class="inherited"><span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#as_json-instance_method" title="ActiveModelSerializers::Adapter::Base#as_json (method)">#as_json</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#cache_key-class_method" title="ActiveModelSerializers::Adapter::Base.cache_key (method)">cache_key</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#cache_key-instance_method" title="ActiveModelSerializers::Adapter::Base#cache_key (method)">#cache_key</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#default_key_transform-class_method" title="ActiveModelSerializers::Adapter::Base.default_key_transform (method)">default_key_transform</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#fragment_cache-instance_method" title="ActiveModelSerializers::Adapter::Base#fragment_cache (method)">#fragment_cache</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#fragment_cache-class_method" title="ActiveModelSerializers::Adapter::Base.fragment_cache (method)">fragment_cache</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#inherited-class_method" title="ActiveModelSerializers::Adapter::Base.inherited (method)">inherited</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#serializable_hash-instance_method" title="ActiveModelSerializers::Adapter::Base#serializable_hash (method)">#serializable_hash</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#transform-class_method" title="ActiveModelSerializers::Adapter::Base.transform (method)">transform</a></span>, <span class='object_link'><a href="../../../ActiveModelSerializers/Adapter/Base.html#transform_key_casing%21-class_method" title="ActiveModelSerializers::Adapter::Base.transform_key_casing! (method)">transform_key_casing!</a></span></p>
|
||||
<div id="constructor_details" class="method_details_list">
|
||||
<h2>Constructor Details</h2>
|
||||
|
||||
@ -239,9 +239,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:39 2016 by
|
||||
Generated on Mon Jun 13 21:53:39 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -147,7 +147,7 @@
|
||||
|
||||
|
||||
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="CollectionSerializer.html" title="ActiveModel::Serializer::CollectionSerializer (class)">CollectionSerializer</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="CollectionSerializer.html#initialize-instance_method" title="ActiveModel::Serializer::CollectionSerializer#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="CollectionSerializer.html#json_key-instance_method" title="ActiveModel::Serializer::CollectionSerializer#json_key (method)">#json_key</a></span>, <span class='object_link'><a href="CollectionSerializer.html#paginated%3F-instance_method" title="ActiveModel::Serializer::CollectionSerializer#paginated? (method)">#paginated?</a></span>, <span class='object_link'><a href="CollectionSerializer.html#success%3F-instance_method" title="ActiveModel::Serializer::CollectionSerializer#success? (method)">#success?</a></span></p>
|
||||
<p class="inherited"><span class='object_link'><a href="CollectionSerializer.html#initialize-instance_method" title="ActiveModel::Serializer::CollectionSerializer#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="CollectionSerializer.html#json_key-instance_method" title="ActiveModel::Serializer::CollectionSerializer#json_key (method)">#json_key</a></span>, <span class='object_link'><a href="CollectionSerializer.html#paginated%3F-instance_method" title="ActiveModel::Serializer::CollectionSerializer#paginated? (method)">#paginated?</a></span>, <span class='object_link'><a href="CollectionSerializer.html#serializable_hash-instance_method" title="ActiveModel::Serializer::CollectionSerializer#serializable_hash (method)">#serializable_hash</a></span>, <span class='object_link'><a href="CollectionSerializer.html#success%3F-instance_method" title="ActiveModel::Serializer::CollectionSerializer#success? (method)">#success?</a></span></p>
|
||||
|
||||
<div id="constructor_details" class="method_details_list">
|
||||
<h2>Constructor Details</h2>
|
||||
@ -160,9 +160,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:40 2016 by
|
||||
Generated on Mon Jun 13 21:53:39 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -583,9 +583,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:39 2016 by
|
||||
Generated on Mon Jun 13 21:53:39 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -119,18 +119,6 @@ object.</p>
|
||||
|
||||
</p>
|
||||
|
||||
<h2>Constant Summary</h2>
|
||||
|
||||
<dl class="constants">
|
||||
|
||||
<dt id="DEFAULT_INCLUDE_TREE-constant" class="">DEFAULT_INCLUDE_TREE =
|
||||
|
||||
</dt>
|
||||
<dd><pre class="code"><span class='const'>ActiveModel</span><span class='op'>::</span><span class='const'>Serializer</span><span class='op'>::</span><span class='const'>IncludeTree</span><span class='period'>.</span><span class='id identifier rubyid_from_string'>from_string</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>*</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span></pre></dd>
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -148,7 +136,7 @@ object.</p>
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#associations-instance_method" title="#associations (instance method)">- (Enumerator<Association>) <strong>associations</strong>(include_tree = DEFAULT_INCLUDE_TREE) </a>
|
||||
<a href="#associations-instance_method" title="#associations (instance method)">- (Enumerator<Association>) <strong>associations</strong>(include_directive = ActiveModelSerializers.default_include_directive) </a>
|
||||
|
||||
|
||||
|
||||
@ -180,7 +168,7 @@ object.</p>
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="associations-instance_method">
|
||||
|
||||
- (<tt>Enumerator<<span class='object_link'><a href="Association.html" title="ActiveModel::Serializer::Association (class)">Association</a></span>></tt>) <strong>associations</strong>(include_tree = DEFAULT_INCLUDE_TREE)
|
||||
- (<tt>Enumerator<<span class='object_link'><a href="Association.html" title="ActiveModel::Serializer::Association (class)">Association</a></span>></tt>) <strong>associations</strong>(include_directive = ActiveModelSerializers.default_include_directive)
|
||||
|
||||
|
||||
|
||||
@ -198,18 +186,19 @@ object.</p>
|
||||
|
||||
<li>
|
||||
|
||||
<span class='name'>include_tree</span>
|
||||
<span class='name'>include_directive</span>
|
||||
|
||||
|
||||
<span class='type'>(<tt><span class='object_link'><a href="IncludeTree.html" title="ActiveModel::Serializer::IncludeTree (class)">IncludeTree</a></span></tt>)</span>
|
||||
<span class='type'>(<tt>JSONAPI::IncludeDirective</tt>)</span>
|
||||
|
||||
|
||||
<em class="default">(defaults to: <tt>DEFAULT_INCLUDE_TREE</tt>)</em>
|
||||
<em class="default">(defaults to: <tt>ActiveModelSerializers.default_include_directive</tt>)</em>
|
||||
|
||||
|
||||
—
|
||||
<div class='inline'>
|
||||
<p>(defaults to all associations when not provided)</p>
|
||||
<p>(defaults to the <code>default_include_directive</code> config value when
|
||||
not provided)</p>
|
||||
</div>
|
||||
|
||||
</li>
|
||||
@ -236,6 +225,7 @@ object.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
85
|
||||
86
|
||||
87
|
||||
88
|
||||
@ -246,20 +236,19 @@ object.</p>
|
||||
93
|
||||
94
|
||||
95
|
||||
96
|
||||
97</pre>
|
||||
96</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/associations.rb', line 86</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/associations.rb', line 85</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_associations'>associations</span><span class='lparen'>(</span><span class='id identifier rubyid_include_tree'>include_tree</span> <span class='op'>=</span> <span class='const'>DEFAULT_INCLUDE_TREE</span><span class='rparen'>)</span>
|
||||
<span class='kw'>def</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='op'>=</span> <span class='const'>ActiveModelSerializers</span><span class='period'>.</span><span class='id identifier rubyid_default_include_directive'>default_include_directive</span><span class='rparen'>)</span>
|
||||
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_object'>object</span>
|
||||
|
||||
<span class='const'>Enumerator</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_y'>y</span><span class='op'>|</span>
|
||||
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid__reflections'>_reflections</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_reflection'>reflection</span><span class='op'>|</span>
|
||||
<span class='kw'>next</span> <span class='kw'>if</span> <span class='id identifier rubyid_reflection'>reflection</span><span class='period'>.</span><span class='id identifier rubyid_excluded?'>excluded?</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_key'>key</span> <span class='op'>=</span> <span class='id identifier rubyid_reflection'>reflection</span><span class='period'>.</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:key</span><span class='comma'>,</span> <span class='id identifier rubyid_reflection'>reflection</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
|
||||
<span class='kw'>next</span> <span class='kw'>unless</span> <span class='id identifier rubyid_include_tree'>include_tree</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
|
||||
<span class='kw'>next</span> <span class='kw'>unless</span> <span class='id identifier rubyid_include_directive'>include_directive</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_y'>y</span><span class='period'>.</span><span class='id identifier rubyid_yield'>yield</span> <span class='id identifier rubyid_reflection'>reflection</span><span class='period'>.</span><span class='id identifier rubyid_build_association'>build_association</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_instance_options'>instance_options</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span>
|
||||
<span class='kw'>end</span>
|
||||
@ -274,9 +263,9 @@ object.</p>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:36 2016 by
|
||||
Generated on Mon Jun 13 21:53:37 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -266,12 +266,12 @@
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
55
|
||||
56
|
||||
57</pre>
|
||||
53
|
||||
54
|
||||
55</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/associations.rb', line 55</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/associations.rb', line 53</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_belongs_to'>belongs_to</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_associate'>associate</span><span class='lparen'>(</span><span class='const'>BelongsToReflection</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='comma'>,</span> <span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
||||
@ -351,12 +351,12 @@
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
44
|
||||
45
|
||||
46</pre>
|
||||
42
|
||||
43
|
||||
44</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/associations.rb', line 44</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/associations.rb', line 42</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_has_many'>has_many</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_associate'>associate</span><span class='lparen'>(</span><span class='const'>HasManyReflection</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='comma'>,</span> <span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
||||
@ -436,12 +436,12 @@
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
66
|
||||
67
|
||||
68</pre>
|
||||
64
|
||||
65
|
||||
66</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/associations.rb', line 66</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/associations.rb', line 64</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_has_one'>has_one</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_associate'>associate</span><span class='lparen'>(</span><span class='const'>HasOneReflection</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='comma'>,</span> <span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
||||
@ -466,13 +466,13 @@
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
30
|
||||
31
|
||||
32
|
||||
33
|
||||
34
|
||||
35</pre>
|
||||
33</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/associations.rb', line 32</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/associations.rb', line 30</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>
|
||||
@ -488,9 +488,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:37 2016 by
|
||||
Generated on Mon Jun 13 21:53:37 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -158,9 +158,9 @@ ActiveModel::Serializer class.</p>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:38 2016 by
|
||||
Generated on Mon Jun 13 21:53:38 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -115,9 +115,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:36 2016 by
|
||||
Generated on Mon Jun 13 21:53:36 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -488,9 +488,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:36 2016 by
|
||||
Generated on Mon Jun 13 21:53:36 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -133,40 +133,6 @@
|
||||
|
||||
|
||||
|
||||
<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="#macro-instance_method" title="#macro (instance method)">- (Object) <strong>macro</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="private note title">private</span>
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -179,6 +145,7 @@
|
||||
|
||||
|
||||
|
||||
<h2>Method Summary</h2>
|
||||
|
||||
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Reflection.html" title="ActiveModel::Serializer::Reflection (class)">Reflection</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="Reflection.html#build_association-instance_method" title="ActiveModel::Serializer::Reflection#build_association (method)">#build_association</a></span>, <span class='object_link'><a href="Reflection.html#include_data-instance_method" title="ActiveModel::Serializer::Reflection#include_data (method)">#include_data</a></span>, <span class='object_link'><a href="Reflection.html#initialize-instance_method" title="ActiveModel::Serializer::Reflection#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Reflection.html#link-instance_method" title="ActiveModel::Serializer::Reflection#link (method)">#link</a></span>, <span class='object_link'><a href="Reflection.html#meta-instance_method" title="ActiveModel::Serializer::Reflection#meta (method)">#meta</a></span>, <span class='object_link'><a href="Reflection.html#value-instance_method" title="ActiveModel::Serializer::Reflection#value (method)">#value</a></span></p>
|
||||
@ -197,61 +164,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<div id="instance_method_details" class="method_details_list">
|
||||
<h2>Instance Method Details</h2>
|
||||
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="macro-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>macro</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
<p class="note private">
|
||||
<strong>This method is part of a private API.</strong>
|
||||
You should avoid using this method if possible, as it may be removed or be changed in the future.
|
||||
</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
5
|
||||
6
|
||||
7</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/belongs_to_reflection.rb', line 5</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_macro'>macro</span>
|
||||
<span class='symbol'>:belongs_to</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:40 2016 by
|
||||
Generated on Mon Jun 13 21:53:40 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -147,14 +147,491 @@
|
||||
|
||||
|
||||
|
||||
<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'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'><<</span> <span class='id identifier rubyid_object_cache_key'>object_cache_key</span>
|
||||
<span class='id identifier rubyid_parts'>parts</span> <span class='op'><<</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'><<</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'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</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'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'>'</span><span class='tstring_content'>%Y%m%d%H%M%S%9N</span><span class='tstring_end'>'</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'>"</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'>"</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'>"</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 'key:' option must be passed into '</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'</span><span class='tstring_end'>"</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 Tue Apr 5 11:04:35 2016 by
|
||||
Generated on Mon Jun 13 21:53:36 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -102,6 +102,28 @@
|
||||
<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>
|
||||
|
||||
|
||||
@ -164,6 +186,30 @@
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
@ -240,7 +286,7 @@
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#fragmented-instance_method" title="#fragmented (instance method)">- (Object) <strong>fragmented</strong>(serializer) </a>
|
||||
<a href="#fragmented_attributes-instance_method" title="#fragmented_attributes (instance method)">- (Object) <strong>fragmented_attributes</strong> </a>
|
||||
|
||||
|
||||
|
||||
@ -251,13 +297,10 @@
|
||||
|
||||
|
||||
|
||||
<span class="private note title">private</span>
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Used by FragmentCache on the CachedSerializer to call attribute methods on
|
||||
the fragmented cached serializer.</p>
|
||||
</div></span>
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
@ -281,6 +324,54 @@ the fragmented cached serializer.</p>
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
@ -320,7 +411,39 @@ the fragmented cached serializer.</p>
|
||||
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="_skip_digest?-instance_method">
|
||||
<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>
|
||||
|
||||
@ -356,12 +479,12 @@ the fragmented cached serializer.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
61
|
||||
62
|
||||
63</pre>
|
||||
67
|
||||
68
|
||||
69</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/caching.rb', line 61</span>
|
||||
<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'>&&</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>
|
||||
@ -451,19 +574,19 @@ else : @see ::_cache_options</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
95
|
||||
96
|
||||
97
|
||||
98
|
||||
99
|
||||
100
|
||||
101
|
||||
102
|
||||
103
|
||||
104</pre>
|
||||
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 95</span>
|
||||
<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>
|
||||
@ -517,12 +640,12 @@ else : @see ::_cache_options</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
140
|
||||
141
|
||||
142</pre>
|
||||
150
|
||||
151
|
||||
152</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/caching.rb', line 140</span>
|
||||
<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'>&&</span> <span class='id identifier rubyid_cache_store'>cache_store</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id identifier rubyid__cache_only'>_cache_only</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id identifier rubyid__cache_except'>_cache_except</span>
|
||||
@ -530,6 +653,72 @@ else : @see ::_cache_options</p>
|
||||
</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 ">
|
||||
@ -624,18 +813,18 @@ is nil.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
130
|
||||
131
|
||||
132
|
||||
133
|
||||
134
|
||||
135
|
||||
136
|
||||
137
|
||||
138</pre>
|
||||
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 130</span>
|
||||
<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>
|
||||
@ -677,21 +866,21 @@ is nil.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
48
|
||||
49
|
||||
50
|
||||
51
|
||||
52
|
||||
53
|
||||
54
|
||||
55
|
||||
56
|
||||
57
|
||||
58
|
||||
59</pre>
|
||||
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 48</span>
|
||||
<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>
|
||||
@ -747,13 +936,13 @@ is nil.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
144
|
||||
145
|
||||
146
|
||||
147</pre>
|
||||
154
|
||||
155
|
||||
156
|
||||
157</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/caching.rb', line 144</span>
|
||||
<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'>&&</span> <span class='id identifier rubyid_cache_store'>cache_store</span> <span class='op'>&&</span>
|
||||
@ -765,46 +954,43 @@ is nil.</p>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="fragmented-instance_method">
|
||||
<h3 class="signature " id="fragmented_attributes-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>fragmented</strong>(serializer)
|
||||
- (<tt>Object</tt>) <strong>fragmented_attributes</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
<p class="note private">
|
||||
<strong>This method is part of a private API.</strong>
|
||||
You should avoid using this method if possible, as it may be removed or be changed in the future.
|
||||
</p>
|
||||
|
||||
<p>Used by FragmentCache on the CachedSerializer</p>
|
||||
|
||||
<pre class="code ruby"><code class="ruby">to call attribute methods on the fragmented cached serializer.</code></pre>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
</h3><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
68
|
||||
69
|
||||
70</pre>
|
||||
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 68</span>
|
||||
<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'>fragmented</span><span class='lparen'>(</span><span class='id identifier rubyid_serializer'>serializer</span><span class='rparen'>)</span>
|
||||
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid__fragmented'>_fragmented</span> <span class='op'>=</span> <span class='id identifier rubyid_serializer'>serializer</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>
|
||||
@ -826,19 +1012,210 @@ is nil.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
41
|
||||
42
|
||||
43
|
||||
44
|
||||
45</pre>
|
||||
45
|
||||
46</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/caching.rb', line 41</span>
|
||||
<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'>_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_caller_line'>caller_line</span><span class='rparen'>)</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>
|
||||
|
||||
|
||||
|
||||
—
|
||||
<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'>&&</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>
|
||||
|
||||
|
||||
|
||||
—
|
||||
<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'><<</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'><<</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'><<</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>
|
||||
@ -892,13 +1269,13 @@ called with a non-nil value. rubocop:disable Style/ClassVars</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
113
|
||||
114
|
||||
115
|
||||
116</pre>
|
||||
123
|
||||
124
|
||||
125
|
||||
126</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/caching.rb', line 113</span>
|
||||
<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'>&&</span> <span class='op'>!</span><span class='cvar'>@@perform_caching</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
||||
@ -914,9 +1291,9 @@ called with a non-nil value. rubocop:disable Style/ClassVars</p>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:36 2016 by
|
||||
Generated on Mon Jun 13 21:53:36 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -163,9 +163,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:40 2016 by
|
||||
Generated on Mon Jun 13 21:53:40 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -268,6 +268,28 @@
|
||||
<p>rubocop:enable Metrics/CyclomaticComplexity.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#serializable_hash-instance_method" title="#serializable_hash (instance method)">- (Object) <strong>serializable_hash</strong>(adapter_options, options, adapter_instance) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="private note title">private</span>
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
@ -331,16 +353,7 @@
|
||||
12
|
||||
13
|
||||
14
|
||||
15
|
||||
16
|
||||
17
|
||||
18
|
||||
19
|
||||
20
|
||||
21
|
||||
22
|
||||
23
|
||||
24</pre>
|
||||
15</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/collection_serializer.rb', line 10</span>
|
||||
@ -349,16 +362,7 @@
|
||||
<span class='ivar'>@object</span> <span class='op'>=</span> <span class='id identifier rubyid_resources'>resources</span>
|
||||
<span class='ivar'>@options</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span>
|
||||
<span class='ivar'>@root</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:root</span><span class='rbracket'>]</span>
|
||||
<span class='id identifier rubyid_serializer_context_class'>serializer_context_class</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:serializer_context_class</span><span class='comma'>,</span> <span class='const'>ActiveModel</span><span class='op'>::</span><span class='const'>Serializer</span><span class='rparen'>)</span>
|
||||
<span class='ivar'>@serializers</span> <span class='op'>=</span> <span class='id identifier rubyid_resources'>resources</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_resource'>resource</span><span class='op'>|</span>
|
||||
<span class='id identifier rubyid_serializer_class'>serializer_class</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:serializer</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_serializer_context_class'>serializer_context_class</span><span class='period'>.</span><span class='id identifier rubyid_serializer_for'>serializer_for</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='rparen'>)</span> <span class='rbrace'>}</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_nil?'>nil?</span> <span class='comment'># rubocop:disable Style/GuardClause
|
||||
</span> <span class='id identifier rubyid_fail'>fail</span> <span class='const'>NoSerializerError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>No serializer found for resource: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
||||
<span class='kw'>else</span>
|
||||
<span class='id identifier rubyid_serializer_class'>serializer_class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_except'>except</span><span class='lparen'>(</span><span class='symbol'>:serializer</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span>
|
||||
<span class='kw'>end</span>
|
||||
<span class='ivar'>@serializers</span> <span class='op'>=</span> <span class='id identifier rubyid_serializers_from_resources'>serializers_from_resources</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
@ -496,7 +500,6 @@ the logic right here.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
38
|
||||
39
|
||||
40
|
||||
41
|
||||
@ -508,10 +511,11 @@ the logic right here.</p>
|
||||
47
|
||||
48
|
||||
49
|
||||
50</pre>
|
||||
50
|
||||
51</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/collection_serializer.rb', line 38</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/collection_serializer.rb', line 39</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_json_key'>json_key</span>
|
||||
<span class='kw'>return</span> <span class='id identifier rubyid_root'>root</span> <span class='kw'>if</span> <span class='id identifier rubyid_root'>root</span>
|
||||
@ -570,14 +574,14 @@ the logic right here.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
53
|
||||
54
|
||||
55
|
||||
56
|
||||
57</pre>
|
||||
57
|
||||
58</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/collection_serializer.rb', line 53</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/collection_serializer.rb', line 54</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_paginated?'>paginated?</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'>:current_page</span><span class='rparen'>)</span> <span class='op'>&&</span>
|
||||
@ -587,6 +591,59 @@ the logic right here.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="serializable_hash-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>serializable_hash</strong>(adapter_options, options, adapter_instance)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
<p class="note private">
|
||||
<strong>This method is part of a private API.</strong>
|
||||
You should avoid using this method if possible, as it may be removed or be changed in the future.
|
||||
</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
22
|
||||
23
|
||||
24
|
||||
25
|
||||
26
|
||||
27
|
||||
28
|
||||
29</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/collection_serializer.rb', line 22</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_serializable_hash'>serializable_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter_options'>adapter_options</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='comma'>,</span> <span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_include_directive'>include_directive</span> <span class='op'>=</span> <span class='const'>ActiveModel</span><span class='op'>::</span><span class='const'>Serializer</span><span class='period'>.</span><span class='id identifier rubyid_include_directive_from_options'>include_directive_from_options</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter_options'>adapter_options</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_adapter_options'>adapter_options</span><span class='lbracket'>[</span><span class='symbol'>:cached_attributes</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='const'>ActiveModel</span><span class='op'>::</span><span class='const'>Serializer</span><span class='period'>.</span><span class='id identifier rubyid_cache_read_multi'>cache_read_multi</span><span class='lparen'>(</span><span class='kw'>self</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_adapter_opts'>adapter_opts</span> <span class='op'>=</span> <span class='id identifier rubyid_adapter_options'>adapter_options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='label'>include_directive:</span> <span class='id identifier rubyid_include_directive'>include_directive</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_serializers'>serializers</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</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_serializer'>serializer</span><span class='period'>.</span><span class='id identifier rubyid_serializable_hash'>serializable_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter_opts'>adapter_opts</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</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></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
@ -626,12 +683,12 @@ the logic right here.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
26
|
||||
27
|
||||
28</pre>
|
||||
17
|
||||
18
|
||||
19</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/collection_serializer.rb', line 26</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/collection_serializer.rb', line 17</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_success?'>success?</span>
|
||||
<span class='kw'>true</span>
|
||||
@ -646,9 +703,9 @@ the logic right here.</p>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:41 2016 by
|
||||
Generated on Mon Jun 13 21:53:40 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -110,9 +110,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:37 2016 by
|
||||
Generated on Mon Jun 13 21:53:37 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -111,7 +111,7 @@
|
||||
|
||||
<h3 class="inherited">Constants inherited
|
||||
from <span class='object_link'><a href="../Serializer.html" title="ActiveModel::Serializer (class)">ActiveModel::Serializer</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="../Serializer.html#VERSION-constant" title="ActiveModel::Serializer::VERSION (constant)">VERSION</a></span></p>
|
||||
<p class="inherited"><span class='object_link'><a href="../Serializer.html#SERIALIZABLE_HASH_VALID_KEYS-constant" title="ActiveModel::Serializer::SERIALIZABLE_HASH_VALID_KEYS (constant)">SERIALIZABLE_HASH_VALID_KEYS</a></span>, <span class='object_link'><a href="../Serializer.html#UndefinedCacheKey-constant" title="ActiveModel::Serializer::UndefinedCacheKey (constant)">UndefinedCacheKey</a></span>, <span class='object_link'><a href="../Serializer.html#VERSION-constant" title="ActiveModel::Serializer::VERSION (constant)">VERSION</a></span></p>
|
||||
|
||||
|
||||
|
||||
@ -121,12 +121,6 @@
|
||||
|
||||
|
||||
|
||||
<h3 class="inherited">Constants included
|
||||
from <span class='object_link'><a href="Associations.html" title="ActiveModel::Serializer::Associations (module)">Associations</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="Associations.html#DEFAULT_INCLUDE_TREE-constant" title="ActiveModel::Serializer::Associations::DEFAULT_INCLUDE_TREE (constant)">Associations::DEFAULT_INCLUDE_TREE</a></span></p>
|
||||
|
||||
|
||||
|
||||
|
||||
<h2>Instance Attribute Summary</h2>
|
||||
|
||||
@ -199,7 +193,7 @@
|
||||
|
||||
|
||||
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Serializer.html" title="ActiveModel::Serializer (class)">ActiveModel::Serializer</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="../Serializer.html#adapter-class_method" title="ActiveModel::Serializer.adapter (method)">adapter</a></span>, <span class='object_link'><a href="../Serializer.html#get_serializer_for-class_method" title="ActiveModel::Serializer.get_serializer_for (method)">get_serializer_for</a></span>, <span class='object_link'><a href="../Serializer.html#initialize-instance_method" title="ActiveModel::Serializer#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Serializer.html#json_key-instance_method" title="ActiveModel::Serializer#json_key (method)">#json_key</a></span>, <span class='object_link'><a href="../Serializer.html#read_attribute_for_serialization-instance_method" title="ActiveModel::Serializer#read_attribute_for_serialization (method)">#read_attribute_for_serialization</a></span>, <span class='object_link'><a href="../Serializer.html#serializable_hash-instance_method" title="ActiveModel::Serializer#serializable_hash (method)">#serializable_hash</a></span>, <span class='object_link'><a href="../Serializer.html#serializer_for-class_method" title="ActiveModel::Serializer.serializer_for (method)">serializer_for</a></span>, <span class='object_link'><a href="../Serializer.html#serializer_lookup_chain_for-class_method" title="ActiveModel::Serializer.serializer_lookup_chain_for (method)">serializer_lookup_chain_for</a></span>, <span class='object_link'><a href="../Serializer.html#serializers_cache-class_method" title="ActiveModel::Serializer.serializers_cache (method)">serializers_cache</a></span></p>
|
||||
<p class="inherited"><span class='object_link'><a href="../Serializer.html#adapter-class_method" title="ActiveModel::Serializer.adapter (method)">adapter</a></span>, <span class='object_link'><a href="../Serializer.html#get_serializer_for-class_method" title="ActiveModel::Serializer.get_serializer_for (method)">get_serializer_for</a></span>, <span class='object_link'><a href="../Serializer.html#include_directive_from_options-class_method" title="ActiveModel::Serializer.include_directive_from_options (method)">include_directive_from_options</a></span>, <span class='object_link'><a href="../Serializer.html#initialize-instance_method" title="ActiveModel::Serializer#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Serializer.html#json_key-instance_method" title="ActiveModel::Serializer#json_key (method)">#json_key</a></span>, <span class='object_link'><a href="../Serializer.html#read_attribute_for_serialization-instance_method" title="ActiveModel::Serializer#read_attribute_for_serialization (method)">#read_attribute_for_serialization</a></span>, <span class='object_link'><a href="../Serializer.html#relationship_value_for-instance_method" title="ActiveModel::Serializer#relationship_value_for (method)">#relationship_value_for</a></span>, <span class='object_link'><a href="../Serializer.html#resource_relationships-instance_method" title="ActiveModel::Serializer#resource_relationships (method)">#resource_relationships</a></span>, <span class='object_link'><a href="../Serializer.html#serializable_hash-instance_method" title="ActiveModel::Serializer#serializable_hash (method)">#serializable_hash</a></span>, <span class='object_link'><a href="../Serializer.html#serialization_adapter_instance-class_method" title="ActiveModel::Serializer.serialization_adapter_instance (method)">serialization_adapter_instance</a></span>, <span class='object_link'><a href="../Serializer.html#serializer_for-class_method" title="ActiveModel::Serializer.serializer_for (method)">serializer_for</a></span>, <span class='object_link'><a href="../Serializer.html#serializer_lookup_chain_for-class_method" title="ActiveModel::Serializer.serializer_lookup_chain_for (method)">serializer_lookup_chain_for</a></span>, <span class='object_link'><a href="../Serializer.html#serializers_cache-class_method" title="ActiveModel::Serializer.serializers_cache (method)">serializers_cache</a></span></p>
|
||||
|
||||
|
||||
|
||||
@ -239,6 +233,11 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 class="inherited">Methods included from <span class='object_link'><a href="Caching.html" title="ActiveModel::Serializer::Caching (module)">Caching</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="Caching.html#cache_key-instance_method" title="ActiveModel::Serializer::Caching#cache_key (method)">#cache_key</a></span>, <span class='object_link'><a href="Caching.html#fetch-instance_method" title="ActiveModel::Serializer::Caching#fetch (method)">#fetch</a></span>, <span class='object_link'><a href="Caching.html#fetch_attributes-instance_method" title="ActiveModel::Serializer::Caching#fetch_attributes (method)">#fetch_attributes</a></span>, <span class='object_link'><a href="Caching.html#fetch_attributes_fragment-instance_method" title="ActiveModel::Serializer::Caching#fetch_attributes_fragment (method)">#fetch_attributes_fragment</a></span>, <span class='object_link'><a href="Caching.html#object_cache_key-instance_method" title="ActiveModel::Serializer::Caching#object_cache_key (method)">#object_cache_key</a></span>, <span class='object_link'><a href="Caching.html#serializer_class-instance_method" title="ActiveModel::Serializer::Caching#serializer_class (method)">#serializer_class</a></span></p>
|
||||
|
||||
|
||||
|
||||
@ -388,9 +387,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:40 2016 by
|
||||
Generated on Mon Jun 13 21:53:39 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -494,9 +494,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:40 2016 by
|
||||
Generated on Mon Jun 13 21:53:39 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -405,9 +405,9 @@ block is evaluated in the context of the serializer.</p>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:38 2016 by
|
||||
Generated on Mon Jun 13 21:53:38 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -303,9 +303,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:38 2016 by
|
||||
Generated on Mon Jun 13 21:53:38 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -133,40 +133,6 @@
|
||||
|
||||
|
||||
|
||||
<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="#macro-instance_method" title="#macro (instance method)">- (Object) <strong>macro</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="private note title">private</span>
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -179,6 +145,7 @@
|
||||
|
||||
|
||||
|
||||
<h2>Method Summary</h2>
|
||||
|
||||
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Reflection.html" title="ActiveModel::Serializer::Reflection (class)">Reflection</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="Reflection.html#build_association-instance_method" title="ActiveModel::Serializer::Reflection#build_association (method)">#build_association</a></span>, <span class='object_link'><a href="Reflection.html#include_data-instance_method" title="ActiveModel::Serializer::Reflection#include_data (method)">#include_data</a></span>, <span class='object_link'><a href="Reflection.html#initialize-instance_method" title="ActiveModel::Serializer::Reflection#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Reflection.html#link-instance_method" title="ActiveModel::Serializer::Reflection#link (method)">#link</a></span>, <span class='object_link'><a href="Reflection.html#meta-instance_method" title="ActiveModel::Serializer::Reflection#meta (method)">#meta</a></span>, <span class='object_link'><a href="Reflection.html#value-instance_method" title="ActiveModel::Serializer::Reflection#value (method)">#value</a></span></p>
|
||||
@ -197,61 +164,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<div id="instance_method_details" class="method_details_list">
|
||||
<h2>Instance Method Details</h2>
|
||||
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="macro-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>macro</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
<p class="note private">
|
||||
<strong>This method is part of a private API.</strong>
|
||||
You should avoid using this method if possible, as it may be removed or be changed in the future.
|
||||
</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
5
|
||||
6
|
||||
7</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/has_many_reflection.rb', line 5</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_macro'>macro</span>
|
||||
<span class='symbol'>:has_many</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:40 2016 by
|
||||
Generated on Mon Jun 13 21:53:40 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -133,40 +133,6 @@
|
||||
|
||||
|
||||
|
||||
<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="#macro-instance_method" title="#macro (instance method)">- (Object) <strong>macro</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="private note title">private</span>
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -179,6 +145,7 @@
|
||||
|
||||
|
||||
|
||||
<h2>Method Summary</h2>
|
||||
|
||||
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Reflection.html" title="ActiveModel::Serializer::Reflection (class)">Reflection</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="Reflection.html#build_association-instance_method" title="ActiveModel::Serializer::Reflection#build_association (method)">#build_association</a></span>, <span class='object_link'><a href="Reflection.html#include_data-instance_method" title="ActiveModel::Serializer::Reflection#include_data (method)">#include_data</a></span>, <span class='object_link'><a href="Reflection.html#initialize-instance_method" title="ActiveModel::Serializer::Reflection#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Reflection.html#link-instance_method" title="ActiveModel::Serializer::Reflection#link (method)">#link</a></span>, <span class='object_link'><a href="Reflection.html#meta-instance_method" title="ActiveModel::Serializer::Reflection#meta (method)">#meta</a></span>, <span class='object_link'><a href="Reflection.html#value-instance_method" title="ActiveModel::Serializer::Reflection#value (method)">#value</a></span></p>
|
||||
@ -197,61 +164,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<div id="instance_method_details" class="method_details_list">
|
||||
<h2>Instance Method Details</h2>
|
||||
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="macro-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>macro</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
<p class="note private">
|
||||
<strong>This method is part of a private API.</strong>
|
||||
You should avoid using this method if possible, as it may be removed or be changed in the future.
|
||||
</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
5
|
||||
6
|
||||
7</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/has_one_reflection.rb', line 5</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_macro'>macro</span>
|
||||
<span class='symbol'>:has_one</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:40 2016 by
|
||||
Generated on Mon Jun 13 21:53:39 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -1,625 +0,0 @@
|
||||
<!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>
|
||||
Class: ActiveModel::Serializer::IncludeTree
|
||||
|
||||
— 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/IncludeTree.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 (I)</a> »
|
||||
<span class='title'><span class='object_link'><a href="../../ActiveModel.html" title="ActiveModel (module)">ActiveModel</a></span></span> » <span class='title'><span class='object_link'><a href="../Serializer.html" title="ActiveModel::Serializer (class)">Serializer</a></span></span>
|
||||
»
|
||||
<span class="title">IncludeTree</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>Class: ActiveModel::Serializer::IncludeTree
|
||||
|
||||
|
||||
|
||||
</h1>
|
||||
|
||||
<dl class="box">
|
||||
|
||||
<dt class="r1">Inherits:</dt>
|
||||
<dd class="r1">
|
||||
<span class="inheritName">Object</span>
|
||||
|
||||
<ul class="fullTree">
|
||||
<li>Object</li>
|
||||
|
||||
<li class="next">ActiveModel::Serializer::IncludeTree</li>
|
||||
|
||||
</ul>
|
||||
<a href="#" class="inheritanceTree">show all</a>
|
||||
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="r2 last">Defined in:</dt>
|
||||
<dd class="r2 last">lib/active_model/serializer/include_tree.rb</dd>
|
||||
|
||||
</dl>
|
||||
<div class="clear"></div>
|
||||
|
||||
<h2>Overview</h2><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>TODO: description of this class, and overview of how it's used</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><h2>Defined Under Namespace</h2>
|
||||
<p class="children">
|
||||
|
||||
|
||||
<strong class="modules">Modules:</strong> <span class='object_link'><a href="IncludeTree/Parsing.html" title="ActiveModel::Serializer::IncludeTree::Parsing (module)">Parsing</a></span>
|
||||
|
||||
|
||||
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2>
|
||||
Class Method Summary
|
||||
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
||||
</h2>
|
||||
|
||||
<ul class="summary">
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#from_include_args-class_method" title="from_include_args (class method)">+ (IncludeTree) <strong>from_include_args</strong>(included) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Translates the arguments passed to the include option into an IncludeTree.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#from_string-class_method" title="from_string (class method)">+ (IncludeTree) <strong>from_string</strong>(included) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Builds an IncludeTree from a comma separated list of dot separated paths
|
||||
(JSON API format).</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<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="#%5B%5D-instance_method" title="#[] (instance method)">- (Object) <strong>[]</strong>(key) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#initialize-instance_method" title="#initialize (instance method)">- (IncludeTree) <strong>initialize</strong>(hash = {}) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
<span class="note title constructor">constructor</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>A new instance of IncludeTree.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#key%3F-instance_method" title="#key? (instance method)">- (Boolean) <strong>key?</strong>(key) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<div id="constructor_details" class="method_details_list">
|
||||
<h2>Constructor Details</h2>
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="initialize-instance_method">
|
||||
|
||||
- (<tt><span class='object_link'><a href="" title="ActiveModel::Serializer::IncludeTree (class)">IncludeTree</a></span></tt>) <strong>initialize</strong>(hash = {})
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Returns a new instance of IncludeTree</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
<p class="tag_title">Parameters:</p>
|
||||
<ul class="param">
|
||||
|
||||
<li>
|
||||
|
||||
<span class='name'>hash</span>
|
||||
|
||||
|
||||
<span class='type'>(<tt>Hash</tt>)</span>
|
||||
|
||||
|
||||
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
88
|
||||
89
|
||||
90</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/include_tree.rb', line 88</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
||||
<span class='ivar'>@hash</span> <span class='op'>=</span> <span class='id identifier rubyid_hash'>hash</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="class_method_details" class="method_details_list">
|
||||
<h2>Class Method Details</h2>
|
||||
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="from_include_args-class_method">
|
||||
|
||||
+ (<tt><span class='object_link'><a href="" title="ActiveModel::Serializer::IncludeTree (class)">IncludeTree</a></span></tt>) <strong>from_include_args</strong>(included)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Translates the arguments passed to the include option into an IncludeTree.
|
||||
The format can be either a String (see #from_string), an Array of Symbols
|
||||
and Hashes, or a mix of both.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
<div class="examples">
|
||||
<p class="tag_title">Examples:</p>
|
||||
|
||||
|
||||
<p class="example_title"><div class='inline'>
|
||||
<p>`posts: [:author, comments: [:author, :upvotes]]`</p>
|
||||
</div></p>
|
||||
|
||||
<pre class="example code"><code></code></pre>
|
||||
|
||||
</div>
|
||||
<p class="tag_title">Parameters:</p>
|
||||
<ul class="param">
|
||||
|
||||
<li>
|
||||
|
||||
<span class='name'>included</span>
|
||||
|
||||
|
||||
<span class='type'>(<tt>Symbol</tt>, <tt>Hash</tt>, <tt>Array</tt>, <tt>String</tt>)</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
<p class="tag_title">Returns:</p>
|
||||
<ul class="return">
|
||||
|
||||
<li>
|
||||
|
||||
|
||||
<span class='type'>(<tt><span class='object_link'><a href="" title="ActiveModel::Serializer::IncludeTree (class)">IncludeTree</a></span></tt>)</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
81
|
||||
82
|
||||
83
|
||||
84
|
||||
85</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/include_tree.rb', line 81</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_from_include_args'>from_include_args</span><span class='lparen'>(</span><span class='id identifier rubyid_included'>included</span><span class='rparen'>)</span>
|
||||
<span class='kw'>return</span> <span class='id identifier rubyid_included'>included</span> <span class='kw'>if</span> <span class='id identifier rubyid_included'>included</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>IncludeTree</span><span class='rparen'>)</span>
|
||||
|
||||
<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>Parsing</span><span class='period'>.</span><span class='id identifier rubyid_include_args_to_hash'>include_args_to_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_included'>included</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="from_string-class_method">
|
||||
|
||||
+ (<tt><span class='object_link'><a href="" title="ActiveModel::Serializer::IncludeTree (class)">IncludeTree</a></span></tt>) <strong>from_string</strong>(included)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Builds an IncludeTree from a comma separated list of dot separated paths
|
||||
(JSON API format).</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
<div class="examples">
|
||||
<p class="tag_title">Examples:</p>
|
||||
|
||||
|
||||
<p class="example_title"><div class='inline'>
|
||||
<p>`'posts.author, posts.comments.upvotes, posts.comments.author'`</p>
|
||||
</div></p>
|
||||
|
||||
<pre class="example code"><code></code></pre>
|
||||
|
||||
</div>
|
||||
<p class="tag_title">Parameters:</p>
|
||||
<ul class="param">
|
||||
|
||||
<li>
|
||||
|
||||
<span class='name'>included</span>
|
||||
|
||||
|
||||
<span class='type'>(<tt>String</tt>)</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
<p class="tag_title">Returns:</p>
|
||||
<ul class="return">
|
||||
|
||||
<li>
|
||||
|
||||
|
||||
<span class='type'>(<tt><span class='object_link'><a href="" title="ActiveModel::Serializer::IncludeTree (class)">IncludeTree</a></span></tt>)</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
70
|
||||
71
|
||||
72</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/include_tree.rb', line 70</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_from_string'>from_string</span><span class='lparen'>(</span><span class='id identifier rubyid_included'>included</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>Parsing</span><span class='period'>.</span><span class='id identifier rubyid_include_string_to_hash'>include_string_to_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_included'>included</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="instance_method_details" class="method_details_list">
|
||||
<h2>Instance Method Details</h2>
|
||||
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="[]-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>[]</strong>(key)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
96
|
||||
97
|
||||
98
|
||||
99
|
||||
100
|
||||
101
|
||||
102
|
||||
103
|
||||
104
|
||||
105
|
||||
106
|
||||
107
|
||||
108</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/include_tree.rb', line 96</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
|
||||
<span class='comment'># TODO(beauby): Adopt a lazy caching strategy for generating subtrees.
|
||||
</span> <span class='kw'>case</span>
|
||||
<span class='kw'>when</span> <span class='ivar'>@hash</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
|
||||
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@hash</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
||||
<span class='kw'>when</span> <span class='ivar'>@hash</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='symbol'>:*</span><span class='rparen'>)</span>
|
||||
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@hash</span><span class='lbracket'>[</span><span class='symbol'>:*</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
||||
<span class='kw'>when</span> <span class='ivar'>@hash</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='symbol'>:**</span><span class='rparen'>)</span>
|
||||
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='symbol'>:**</span> <span class='op'>=></span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</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="key?-instance_method">
|
||||
|
||||
- (<tt>Boolean</tt>) <strong>key?</strong>(key)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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">
|
||||
|
||||
|
||||
92
|
||||
93
|
||||
94</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/include_tree.rb', line 92</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
|
||||
<span class='ivar'>@hash</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='ivar'>@hash</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='symbol'>:*</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='ivar'>@hash</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='symbol'>:**</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:39 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -1,387 +0,0 @@
|
||||
<!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::IncludeTree::Parsing
|
||||
|
||||
— 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/IncludeTree/Parsing.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 (P)</a> »
|
||||
<span class='title'><span class='object_link'><a href="../../../ActiveModel.html" title="ActiveModel (module)">ActiveModel</a></span></span> » <span class='title'><span class='object_link'><a href="../../Serializer.html" title="ActiveModel::Serializer (class)">Serializer</a></span></span> » <span class='title'><span class='object_link'><a href="../IncludeTree.html" title="ActiveModel::Serializer::IncludeTree (class)">IncludeTree</a></span></span>
|
||||
»
|
||||
<span class="title">Parsing</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::IncludeTree::Parsing
|
||||
|
||||
|
||||
|
||||
</h1>
|
||||
|
||||
<dl class="box">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="r1 last">Defined in:</dt>
|
||||
<dd class="r1 last">lib/active_model/serializer/include_tree.rb</dd>
|
||||
|
||||
</dl>
|
||||
<div class="clear"></div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2>
|
||||
Class Method Summary
|
||||
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
||||
</h2>
|
||||
|
||||
<ul class="summary">
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#include_args_to_hash-class_method" title="include_args_to_hash (class method)">+ (Hash) <strong>include_args_to_hash</strong>(included) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Translates the arguments passed to the include option into a Hash.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#include_string_to_hash-class_method" title="include_string_to_hash (class method)">+ (Hash) <strong>include_string_to_hash</strong>(included) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Translates a comma separated list of dot separated paths (JSON API format)
|
||||
into a Hash.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
<div id="class_method_details" class="method_details_list">
|
||||
<h2>Class Method Details</h2>
|
||||
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="include_args_to_hash-class_method">
|
||||
|
||||
+ (<tt>Hash</tt>) <strong>include_args_to_hash</strong>(included)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Translates the arguments passed to the include option into a Hash. The
|
||||
format can be either a String (see #include_string_to_hash), an Array of
|
||||
Symbols and Hashes, or a mix of both.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
<div class="examples">
|
||||
<p class="tag_title">Examples:</p>
|
||||
|
||||
|
||||
<pre class="example code"><code>`posts: [:author, comments: [:author, :upvotes]]`
|
||||
|
||||
would become
|
||||
|
||||
`{ posts: { author: {}, comments: { author: {}, upvotes: {} } } }`.</code></pre>
|
||||
|
||||
|
||||
<pre class="example code"><code><span class='backtick'>`</span><span class='tstring_content'>[:author, :comments => [:author]]</span><span class='tstring_end'>`</span></span>
|
||||
|
||||
<span class='id identifier rubyid_would'>would</span> <span class='id identifier rubyid_become'>become</span>
|
||||
|
||||
<span class='backtick'>`</span><span class='tstring_content'>{:author => {}, :comments => { author: {} } }</span><span class='tstring_end'>`</span></span></code></pre>
|
||||
|
||||
</div>
|
||||
<p class="tag_title">Parameters:</p>
|
||||
<ul class="param">
|
||||
|
||||
<li>
|
||||
|
||||
<span class='name'>included</span>
|
||||
|
||||
|
||||
<span class='type'>(<tt>Symbol</tt>, <tt>Hash</tt>, <tt>Array</tt>, <tt>String</tt>)</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
<p class="tag_title">Returns:</p>
|
||||
<ul class="return">
|
||||
|
||||
<li>
|
||||
|
||||
|
||||
<span class='type'>(<tt>Hash</tt>)</span>
|
||||
|
||||
|
||||
|
||||
—
|
||||
<div class='inline'>
|
||||
<p>a Hash representing the same tree structure</p>
|
||||
</div>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
46
|
||||
47
|
||||
48
|
||||
49
|
||||
50
|
||||
51
|
||||
52
|
||||
53
|
||||
54
|
||||
55
|
||||
56
|
||||
57
|
||||
58
|
||||
59
|
||||
60
|
||||
61</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/include_tree.rb', line 46</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_include_args_to_hash'>include_args_to_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_included'>included</span><span class='rparen'>)</span>
|
||||
<span class='kw'>case</span> <span class='id identifier rubyid_included'>included</span>
|
||||
<span class='kw'>when</span> <span class='const'>Symbol</span>
|
||||
<span class='lbrace'>{</span> <span class='id identifier rubyid_included'>included</span> <span class='op'>=></span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='rbrace'>}</span>
|
||||
<span class='kw'>when</span> <span class='const'>Hash</span>
|
||||
<span class='id identifier rubyid_included'>included</span><span class='period'>.</span><span class='id identifier rubyid_each_with_object'>each_with_object</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_hash'>hash</span><span class='op'>|</span>
|
||||
<span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_include_args_to_hash'>include_args_to_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span>
|
||||
<span class='kw'>when</span> <span class='const'>Array</span>
|
||||
<span class='id identifier rubyid_included'>included</span><span class='period'>.</span><span class='id identifier rubyid_reduce'>reduce</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='comma'>,</span> <span class='id identifier rubyid_e'>e</span><span class='op'>|</span> <span class='id identifier rubyid_a'>a</span><span class='period'>.</span><span class='id identifier rubyid_deep_merge!'>deep_merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_include_args_to_hash'>include_args_to_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
||||
<span class='kw'>when</span> <span class='const'>String</span>
|
||||
<span class='id identifier rubyid_include_string_to_hash'>include_string_to_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_included'>included</span><span class='rparen'>)</span>
|
||||
<span class='kw'>else</span>
|
||||
<span class='lbrace'>{</span><span class='rbrace'>}</span>
|
||||
<span class='kw'>end</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="include_string_to_hash-class_method">
|
||||
|
||||
+ (<tt>Hash</tt>) <strong>include_string_to_hash</strong>(included)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Translates a comma separated list of dot separated paths (JSON API format)
|
||||
into a Hash.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
<div class="examples">
|
||||
<p class="tag_title">Examples:</p>
|
||||
|
||||
|
||||
<pre class="example code"><code>`'posts.author, posts.comments.upvotes, posts.comments.author'`
|
||||
|
||||
would become
|
||||
|
||||
`{ posts: { author: {}, comments: { author: {}, upvotes: {} } } }`.</code></pre>
|
||||
|
||||
</div>
|
||||
<p class="tag_title">Parameters:</p>
|
||||
<ul class="param">
|
||||
|
||||
<li>
|
||||
|
||||
<span class='name'>included</span>
|
||||
|
||||
|
||||
<span class='type'>(<tt>String</tt>)</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
<p class="tag_title">Returns:</p>
|
||||
<ul class="return">
|
||||
|
||||
<li>
|
||||
|
||||
|
||||
<span class='type'>(<tt>Hash</tt>)</span>
|
||||
|
||||
|
||||
|
||||
—
|
||||
<div class='inline'>
|
||||
<p>a Hash representing the same tree structure</p>
|
||||
</div>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
19
|
||||
20
|
||||
21
|
||||
22
|
||||
23
|
||||
24
|
||||
25</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/include_tree.rb', line 19</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_include_string_to_hash'>include_string_to_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_included'>included</span><span class='rparen'>)</span>
|
||||
<span class='comment'># TODO: Needs comment walking through the process of what all this is doing.
|
||||
</span> <span class='id identifier rubyid_included'>included</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'> </span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>,</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_reduce'>reduce</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_hash'>hash</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='op'>|</span>
|
||||
<span class='id identifier rubyid_include_tree'>include_tree</span> <span class='op'>=</span> <span class='id identifier rubyid_path'>path</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>.</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_reverse_each'>reverse_each</span><span class='period'>.</span><span class='id identifier rubyid_reduce'>reduce</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='comma'>,</span> <span class='id identifier rubyid_e'>e</span><span class='op'>|</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span> <span class='op'>=></span> <span class='id identifier rubyid_a'>a</span> <span class='rbrace'>}</span> <span class='rbrace'>}</span>
|
||||
<span class='id identifier rubyid_hash'>hash</span><span class='period'>.</span><span class='id identifier rubyid_deep_merge!'>deep_merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_include_tree'>include_tree</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:36 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -115,9 +115,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:35 2016 by
|
||||
Generated on Mon Jun 13 21:53:35 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -246,9 +246,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:35 2016 by
|
||||
Generated on Mon Jun 13 21:53:36 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -106,9 +106,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:35 2016 by
|
||||
Generated on Mon Jun 13 21:53:35 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -413,12 +413,12 @@ arguments.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
129
|
||||
130
|
||||
131</pre>
|
||||
122
|
||||
123
|
||||
124</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/lint.rb', line 129</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/lint.rb', line 122</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_test_active_model_errors'>test_active_model_errors</span>
|
||||
<span class='id identifier rubyid_assert_respond_to'>assert_respond_to</span> <span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='symbol'>:errors</span>
|
||||
@ -443,13 +443,13 @@ arguments.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
133
|
||||
134
|
||||
135
|
||||
136</pre>
|
||||
126
|
||||
127
|
||||
128
|
||||
129</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/lint.rb', line 133</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/lint.rb', line 126</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_test_active_model_errors_human_attribute_name'>test_active_model_errors_human_attribute_name</span>
|
||||
<span class='id identifier rubyid_assert_respond_to'>assert_respond_to</span> <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='comma'>,</span> <span class='symbol'>:human_attribute_name</span>
|
||||
@ -475,13 +475,13 @@ arguments.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
138
|
||||
139
|
||||
140
|
||||
141</pre>
|
||||
131
|
||||
132
|
||||
133
|
||||
134</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/lint.rb', line 138</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/lint.rb', line 131</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_test_active_model_errors_lookup_ancestors'>test_active_model_errors_lookup_ancestors</span>
|
||||
<span class='id identifier rubyid_assert_respond_to'>assert_respond_to</span> <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='comma'>,</span> <span class='symbol'>:lookup_ancestors</span>
|
||||
@ -524,14 +524,14 @@ ActiveModel::Serializers::JSON. or by the JSON gem when required.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
60
|
||||
61
|
||||
62
|
||||
63
|
||||
64</pre>
|
||||
54
|
||||
55
|
||||
56
|
||||
57
|
||||
58</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/lint.rb', line 60</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/lint.rb', line 54</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_test_as_json'>test_as_json</span>
|
||||
<span class='id identifier rubyid_assert_respond_to'>assert_respond_to</span> <span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='symbol'>:as_json</span>
|
||||
@ -573,21 +573,19 @@ It is not required unless caching is enabled.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
85
|
||||
86
|
||||
87
|
||||
88
|
||||
89
|
||||
90</pre>
|
||||
79
|
||||
80
|
||||
81
|
||||
82
|
||||
83</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/lint.rb', line 85</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/lint.rb', line 79</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_test_cache_key'>test_cache_key</span>
|
||||
<span class='id identifier rubyid_assert_respond_to'>assert_respond_to</span> <span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='symbol'>:cache_key</span>
|
||||
<span class='id identifier rubyid_actual_arity'>actual_arity</span> <span class='op'>=</span> <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_method'>method</span><span class='lparen'>(</span><span class='symbol'>:cache_key</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_arity'>arity</span>
|
||||
<span class='id identifier rubyid_assert_includes'>assert_includes</span> <span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='comma'>,</span> <span class='int'>0</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_actual_arity'>actual_arity</span><span class='comma'>,</span>
|
||||
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>expected </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_actual_arity'>actual_arity</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'> to be 0 or -1</span><span class='tstring_end'>"</span></span>
|
||||
<span class='id identifier rubyid_assert_includes'>assert_includes</span> <span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='comma'>,</span> <span class='int'>0</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_actual_arity'>actual_arity</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>expected </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_actual_arity'>actual_arity</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'> to be 0 or -1</span><span class='tstring_end'>"</span></span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
@ -624,13 +622,13 @@ required unless caching is enabled.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
111
|
||||
112
|
||||
113
|
||||
114</pre>
|
||||
104
|
||||
105
|
||||
106
|
||||
107</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/lint.rb', line 111</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/lint.rb', line 104</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_test_id'>test_id</span>
|
||||
<span class='id identifier rubyid_assert_respond_to'>assert_respond_to</span> <span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='symbol'>:id</span>
|
||||
@ -672,14 +670,14 @@ unless caching is enabled.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
123
|
||||
124
|
||||
125
|
||||
126
|
||||
127</pre>
|
||||
116
|
||||
117
|
||||
118
|
||||
119
|
||||
120</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/lint.rb', line 123</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/lint.rb', line 116</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_test_model_name'>test_model_name</span>
|
||||
<span class='id identifier rubyid_resource_class'>resource_class</span> <span class='op'>=</span> <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span>
|
||||
@ -730,13 +728,7 @@ ActiveModel::Serialization.</p>
|
||||
40
|
||||
41
|
||||
42
|
||||
43
|
||||
44
|
||||
45
|
||||
46
|
||||
47
|
||||
48
|
||||
49</pre>
|
||||
43</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/lint.rb', line 36</span>
|
||||
@ -744,16 +736,10 @@ ActiveModel::Serialization.</p>
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_test_read_attribute_for_serialization'>test_read_attribute_for_serialization</span>
|
||||
<span class='id identifier rubyid_assert_respond_to'>assert_respond_to</span> <span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='symbol'>:read_attribute_for_serialization</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>The resource should respond to read_attribute_for_serialization</span><span class='tstring_end'>'</span></span>
|
||||
<span class='id identifier rubyid_actual_arity'>actual_arity</span> <span class='op'>=</span> <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_method'>method</span><span class='lparen'>(</span><span class='symbol'>:read_attribute_for_serialization</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_arity'>arity</span>
|
||||
<span class='kw'>if</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='op'>::</span><span class='const'>Rubinius</span><span class='rparen'>)</span>
|
||||
<span class='comment'># 1 for def read_attribute_for_serialization(name); end
|
||||
</span> <span class='comment'># -2 for alias :read_attribute_for_serialization :send for rbx because :shrug:
|
||||
</span> <span class='id identifier rubyid_assert_includes'>assert_includes</span> <span class='lbracket'>[</span><span class='int'>1</span><span class='comma'>,</span> <span class='op'>-</span><span class='int'>2</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_actual_arity'>actual_arity</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>expected </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_actual_arity'>actual_arity</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'> to be 1 or -2</span><span class='tstring_end'>"</span></span>
|
||||
<span class='kw'>else</span>
|
||||
<span class='comment'># using absolute value since arity is:
|
||||
</span> <span class='comment'># 1 for def read_attribute_for_serialization(name); end
|
||||
</span> <span class='comment'># -1 for alias :read_attribute_for_serialization :send
|
||||
</span> <span class='id identifier rubyid_assert_includes'>assert_includes</span> <span class='lbracket'>[</span><span class='int'>1</span><span class='comma'>,</span> <span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_actual_arity'>actual_arity</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>expected </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_actual_arity'>actual_arity</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'> to be 1 or -1</span><span class='tstring_end'>"</span></span>
|
||||
<span class='kw'>end</span>
|
||||
</span> <span class='id identifier rubyid_assert_equal'>assert_equal</span> <span class='int'>1</span><span class='comma'>,</span> <span class='id identifier rubyid_actual_arity'>actual_arity</span><span class='period'>.</span><span class='id identifier rubyid_abs'>abs</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>expected </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_actual_arity'>actual_arity</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'>.abs to be 1 or -1</span><span class='tstring_end'>"</span></span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
@ -841,14 +827,14 @@ it is implemented on all objects when the JSON gem is required.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
73
|
||||
74
|
||||
75
|
||||
76
|
||||
77</pre>
|
||||
67
|
||||
68
|
||||
69
|
||||
70
|
||||
71</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/lint.rb', line 73</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/lint.rb', line 67</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_test_to_json'>test_to_json</span>
|
||||
<span class='id identifier rubyid_assert_respond_to'>assert_respond_to</span> <span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='symbol'>:to_json</span>
|
||||
@ -891,14 +877,14 @@ required unless caching is enabled.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
99
|
||||
100
|
||||
101
|
||||
102
|
||||
103</pre>
|
||||
92
|
||||
93
|
||||
94
|
||||
95
|
||||
96</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/lint.rb', line 99</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model/serializer/lint.rb', line 92</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_test_updated_at'>test_updated_at</span>
|
||||
<span class='id identifier rubyid_assert_respond_to'>assert_respond_to</span> <span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='symbol'>:updated_at</span>
|
||||
@ -915,9 +901,9 @@ required unless caching is enabled.</p>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:35 2016 by
|
||||
Generated on Mon Jun 13 21:53:35 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -115,9 +115,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:35 2016 by
|
||||
Generated on Mon Jun 13 21:53:35 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -192,9 +192,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:35 2016 by
|
||||
Generated on Mon Jun 13 21:53:35 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -111,7 +111,7 @@
|
||||
|
||||
<h3 class="inherited">Constants inherited
|
||||
from <span class='object_link'><a href="../Serializer.html" title="ActiveModel::Serializer (class)">ActiveModel::Serializer</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="../Serializer.html#VERSION-constant" title="ActiveModel::Serializer::VERSION (constant)">VERSION</a></span></p>
|
||||
<p class="inherited"><span class='object_link'><a href="../Serializer.html#SERIALIZABLE_HASH_VALID_KEYS-constant" title="ActiveModel::Serializer::SERIALIZABLE_HASH_VALID_KEYS (constant)">SERIALIZABLE_HASH_VALID_KEYS</a></span>, <span class='object_link'><a href="../Serializer.html#UndefinedCacheKey-constant" title="ActiveModel::Serializer::UndefinedCacheKey (constant)">UndefinedCacheKey</a></span>, <span class='object_link'><a href="../Serializer.html#VERSION-constant" title="ActiveModel::Serializer::VERSION (constant)">VERSION</a></span></p>
|
||||
|
||||
|
||||
|
||||
@ -121,12 +121,6 @@
|
||||
|
||||
|
||||
|
||||
<h3 class="inherited">Constants included
|
||||
from <span class='object_link'><a href="Associations.html" title="ActiveModel::Serializer::Associations (module)">Associations</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="Associations.html#DEFAULT_INCLUDE_TREE-constant" title="ActiveModel::Serializer::Associations::DEFAULT_INCLUDE_TREE (constant)">Associations::DEFAULT_INCLUDE_TREE</a></span></p>
|
||||
|
||||
|
||||
|
||||
|
||||
<h2>Instance Attribute Summary</h2>
|
||||
|
||||
@ -221,7 +215,7 @@
|
||||
|
||||
|
||||
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Serializer.html" title="ActiveModel::Serializer (class)">ActiveModel::Serializer</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="../Serializer.html#adapter-class_method" title="ActiveModel::Serializer.adapter (method)">adapter</a></span>, <span class='object_link'><a href="../Serializer.html#as_json-instance_method" title="ActiveModel::Serializer#as_json (method)">#as_json</a></span>, <span class='object_link'><a href="../Serializer.html#get_serializer_for-class_method" title="ActiveModel::Serializer.get_serializer_for (method)">get_serializer_for</a></span>, <span class='object_link'><a href="../Serializer.html#initialize-instance_method" title="ActiveModel::Serializer#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Serializer.html#json_key-instance_method" title="ActiveModel::Serializer#json_key (method)">#json_key</a></span>, <span class='object_link'><a href="../Serializer.html#read_attribute_for_serialization-instance_method" title="ActiveModel::Serializer#read_attribute_for_serialization (method)">#read_attribute_for_serialization</a></span>, <span class='object_link'><a href="../Serializer.html#serializer_for-class_method" title="ActiveModel::Serializer.serializer_for (method)">serializer_for</a></span>, <span class='object_link'><a href="../Serializer.html#serializer_lookup_chain_for-class_method" title="ActiveModel::Serializer.serializer_lookup_chain_for (method)">serializer_lookup_chain_for</a></span>, <span class='object_link'><a href="../Serializer.html#serializers_cache-class_method" title="ActiveModel::Serializer.serializers_cache (method)">serializers_cache</a></span>, <span class='object_link'><a href="../Serializer.html#success%3F-instance_method" title="ActiveModel::Serializer#success? (method)">#success?</a></span></p>
|
||||
<p class="inherited"><span class='object_link'><a href="../Serializer.html#adapter-class_method" title="ActiveModel::Serializer.adapter (method)">adapter</a></span>, <span class='object_link'><a href="../Serializer.html#as_json-instance_method" title="ActiveModel::Serializer#as_json (method)">#as_json</a></span>, <span class='object_link'><a href="../Serializer.html#get_serializer_for-class_method" title="ActiveModel::Serializer.get_serializer_for (method)">get_serializer_for</a></span>, <span class='object_link'><a href="../Serializer.html#include_directive_from_options-class_method" title="ActiveModel::Serializer.include_directive_from_options (method)">include_directive_from_options</a></span>, <span class='object_link'><a href="../Serializer.html#initialize-instance_method" title="ActiveModel::Serializer#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Serializer.html#json_key-instance_method" title="ActiveModel::Serializer#json_key (method)">#json_key</a></span>, <span class='object_link'><a href="../Serializer.html#read_attribute_for_serialization-instance_method" title="ActiveModel::Serializer#read_attribute_for_serialization (method)">#read_attribute_for_serialization</a></span>, <span class='object_link'><a href="../Serializer.html#relationship_value_for-instance_method" title="ActiveModel::Serializer#relationship_value_for (method)">#relationship_value_for</a></span>, <span class='object_link'><a href="../Serializer.html#resource_relationships-instance_method" title="ActiveModel::Serializer#resource_relationships (method)">#resource_relationships</a></span>, <span class='object_link'><a href="../Serializer.html#serialization_adapter_instance-class_method" title="ActiveModel::Serializer.serialization_adapter_instance (method)">serialization_adapter_instance</a></span>, <span class='object_link'><a href="../Serializer.html#serializer_for-class_method" title="ActiveModel::Serializer.serializer_for (method)">serializer_for</a></span>, <span class='object_link'><a href="../Serializer.html#serializer_lookup_chain_for-class_method" title="ActiveModel::Serializer.serializer_lookup_chain_for (method)">serializer_lookup_chain_for</a></span>, <span class='object_link'><a href="../Serializer.html#serializers_cache-class_method" title="ActiveModel::Serializer.serializers_cache (method)">serializers_cache</a></span>, <span class='object_link'><a href="../Serializer.html#success%3F-instance_method" title="ActiveModel::Serializer#success? (method)">#success?</a></span></p>
|
||||
|
||||
|
||||
|
||||
@ -263,6 +257,11 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 class="inherited">Methods included from <span class='object_link'><a href="Caching.html" title="ActiveModel::Serializer::Caching (module)">Caching</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="Caching.html#cache_key-instance_method" title="ActiveModel::Serializer::Caching#cache_key (method)">#cache_key</a></span>, <span class='object_link'><a href="Caching.html#fetch-instance_method" title="ActiveModel::Serializer::Caching#fetch (method)">#fetch</a></span>, <span class='object_link'><a href="Caching.html#fetch_attributes-instance_method" title="ActiveModel::Serializer::Caching#fetch_attributes (method)">#fetch_attributes</a></span>, <span class='object_link'><a href="Caching.html#fetch_attributes_fragment-instance_method" title="ActiveModel::Serializer::Caching#fetch_attributes_fragment (method)">#fetch_attributes_fragment</a></span>, <span class='object_link'><a href="Caching.html#object_cache_key-instance_method" title="ActiveModel::Serializer::Caching#object_cache_key (method)">#object_cache_key</a></span>, <span class='object_link'><a href="Caching.html#serializer_class-instance_method" title="ActiveModel::Serializer::Caching#serializer_class (method)">#serializer_class</a></span></p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -391,9 +390,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:38 2016 by
|
||||
Generated on Mon Jun 13 21:53:38 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -710,10 +710,10 @@ association by its reflection.</p>
|
||||
|
||||
<span class='kw'>if</span> <span class='id identifier rubyid_block'>block</span>
|
||||
<span class='id identifier rubyid_block_value'>block_value</span> <span class='op'>=</span> <span class='id identifier rubyid_instance_exec'>instance_exec</span><span class='lparen'>(</span><span class='id identifier rubyid_serializer'>serializer</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
||||
<span class='kw'>if</span> <span class='id identifier rubyid_block_value'>block_value</span> <span class='op'>==</span> <span class='symbol'>:nil</span>
|
||||
<span class='id identifier rubyid_serializer'>serializer</span><span class='period'>.</span><span class='id identifier rubyid_read_attribute_for_serialization'>read_attribute_for_serialization</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
|
||||
<span class='kw'>else</span>
|
||||
<span class='kw'>if</span> <span class='id identifier rubyid_block_value'>block_value</span> <span class='op'>!=</span> <span class='symbol'>:nil</span>
|
||||
<span class='id identifier rubyid_block_value'>block_value</span>
|
||||
<span class='kw'>elsif</span> <span class='ivar'>@_include_data</span>
|
||||
<span class='id identifier rubyid_serializer'>serializer</span><span class='period'>.</span><span class='id identifier rubyid_read_attribute_for_serialization'>read_attribute_for_serialization</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span>
|
||||
<span class='kw'>else</span>
|
||||
<span class='id identifier rubyid_serializer'>serializer</span><span class='period'>.</span><span class='id identifier rubyid_read_attribute_for_serialization'>read_attribute_for_serialization</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
|
||||
@ -729,9 +729,9 @@ association by its reflection.</p>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:38 2016 by
|
||||
Generated on Mon Jun 13 21:53:38 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -163,9 +163,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:40 2016 by
|
||||
Generated on Mon Jun 13 21:53:40 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -115,9 +115,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:35 2016 by
|
||||
Generated on Mon Jun 13 21:53:35 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -187,9 +187,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:35 2016 by
|
||||
Generated on Mon Jun 13 21:53:35 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -84,7 +84,7 @@
|
||||
|
||||
<dt class="r2 last">Defined in:</dt>
|
||||
<dd class="r2 last">lib/active_model_serializers/model.rb<span class="defines">,<br />
|
||||
lib/active_model_serializers.rb,<br /> lib/active_model_serializers/test.rb,<br /> lib/active_model_serializers/railtie.rb,<br /> lib/active_model_serializers/logging.rb,<br /> lib/active_model_serializers/adapter.rb,<br /> lib/active_model_serializers/callbacks.rb,<br /> lib/active_model_serializers/deprecate.rb,<br /> lib/active_model_serializers/test/schema.rb,<br /> lib/active_model_serializers/json_pointer.rb,<br /> lib/active_model_serializers/adapter/null.rb,<br /> lib/active_model_serializers/adapter/base.rb,<br /> lib/active_model_serializers/adapter/json.rb,<br /> lib/active_model_serializers/key_transform.rb,<br /> lib/active_model_serializers/fragment_cache.rb,<br /> lib/active_model_serializers/deserialization.rb,<br /> lib/active_model_serializers/test/serializer.rb,<br /> lib/active_model_serializers/adapter/json_api.rb,<br /> lib/active_model_serializers/cached_serializer.rb,<br /> lib/active_model_serializers/adapter/attributes.rb,<br /> lib/active_model_serializers/adapter/json_api/meta.rb,<br /> lib/active_model_serializers/serialization_context.rb,<br /> lib/active_model_serializers/adapter/json_api/link.rb,<br /> lib/active_model_serializers/serializable_resource.rb,<br /> lib/active_model_serializers/adapter/json_api/error.rb,<br /> lib/active_model_serializers/adapter/json_api/jsonapi.rb,<br /> lib/active_model_serializers/adapter/json_api/relationship.rb,<br /> lib/active_model_serializers/adapter/json_api/deserialization.rb,<br /> lib/active_model_serializers/adapter/json_api/pagination_links.rb,<br /> lib/active_model_serializers/adapter/json_api/resource_identifier.rb</span>
|
||||
lib/active_model_serializers.rb,<br /> lib/active_model_serializers/test.rb,<br /> lib/active_model_serializers/railtie.rb,<br /> lib/active_model_serializers/adapter.rb,<br /> lib/active_model_serializers/logging.rb,<br /> lib/active_model_serializers/deprecate.rb,<br /> lib/active_model_serializers/callbacks.rb,<br /> lib/active_model_serializers/test/schema.rb,<br /> lib/active_model_serializers/adapter/null.rb,<br /> lib/active_model_serializers/adapter/base.rb,<br /> lib/active_model_serializers/json_pointer.rb,<br /> lib/active_model_serializers/adapter/json.rb,<br /> lib/active_model_serializers/key_transform.rb,<br /> lib/active_model_serializers/test/serializer.rb,<br /> lib/active_model_serializers/deserialization.rb,<br /> lib/active_model_serializers/adapter/json_api.rb,<br /> lib/active_model_serializers/adapter/attributes.rb,<br /> lib/active_model_serializers/adapter/json_api/link.rb,<br /> lib/active_model_serializers/serialization_context.rb,<br /> lib/active_model_serializers/serializable_resource.rb,<br /> lib/active_model_serializers/adapter/json_api/meta.rb,<br /> lib/active_model_serializers/adapter/json_api/error.rb,<br /> lib/active_model_serializers/adapter/json_api/jsonapi.rb,<br /> lib/active_model_serializers/adapter/json_api/relationship.rb,<br /> lib/active_model_serializers/adapter/json_api/deserialization.rb,<br /> lib/active_model_serializers/adapter/json_api/pagination_links.rb,<br /> lib/active_model_serializers/adapter/json_api/resource_identifier.rb</span>
|
||||
</dd>
|
||||
|
||||
</dl>
|
||||
@ -136,7 +136,7 @@ Style/AsciiComments TODO: implement!</p>
|
||||
|
||||
|
||||
|
||||
<strong class="classes">Classes:</strong> <span class='object_link'><a href="ActiveModelSerializers/CachedSerializer.html" title="ActiveModelSerializers::CachedSerializer (class)">CachedSerializer</a></span>, <span class='object_link'><a href="ActiveModelSerializers/FragmentCache.html" title="ActiveModelSerializers::FragmentCache (class)">FragmentCache</a></span>, <span class='object_link'><a href="ActiveModelSerializers/Model.html" title="ActiveModelSerializers::Model (class)">Model</a></span>, <span class='object_link'><a href="ActiveModelSerializers/Railtie.html" title="ActiveModelSerializers::Railtie (class)">Railtie</a></span>, <span class='object_link'><a href="ActiveModelSerializers/SerializableResource.html" title="ActiveModelSerializers::SerializableResource (class)">SerializableResource</a></span>, <span class='object_link'><a href="ActiveModelSerializers/SerializationContext.html" title="ActiveModelSerializers::SerializationContext (class)">SerializationContext</a></span>
|
||||
<strong class="classes">Classes:</strong> <span class='object_link'><a href="ActiveModelSerializers/Model.html" title="ActiveModelSerializers::Model (class)">Model</a></span>, <span class='object_link'><a href="ActiveModelSerializers/Railtie.html" title="ActiveModelSerializers::Railtie (class)">Railtie</a></span>, <span class='object_link'><a href="ActiveModelSerializers/SerializableResource.html" title="ActiveModelSerializers::SerializableResource (class)">SerializableResource</a></span>, <span class='object_link'><a href="ActiveModelSerializers/SerializationContext.html" title="ActiveModelSerializers::SerializationContext (class)">SerializationContext</a></span>
|
||||
|
||||
|
||||
</p>
|
||||
@ -206,6 +206,30 @@ Style/AsciiComments TODO: implement!</p>
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#default_include_directive-class_method" title="default_include_directive (class method)">+ (JSONAPI::IncludeDirective) <strong>default_include_directive</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Memoized default include directive.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
@ -269,12 +293,12 @@ Style/AsciiComments TODO: implement!</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
20
|
||||
21
|
||||
22</pre>
|
||||
18
|
||||
19
|
||||
20</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers.rb', line 20</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers.rb', line 18</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_logger'>logger</span>
|
||||
<span class='ivar'>@logger</span>
|
||||
@ -306,12 +330,12 @@ Style/AsciiComments TODO: implement!</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
23
|
||||
24
|
||||
25</pre>
|
||||
21
|
||||
22
|
||||
23</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers.rb', line 23</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers.rb', line 21</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span>
|
||||
<span class='const'>ActiveModel</span><span class='op'>::</span><span class='const'>Serializer</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span>
|
||||
@ -319,6 +343,60 @@ Style/AsciiComments TODO: implement!</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="default_include_directive-class_method">
|
||||
|
||||
+ (<tt>JSONAPI::IncludeDirective</tt>) <strong>default_include_directive</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Memoized default include directive</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
<p class="tag_title">Returns:</p>
|
||||
<ul class="return">
|
||||
|
||||
<li>
|
||||
|
||||
|
||||
<span class='type'>(<tt>JSONAPI::IncludeDirective</tt>)</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
36
|
||||
37
|
||||
38</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers.rb', line 36</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_default_include_directive'>default_include_directive</span>
|
||||
<span class='ivar'>@default_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_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_default_includes'>default_includes</span><span class='comma'>,</span> <span class='label'>allow_wildcard:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
@ -347,16 +425,16 @@ Style/AsciiComments TODO: implement!</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
26
|
||||
27
|
||||
28
|
||||
29
|
||||
30
|
||||
31
|
||||
32
|
||||
33
|
||||
34</pre>
|
||||
32</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers.rb', line 28</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers.rb', line 26</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_location_of_caller'>location_of_caller</span>
|
||||
<span class='id identifier rubyid_caller'>caller</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>(.*?):(\d+).*?$</span><span class='regexp_end'>/i</span></span>
|
||||
@ -375,9 +453,9 @@ Style/AsciiComments TODO: implement!</p>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:35 2016 by
|
||||
Generated on Mon Jun 13 21:53:35 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -84,7 +84,7 @@
|
||||
|
||||
<dt class="r2 last">Defined in:</dt>
|
||||
<dd class="r2 last">lib/active_model_serializers/adapter.rb<span class="defines">,<br />
|
||||
lib/active_model_serializers/adapter/null.rb,<br /> lib/active_model_serializers/adapter/base.rb,<br /> lib/active_model_serializers/adapter/json.rb,<br /> lib/active_model_serializers/adapter/json_api.rb,<br /> lib/active_model_serializers/adapter/attributes.rb,<br /> lib/active_model_serializers/adapter/json_api/meta.rb,<br /> lib/active_model_serializers/adapter/json_api/link.rb,<br /> lib/active_model_serializers/adapter/json_api/error.rb,<br /> lib/active_model_serializers/adapter/json_api/jsonapi.rb,<br /> lib/active_model_serializers/adapter/json_api/relationship.rb,<br /> lib/active_model_serializers/adapter/json_api/deserialization.rb,<br /> lib/active_model_serializers/adapter/json_api/pagination_links.rb,<br /> lib/active_model_serializers/adapter/json_api/resource_identifier.rb</span>
|
||||
lib/active_model_serializers/adapter/null.rb,<br /> lib/active_model_serializers/adapter/base.rb,<br /> lib/active_model_serializers/adapter/json.rb,<br /> lib/active_model_serializers/adapter/json_api.rb,<br /> lib/active_model_serializers/adapter/attributes.rb,<br /> lib/active_model_serializers/adapter/json_api/link.rb,<br /> lib/active_model_serializers/adapter/json_api/meta.rb,<br /> lib/active_model_serializers/adapter/json_api/error.rb,<br /> lib/active_model_serializers/adapter/json_api/jsonapi.rb,<br /> lib/active_model_serializers/adapter/json_api/relationship.rb,<br /> lib/active_model_serializers/adapter/json_api/deserialization.rb,<br /> lib/active_model_serializers/adapter/json_api/pagination_links.rb,<br /> lib/active_model_serializers/adapter/json_api/resource_identifier.rb</span>
|
||||
</dd>
|
||||
|
||||
</dl>
|
||||
@ -212,7 +212,9 @@
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>:nocov:.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
@ -280,7 +282,9 @@
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>:nocov:.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
@ -307,6 +311,28 @@
|
||||
'adapter_map' Names are stringified and underscored.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#registered_name-class_method" title="registered_name (class method)">+ (Object) <strong>registered_name</strong>(adapter_class) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
@ -351,12 +377,12 @@
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
25
|
||||
26
|
||||
27</pre>
|
||||
27
|
||||
28
|
||||
29</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter.rb', line 25</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter.rb', line 27</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_adapter_class'>adapter_class</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter'>adapter</span><span class='rparen'>)</span>
|
||||
<span class='const'>ActiveModelSerializers</span><span class='op'>::</span><span class='const'>Adapter</span><span class='period'>.</span><span class='id identifier rubyid_lookup'>lookup</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter'>adapter</span><span class='rparen'>)</span>
|
||||
@ -403,12 +429,12 @@
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
30
|
||||
31
|
||||
32</pre>
|
||||
32
|
||||
33
|
||||
34</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter.rb', line 30</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter.rb', line 32</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_adapter_map'>adapter_map</span>
|
||||
<span class='const'>ADAPTER_MAP</span>
|
||||
@ -462,12 +488,12 @@
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
35
|
||||
36
|
||||
37</pre>
|
||||
37
|
||||
38
|
||||
39</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter.rb', line 35</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter.rb', line 37</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_adapters'>adapters</span>
|
||||
<span class='id identifier rubyid_adapter_map'>adapter_map</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_sort'>sort</span>
|
||||
@ -486,18 +512,29 @@
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>:nocov:</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
14
|
||||
15
|
||||
16</pre>
|
||||
16
|
||||
17
|
||||
18</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter.rb', line 14</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter.rb', line 16</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_configured_adapter'>configured_adapter</span>
|
||||
<span class='id identifier rubyid_lookup'>lookup</span><span class='lparen'>(</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_adapter'>adapter</span><span class='rparen'>)</span>
|
||||
@ -522,14 +559,14 @@
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
18
|
||||
19
|
||||
20
|
||||
21
|
||||
22</pre>
|
||||
22
|
||||
23
|
||||
24</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter.rb', line 18</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter.rb', line 20</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</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='id identifier rubyid_override'>override</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'>:adapter</span><span class='rparen'>)</span>
|
||||
@ -618,12 +655,6 @@
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
57
|
||||
58
|
||||
59
|
||||
60
|
||||
61
|
||||
62
|
||||
63
|
||||
64
|
||||
65
|
||||
@ -633,10 +664,16 @@
|
||||
69
|
||||
70
|
||||
71
|
||||
72</pre>
|
||||
72
|
||||
73
|
||||
74
|
||||
75
|
||||
76
|
||||
77
|
||||
78</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter.rb', line 57</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter.rb', line 63</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_lookup'>lookup</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter'>adapter</span><span class='rparen'>)</span>
|
||||
<span class='comment'># 1. return if is a class
|
||||
@ -668,20 +705,31 @@
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>:nocov:</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
8
|
||||
9
|
||||
10
|
||||
11
|
||||
12</pre>
|
||||
12
|
||||
13</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter.rb', line 8</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter.rb', line 9</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Adapters inherit from Adapter::Base.</span><span class='tstring_end'>'</span></span> \
|
||||
@ -776,14 +824,14 @@ so that registering 'ActiveModelSerializers::Adapter::Json' and
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
48
|
||||
49
|
||||
50
|
||||
51
|
||||
52</pre>
|
||||
52
|
||||
53
|
||||
54</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter.rb', line 48</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter.rb', line 50</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_register'>register</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_klass'>klass</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\AActiveModelSerializers::Adapter::</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span><span class='rparen'>)</span>
|
||||
@ -793,6 +841,36 @@ so that registering 'ActiveModelSerializers::Adapter::Json' and
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="registered_name-class_method">
|
||||
|
||||
+ (<tt>Object</tt>) <strong>registered_name</strong>(adapter_class)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
56
|
||||
57
|
||||
58</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter.rb', line 56</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_registered_name'>registered_name</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter_class'>adapter_class</span><span class='rparen'>)</span>
|
||||
<span class='const'>ADAPTER_MAP</span><span class='period'>.</span><span class='id identifier rubyid_key'>key</span> <span class='id identifier rubyid_adapter_class'>adapter_class</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@ -800,9 +878,9 @@ so that registering 'ActiveModelSerializers::Adapter::Json' and
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:36 2016 by
|
||||
Generated on Mon Jun 13 21:53:36 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -128,32 +128,6 @@
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Attributes) <strong>initialize</strong>(serializer, options = {}) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
<span class="note title constructor">constructor</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>A new instance of Attributes.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#serializable_hash-instance_method" title="#serializable_hash (instance method)">- (Object) <strong>serializable_hash</strong>(options = nil) </a>
|
||||
|
||||
|
||||
@ -186,54 +160,11 @@
|
||||
|
||||
|
||||
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="ActiveModelSerializers::Adapter::Base (class)">Base</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="Base.html#as_json-instance_method" title="ActiveModelSerializers::Adapter::Base#as_json (method)">#as_json</a></span>, <span class='object_link'><a href="Base.html#cache_check-instance_method" title="ActiveModelSerializers::Adapter::Base#cache_check (method)">#cache_check</a></span>, <span class='object_link'><a href="Base.html#cached_name-instance_method" title="ActiveModelSerializers::Adapter::Base#cached_name (method)">#cached_name</a></span>, <span class='object_link'><a href="Base.html#default_key_transform-class_method" title="ActiveModelSerializers::Adapter::Base.default_key_transform (method)">default_key_transform</a></span>, <span class='object_link'><a href="Base.html#fragment_cache-instance_method" title="ActiveModelSerializers::Adapter::Base#fragment_cache (method)">#fragment_cache</a></span>, <span class='object_link'><a href="Base.html#inherited-class_method" title="ActiveModelSerializers::Adapter::Base.inherited (method)">inherited</a></span>, <span class='object_link'><a href="Base.html#transform-class_method" title="ActiveModelSerializers::Adapter::Base.transform (method)">transform</a></span>, <span class='object_link'><a href="Base.html#transform_key_casing%21-class_method" title="ActiveModelSerializers::Adapter::Base.transform_key_casing! (method)">transform_key_casing!</a></span></p>
|
||||
<p class="inherited"><span class='object_link'><a href="Base.html#as_json-instance_method" title="ActiveModelSerializers::Adapter::Base#as_json (method)">#as_json</a></span>, <span class='object_link'><a href="Base.html#cache_key-class_method" title="ActiveModelSerializers::Adapter::Base.cache_key (method)">cache_key</a></span>, <span class='object_link'><a href="Base.html#cache_key-instance_method" title="ActiveModelSerializers::Adapter::Base#cache_key (method)">#cache_key</a></span>, <span class='object_link'><a href="Base.html#default_key_transform-class_method" title="ActiveModelSerializers::Adapter::Base.default_key_transform (method)">default_key_transform</a></span>, <span class='object_link'><a href="Base.html#fragment_cache-instance_method" title="ActiveModelSerializers::Adapter::Base#fragment_cache (method)">#fragment_cache</a></span>, <span class='object_link'><a href="Base.html#fragment_cache-class_method" title="ActiveModelSerializers::Adapter::Base.fragment_cache (method)">fragment_cache</a></span>, <span class='object_link'><a href="Base.html#inherited-class_method" title="ActiveModelSerializers::Adapter::Base.inherited (method)">inherited</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="ActiveModelSerializers::Adapter::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#transform-class_method" title="ActiveModelSerializers::Adapter::Base.transform (method)">transform</a></span>, <span class='object_link'><a href="Base.html#transform_key_casing%21-class_method" title="ActiveModelSerializers::Adapter::Base.transform_key_casing! (method)">transform_key_casing!</a></span></p>
|
||||
<div id="constructor_details" class="method_details_list">
|
||||
<h2>Constructor Details</h2>
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="initialize-instance_method">
|
||||
|
||||
- (<tt><span class='object_link'><a href="" title="ActiveModelSerializers::Adapter::Attributes (class)">Attributes</a></span></tt>) <strong>initialize</strong>(serializer, options = {})
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Returns a new instance of Attributes</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
4
|
||||
5
|
||||
6
|
||||
7
|
||||
8</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/attributes.rb', line 4</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_serializer'>serializer</span><span class='comma'>,</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'>super</span>
|
||||
<span class='ivar'>@include_tree</span> <span class='op'>=</span> <span class='const'>ActiveModel</span><span class='op'>::</span><span class='const'>Serializer</span><span class='op'>::</span><span class='const'>IncludeTree</span><span class='period'>.</span><span class='id identifier rubyid_from_include_args'>from_include_args</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>*</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
||||
<span class='ivar'>@cached_attributes</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:cache_attributes</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="ActiveModelSerializers::Adapter::Base#initialize (method)">ActiveModelSerializers::Adapter::Base</a></span></p>
|
||||
|
||||
</div>
|
||||
|
||||
@ -257,27 +188,19 @@
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
10
|
||||
11
|
||||
12
|
||||
13
|
||||
14
|
||||
15
|
||||
16
|
||||
17
|
||||
18</pre>
|
||||
4
|
||||
5
|
||||
6
|
||||
7
|
||||
8</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/attributes.rb', line 10</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/attributes.rb', line 4</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_serializable_hash'>serializable_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_options'>options</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
||||
|
||||
<span class='kw'>if</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_serializable_hash_for_collection'>serializable_hash_for_collection</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
<span class='kw'>else</span>
|
||||
<span class='id identifier rubyid_serializable_hash_for_single_resource'>serializable_hash_for_single_resource</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span>
|
||||
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='id identifier rubyid_serialization_options'>serialization_options</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:fields</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='id identifier rubyid_instance_options'>instance_options</span><span class='lbracket'>[</span><span class='symbol'>:fields</span><span class='rbracket'>]</span>
|
||||
<span class='id identifier rubyid_serializer'>serializer</span><span class='period'>.</span><span class='id identifier rubyid_serializable_hash'>serializable_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_instance_options'>instance_options</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='comma'>,</span> <span class='kw'>self</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
@ -289,9 +212,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:40 2016 by
|
||||
Generated on Mon Jun 13 21:53:40 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -184,6 +184,28 @@
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#cache_key-class_method" title="cache_key (class method)">+ (Object) <strong>cache_key</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#default_key_transform-class_method" title="default_key_transform (class method)">+ (Symbol) <strong>default_key_transform</strong> </a>
|
||||
|
||||
|
||||
@ -202,6 +224,28 @@
|
||||
<p>Sets the default transform for the adapter.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#fragment_cache-class_method" title="fragment_cache (class method)">+ (Object) <strong>fragment_cache</strong>(cached_hash, non_cached_hash) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
@ -312,29 +356,7 @@ global config, adapter default.</p>
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#cache_check-instance_method" title="#cache_check (instance method)">- (Object) <strong>cache_check</strong>(serializer) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#cached_name-instance_method" title="#cached_name (instance method)">- (Object) <strong>cached_name</strong> </a>
|
||||
<a href="#cache_key-instance_method" title="#cache_key (instance method)">- (Object) <strong>cache_key</strong> </a>
|
||||
|
||||
|
||||
|
||||
@ -418,7 +440,10 @@ global config, adapter default.</p>
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Subclasses that implement this method must first call options =
|
||||
serialization_options(options).</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
@ -455,13 +480,13 @@ global config, adapter default.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
13
|
||||
14
|
||||
15
|
||||
16</pre>
|
||||
47
|
||||
48
|
||||
49
|
||||
50</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/base.rb', line 13</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/base.rb', line 47</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_serializer'>serializer</span><span class='comma'>,</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='ivar'>@serializer</span> <span class='op'>=</span> <span class='id identifier rubyid_serializer'>serializer</span>
|
||||
@ -505,12 +530,12 @@ global config, adapter default.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
11
|
||||
12
|
||||
13</pre>
|
||||
45
|
||||
46
|
||||
47</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/base.rb', line 11</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/base.rb', line 45</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_instance_options'>instance_options</span>
|
||||
<span class='ivar'>@instance_options</span>
|
||||
@ -548,12 +573,12 @@ global config, adapter default.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
11
|
||||
12
|
||||
13</pre>
|
||||
45
|
||||
46
|
||||
47</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/base.rb', line 11</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/base.rb', line 45</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_serializer'>serializer</span>
|
||||
<span class='ivar'>@serializer</span>
|
||||
@ -571,7 +596,37 @@ global config, adapter default.</p>
|
||||
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="default_key_transform-class_method">
|
||||
<h3 class="signature first" id="cache_key-class_method">
|
||||
|
||||
+ (<tt>Object</tt>) <strong>cache_key</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
37
|
||||
38
|
||||
39</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/base.rb', line 37</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_cache_key'>cache_key</span>
|
||||
<span class='ivar'>@cache_key</span> <span class='op'>||=</span> <span class='const'>ActiveModelSerializers</span><span class='op'>::</span><span class='const'>Adapter</span><span class='period'>.</span><span class='id identifier rubyid_registered_name'>registered_name</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="default_key_transform-class_method">
|
||||
|
||||
+ (<tt>Symbol</tt>) <strong>default_key_transform</strong>
|
||||
|
||||
@ -614,19 +669,49 @@ global config, adapter default.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
65
|
||||
66
|
||||
67</pre>
|
||||
14
|
||||
15
|
||||
16</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/base.rb', line 65</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/base.rb', line 14</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_default_key_transform'>default_key_transform</span>
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_default_key_transform'>default_key_transform</span>
|
||||
<span class='symbol'>:unaltered</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="fragment_cache-class_method">
|
||||
|
||||
+ (<tt>Object</tt>) <strong>fragment_cache</strong>(cached_hash, non_cached_hash)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
41
|
||||
42
|
||||
43</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/base.rb', line 41</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</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='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_cached_hash'>cached_hash</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
@ -731,15 +816,15 @@ global config, adapter default.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
74
|
||||
75
|
||||
76
|
||||
77</pre>
|
||||
23
|
||||
24
|
||||
25
|
||||
26</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/base.rb', line 74</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/base.rb', line 23</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_transform'>transform</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_transform'>transform</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
<span class='kw'>return</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:key_transform</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>&&</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:key_transform</span><span class='rbracket'>]</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_key_transform'>key_transform</span> <span class='op'>||</span> <span class='id identifier rubyid_default_key_transform'>default_key_transform</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
@ -828,14 +913,14 @@ global config, adapter default.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
84
|
||||
85
|
||||
86</pre>
|
||||
33
|
||||
34
|
||||
35</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/base.rb', line 84</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/base.rb', line 33</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_transform_key_casing!'>transform_key_casing!</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_transform_key_casing!'>transform_key_casing!</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
<span class='const'>KeyTransform</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_transform'>transform</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
@ -864,19 +949,15 @@ global config, adapter default.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
26
|
||||
27
|
||||
28
|
||||
29
|
||||
30</pre>
|
||||
58
|
||||
59
|
||||
60</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/base.rb', line 26</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/base.rb', line 58</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_as_json'>as_json</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_hash'>hash</span> <span class='op'>=</span> <span class='id identifier rubyid_serializable_hash'>serializable_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_include_meta'>include_meta</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_hash'>hash</span>
|
||||
<span class='id identifier rubyid_serializable_hash'>serializable_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
@ -884,9 +965,9 @@ global config, adapter default.</p>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="cache_check-instance_method">
|
||||
<h3 class="signature " id="cache_key-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>cache_check</strong>(serializer)
|
||||
- (<tt>Object</tt>) <strong>cache_key</strong>
|
||||
|
||||
|
||||
|
||||
@ -898,49 +979,15 @@ global config, adapter default.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
36
|
||||
37
|
||||
38
|
||||
39
|
||||
40</pre>
|
||||
62
|
||||
63
|
||||
64</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/base.rb', line 36</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/base.rb', line 62</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_cache_check'>cache_check</span><span class='lparen'>(</span><span class='id identifier rubyid_serializer'>serializer</span><span class='rparen'>)</span>
|
||||
<span class='const'>CachedSerializer</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_serializer'>serializer</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_cache_check'>cache_check</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span> <span class='kw'>do</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="cached_name-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>cached_name</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
18
|
||||
19
|
||||
20</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/base.rb', line 18</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_cached_name'>cached_name</span>
|
||||
<span class='ivar'>@cached_name</span> <span class='op'>||=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_demodulize'>demodulize</span><span class='period'>.</span><span class='id identifier rubyid_underscore'>underscore</span>
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_cache_key'>cache_key</span>
|
||||
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_cache_key'>cache_key</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
@ -962,15 +1009,15 @@ global config, adapter default.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
32
|
||||
33
|
||||
34</pre>
|
||||
66
|
||||
67
|
||||
68</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/base.rb', line 32</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/base.rb', line 66</span>
|
||||
|
||||
<span class='kw'>def</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='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_cached_hash'>cached_hash</span>
|
||||
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</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>
|
||||
@ -986,18 +1033,32 @@ global config, adapter default.</p>
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Subclasses that implement this method must first call</p>
|
||||
|
||||
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='id identifier rubyid_serialization_options'>serialization_options</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
</code></pre>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
22
|
||||
23
|
||||
24</pre>
|
||||
54
|
||||
55
|
||||
56</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/base.rb', line 22</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/base.rb', line 54</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_serializable_hash'>serializable_hash</span><span class='lparen'>(</span><span class='id identifier rubyid__options'>_options</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>This is an abstract method. Should be implemented at the concrete adapter.</span><span class='tstring_end'>'</span></span>
|
||||
@ -1012,9 +1073,9 @@ global config, adapter default.</p>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:39 2016 by
|
||||
Generated on Mon Jun 13 21:53:39 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -128,6 +128,50 @@
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#meta-instance_method" title="#meta (instance method)">- (Object) <strong>meta</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#meta_key-instance_method" title="#meta_key (instance method)">- (Object) <strong>meta_key</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#serializable_hash-instance_method" title="#serializable_hash (instance method)">- (Object) <strong>serializable_hash</strong>(options = nil) </a>
|
||||
|
||||
|
||||
@ -160,7 +204,7 @@
|
||||
|
||||
|
||||
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="ActiveModelSerializers::Adapter::Base (class)">Base</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="Base.html#as_json-instance_method" title="ActiveModelSerializers::Adapter::Base#as_json (method)">#as_json</a></span>, <span class='object_link'><a href="Base.html#cache_check-instance_method" title="ActiveModelSerializers::Adapter::Base#cache_check (method)">#cache_check</a></span>, <span class='object_link'><a href="Base.html#cached_name-instance_method" title="ActiveModelSerializers::Adapter::Base#cached_name (method)">#cached_name</a></span>, <span class='object_link'><a href="Base.html#default_key_transform-class_method" title="ActiveModelSerializers::Adapter::Base.default_key_transform (method)">default_key_transform</a></span>, <span class='object_link'><a href="Base.html#fragment_cache-instance_method" title="ActiveModelSerializers::Adapter::Base#fragment_cache (method)">#fragment_cache</a></span>, <span class='object_link'><a href="Base.html#inherited-class_method" title="ActiveModelSerializers::Adapter::Base.inherited (method)">inherited</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="ActiveModelSerializers::Adapter::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#transform-class_method" title="ActiveModelSerializers::Adapter::Base.transform (method)">transform</a></span>, <span class='object_link'><a href="Base.html#transform_key_casing%21-class_method" title="ActiveModelSerializers::Adapter::Base.transform_key_casing! (method)">transform_key_casing!</a></span></p>
|
||||
<p class="inherited"><span class='object_link'><a href="Base.html#as_json-instance_method" title="ActiveModelSerializers::Adapter::Base#as_json (method)">#as_json</a></span>, <span class='object_link'><a href="Base.html#cache_key-class_method" title="ActiveModelSerializers::Adapter::Base.cache_key (method)">cache_key</a></span>, <span class='object_link'><a href="Base.html#cache_key-instance_method" title="ActiveModelSerializers::Adapter::Base#cache_key (method)">#cache_key</a></span>, <span class='object_link'><a href="Base.html#default_key_transform-class_method" title="ActiveModelSerializers::Adapter::Base.default_key_transform (method)">default_key_transform</a></span>, <span class='object_link'><a href="Base.html#fragment_cache-instance_method" title="ActiveModelSerializers::Adapter::Base#fragment_cache (method)">#fragment_cache</a></span>, <span class='object_link'><a href="Base.html#fragment_cache-class_method" title="ActiveModelSerializers::Adapter::Base.fragment_cache (method)">fragment_cache</a></span>, <span class='object_link'><a href="Base.html#inherited-class_method" title="ActiveModelSerializers::Adapter::Base.inherited (method)">inherited</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="ActiveModelSerializers::Adapter::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#transform-class_method" title="ActiveModelSerializers::Adapter::Base.transform (method)">transform</a></span>, <span class='object_link'><a href="Base.html#transform_key_casing%21-class_method" title="ActiveModelSerializers::Adapter::Base.transform_key_casing! (method)">transform_key_casing!</a></span></p>
|
||||
<div id="constructor_details" class="method_details_list">
|
||||
<h2>Constructor Details</h2>
|
||||
|
||||
@ -174,7 +218,67 @@
|
||||
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="serializable_hash-instance_method">
|
||||
<h3 class="signature first" id="meta-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>meta</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
12
|
||||
13
|
||||
14</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/json.rb', line 12</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_meta'>meta</span>
|
||||
<span class='id identifier rubyid_instance_options'>instance_options</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:meta</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="meta_key-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>meta_key</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
16
|
||||
17
|
||||
18</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/json.rb', line 16</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_meta_key'>meta_key</span>
|
||||
<span class='id identifier rubyid_instance_options'>instance_options</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:meta_key</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>meta</span><span class='tstring_end'>'</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="serializable_hash-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>serializable_hash</strong>(options = nil)
|
||||
|
||||
@ -192,15 +296,19 @@
|
||||
5
|
||||
6
|
||||
7
|
||||
8</pre>
|
||||
8
|
||||
9
|
||||
10</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/json.rb', line 4</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_serializable_hash'>serializable_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_options'>options</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
||||
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='id identifier rubyid_serialization_options'>serialization_options</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_serialized_hash'>serialized_hash</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_root'>root</span> <span class='op'>=></span> <span class='const'>Attributes</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_serializer'>serializer</span><span class='comma'>,</span> <span class='id identifier rubyid_instance_options'>instance_options</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_serializable_hash'>serializable_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
||||
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_transform_key_casing!'>transform_key_casing!</span><span class='lparen'>(</span><span class='id identifier rubyid_serialized_hash'>serialized_hash</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_serialized_hash'>serialized_hash</span><span class='lbracket'>[</span><span class='id identifier rubyid_meta_key'>meta_key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_meta'>meta</span> <span class='kw'>unless</span> <span class='id identifier rubyid_meta'>meta</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span>
|
||||
|
||||
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_transform_key_casing!'>transform_key_casing!</span><span class='lparen'>(</span><span class='id identifier rubyid_serialized_hash'>serialized_hash</span><span class='comma'>,</span> <span class='id identifier rubyid_instance_options'>instance_options</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
@ -212,9 +320,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:39 2016 by
|
||||
Generated on Mon Jun 13 21:53:39 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -101,7 +101,7 @@
|
||||
|
||||
<dt class="r1 last">Defined in:</dt>
|
||||
<dd class="r1 last">lib/active_model_serializers/adapter/json_api.rb<span class="defines">,<br />
|
||||
lib/active_model_serializers/adapter/json_api/meta.rb,<br /> lib/active_model_serializers/adapter/json_api/link.rb,<br /> lib/active_model_serializers/adapter/json_api/error.rb,<br /> lib/active_model_serializers/adapter/json_api/jsonapi.rb,<br /> lib/active_model_serializers/adapter/json_api/relationship.rb,<br /> lib/active_model_serializers/adapter/json_api/deserialization.rb,<br /> lib/active_model_serializers/adapter/json_api/pagination_links.rb,<br /> lib/active_model_serializers/adapter/json_api/resource_identifier.rb</span>
|
||||
lib/active_model_serializers/adapter/json_api/link.rb,<br /> lib/active_model_serializers/adapter/json_api/meta.rb,<br /> lib/active_model_serializers/adapter/json_api/error.rb,<br /> lib/active_model_serializers/adapter/json_api/jsonapi.rb,<br /> lib/active_model_serializers/adapter/json_api/relationship.rb,<br /> lib/active_model_serializers/adapter/json_api/deserialization.rb,<br /> lib/active_model_serializers/adapter/json_api/pagination_links.rb,<br /> lib/active_model_serializers/adapter/json_api/resource_identifier.rb</span>
|
||||
</dd>
|
||||
|
||||
</dl>
|
||||
@ -160,6 +160,28 @@
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#fragment_cache-class_method" title="fragment_cache (class method)">+ (Object) <strong>fragment_cache</strong>(cached_hash, non_cached_hash, root = true) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
@ -177,7 +199,7 @@
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#failure_document-instance_method" title="#failure_document (instance method)">- (Object) <strong>failure_document</strong>(options) </a>
|
||||
<a href="#failure_document-instance_method" title="#failure_document (instance method)">- (Object) <strong>failure_document</strong> </a>
|
||||
|
||||
|
||||
|
||||
@ -253,7 +275,7 @@ prs: https://github.com/rails-api/active_model_serializers/pull/1004.</p>
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#serializable_hash-instance_method" title="#serializable_hash (instance method)">- (Object) <strong>serializable_hash</strong>(options = nil) </a>
|
||||
<a href="#serializable_hash-instance_method" title="#serializable_hash (instance method)">- (Object) <strong>serializable_hash</strong> </a>
|
||||
|
||||
|
||||
|
||||
@ -277,7 +299,7 @@ prs: https://github.com/rails-api/active_model_serializers/pull/1004.</p>
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#success_document-instance_method" title="#success_document (instance method)">- (Object) <strong>success_document</strong>(options) </a>
|
||||
<a href="#success_document-instance_method" title="#success_document (instance method)">- (Object) <strong>success_document</strong> </a>
|
||||
|
||||
|
||||
|
||||
@ -296,7 +318,8 @@ prs: https://github.com/rails-api/active_model_serializers/pull/1004.</p>
|
||||
☐ toplevel_data (required) ☐ toplevel_included ☑ toplevel_meta ☑
|
||||
toplevel_links ☑ toplevel_jsonapi structure: { data: toplevel_data,
|
||||
included: toplevel_included, meta: toplevel_meta, links:
|
||||
toplevel_links, jsonapi: toplevel_jsonapi }.reject! {|_,v| v.nil? }.</p>
|
||||
toplevel_links, jsonapi: toplevel_jsonapi }.reject! {|_,v| v.nil? }
|
||||
rubocop:disable Metrics/CyclomaticComplexity.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
@ -316,7 +339,7 @@ toplevel_links, jsonapi: toplevel_jsonapi }.reject! {|_,v| v.nil? }.</p>
|
||||
|
||||
|
||||
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="ActiveModelSerializers::Adapter::Base (class)">Base</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="Base.html#as_json-instance_method" title="ActiveModelSerializers::Adapter::Base#as_json (method)">#as_json</a></span>, <span class='object_link'><a href="Base.html#cache_check-instance_method" title="ActiveModelSerializers::Adapter::Base#cache_check (method)">#cache_check</a></span>, <span class='object_link'><a href="Base.html#cached_name-instance_method" title="ActiveModelSerializers::Adapter::Base#cached_name (method)">#cached_name</a></span>, <span class='object_link'><a href="Base.html#inherited-class_method" title="ActiveModelSerializers::Adapter::Base.inherited (method)">inherited</a></span>, <span class='object_link'><a href="Base.html#transform-class_method" title="ActiveModelSerializers::Adapter::Base.transform (method)">transform</a></span>, <span class='object_link'><a href="Base.html#transform_key_casing%21-class_method" title="ActiveModelSerializers::Adapter::Base.transform_key_casing! (method)">transform_key_casing!</a></span></p>
|
||||
<p class="inherited"><span class='object_link'><a href="Base.html#as_json-instance_method" title="ActiveModelSerializers::Adapter::Base#as_json (method)">#as_json</a></span>, <span class='object_link'><a href="Base.html#cache_key-instance_method" title="ActiveModelSerializers::Adapter::Base#cache_key (method)">#cache_key</a></span>, <span class='object_link'><a href="Base.html#cache_key-class_method" title="ActiveModelSerializers::Adapter::Base.cache_key (method)">cache_key</a></span>, <span class='object_link'><a href="Base.html#inherited-class_method" title="ActiveModelSerializers::Adapter::Base.inherited (method)">inherited</a></span>, <span class='object_link'><a href="Base.html#transform-class_method" title="ActiveModelSerializers::Adapter::Base.transform (method)">transform</a></span>, <span class='object_link'><a href="Base.html#transform_key_casing%21-class_method" title="ActiveModelSerializers::Adapter::Base.transform_key_casing! (method)">transform_key_casing!</a></span></p>
|
||||
<div id="constructor_details" class="method_details_list">
|
||||
<h2>Constructor Details</h2>
|
||||
|
||||
@ -346,18 +369,18 @@ toplevel_links, jsonapi: toplevel_jsonapi }.reject! {|_,v| v.nil? }.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
34
|
||||
35
|
||||
36
|
||||
37
|
||||
38</pre>
|
||||
49
|
||||
50
|
||||
51
|
||||
52
|
||||
53</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/json_api.rb', line 34</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/json_api.rb', line 49</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_serializer'>serializer</span><span class='comma'>,</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'>super</span>
|
||||
<span class='ivar'>@include_tree</span> <span class='op'>=</span> <span class='const'>ActiveModel</span><span class='op'>::</span><span class='const'>Serializer</span><span class='op'>::</span><span class='const'>IncludeTree</span><span class='period'>.</span><span class='id identifier rubyid_from_include_args'>from_include_args</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
||||
<span class='ivar'>@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_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>allow_wildcard:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
||||
<span class='ivar'>@fieldset</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:fieldset</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='const'>ActiveModel</span><span class='op'>::</span><span class='const'>Serializer</span><span class='op'>::</span><span class='const'>Fieldset</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</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'>:fields</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
@ -387,12 +410,12 @@ toplevel_links, jsonapi: toplevel_jsonapi }.reject! {|_,v| v.nil? }.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
40
|
||||
41
|
||||
42</pre>
|
||||
34
|
||||
35
|
||||
36</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/json_api.rb', line 40</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/json_api.rb', line 34</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_default_key_transform'>default_key_transform</span>
|
||||
<span class='symbol'>:dash</span>
|
||||
@ -400,6 +423,50 @@ toplevel_links, jsonapi: toplevel_jsonapi }.reject! {|_,v| v.nil? }.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="fragment_cache-class_method">
|
||||
|
||||
+ (<tt>Object</tt>) <strong>fragment_cache</strong>(cached_hash, non_cached_hash, root = true)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
38
|
||||
39
|
||||
40
|
||||
41
|
||||
42
|
||||
43
|
||||
44
|
||||
45
|
||||
46
|
||||
47</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/json_api.rb', line 38</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</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='comma'>,</span> <span class='id identifier rubyid_root'>root</span> <span class='op'>=</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_core_cached'>core_cached</span> <span class='op'>=</span> <span class='id identifier rubyid_cached_hash'>cached_hash</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
|
||||
<span class='id identifier rubyid_core_non_cached'>core_non_cached</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_first'>first</span>
|
||||
<span class='id identifier rubyid_no_root_cache'>no_root_cache</span> <span class='op'>=</span> <span class='id identifier rubyid_cached_hash'>cached_hash</span><span class='period'>.</span><span class='id identifier rubyid_delete_if'>delete_if</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid__value'>_value</span><span class='op'>|</span> <span class='id identifier rubyid_key'>key</span> <span class='op'>==</span> <span class='id identifier rubyid_core_cached'>core_cached</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='rbrace'>}</span>
|
||||
<span class='id identifier rubyid_no_root_non_cache'>no_root_non_cache</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_delete_if'>delete_if</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid__value'>_value</span><span class='op'>|</span> <span class='id identifier rubyid_key'>key</span> <span class='op'>==</span> <span class='id identifier rubyid_core_non_cached'>core_non_cached</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='rbrace'>}</span>
|
||||
<span class='id identifier rubyid_cached_resource'>cached_resource</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_core_cached'>core_cached</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_core_cached'>core_cached</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_deep_merge'>deep_merge</span><span class='lparen'>(</span><span class='id identifier rubyid_core_non_cached'>core_non_cached</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id identifier rubyid_core_non_cached'>core_non_cached</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
|
||||
<span class='id identifier rubyid_hash'>hash</span> <span class='op'>=</span> <span class='id identifier rubyid_root'>root</span> <span class='op'>?</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_root'>root</span> <span class='op'>=></span> <span class='id identifier rubyid_cached_resource'>cached_resource</span> <span class='rbrace'>}</span> <span class='op'>:</span> <span class='id identifier rubyid_cached_resource'>cached_resource</span>
|
||||
|
||||
<span class='id identifier rubyid_hash'>hash</span><span class='period'>.</span><span class='id identifier rubyid_deep_merge'>deep_merge</span> <span class='id identifier rubyid_no_root_non_cache'>no_root_non_cache</span><span class='period'>.</span><span class='id identifier rubyid_deep_merge'>deep_merge</span> <span class='id identifier rubyid_no_root_cache'>no_root_cache</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@ -411,7 +478,7 @@ toplevel_links, jsonapi: toplevel_jsonapi }.reject! {|_,v| v.nil? }.</p>
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="failure_document-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>failure_document</strong>(options)
|
||||
- (<tt>Object</tt>) <strong>failure_document</strong>
|
||||
|
||||
|
||||
|
||||
@ -454,33 +521,33 @@ definition:</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
151
|
||||
152
|
||||
153
|
||||
154
|
||||
155
|
||||
156
|
||||
157
|
||||
158
|
||||
159
|
||||
160
|
||||
161
|
||||
162
|
||||
163
|
||||
164
|
||||
165
|
||||
166
|
||||
167
|
||||
168
|
||||
169
|
||||
170
|
||||
171
|
||||
172</pre>
|
||||
172
|
||||
173
|
||||
174
|
||||
175
|
||||
176
|
||||
177
|
||||
178
|
||||
179
|
||||
180
|
||||
181
|
||||
182
|
||||
183
|
||||
184
|
||||
185
|
||||
186
|
||||
187
|
||||
188
|
||||
189
|
||||
190
|
||||
191</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/json_api.rb', line 151</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/json_api.rb', line 170</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_failure_document'>failure_document</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_failure_document'>failure_document</span>
|
||||
<span class='id identifier rubyid_hash'>hash</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
||||
<span class='comment'># PR Please :)
|
||||
</span> <span class='comment'># Jsonapi.add!(hash)
|
||||
@ -495,10 +562,10 @@ definition:</p>
|
||||
</span> <span class='comment'># ]
|
||||
</span> <span class='kw'>if</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_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:errors</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_serializer'>serializer</span><span class='period'>.</span><span class='id identifier rubyid_flat_map'>flat_map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_error_serializer'>error_serializer</span><span class='op'>|</span>
|
||||
<span class='const'>Error</span><span class='period'>.</span><span class='id identifier rubyid_resource_errors'>resource_errors</span><span class='lparen'>(</span><span class='id identifier rubyid_error_serializer'>error_serializer</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
<span class='const'>Error</span><span class='period'>.</span><span class='id identifier rubyid_resource_errors'>resource_errors</span><span class='lparen'>(</span><span class='id identifier rubyid_error_serializer'>error_serializer</span><span class='comma'>,</span> <span class='id identifier rubyid_instance_options'>instance_options</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span>
|
||||
<span class='kw'>else</span>
|
||||
<span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:errors</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>Error</span><span class='period'>.</span><span class='id identifier rubyid_resource_errors'>resource_errors</span><span class='lparen'>(</span><span class='id identifier rubyid_serializer'>serializer</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:errors</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>Error</span><span class='period'>.</span><span class='id identifier rubyid_resource_errors'>resource_errors</span><span class='lparen'>(</span><span class='id identifier rubyid_serializer'>serializer</span><span class='comma'>,</span> <span class='id identifier rubyid_instance_options'>instance_options</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span>
|
||||
<span class='id identifier rubyid_hash'>hash</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
@ -522,31 +589,17 @@ definition:</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
174
|
||||
175
|
||||
176
|
||||
177
|
||||
178
|
||||
179
|
||||
180
|
||||
181
|
||||
182
|
||||
183
|
||||
184</pre>
|
||||
66
|
||||
67
|
||||
68
|
||||
69</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/json_api.rb', line 174</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/json_api.rb', line 66</span>
|
||||
|
||||
<span class='kw'>def</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='id identifier rubyid_root'>root</span> <span class='op'>=</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_instance_options'>instance_options</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='symbol'>:include</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_core_cached'>core_cached</span> <span class='op'>=</span> <span class='id identifier rubyid_cached_hash'>cached_hash</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
|
||||
<span class='id identifier rubyid_core_non_cached'>core_non_cached</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_first'>first</span>
|
||||
<span class='id identifier rubyid_no_root_cache'>no_root_cache</span> <span class='op'>=</span> <span class='id identifier rubyid_cached_hash'>cached_hash</span><span class='period'>.</span><span class='id identifier rubyid_delete_if'>delete_if</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid__value'>_value</span><span class='op'>|</span> <span class='id identifier rubyid_key'>key</span> <span class='op'>==</span> <span class='id identifier rubyid_core_cached'>core_cached</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='rbrace'>}</span>
|
||||
<span class='id identifier rubyid_no_root_non_cache'>no_root_non_cache</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_delete_if'>delete_if</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid__value'>_value</span><span class='op'>|</span> <span class='id identifier rubyid_key'>key</span> <span class='op'>==</span> <span class='id identifier rubyid_core_non_cached'>core_non_cached</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='rbrace'>}</span>
|
||||
<span class='id identifier rubyid_cached_resource'>cached_resource</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_core_cached'>core_cached</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_core_cached'>core_cached</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_deep_merge'>deep_merge</span><span class='lparen'>(</span><span class='id identifier rubyid_core_non_cached'>core_non_cached</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id identifier rubyid_core_non_cached'>core_non_cached</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
|
||||
<span class='id identifier rubyid_hash'>hash</span> <span class='op'>=</span> <span class='id identifier rubyid_root'>root</span> <span class='op'>?</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_root'>root</span> <span class='op'>=></span> <span class='id identifier rubyid_cached_resource'>cached_resource</span> <span class='rbrace'>}</span> <span class='op'>:</span> <span class='id identifier rubyid_cached_resource'>cached_resource</span>
|
||||
|
||||
<span class='id identifier rubyid_hash'>hash</span><span class='period'>.</span><span class='id identifier rubyid_deep_merge'>deep_merge</span> <span class='id identifier rubyid_no_root_non_cache'>no_root_non_cache</span><span class='period'>.</span><span class='id identifier rubyid_deep_merge'>deep_merge</span> <span class='id identifier rubyid_no_root_cache'>no_root_cache</span>
|
||||
<span class='id identifier rubyid_root'>root</span> <span class='op'>=</span> <span class='op'>!</span><span class='id identifier rubyid_instance_options'>instance_options</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='symbol'>:include</span><span class='rparen'>)</span>
|
||||
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</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='comma'>,</span> <span class='id identifier rubyid_root'>root</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
@ -556,7 +609,7 @@ definition:</p>
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="serializable_hash-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>serializable_hash</strong>(options = nil)
|
||||
- (<tt>Object</tt>) <strong>serializable_hash</strong>
|
||||
|
||||
|
||||
|
||||
@ -579,27 +632,25 @@ definition:</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
46
|
||||
47
|
||||
48
|
||||
49
|
||||
50
|
||||
51
|
||||
52
|
||||
53
|
||||
54</pre>
|
||||
57
|
||||
58
|
||||
59
|
||||
60
|
||||
61
|
||||
62
|
||||
63
|
||||
64</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/json_api.rb', line 46</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/json_api.rb', line 57</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_serializable_hash'>serializable_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_options'>options</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_serializable_hash'>serializable_hash</span><span class='lparen'>(</span><span class='op'>*</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_document'>document</span> <span class='op'>=</span> <span class='kw'>if</span> <span class='id identifier rubyid_serializer'>serializer</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
|
||||
<span class='id identifier rubyid_success_document'>success_document</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_success_document'>success_document</span>
|
||||
<span class='kw'>else</span>
|
||||
<span class='id identifier rubyid_failure_document'>failure_document</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_failure_document'>failure_document</span>
|
||||
<span class='kw'>end</span>
|
||||
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_transform_key_casing!'>transform_key_casing!</span><span class='lparen'>(</span><span class='id identifier rubyid_document'>document</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_transform_key_casing!'>transform_key_casing!</span><span class='lparen'>(</span><span class='id identifier rubyid_document'>document</span><span class='comma'>,</span> <span class='id identifier rubyid_instance_options'>instance_options</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
@ -609,7 +660,7 @@ definition:</p>
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="success_document-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>success_document</strong>(options)
|
||||
- (<tt>Object</tt>) <strong>success_document</strong>
|
||||
|
||||
|
||||
|
||||
@ -638,6 +689,8 @@ definition:</p>
|
||||
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_reject!'>reject!</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid__'>_</span><span class='comma'>,</span><span class='id identifier rubyid_v'>v</span><span class='op'>|</span> <span class='id identifier rubyid_v'>v</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='rbrace'>}</span>
|
||||
</code></pre>
|
||||
|
||||
<p>rubocop:disable Metrics/CyclomaticComplexity</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@ -650,22 +703,6 @@ definition:</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
71
|
||||
72
|
||||
73
|
||||
74
|
||||
75
|
||||
76
|
||||
77
|
||||
78
|
||||
79
|
||||
80
|
||||
81
|
||||
82
|
||||
83
|
||||
84
|
||||
85
|
||||
86
|
||||
87
|
||||
88
|
||||
89
|
||||
@ -714,15 +751,33 @@ definition:</p>
|
||||
132
|
||||
133
|
||||
134
|
||||
135</pre>
|
||||
135
|
||||
136
|
||||
137
|
||||
138
|
||||
139
|
||||
140
|
||||
141
|
||||
142
|
||||
143
|
||||
144
|
||||
145
|
||||
146
|
||||
147
|
||||
148
|
||||
149
|
||||
150
|
||||
151
|
||||
152
|
||||
153</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/json_api.rb', line 71</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/json_api.rb', line 87</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_success_document'>success_document</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_success_document'>success_document</span>
|
||||
<span class='id identifier rubyid_is_collection'>is_collection</span> <span class='op'>=</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_serializers'>serializers</span> <span class='op'>=</span> <span class='id identifier rubyid_is_collection'>is_collection</span> <span class='op'>?</span> <span class='id identifier rubyid_serializer'>serializer</span> <span class='op'>:</span> <span class='lbracket'>[</span><span class='id identifier rubyid_serializer'>serializer</span><span class='rbracket'>]</span>
|
||||
<span class='id identifier rubyid_primary_data'>primary_data</span><span class='comma'>,</span> <span class='id identifier rubyid_included'>included</span> <span class='op'>=</span> <span class='id identifier rubyid_resource_objects_for'>resource_objects_for</span><span class='lparen'>(</span><span class='id identifier rubyid_serializers'>serializers</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_primary_data'>primary_data</span><span class='comma'>,</span> <span class='id identifier rubyid_included'>included</span> <span class='op'>=</span> <span class='id identifier rubyid_resource_objects_for'>resource_objects_for</span><span class='lparen'>(</span><span class='id identifier rubyid_serializers'>serializers</span><span class='rparen'>)</span>
|
||||
|
||||
<span class='id identifier rubyid_hash'>hash</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
||||
<span class='comment'># toplevel_data
|
||||
@ -779,9 +834,11 @@ definition:</p>
|
||||
|
||||
<span class='kw'>if</span> <span class='id identifier rubyid_is_collection'>is_collection</span> <span class='op'>&&</span> <span class='id identifier rubyid_serializer'>serializer</span><span class='period'>.</span><span class='id identifier rubyid_paginated?'>paginated?</span>
|
||||
<span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:links</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
||||
<span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:links</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_pagination_links_for'>pagination_links_for</span><span class='lparen'>(</span><span class='id identifier rubyid_serializer'>serializer</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:links</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_pagination_links_for'>pagination_links_for</span><span class='lparen'>(</span><span class='id identifier rubyid_serializer'>serializer</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span>
|
||||
|
||||
<span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:meta</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_instance_options'>instance_options</span><span class='lbracket'>[</span><span class='symbol'>:meta</span><span class='rbracket'>]</span> <span class='kw'>unless</span> <span class='id identifier rubyid_instance_options'>instance_options</span><span class='lbracket'>[</span><span class='symbol'>:meta</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span>
|
||||
|
||||
<span class='id identifier rubyid_hash'>hash</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
@ -794,9 +851,9 @@ definition:</p>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:40 2016 by
|
||||
Generated on Mon Jun 13 21:53:39 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -1050,9 +1050,9 @@ value.</p>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:37 2016 by
|
||||
Generated on Mon Jun 13 21:53:37 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -462,9 +462,9 @@ parameter: A string indicating which query parameter caused the error</code></pr
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:37 2016 by
|
||||
Generated on Mon Jun 13 21:53:37 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -356,9 +356,9 @@ meta</code></pre>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:37 2016 by
|
||||
Generated on Mon Jun 13 21:53:37 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -390,7 +390,7 @@ meta</code></pre>
|
||||
<span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:href</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@href</span> <span class='kw'>if</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='ivar'>@href</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:meta</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@meta</span> <span class='kw'>if</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='ivar'>@meta</span><span class='rparen'>)</span>
|
||||
|
||||
<span class='id identifier rubyid_hash'>hash</span>
|
||||
<span class='id identifier rubyid_hash'>hash</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span> <span class='op'>?</span> <span class='id identifier rubyid_hash'>hash</span> <span class='op'>:</span> <span class='kw'>nil</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
@ -466,9 +466,9 @@ meta</code></pre>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:41 2016 by
|
||||
Generated on Mon Jun 13 21:53:40 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -292,9 +292,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:41 2016 by
|
||||
Generated on Mon Jun 13 21:53:40 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -192,7 +192,29 @@
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#initialize-instance_method" title="#initialize (instance method)">- (PaginationLinks) <strong>initialize</strong>(collection, context) </a>
|
||||
<a href="#as_json-instance_method" title="#as_json (instance method)">- (Object) <strong>as_json</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#initialize-instance_method" title="#initialize (instance method)">- (PaginationLinks) <strong>initialize</strong>(collection, adapter_options) </a>
|
||||
|
||||
|
||||
|
||||
@ -212,28 +234,6 @@
|
||||
<p>A new instance of PaginationLinks.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#serializable_hash-instance_method" title="#serializable_hash (instance method)">- (Object) <strong>serializable_hash</strong>(options = {}) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
@ -246,7 +246,7 @@
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="initialize-instance_method">
|
||||
|
||||
- (<tt><span class='object_link'><a href="" title="ActiveModelSerializers::Adapter::JsonApi::PaginationLinks (class)">PaginationLinks</a></span></tt>) <strong>initialize</strong>(collection, context)
|
||||
- (<tt><span class='object_link'><a href="" title="ActiveModelSerializers::Adapter::JsonApi::PaginationLinks (class)">PaginationLinks</a></span></tt>) <strong>initialize</strong>(collection, adapter_options)
|
||||
|
||||
|
||||
|
||||
@ -272,14 +272,16 @@
|
||||
9
|
||||
10
|
||||
11
|
||||
12</pre>
|
||||
12
|
||||
13</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/json_api/pagination_links.rb', line 9</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_collection'>collection</span><span class='comma'>,</span> <span class='id identifier rubyid_context'>context</span><span class='rparen'>)</span>
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_collection'>collection</span><span class='comma'>,</span> <span class='id identifier rubyid_adapter_options'>adapter_options</span><span class='rparen'>)</span>
|
||||
<span class='ivar'>@collection</span> <span class='op'>=</span> <span class='id identifier rubyid_collection'>collection</span>
|
||||
<span class='ivar'>@context</span> <span class='op'>=</span> <span class='id identifier rubyid_context'>context</span>
|
||||
<span class='ivar'>@adapter_options</span> <span class='op'>=</span> <span class='id identifier rubyid_adapter_options'>adapter_options</span>
|
||||
<span class='ivar'>@context</span> <span class='op'>=</span> <span class='id identifier rubyid_adapter_options'>adapter_options</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:serialization_context</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
@ -385,9 +387,9 @@
|
||||
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="serializable_hash-instance_method">
|
||||
<h3 class="signature first" id="as_json-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>serializable_hash</strong>(options = {})
|
||||
- (<tt>Object</tt>) <strong>as_json</strong>
|
||||
|
||||
|
||||
|
||||
@ -399,24 +401,24 @@
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
14
|
||||
15
|
||||
16
|
||||
17
|
||||
18
|
||||
19
|
||||
20
|
||||
21</pre>
|
||||
21
|
||||
22</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/json_api/pagination_links.rb', line 14</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/json_api/pagination_links.rb', line 15</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_serializable_hash'>serializable_hash</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'>def</span> <span class='id identifier rubyid_as_json'>as_json</span>
|
||||
<span class='id identifier rubyid_per_page'>per_page</span> <span class='op'>=</span> <span class='id identifier rubyid_collection'>collection</span><span class='period'>.</span><span class='id identifier rubyid_try'>try</span><span class='lparen'>(</span><span class='symbol'>:per_page</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_collection'>collection</span><span class='period'>.</span><span class='id identifier rubyid_try'>try</span><span class='lparen'>(</span><span class='symbol'>:limit_value</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_collection'>collection</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span>
|
||||
<span class='id identifier rubyid_pages_from'>pages_from</span><span class='period'>.</span><span class='id identifier rubyid_each_with_object'>each_with_object</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_hash'>hash</span><span class='op'>|</span>
|
||||
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_query_parameters'>query_parameters</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='label'>page:</span> <span class='lbrace'>{</span> <span class='label'>number:</span> <span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='label'>size:</span> <span class='id identifier rubyid_per_page'>per_page</span> <span class='rbrace'>}</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_query'>to_query</span>
|
||||
|
||||
<span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_url'>url</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>?</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
||||
<span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_url'>url</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter_options'>adapter_options</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>?</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
||||
<span class='kw'>end</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
@ -429,9 +431,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:41 2016 by
|
||||
Generated on Mon Jun 13 21:53:40 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -287,9 +287,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:41 2016 by
|
||||
Generated on Mon Jun 13 21:53:40 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -255,9 +255,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:41 2016 by
|
||||
Generated on Mon Jun 13 21:53:40 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -128,7 +128,7 @@
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#serializable_hash-instance_method" title="#serializable_hash (instance method)">- (Object) <strong>serializable_hash</strong>(_options = nil) </a>
|
||||
<a href="#serializable_hash-instance_method" title="#serializable_hash (instance method)">- (Object) <strong>serializable_hash</strong> </a>
|
||||
|
||||
|
||||
|
||||
@ -142,9 +142,7 @@
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Since options param is not being used, underscored naming of the param.</p>
|
||||
</div></span>
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
@ -162,7 +160,7 @@
|
||||
|
||||
|
||||
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="ActiveModelSerializers::Adapter::Base (class)">Base</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="Base.html#as_json-instance_method" title="ActiveModelSerializers::Adapter::Base#as_json (method)">#as_json</a></span>, <span class='object_link'><a href="Base.html#cache_check-instance_method" title="ActiveModelSerializers::Adapter::Base#cache_check (method)">#cache_check</a></span>, <span class='object_link'><a href="Base.html#cached_name-instance_method" title="ActiveModelSerializers::Adapter::Base#cached_name (method)">#cached_name</a></span>, <span class='object_link'><a href="Base.html#default_key_transform-class_method" title="ActiveModelSerializers::Adapter::Base.default_key_transform (method)">default_key_transform</a></span>, <span class='object_link'><a href="Base.html#fragment_cache-instance_method" title="ActiveModelSerializers::Adapter::Base#fragment_cache (method)">#fragment_cache</a></span>, <span class='object_link'><a href="Base.html#inherited-class_method" title="ActiveModelSerializers::Adapter::Base.inherited (method)">inherited</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="ActiveModelSerializers::Adapter::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#transform-class_method" title="ActiveModelSerializers::Adapter::Base.transform (method)">transform</a></span>, <span class='object_link'><a href="Base.html#transform_key_casing%21-class_method" title="ActiveModelSerializers::Adapter::Base.transform_key_casing! (method)">transform_key_casing!</a></span></p>
|
||||
<p class="inherited"><span class='object_link'><a href="Base.html#as_json-instance_method" title="ActiveModelSerializers::Adapter::Base#as_json (method)">#as_json</a></span>, <span class='object_link'><a href="Base.html#cache_key-class_method" title="ActiveModelSerializers::Adapter::Base.cache_key (method)">cache_key</a></span>, <span class='object_link'><a href="Base.html#cache_key-instance_method" title="ActiveModelSerializers::Adapter::Base#cache_key (method)">#cache_key</a></span>, <span class='object_link'><a href="Base.html#default_key_transform-class_method" title="ActiveModelSerializers::Adapter::Base.default_key_transform (method)">default_key_transform</a></span>, <span class='object_link'><a href="Base.html#fragment_cache-instance_method" title="ActiveModelSerializers::Adapter::Base#fragment_cache (method)">#fragment_cache</a></span>, <span class='object_link'><a href="Base.html#fragment_cache-class_method" title="ActiveModelSerializers::Adapter::Base.fragment_cache (method)">fragment_cache</a></span>, <span class='object_link'><a href="Base.html#inherited-class_method" title="ActiveModelSerializers::Adapter::Base.inherited (method)">inherited</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="ActiveModelSerializers::Adapter::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#transform-class_method" title="ActiveModelSerializers::Adapter::Base.transform (method)">transform</a></span>, <span class='object_link'><a href="Base.html#transform_key_casing%21-class_method" title="ActiveModelSerializers::Adapter::Base.transform_key_casing! (method)">transform_key_casing!</a></span></p>
|
||||
<div id="constructor_details" class="method_details_list">
|
||||
<h2>Constructor Details</h2>
|
||||
|
||||
@ -178,37 +176,26 @@
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="serializable_hash-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>serializable_hash</strong>(_options = nil)
|
||||
- (<tt>Object</tt>) <strong>serializable_hash</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Since options param is not being used, underscored naming of the param</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
</h3><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
4
|
||||
5
|
||||
6
|
||||
7</pre>
|
||||
6</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/null.rb', line 5</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/adapter/null.rb', line 4</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_serializable_hash'>serializable_hash</span><span class='lparen'>(</span><span class='id identifier rubyid__options'>_options</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_serializable_hash'>serializable_hash</span><span class='lparen'>(</span><span class='op'>*</span><span class='rparen'>)</span>
|
||||
<span class='lbrace'>{</span><span class='rbrace'>}</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
@ -221,9 +208,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:39 2016 by
|
||||
Generated on Mon Jun 13 21:53:39 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -1,843 +0,0 @@
|
||||
<!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>
|
||||
Class: ActiveModelSerializers::CachedSerializer
|
||||
|
||||
— 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/CachedSerializer.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> »
|
||||
<span class='title'><span class='object_link'><a href="../ActiveModelSerializers.html" title="ActiveModelSerializers (module)">ActiveModelSerializers</a></span></span>
|
||||
»
|
||||
<span class="title">CachedSerializer</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>Class: ActiveModelSerializers::CachedSerializer
|
||||
|
||||
|
||||
|
||||
</h1>
|
||||
|
||||
<dl class="box">
|
||||
|
||||
<dt class="r1">Inherits:</dt>
|
||||
<dd class="r1">
|
||||
<span class="inheritName">Object</span>
|
||||
|
||||
<ul class="fullTree">
|
||||
<li>Object</li>
|
||||
|
||||
<li class="next">ActiveModelSerializers::CachedSerializer</li>
|
||||
|
||||
</ul>
|
||||
<a href="#" class="inheritanceTree">show all</a>
|
||||
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="r2 last">Defined in:</dt>
|
||||
<dd class="r2 last">lib/active_model_serializers/cached_serializer.rb</dd>
|
||||
|
||||
</dl>
|
||||
<div class="clear"></div>
|
||||
|
||||
|
||||
<h2>Constant Summary</h2>
|
||||
|
||||
<dl class="constants">
|
||||
|
||||
<dt id="UndefinedCacheKey-constant" class="">UndefinedCacheKey =
|
||||
|
||||
</dt>
|
||||
<dd><pre class="code"><span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>StandardError</span><span class='rparen'>)</span></pre></dd>
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2>
|
||||
Class Method Summary
|
||||
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
||||
</h2>
|
||||
|
||||
<ul class="summary">
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#object_cache_key-class_method" title="object_cache_key (class 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-class_method" title="object_cache_keys (class method)">+ (Array) <strong>object_cache_keys</strong>(serializers, adapter_instance, include_tree) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>find all cache_key for the collection_serializer.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<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_check-instance_method" title="#cache_check (instance method)">- (Object) <strong>cache_check</strong>(adapter_instance) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<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="#cached%3F-instance_method" title="#cached? (instance method)">- (Boolean) <strong>cached?</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#fragment_cached%3F-instance_method" title="#fragment_cached? (instance method)">- (Boolean) <strong>fragment_cached?</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#initialize-instance_method" title="#initialize (instance method)">- (CachedSerializer) <strong>initialize</strong>(serializer) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
<span class="note title constructor">constructor</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>A new instance of CachedSerializer.</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'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>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<div id="constructor_details" class="method_details_list">
|
||||
<h2>Constructor Details</h2>
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="initialize-instance_method">
|
||||
|
||||
- (<tt><span class='object_link'><a href="" title="ActiveModelSerializers::CachedSerializer (class)">CachedSerializer</a></span></tt>) <strong>initialize</strong>(serializer)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Returns a new instance of CachedSerializer</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
5
|
||||
6
|
||||
7
|
||||
8</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/cached_serializer.rb', line 5</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_serializer'>serializer</span><span class='rparen'>)</span>
|
||||
<span class='ivar'>@cached_serializer</span> <span class='op'>=</span> <span class='id identifier rubyid_serializer'>serializer</span>
|
||||
<span class='ivar'>@klass</span> <span class='op'>=</span> <span class='ivar'>@cached_serializer</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 id="class_method_details" class="method_details_list">
|
||||
<h2>Class Method Details</h2>
|
||||
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="object_cache_key-class_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>
|
||||
|
||||
|
||||
|
||||
—
|
||||
<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">
|
||||
|
||||
|
||||
80
|
||||
81
|
||||
82
|
||||
83
|
||||
84
|
||||
85</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/cached_serializer.rb', line 80</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</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'>&&</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_cached_serializer'>cached_serializer</span> <span class='op'>=</span> <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_serializer'>serializer</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_cached_serializer'>cached_serializer</span><span class='period'>.</span><span class='id identifier rubyid_cached?'>cached?</span> <span class='op'>?</span> <span class='id identifier rubyid_cached_serializer'>cached_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-class_method">
|
||||
|
||||
+ (<tt>Array</tt>) <strong>object_cache_keys</strong>(serializers, adapter_instance, include_tree)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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="../ActiveModel/Serializer/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="Adapter/Base.html" title="ActiveModelSerializers::Adapter::Base (class)">ActiveModelSerializers::Adapter::Base</a></span></tt>)</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<span class='name'>include_tree</span>
|
||||
|
||||
|
||||
<span class='type'>(<tt><span class='object_link'><a href="../ActiveModel/Serializer/IncludeTree.html" title="ActiveModel::Serializer::IncludeTree (class)">ActiveModel::Serializer::IncludeTree</a></span></tt>)</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
<p class="tag_title">Returns:</p>
|
||||
<ul class="return">
|
||||
|
||||
<li>
|
||||
|
||||
|
||||
<span class='type'>(<tt>Array</tt>)</span>
|
||||
|
||||
|
||||
|
||||
—
|
||||
<div class='inline'>
|
||||
<p>all cache_key of collection_serializer</p>
|
||||
</div>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
59
|
||||
60
|
||||
61
|
||||
62
|
||||
63
|
||||
64
|
||||
65
|
||||
66
|
||||
67
|
||||
68
|
||||
69
|
||||
70
|
||||
71
|
||||
72
|
||||
73
|
||||
74
|
||||
75
|
||||
76
|
||||
77</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/cached_serializer.rb', line 59</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_object_cache_keys'>object_cache_keys</span><span class='lparen'>(</span><span class='id identifier rubyid_serializers'>serializers</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_tree'>include_tree</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_serializers'>serializers</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'><<</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_tree'>include_tree</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'><<</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'><<</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>
|
||||
|
||||
<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_check-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>cache_check</strong>(adapter_instance)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
10
|
||||
11
|
||||
12
|
||||
13
|
||||
14
|
||||
15
|
||||
16
|
||||
17
|
||||
18
|
||||
19
|
||||
20</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/cached_serializer.rb', line 10</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_cache_check'>cache_check</span><span class='lparen'>(</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_cached?'>cached?</span>
|
||||
<span class='ivar'>@klass</span><span class='period'>.</span><span class='id identifier rubyid__cache'>_cache</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='ivar'>@klass</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='kw'>yield</span>
|
||||
<span class='kw'>end</span>
|
||||
<span class='kw'>elsif</span> <span class='id identifier rubyid_fragment_cached?'>fragment_cached?</span>
|
||||
<span class='const'>FragmentCache</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='comma'>,</span> <span class='ivar'>@cached_serializer</span><span class='comma'>,</span> <span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='period'>.</span><span class='id identifier rubyid_instance_options'>instance_options</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</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="cache_key-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>cache_key</strong>(adapter_instance)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
30
|
||||
31
|
||||
32
|
||||
33
|
||||
34
|
||||
35
|
||||
36
|
||||
37
|
||||
38</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/cached_serializer.rb', line 30</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'><<</span> <span class='id identifier rubyid_object_cache_key'>object_cache_key</span>
|
||||
<span class='id identifier rubyid_parts'>parts</span> <span class='op'><<</span> <span class='id identifier rubyid_adapter_instance'>adapter_instance</span><span class='period'>.</span><span class='id identifier rubyid_cached_name'>cached_name</span>
|
||||
<span class='id identifier rubyid_parts'>parts</span> <span class='op'><<</span> <span class='ivar'>@klass</span><span class='period'>.</span><span class='id identifier rubyid__cache_digest'>_cache_digest</span> <span class='kw'>unless</span> <span class='ivar'>@klass</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'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="cached?-instance_method">
|
||||
|
||||
- (<tt>Boolean</tt>) <strong>cached?</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">
|
||||
|
||||
|
||||
22
|
||||
23
|
||||
24</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/cached_serializer.rb', line 22</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_cached?'>cached?</span>
|
||||
<span class='ivar'>@klass</span><span class='period'>.</span><span class='id identifier rubyid_cache_enabled?'>cache_enabled?</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="fragment_cached?-instance_method">
|
||||
|
||||
- (<tt>Boolean</tt>) <strong>fragment_cached?</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">
|
||||
|
||||
|
||||
26
|
||||
27
|
||||
28</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/cached_serializer.rb', line 26</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_fragment_cached?'>fragment_cached?</span>
|
||||
<span class='ivar'>@klass</span><span class='period'>.</span><span class='id identifier rubyid_fragment_cache_enabled?'>fragment_cache_enabled?</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'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">
|
||||
|
||||
|
||||
42
|
||||
43
|
||||
44
|
||||
45
|
||||
46
|
||||
47
|
||||
48
|
||||
49
|
||||
50
|
||||
51
|
||||
52</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/cached_serializer.rb', line 42</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='ivar'>@cached_serializer</span><span class='period'>.</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='ivar'>@cached_serializer</span><span class='period'>.</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_cache_key'>cache_key</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='ivar'>@klass</span><span class='period'>.</span><span class='id identifier rubyid__cache_key'>_cache_key</span> <span class='op'>||</span> <span class='ivar'>@klass</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='ivar'>@cached_serializer</span><span class='period'>.</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'>'</span><span class='tstring_content'>%Y%m%d%H%M%S%9N</span><span class='tstring_end'>'</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'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_cache_key'>cache_key</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@cached_serializer</span><span class='period'>.</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'>"</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'>"</span><span class='embexpr_beg'>#{</span><span class='ivar'>@cached_serializer</span><span class='period'>.</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 'key:' option must be passed into '</span><span class='embexpr_beg'>#{</span><span class='ivar'>@klass</span><span class='embexpr_end'>}</span><span class='tstring_content'>.cache'</span><span class='tstring_end'>"</span></span>
|
||||
<span class='kw'>end</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:40 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -133,9 +133,9 @@ serialization and allow you to trigger logic. Available callbacks are:</p>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:36 2016 by
|
||||
Generated on Mon Jun 13 21:53:36 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -216,9 +216,9 @@ it is as_json, to_json, or serializable_hash</p>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:36 2016 by
|
||||
Generated on Mon Jun 13 21:53:36 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -174,13 +174,13 @@ up in a dummy method.</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
46
|
||||
47
|
||||
48
|
||||
49
|
||||
50</pre>
|
||||
49</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/deprecate.rb', line 47</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/deprecate.rb', line 46</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_delegate_and_deprecate'>delegate_and_deprecate</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='id identifier rubyid_delegee'>delegee</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_delegate'>delegate</span> <span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='label'>to:</span> <span class='id identifier rubyid_delegee'>delegee</span>
|
||||
@ -233,8 +233,7 @@ that it is planned to go away.</p>
|
||||
41
|
||||
42
|
||||
43
|
||||
44
|
||||
45</pre>
|
||||
44</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/deprecate.rb', line 31</span>
|
||||
@ -247,8 +246,7 @@ that it is planned to go away.</p>
|
||||
<span class='id identifier rubyid_target'>target</span> <span class='op'>=</span> <span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Module</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='embexpr_end'>}</span><span class='tstring_content'>.</span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_content'>#</span><span class='tstring_end'>"</span></span>
|
||||
<span class='id identifier rubyid_msg'>msg</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>NOTE: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_target'>target</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'> is deprecated</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
||||
<span class='id identifier rubyid_replacement'>replacement</span> <span class='op'>==</span> <span class='symbol'>:none</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'> with no replacement</span><span class='tstring_end'>'</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>; use </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_replacement'>replacement</span><span class='embexpr_end'>}</span><span class='tstring_content'> instead</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
||||
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_target'>target</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'> called from </span><span class='embexpr_beg'>#{</span><span class='const'>ActiveModelSerializers</span><span class='period'>.</span><span class='id identifier rubyid_location_of_caller'>location_of_caller</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>:</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
||||
<span class='rbracket'>]</span>
|
||||
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_target'>target</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'> called from </span><span class='embexpr_beg'>#{</span><span class='const'>ActiveModelSerializers</span><span class='period'>.</span><span class='id identifier rubyid_location_of_caller'>location_of_caller</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>:</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
||||
<span class='id identifier rubyid_warn'>warn</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_msg'>msg</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='embexpr_end'>}</span><span class='tstring_content'>.</span><span class='tstring_end'>"</span></span>
|
||||
<span class='id identifier rubyid_send'>send</span> <span class='id identifier rubyid_old'>old</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span>
|
||||
<span class='kw'>end</span>
|
||||
@ -264,9 +262,9 @@ that it is planned to go away.</p>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:36 2016 by
|
||||
Generated on Mon Jun 13 21:53:36 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -138,7 +138,9 @@
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>:nocov:.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
@ -191,18 +193,29 @@
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>:nocov:</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
9
|
||||
10
|
||||
11</pre>
|
||||
11
|
||||
12</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/deserialization.rb', line 9</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/deserialization.rb', line 10</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_jsonapi_parse!'>jsonapi_parse!</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
|
||||
<span class='const'>Adapter</span><span class='op'>::</span><span class='const'>JsonApi</span><span class='op'>::</span><span class='const'>Deserialization</span><span class='period'>.</span><span class='id identifier rubyid_parse!'>parse!</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
|
||||
@ -217,9 +230,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:37 2016 by
|
||||
Generated on Mon Jun 13 21:53:37 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -1,384 +0,0 @@
|
||||
<!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>
|
||||
Class: ActiveModelSerializers::FragmentCache
|
||||
|
||||
— 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/FragmentCache.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 (F)</a> »
|
||||
<span class='title'><span class='object_link'><a href="../ActiveModelSerializers.html" title="ActiveModelSerializers (module)">ActiveModelSerializers</a></span></span>
|
||||
»
|
||||
<span class="title">FragmentCache</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>Class: ActiveModelSerializers::FragmentCache
|
||||
|
||||
|
||||
|
||||
</h1>
|
||||
|
||||
<dl class="box">
|
||||
|
||||
<dt class="r1">Inherits:</dt>
|
||||
<dd class="r1">
|
||||
<span class="inheritName">Object</span>
|
||||
|
||||
<ul class="fullTree">
|
||||
<li>Object</li>
|
||||
|
||||
<li class="next">ActiveModelSerializers::FragmentCache</li>
|
||||
|
||||
</ul>
|
||||
<a href="#" class="inheritanceTree">show all</a>
|
||||
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="r2 last">Defined in:</dt>
|
||||
<dd class="r2 last">lib/active_model_serializers/fragment_cache.rb</dd>
|
||||
|
||||
</dl>
|
||||
<div class="clear"></div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
||||
<ul class="summary">
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#serializer-instance_method" title="#serializer (instance method)">- (Object) <strong>serializer</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="note title readonly">readonly</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Returns the value of attribute serializer.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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="#fetch-instance_method" title="#fetch (instance method)">- (Object) <strong>fetch</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>1.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#initialize-instance_method" title="#initialize (instance method)">- (FragmentCache) <strong>initialize</strong>(adapter, serializer, options) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
<span class="note title constructor">constructor</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>A new instance of FragmentCache.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<div id="constructor_details" class="method_details_list">
|
||||
<h2>Constructor Details</h2>
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="initialize-instance_method">
|
||||
|
||||
- (<tt><span class='object_link'><a href="" title="ActiveModelSerializers::FragmentCache (class)">FragmentCache</a></span></tt>) <strong>initialize</strong>(adapter, serializer, options)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Returns a new instance of FragmentCache</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
5
|
||||
6
|
||||
7
|
||||
8
|
||||
9</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/fragment_cache.rb', line 5</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter'>adapter</span><span class='comma'>,</span> <span class='id identifier rubyid_serializer'>serializer</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
<span class='ivar'>@instance_options</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span>
|
||||
<span class='ivar'>@adapter</span> <span class='op'>=</span> <span class='id identifier rubyid_adapter'>adapter</span>
|
||||
<span class='ivar'>@serializer</span> <span class='op'>=</span> <span class='id identifier rubyid_serializer'>serializer</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="instance_attr_details" class="attr_details">
|
||||
<h2>Instance Attribute Details</h2>
|
||||
|
||||
|
||||
<span id=""></span>
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="serializer-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>serializer</strong> <span class="extras">(readonly)</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Returns the value of attribute serializer</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
3
|
||||
4
|
||||
5</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/fragment_cache.rb', line 3</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_serializer'>serializer</span>
|
||||
<span class='ivar'>@serializer</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="instance_method_details" class="method_details_list">
|
||||
<h2>Instance Method Details</h2>
|
||||
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="fetch-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>fetch</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
<ol><li>
|
||||
<p>Create a CachedSerializer and NonCachedSerializer from the serializer class</p>
|
||||
</li><li>
|
||||
<p>Serialize the above two with the given adapter</p>
|
||||
</li><li>
|
||||
<p>Pass their serializations to the adapter <code>::fragment_cache</code></p>
|
||||
</li></ol>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
14
|
||||
15
|
||||
16
|
||||
17
|
||||
18
|
||||
19
|
||||
20
|
||||
21
|
||||
22
|
||||
23
|
||||
24
|
||||
25
|
||||
26</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/fragment_cache.rb', line 14</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_fetch'>fetch</span>
|
||||
<span class='id identifier rubyid_object'>object</span> <span class='op'>=</span> <span class='id identifier rubyid_serializer'>serializer</span><span class='period'>.</span><span class='id identifier rubyid_object'>object</span>
|
||||
|
||||
<span class='comment'># It will split the serializer into two, one that will be cached and one that will not
|
||||
</span> <span class='id identifier rubyid_serializers'>serializers</span> <span class='op'>=</span> <span class='id identifier rubyid_fragment_serializer'>fragment_serializer</span>
|
||||
|
||||
<span class='comment'># Get serializable hash from both
|
||||
</span> <span class='id identifier rubyid_cached_hash'>cached_hash</span> <span class='op'>=</span> <span class='id identifier rubyid_serialize'>serialize</span><span class='lparen'>(</span><span class='id identifier rubyid_object'>object</span><span class='comma'>,</span> <span class='id identifier rubyid_serializers'>serializers</span><span class='lbracket'>[</span><span class='symbol'>:cached</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_non_cached_hash'>non_cached_hash</span> <span class='op'>=</span> <span class='id identifier rubyid_serialize'>serialize</span><span class='lparen'>(</span><span class='id identifier rubyid_object'>object</span><span class='comma'>,</span> <span class='id identifier rubyid_serializers'>serializers</span><span class='lbracket'>[</span><span class='symbol'>:non_cached</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
||||
|
||||
<span class='comment'># Merge both results
|
||||
</span> <span class='id identifier rubyid_adapter'>adapter</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>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:39 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -180,9 +180,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:37 2016 by
|
||||
Generated on Mon Jun 13 21:53:37 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -165,13 +165,187 @@ format: [jsonapi]`)</p>
|
||||
|
||||
|
||||
|
||||
<h2>
|
||||
Class Method Summary
|
||||
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
||||
</h2>
|
||||
|
||||
<ul class="summary">
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#install-class_method" title="install (class method)">+ (Object) <strong>install</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#parser-class_method" title="parser (class method)">+ (Object) <strong>parser</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Proposal: should actually deserialize the JSON API params to the hash
|
||||
format expected by `ActiveModel::Serializers::JSON`
|
||||
actionpack/lib/action_dispatch/http/parameters.rb.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
<div id="class_method_details" class="method_details_list">
|
||||
<h2>Class Method Details</h2>
|
||||
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="install-class_method">
|
||||
|
||||
+ (<tt>Object</tt>) <strong>install</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
32
|
||||
33
|
||||
34
|
||||
35
|
||||
36
|
||||
37
|
||||
38
|
||||
39
|
||||
40
|
||||
41
|
||||
42
|
||||
43
|
||||
44
|
||||
45
|
||||
46
|
||||
47
|
||||
48</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/register_jsonapi_renderer.rb', line 32</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_install'>install</span>
|
||||
<span class='comment'># actionpack/lib/action_dispatch/http/mime_types.rb
|
||||
</span> <span class='const'>Mime</span><span class='op'>::</span><span class='const'>Type</span><span class='period'>.</span><span class='id identifier rubyid_register'>register</span> <span class='const'>MEDIA_TYPE</span><span class='comma'>,</span> <span class='symbol'>:jsonapi</span>
|
||||
|
||||
<span class='kw'>if</span> <span class='const'>Rails</span><span class='op'>::</span><span class='const'>VERSION</span><span class='op'>::</span><span class='const'>MAJOR</span> <span class='op'>>=</span> <span class='int'>5</span>
|
||||
<span class='const'>ActionDispatch</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_parameter_parsers'>parameter_parsers</span><span class='lbracket'>[</span><span class='symbol'>:jsonapi</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_parser'>parser</span>
|
||||
<span class='kw'>else</span>
|
||||
<span class='const'>ActionDispatch</span><span class='op'>::</span><span class='const'>ParamsParser</span><span class='op'>::</span><span class='const'>DEFAULT_PARSERS</span><span class='lbracket'>[</span><span class='const'>Mime</span><span class='lbracket'>[</span><span class='symbol'>:jsonapi</span><span class='rbracket'>]</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_parser'>parser</span>
|
||||
<span class='kw'>end</span>
|
||||
|
||||
<span class='comment'># ref https://github.com/rails/rails/pull/21496
|
||||
</span> <span class='const'>ActionController</span><span class='op'>::</span><span class='const'>Renderers</span><span class='period'>.</span><span class='id identifier rubyid_add'>add</span> <span class='symbol'>:jsonapi</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_json'>json</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>|</span>
|
||||
<span class='id identifier rubyid_json'>json</span> <span class='op'>=</span> <span class='id identifier rubyid_serialize_jsonapi'>serialize_jsonapi</span><span class='lparen'>(</span><span class='id identifier rubyid_json'>json</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_json'>json</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span>
|
||||
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_content_type'>content_type</span> <span class='op'>||=</span> <span class='const'>Mime</span><span class='lbracket'>[</span><span class='symbol'>:jsonapi</span><span class='rbracket'>]</span>
|
||||
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_response_body'>response_body</span> <span class='op'>=</span> <span class='id identifier rubyid_json'>json</span>
|
||||
<span class='kw'>end</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="parser-class_method">
|
||||
|
||||
+ (<tt>Object</tt>) <strong>parser</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Proposal: should actually deserialize the JSON API params to the hash
|
||||
format expected by `ActiveModel::Serializers::JSON`
|
||||
actionpack/lib/action_dispatch/http/parameters.rb</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
53
|
||||
54
|
||||
55
|
||||
56
|
||||
57
|
||||
58
|
||||
59</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/register_jsonapi_renderer.rb', line 53</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_parser'>parser</span>
|
||||
<span class='id identifier rubyid_lambda'>lambda</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_body'>body</span><span class='op'>|</span>
|
||||
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='symbol'>:_json</span> <span class='op'>=></span> <span class='id identifier rubyid_data'>data</span> <span class='rbrace'>}</span> <span class='kw'>unless</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_with_indifferent_access'>with_indifferent_access</span>
|
||||
<span class='kw'>end</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:37 2016 by
|
||||
Generated on Mon Jun 13 21:53:37 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -145,18 +145,22 @@
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
33
|
||||
34
|
||||
35
|
||||
36
|
||||
37</pre>
|
||||
62
|
||||
63
|
||||
64
|
||||
65
|
||||
66
|
||||
67
|
||||
68</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/register_jsonapi_renderer.rb', line 33</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/register_jsonapi_renderer.rb', line 62</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_serialize_jsonapi'>serialize_jsonapi</span><span class='lparen'>(</span><span class='id identifier rubyid_json'>json</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:adapter</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:json_api</span>
|
||||
<span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:serialization_context</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:serialization_context</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>ActiveModelSerializers</span><span class='op'>::</span><span class='const'>SerializationContext</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
||||
<span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:serialization_context</span><span class='rparen'>)</span> <span class='kw'>do</span>
|
||||
<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:serialization_context</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>ActiveModelSerializers</span><span class='op'>::</span><span class='const'>SerializationContext</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span>
|
||||
<span class='id identifier rubyid_get_serializer'>get_serializer</span><span class='lparen'>(</span><span class='id identifier rubyid_json'>json</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
@ -169,9 +173,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:37 2016 by
|
||||
Generated on Mon Jun 13 21:53:37 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -524,9 +524,9 @@ deserialization in the JsonApi adapter.</p>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:37 2016 by
|
||||
Generated on Mon Jun 13 21:53:37 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -262,9 +262,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:36 2016 by
|
||||
Generated on Mon Jun 13 21:53:36 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -177,9 +177,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:36 2016 by
|
||||
Generated on Mon Jun 13 21:53:36 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -245,9 +245,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:38 2016 by
|
||||
Generated on Mon Jun 13 21:53:38 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -240,9 +240,9 @@ rendered. Adapted from:</p>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:36 2016 by
|
||||
Generated on Mon Jun 13 21:53:36 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -200,7 +200,7 @@
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>The following methods are needed to be minimally implemented for
|
||||
ActiveModel::Errors.</p>
|
||||
ActiveModel::Errors :nocov:.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
@ -521,7 +521,7 @@ ActiveModel::Errors.</p>
|
||||
<div class="discussion">
|
||||
|
||||
<p>The following methods are needed to be minimally implemented for
|
||||
ActiveModel::Errors</p>
|
||||
ActiveModel::Errors :nocov:</p>
|
||||
|
||||
|
||||
</div>
|
||||
@ -535,12 +535,12 @@ ActiveModel::Errors</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
41
|
||||
42
|
||||
43</pre>
|
||||
43
|
||||
44</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/model.rb', line 41</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/model.rb', line 42</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_human_attribute_name'>human_attribute_name</span><span class='lparen'>(</span><span class='id identifier rubyid_attr'>attr</span><span class='comma'>,</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='id identifier rubyid_attr'>attr</span>
|
||||
@ -565,12 +565,12 @@ ActiveModel::Errors</p>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
45
|
||||
46
|
||||
47</pre>
|
||||
47
|
||||
48</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/model.rb', line 45</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/model.rb', line 46</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_lookup_ancestors'>lookup_ancestors</span>
|
||||
<span class='lbracket'>[</span><span class='kw'>self</span><span class='rbracket'>]</span>
|
||||
@ -752,9 +752,9 @@ ActiveModel::Errors</p>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:38 2016 by
|
||||
Generated on Mon Jun 13 21:53:38 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -114,9 +114,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:38 2016 by
|
||||
Generated on Mon Jun 13 21:53:38 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -111,7 +111,7 @@
|
||||
<dt id="ADAPTER_OPTION_KEYS-constant" class="">ADAPTER_OPTION_KEYS =
|
||||
|
||||
</dt>
|
||||
<dd><pre class="code"><span class='const'>Set</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:include</span><span class='comma'>,</span> <span class='symbol'>:fields</span><span class='comma'>,</span> <span class='symbol'>:adapter</span><span class='comma'>,</span> <span class='symbol'>:meta</span><span class='comma'>,</span> <span class='symbol'>:meta_key</span><span class='comma'>,</span> <span class='symbol'>:links</span><span class='rbracket'>]</span><span class='rparen'>)</span></pre></dd>
|
||||
<dd><pre class="code"><span class='const'>Set</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:include</span><span class='comma'>,</span> <span class='symbol'>:fields</span><span class='comma'>,</span> <span class='symbol'>:adapter</span><span class='comma'>,</span> <span class='symbol'>:meta</span><span class='comma'>,</span> <span class='symbol'>:meta_key</span><span class='comma'>,</span> <span class='symbol'>:links</span><span class='comma'>,</span> <span class='symbol'>:serialization_context</span><span class='comma'>,</span> <span class='symbol'>:key_transform</span><span class='rbracket'>]</span><span class='rparen'>)</span></pre></dd>
|
||||
|
||||
</dl>
|
||||
|
||||
@ -822,9 +822,9 @@ False when explicit adapter is falsy (nil or false)</p>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:41 2016 by
|
||||
Generated on Mon Jun 13 21:53:40 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -559,9 +559,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:41 2016 by
|
||||
Generated on Mon Jun 13 21:53:40 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -236,9 +236,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:37 2016 by
|
||||
Generated on Mon Jun 13 21:53:37 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -113,9 +113,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:35 2016 by
|
||||
Generated on Mon Jun 13 21:53:36 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -90,7 +90,7 @@
|
||||
|
||||
|
||||
|
||||
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Schema/AssertResponseSchema.html" title="ActiveModelSerializers::Test::Schema::AssertResponseSchema (class)">AssertResponseSchema</a></span>
|
||||
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Schema/AssertRequestSchema.html" title="ActiveModelSerializers::Test::Schema::AssertRequestSchema (class)">AssertRequestSchema</a></span>, <span class='object_link'><a href="Schema/AssertResponseSchema.html" title="ActiveModelSerializers::Test::Schema::AssertResponseSchema (class)">AssertResponseSchema</a></span>, <span class='object_link'><a href="Schema/AssertSchema.html" title="ActiveModelSerializers::Test::Schema::AssertSchema (class)">AssertSchema</a></span>
|
||||
|
||||
|
||||
</p>
|
||||
@ -102,12 +102,12 @@
|
||||
<dt id="MissingSchema-constant" class="">MissingSchema =
|
||||
|
||||
</dt>
|
||||
<dd><pre class="code"><span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>Errno</span><span class='op'>::</span><span class='const'>ENOENT</span><span class='rparen'>)</span></pre></dd>
|
||||
<dd><pre class="code"><span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>Minitest</span><span class='op'>::</span><span class='const'>Assertion</span><span class='rparen'>)</span></pre></dd>
|
||||
|
||||
<dt id="InvalidSchemaError-constant" class="">InvalidSchemaError =
|
||||
|
||||
</dt>
|
||||
<dd><pre class="code"><span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>StandardError</span><span class='rparen'>)</span></pre></dd>
|
||||
<dd><pre class="code"><span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>Minitest</span><span class='op'>::</span><span class='const'>Assertion</span><span class='rparen'>)</span></pre></dd>
|
||||
|
||||
</dl>
|
||||
|
||||
@ -129,6 +129,52 @@
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#assert_request_response_schema-instance_method" title="#assert_request_response_schema (instance method)">- (Object) <strong>assert_request_response_schema</strong>(schema_path = nil, message = nil) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>May be renamed.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#assert_request_schema-instance_method" title="#assert_request_schema (instance method)">- (Object) <strong>assert_request_schema</strong>(schema_path = nil, message = nil) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#assert_response_schema-instance_method" title="#assert_response_schema (instance method)">- (Boolean, Minitest::Assertion) <strong>assert_response_schema</strong>(schema_path = nil, message = nil) </a>
|
||||
|
||||
|
||||
@ -147,6 +193,28 @@
|
||||
<p>A Minitest Assertion that test the response is valid against a schema.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#assert_schema-instance_method" title="#assert_schema (instance method)">- (Object) <strong>assert_schema</strong>(payload, schema_path = nil, message = nil) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
@ -160,7 +228,82 @@
|
||||
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="assert_response_schema-instance_method">
|
||||
<h3 class="signature first" id="assert_request_response_schema-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>assert_request_response_schema</strong>(schema_path = nil, message = nil)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>May be renamed</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
23
|
||||
24
|
||||
25
|
||||
26</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/test/schema.rb', line 23</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_assert_request_response_schema'>assert_request_response_schema</span><span class='lparen'>(</span><span class='id identifier rubyid_schema_path'>schema_path</span> <span class='op'>=</span> <span class='kw'>nil</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='id identifier rubyid_assert_request_schema'>assert_request_schema</span><span class='lparen'>(</span><span class='id identifier rubyid_schema_path'>schema_path</span><span class='comma'>,</span> <span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_assert_response_schema'>assert_response_schema</span><span class='lparen'>(</span><span class='id identifier rubyid_schema_path'>schema_path</span><span class='comma'>,</span> <span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="assert_request_schema-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>assert_request_schema</strong>(schema_path = nil, message = nil)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
17
|
||||
18
|
||||
19
|
||||
20</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/test/schema.rb', line 17</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_assert_request_schema'>assert_request_schema</span><span class='lparen'>(</span><span class='id identifier rubyid_schema_path'>schema_path</span> <span class='op'>=</span> <span class='kw'>nil</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='id identifier rubyid_matcher'>matcher</span> <span class='op'>=</span> <span class='const'>AssertRequestSchema</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_schema_path'>schema_path</span><span class='comma'>,</span> <span class='id identifier rubyid_request'>request</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_assert'>assert</span><span class='lparen'>(</span><span class='id identifier rubyid_matcher'>matcher</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='comma'>,</span> <span class='id identifier rubyid_matcher'>matcher</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 class="method_details ">
|
||||
<h3 class="signature " id="assert_response_schema-instance_method">
|
||||
|
||||
- (<tt>Boolean</tt>, <tt>Minitest::Assertion</tt>) <strong>assert_response_schema</strong>(schema_path = nil, message = nil)
|
||||
|
||||
@ -275,7 +418,39 @@
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/test/schema.rb', line 12</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_assert_response_schema'>assert_response_schema</span><span class='lparen'>(</span><span class='id identifier rubyid_schema_path'>schema_path</span> <span class='op'>=</span> <span class='kw'>nil</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='id identifier rubyid_matcher'>matcher</span> <span class='op'>=</span> <span class='const'>AssertResponseSchema</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_schema_path'>schema_path</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_matcher'>matcher</span> <span class='op'>=</span> <span class='const'>AssertResponseSchema</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_schema_path'>schema_path</span><span class='comma'>,</span> <span class='id identifier rubyid_request'>request</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_assert'>assert</span><span class='lparen'>(</span><span class='id identifier rubyid_matcher'>matcher</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='comma'>,</span> <span class='id identifier rubyid_matcher'>matcher</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 class="method_details ">
|
||||
<h3 class="signature " id="assert_schema-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>assert_schema</strong>(payload, schema_path = nil, message = nil)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
28
|
||||
29
|
||||
30
|
||||
31</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/test/schema.rb', line 28</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_assert_schema'>assert_schema</span><span class='lparen'>(</span><span class='id identifier rubyid_payload'>payload</span><span class='comma'>,</span> <span class='id identifier rubyid_schema_path'>schema_path</span> <span class='op'>=</span> <span class='kw'>nil</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='id identifier rubyid_matcher'>matcher</span> <span class='op'>=</span> <span class='const'>AssertSchema</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_schema_path'>schema_path</span><span class='comma'>,</span> <span class='id identifier rubyid_request'>request</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_assert'>assert</span><span class='lparen'>(</span><span class='id identifier rubyid_matcher'>matcher</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='comma'>,</span> <span class='id identifier rubyid_matcher'>matcher</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
@ -288,9 +463,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:36 2016 by
|
||||
Generated on Mon Jun 13 21:53:37 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
222
ActiveModelSerializers/Test/Schema/AssertRequestSchema.html
Normal file
222
ActiveModelSerializers/Test/Schema/AssertRequestSchema.html
Normal file
@ -0,0 +1,222 @@
|
||||
<!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>
|
||||
Class: ActiveModelSerializers::Test::Schema::AssertRequestSchema
|
||||
|
||||
— 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/Schema/AssertRequestSchema.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 (A)</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'><span class='object_link'><a href="../Schema.html" title="ActiveModelSerializers::Test::Schema (module)">Schema</a></span></span>
|
||||
»
|
||||
<span class="title">AssertRequestSchema</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>Class: ActiveModelSerializers::Test::Schema::AssertRequestSchema
|
||||
|
||||
|
||||
|
||||
</h1>
|
||||
|
||||
<dl class="box">
|
||||
|
||||
<dt class="r1">Inherits:</dt>
|
||||
<dd class="r1">
|
||||
<span class="inheritName"><span class='object_link'><a href="AssertSchema.html" title="ActiveModelSerializers::Test::Schema::AssertSchema (class)">AssertSchema</a></span></span>
|
||||
|
||||
<ul class="fullTree">
|
||||
<li>Object</li>
|
||||
|
||||
<li class="next"><span class='object_link'><a href="AssertSchema.html" title="ActiveModelSerializers::Test::Schema::AssertSchema (class)">AssertSchema</a></span></li>
|
||||
|
||||
<li class="next">ActiveModelSerializers::Test::Schema::AssertRequestSchema</li>
|
||||
|
||||
</ul>
|
||||
<a href="#" class="inheritanceTree">show all</a>
|
||||
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="r2 last">Defined in:</dt>
|
||||
<dd class="r2 last">lib/active_model_serializers/test/schema.rb</dd>
|
||||
|
||||
</dl>
|
||||
<div class="clear"></div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2>Instance Attribute Summary</h2>
|
||||
|
||||
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="AssertSchema.html" title="ActiveModelSerializers::Test::Schema::AssertSchema (class)">AssertSchema</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="AssertSchema.html#message-instance_method" title="ActiveModelSerializers::Test::Schema::AssertSchema#message (method)">#message</a></span>, <span class='object_link'><a href="AssertSchema.html#payload-instance_method" title="ActiveModelSerializers::Test::Schema::AssertSchema#payload (method)">#payload</a></span>, <span class='object_link'><a href="AssertSchema.html#request-instance_method" title="ActiveModelSerializers::Test::Schema::AssertSchema#request (method)">#request</a></span>, <span class='object_link'><a href="AssertSchema.html#response-instance_method" title="ActiveModelSerializers::Test::Schema::AssertSchema#response (method)">#response</a></span>, <span class='object_link'><a href="AssertSchema.html#schema_path-instance_method" title="ActiveModelSerializers::Test::Schema::AssertSchema#schema_path (method)">#schema_path</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="#initialize-instance_method" title="#initialize (instance method)">- (AssertRequestSchema) <strong>initialize</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
<span class="note title constructor">constructor</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>A new instance of AssertRequestSchema.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="AssertSchema.html" title="ActiveModelSerializers::Test::Schema::AssertSchema (class)">AssertSchema</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="AssertSchema.html#call-instance_method" title="ActiveModelSerializers::Test::Schema::AssertSchema#call (method)">#call</a></span></p>
|
||||
<div id="constructor_details" class="method_details_list">
|
||||
<h2>Constructor Details</h2>
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="initialize-instance_method">
|
||||
|
||||
- (<tt><span class='object_link'><a href="" title="ActiveModelSerializers::Test::Schema::AssertRequestSchema (class)">AssertRequestSchema</a></span></tt>) <strong>initialize</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Returns a new instance of AssertRequestSchema</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
131
|
||||
132
|
||||
133
|
||||
134</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/test/schema.rb', line 131</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='op'>*</span><span class='rparen'>)</span>
|
||||
<span class='kw'>super</span>
|
||||
<span class='ivar'>@payload</span> <span class='op'>=</span> <span class='id identifier rubyid_request_params'>request_params</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Mon Jun 13 21:53:39 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>
|
||||
@ -73,11 +73,13 @@
|
||||
|
||||
<dt class="r1">Inherits:</dt>
|
||||
<dd class="r1">
|
||||
<span class="inheritName">Object</span>
|
||||
<span class="inheritName"><span class='object_link'><a href="AssertSchema.html" title="ActiveModelSerializers::Test::Schema::AssertSchema (class)">AssertSchema</a></span></span>
|
||||
|
||||
<ul class="fullTree">
|
||||
<li>Object</li>
|
||||
|
||||
<li class="next"><span class='object_link'><a href="AssertSchema.html" title="ActiveModelSerializers::Test::Schema::AssertSchema (class)">AssertSchema</a></span></li>
|
||||
|
||||
<li class="next">ActiveModelSerializers::Test::Schema::AssertResponseSchema</li>
|
||||
|
||||
</ul>
|
||||
@ -103,99 +105,12 @@
|
||||
|
||||
|
||||
|
||||
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
||||
<ul class="summary">
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#message-instance_method" title="#message (instance method)">- (Object) <strong>message</strong> </a>
|
||||
|
||||
|
||||
<h2>Instance Attribute Summary</h2>
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="note title readonly">readonly</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Returns the value of attribute message.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#response-instance_method" title="#response (instance method)">- (Object) <strong>response</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="note title readonly">readonly</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Returns the value of attribute response.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#schema_path-instance_method" title="#schema_path (instance method)">- (Object) <strong>schema_path</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="note title readonly">readonly</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Returns the value of attribute schema_path.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="AssertSchema.html" title="ActiveModelSerializers::Test::Schema::AssertSchema (class)">AssertSchema</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="AssertSchema.html#message-instance_method" title="ActiveModelSerializers::Test::Schema::AssertSchema#message (method)">#message</a></span>, <span class='object_link'><a href="AssertSchema.html#payload-instance_method" title="ActiveModelSerializers::Test::Schema::AssertSchema#payload (method)">#payload</a></span>, <span class='object_link'><a href="AssertSchema.html#request-instance_method" title="ActiveModelSerializers::Test::Schema::AssertSchema#request (method)">#request</a></span>, <span class='object_link'><a href="AssertSchema.html#response-instance_method" title="ActiveModelSerializers::Test::Schema::AssertSchema#response (method)">#response</a></span>, <span class='object_link'><a href="AssertSchema.html#schema_path-instance_method" title="ActiveModelSerializers::Test::Schema::AssertSchema#schema_path (method)">#schema_path</a></span></p>
|
||||
|
||||
|
||||
|
||||
@ -209,29 +124,7 @@
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#call-instance_method" title="#call (instance method)">- (Object) <strong>call</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#initialize-instance_method" title="#initialize (instance method)">- (AssertResponseSchema) <strong>initialize</strong>(schema_path, response, message) </a>
|
||||
<a href="#initialize-instance_method" title="#initialize (instance method)">- (AssertResponseSchema) <strong>initialize</strong> </a>
|
||||
|
||||
|
||||
|
||||
@ -257,13 +150,24 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="AssertSchema.html" title="ActiveModelSerializers::Test::Schema::AssertSchema (class)">AssertSchema</a></span></h3>
|
||||
<p class="inherited"><span class='object_link'><a href="AssertSchema.html#call-instance_method" title="ActiveModelSerializers::Test::Schema::AssertSchema#call (method)">#call</a></span></p>
|
||||
<div id="constructor_details" class="method_details_list">
|
||||
<h2>Constructor Details</h2>
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="initialize-instance_method">
|
||||
|
||||
- (<tt><span class='object_link'><a href="" title="ActiveModelSerializers::Test::Schema::AssertResponseSchema (class)">AssertResponseSchema</a></span></tt>) <strong>initialize</strong>(schema_path, response, message)
|
||||
- (<tt><span class='object_link'><a href="" title="ActiveModelSerializers::Test::Schema::AssertResponseSchema (class)">AssertResponseSchema</a></span></tt>) <strong>initialize</strong>
|
||||
|
||||
|
||||
|
||||
@ -286,25 +190,17 @@
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
23
|
||||
24
|
||||
25
|
||||
26
|
||||
27
|
||||
28
|
||||
29
|
||||
30</pre>
|
||||
125
|
||||
126
|
||||
127
|
||||
128</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/test/schema.rb', line 23</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/test/schema.rb', line 125</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_schema_path'>schema_path</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_require_json_schema!'>require_json_schema!</span>
|
||||
<span class='ivar'>@response</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span>
|
||||
<span class='ivar'>@schema_path</span> <span class='op'>=</span> <span class='id identifier rubyid_schema_path'>schema_path</span> <span class='op'>||</span> <span class='id identifier rubyid_schema_path_default'>schema_path_default</span>
|
||||
<span class='ivar'>@message</span> <span class='op'>=</span> <span class='id identifier rubyid_message'>message</span>
|
||||
<span class='ivar'>@document_store</span> <span class='op'>=</span> <span class='const'>JsonSchema</span><span class='op'>::</span><span class='const'>DocumentStore</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
|
||||
<span class='id identifier rubyid_add_schema_to_document_store'>add_schema_to_document_store</span>
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='op'>*</span><span class='rparen'>)</span>
|
||||
<span class='kw'>super</span>
|
||||
<span class='ivar'>@payload</span> <span class='op'>=</span> <span class='id identifier rubyid_response_body'>response_body</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
@ -313,189 +209,13 @@
|
||||
|
||||
</div>
|
||||
|
||||
<div id="instance_attr_details" class="attr_details">
|
||||
<h2>Instance Attribute Details</h2>
|
||||
|
||||
|
||||
<span id=""></span>
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="message-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>message</strong> <span class="extras">(readonly)</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Returns the value of attribute message</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
21
|
||||
22
|
||||
23</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/test/schema.rb', line 21</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_message'>message</span>
|
||||
<span class='ivar'>@message</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
|
||||
<span id=""></span>
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="response-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>response</strong> <span class="extras">(readonly)</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Returns the value of attribute response</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
21
|
||||
22
|
||||
23</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/test/schema.rb', line 21</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_response'>response</span>
|
||||
<span class='ivar'>@response</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
|
||||
<span id=""></span>
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="schema_path-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>schema_path</strong> <span class="extras">(readonly)</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Returns the value of attribute schema_path</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
21
|
||||
22
|
||||
23</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/test/schema.rb', line 21</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_schema_path'>schema_path</span>
|
||||
<span class='ivar'>@schema_path</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="instance_method_details" class="method_details_list">
|
||||
<h2>Instance Method Details</h2>
|
||||
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="call-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>call</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><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/schema.rb', line 32</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span>
|
||||
<span class='id identifier rubyid_json_schema'>json_schema</span><span class='period'>.</span><span class='id identifier rubyid_expand_references!'>expand_references!</span><span class='lparen'>(</span><span class='label'>store:</span> <span class='id identifier rubyid_document_store'>document_store</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='id identifier rubyid_errors'>errors</span> <span class='op'>=</span> <span class='id identifier rubyid_json_schema'>json_schema</span><span class='period'>.</span><span class='id identifier rubyid_validate'>validate</span><span class='lparen'>(</span><span class='id identifier rubyid_response_body'>response_body</span><span class='rparen'>)</span>
|
||||
<span class='ivar'>@message</span> <span class='op'>||=</span> <span class='id identifier rubyid_errors'>errors</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:to_s</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_sentence'>to_sentence</span>
|
||||
<span class='id identifier rubyid_status'>status</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:39 2016 by
|
||||
Generated on Mon Jun 13 21:53:39 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
654
ActiveModelSerializers/Test/Schema/AssertSchema.html
Normal file
654
ActiveModelSerializers/Test/Schema/AssertSchema.html
Normal file
@ -0,0 +1,654 @@
|
||||
<!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>
|
||||
Class: ActiveModelSerializers::Test::Schema::AssertSchema
|
||||
|
||||
— 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/Schema/AssertSchema.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 (A)</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'><span class='object_link'><a href="../Schema.html" title="ActiveModelSerializers::Test::Schema (module)">Schema</a></span></span>
|
||||
»
|
||||
<span class="title">AssertSchema</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>Class: ActiveModelSerializers::Test::Schema::AssertSchema
|
||||
|
||||
|
||||
|
||||
</h1>
|
||||
|
||||
<dl class="box">
|
||||
|
||||
<dt class="r1">Inherits:</dt>
|
||||
<dd class="r1">
|
||||
<span class="inheritName">Object</span>
|
||||
|
||||
<ul class="fullTree">
|
||||
<li>Object</li>
|
||||
|
||||
<li class="next">ActiveModelSerializers::Test::Schema::AssertSchema</li>
|
||||
|
||||
</ul>
|
||||
<a href="#" class="inheritanceTree">show all</a>
|
||||
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="r2 last">Defined in:</dt>
|
||||
<dd class="r2 last">lib/active_model_serializers/test/schema.rb</dd>
|
||||
|
||||
</dl>
|
||||
<div class="clear"></div>
|
||||
|
||||
<div id="subclasses">
|
||||
<h2>Direct Known Subclasses</h2>
|
||||
<p class="children"><span class='object_link'><a href="AssertRequestSchema.html" title="ActiveModelSerializers::Test::Schema::AssertRequestSchema (class)">AssertRequestSchema</a></span>, <span class='object_link'><a href="AssertResponseSchema.html" title="ActiveModelSerializers::Test::Schema::AssertResponseSchema (class)">AssertResponseSchema</a></span></p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
||||
<ul class="summary">
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#message-instance_method" title="#message (instance method)">- (Object) <strong>message</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="note title readonly">readonly</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Returns the value of attribute message.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#payload-instance_method" title="#payload (instance method)">- (Object) <strong>payload</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="note title readonly">readonly</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Returns the value of attribute payload.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#request-instance_method" title="#request (instance method)">- (Object) <strong>request</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="note title readonly">readonly</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Returns the value of attribute request.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#response-instance_method" title="#response (instance method)">- (Object) <strong>response</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="note title readonly">readonly</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Returns the value of attribute response.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#schema_path-instance_method" title="#schema_path (instance method)">- (Object) <strong>schema_path</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="note title readonly">readonly</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Returns the value of attribute schema_path.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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="#call-instance_method" title="#call (instance method)">- (Object) <strong>call</strong> </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'></div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#initialize-instance_method" title="#initialize (instance method)">- (AssertSchema) <strong>initialize</strong>(schema_path, request, response, message, payload = nil) </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
<span class="note title constructor">constructor</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Interface may change.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<div id="constructor_details" class="method_details_list">
|
||||
<h2>Constructor Details</h2>
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="initialize-instance_method">
|
||||
|
||||
- (<tt><span class='object_link'><a href="" title="ActiveModelSerializers::Test::Schema::AssertSchema (class)">AssertSchema</a></span></tt>) <strong>initialize</strong>(schema_path, request, response, message, payload = nil)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Interface may change.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
40
|
||||
41
|
||||
42
|
||||
43
|
||||
44
|
||||
45
|
||||
46
|
||||
47
|
||||
48
|
||||
49</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/test/schema.rb', line 40</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_schema_path'>schema_path</span><span class='comma'>,</span> <span class='id identifier rubyid_request'>request</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_require_json_schema!'>require_json_schema!</span>
|
||||
<span class='ivar'>@request</span> <span class='op'>=</span> <span class='id identifier rubyid_request'>request</span>
|
||||
<span class='ivar'>@response</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span>
|
||||
<span class='ivar'>@payload</span> <span class='op'>=</span> <span class='id identifier rubyid_payload'>payload</span>
|
||||
<span class='ivar'>@schema_path</span> <span class='op'>=</span> <span class='id identifier rubyid_schema_path'>schema_path</span> <span class='op'>||</span> <span class='id identifier rubyid_schema_path_default'>schema_path_default</span>
|
||||
<span class='ivar'>@message</span> <span class='op'>=</span> <span class='id identifier rubyid_message'>message</span>
|
||||
<span class='ivar'>@document_store</span> <span class='op'>=</span> <span class='const'>JsonSchema</span><span class='op'>::</span><span class='const'>DocumentStore</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
|
||||
<span class='id identifier rubyid_add_schema_to_document_store'>add_schema_to_document_store</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="instance_attr_details" class="attr_details">
|
||||
<h2>Instance Attribute Details</h2>
|
||||
|
||||
|
||||
<span id=""></span>
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="message-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>message</strong> <span class="extras">(readonly)</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Returns the value of attribute message</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
37
|
||||
38
|
||||
39</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/test/schema.rb', line 37</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_message'>message</span>
|
||||
<span class='ivar'>@message</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
|
||||
<span id=""></span>
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="payload-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>payload</strong> <span class="extras">(readonly)</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Returns the value of attribute payload</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
37
|
||||
38
|
||||
39</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/test/schema.rb', line 37</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_payload'>payload</span>
|
||||
<span class='ivar'>@payload</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
|
||||
<span id=""></span>
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="request-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>request</strong> <span class="extras">(readonly)</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Returns the value of attribute request</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
37
|
||||
38
|
||||
39</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/test/schema.rb', line 37</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_request'>request</span>
|
||||
<span class='ivar'>@request</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
|
||||
<span id=""></span>
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="response-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>response</strong> <span class="extras">(readonly)</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Returns the value of attribute response</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
37
|
||||
38
|
||||
39</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/test/schema.rb', line 37</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_response'>response</span>
|
||||
<span class='ivar'>@response</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
|
||||
<span id=""></span>
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="schema_path-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>schema_path</strong> <span class="extras">(readonly)</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Returns the value of attribute schema_path</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
37
|
||||
38
|
||||
39</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/test/schema.rb', line 37</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_schema_path'>schema_path</span>
|
||||
<span class='ivar'>@schema_path</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="instance_method_details" class="method_details_list">
|
||||
<h2>Instance Method Details</h2>
|
||||
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="call-instance_method">
|
||||
|
||||
- (<tt>Object</tt>) <strong>call</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
51
|
||||
52
|
||||
53
|
||||
54
|
||||
55
|
||||
56</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/test/schema.rb', line 51</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span>
|
||||
<span class='id identifier rubyid_json_schema'>json_schema</span><span class='period'>.</span><span class='id identifier rubyid_expand_references!'>expand_references!</span><span class='lparen'>(</span><span class='label'>store:</span> <span class='id identifier rubyid_document_store'>document_store</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='id identifier rubyid_errors'>errors</span> <span class='op'>=</span> <span class='id identifier rubyid_json_schema'>json_schema</span><span class='period'>.</span><span class='id identifier rubyid_validate'>validate</span><span class='lparen'>(</span><span class='id identifier rubyid_response_body'>response_body</span><span class='rparen'>)</span>
|
||||
<span class='ivar'>@message</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_errors'>errors</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:to_s</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_sentence'>to_sentence</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>: </span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_status'>status</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Mon Jun 13 21:53:39 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>
|
||||
@ -218,9 +218,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:37 2016 by
|
||||
Generated on Mon Jun 13 21:53:37 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -701,9 +701,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:39 2016 by
|
||||
Generated on Mon Jun 13 21:53:39 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
2
Gemfile
2
Gemfile
@ -1,2 +0,0 @@
|
||||
source 'https://rubygems.org'
|
||||
gem 'github-pages', group: :jekyll_plugins
|
||||
133
Gemfile.lock
133
Gemfile.lock
@ -1,133 +0,0 @@
|
||||
GEM
|
||||
remote: https://rubygems.org/
|
||||
specs:
|
||||
RedCloth (4.2.9)
|
||||
activesupport (4.2.6)
|
||||
i18n (~> 0.7)
|
||||
json (~> 1.7, >= 1.7.7)
|
||||
minitest (~> 5.1)
|
||||
thread_safe (~> 0.3, >= 0.3.4)
|
||||
tzinfo (~> 1.1)
|
||||
addressable (2.4.0)
|
||||
coffee-script (2.4.1)
|
||||
coffee-script-source
|
||||
execjs
|
||||
coffee-script-source (1.10.0)
|
||||
colorator (0.1)
|
||||
ethon (0.8.1)
|
||||
ffi (>= 1.3.0)
|
||||
execjs (2.6.0)
|
||||
faraday (0.9.2)
|
||||
multipart-post (>= 1.2, < 3)
|
||||
ffi (1.9.10)
|
||||
gemoji (2.1.0)
|
||||
github-pages (68)
|
||||
RedCloth (= 4.2.9)
|
||||
github-pages-health-check (= 1.1.0)
|
||||
jekyll (= 3.0.3)
|
||||
jekyll-coffeescript (= 1.0.1)
|
||||
jekyll-feed (= 0.4.0)
|
||||
jekyll-gist (= 1.4.0)
|
||||
jekyll-github-metadata (= 1.10.0)
|
||||
jekyll-mentions (= 1.1.2)
|
||||
jekyll-paginate (= 1.1.0)
|
||||
jekyll-redirect-from (= 0.10.0)
|
||||
jekyll-sass-converter (= 1.3.0)
|
||||
jekyll-seo-tag (= 1.3.3)
|
||||
jekyll-sitemap (= 0.10.0)
|
||||
jekyll-textile-converter (= 0.1.0)
|
||||
jemoji (= 0.6.2)
|
||||
kramdown (= 1.10.0)
|
||||
liquid (= 3.0.6)
|
||||
mercenary (~> 0.3)
|
||||
rdiscount (= 2.1.8)
|
||||
redcarpet (= 3.3.3)
|
||||
rouge (= 1.10.1)
|
||||
terminal-table (~> 1.4)
|
||||
github-pages-health-check (1.1.0)
|
||||
addressable (~> 2.3)
|
||||
net-dns (~> 0.8)
|
||||
octokit (~> 4.0)
|
||||
public_suffix (~> 1.4)
|
||||
typhoeus (~> 0.7)
|
||||
html-pipeline (2.3.0)
|
||||
activesupport (>= 2, < 5)
|
||||
nokogiri (>= 1.4)
|
||||
i18n (0.7.0)
|
||||
jekyll (3.0.3)
|
||||
colorator (~> 0.1)
|
||||
jekyll-sass-converter (~> 1.0)
|
||||
jekyll-watch (~> 1.1)
|
||||
kramdown (~> 1.3)
|
||||
liquid (~> 3.0)
|
||||
mercenary (~> 0.3.3)
|
||||
rouge (~> 1.7)
|
||||
safe_yaml (~> 1.0)
|
||||
jekyll-coffeescript (1.0.1)
|
||||
coffee-script (~> 2.2)
|
||||
jekyll-feed (0.4.0)
|
||||
jekyll-gist (1.4.0)
|
||||
octokit (~> 4.2)
|
||||
jekyll-github-metadata (1.10.0)
|
||||
octokit (~> 4.0)
|
||||
jekyll-mentions (1.1.2)
|
||||
html-pipeline (~> 2.3)
|
||||
jekyll (~> 3.0)
|
||||
jekyll-paginate (1.1.0)
|
||||
jekyll-redirect-from (0.10.0)
|
||||
jekyll (>= 2.0)
|
||||
jekyll-sass-converter (1.3.0)
|
||||
sass (~> 3.2)
|
||||
jekyll-seo-tag (1.3.3)
|
||||
jekyll (~> 3.0)
|
||||
jekyll-sitemap (0.10.0)
|
||||
jekyll-textile-converter (0.1.0)
|
||||
RedCloth (~> 4.0)
|
||||
jekyll-watch (1.3.1)
|
||||
listen (~> 3.0)
|
||||
jemoji (0.6.2)
|
||||
gemoji (~> 2.0)
|
||||
html-pipeline (~> 2.2)
|
||||
jekyll (>= 3.0)
|
||||
json (1.8.3)
|
||||
kramdown (1.10.0)
|
||||
liquid (3.0.6)
|
||||
listen (3.0.6)
|
||||
rb-fsevent (>= 0.9.3)
|
||||
rb-inotify (>= 0.9.7)
|
||||
mercenary (0.3.5)
|
||||
mini_portile2 (2.0.0)
|
||||
minitest (5.8.4)
|
||||
multipart-post (2.0.0)
|
||||
net-dns (0.8.0)
|
||||
nokogiri (1.6.7.2)
|
||||
mini_portile2 (~> 2.0.0.rc2)
|
||||
octokit (4.3.0)
|
||||
sawyer (~> 0.7.0, >= 0.5.3)
|
||||
public_suffix (1.5.3)
|
||||
rb-fsevent (0.9.7)
|
||||
rb-inotify (0.9.7)
|
||||
ffi (>= 0.5.0)
|
||||
rdiscount (2.1.8)
|
||||
redcarpet (3.3.3)
|
||||
rouge (1.10.1)
|
||||
safe_yaml (1.0.4)
|
||||
sass (3.4.22)
|
||||
sawyer (0.7.0)
|
||||
addressable (>= 2.3.5, < 2.5)
|
||||
faraday (~> 0.8, < 0.10)
|
||||
terminal-table (1.5.2)
|
||||
thread_safe (0.3.5)
|
||||
typhoeus (0.8.0)
|
||||
ethon (>= 0.8.0)
|
||||
tzinfo (1.2.2)
|
||||
thread_safe (~> 0.1)
|
||||
|
||||
PLATFORMS
|
||||
ruby
|
||||
|
||||
DEPENDENCIES
|
||||
github-pages
|
||||
|
||||
BUNDLED WITH
|
||||
1.11.2
|
||||
@ -124,9 +124,9 @@ render helper in Grape::Helpers::ActiveModelSerializers</p>
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:37 2016 by
|
||||
Generated on Mon Jun 13 21:53:37 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -101,9 +101,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:35 2016 by
|
||||
Generated on Mon Jun 13 21:53:36 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -106,9 +106,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:37 2016 by
|
||||
Generated on Mon Jun 13 21:53:37 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -169,9 +169,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:37 2016 by
|
||||
Generated on Mon Jun 13 21:53:37 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
@ -106,9 +106,9 @@
|
||||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Tue Apr 5 11:04:37 2016 by
|
||||
Generated on Mon Jun 13 21:53:37 2016 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.8.7.6 (ruby-2.2.2).
|
||||
0.8.7.6 (ruby-2.2.4).
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user