<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: JsonapiCompliable::Sideload
— Documentation by YARD 0.9.9
</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">
pathId = "JsonapiCompliable::Sideload";
relpath = '../';
</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 class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (S)</a> »
<span class='title'><span class='object_link'><a href="../JsonapiCompliable.html" title="JsonapiCompliable (module)">JsonapiCompliable</a></span></span>
»
<span class="title">Sideload</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: JsonapiCompliable::Sideload
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">JsonapiCompliable::Sideload</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/jsonapi_compliable/sideload.rb</dd>
</dl>
</div>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="HOOK_ACTIONS-constant" class="">HOOK_ACTIONS =
</dt>
<dd><pre class="code"><span class='lbracket'>[</span><span class='symbol'>:save</span><span class='comma'>,</span> <span class='symbol'>:create</span><span class='comma'>,</span> <span class='symbol'>:update</span><span class='comma'>,</span> <span class='symbol'>:destroy</span><span class='comma'>,</span> <span class='symbol'>:disassociate</span><span class='rbracket'>]</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="#assign_proc-instance_method" title="#assign_proc (instance method)">#<strong>assign_proc</strong> ⇒ Proc </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>The configured 'assign' block.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#foreign_key-instance_method" title="#foreign_key (instance method)">#<strong>foreign_key</strong> ⇒ Symbol </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>The attribute used to match objects - need not be a true database foreign
key.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#grouping_field-instance_method" title="#grouping_field (instance method)">#<strong>grouping_field</strong> ⇒ Symbol </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>The configured 'group_by' symbol.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> ⇒ Symbol </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>The name of the sideload.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#parent-instance_method" title="#parent (instance method)">#<strong>parent</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute parent.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#polymorphic-instance_method" title="#polymorphic (instance method)">#<strong>polymorphic</strong> ⇒ Boolean </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Is this a polymorphic sideload?.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#polymorphic_groups-instance_method" title="#polymorphic_groups (instance method)">#<strong>polymorphic_groups</strong> ⇒ Hash </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>The subgroups, when polymorphic.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#primary_key-instance_method" title="#primary_key (instance method)">#<strong>primary_key</strong> ⇒ Symbol </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>The attribute used to match objects - need not be a true database primary
key.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#resource_class-instance_method" title="#resource_class (instance method)">#<strong>resource_class</strong> ⇒ Class </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>The corresponding Resource class.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#scope_proc-instance_method" title="#scope_proc (instance method)">#<strong>scope_proc</strong> ⇒ Proc </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>The configured 'scope' block.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#sideloads-instance_method" title="#sideloads (instance method)">#<strong>sideloads</strong> ⇒ Hash </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>The associated sibling sideloads.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#type-instance_method" title="#type (instance method)">#<strong>type</strong> ⇒ Symbol </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>One of :has_many, :belongs_to, etc.</p>
</div></span>
</li>
</ul>
<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="#max_depth-class_method" title="max_depth (class method)">.<strong>max_depth</strong> ⇒ Object </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="#max_depth=-class_method" title="max_depth= (class method)">.<strong>max_depth=</strong>(val) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Set maximum levels of sideload recursion /authors?comments.authors would be
one level /authors?comments.authors.comments.authors would be two levels
etc.</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="#after_save-instance_method" title="#after_save (instance method)">#<strong>after_save</strong>(only: [], except: [], &blk) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Configure post-processing hooks.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#all_sideloads-instance_method" title="#all_sideloads (instance method)">#<strong>all_sideloads</strong> ⇒ Object </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="#allow_sideload-instance_method" title="#allow_sideload (instance method)">#<strong>allow_sideload</strong>(name, opts = {}, &blk) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Configure a relationship between Resource objects.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#assign-instance_method" title="#assign (instance method)">#<strong>assign</strong> {|parents, children| ... } ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The proc used to assign the resolved parents and children.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#associate-instance_method" title="#associate (instance method)">#<strong>associate</strong>(parent, child) ⇒ Object </a>
</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'>
<p>Configure how to associate parent and child records.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#disassociate-instance_method" title="#disassociate (instance method)">#<strong>disassociate</strong>(parent, child) ⇒ Object </a>
</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'>
<p>Configure how to disassociate parent and child records.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fire_hooks!-instance_method" title="#fire_hooks! (instance method)">#<strong>fire_hooks!</strong>(parent, objects, method) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#group_by-instance_method" title="#group_by (instance method)">#<strong>group_by</strong>(grouping_field) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Define an attribute that groups the parent records.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#hooks-instance_method" title="#hooks (instance method)">#<strong>hooks</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Get the hooks the user has configured.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(name, type: nil, resource: nil, polymorphic: false, primary_key: :id, foreign_key: nil, parent: nil) ⇒ Sideload </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>NB - the adapter's <code>#sideloading_module</code> is mixed in on
instantiation.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#polymorphic%3F-instance_method" title="#polymorphic? (instance method)">#<strong>polymorphic?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Is this sideload polymorphic?.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#polymorphic_child_for_type-instance_method" title="#polymorphic_child_for_type (instance method)">#<strong>polymorphic_child_for_type</strong>(type) ⇒ Object </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="#resolve-instance_method" title="#resolve (instance method)">#<strong>resolve</strong>(parents, query, namespace = nil) ⇒ void </a>
</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'>
<p>Resolve the sideload.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#resource-instance_method" title="#resource (instance method)">#<strong>resource</strong> ⇒ Resource </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>An instance of <code>#resource_class</code>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#scope-instance_method" title="#scope (instance method)">#<strong>scope</strong> {|parents| ... } ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Build a scope that will be used to fetch the related records This scope
will be further chained with filtering/sorting/etc.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#sideload-instance_method" title="#sideload (instance method)">#<strong>sideload</strong>(name) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Fetch a Sideload object by its name.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_hash-instance_method" title="#to_hash (instance method)">#<strong>to_hash</strong>(depth_chain = [], parent = nil) ⇒ Hash </a>
</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'>
<p>Looks at all nested sideload, and all nested sideloads for the
corresponding Resources, and returns an Include Directive hash.</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">
#<strong>initialize</strong>(name, type: nil, resource: nil, polymorphic: false, primary_key: :id, foreign_key: nil, parent: nil) ⇒ <tt><span class='object_link'><a href="" title="JsonapiCompliable::Sideload (class)">Sideload</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>NB - the adapter's <code>#sideloading_module</code> is mixed in on
instantiation</p>
<p>An anonymous Resource will be assigned when none provided.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="Adapters/Abstract.html#sideloading_module-instance_method" title="JsonapiCompliable::Adapters::Abstract#sideloading_module (method)">Adapters::Abstract#sideloading_module</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
32
33
34
35
36
37
38
39
40
41
42
43
44</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 32</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='label'>type:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>resource:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>polymorphic:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>primary_key:</span> <span class='symbol'>:id</span><span class='comma'>,</span> <span class='label'>foreign_key:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='ivar'>@name</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
<span class='ivar'>@resource_class</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span> <span class='op'>||</span> <span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Resource.html" title="JsonapiCompliable::Resource (class)">Resource</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='ivar'>@sideloads</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='ivar'>@polymorphic</span> <span class='op'>=</span> <span class='op'>!</span><span class='op'>!</span><span class='id identifier rubyid_polymorphic'>polymorphic</span>
<span class='ivar'>@polymorphic_groups</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='kw'>if</span> <span class='id identifier rubyid_polymorphic?'>polymorphic?</span>
<span class='ivar'>@parent</span> <span class='op'>=</span> <span class='id identifier rubyid_parent'>parent</span>
<span class='ivar'>@primary_key</span> <span class='op'>=</span> <span class='id identifier rubyid_primary_key'>primary_key</span>
<span class='ivar'>@foreign_key</span> <span class='op'>=</span> <span class='id identifier rubyid_foreign_key'>foreign_key</span>
<span class='ivar'>@type</span> <span class='op'>=</span> <span class='id identifier rubyid_type'>type</span>
<span class='id identifier rubyid_extend'>extend</span> <span class='ivar'>@resource_class</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='lbracket'>[</span><span class='symbol'>:adapter</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_sideloading_module'>sideloading_module</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="assign_proc-instance_method">
#<strong>assign_proc</strong> ⇒ <tt>Proc</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>The configured 'assign' block</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Proc</tt>)</span>
—
<div class='inline'>
<p>the current value of assign_proc</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_assign_proc'>assign_proc</span>
<span class='ivar'>@assign_proc</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="foreign_key-instance_method">
#<strong>foreign_key</strong> ⇒ <tt>Symbol</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>The attribute used to match objects - need not be a true database foreign
key.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Symbol</tt>)</span>
—
<div class='inline'>
<p>the current value of foreign_key</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_foreign_key'>foreign_key</span>
<span class='ivar'>@foreign_key</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="grouping_field-instance_method">
#<strong>grouping_field</strong> ⇒ <tt>Symbol</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>The configured 'group_by' symbol</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Symbol</tt>)</span>
—
<div class='inline'>
<p>the current value of grouping_field</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_grouping_field'>grouping_field</span>
<span class='ivar'>@grouping_field</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="name-instance_method">
#<strong>name</strong> ⇒ <tt>Symbol</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>The name of the sideload</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Symbol</tt>)</span>
—
<div class='inline'>
<p>the current value of name</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
<span class='ivar'>@name</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="parent-instance_method">
#<strong>parent</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute parent</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
14
15
16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 14</span>
<span class='kw'>def</span> <span class='id identifier rubyid_parent'>parent</span>
<span class='ivar'>@parent</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="polymorphic-instance_method">
#<strong>polymorphic</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Is this a polymorphic sideload?</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'>
<p>the current value of polymorphic</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_polymorphic'>polymorphic</span>
<span class='ivar'>@polymorphic</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="polymorphic_groups-instance_method">
#<strong>polymorphic_groups</strong> ⇒ <tt>Hash</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>The subgroups, when polymorphic</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash</tt>)</span>
—
<div class='inline'>
<p>the current value of polymorphic_groups</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_polymorphic_groups'>polymorphic_groups</span>
<span class='ivar'>@polymorphic_groups</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="primary_key-instance_method">
#<strong>primary_key</strong> ⇒ <tt>Symbol</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>The attribute used to match objects - need not be a true database primary
key.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Symbol</tt>)</span>
—
<div class='inline'>
<p>the current value of primary_key</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_primary_key'>primary_key</span>
<span class='ivar'>@primary_key</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="resource_class-instance_method">
#<strong>resource_class</strong> ⇒ <tt>Class</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>The corresponding Resource class</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Class</tt>)</span>
—
<div class='inline'>
<p>the current value of resource_class</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_resource_class'>resource_class</span>
<span class='ivar'>@resource_class</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="scope_proc-instance_method">
#<strong>scope_proc</strong> ⇒ <tt>Proc</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>The configured 'scope' block</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Proc</tt>)</span>
—
<div class='inline'>
<p>the current value of scope_proc</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_scope_proc'>scope_proc</span>
<span class='ivar'>@scope_proc</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="sideloads-instance_method">
#<strong>sideloads</strong> ⇒ <tt>Hash</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>The associated sibling sideloads</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash</tt>)</span>
—
<div class='inline'>
<p>the current value of sideloads</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_sideloads'>sideloads</span>
<span class='ivar'>@sideloads</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="type-instance_method">
#<strong>type</strong> ⇒ <tt>Symbol</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>One of :has_many, :belongs_to, etc</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Symbol</tt>)</span>
—
<div class='inline'>
<p>the current value of type</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span>
<span class='ivar'>@type</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="max_depth-class_method">
.<strong>max_depth</strong> ⇒ <tt>Object</tt>
</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">
47
48
49</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 47</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_max_depth'>max_depth</span>
<span class='ivar'>@max_depth</span> <span class='op'>||</span> <span class='int'>2</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="max_depth=-class_method">
.<strong>max_depth=</strong>(val) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Set maximum levels of sideload recursion /authors?comments.authors would be
one level /authors?comments.authors.comments.authors would be two levels
etc</p>
<p>Default max depth is 2</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
57
58
59</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 57</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_max_depth='>max_depth=</span><span class='lparen'>(</span><span class='id identifier rubyid_val'>val</span><span class='rparen'>)</span>
<span class='ivar'>@max_depth</span> <span class='op'>=</span> <span class='id identifier rubyid_val'>val</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="after_save-instance_method">
#<strong>after_save</strong>(only: [], except: [], &blk) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Configure post-processing hooks</p>
<p>In particular, helpful for bulk operations. “after_save” will fire for any
persistence method - <code>:create</code>, <code>:update</code>,
<code>:destroy</code>, <code>:disassociate</code>. Use “only” and “except”
keyword arguments to fire only for a specific persistence method.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>Bulk Notify Users on Invite</p>
</div></p>
<pre class="example code"><code><span class='kw'>class</span> <span class='const'>ProjectResource</span> <span class='op'><</span> <span class='const'>ApplicationResource</span>
<span class='comment'># ... code ...
</span> <span class='id identifier rubyid_allow_sideload'>allow_sideload</span> <span class='symbol'>:users</span><span class='comma'>,</span> <span class='label'>resource:</span> <span class='const'>UserResource</span> <span class='kw'>do</span>
<span class='comment'># scope {}
</span> <span class='comment'># assign {}
</span> <span class='id identifier rubyid_after_save'>after_save</span> <span class='label'>only:</span> <span class='lbracket'>[</span><span class='symbol'>:create</span><span class='rbracket'>]</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_project'>project</span><span class='comma'>,</span> <span class='id identifier rubyid_users'>users</span><span class='op'>|</span>
<span class='const'>UserMailer</span><span class='period'>.</span><span class='id identifier rubyid_invite'>invite</span><span class='lparen'>(</span><span class='id identifier rubyid_project'>project</span><span class='comma'>,</span> <span class='id identifier rubyid_users'>users</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_deliver_later'>deliver_later</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></code></pre>
</div>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#hooks-instance_method" title="JsonapiCompliable::Sideload#hooks (method)">#hooks</a></span></li>
<li><span class='object_link'><a href="Util/Persistence.html" title="JsonapiCompliable::Util::Persistence (class)">Util::Persistence</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
232
233
234
235
236
237
238
239</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 232</span>
<span class='kw'>def</span> <span class='id identifier rubyid_after_save'>after_save</span><span class='lparen'>(</span><span class='label'>only:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>except:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_blk'>blk</span><span class='rparen'>)</span>
<span class='id identifier rubyid_actions'>actions</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#HOOK_ACTIONS-constant" title="JsonapiCompliable::Sideload::HOOK_ACTIONS (constant)">HOOK_ACTIONS</a></span></span> <span class='op'>-</span> <span class='id identifier rubyid_except'>except</span>
<span class='id identifier rubyid_actions'>actions</span> <span class='op'>=</span> <span class='id identifier rubyid_only'>only</span> <span class='op'>&</span> <span class='id identifier rubyid_actions'>actions</span>
<span class='id identifier rubyid_actions'>actions</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='symbol'>:save</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_only'>only</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> <span class='op'>&&</span> <span class='id identifier rubyid_except'>except</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
<span class='id identifier rubyid_actions'>actions</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_a'>a</span><span class='op'>|</span>
<span class='id identifier rubyid_hooks'>hooks</span><span class='lbracket'>[</span><span class='symbol'>:after_</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_a'>a</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'><<</span> <span class='id identifier rubyid_blk'>blk</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="all_sideloads-instance_method">
#<strong>all_sideloads</strong> ⇒ <tt>Object</tt>
</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">
350
351
352
353
354
355
356
357
358
359
360</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 350</span>
<span class='kw'>def</span> <span class='id identifier rubyid_all_sideloads'>all_sideloads</span>
<span class='lbrace'>{</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_all'>all</span><span class='op'>|</span>
<span class='kw'>if</span> <span class='id identifier rubyid_polymorphic?'>polymorphic?</span>
<span class='id identifier rubyid_polymorphic_groups'>polymorphic_groups</span><span class='period'>.</span><span class='id identifier rubyid_each_pair'>each_pair</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='id identifier rubyid_sl'>sl</span><span class='op'>|</span>
<span class='id identifier rubyid_all'>all</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_sl'>sl</span><span class='period'>.</span><span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_sideloading'>sideloading</span><span class='period'>.</span><span class='id identifier rubyid_all_sideloads'>all_sideloads</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_all'>all</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='ivar'>@sideloads</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_sideloading'>sideloading</span><span class='period'>.</span><span class='id identifier rubyid_sideloads'>sideloads</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="allow_sideload-instance_method">
#<strong>allow_sideload</strong>(name, opts = {}, &blk) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Configure a relationship between Resource objects</p>
<p>You probably want to extract this logic into an adapter rather than using
directly</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>Default ActiveRecord</p>
</div></p>
<pre class="example code"><code><span class='comment'># What happens 'under the hood'
</span><span class='kw'>class</span> <span class='const'>CommentResource</span> <span class='op'><</span> <span class='const'>ApplicationResource</span>
<span class='comment'># ... code ...
</span> <span class='id identifier rubyid_allow_sideload'>allow_sideload</span> <span class='symbol'>:post</span><span class='comma'>,</span> <span class='label'>resource:</span> <span class='const'>PostResource</span> <span class='kw'>do</span>
<span class='id identifier rubyid_scope'>scope</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_comments'>comments</span><span class='op'>|</span>
<span class='const'>Post</span><span class='period'>.</span><span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='id identifier rubyid_comments'>comments</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:post_id</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_assign'>assign</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_comments'>comments</span><span class='comma'>,</span> <span class='id identifier rubyid_posts'>posts</span><span class='op'>|</span>
<span class='id identifier rubyid_comments'>comments</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_comment'>comment</span><span class='op'>|</span>
<span class='id identifier rubyid_relevant_post'>relevant_post</span> <span class='op'>=</span> <span class='id identifier rubyid_posts'>posts</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_p'>p</span><span class='op'>|</span> <span class='id identifier rubyid_p'>p</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> <span class='op'>==</span> <span class='id identifier rubyid_comment'>comment</span><span class='period'>.</span><span class='id identifier rubyid_post_id'>post_id</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_comment'>comment</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span> <span class='op'>=</span> <span class='id identifier rubyid_relevant_post'>relevant_post</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='comment'># Rather than writing that code directly, go through the adapter:
</span><span class='kw'>class</span> <span class='const'>CommentResource</span> <span class='op'><</span> <span class='const'>ApplicationResource</span>
<span class='comment'># ... code ...
</span> <span class='id identifier rubyid_use_adapter'>use_adapter</span> <span class='const'><span class='object_link'><a href="../JsonapiCompliable.html" title="JsonapiCompliable (module)">JsonapiCompliable</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Adapters.html" title="JsonapiCompliable::Adapters (module)">Adapters</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Adapters/ActiveRecord.html" title="JsonapiCompliable::Adapters::ActiveRecord (class)">ActiveRecord</a></span></span>
<span class='id identifier rubyid_belongs_to'>belongs_to</span> <span class='symbol'>:post</span><span class='comma'>,</span>
<span class='label'>scope:</span> <span class='tlambda'>-></span> <span class='tlambeg'>{</span> <span class='const'>Post</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span> <span class='rbrace'>}</span><span class='comma'>,</span>
<span class='label'>resource:</span> <span class='const'>PostResource</span><span class='comma'>,</span>
<span class='label'>foreign_key:</span> <span class='symbol'>:post_id</span>
<span class='kw'>end</span></code></pre>
</div>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'>
<p>void</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="Adapters/ActiveRecordSideloading.html#belongs_to-instance_method" title="JsonapiCompliable::Adapters::ActiveRecordSideloading#belongs_to (method)">Adapters::ActiveRecordSideloading#belongs_to</a></span></li>
<li><span class='object_link'><a href="#assign-instance_method" title="JsonapiCompliable::Sideload#assign (method)">#assign</a></span></li>
<li><span class='object_link'><a href="#scope-instance_method" title="JsonapiCompliable::Sideload#scope (method)">#scope</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
330
331
332
333
334
335
336
337
338
339</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 330</span>
<span class='kw'>def</span> <span class='id identifier rubyid_allow_sideload'>allow_sideload</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</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_blk'>blk</span><span class='rparen'>)</span>
<span class='id identifier rubyid_sideload'>sideload</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="JsonapiCompliable::Sideload (class)">Sideload</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="JsonapiCompliable::Sideload#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_sideload'>sideload</span><span class='period'>.</span><span class='id identifier rubyid_instance_eval'>instance_eval</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_blk'>blk</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_blk'>blk</span>
<span class='kw'>if</span> <span class='id identifier rubyid_polymorphic?'>polymorphic?</span>
<span class='ivar'>@polymorphic_groups</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_sideload'>sideload</span>
<span class='kw'>else</span>
<span class='ivar'>@sideloads</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_sideload'>sideload</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="assign-instance_method">
#<strong>assign</strong> {|parents, children| ... } ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The proc used to assign the resolved parents and children.</p>
<p>You probably want to wrap this logic in an Adapter, instead of specifying
in your resource directly.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>Default ActiveRecord</p>
</div></p>
<pre class="example code"><code><span class='kw'>class</span> <span class='const'>PostResource</span> <span class='op'><</span> <span class='const'>ApplicationResource</span>
<span class='comment'># ... code ...
</span> <span class='id identifier rubyid_allow_sideload'>allow_sideload</span> <span class='symbol'>:comments</span><span class='comma'>,</span> <span class='label'>resource:</span> <span class='const'>CommentResource</span> <span class='kw'>do</span>
<span class='comment'># ... code ...
</span> <span class='id identifier rubyid_assign'>assign</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_posts'>posts</span><span class='comma'>,</span> <span class='id identifier rubyid_comments'>comments</span><span class='op'>|</span>
<span class='id identifier rubyid_posts'>posts</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_post'>post</span><span class='op'>|</span>
<span class='id identifier rubyid_relevant_comments'>relevant_comments</span> <span class='op'>=</span> <span class='id identifier rubyid_comments'>comments</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_c'>c</span><span class='op'>|</span> <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_post_id'>post_id</span> <span class='op'>==</span> <span class='id identifier rubyid_post'>post</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_post'>post</span><span class='period'>.</span><span class='id identifier rubyid_comments'>comments</span> <span class='op'>=</span> <span class='id identifier rubyid_relevant_comments'>relevant_comments</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></code></pre>
<p class="example_title"><div class='inline'>
<p>ActiveRecord via Adapter</p>
</div></p>
<pre class="example code"><code><span class='kw'>class</span> <span class='const'>PostResource</span> <span class='op'><</span> <span class='const'>ApplicationResource</span>
<span class='comment'># ... code ...
</span> <span class='id identifier rubyid_has_many'>has_many</span> <span class='symbol'>:comments</span><span class='comma'>,</span>
<span class='label'>scope:</span> <span class='tlambda'>-></span> <span class='tlambeg'>{</span> <span class='const'>Comment</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span> <span class='rbrace'>}</span><span class='comma'>,</span>
<span class='label'>resource:</span> <span class='const'>CommentResource</span><span class='comma'>,</span>
<span class='label'>foreign_key:</span> <span class='symbol'>:post_id</span>
<span class='kw'>end</span></code></pre>
</div>
<p class="tag_title">Yield Parameters:</p>
<ul class="yieldparam">
<li>
<span class='name'>parents</span>
<span class='type'></span>
—
<div class='inline'><ul><li>
<p>The resolved parent records</p>
</li></ul>
</div>
</li>
<li>
<span class='name'>children</span>
<span class='type'></span>
—
<div class='inline'><ul><li>
<p>The resolved child records</p>
</li></ul>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="Adapters/Abstract.html" title="JsonapiCompliable::Adapters::Abstract (class)">Adapters::Abstract</a></span></li>
<li><span class='object_link'><a href="Adapters/ActiveRecordSideloading.html#has_many-instance_method" title="JsonapiCompliable::Adapters::ActiveRecordSideloading#has_many (method)">Adapters::ActiveRecordSideloading#has_many</a></span></li>
<li><span class='object_link'><a href="#allow_sideload-instance_method" title="JsonapiCompliable::Sideload#allow_sideload (method)">#allow_sideload</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
183
184
185</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 183</span>
<span class='kw'>def</span> <span class='id identifier rubyid_assign'>assign</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_blk'>blk</span><span class='rparen'>)</span>
<span class='ivar'>@assign_proc</span> <span class='op'>=</span> <span class='id identifier rubyid_blk'>blk</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="associate-instance_method">
#<strong>associate</strong>(parent, child) ⇒ <tt>Object</tt>
</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>Configure how to associate parent and child records. Delegates to #resource</p>
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#name-instance_method" title="JsonapiCompliable::Sideload#name (method)">#name</a></span></li>
<li><span class='object_link'><a href="#type-instance_method" title="JsonapiCompliable::Sideload#type (method)">#type</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
193
194
195
196</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 193</span>
<span class='kw'>def</span> <span class='id identifier rubyid_associate'>associate</span><span class='lparen'>(</span><span class='id identifier rubyid_parent'>parent</span><span class='comma'>,</span> <span class='id identifier rubyid_child'>child</span><span class='rparen'>)</span>
<span class='id identifier rubyid_association_name'>association_name</span> <span class='op'>=</span> <span class='ivar'>@parent</span> <span class='op'>?</span> <span class='ivar'>@parent</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>:</span> <span class='id identifier rubyid_name'>name</span>
<span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_associate'>associate</span><span class='lparen'>(</span><span class='id identifier rubyid_parent'>parent</span><span class='comma'>,</span> <span class='id identifier rubyid_child'>child</span><span class='comma'>,</span> <span class='id identifier rubyid_association_name'>association_name</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="disassociate-instance_method">
#<strong>disassociate</strong>(parent, child) ⇒ <tt>Object</tt>
</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>Configure how to disassociate parent and child records. Delegates to
#resource</p>
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#name-instance_method" title="JsonapiCompliable::Sideload#name (method)">#name</a></span></li>
<li><span class='object_link'><a href="#type-instance_method" title="JsonapiCompliable::Sideload#type (method)">#type</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
204
205
206
207</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 204</span>
<span class='kw'>def</span> <span class='id identifier rubyid_disassociate'>disassociate</span><span class='lparen'>(</span><span class='id identifier rubyid_parent'>parent</span><span class='comma'>,</span> <span class='id identifier rubyid_child'>child</span><span class='rparen'>)</span>
<span class='id identifier rubyid_association_name'>association_name</span> <span class='op'>=</span> <span class='ivar'>@parent</span> <span class='op'>?</span> <span class='ivar'>@parent</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>:</span> <span class='id identifier rubyid_name'>name</span>
<span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_disassociate'>disassociate</span><span class='lparen'>(</span><span class='id identifier rubyid_parent'>parent</span><span class='comma'>,</span> <span class='id identifier rubyid_child'>child</span><span class='comma'>,</span> <span class='id identifier rubyid_association_name'>association_name</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fire_hooks!-instance_method">
#<strong>fire_hooks!</strong>(parent, objects, method) ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
408
409
410
411
412
413
414
415</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 408</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fire_hooks!'>fire_hooks!</span><span class='lparen'>(</span><span class='id identifier rubyid_parent'>parent</span><span class='comma'>,</span> <span class='id identifier rubyid_objects'>objects</span><span class='comma'>,</span> <span class='id identifier rubyid_method'>method</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_hooks'>hooks</span>
<span class='id identifier rubyid_hooks'>hooks</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_hooks'>hooks</span><span class='lbracket'>[</span><span class='symbol'>:after_</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_method'>method</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>+</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_hooks'>hooks</span><span class='lbracket'>[</span><span class='symbol'>:after_save</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_hooks'>hooks</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</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_hook'>hook</span><span class='op'>|</span>
<span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_instance_exec'>instance_exec</span><span class='lparen'>(</span><span class='id identifier rubyid_parent'>parent</span><span class='comma'>,</span> <span class='id identifier rubyid_objects'>objects</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_hook'>hook</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="group_by-instance_method">
#<strong>group_by</strong>(grouping_field) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Define an attribute that groups the parent records. For instance, with an
ActiveRecord polymorphic belongs_to there will be a <code>parent_id</code>
and <code>parent_type</code>. We would want to group on
<code>parent_type</code>:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_allow_sideload'>allow_sideload</span> <span class='symbol'>:organization</span><span class='comma'>,</span> <span class='label'>polymorphic:</span> <span class='kw'>true</span> <span class='kw'>do</span>
<span class='comment'># group parent_type, parent here is 'organization'
</span> <span class='id identifier rubyid_group_by'>group_by</span> <span class='symbol'>:organization_type</span>
<span class='kw'>end</span>
</code></pre>
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#polymorphic%3F-instance_method" title="JsonapiCompliable::Sideload#polymorphic? (method)">#polymorphic?</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
263
264
265</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 263</span>
<span class='kw'>def</span> <span class='id identifier rubyid_group_by'>group_by</span><span class='lparen'>(</span><span class='id identifier rubyid_grouping_field'>grouping_field</span><span class='rparen'>)</span>
<span class='ivar'>@grouping_field</span> <span class='op'>=</span> <span class='id identifier rubyid_grouping_field'>grouping_field</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="hooks-instance_method">
#<strong>hooks</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Get the hooks the user has configured</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'>
<p>hash of hooks, ie <tt>{ after_create: #<Proc>}</tt></p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#after_save-instance_method" title="JsonapiCompliable::Sideload#after_save (method)">#after_save</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
244
245
246
247
248
249
250
251</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 244</span>
<span class='kw'>def</span> <span class='id identifier rubyid_hooks'>hooks</span>
<span class='ivar'>@hooks</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_h'>h</span><span class='op'>|</span>
<span class='const'><span class='object_link'><a href="#HOOK_ACTIONS-constant" title="JsonapiCompliable::Sideload::HOOK_ACTIONS (constant)">HOOK_ACTIONS</a></span></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_a'>a</span><span class='op'>|</span>
<span class='id identifier rubyid_h'>h</span><span class='lbracket'>[</span><span class='symbol'>:after_</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_a'>a</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_h'>h</span><span class='lbracket'>[</span><span class='symbol'>:before_</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_a'>a</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="polymorphic?-instance_method">
#<strong>polymorphic?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Is this sideload polymorphic?</p>
<p>Polymorphic sideloads group the parent objects in some fashion, so
different 'types' can be resolved differently. Let's say an
<code>Office</code> has a polymorphic <code>Organization</code>, which can
be either a <code>Business</code> or <code>Government</code>:</p>
<pre class="code ruby"><code class="ruby">allow_sideload :organization, :polymorphic: true do
group_by :organization_type
allow_sideload 'Business', resource: BusinessResource do
# ... code ...
end
allow_sideload 'Governemnt', resource: GovernmentResource do
# ... code ...
end
end</code></pre>
<p>You probably want to extract this code into an Adapter. For instance, with
ActiveRecord:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_polymorphic_belongs_to'>polymorphic_belongs_to</span> <span class='symbol'>:organization</span><span class='comma'>,</span>
<span class='label'>group_by:</span> <span class='symbol'>:organization_type</span><span class='comma'>,</span>
<span class='label'>groups:</span> <span class='lbrace'>{</span>
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Business</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
<span class='label'>scope:</span> <span class='tlambda'>-></span> <span class='tlambeg'>{</span> <span class='const'>Business</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span> <span class='rbrace'>}</span><span class='comma'>,</span>
<span class='label'>resource:</span> <span class='const'>BusinessResource</span><span class='comma'>,</span>
<span class='label'>foreign_key:</span> <span class='symbol'>:organization_id</span>
<span class='rbrace'>}</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Government</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
<span class='label'>scope:</span> <span class='tlambda'>-></span> <span class='tlambeg'>{</span> <span class='const'>Government</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span> <span class='rbrace'>}</span><span class='comma'>,</span>
<span class='label'>resource:</span> <span class='const'>GovernmentResource</span><span class='comma'>,</span>
<span class='label'>foreign_key:</span> <span class='symbol'>:organization_id</span>
<span class='rbrace'>}</span>
<span class='rbrace'>}</span>
</code></pre>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'>
<p>is this sideload polymorphic?</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="Adapters/ActiveRecordSideloading.html#polymorphic_belongs_to-instance_method" title="JsonapiCompliable::Adapters::ActiveRecordSideloading#polymorphic_belongs_to (method)">Adapters::ActiveRecordSideloading#polymorphic_belongs_to</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
106
107
108</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 106</span>
<span class='kw'>def</span> <span class='id identifier rubyid_polymorphic?'>polymorphic?</span>
<span class='ivar'>@polymorphic</span> <span class='op'>==</span> <span class='kw'>true</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="polymorphic_child_for_type-instance_method">
#<strong>polymorphic_child_for_type</strong>(type) ⇒ <tt>Object</tt>
</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">
402
403
404
405
406</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 402</span>
<span class='kw'>def</span> <span class='id identifier rubyid_polymorphic_child_for_type'>polymorphic_child_for_type</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span>
<span class='id identifier rubyid_polymorphic_groups'>polymorphic_groups</span><span class='period'>.</span><span class='id identifier rubyid_values'>values</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='kw'>do</span> <span class='op'>|</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_resource_class'>resource_class</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_type'>type</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="resolve-instance_method">
#<strong>resolve</strong>(parents, query, namespace = nil) ⇒ <tt>void</tt>
</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 class="note returns_void">This method returns an undefined value.</p>
<p>Resolve the sideload.</p>
<ul><li>
<p>Uses the 'scope' proc to build a 'base scope'</p>
</li><li>
<p>Chains additional criteria onto that 'base scope'</p>
</li><li>
<p>Resolves that scope (see Scope#resolve)</p>
</li><li>
<p>Assigns the resulting child objects to their corresponding parents</p>
</li></ul>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>parents</span>
<span class='type'>(<tt>Object</tt>)</span>
—
<div class='inline'>
<p>The resolved parent models</p>
</div>
</li>
<li>
<span class='name'>query</span>
<span class='type'>(<tt><span class='object_link'><a href="Query.html" title="JsonapiCompliable::Query (class)">Query</a></span></tt>)</span>
—
<div class='inline'>
<p>The Query instance</p>
</div>
</li>
<li>
<span class='name'>namespace</span>
<span class='type'>(<tt>Symbol</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
<p>The current namespace (see Resource#with_context)</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="Scope.html#resolve-instance_method" title="JsonapiCompliable::Scope#resolve (method)">JsonapiCompliable::Scope#resolve</a></span></li>
<li><span class='object_link'><a href="Query.html" title="JsonapiCompliable::Query (class)">Query</a></span></li>
<li><span class='object_link'><a href="Resource.html#with_context-instance_method" title="JsonapiCompliable::Resource#with_context (method)">Resource#with_context</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
282
283
284
285
286
287
288
289
290</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 282</span>
<span class='kw'>def</span> <span class='id identifier rubyid_resolve'>resolve</span><span class='lparen'>(</span><span class='id identifier rubyid_parents'>parents</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='comma'>,</span> <span class='id identifier rubyid_namespace'>namespace</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_namespace'>namespace</span> <span class='op'>||=</span> <span class='id identifier rubyid_name'>name</span>
<span class='kw'>if</span> <span class='id identifier rubyid_polymorphic?'>polymorphic?</span>
<span class='id identifier rubyid_resolve_polymorphic'>resolve_polymorphic</span><span class='lparen'>(</span><span class='id identifier rubyid_parents'>parents</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_resolve_basic'>resolve_basic</span><span class='lparen'>(</span><span class='id identifier rubyid_parents'>parents</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='comma'>,</span> <span class='id identifier rubyid_namespace'>namespace</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="resource-instance_method">
#<strong>resource</strong> ⇒ <tt><span class='object_link'><a href="Resource.html" title="JsonapiCompliable::Resource (class)">Resource</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns an instance of <code>#resource_class</code></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Resource.html" title="JsonapiCompliable::Resource (class)">Resource</a></span></tt>)</span>
—
<div class='inline'>
<p>an instance of <code>#resource_class</code></p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#resource_class-instance_method" title="JsonapiCompliable::Sideload#resource_class (method)">#resource_class</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
63
64
65</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 63</span>
<span class='kw'>def</span> <span class='id identifier rubyid_resource'>resource</span>
<span class='ivar'>@resource</span> <span class='op'>||=</span> <span class='id identifier rubyid_resource_class'>resource_class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="scope-instance_method">
#<strong>scope</strong> {|parents| ... } ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Build a scope that will be used to fetch the related records This scope
will be further chained with filtering/sorting/etc</p>
<p>You probably want to wrap this logic in an Adapter, instead of specifying
in your resource directly.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>Default ActiveRecord</p>
</div></p>
<pre class="example code"><code><span class='kw'>class</span> <span class='const'>PostResource</span> <span class='op'><</span> <span class='const'>ApplicationResource</span>
<span class='comment'># ... code ...
</span> <span class='id identifier rubyid_allow_sideload'>allow_sideload</span> <span class='symbol'>:comments</span><span class='comma'>,</span> <span class='label'>resource:</span> <span class='const'>CommentResource</span> <span class='kw'>do</span>
<span class='id identifier rubyid_scope'>scope</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_posts'>posts</span><span class='op'>|</span>
<span class='const'>Comment</span><span class='period'>.</span><span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='label'>post_id:</span> <span class='id identifier rubyid_posts'>posts</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:id</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='comment'># ... code ...
</span> <span class='kw'>end</span>
<span class='kw'>end</span></code></pre>
<p class="example_title"><div class='inline'>
<p>Custom Scope</p>
</div></p>
<pre class="example code"><code><span class='comment'># In this example, our base scope is a Hash
</span><span class='id identifier rubyid_scope'>scope</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_posts'>posts</span><span class='op'>|</span>
<span class='lbrace'>{</span> <span class='label'>post_ids:</span> <span class='id identifier rubyid_posts'>posts</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:id</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='kw'>end</span></code></pre>
<p class="example_title"><div class='inline'>
<p>ActiveRecord via Adapter</p>
</div></p>
<pre class="example code"><code><span class='kw'>class</span> <span class='const'>PostResource</span> <span class='op'><</span> <span class='const'>ApplicationResource</span>
<span class='comment'># ... code ...
</span> <span class='id identifier rubyid_has_many'>has_many</span> <span class='symbol'>:comments</span><span class='comma'>,</span>
<span class='label'>scope:</span> <span class='tlambda'>-></span> <span class='tlambeg'>{</span> <span class='const'>Comment</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span> <span class='rbrace'>}</span><span class='comma'>,</span>
<span class='label'>resource:</span> <span class='const'>CommentResource</span><span class='comma'>,</span>
<span class='label'>foreign_key:</span> <span class='symbol'>:post_id</span>
<span class='kw'>end</span></code></pre>
</div>
<p class="tag_title">Yield Parameters:</p>
<ul class="yieldparam">
<li>
<span class='name'>parents</span>
<span class='type'></span>
—
<div class='inline'><ul><li>
<p>The resolved parent records</p>
</li></ul>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="Adapters/Abstract.html" title="JsonapiCompliable::Adapters::Abstract (class)">Adapters::Abstract</a></span></li>
<li><span class='object_link'><a href="Adapters/ActiveRecordSideloading.html#has_many-instance_method" title="JsonapiCompliable::Adapters::ActiveRecordSideloading#has_many (method)">Adapters::ActiveRecordSideloading#has_many</a></span></li>
<li><span class='object_link'><a href="#allow_sideload-instance_method" title="JsonapiCompliable::Sideload#allow_sideload (method)">#allow_sideload</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
146
147
148</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 146</span>
<span class='kw'>def</span> <span class='id identifier rubyid_scope'>scope</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_blk'>blk</span><span class='rparen'>)</span>
<span class='ivar'>@scope_proc</span> <span class='op'>=</span> <span class='id identifier rubyid_blk'>blk</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="sideload-instance_method">
#<strong>sideload</strong>(name) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Fetch a Sideload object by its name</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>name</span>
<span class='type'>(<tt>Symbol</tt>)</span>
—
<div class='inline'>
<p>The name of the corresponding sideload</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'>
<p>the corresponding Sideload object</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li>+allow_sideload</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
345
346
347</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 345</span>
<span class='kw'>def</span> <span class='id identifier rubyid_sideload'>sideload</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
<span class='ivar'>@sideloads</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to_hash-instance_method">
#<strong>to_hash</strong>(depth_chain = [], parent = nil) ⇒ <tt>Hash</tt>
</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>Looks at all nested sideload, and all nested sideloads for the
corresponding Resources, and returns an Include Directive hash</p>
<p>For instance, this configuration:</p>
<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>BarResource</span> <span class='op'><</span> <span class='const'>ApplicationResource</span>
<span class='id identifier rubyid_allow_sideload'>allow_sideload</span> <span class='symbol'>:baz</span> <span class='kw'>do</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>class</span> <span class='const'>PostResource</span> <span class='op'><</span> <span class='const'>ApplicationResource</span>
<span class='id identifier rubyid_allow_sideload'>allow_sideload</span> <span class='symbol'>:foo</span> <span class='kw'>do</span>
<span class='id identifier rubyid_allow_sideload'>allow_sideload</span> <span class='symbol'>:bar</span><span class='comma'>,</span> <span class='label'>resource:</span> <span class='const'>BarResource</span> <span class='kw'>do</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
</code></pre>
<p><code>post_resource.sideloading.to_hash</code> would return</p>
<pre class="code ruby"><code class="ruby"><span class='lbrace'>{</span> <span class='label'>base:</span> <span class='lbrace'>{</span> <span class='label'>foo:</span> <span class='lbrace'>{</span> <span class='label'>bar:</span> <span class='lbrace'>{</span> <span class='label'>baz:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='rbrace'>}</span> <span class='rbrace'>}</span> <span class='rbrace'>}</span> <span class='rbrace'>}</span>
</code></pre>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash</tt>)</span>
—
<div class='inline'>
<p>The nested include hash</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/sideload.rb', line 385</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_hash'>to_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_depth_chain'>depth_chain</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_parent'>parent</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_depth'>depth</span> <span class='op'>=</span> <span class='id identifier rubyid_depth_chain'>depth_chain</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_arr'>arr</span><span class='op'>|</span> <span class='id identifier rubyid_arr'>arr</span> <span class='op'>==</span> <span class='lbracket'>[</span><span class='id identifier rubyid_parent'>parent</span><span class='comma'>,</span> <span class='kw'>self</span><span class='rbracket'>]</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span>
<span class='kw'>return</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='kw'>if</span> <span class='id identifier rubyid_depth'>depth</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_max_depth'>max_depth</span>
<span class='kw'>unless</span> <span class='lparen'>(</span><span class='id identifier rubyid_parent'>parent</span> <span class='op'>&&</span> <span class='id identifier rubyid_parent'>parent</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>==</span> <span class='symbol'>:base</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_name'>name</span> <span class='op'>==</span> <span class='symbol'>:base</span>
<span class='id identifier rubyid_depth_chain'>depth_chain</span> <span class='op'>+=</span> <span class='lbracket'>[</span><span class='lbracket'>[</span><span class='id identifier rubyid_parent'>parent</span><span class='comma'>,</span> <span class='kw'>self</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
<span class='kw'>end</span>
<span class='lbrace'>{</span> <span class='id identifier rubyid_name'>name</span> <span class='op'>=></span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_hash'>hash</span><span class='op'>|</span>
<span class='id identifier rubyid_all_sideloads'>all_sideloads</span><span class='period'>.</span><span class='id identifier rubyid_each_pair'>each_pair</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_sl'>sl</span><span class='op'>|</span>
<span class='id identifier rubyid_sideload_hash'>sideload_hash</span> <span class='op'>=</span> <span class='id identifier rubyid_sl'>sl</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_depth_chain'>depth_chain</span><span class='comma'>,</span> <span class='kw'>self</span><span class='rparen'>)</span>
<span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_sideload_hash'>sideload_hash</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Thu Sep 28 17:28:11 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.3.0).
</div>
</div>
</body>
</html>