inquery 0.1.0 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: aec4e3689d2f6830ee142beb89ef38d8c7e03d65
-  data.tar.gz: 491f28cd6d7b8335362d77699f0f0c214824b893
+SHA256:
+  metadata.gz: 705cf4cd798bece378f6bb8f58f6fe8c4cc8e5175519bff8d292bcb1c718ffa9
+  data.tar.gz: 4aad1d32fc5725ad02d1361d351f225304115006fd974f98ea587f2e7e0dcfa7
 SHA512:
-  metadata.gz: 9d009ad21e0578929aa49c050210096c6f3d747c9b6aed1ede3ab26d4e4255d7695a0d22ec896b657167cca300642158ecf040cac48f0d3a2c7e8d374aec603f
-  data.tar.gz: '08ad570e01461f620e959923cc8cbc8083efe08296982f5517ab1e99df22dad1d3b6bb73fe9eba1c68205bacdffb782ab8b4df92538eb568d015d70c3c412ae5'
+  metadata.gz: 54ca20f922c48be73d09f88519323a9133837fb621721b3fc7ad4ba68e612df6f1aabcd2343322440d0a6102691bdd29de704b440007168ff068547f20021c5f
+  data.tar.gz: 46ddba74947a1c088216e3467a20c0ddf4716e471f4b6f3fab1a96e8b0d5e624bc935bfd4cfbbfc44ac6515dac0380aebfcfae80fff77ae2b7ec70fd83599611

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Change log
+
+## 1.0.4 (2020-11-24)
+
+- Add support for schemacop 3.x (but still using 2.x schema version)
+
+## 1.0.3 (2020-05-12)
+
+- Overwrite parameter hash with the casted version if using 
+  casting inside the schemacop `schema` block
+
+## 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) 2020 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

@@ -24,9 +24,9 @@ gem 'inquery'
 
 ```ruby
 class FetchUsersWithACar < Inquery::Query
-  schema(
-    color: :symbol
-  )
+  schema do
+    req :color, :symbol
+  end
 
   def call
     User.joins(:cars).where(cars: { color: osparams.color })
@@ -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.
@@ -223,14 +254,12 @@ purpose, Inquery provides the `schema` method witch integrates the
 
 ```ruby
 class SomeQueryClass < Inquery::Query
-  schema(
-    some_param: :integer,
-    some_other_param: {
-      hash: {
-        some_field: :string
-      }
-    }
-  )
+  schema do
+    req :some_param, :integer
+    opt :some_other_param, :hash do
+      req :some_field, :string
+    end
+  end
 
   # ...
 end
@@ -290,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) 2020 Sitrox. See `LICENSE` for further details.

data/RUBY_VERSION

@@ -1 +1 @@
-ruby-2.3.1-p112
+ruby-2.6.2-p47

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'
@@ -21,7 +21,7 @@ task :gemspec do
     spec.add_dependency 'minitest'
     spec.add_dependency 'activesupport'
     spec.add_dependency 'activerecord'
-    spec.add_dependency 'schemacop', '~> 1'
+    spec.add_dependency 'schemacop', '>= 2.0'
   end
 
   File.open('inquery.gemspec', 'w') { |f| f.write(gemspec.to_ruby.strip) }

data/VERSION

@@ -1 +1 @@
-0.1.0
+1.0.4

data/doc/Inquery.html

@@ -6,15 +6,15 @@
 <title>
   Module: Inquery
   
-    &mdash; Documentation by YARD 0.9.9
+    &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";
   relpath = '';
 </script>
@@ -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 Tue May 16 10:49:05 2017 by
+  Generated on Tue Nov 24 16:32:43 2020 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.25 (ruby-2.6.2).
 </div>
 
     </div>

data/doc/Inquery/Exceptions.html

@@ -6,15 +6,15 @@
 <title>
   Module: Inquery::Exceptions
   
-    &mdash; Documentation by YARD 0.9.9
+    &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::Exceptions";
   relpath = '../';
 </script>
@@ -105,9 +105,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 10:49:05 2017 by
+  Generated on Tue Nov 24 16:32:43 2020 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.25 (ruby-2.6.2).
 </div>
 
     </div>

data/doc/Inquery/Exceptions/Base.html

@@ -6,15 +6,15 @@
 <title>
   Exception: Inquery::Exceptions::Base
   
-    &mdash; Documentation by YARD 0.9.9
+    &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::Exceptions::Base";
   relpath = '../../';
 </script>
@@ -118,9 +118,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 10:49:05 2017 by
+  Generated on Tue Nov 24 16:32:43 2020 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.25 (ruby-2.6.2).
 </div>
 
     </div>

data/doc/Inquery/Exceptions/InvalidRelation.html

@@ -6,15 +6,15 @@
 <title>
   Exception: Inquery::Exceptions::InvalidRelation
   
-    &mdash; Documentation by YARD 0.9.9
+    &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::Exceptions::InvalidRelation";
   relpath = '../../';
 </script>
@@ -122,9 +122,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 10:49:05 2017 by
+  Generated on Tue Nov 24 16:32:43 2020 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.25 (ruby-2.6.2).
 </div>
 
     </div>

data/doc/Inquery/Exceptions/UnknownCallSignature.html

@@ -6,15 +6,15 @@
 <title>
   Exception: Inquery::Exceptions::UnknownCallSignature
   
-    &mdash; Documentation by YARD 0.9.9
+    &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::Exceptions::UnknownCallSignature";
   relpath = '../../';
 </script>
@@ -122,9 +122,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 10:49:05 2017 by
+  Generated on Tue Nov 24 16:32:43 2020 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.25 (ruby-2.6.2).
 </div>
 
     </div>

data/doc/Inquery/Mixins.html

@@ -6,15 +6,15 @@
 <title>
   Module: Inquery::Mixins
   
-    &mdash; Documentation by YARD 0.9.9
+    &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";
   relpath = '../';
 </script>
@@ -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 Tue May 16 10:49:05 2017 by
+  Generated on Tue Nov 24 16:32:43 2020 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.25 (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.25
+  
+</title>
+
+  <link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+  <link rel="stylesheet" href="../../css/common.css" type="text/css" />
+
+<script type="text/javascript">
+  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 Tue Nov 24 16:32:43 2020 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.25 (ruby-2.6.2).
+</div>
+
+    </div>
+  </body>
+</html>