inquery 1.0.2 → 1.0.7

data/doc/Inquery/Mixins/SchemaValidation/ClassMethods.html

@@ -6,15 +6,15 @@
 <title>
   Module: Inquery::Mixins::SchemaValidation::ClassMethods
   
-    &mdash; Documentation by YARD 0.9.20
+    &mdash; Documentation by YARD 0.9.25
   
 </title>
 
-  <link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../../../css/style.css" type="text/css" />
 
-  <link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../../../css/common.css" type="text/css" />
 
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   pathId = "Inquery::Mixins::SchemaValidation::ClassMethods";
   relpath = '../../../';
 </script>
@@ -115,6 +115,50 @@
   
 
   
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#schema2-instance_method" title="#schema2 (instance method)">#<strong>schema2</strong>(*args, &amp;block)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#schema3-instance_method" title="#schema3 (instance method)">#<strong>schema3</strong>(reference = nil, **options, &amp;block)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
     <span class="summary_desc"><div class='inline'></div></span>
   
 </li>
@@ -138,6 +182,52 @@
   
 
   
+</h3><div class="docstring">
+  <div class="discussion">
+    
+
+  </div>
+</div>
+<div class="tags">
+  
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="#schema2-instance_method" title="Inquery::Mixins::SchemaValidation::ClassMethods#schema2 (method)">#schema2</a></span></li>
+    
+  </ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+25
+26
+27</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/inquery/mixins/schema_validation.rb', line 25</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_schema'>schema</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_schema2'>schema2</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="schema2-instance_method">
+  
+    #<strong>schema2</strong>(*args, &amp;block)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
 </h3><table class="source_code">
   <tr>
     <td>
@@ -146,17 +236,51 @@
 
 12
 13
-14
-15
-16</pre>
+14</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/inquery/mixins/schema_validation.rb', line 12</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_schema'>schema</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_schema'>schema</span> <span class='op'>=</span> <span class='const'>Schemacop</span><span class='op'>::</span><span class='const'>Schema</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_schema2'>schema2</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid__schema'>_schema</span> <span class='op'>=</span> <span class='const'>Schemacop</span><span class='op'>::</span><span class='const'>Schema</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="schema3-instance_method">
+  
+    #<strong>schema3</strong>(reference = nil, **options, &amp;block)  &#x21d2; <tt>Object</tt> 
+  
 
-  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid__schema'>_schema</span> <span class='op'>=</span> <span class='id identifier rubyid_schema'>schema</span>
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+16
+17
+18
+19
+20
+21
+22</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/inquery/mixins/schema_validation.rb', line 16</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_schema3'>schema3</span><span class='lparen'>(</span><span class='id identifier rubyid_reference'>reference</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_reference'>reference</span>
+    <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid__schema'>_schema</span> <span class='op'>=</span> <span class='const'>Schemacop</span><span class='op'>::</span><span class='const'>Schema3</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='symbol'>:reference</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='label'>path:</span> <span class='id identifier rubyid_reference'>reference</span><span class='rparen'>)</span><span class='rparen'>)</span>
+  <span class='kw'>else</span>
+    <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid__schema'>_schema</span> <span class='op'>=</span> <span class='const'>Schemacop</span><span class='op'>::</span><span class='const'>Schema3</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='symbol'>:hash</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
+  <span class='kw'>end</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -168,9 +292,9 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Oct  9 16:20:53 2019 by
+  Generated on Wed Nov 25 14:05:20 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.20 (ruby-2.6.2).
+  0.9.25 (ruby-2.6.2).
 </div>
 
     </div>

data/doc/Inquery/Query.html

@@ -6,15 +6,15 @@
 <title>
   Class: Inquery::Query
   
-    &mdash; Documentation by YARD 0.9.20
+    &mdash; Documentation by YARD 0.9.25
   
 </title>
 
-  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/style.css" type="text/css" />
 
-  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" />
 
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   pathId = "Inquery::Query";
   relpath = '../';
 </script>
@@ -421,8 +421,8 @@ was a validation schema specified).</p>
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='ivar'>@params</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span>
 
-  <span class='kw'>if</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__schema'>_schema</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__schema'>_schema</span><span class='period'>.</span><span class='id identifier rubyid_validate!'>validate!</span><span class='lparen'>(</span><span class='ivar'>@params</span><span class='rparen'>)</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid__schema'>_schema</span>
+    <span class='ivar'>@params</span> <span class='op'>=</span> <span class='id identifier rubyid__schema'>_schema</span><span class='period'>.</span><span class='id identifier rubyid_validate!'>validate!</span><span class='lparen'>(</span><span class='ivar'>@params</span><span class='rparen'>)</span>
   <span class='kw'>end</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -448,7 +448,7 @@ was a validation schema specified).</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Returns the value of attribute params</p>
+    <p>Returns the value of attribute params.</p>
 
 
   </div>
@@ -779,9 +779,9 @@ easyer access.</p>
 </div>
 
       <div id="footer">
-  Generated on Wed Oct  9 16:20:53 2019 by
+  Generated on Wed Nov 25 14:05:20 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.20 (ruby-2.6.2).
+  0.9.25 (ruby-2.6.2).
 </div>
 
     </div>

data/doc/Inquery/Query/Chainable.html

@@ -6,15 +6,15 @@
 <title>
   Class: Inquery::Query::Chainable
   
-    &mdash; Documentation by YARD 0.9.20
+    &mdash; Documentation by YARD 0.9.25
   
 </title>
 
-  <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../../css/style.css" type="text/css" />
 
-  <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../../css/common.css" type="text/css" />
 
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   pathId = "Inquery::Query::Chainable";
   relpath = '../../';
 </script>
@@ -321,7 +321,7 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Returns a new instance of Chainable</p>
+    <p>Returns a new instance of Chainable.</p>
 
 
   </div>
@@ -372,7 +372,7 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Returns the value of attribute relation</p>
+    <p>Returns the value of attribute relation.</p>
 
 
   </div>
@@ -529,9 +529,9 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Oct  9 16:20:53 2019 by
+  Generated on Wed Nov 25 14:05:20 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.20 (ruby-2.6.2).
+  0.9.25 (ruby-2.6.2).
 </div>
 
     </div>

data/doc/_index.html

@@ -4,15 +4,15 @@
     <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <title>
-  Documentation by YARD 0.9.20
+  Documentation by YARD 0.9.25
   
 </title>
 
-  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
 
-  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
 
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   pathId = null;
   relpath = '';
 </script>
@@ -52,7 +52,7 @@
         <div class="clear"></div>
       </div>
 
-      <div id="content"><h1 class="noborder title">Documentation by YARD 0.9.20</h1>
+      <div id="content"><h1 class="noborder title">Documentation by YARD 0.9.25</h1>
 <div id="listing">
   <h1 class="alphaindex">Alphabetic Index</h1>
   
@@ -248,9 +248,9 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Oct  9 16:20:52 2019 by
+  Generated on Wed Nov 25 14:05:19 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.20 (ruby-2.6.2).
+  0.9.25 (ruby-2.6.2).
 </div>
 
     </div>

data/doc/class_list.html

@@ -4,9 +4,9 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta charset="utf-8" />
     
-      <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
+      <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
     
-      <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+      <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
     
 
     

data/doc/css/style.css

@@ -422,8 +422,8 @@ li.r2 { background: #fafafa; }
 #toc ol { padding-left: 1.8em; }
 #toc li { font-size: 1.1em; line-height: 1.7em; }
 #toc > ol > li { font-size: 1.1em; font-weight: bold; }
-#toc ol > ol { font-size: 0.9em; }
-#toc ol ol > ol { padding-left: 2.3em; }
+#toc ol > li > ol { font-size: 0.9em; }
+#toc ol ol > li > ol { padding-left: 2.3em; }
 #toc ol + li { margin-top: 0.3em; }
 #toc.hidden { padding: 10px; background: #fefefe; box-shadow: none; }
 #toc.hidden:hover { background: #fafafa; }

data/doc/file.README.html

@@ -6,15 +6,15 @@
 <title>
   File: README
   
-    &mdash; Documentation by YARD 0.9.20
+    &mdash; Documentation by YARD 0.9.25
   
 </title>
 
-  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
 
-  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
 
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   pathId = "README";
   relpath = '';
 </script>
@@ -60,11 +60,11 @@
       <div id="content"><div id='filecontents'><p><a href="https://travis-ci.org/sitrox/inquery"><img src="https://travis-ci.org/sitrox/inquery.svg?branch=master" alt="Build Status"></a>
 <a href="https://badge.fury.io/rb/inquery"><img src="https://badge.fury.io/rb/inquery.svg" alt="Gem Version"></a></p>
 
-<h1>Inquery</h1>
+<h1 id="inquery">Inquery</h1>
 
 <p>A skeleton that allows extracting queries into atomic, reusable classes.</p>
 
-<h2>Installation</h2>
+<h2 id="installation">Installation</h2>
 
 <p>To install the <strong>Inquery</strong> gem:</p>
 
@@ -77,7 +77,7 @@ to your <code>Gemfile</code>:</p>
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>inquery</span><span class='tstring_end'>&#39;</span></span>
 </code></pre>
 
-<h2>Basic usage</h2>
+<h2 id="basic-usage">Basic usage</h2>
 
 <pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>FetchUsersWithACar</span> <span class='op'>&lt;</span> <span class='const'><span class='object_link'><a href="Inquery.html" title="Inquery (module)">Inquery</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Inquery/Query.html" title="Inquery::Query (class)">Query</a></span></span>
   <span class='id identifier rubyid_schema'>schema</span> <span class='kw'>do</span>
@@ -97,7 +97,7 @@ to your <code>Gemfile</code>:</p>
 and <span class='object_link'><a href="Inquery/Query/Chainable.html" title="Inquery::Query::Chainable (class)">Inquery::Query::Chainable</a></span>. See the following sections for detailed
 explanations.</p>
 
-<h2>Basic queries</h2>
+<h2 id="basic-queries">Basic queries</h2>
 
 <p>Basic queries inherit from <span class='object_link'><a href="Inquery/Query.html" title="Inquery::Query (class)">Inquery::Query</a></span>. They receive an optional set of
 parameters and commonly return a relation / AR result. An optional <code>process</code>
@@ -141,7 +141,7 @@ the <code>call</code> and optionally the <code>process</code> method:</p>
 <p>Note that it&#39;s perfectly fine for some queries to return <code>nil</code>, i.e. if they&#39;re
 writing queries that don&#39;t fetch any results.</p>
 
-<h3>Using raw SQL</h3>
+<h3 id="using-raw-sql">Using raw SQL</h3>
 
 <p>In some cases it may make sense to push down all computation to the database and
 only construct an SQL query for this purpose. To facilitate this,
@@ -171,7 +171,7 @@ only construct an SQL query for this purpose. To facilitate this,
 <span class='kw'>end</span>
 </code></pre>
 
-<h2>Chainable queries</h2>
+<h2 id="chainable-queries">Chainable queries</h2>
 
 <p>Chainable queries are queries that input and output an Active Record relation.
 You can access the given relation using the method <code>relation</code>:</p>
@@ -187,7 +187,7 @@ You can access the given relation using the method <code>relation</code>:</p>
 could pass a relation of <code>Group</code>s and receive back a relation of corresponding
 <code>User</code>s).</p>
 
-<h3>Relation validation</h3>
+<h3 id="relation-validation">Relation validation</h3>
 
 <p>Chainable queries allow you to further specify and validate the relation it
 receives. This is done using the static <code>relation</code> method:</p>
@@ -229,7 +229,7 @@ automatically select the given field. This option defaults to <code>:id</code>.
 <code>nil</code> to disable this behavior.</p></li>
 </ul>
 
-<h3>Using query classes as regular scopes</h3>
+<h3 id="using-query-classes-as-regular-scopes">Using query classes as regular scopes</h3>
 
 <p>Chainable queries can also be used as regular AR model scopes:</p>
 
@@ -255,7 +255,7 @@ but have the possibly complex query code hidden in a separate, reusable class.</
 
 <p>Note that when using classes as scopes, the <code>process</code> method will be ignored.</p>
 
-<h3>Using the given relation as subquery</h3>
+<h3 id="using-the-given-relation-as-subquery">Using the given relation as subquery</h3>
 
 <p>In simple cases and all the examples above, we just extend the given relation
 and return it again. It is also possible however to just use the given relation
@@ -291,7 +291,7 @@ as a subquery and return a completely new relation:</p>
 </span><span class='const'>FetchUsersInGroup</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='const'>Group</span><span class='period'>.</span><span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='label'>color:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>red</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
 </code></pre>
 
-<h2>Parameters</h2>
+<h2 id="parameters">Parameters</h2>
 
 <p>Both query classes can be parameterized using a hash called <code>params</code>. It is
 recommended to specify and validate input parameters in every query. For this
@@ -328,14 +328,17 @@ access.</p>
 <span class='kw'>end</span>
 </code></pre>
 
-<h2>Rails integration</h2>
+<p>Inquery supports both schemacop specification versions 2 and 3 using the methods
+<code>schema</code> / <code>schema2</code> for version 2 and method <code>schema3</code> for version 3.</p>
+
+<h2 id="rails-integration">Rails integration</h2>
 
 <p>While it is optional, Inquery has been written from the ground up to be
 perfectly integrated into any Rails application. It has proven to be a winning
 concept to extract all complex queries into separate classes that are
 independently executable and testable.</p>
 
-<h3>Directory structure</h3>
+<h3 id="directory-structure">Directory structure</h3>
 
 <p>While not enforced, it is encouraged to use the following structure for storing
 your query classes:</p>
@@ -363,20 +366,20 @@ clear where to find the corresponding unit tests for each one of your
 query classes.</li>
 </ul>
 
-<h2>Contributors</h2>
+<h2 id="contributors">Contributors</h2>
 
 <p>Thanks to Jeroen Weeink for his insights regarding using query classes as scopes
 in his <a href="http://craftingruby.com/posts/2015/06/29/query-objects-through-scopes.html">blog post</a>.</p>
 
-<h2>Copyright</h2>
+<h2 id="copyright">Copyright</h2>
 
-<p>Copyright (c) 2019 Sitrox. See <code>LICENSE</code> for further details.</p>
+<p>Copyright (c) 2020 Sitrox. See <code>LICENSE</code> for further details.</p>
 </div></div>
 
       <div id="footer">
-  Generated on Wed Oct  9 16:20:53 2019 by
+  Generated on Wed Nov 25 14:05:20 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.20 (ruby-2.6.2).
+  0.9.25 (ruby-2.6.2).
 </div>
 
     </div>