<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Module: Inquery::Mixins::RelationValidation
— Documentation by YARD 0.8.7.6
</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">
hasFrames = window.top.frames.main ? true : false;
relpath = '../../';
framesUrl = "../../frames.html#!Inquery/Mixins/RelationValidation.html";
</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 id="header">
<div id="menu">
<a href="../../_index.html">Index (R)</a> »
<span class='title'><span class='object_link'><a href="../../Inquery.html" title="Inquery (module)">Inquery</a></span></span> » <span class='title'><span class='object_link'><a href="../Mixins.html" title="Inquery::Mixins (module)">Mixins</a></span></span>
»
<span class="title">RelationValidation</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: Inquery::Mixins::RelationValidation
</h1>
<dl class="box">
<dt class="r1">Extended by:</dt>
<dd class="r1">ActiveSupport::Concern</dd>
<dt class="r2">Included in:</dt>
<dd class="r2"><span class='object_link'><a href="../Query/Chainable.html" title="Inquery::Query::Chainable (class)">Query::Chainable</a></span></dd>
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/inquery/mixins/relation_validation.rb</dd>
</dl>
<div class="clear"></div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="RelationValidation/ClassMethods.html" title="Inquery::Mixins::RelationValidation::ClassMethods (module)">ClassMethods</a></span>
</p>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="OPTIONS_SCHEMA-constant" class="">OPTIONS_SCHEMA =
</dt>
<dd><pre class="code"><span class='lbrace'>{</span>
<span class='label'>hash:</span> <span class='lbrace'>{</span>
<span class='label'>class:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='const'>String</span><span class='comma'>,</span> <span class='label'>null:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>required:</span> <span class='kw'>false</span> <span class='rbrace'>}</span><span class='comma'>,</span>
<span class='label'>fields:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='symbol'>:integer</span><span class='comma'>,</span> <span class='label'>null:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>required:</span> <span class='kw'>false</span> <span class='rbrace'>}</span><span class='comma'>,</span>
<span class='label'>default_select:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='symbol'>:symbol</span><span class='comma'>,</span> <span class='label'>null:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>required:</span> <span class='kw'>false</span> <span class='rbrace'>}</span><span class='comma'>,</span>
<span class='label'>default:</span> <span class='lbrace'>{</span> <span class='label'>type:</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='comma'>,</span> <span class='label'>null:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>required:</span> <span class='kw'>false</span> <span class='rbrace'>}</span>
<span class='rbrace'>}</span>
<span class='rbrace'>}</span></pre></dd>
<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't
</span> <span class='comment'># specify any `default`.
</span> <span class='label'>class:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='comment'># This allows to specify a default relation that will be taken if no
</span> <span class='comment'># relation is given. This must be specified as a Proc returning the
</span> <span class='comment'># relation. Set this to `false` for no default. If this is set to `nil`,
</span> <span class='comment'># it will try to infer the default from the option `class` (if given).
</span> <span class='label'>default:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='comment'># Allows to restrict the number of fields / values the relation must
</span> <span class='comment'># select. This is particularly useful if you're using the query as a
</span> <span class='comment'># subquery and need it to return exactly one field. Use `nil` to not
</span> <span class='comment'># perform any checks.
</span> <span class='label'>fields:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='comment'># If this is set to a symbol, the relation does not have any select
</span> <span class='comment'># fields specified (`select_values` is empty) and `fields` is > 0, it
</span> <span class='comment'># will automatically select the given field. Use `nil` to disable this
</span> <span class='comment'># behavior.
</span> <span class='label'>default_select:</span> <span class='symbol'>:id</span>
<span class='rbrace'>}</span></pre></dd>
</dl>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#validate_relation%21-instance_method" title="#validate_relation! (instance method)">- (Object) <strong>validate_relation!</strong>(relation) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Validates (and possibly alters) the given relation according to the options
specified at class level using the <code>relation</code> method.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="validate_relation!-instance_method">
- (<tt>Object</tt>) <strong>validate_relation!</strong>(relation)
</h3><div class="docstring">
<div class="discussion">
<p>Validates (and possibly alters) the given relation according to the options
specified at class level using the <code>relation</code> method.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/inquery/mixins/relation_validation.rb', line 56</span>
<span class='kw'>def</span> <span class='id identifier rubyid_validate_relation!'>validate_relation!</span><span class='lparen'>(</span><span class='id identifier rubyid_relation'>relation</span><span class='rparen'>)</span>
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='const'>DEFAULT_OPTIONS</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</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='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid__relation_options'>_relation_options</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span><span class='rparen'>)</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__relation_options'>_relation_options</span>
<span class='id identifier rubyid_relation_class'>relation_class</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:class</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_try'>try</span><span class='lparen'>(</span><span class='symbol'>:constantize</span><span class='rparen'>)</span>
<span class='comment'># ---------------------------------------------------------------
</span> <span class='comment'># Validate presence
</span> <span class='comment'># ---------------------------------------------------------------
</span> <span class='kw'>if</span> <span class='id identifier rubyid_relation'>relation</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:default</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_relation'>relation</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:default</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:default</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>&&</span> <span class='id identifier rubyid_relation_class'>relation_class</span>
<span class='id identifier rubyid_relation'>relation</span> <span class='op'>=</span> <span class='id identifier rubyid_relation_class'>relation_class</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>Inquery</span><span class='op'>::</span><span class='const'>Exceptions</span><span class='op'>::</span><span class='const'>InvalidRelation</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>A relation must be given for this query.</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='comment'># ---------------------------------------------------------------
</span> <span class='comment'># Validate class
</span> <span class='comment'># ---------------------------------------------------------------
</span> <span class='kw'>if</span> <span class='id identifier rubyid_relation_class'>relation_class</span> <span class='op'>&&</span> <span class='id identifier rubyid_relation_class'>relation_class</span> <span class='op'>!=</span> <span class='id identifier rubyid_relation'>relation</span><span class='period'>.</span><span class='id identifier rubyid_klass'>klass</span>
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>Inquery</span><span class='op'>::</span><span class='const'>Exceptions</span><span class='op'>::</span><span class='const'>InvalidRelation</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Unexpected relation class '</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_relation'>relation</span><span class='period'>.</span><span class='id identifier rubyid_klass'>klass</span><span class='embexpr_end'>}</span><span class='tstring_content'>' for this query, expected a '</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_relation_class'>relation_class</span><span class='embexpr_end'>}</span><span class='tstring_content'>'.</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='comment'># ---------------------------------------------------------------
</span> <span class='comment'># Validate selected fields
</span> <span class='comment'># ---------------------------------------------------------------
</span> <span class='id identifier rubyid_fields_count'>fields_count</span> <span class='op'>=</span> <span class='id identifier rubyid_relation'>relation</span><span class='period'>.</span><span class='id identifier rubyid_select_values'>select_values</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span>
<span class='kw'>if</span> <span class='id identifier rubyid_fields_count'>fields_count</span> <span class='op'>==</span> <span class='int'>0</span> <span class='op'>&&</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:default_select</span><span class='rbracket'>]</span> <span class='op'>&&</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:fields</span><span class='rbracket'>]</span> <span class='op'>&&</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:fields</span><span class='rbracket'>]</span> <span class='op'>></span> <span class='int'>0</span>
<span class='id identifier rubyid_relation'>relation</span> <span class='op'>=</span> <span class='id identifier rubyid_relation'>relation</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:default_select</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='id identifier rubyid_fields_count'>fields_count</span> <span class='op'>=</span> <span class='int'>1</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:fields</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>&&</span> <span class='id identifier rubyid_fields_count'>fields_count</span> <span class='op'>!=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:fields</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>Inquery</span><span class='op'>::</span><span class='const'>Exceptions</span><span class='op'>::</span><span class='const'>InvalidRelation</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Expected given relation to select </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:fields</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'> field(s) but got </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_fields_count'>fields_count</span><span class='embexpr_end'>}</span><span class='tstring_content'>.</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='kw'>return</span> <span class='id identifier rubyid_relation'>relation</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Thu Jun 9 10:26:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.3).
</div>
</body>
</html>