inquery 1.0.11 → 1.1.0

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

@@ -6,7 +6,7 @@
 <title>
   Module: Inquery::Mixins::SchemaValidation::ClassMethods
   
-    &mdash; Documentation by YARD 0.9.27
+    &mdash; Documentation by YARD 0.9.37
   
 </title>
 
@@ -306,9 +306,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Aug 24 11:11:23 2023 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.27 (ruby-3.0.1).
+  Generated on Mon Jan  5 14:06:48 2026 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.37 (ruby-3.3.5).
 </div>
 
     </div>

data/doc/Inquery/Mixins/SchemaValidation.html

@@ -6,7 +6,7 @@
 <title>
   Module: Inquery::Mixins::SchemaValidation
   
-    &mdash; Documentation by YARD 0.9.27
+    &mdash; Documentation by YARD 0.9.37
   
 </title>
 
@@ -116,9 +116,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Aug 24 11:11:23 2023 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.27 (ruby-3.0.1).
+  Generated on Mon Jan  5 14:06:48 2026 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.37 (ruby-3.3.5).
 </div>
 
     </div>

data/doc/Inquery/Mixins.html

@@ -6,7 +6,7 @@
 <title>
   Module: Inquery::Mixins
   
-    &mdash; Documentation by YARD 0.9.27
+    &mdash; Documentation by YARD 0.9.37
   
 </title>
 
@@ -107,9 +107,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Aug 24 11:11:23 2023 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.27 (ruby-3.0.1).
+  Generated on Mon Jan  5 14:06:48 2026 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.37 (ruby-3.3.5).
 </div>
 
     </div>

data/doc/Inquery/Query/Chainable.html

@@ -6,7 +6,7 @@
 <title>
   Class: Inquery::Query::Chainable
   
-    &mdash; Documentation by YARD 0.9.27
+    &mdash; Documentation by YARD 0.9.37
   
 </title>
 
@@ -106,7 +106,37 @@
   
 </div>
 
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>Chainable query class for queries that input and output ActiveRecord relations.</p>
+
+<p>Use this class when you want to build queries that can be chained together or used as ActiveRecord scopes. The query receives a relation, transforms it, and returns a new relation.</p>
+
+<p>Example:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>FetchActive</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="../Query.html" title="Inquery::Query (class)">Query</a></span></span><span class='op'>::</span><span class='const'>Chainable</span>
+  <span class='id identifier rubyid_relation'>relation</span> <span class='label'>class:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>User</span><span class='tstring_end'>&#39;</span></span>
+
+  <span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span>
+    <span class='id identifier rubyid_relation'>relation</span><span class='period'>.</span><span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='label'>active:</span> <span class='kw'>true</span><span class='rparen'>)</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span>
+
+<span class='const'>User</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span><span class='period'>.</span><span class='id identifier rubyid_then'>then</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_rel'>rel</span><span class='op'>|</span> <span class='const'>FetchActive</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='id identifier rubyid_rel'>rel</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
+<span class='comment'># Or as a scope:
+</span><span class='kw'>class</span> <span class='const'>User</span> <span class='op'>&lt;</span> <span class='const'>ActiveRecord</span><span class='op'>::</span><span class='const'>Base</span>
+  <span class='id identifier rubyid_scope'>scope</span> <span class='symbol'>:active</span><span class='comma'>,</span> <span class='const'>FetchActive</span>
+<span class='kw'>end</span>
+</code></pre>
+
 
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
 
 
   <h2>Constant Summary</h2>
@@ -122,7 +152,7 @@
       <li class="public ">
   <span class="summary_signature">
     
-      <a href="#relation-instance_method" title="#relation (instance method)">#<strong>relation</strong>  &#x21d2; Object </a>
+      <a href="#relation-instance_method" title="#relation (instance method)">#<strong>relation</strong>  &#x21d2; ActiveRecord::Relation </a>
     
 
     
@@ -141,7 +171,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute relation.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>The input ActiveRecord relation that will be transformed by this query.</p>
 </div></span>
   
 </li>
@@ -168,7 +199,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#call-class_method" title="call (class method)">.<strong>call</strong>(*args)  &#x21d2; Object </a>
+      <a href="#call-class_method" title="call (class method)">.<strong>call</strong>(*args)  &#x21d2; ActiveRecord::Relation </a>
     
 
     
@@ -182,7 +213,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Allows using this class as an AR scope.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Instantiates the query and executes it, allowing use as an AR scope.</p>
 </div></span>
   
 </li>
@@ -200,29 +232,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#call-instance_method" title="#call (instance method)">#<strong>call</strong>(*args)  &#x21d2; Object </a>
-    
-
-    
-  </span>
-  
-  
-  
-  
-  
-  
-  
-
-  
-    <span class="summary_desc"><div class='inline'></div></span>
-  
-</li>
-
-      
-        <li class="public ">
-  <span class="summary_signature">
-    
-      <a href="#connection-instance_method" title="#connection (instance method)">#<strong>connection</strong>  &#x21d2; Object </a>
+      <a href="#connection-instance_method" title="#connection (instance method)">#<strong>connection</strong>  &#x21d2; ActiveRecord::ConnectionAdapters::AbstractAdapter </a>
     
 
     
@@ -236,7 +246,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Override the connection method to (re-)use the connection of the relation.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the database connection from the relation.</p>
 </div></span>
   
 </li>
@@ -261,7 +272,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>A new instance of Chainable.</p>
+    <span class="summary_desc"><div class='inline'>
+<p>Initializes a chainable query with a relation and optional parameters.</p>
 </div></span>
   
 </li>
@@ -292,7 +304,7 @@
   
   
   <h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Query.html" title="Inquery::Query (class)">Inquery::Query</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="../Query.html#osparams-instance_method" title="Inquery::Query#osparams (method)">#osparams</a></span>, <span class='object_link'><a href="../Query.html#process-instance_method" title="Inquery::Query#process (method)">#process</a></span>, <span class='object_link'><a href="../Query.html#run-class_method" title="Inquery::Query.run (method)">run</a></span>, <span class='object_link'><a href="../Query.html#run-instance_method" title="Inquery::Query#run (method)">#run</a></span></p>
+  <p class="inherited"><span class='object_link'><a href="../Query.html#call-instance_method" title="Inquery::Query#call (method)">#call</a></span>, <span class='object_link'><a href="../Query.html#osparams-instance_method" title="Inquery::Query#osparams (method)">#osparams</a></span>, <span class='object_link'><a href="../Query.html#process-instance_method" title="Inquery::Query#process (method)">#process</a></span>, <span class='object_link'><a href="../Query.html#run-class_method" title="Inquery::Query.run (method)">run</a></span>, <span class='object_link'><a href="../Query.html#run-instance_method" title="Inquery::Query#run (method)">#run</a></span></p>
 
   
   
@@ -321,13 +333,74 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Returns a new instance of Chainable.</p>
+    
+<p>Initializes a chainable query with a relation and optional parameters.</p>
+
+<p>Supports multiple call signatures:</p>
+
+<pre class="code ruby"><code class="ruby">new()                    - Uses default relation from &#39;relation&#39; DSL
+new(relation)            - Uses provided relation
+new(params)              - Uses default relation with params
+new(relation, params)    - Uses provided relation and params
+</code></pre>
 
 
   </div>
 </div>
 <div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>args</span>
+      
+      
+        <span class='type'>(<tt>Array</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Variable arguments for relation and/or params</p>
+</div>
+      
+    </li>
   
+</ul>
+
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="../Exceptions/UnknownCallSignature.html" title="Inquery::Exceptions::UnknownCallSignature (class)">Inquery::Exceptions::UnknownCallSignature</a></span></tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>for invalid arguments</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="../Exceptions/InvalidRelation.html" title="Inquery::Exceptions::InvalidRelation (class)">Inquery::Exceptions::InvalidRelation</a></span></tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>if relation validation fails</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -335,14 +408,14 @@
       <pre class="lines">
 
 
-16
-17
-18
-19
-20</pre>
+52
+53
+54
+55
+56</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/inquery/query/chainable.rb', line 16</span>
+      <pre class="code"><span class="info file"># File 'lib/inquery/query/chainable.rb', line 52</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_relation'>relation</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_parse_init_args'>parse_init_args</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
@@ -364,7 +437,7 @@
       <div class="method_details first">
   <h3 class="signature first" id="relation-instance_method">
   
-    #<strong>relation</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+    #<strong>relation</strong>  &#x21d2; <tt>ActiveRecord::Relation</tt>  <span class="extras">(readonly)</span>
   
 
   
@@ -372,13 +445,27 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Returns the value of attribute relation.</p>
+    
+<p>The input ActiveRecord relation that will be transformed by this query.</p>
 
 
   </div>
 </div>
 <div class="tags">
   
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>ActiveRecord::Relation</tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -386,12 +473,12 @@
       <pre class="lines">
 
 
-14
-15
-16</pre>
+39
+40
+41</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/inquery/query/chainable.rb', line 14</span>
+      <pre class="code"><span class="info file"># File 'lib/inquery/query/chainable.rb', line 39</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_relation'>relation</span>
   <span class='ivar'>@relation</span>
@@ -411,7 +498,7 @@
       <div class="method_details first">
   <h3 class="signature first" id="call-class_method">
   
-    .<strong>call</strong>(*args)  &#x21d2; <tt>Object</tt> 
+    .<strong>call</strong>(*args)  &#x21d2; <tt>ActiveRecord::Relation</tt> 
   
 
   
@@ -419,13 +506,57 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Allows using this class as an AR scope.</p>
+    
+<p>Instantiates the query and executes it, allowing use as an AR scope.</p>
+
+<p>This enables chainable queries to be used directly as ActiveRecord scopes:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_scope'>scope</span> <span class='symbol'>:active</span><span class='comma'>,</span> <span class='const'>FetchActive</span>
+</code></pre>
 
 
   </div>
 </div>
 <div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
   
+    <li>
+      
+        <span class='name'>args</span>
+      
+      
+        <span class='type'>(<tt>Array</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Arguments passed to initialize (relation and/or params)</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>ActiveRecord::Relation</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The transformed relation</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -433,12 +564,12 @@
       <pre class="lines">
 
 
-6
-7
-8</pre>
+32
+33
+34</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/inquery/query/chainable.rb', line 6</span>
+      <pre class="code"><span class="info file"># File 'lib/inquery/query/chainable.rb', line 32</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
   <span class='kw'>return</span> <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span>
@@ -455,39 +586,9 @@
 
     
       <div class="method_details first">
-  <h3 class="signature first" id="call-instance_method">
-  
-    #<strong>call</strong>(*args)  &#x21d2; <tt>Object</tt> 
-  
-
-  
-
-  
-</h3><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-
-
-10
-11
-12</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/inquery/query/chainable.rb', line 10</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_fail'>fail</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-    
-      <div class="method_details ">
-  <h3 class="signature " id="connection-instance_method">
+  <h3 class="signature first" id="connection-instance_method">
   
-    #<strong>connection</strong>  &#x21d2; <tt>Object</tt> 
+    #<strong>connection</strong>  &#x21d2; <tt>ActiveRecord::ConnectionAdapters::AbstractAdapter</tt> 
   
 
   
@@ -495,13 +596,29 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Override the connection method to (re-)use the connection of the relation</p>
+    
+<p>Returns the database connection from the relation.</p>
+
+<p>This ensures that the query uses the same connection as the input relation, which is important for connection pooling and transactions.</p>
 
 
   </div>
 </div>
 <div class="tags">
   
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>ActiveRecord::ConnectionAdapters::AbstractAdapter</tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -509,12 +626,12 @@
       <pre class="lines">
 
 
-23
-24
-25</pre>
+64
+65
+66</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/inquery/query/chainable.rb', line 23</span>
+      <pre class="code"><span class="info file"># File 'lib/inquery/query/chainable.rb', line 64</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_connection'>connection</span>
   <span class='ivar'>@relation</span><span class='period'>.</span><span class='id identifier rubyid_connection'>connection</span>
@@ -529,9 +646,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Aug 24 11:11:23 2023 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.27 (ruby-3.0.1).
+  Generated on Mon Jan  5 14:06:48 2026 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.37 (ruby-3.3.5).
 </div>
 
     </div>