inquery 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2510806e3068638779cf5e1012b37c8ddfd1141e
-  data.tar.gz: 60217fc4f8376d9939ba8851705a94ead50f5b22
+SHA256:
+  metadata.gz: fadeb3eebd8e58e36b96cddf25d32dc634de642a68cb967dd1cbaf010b889665
+  data.tar.gz: b468fd644261a3dd7d78f630833677539ab157d96483cfbacc7d16de5d734df0
 SHA512:
-  metadata.gz: 77725cde076b84538c4a020b66e1a70a4138f3b3eed00be69f3361c1c11db1bc743794bf2f84300ff392a0c54b5799701a2f80dc2e9c19cbd16bd12e5750248a
-  data.tar.gz: d257e5b56c8649bb77fce41b03b336a5e3506957103df9da7880d5e4d34d36ec63668cc42a6d504dfad5e4d08d16fbc9a50a6302389cc7b2eb65b089f4e25003
+  metadata.gz: 6c19663ecce2ce5f0818ea606b9d07bc6512aff13eb26cb7a979b25dd7ef5db6f077c6f1e6c246b7c85597eab6385beb2d633cecc4bea8381d0145098b992c27
+  data.tar.gz: 28d534d48d02eb0f78e170fecd02b446244ea80ea1f1906001cc21a90681258a319cb85715099c94d402463aa17338ada5d835cb341e20200480f5f97368b44d

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Change log
+
+## 1.0.2 (2019-10-09)
+
+- Add new mixin `RawSqlUtils`, which provides two methods for
+  `Inquery::Query`:
+
+    - `san`: Sanitizes SQL and performs parameter substitution
+    - `exec_query`: For directly executing SQL queries
+
+## 1.0.1 (2017-05-17)
+
+- Pin `schemacop` version properly
+
+## 1.0.0 (2017-05-16)
+
+- Initial release

data/LICENSE

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2016 Sitrox
+Copyright (c) 2019 Sitrox
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -87,6 +87,37 @@ FetchRedCarsAsJson.new(params = {}).call
 Note that it's perfectly fine for some queries to return `nil`, i.e. if they're
 writing queries that don't fetch any results.
 
+### Using raw SQL
+
+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,
+{Inquery::Query} provides sanitization and query execution methods:
+
+```ruby
+# Note: There are better ways of achieving the same result, this is an example
+# to demonstrate the methods.
+class CheckIfSold < Inquery::Query
+  def call
+    parts = [
+      'SELECT car_id FROM dealership_sales',
+      'SELECT car_id FROM dealership_leasings'
+    ]
+
+    sql = 'SELECT ? IN (' + parts.join(' UNION ') + ')'
+
+    # The 'san' method takes n+1 arguments: The SQL string and n parameters
+    sanitized_sql = san(sql, osparams.car_id)
+
+    # Returns instance of ActiveRecord::Result
+    return exec_query(sanitized_sql)
+  end
+
+  def process(results)
+    results.rows.first.first
+  end
+end
+```
+
 ## Chainable queries
 
 Chainable queries are queries that input and output an Active Record relation.
@@ -288,8 +319,7 @@ There are some key benefits to this approach:
 
 Thanks to Jeroen Weeink for his insights regarding using query classes as scopes
 in his [blog post](http://craftingruby.com/posts/2015/06/29/query-objects-through-scopes.html).
-And special thanks to [SubGit](http://www.subgit.com/) for their great open source licensing.
 
 ## Copyright
 
-Copyright (c) 2017 Sitrox. See `LICENSE` for further details.
+Copyright (c) 2019 Sitrox. See `LICENSE` for further details.

data/Rakefile

@@ -11,7 +11,7 @@ task :gemspec do
     spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
     spec.require_paths = ['lib']
 
-    spec.add_development_dependency 'bundler', '~> 1.3'
+    spec.add_development_dependency 'bundler'
     spec.add_development_dependency 'rake'
     spec.add_development_dependency 'sqlite3'
     spec.add_development_dependency 'haml'

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.0.2

data/doc/Inquery.html

@@ -6,7 +6,7 @@
 <title>
   Module: Inquery
   
-    &mdash; Documentation by YARD 0.9.9
+    &mdash; Documentation by YARD 0.9.20
   
 </title>
 
@@ -79,7 +79,7 @@
   <dl>
     <dt>Defined in:</dt>
     <dd>lib/inquery.rb<span class="defines">,<br />
-  lib/inquery/query.rb,<br /> lib/inquery/exceptions.rb,<br /> lib/inquery/query/chainable.rb,<br /> lib/inquery/mixins/schema_validation.rb,<br /> lib/inquery/mixins/relation_validation.rb</span>
+  lib/inquery/query.rb,<br /> lib/inquery/exceptions.rb,<br /> lib/inquery/query/chainable.rb,<br /> lib/inquery/mixins/raw_sql_utils.rb,<br /> lib/inquery/mixins/schema_validation.rb,<br /> lib/inquery/mixins/relation_validation.rb</span>
 </dd>
   </dl>
   
@@ -109,9 +109,9 @@
 </div>
 
       <div id="footer">
-  Generated on Wed May 17 12:30:38 2017 by
+  Generated on Wed Oct  9 16:20:53 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.9 (ruby-2.3.1).
+  0.9.20 (ruby-2.6.2).
 </div>
 
     </div>

data/doc/Inquery/Exceptions.html

@@ -6,7 +6,7 @@
 <title>
   Module: Inquery::Exceptions
   
-    &mdash; Documentation by YARD 0.9.9
+    &mdash; Documentation by YARD 0.9.20
   
 </title>
 
@@ -105,9 +105,9 @@
 </div>
 
       <div id="footer">
-  Generated on Wed May 17 12:30:38 2017 by
+  Generated on Wed Oct  9 16:20:53 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.9 (ruby-2.3.1).
+  0.9.20 (ruby-2.6.2).
 </div>
 
     </div>

data/doc/Inquery/Exceptions/Base.html

@@ -6,7 +6,7 @@
 <title>
   Exception: Inquery::Exceptions::Base
   
-    &mdash; Documentation by YARD 0.9.9
+    &mdash; Documentation by YARD 0.9.20
   
 </title>
 
@@ -118,9 +118,9 @@
 </div>
 
       <div id="footer">
-  Generated on Wed May 17 12:30:38 2017 by
+  Generated on Wed Oct  9 16:20:53 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.9 (ruby-2.3.1).
+  0.9.20 (ruby-2.6.2).
 </div>
 
     </div>

data/doc/Inquery/Exceptions/InvalidRelation.html

@@ -6,7 +6,7 @@
 <title>
   Exception: Inquery::Exceptions::InvalidRelation
   
-    &mdash; Documentation by YARD 0.9.9
+    &mdash; Documentation by YARD 0.9.20
   
 </title>
 
@@ -122,9 +122,9 @@
 </div>
 
       <div id="footer">
-  Generated on Wed May 17 12:30:38 2017 by
+  Generated on Wed Oct  9 16:20:53 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.9 (ruby-2.3.1).
+  0.9.20 (ruby-2.6.2).
 </div>
 
     </div>

data/doc/Inquery/Exceptions/UnknownCallSignature.html

@@ -6,7 +6,7 @@
 <title>
   Exception: Inquery::Exceptions::UnknownCallSignature
   
-    &mdash; Documentation by YARD 0.9.9
+    &mdash; Documentation by YARD 0.9.20
   
 </title>
 
@@ -122,9 +122,9 @@
 </div>
 
       <div id="footer">
-  Generated on Wed May 17 12:30:38 2017 by
+  Generated on Wed Oct  9 16:20:53 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.9 (ruby-2.3.1).
+  0.9.20 (ruby-2.6.2).
 </div>
 
     </div>

data/doc/Inquery/Mixins.html

@@ -6,7 +6,7 @@
 <title>
   Module: Inquery::Mixins
   
-    &mdash; Documentation by YARD 0.9.9
+    &mdash; Documentation by YARD 0.9.20
   
 </title>
 
@@ -78,8 +78,8 @@
   
   <dl>
     <dt>Defined in:</dt>
-    <dd>lib/inquery/mixins/schema_validation.rb<span class="defines">,<br />
-  lib/inquery/mixins/relation_validation.rb</span>
+    <dd>lib/inquery/mixins/raw_sql_utils.rb<span class="defines">,<br />
+  lib/inquery/mixins/schema_validation.rb,<br /> lib/inquery/mixins/relation_validation.rb</span>
 </dd>
   </dl>
   
@@ -89,7 +89,7 @@
 <p class="children">
   
     
-      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Mixins/RelationValidation.html" title="Inquery::Mixins::RelationValidation (module)">RelationValidation</a></span>, <span class='object_link'><a href="Mixins/SchemaValidation.html" title="Inquery::Mixins::SchemaValidation (module)">SchemaValidation</a></span>
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Mixins/RawSqlUtils.html" title="Inquery::Mixins::RawSqlUtils (module)">RawSqlUtils</a></span>, <span class='object_link'><a href="Mixins/RelationValidation.html" title="Inquery::Mixins::RelationValidation (module)">RelationValidation</a></span>, <span class='object_link'><a href="Mixins/SchemaValidation.html" title="Inquery::Mixins::SchemaValidation (module)">SchemaValidation</a></span>
     
   
     
@@ -107,9 +107,9 @@
 </div>
 
       <div id="footer">
-  Generated on Wed May 17 12:30:38 2017 by
+  Generated on Wed Oct  9 16:20:53 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.9 (ruby-2.3.1).
+  0.9.20 (ruby-2.6.2).
 </div>
 
     </div>

data/doc/Inquery/Mixins/RawSqlUtils.html

@@ -0,0 +1,116 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: Inquery::Mixins::RawSqlUtils
+  
+    &mdash; Documentation by YARD 0.9.20
+  
+</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 = "Inquery::Mixins::RawSqlUtils";
+  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 (R)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../Inquery.html" title="Inquery (module)">Inquery</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Mixins.html" title="Inquery::Mixins (module)">Mixins</a></span></span>
+     &raquo; 
+    <span class="title">RawSqlUtils</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>Module: Inquery::Mixins::RawSqlUtils
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+
+  
+  
+  <dl>
+      <dt>Extended by:</dt>
+      <dd>ActiveSupport::Concern</dd>
+  </dl>
+  
+  
+  
+  
+
+  
+  <dl>
+    <dt>Included in:</dt>
+    <dd><span class='object_link'><a href="../Query.html" title="Inquery::Query (class)">Query</a></span></dd>
+  </dl>
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/inquery/mixins/raw_sql_utils.rb</dd>
+  </dl>
+  
+</div>
+
+
+
+
+
+
+
+
+
+  
+
+</div>
+
+      <div id="footer">
+  Generated on Wed Oct  9 16:20:53 2019 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.20 (ruby-2.6.2).
+</div>
+
+    </div>
+  </body>
+</html>

data/doc/Inquery/Mixins/RelationValidation.html

@@ -6,7 +6,7 @@
 <title>
   Module: Inquery::Mixins::RelationValidation
   
-    &mdash; Documentation by YARD 0.9.9
+    &mdash; Documentation by YARD 0.9.20
   
 </title>
 
@@ -104,23 +104,28 @@
   
 </p>
 
-  <h2>Constant Summary</h2>
-  <dl class="constants">
-    
-      <dt id="OPTIONS_SCHEMA-constant" class="">OPTIONS_SCHEMA =
-        
-      </dt>
-      <dd><pre class="code"><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='kw'>do</span>
+  
+    <h2>
+      Constant Summary
+      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+    </h2>
+
+    <dl class="constants">
+      
+        <dt id="OPTIONS_SCHEMA-constant" class="">OPTIONS_SCHEMA =
+          
+        </dt>
+        <dd><pre class="code"><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='kw'>do</span>
   <span class='id identifier rubyid_opt'>opt</span> <span class='symbol'>:class</span><span class='comma'>,</span> <span class='symbol'>:string</span>
   <span class='id identifier rubyid_opt'>opt</span> <span class='symbol'>:fields</span><span class='comma'>,</span> <span class='symbol'>:integer</span>
   <span class='id identifier rubyid_opt'>opt</span> <span class='symbol'>:default_select</span><span class='comma'>,</span> <span class='symbol'>:symbol</span>
   <span class='id identifier rubyid_opt'>opt</span> <span class='symbol'>:default</span><span class='comma'>,</span> <span class='symbol'>:object</span><span class='comma'>,</span> <span class='label'>classes:</span> <span class='lbracket'>[</span><span class='const'>Proc</span><span class='comma'>,</span> <span class='const'>FalseClass</span><span class='rbracket'>]</span>
 <span class='kw'>end</span></pre></dd>
-    
-      <dt id="DEFAULT_OPTIONS-constant" class="">DEFAULT_OPTIONS =
-        
-      </dt>
-      <dd><pre class="code"><span class='lbrace'>{</span>
+      
+        <dt id="DEFAULT_OPTIONS-constant" class="">DEFAULT_OPTIONS =
+          
+        </dt>
+        <dd><pre class="code"><span class='lbrace'>{</span>
   <span class='comment'># Allows to restrict the class (attribute `klass`) of the relation. Use
 </span>  <span class='comment'># `nil` to not perform any checks. The `class` attribute will also be
 </span>  <span class='comment'># taken to infer a default if no relation is given and you didn&#39;t
@@ -145,8 +150,9 @@
 </span>  <span class='comment'># behavior.
 </span>  <span class='label'>default_select:</span> <span class='symbol'>:id</span>
 <span class='rbrace'>}</span></pre></dd>
-    
-  </dl>
+      
+    </dl>
+  
 
 
 
@@ -319,9 +325,9 @@ options specified at class level using the <code>relation</code> method.</p>
 </div>
 
       <div id="footer">
-  Generated on Wed May 17 12:30:38 2017 by
+  Generated on Wed Oct  9 16:20:53 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.9 (ruby-2.3.1).
+  0.9.20 (ruby-2.6.2).
 </div>
 
     </div>