Update YARD

Author: Lee Richmond

docs/Jsonapi.html

@@ -105,7 +105,7 @@ <h2>Defined Under Namespace</h2>
 </div>
 
       <div id="footer">
-  Generated on Tue Oct  3 14:55:06 2017 by
+  Generated on Wed Apr 18 07:58:12 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.0).
 </div>

docs/Jsonapi/ResourceGenerator.html

@@ -163,37 +163,47 @@ <h3 class="signature first" id="copy_resource_file-instance_method">
       <pre class="lines">
 
 
-42
-43
-44
-45
-46
-47
-48
-49
-50
-51
-52
-53
-54
-55</pre>
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/generators/jsonapi/resource_generator.rb', line 42</span>
+      <pre class="code"><span class="info file"># File 'lib/generators/jsonapi/resource_generator.rb', line 19</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_copy_resource_file'>copy_resource_file</span>
   <span class='kw'>unless</span> <span class='id identifier rubyid_model_klass'>model_klass</span>
     <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>You must define a </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_class_name'>class_name</span><span class='embexpr_end'>}</span><span class='tstring_content'> model before generating the corresponding resource.</span><span class='tstring_end'>&quot;</span></span>
   <span class='kw'>end</span>
 
-  <span class='id identifier rubyid_generate_controller'>generate_controller</span> <span class='kw'>unless</span> <span class='id identifier rubyid_omit_controller?'>omit_controller?</span>
-  <span class='id identifier rubyid_generate_serializer'>generate_serializer</span> <span class='kw'>unless</span> <span class='id identifier rubyid_omit_serializer?'>omit_serializer?</span>
+  <span class='id identifier rubyid_generate_controller'>generate_controller</span>
+  <span class='id identifier rubyid_generate_serializer'>generate_serializer</span>
   <span class='id identifier rubyid_generate_application_resource'>generate_application_resource</span> <span class='kw'>unless</span> <span class='id identifier rubyid_application_resource_defined?'>application_resource_defined?</span>
-  <span class='id identifier rubyid_generate_spec_payload'>generate_spec_payload</span> <span class='kw'>unless</span> <span class='id identifier rubyid_omit_spec_payload?'>omit_spec_payload?</span>
-  <span class='id identifier rubyid_generate_strong_resource'>generate_strong_resource</span> <span class='kw'>unless</span> <span class='id identifier rubyid_omit_strong_resource?'>omit_strong_resource?</span>
-  <span class='id identifier rubyid_generate_route'>generate_route</span> <span class='kw'>unless</span> <span class='id identifier rubyid_omit_route?'>omit_route?</span>
-  <span class='id identifier rubyid_generate_tests'>generate_tests</span> <span class='kw'>unless</span> <span class='id identifier rubyid_omit_tests?'>omit_tests?</span>
+  <span class='id identifier rubyid_generate_spec_payload'>generate_spec_payload</span>
+
+  <span class='kw'>if</span> <span class='id identifier rubyid_actions?'>actions?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>create</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>update</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+    <span class='id identifier rubyid_generate_strong_resource'>generate_strong_resource</span>
+  <span class='kw'>end</span>
+
+  <span class='id identifier rubyid_generate_route'>generate_route</span>
+  <span class='id identifier rubyid_generate_tests'>generate_tests</span>
   <span class='id identifier rubyid_generate_resource'>generate_resource</span>
+  <span class='id identifier rubyid_generate_swagger'>generate_swagger</span> <span class='kw'>if</span> <span class='id identifier rubyid_docs_controller?'>docs_controller?</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -205,7 +215,7 @@ <h3 class="signature first" id="copy_resource_file-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Oct  3 14:55:08 2017 by
+  Generated on Wed Apr 18 07:58:13 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.0).
 </div>

docs/JsonapiCompliable.html

@@ -78,22 +78,34 @@
 
   <dl>
     <dt>Defined in:</dt>
-    <dd>lib/jsonapi_compliable.rb<span class="defines">,<br />
-  lib/jsonapi_compliable/base.rb,<br /> lib/jsonapi_compliable/query.rb,<br /> lib/jsonapi_compliable/rails.rb,<br /> lib/jsonapi_compliable/scope.rb,<br /> lib/jsonapi_compliable/errors.rb,<br /> lib/jsonapi_compliable/version.rb,<br /> lib/jsonapi_compliable/resource.rb,<br /> lib/jsonapi_compliable/sideload.rb,<br /> lib/jsonapi_compliable/stats/dsl.rb,<br /> lib/jsonapi_compliable/util/hash.rb,<br /> lib/jsonapi_compliable/scoping/base.rb,<br /> lib/jsonapi_compliable/scoping/sort.rb,<br /> lib/jsonapi_compliable/adapters/null.rb,<br /> lib/jsonapi_compliable/stats/payload.rb,<br /> lib/jsonapi_compliable/util/sideload.rb,<br /> lib/jsonapi_compliable/scoping/filter.rb,<br /> lib/jsonapi_compliable/scoping/paginate.rb,<br /> lib/jsonapi_compliable/adapters/abstract.rb,<br /> lib/jsonapi_compliable/util/field_params.rb,<br /> lib/jsonapi_compliable/extensions/temp_id.rb,<br /> lib/jsonapi_compliable/scoping/filterable.rb,<br /> lib/jsonapi_compliable/util/include_params.rb,<br /> lib/jsonapi_compliable/util/render_options.rb,<br /> lib/jsonapi_compliable/scoping/extra_fields.rb,<br /> lib/jsonapi_compliable/adapters/active_record.rb,<br /> lib/jsonapi_compliable/scoping/default_filter.rb,<br /> lib/jsonapi_compliable/util/relationship_payload.rb,<br /> lib/jsonapi_compliable/extensions/extra_attribute.rb,<br /> lib/jsonapi_compliable/extensions/boolean_attribute.rb,<br /> lib/jsonapi_compliable/adapters/active_record_sideloading.rb</span>
+    <dd>lib/jsonapi_compliable/configuration.rb<span class="defines">,<br />
+  lib/jsonapi_compliable.rb,<br /> lib/jsonapi_compliable/base.rb,<br /> lib/jsonapi_compliable/query.rb,<br /> lib/jsonapi_compliable/rails.rb,<br /> lib/jsonapi_compliable/scope.rb,<br /> lib/jsonapi_compliable/errors.rb,<br /> lib/jsonapi_compliable/version.rb,<br /> lib/jsonapi_compliable/resource.rb,<br /> lib/jsonapi_compliable/sideload.rb,<br /> lib/jsonapi_compliable/stats/dsl.rb,<br /> lib/jsonapi_compliable/util/hash.rb,<br /> lib/jsonapi_compliable/scoping/base.rb,<br /> lib/jsonapi_compliable/scoping/sort.rb,<br /> lib/jsonapi_compliable/adapters/null.rb,<br /> lib/jsonapi_compliable/stats/payload.rb,<br /> lib/jsonapi_compliable/util/sideload.rb,<br /> lib/jsonapi_compliable/scoping/filter.rb,<br /> lib/jsonapi_compliable/scoping/paginate.rb,<br /> lib/jsonapi_compliable/adapters/abstract.rb,<br /> lib/jsonapi_compliable/util/field_params.rb,<br /> lib/jsonapi_compliable/extensions/temp_id.rb,<br /> lib/jsonapi_compliable/scoping/filterable.rb,<br /> lib/jsonapi_compliable/util/include_params.rb,<br /> lib/jsonapi_compliable/util/render_options.rb,<br /> lib/jsonapi_compliable/scoping/extra_fields.rb,<br /> lib/jsonapi_compliable/adapters/active_record.rb,<br /> lib/jsonapi_compliable/scoping/default_filter.rb,<br /> lib/jsonapi_compliable/util/relationship_payload.rb,<br /> lib/jsonapi_compliable/extensions/extra_attribute.rb,<br /> lib/jsonapi_compliable/extensions/boolean_attribute.rb,<br /> lib/jsonapi_compliable/adapters/active_record_sideloading.rb</span>
 </dd>
   </dl>
 
 </div>
 
-<h2>Defined Under Namespace</h2>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p><a
+href="https://robots.thoughtbot.com/mygem-configure-block">robots.thoughtbot.com/mygem-configure-block</a></p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><h2>Defined Under Namespace</h2>
 <p class="children">
 
 
       <strong class="modules">Modules:</strong> <span class='object_link'><a href="JsonapiCompliable/Adapters.html" title="JsonapiCompliable::Adapters (module)">Adapters</a></span>, <span class='object_link'><a href="JsonapiCompliable/Base.html" title="JsonapiCompliable::Base (module)">Base</a></span>, <span class='object_link'><a href="JsonapiCompliable/Errors.html" title="JsonapiCompliable::Errors (module)">Errors</a></span>, <span class='object_link'><a href="JsonapiCompliable/Extensions.html" title="JsonapiCompliable::Extensions (module)">Extensions</a></span>, <span class='object_link'><a href="JsonapiCompliable/Rails.html" title="JsonapiCompliable::Rails (module)">Rails</a></span>, <span class='object_link'><a href="JsonapiCompliable/Scoping.html" title="JsonapiCompliable::Scoping (module)">Scoping</a></span>, <span class='object_link'><a href="JsonapiCompliable/SerializableTempId.html" title="JsonapiCompliable::SerializableTempId (module)">SerializableTempId</a></span>, <span class='object_link'><a href="JsonapiCompliable/Stats.html" title="JsonapiCompliable::Stats (module)">Stats</a></span>, <span class='object_link'><a href="JsonapiCompliable/Util.html" title="JsonapiCompliable::Util (module)">Util</a></span>
 
 
 
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="JsonapiCompliable/Deserializer.html" title="JsonapiCompliable::Deserializer (class)">Deserializer</a></span>, <span class='object_link'><a href="JsonapiCompliable/Query.html" title="JsonapiCompliable::Query (class)">Query</a></span>, <span class='object_link'><a href="JsonapiCompliable/Resource.html" title="JsonapiCompliable::Resource (class)">Resource</a></span>, <span class='object_link'><a href="JsonapiCompliable/Scope.html" title="JsonapiCompliable::Scope (class)">Scope</a></span>, <span class='object_link'><a href="JsonapiCompliable/Sideload.html" title="JsonapiCompliable::Sideload (class)">Sideload</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="JsonapiCompliable/Configuration.html" title="JsonapiCompliable::Configuration (class)">Configuration</a></span>, <span class='object_link'><a href="JsonapiCompliable/Deserializer.html" title="JsonapiCompliable::Deserializer (class)">Deserializer</a></span>, <span class='object_link'><a href="JsonapiCompliable/Query.html" title="JsonapiCompliable::Query (class)">Query</a></span>, <span class='object_link'><a href="JsonapiCompliable/Resource.html" title="JsonapiCompliable::Resource (class)">Resource</a></span>, <span class='object_link'><a href="JsonapiCompliable/Scope.html" title="JsonapiCompliable::Scope (class)">Scope</a></span>, <span class='object_link'><a href="JsonapiCompliable/Sideload.html" title="JsonapiCompliable::Sideload (class)">Sideload</a></span>
 
 
 </p>
@@ -104,7 +116,7 @@ <h2>Constant Summary</h2>
       <dt id="VERSION-constant" class="">VERSION =
 
       </dt>
-      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.10.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.11.4</span><span class='tstring_end'>&quot;</span></span></pre></dd>
 
   </dl>
 
@@ -125,6 +137,50 @@ <h2>
         <li class="public ">
   <span class="summary_signature">
 
+      <a href="#config-class_method" title="config (class method)">.<strong>config</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#configure-class_method" title="configure (class method)">.<strong>configure</strong> {|config| ... } &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
       <a href="#context-class_method" title="context (class method)">.<strong>context</strong>  &#x21d2; Object </a>
 
 
@@ -220,7 +276,106 @@ <h2>Class Method Details</h2>
 
 
       <div class="method_details first">
-  <h3 class="signature first" id="context-class_method">
+  <h3 class="signature first" id="config-class_method">
+  
+    .<strong>config</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+69
+70
+71</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/jsonapi_compliable.rb', line 69</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span>
+  <span class='ivar'>@config</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="JsonapiCompliable/Configuration.html" title="JsonapiCompliable::Configuration (class)">Configuration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="JsonapiCompliable/Configuration.html#initialize-instance_method" title="JsonapiCompliable::Configuration#initialize (method)">new</a></span></span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="configure-class_method">
+  
+    .<strong>configure</strong> {|config| ... } &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+
+  </div>
+</div>
+<div class="tags">
+  
+  <div class="examples">
+    <p class="tag_title">Examples:</p>
+    
+      
+      <pre class="example code"><code><span class='const'><span class='object_link'><a href="" title="JsonapiCompliable (module)">JsonapiCompliable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span> <span class='kw'>do</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_raise_on_missing_sideload'>raise_on_missing_sideload</span> <span class='op'>=</span> <span class='kw'>false</span>
+<span class='kw'>end</span></code></pre>
+    
+  </div>
+
+<p class="tag_title">Yields:</p>
+<ul class="yield">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="#config-class_method" title="JsonapiCompliable.config (method)">config</a></span></tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="JsonapiCompliable/Configuration.html" title="JsonapiCompliable::Configuration (class)">Configuration</a></span></li>
+    
+  </ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+79
+80
+81</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/jsonapi_compliable.rb', line 79</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span>
+  <span class='kw'>yield</span> <span class='id identifier rubyid_config'>config</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="context-class_method">
 
     .<strong>context</strong>  &#x21d2; <tt>Object</tt> 
 
@@ -247,12 +402,12 @@ <h3 class="signature first" id="context-class_method">
       <pre class="lines">
 
 
-48
 49
-50</pre>
+50
+51</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/jsonapi_compliable.rb', line 48</span>
+      <pre class="code"><span class="info file"># File 'lib/jsonapi_compliable.rb', line 49</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_context'>context</span>
   <span class='const'>Thread</span><span class='period'>.</span><span class='id identifier rubyid_current'>current</span><span class='lbracket'>[</span><span class='symbol'>:context</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
@@ -290,12 +445,12 @@ <h3 class="signature " id="context=-class_method">
       <pre class="lines">
 
 
-53
 54
-55</pre>
+55
+56</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/jsonapi_compliable.rb', line 53</span>
+      <pre class="code"><span class="info file"># File 'lib/jsonapi_compliable.rb', line 54</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_context='>context=</span><span class='lparen'>(</span><span class='id identifier rubyid_val'>val</span><span class='rparen'>)</span>
   <span class='const'>Thread</span><span class='period'>.</span><span class='id identifier rubyid_current'>current</span><span class='lbracket'>[</span><span class='symbol'>:context</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_val'>val</span>
@@ -320,14 +475,14 @@ <h3 class="signature " id="included-class_method">
       <pre class="lines">
 
 
-41
 42
 43
 44
-45</pre>
+45
+46</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/jsonapi_compliable.rb', line 41</span>
+      <pre class="code"><span class="info file"># File 'lib/jsonapi_compliable.rb', line 42</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_included'>included</span><span class='lparen'>(</span><span class='id identifier rubyid_klass'>klass</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_klass'>klass</span><span class='period'>.</span><span class='id identifier rubyid_instance_eval'>instance_eval</span> <span class='kw'>do</span>
@@ -367,18 +522,18 @@ <h3 class="signature " id="with_context-class_method">
       <pre class="lines">
 
 
-58
 59
 60
 61
 62
 63
 64
 65
-66</pre>
+66
+67</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/jsonapi_compliable.rb', line 58</span>
+      <pre class="code"><span class="info file"># File 'lib/jsonapi_compliable.rb', line 59</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_with_context'>with_context</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='comma'>,</span> <span class='id identifier rubyid_namespace'>namespace</span><span class='rparen'>)</span>
   <span class='kw'>begin</span>
@@ -399,7 +554,7 @@ <h3 class="signature " id="with_context-class_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Oct  3 14:55:06 2017 by
+  Generated on Wed Apr 18 07:58:12 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.0).
 </div>

docs/JsonapiCompliable/Adapters.html

@@ -109,7 +109,7 @@ <h2>Defined Under Namespace</h2>
 </div>
 
       <div id="footer">
-  Generated on Tue Oct  3 14:55:06 2017 by
+  Generated on Wed Apr 18 07:58:12 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.0).
 </div>

docs/JsonapiCompliable/Adapters/Abstract.html

@@ -2451,7 +2451,7 @@ <h3 class="signature " id="update-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Oct  3 14:55:08 2017 by
+  Generated on Wed Apr 18 07:58:13 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.0).
 </div>