<!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: Dynamoid::Validations
— Documentation by YARD 0.7.5
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '..';
if (relpath != '') 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>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
<div id="header">
<div id="menu">
<a href="../_index.html">Index (V)</a> »
<span class='title'><span class='object_link'><a href="../Dynamoid.html" title="Dynamoid (module)">Dynamoid</a></span></span>
»
<span class="title">Validations</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 id="class_list_link" href="#">Class List</a>
<a id="method_list_link" href="#">Method List</a>
<a id="file_list_link" href="#">File List</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: Dynamoid::Validations
</h1>
<dl class="box">
<dt class="r1">Extended by:</dt>
<dd class="r1">ActiveSupport::Concern</dd>
<dt class="r2">Includes:</dt>
<dd class="r2">ActiveModel::Validations, ActiveModel::Validations::Callbacks</dd>
<dt class="r1">Included in:</dt>
<dd class="r1"><span class='object_link'><a href="Components.html" title="Dynamoid::Components (module)">Components</a></span></dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/dynamoid/validations.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Provide ActiveModel validations to Dynamoid documents.</p>
</div>
</div>
<div class="tags">
</div>
<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="#save-instance_method" title="#save (instance method)">- (Object) <strong>save</strong>(options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Override save to provide validation support.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#save%21-instance_method" title="#save! (instance method)">- (Object) <strong>save!</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Raise an error unless this object is valid.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#valid%3F-instance_method" title="#valid? (instance method)">- (Boolean) <strong>valid?</strong>(context = nil) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Is this object valid?.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<p class="signature first" id="save-instance_method">
- (<tt>Object</tt>) <strong>save</strong>(options = {})
</p><div class="docstring">
<div class="discussion">
<p>Override save to provide validation support.</p>
</div>
</div>
<div class="tags">
<h3>Since:</h3>
<ul class="since">
<li>
<div class='inline'><p>0.2.0</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
14
15
16
17
18</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/dynamoid/validations.rb', line 14</span>
<span class='kw'>def</span> <span class='id identifier rubyid_save'>save</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_reverse_merge!'>reverse_merge!</span><span class='lparen'>(</span><span class='symbol'>:validate</span> <span class='op'>=></span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:validate</span><span class='rbracket'>]</span> <span class='kw'>and</span> <span class='lparen'>(</span><span class='kw'>not</span> <span class='id identifier rubyid_valid?'>valid?</span><span class='rparen'>)</span>
<span class='kw'>super</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="save!-instance_method">
- (<tt>Object</tt>) <strong>save!</strong>
</p><div class="docstring">
<div class="discussion">
<p>Raise an error unless this object is valid.</p>
</div>
</div>
<div class="tags">
<h3>Raises:</h3>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Errors/DocumentNotValid.html" title="Dynamoid::Errors::DocumentNotValid (class)">Dynamoid::Errors::DocumentNotValid</a></span></tt>)</span>
</li>
</ul>
<h3>Since:</h3>
<ul class="since">
<li>
<div class='inline'><p>0.2.0</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
31
32
33
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/dynamoid/validations.rb', line 31</span>
<span class='kw'>def</span> <span class='id identifier rubyid_save!'>save!</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>Dynamoid</span><span class='op'>::</span><span class='const'>Errors</span><span class='op'>::</span><span class='const'>DocumentNotValid</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_valid?'>valid?</span>
<span class='id identifier rubyid_save'>save</span><span class='lparen'>(</span><span class='symbol'>:validate</span> <span class='op'>=></span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="valid?-instance_method">
- (<tt>Boolean</tt>) <strong>valid?</strong>(context = nil)
</p><div class="docstring">
<div class="discussion">
<p>Is this object valid?</p>
</div>
</div>
<div class="tags">
<h3>Returns:</h3>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
<h3>Since:</h3>
<ul class="since">
<li>
<div class='inline'><p>0.2.0</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
23
24
25
26</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/dynamoid/validations.rb', line 23</span>
<span class='kw'>def</span> <span class='id identifier rubyid_valid?'>valid?</span><span class='lparen'>(</span><span class='id identifier rubyid_context'>context</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_context'>context</span> <span class='op'>||=</span> <span class='lparen'>(</span><span class='id identifier rubyid_new_record?'>new_record?</span> <span class='op'>?</span> <span class='symbol'>:create</span> <span class='op'>:</span> <span class='symbol'>:update</span><span class='rparen'>)</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_context'>context</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Mar 27 17:53:06 2012 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.7.5 (ruby-1.9.3).
</div>
</body>
</html>