<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: JsonapiCompliable::Adapters::Abstract
— 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::Adapters::Abstract";
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 (A)</a> »
<span class='title'><span class='object_link'><a href="../../JsonapiCompliable.html" title="JsonapiCompliable (module)">JsonapiCompliable</a></span></span> » <span class='title'><span class='object_link'><a href="../Adapters.html" title="JsonapiCompliable::Adapters (module)">Adapters</a></span></span>
»
<span class="title">Abstract</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::Adapters::Abstract
</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::Adapters::Abstract</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/jsonapi_compliable/adapters/abstract.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Adapters DRY up common resource logic.</p>
<p>For instance, there's no reason to write ActiveRecord logic like this
in every Resource:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_allow_filter'>allow_filter</span> <span class='symbol'>:title</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
<span class='id identifier rubyid_scope'>scope</span><span class='period'>.</span><span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='label'>title:</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_sort'>sort</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_att'>att</span><span class='comma'>,</span> <span class='id identifier rubyid_dir'>dir</span><span class='op'>|</span>
<span class='id identifier rubyid_scope'>scope</span><span class='period'>.</span><span class='id identifier rubyid_order'>order</span><span class='lparen'>(</span><span class='id identifier rubyid_att'>att</span> <span class='op'>=></span> <span class='id identifier rubyid_dir'>dir</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_paginate'>paginate</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_current_page'>current_page</span><span class='comma'>,</span> <span class='id identifier rubyid_per_page'>per_page</span><span class='op'>|</span>
<span class='id identifier rubyid_scope'>scope</span><span class='period'>.</span><span class='id identifier rubyid_page'>page</span><span class='lparen'>(</span><span class='id identifier rubyid_current_page'>current_page</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_per'>per</span><span class='lparen'>(</span><span class='id identifier rubyid_per_page'>per_page</span><span class='rparen'>)</span>
<span class='kw'>end</span>
</code></pre>
<p>This logic can be re-used through an <strong>Adapter</strong>:</p>
<pre class="code ruby"><code class="ruby"><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="ActiveRecord.html" title="JsonapiCompliable::Adapters::ActiveRecord (class)">ActiveRecord</a></span></span>
<span class='id identifier rubyid_allow_filter'>allow_filter</span> <span class='symbol'>:title</span>
</code></pre>
<p>Adapters are pretty simple to write. The corresponding code for the above
ActiveRecord adapter, which should look pretty familiar:</p>
<pre class="code ruby"><code class="ruby"><span class='kw'>class</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="ActiveRecord.html" title="JsonapiCompliable::Adapters::ActiveRecord (class)">ActiveRecord</a></span></span>
<span class='kw'>def</span> <span class='id identifier rubyid_filter'>filter</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_attribute'>attribute</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='id identifier rubyid_scope'>scope</span><span class='period'>.</span><span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='id identifier rubyid_attribute'>attribute</span> <span class='op'>=></span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>def</span> <span class='id identifier rubyid_order'>order</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_attribute'>attribute</span><span class='comma'>,</span> <span class='id identifier rubyid_direction'>direction</span><span class='rparen'>)</span>
<span class='id identifier rubyid_scope'>scope</span><span class='period'>.</span><span class='id identifier rubyid_order'>order</span><span class='lparen'>(</span><span class='id identifier rubyid_attribute'>attribute</span> <span class='op'>=></span> <span class='id identifier rubyid_direction'>direction</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>def</span> <span class='id identifier rubyid_paginate'>paginate</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_current_page'>current_page</span><span class='comma'>,</span> <span class='id identifier rubyid_per_page'>per_page</span><span class='rparen'>)</span>
<span class='id identifier rubyid_scope'>scope</span><span class='period'>.</span><span class='id identifier rubyid_page'>page</span><span class='lparen'>(</span><span class='id identifier rubyid_current_page'>current_page</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_per'>per</span><span class='lparen'>(</span><span class='id identifier rubyid_per_page'>per_page</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
</code></pre>
<p>An adapter can have a corresponding <code>sideloading_module</code>. This
module gets mixed in to a Sideload. In other words,
<strong>Resource</strong> is to <strong>Adapter</strong> as
<strong>Sideload</strong> is to *Adapter#sideloading_module*. Use this
module to define DSL methods that wrap #allow_sideload:</p>
<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>MyAdapter</span> <span class='op'><</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'>Abstract</span>
<span class='comment'># ... code ...
</span> <span class='kw'>def</span> <span class='id identifier rubyid_sideloading_module'>sideloading_module</span>
<span class='const'>MySideloadingAdapter</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>module</span> <span class='const'>MySideloadingAdapter</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_association_name'>association_name</span><span class='rparen'>)</span>
<span class='id identifier rubyid_allow_sideload'>allow_sideload</span> <span class='id identifier rubyid_association_name'>association_name</span> <span class='kw'>do</span>
<span class='comment'># ... code ...
</span> <span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='comment'># And now in your Resource:
</span><span class='kw'>class</span> <span class='const'>MyResource</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'>MyAdapter</span>
<span class='id identifier rubyid_belongs_to'>belongs_to</span> <span class='symbol'>:my_association</span>
<span class='kw'>end</span>
</code></pre>
<p>If you need the adapter to do <strong>nothing</strong>, because perhaps the
API you are hitting does not support sorting, use
<code>JsonapiCompliable::Adapters::Null</code>.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="../Resource.html#use_adapter-class_method" title="JsonapiCompliable::Resource.use_adapter (method)">Resource.use_adapter</a></span></li>
<li><span class='object_link'><a href="ActiveRecord.html" title="JsonapiCompliable::Adapters::ActiveRecord (class)">ActiveRecord</a></span></li>
<li><span class='object_link'><a href="ActiveRecordSideloading.html" title="JsonapiCompliable::Adapters::ActiveRecordSideloading (module)">ActiveRecordSideloading</a></span></li>
<li><span class='object_link'><a href="Null.html" title="JsonapiCompliable::Adapters::Null (class)">Null</a></span></li>
</ul>
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="ActiveRecord.html" title="JsonapiCompliable::Adapters::ActiveRecord (class)">ActiveRecord</a></span>, <span class='object_link'><a href="Null.html" title="JsonapiCompliable::Adapters::Null (class)">Null</a></span></p>
</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="#associate-instance_method" title="#associate (instance method)">#<strong>associate</strong>(parent, child, association_name, association_type) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Assign these two objects together.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#average-instance_method" title="#average (instance method)">#<strong>average</strong>(scope, attr) ⇒ Float </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The average of the scope.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#count-instance_method" title="#count (instance method)">#<strong>count</strong>(scope, attr) ⇒ Numeric </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The count of the scope.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(model_class, create_params) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The model instance just created.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#destroy-instance_method" title="#destroy (instance method)">#<strong>destroy</strong>(model_class, id) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The model instance just destroyed.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#filter-instance_method" title="#filter (instance method)">#<strong>filter</strong>(scope, attribute, value) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The scope.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#maximum-instance_method" title="#maximum (instance method)">#<strong>maximum</strong>(scope, attr) ⇒ Numeric </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The maximum value of the scope.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#minimum-instance_method" title="#minimum (instance method)">#<strong>minimum</strong>(scope, attr) ⇒ Numeric </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The maximum value of the scope.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#order-instance_method" title="#order (instance method)">#<strong>order</strong>(scope, attribute, direction) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The scope.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#paginate-instance_method" title="#paginate (instance method)">#<strong>paginate</strong>(scope, current_page, per_page) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The scope.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#resolve-instance_method" title="#resolve (instance method)">#<strong>resolve</strong>(scope) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Resolve the scope.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#sideloading_module-instance_method" title="#sideloading_module (instance method)">#<strong>sideloading_module</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>This module gets mixed in to Sideload classes This is where you define
methods like has_many, belongs_to etc that wrap the lower-level
Sideload#allow_sideload.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#sum-instance_method" title="#sum (instance method)">#<strong>sum</strong>(scope, attr) ⇒ Numeric </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The sum of the scope.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#transaction-instance_method" title="#transaction (instance method)">#<strong>transaction</strong>(model_class) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>This method must <code>yield</code> the code to run within the transaction.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(model_class, update_params) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The model instance just created.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="associate-instance_method">
#<strong>associate</strong>(parent, child, association_name, association_type) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Assign these two objects together.</p>
<p><code>association_name</code> and <code>association_type</code> come from
your sideload configuration:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_allow_sideload'>allow_sideload</span> <span class='symbol'>:the_name</span><span class='comma'>,</span> <span class='label'>type:</span> <span class='id identifier rubyid_the_type'>the_type</span> <span class='kw'>do</span>
<span class='comment'># ... code.
</span><span class='kw'>end</span>
</code></pre>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>Basic accessor</p>
</div></p>
<pre class="example code"><code><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='comma'>,</span> <span class='id identifier rubyid_association_name'>association_name</span><span class='comma'>,</span> <span class='id identifier rubyid_association_type'>association_type</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_association_type'>association_type</span> <span class='op'>==</span> <span class='symbol'>:has_many</span>
<span class='id identifier rubyid_parent'>parent</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_association_name'>association_name</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_child'>child</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_child'>child</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='symbol'>:#{</span><span class='id identifier rubyid_association_name'>association_name</span><span class='embexpr_end'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_parent'>parent</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></code></pre>
</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>parent</span>
<span class='type'></span>
—
<div class='inline'>
<p>The parent object (via the JSONAPI 'relationships' graph)</p>
</div>
</li>
<li>
<span class='name'>child</span>
<span class='type'></span>
—
<div class='inline'>
<p>The child object (via the JSONAPI 'relationships' graph)</p>
</div>
</li>
<li>
<span class='name'>association_name</span>
<span class='type'></span>
—
<div class='inline'>
<p>The 'relationships' key we are processing</p>
</div>
</li>
<li>
<span class='name'>association_type</span>
<span class='type'></span>
—
<div class='inline'>
<p>The Sideload type (see Sideload#type). Usually :has_many/:belongs_to/etc</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
236
237
238</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/adapters/abstract.rb', line 236</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='comma'>,</span> <span class='id identifier rubyid_association_name'>association_name</span><span class='comma'>,</span> <span class='id identifier rubyid_association_type'>association_type</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>you must override #associate in an adapter subclass</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="average-instance_method">
#<strong>average</strong>(scope, attr) ⇒ <tt>Float</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the average of the scope</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>ActiveRecord default</p>
</div></p>
<pre class="example code"><code><span class='kw'>def</span> <span class='id identifier rubyid_average'>average</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_attr'>attr</span><span class='rparen'>)</span>
<span class='id identifier rubyid_scope'>scope</span><span class='period'>.</span><span class='id identifier rubyid_average'>average</span><span class='lparen'>(</span><span class='id identifier rubyid_attr'>attr</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_f'>to_f</span>
<span class='kw'>end</span></code></pre>
</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>scope</span>
<span class='type'></span>
—
<div class='inline'>
<p>the scope object we are chaining</p>
</div>
</li>
<li>
<span class='name'>attr</span>
<span class='type'>(<tt>Symbol</tt>)</span>
—
<div class='inline'>
<p>corresponding stat attribute name</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Float</tt>)</span>
—
<div class='inline'>
<p>the average of the scope</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
138
139
140</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/adapters/abstract.rb', line 138</span>
<span class='kw'>def</span> <span class='id identifier rubyid_average'>average</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_attr'>attr</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>you must override #average in an adapter subclass</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="count-instance_method">
#<strong>count</strong>(scope, attr) ⇒ <tt>Numeric</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the count of the scope</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>ActiveRecord default</p>
</div></p>
<pre class="example code"><code><span class='kw'>def</span> <span class='id identifier rubyid_count'>count</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_attr'>attr</span><span class='rparen'>)</span>
<span class='id identifier rubyid_column'>column</span> <span class='op'>=</span> <span class='id identifier rubyid_attr'>attr</span> <span class='op'>==</span> <span class='symbol'>:total</span> <span class='op'>?</span> <span class='symbol'>:all</span> <span class='op'>:</span> <span class='id identifier rubyid_attr'>attr</span>
<span class='id identifier rubyid_scope'>scope</span><span class='period'>.</span><span class='id identifier rubyid_uniq'>uniq</span><span class='period'>.</span><span class='id identifier rubyid_count'>count</span><span class='lparen'>(</span><span class='id identifier rubyid_column'>column</span><span class='rparen'>)</span>
<span class='kw'>end</span></code></pre>
</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>scope</span>
<span class='type'></span>
—
<div class='inline'>
<p>the scope object we are chaining</p>
</div>
</li>
<li>
<span class='name'>attr</span>
<span class='type'>(<tt>Symbol</tt>)</span>
—
<div class='inline'>
<p>corresponding stat attribute name</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Numeric</tt>)</span>
—
<div class='inline'>
<p>the count of the scope</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
127
128
129</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/adapters/abstract.rb', line 127</span>
<span class='kw'>def</span> <span class='id identifier rubyid_count'>count</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_attr'>attr</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>you must override #count in an adapter subclass</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="create-instance_method">
#<strong>create</strong>(model_class, create_params) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the model instance just created</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>ActiveRecord default</p>
</div></p>
<pre class="example code"><code><span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_model_class'>model_class</span><span class='comma'>,</span> <span class='id identifier rubyid_create_params'>create_params</span><span class='rparen'>)</span>
<span class='id identifier rubyid_instance'>instance</span> <span class='op'>=</span> <span class='id identifier rubyid_model_class'>model_class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_create_params'>create_params</span><span class='rparen'>)</span>
<span class='id identifier rubyid_instance'>instance</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span>
<span class='id identifier rubyid_instance'>instance</span>
<span class='kw'>end</span></code></pre>
</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>model_class</span>
<span class='type'>(<tt>Class</tt>)</span>
—
<div class='inline'>
<p>The configured model class (see Resource.model)</p>
</div>
</li>
<li>
<span class='name'>create_params</span>
<span class='type'>(<tt>Hash</tt>)</span>
—
<div class='inline'>
<p>Attributes + id</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'>
<p>the model instance just created</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="../Resource.html#model-class_method" title="JsonapiCompliable::Resource.model (method)">Resource.model</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/adapters/abstract.rb', line 263</span>
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_model_class'>model_class</span><span class='comma'>,</span> <span class='id identifier rubyid_create_params'>create_params</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>you must override #create in an adapter subclass</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="destroy-instance_method">
#<strong>destroy</strong>(model_class, id) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the model instance just destroyed</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>ActiveRecord default</p>
</div></p>
<pre class="example code"><code><span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span><span class='lparen'>(</span><span class='id identifier rubyid_model_class'>model_class</span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
<span class='id identifier rubyid_instance'>instance</span> <span class='op'>=</span> <span class='id identifier rubyid_model_class'>model_class</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
<span class='id identifier rubyid_instance'>instance</span><span class='period'>.</span><span class='id identifier rubyid_destroy'>destroy</span>
<span class='id identifier rubyid_instance'>instance</span>
<span class='kw'>end</span></code></pre>
</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>model_class</span>
<span class='type'>(<tt>Class</tt>)</span>
—
<div class='inline'>
<p>The configured model class (see Resource.model)</p>
</div>
</li>
<li>
<span class='name'>id</span>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'>
<p>the id for this model</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'>
<p>the model instance just destroyed</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="../Resource.html#model-class_method" title="JsonapiCompliable::Resource.model (method)">Resource.model</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
291
292
293</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/adapters/abstract.rb', line 291</span>
<span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span><span class='lparen'>(</span><span class='id identifier rubyid_model_class'>model_class</span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>you must override #destroy in an adapter subclass</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="filter-instance_method">
#<strong>filter</strong>(scope, attribute, value) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the scope</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>ActiveRecord default</p>
</div></p>
<pre class="example code"><code><span class='kw'>def</span> <span class='id identifier rubyid_filter'>filter</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_attribute'>attribute</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='id identifier rubyid_scope'>scope</span><span class='period'>.</span><span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='id identifier rubyid_attribute'>attribute</span> <span class='op'>=></span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>end</span></code></pre>
</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>scope</span>
<span class='type'></span>
—
<div class='inline'>
<p>The scope object we are chaining</p>
</div>
</li>
<li>
<span class='name'>attribute</span>
<span class='type'>(<tt>Symbol</tt>)</span>
—
<div class='inline'>
<p>The attribute name we are filtering</p>
</div>
</li>
<li>
<span class='name'>value</span>
<span class='type'></span>
—
<div class='inline'>
<p>The corresponding query parameter value</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'>
<p>the scope</p>
</div>
</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/jsonapi_compliable/adapters/abstract.rb', line 88</span>
<span class='kw'>def</span> <span class='id identifier rubyid_filter'>filter</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_attribute'>attribute</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>you must override #filter in an adapter subclass</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="maximum-instance_method">
#<strong>maximum</strong>(scope, attr) ⇒ <tt>Numeric</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the maximum value of the scope</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>ActiveRecord default</p>
</div></p>
<pre class="example code"><code><span class='kw'>def</span> <span class='id identifier rubyid_maximum'>maximum</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_attr'>attr</span><span class='rparen'>)</span>
<span class='id identifier rubyid_scope'>scope</span><span class='period'>.</span><span class='id identifier rubyid_maximum'>maximum</span><span class='lparen'>(</span><span class='id identifier rubyid_attr'>attr</span><span class='rparen'>)</span>
<span class='kw'>end</span></code></pre>
</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>scope</span>
<span class='type'></span>
—
<div class='inline'>
<p>the scope object we are chaining</p>
</div>
</li>
<li>
<span class='name'>attr</span>
<span class='type'>(<tt>Symbol</tt>)</span>
—
<div class='inline'>
<p>corresponding stat attribute name</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Numeric</tt>)</span>
—
<div class='inline'>
<p>the maximum value of the scope</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
160
161
162</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/adapters/abstract.rb', line 160</span>
<span class='kw'>def</span> <span class='id identifier rubyid_maximum'>maximum</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_attr'>attr</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>you must override #maximum in an adapter subclass</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="minimum-instance_method">
#<strong>minimum</strong>(scope, attr) ⇒ <tt>Numeric</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the maximum value of the scope</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>ActiveRecord default</p>
</div></p>
<pre class="example code"><code><span class='kw'>def</span> <span class='id identifier rubyid_maximum'>maximum</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_attr'>attr</span><span class='rparen'>)</span>
<span class='id identifier rubyid_scope'>scope</span><span class='period'>.</span><span class='id identifier rubyid_maximum'>maximum</span><span class='lparen'>(</span><span class='id identifier rubyid_attr'>attr</span><span class='rparen'>)</span>
<span class='kw'>end</span></code></pre>
</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>scope</span>
<span class='type'></span>
—
<div class='inline'>
<p>the scope object we are chaining</p>
</div>
</li>
<li>
<span class='name'>attr</span>
<span class='type'>(<tt>Symbol</tt>)</span>
—
<div class='inline'>
<p>corresponding stat attribute name</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Numeric</tt>)</span>
—
<div class='inline'>
<p>the maximum value of the scope</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
171
172
173</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/adapters/abstract.rb', line 171</span>
<span class='kw'>def</span> <span class='id identifier rubyid_minimum'>minimum</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_attr'>attr</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>you must override #maximum in an adapter subclass</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="order-instance_method">
#<strong>order</strong>(scope, attribute, direction) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the scope</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>ActiveRecord default</p>
</div></p>
<pre class="example code"><code><span class='kw'>def</span> <span class='id identifier rubyid_order'>order</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_attribute'>attribute</span><span class='comma'>,</span> <span class='id identifier rubyid_direction'>direction</span><span class='rparen'>)</span>
<span class='id identifier rubyid_scope'>scope</span><span class='period'>.</span><span class='id identifier rubyid_order'>order</span><span class='lparen'>(</span><span class='id identifier rubyid_attribute'>attribute</span> <span class='op'>=></span> <span class='id identifier rubyid_direction'>direction</span><span class='rparen'>)</span>
<span class='kw'>end</span></code></pre>
</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>scope</span>
<span class='type'></span>
—
<div class='inline'>
<p>The scope object we are chaining</p>
</div>
</li>
<li>
<span class='name'>attribute</span>
<span class='type'>(<tt>Symbol</tt>)</span>
—
<div class='inline'>
<p>The attribute name we are sorting</p>
</div>
</li>
<li>
<span class='name'>direction</span>
<span class='type'>(<tt>Symbol</tt>)</span>
—
<div class='inline'>
<p>The direction we are sorting (asc/desc)</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'>
<p>the scope</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
101
102
103</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/adapters/abstract.rb', line 101</span>
<span class='kw'>def</span> <span class='id identifier rubyid_order'>order</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_attribute'>attribute</span><span class='comma'>,</span> <span class='id identifier rubyid_direction'>direction</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>you must override #order in an adapter subclass</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="paginate-instance_method">
#<strong>paginate</strong>(scope, current_page, per_page) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the scope</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>ActiveRecord default</p>
</div></p>
<pre class="example code"><code><span class='comment'># via kaminari gem
</span><span class='kw'>def</span> <span class='id identifier rubyid_paginate'>paginate</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_current_page'>current_page</span><span class='comma'>,</span> <span class='id identifier rubyid_per_page'>per_page</span><span class='rparen'>)</span>
<span class='id identifier rubyid_scope'>scope</span><span class='period'>.</span><span class='id identifier rubyid_page'>page</span><span class='lparen'>(</span><span class='id identifier rubyid_current_page'>current_page</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_per'>per</span><span class='lparen'>(</span><span class='id identifier rubyid_per_page'>per_page</span><span class='rparen'>)</span>
<span class='kw'>end</span></code></pre>
</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>scope</span>
<span class='type'></span>
—
<div class='inline'>
<p>The scope object we are chaining</p>
</div>
</li>
<li>
<span class='name'>current_page</span>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'>
<p>The current page number</p>
</div>
</li>
<li>
<span class='name'>per_page</span>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'>
<p>The number of results per page</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'>
<p>the scope</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
115
116
117</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/adapters/abstract.rb', line 115</span>
<span class='kw'>def</span> <span class='id identifier rubyid_paginate'>paginate</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_current_page'>current_page</span><span class='comma'>,</span> <span class='id identifier rubyid_per_page'>per_page</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>you must override #paginate in an adapter subclass</span><span class='tstring_end'>'</span></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>(scope) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Resolve the scope. This is where you'd actually fire SQL, actually make
an HTTP call, etc.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>ActiveRecordDefault</p>
</div></p>
<pre class="example code"><code><span class='kw'>def</span> <span class='id identifier rubyid_resolve'>resolve</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='rparen'>)</span>
<span class='id identifier rubyid_scope'>scope</span><span class='period'>.</span><span class='id identifier rubyid_to_a'>to_a</span>
<span class='kw'>end</span></code></pre>
<p class="example_title"><div class='inline'>
<p>Suggested Customization</p>
</div></p>
<pre class="example code"><code><span class='comment'># When making a service call, we suggest this abstraction
</span><span class='comment'># 'scope' here is a hash
</span><span class='kw'>def</span> <span class='id identifier rubyid_resolve'>resolve</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='rparen'>)</span>
<span class='comment'># The implementation of .where can be whatever you want
</span> <span class='const'>SomeModelClass</span><span class='period'>.</span><span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='rparen'>)</span>
<span class='kw'>end</span></code></pre>
</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>scope</span>
<span class='type'></span>
—
<div class='inline'>
<p>The scope object to resolve</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'>
<p>an array of Model instances</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="ActiveRecord.html#resolve-instance_method" title="JsonapiCompliable::Adapters::ActiveRecord#resolve (method)">JsonapiCompliable::Adapters::ActiveRecord#resolve</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
210
211
212</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/adapters/abstract.rb', line 210</span>
<span class='kw'>def</span> <span class='id identifier rubyid_resolve'>resolve</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='rparen'>)</span>
<span class='id identifier rubyid_scope'>scope</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="sideloading_module-instance_method">
#<strong>sideloading_module</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>This module gets mixed in to Sideload classes This is where you define
methods like has_many, belongs_to etc that wrap the lower-level
Sideload#allow_sideload</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'>
<p>the module to mix in</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li>Resource#allow_sideload</li>
<li><span class='object_link'><a href="../Sideload.html#allow_sideload-instance_method" title="JsonapiCompliable::Sideload#allow_sideload (method)">Sideload#allow_sideload</a></span></li>
<li><span class='object_link'><a href="ActiveRecord.html#sideloading_module-instance_method" title="JsonapiCompliable::Adapters::ActiveRecord#sideloading_module (method)">JsonapiCompliable::Adapters::ActiveRecord#sideloading_module</a></span></li>
<li><span class='object_link'><a href="ActiveRecordSideloading.html" title="JsonapiCompliable::Adapters::ActiveRecordSideloading (module)">JsonapiCompliable::Adapters::ActiveRecordSideloading</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
249
250
251</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/adapters/abstract.rb', line 249</span>
<span class='kw'>def</span> <span class='id identifier rubyid_sideloading_module'>sideloading_module</span>
<span class='const'>Module</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="sum-instance_method">
#<strong>sum</strong>(scope, attr) ⇒ <tt>Numeric</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the sum of the scope</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>ActiveRecord default</p>
</div></p>
<pre class="example code"><code><span class='kw'>def</span> <span class='id identifier rubyid_sum'>sum</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_attr'>attr</span><span class='rparen'>)</span>
<span class='id identifier rubyid_scope'>scope</span><span class='period'>.</span><span class='id identifier rubyid_sum'>sum</span><span class='lparen'>(</span><span class='id identifier rubyid_attr'>attr</span><span class='rparen'>)</span>
<span class='kw'>end</span></code></pre>
</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>scope</span>
<span class='type'></span>
—
<div class='inline'>
<p>the scope object we are chaining</p>
</div>
</li>
<li>
<span class='name'>attr</span>
<span class='type'>(<tt>Symbol</tt>)</span>
—
<div class='inline'>
<p>corresponding stat attribute name</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Numeric</tt>)</span>
—
<div class='inline'>
<p>the sum of the scope</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
149
150
151</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/adapters/abstract.rb', line 149</span>
<span class='kw'>def</span> <span class='id identifier rubyid_sum'>sum</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_attr'>attr</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>you must override #sum in an adapter subclass</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="transaction-instance_method">
#<strong>transaction</strong>(model_class) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>This method must <code>yield</code> the code to run within the transaction.
This method should roll back the transaction if an error is raised.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>ActiveRecord default</p>
</div></p>
<pre class="example code"><code><span class='kw'>def</span> <span class='id identifier rubyid_transaction'>transaction</span><span class='lparen'>(</span><span class='id identifier rubyid_model_class'>model_class</span><span class='rparen'>)</span>
<span class='id identifier rubyid_model_class'>model_class</span><span class='period'>.</span><span class='id identifier rubyid_transaction'>transaction</span> <span class='kw'>do</span>
<span class='kw'>yield</span>
<span class='kw'>end</span>
<span class='kw'>end</span></code></pre>
</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>model_class</span>
<span class='type'>(<tt>Class</tt>)</span>
—
<div class='inline'>
<p>The class we're operating on</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="../Resource.html#model-class_method" title="JsonapiCompliable::Resource.model (method)">Resource.model</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
187
188
189</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/adapters/abstract.rb', line 187</span>
<span class='kw'>def</span> <span class='id identifier rubyid_transaction'>transaction</span><span class='lparen'>(</span><span class='id identifier rubyid_model_class'>model_class</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>you must override #transaction in an adapter subclass, it must yield</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="update-instance_method">
#<strong>update</strong>(model_class, update_params) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the model instance just created</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>ActiveRecord default</p>
</div></p>
<pre class="example code"><code><span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_model_class'>model_class</span><span class='comma'>,</span> <span class='id identifier rubyid_update_params'>update_params</span><span class='rparen'>)</span>
<span class='id identifier rubyid_instance'>instance</span> <span class='op'>=</span> <span class='id identifier rubyid_model_class'>model_class</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_update_params'>update_params</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:id</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='id identifier rubyid_instance'>instance</span><span class='period'>.</span><span class='id identifier rubyid_update_attributes'>update_attributes</span><span class='lparen'>(</span><span class='id identifier rubyid_update_params'>update_params</span><span class='rparen'>)</span>
<span class='id identifier rubyid_instance'>instance</span>
<span class='kw'>end</span></code></pre>
</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>model_class</span>
<span class='type'>(<tt>Class</tt>)</span>
—
<div class='inline'>
<p>The configured model class (see Resource.model)</p>
</div>
</li>
<li>
<span class='name'>update_params</span>
<span class='type'>(<tt>Hash</tt>)</span>
—
<div class='inline'>
<p>Attributes + id</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'>
<p>the model instance just created</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="../Resource.html#model-class_method" title="JsonapiCompliable::Resource.model (method)">Resource.model</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
277
278
279</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/adapters/abstract.rb', line 277</span>
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_model_class'>model_class</span><span class='comma'>,</span> <span class='id identifier rubyid_update_params'>update_params</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>you must override #update in an adapter subclass</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri May 5 15:53:23 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>