RubyGems - inquery - Versions diffs - 1.0.2 → 1.0.7 - Mend

inquery 1.0.2 → 1.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (35) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +21 -0
data/LICENSE +1 -1
data/README.md +4 -1
data/RUBY_VERSION +1 -1
data/Rakefile +1 -1
data/VERSION +1 -1
data/doc/Inquery.html +6 -6
data/doc/Inquery/Exceptions.html +6 -6
data/doc/Inquery/Exceptions/Base.html +6 -6
data/doc/Inquery/Exceptions/InvalidRelation.html +6 -6
data/doc/Inquery/Exceptions/UnknownCallSignature.html +6 -6
data/doc/Inquery/Mixins.html +6 -6
data/doc/Inquery/Mixins/RawSqlUtils.html +6 -6
data/doc/Inquery/Mixins/RelationValidation.html +17 -17
data/doc/Inquery/Mixins/RelationValidation/ClassMethods.html +11 -11
data/doc/Inquery/Mixins/SchemaValidation.html +6 -6
data/doc/Inquery/Mixins/SchemaValidation/ClassMethods.html +136 -12
data/doc/Inquery/Query.html +9 -9
data/doc/Inquery/Query/Chainable.html +8 -8
data/doc/_index.html +7 -7
data/doc/class_list.html +2 -2
data/doc/css/style.css +2 -2
data/doc/file.README.html +24 -21
data/doc/file_list.html +2 -2
data/doc/frames.html +2 -2
data/doc/index.html +24 -21
data/doc/js/app.js +14 -3
data/doc/method_list.html +18 -2
data/doc/top-level-namespace.html +6 -6
data/inquery.gemspec +6 -6
data/lib/inquery/mixins/relation_validation.rb +14 -5
data/lib/inquery/mixins/schema_validation.rb +14 -3
data/lib/inquery/query.rb +2 -2
metadata +11 -11

data/doc/file_list.html CHANGED

@@ -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/frames.html CHANGED

@@ -2,9 +2,9 @@
 <html>
 <head>
   <meta charset="utf-8">
-	<title>Documentation by YARD 0.9.20</title>
+	<title>Documentation by YARD 0.9.25</title>
 </head>
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   var match = unescape(window.location.hash).match(/^#!(.+)/);
   var name = match ? match[1] : 'index.html';
   name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');

data/doc/index.html CHANGED

@@ -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: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/js/app.js CHANGED

@@ -171,6 +171,7 @@ function generateTOC() {
   var counter = 0;
   var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
   var i;
+  var curli;
   if ($('#filecontents h1').length > 1) tags.unshift('h1');
   for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
   var lastTag = parseInt(tags[0][1], 10);
@@ -190,15 +191,25 @@ function generateTOC() {
     }
     if (thisTag > lastTag) {
       for (i = 0; i < thisTag - lastTag; i++) {
-        var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
+        if ( typeof(curli) == "undefined" ) {
+          curli = $('<li/>');
+          toc.append(curli);
+        }
+        toc = $('<ol/>');
+        curli.append(toc);
+        curli = undefined;
       }
     }
     if (thisTag < lastTag) {
-      for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
+      for (i = 0; i < lastTag - thisTag; i++) {
+        toc = toc.parent();
+        toc = toc.parent();
+      }
     }
     var title = $(this).attr('toc-title');
     if (typeof(title) == "undefined") title = $(this).text();
-    toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
+    curli =$('<li><a href="#' + this.id + '">' + title + '</a></li>');
+    toc.append(curli);
     lastTag = thisTag;
   });
   if (!show) return;

data/doc/method_list.html CHANGED

@@ -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" />
@@ -172,6 +172,22 @@
   </li>
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Inquery/Mixins/SchemaValidation/ClassMethods.html#schema2-instance_method" title="Inquery::Mixins::SchemaValidation::ClassMethods#schema2 (method)">#schema2</a></span>
+      <small>Inquery::Mixins::SchemaValidation::ClassMethods</small>
+    </div>
+  </li>
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Inquery/Mixins/SchemaValidation/ClassMethods.html#schema3-instance_method" title="Inquery::Mixins::SchemaValidation::ClassMethods#schema3 (method)">#schema3</a></span>
+      <small>Inquery::Mixins::SchemaValidation::ClassMethods</small>
+    </div>
+  </li>
   <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Inquery/Mixins/RelationValidation.html#validate_relation!-instance_method" title="Inquery::Mixins::RelationValidation#validate_relation! (method)">#validate_relation!</a></span>

data/doc/top-level-namespace.html CHANGED

@@ -6,15 +6,15 @@
 <title>
   Top Level Namespace
-    &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 = "";
   relpath = '';
 </script>
@@ -100,9 +100,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/inquery.gemspec CHANGED

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: inquery 1.0.2 ruby lib
+# stub: inquery 1.0.7 ruby lib
 Gem::Specification.new do |s|
   s.name = "inquery".freeze
-  s.version = "1.0.2"
+  s.version = "1.0.7"
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Sitrox".freeze]
-  s.date = "2019-10-09"
+  s.date = "2020-11-25"
   s.files = [".gitignore".freeze, ".releaser_config".freeze, ".rubocop.yml".freeze, ".travis.yml".freeze, ".yardopts".freeze, "CHANGELOG.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "RUBY_VERSION".freeze, "Rakefile".freeze, "VERSION".freeze, "doc/Inquery.html".freeze, "doc/Inquery/Exceptions.html".freeze, "doc/Inquery/Exceptions/Base.html".freeze, "doc/Inquery/Exceptions/InvalidRelation.html".freeze, "doc/Inquery/Exceptions/UnknownCallSignature.html".freeze, "doc/Inquery/Mixins.html".freeze, "doc/Inquery/Mixins/RawSqlUtils.html".freeze, "doc/Inquery/Mixins/RelationValidation.html".freeze, "doc/Inquery/Mixins/RelationValidation/ClassMethods.html".freeze, "doc/Inquery/Mixins/SchemaValidation.html".freeze, "doc/Inquery/Mixins/SchemaValidation/ClassMethods.html".freeze, "doc/Inquery/Query.html".freeze, "doc/Inquery/Query/Chainable.html".freeze, "doc/_index.html".freeze, "doc/class_list.html".freeze, "doc/css/common.css".freeze, "doc/css/full_list.css".freeze, "doc/css/style.css".freeze, "doc/file.README.html".freeze, "doc/file_list.html".freeze, "doc/frames.html".freeze, "doc/index.html".freeze, "doc/js/app.js".freeze, "doc/js/full_list.js".freeze, "doc/js/jquery.js".freeze, "doc/method_list.html".freeze, "doc/top-level-namespace.html".freeze, "inquery.gemspec".freeze, "lib/inquery.rb".freeze, "lib/inquery/exceptions.rb".freeze, "lib/inquery/mixins/raw_sql_utils.rb".freeze, "lib/inquery/mixins/relation_validation.rb".freeze, "lib/inquery/mixins/schema_validation.rb".freeze, "lib/inquery/query.rb".freeze, "lib/inquery/query/chainable.rb".freeze, "test/db/models.rb".freeze, "test/db/schema.rb".freeze, "test/inquery/query/chainable_test.rb".freeze, "test/inquery/query_test.rb".freeze, "test/queries/group/fetch_as_json.rb".freeze, "test/queries/group/fetch_green.rb".freeze, "test/queries/group/fetch_red.rb".freeze, "test/queries/group/filter_with_color.rb".freeze, "test/queries/user/fetch_all.rb".freeze, "test/queries/user/fetch_in_group.rb".freeze, "test/queries/user/fetch_in_group_rel.rb".freeze, "test/test_helper.rb".freeze]
   s.rubygems_version = "3.0.3".freeze
   s.summary = "A skeleton that allows extracting queries into atomic, reusable classes.".freeze
@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<minitest>.freeze, [">= 0"])
       s.add_runtime_dependency(%q<activesupport>.freeze, [">= 0"])
       s.add_runtime_dependency(%q<activerecord>.freeze, [">= 0"])
-      s.add_runtime_dependency(%q<schemacop>.freeze, ["~> 2.0"])
+      s.add_runtime_dependency(%q<schemacop>.freeze, [">= 2.0"])
     else
       s.add_dependency(%q<bundler>.freeze, [">= 0"])
       s.add_dependency(%q<rake>.freeze, [">= 0"])
@@ -40,7 +40,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<minitest>.freeze, [">= 0"])
       s.add_dependency(%q<activesupport>.freeze, [">= 0"])
       s.add_dependency(%q<activerecord>.freeze, [">= 0"])
-      s.add_dependency(%q<schemacop>.freeze, ["~> 2.0"])
+      s.add_dependency(%q<schemacop>.freeze, [">= 2.0"])
     end
   else
     s.add_dependency(%q<bundler>.freeze, [">= 0"])
@@ -53,6 +53,6 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<minitest>.freeze, [">= 0"])
     s.add_dependency(%q<activesupport>.freeze, [">= 0"])
     s.add_dependency(%q<activerecord>.freeze, [">= 0"])
-    s.add_dependency(%q<schemacop>.freeze, ["~> 2.0"])
+    s.add_dependency(%q<schemacop>.freeze, [">= 2.0"])
   end
 end

data/lib/inquery/mixins/relation_validation.rb CHANGED

@@ -3,11 +3,20 @@ module Inquery
     module RelationValidation
       extend ActiveSupport::Concern
-      OPTIONS_SCHEMA = Schemacop::Schema.new do
-        opt :class, :string
-        opt :fields, :integer
-        opt :default_select, :symbol
-        opt :default, :object, classes: [Proc, FalseClass]
+      if defined?(Schemacop::Schema3)
+        OPTIONS_SCHEMA = Schemacop::Schema3.new(:hash) do
+          str? :class
+          int? :fields
+          sym? :default_select
+          rby? :default, [Proc, FalseClass]
+        end
+      else
+        OPTIONS_SCHEMA = Schemacop::Schema.new do
+          opt :class, :string
+          opt :fields, :integer
+          opt :default_select, :symbol
+          opt :default, :object, classes: [Proc, FalseClass]
+        end
       end
       DEFAULT_OPTIONS = {

data/lib/inquery/mixins/schema_validation.rb CHANGED

@@ -9,10 +9,21 @@ module Inquery
       end
       module ClassMethods
-        def schema(*args, &block)
-          schema = Schemacop::Schema.new(*args, &block)
+        def schema2(*args, &block)
+          self._schema = Schemacop::Schema.new(*args, &block)
+        end
-          self._schema = schema
+        def schema3(reference = nil, **options, &block)
+          if reference
+            self._schema = Schemacop::Schema3.new(:reference, options.merge(path: reference))
+          else
+            self._schema = Schemacop::Schema3.new(:hash, **options, &block)
+          end
+        end
+        # @see schema2
+        def schema(*args, &block)
+          schema2(*args, &block)
         end
       end
     end

data/lib/inquery/query.rb CHANGED

@@ -22,8 +22,8 @@ module Inquery
     def initialize(params = {})
       @params = params
-      if self.class._schema
-        self.class._schema.validate!(@params)
+      if _schema
+        @params = _schema.validate!(@params)
       end
     end

metadata CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inquery
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.7
 platform: ruby
 authors:
 - Sitrox
-autorequire:
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-09 00:00:00.000000000 Z
+date: 2020-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -154,18 +154,18 @@ dependencies:
   name: schemacop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
-description:
-email:
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -229,10 +229,10 @@ files:
 - test/queries/user/fetch_in_group.rb
 - test/queries/user/fetch_in_group_rel.rb
 - test/test_helper.rb
-homepage:
+homepage:
 licenses: []
 metadata: {}
-post_install_message:
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -247,8 +247,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: A skeleton that allows extracting queries into atomic, reusable classes.
 test_files: