doc/Dynamoid/Fields/ClassMethods.html in dynamoid-0.6.1 vs doc/Dynamoid/Fields/ClassMethods.html in dynamoid-0.7.0

- old
+ new

@@ -4,60 +4,67 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title> Module: Dynamoid::Fields::ClassMethods - &mdash; Documentation by YARD 0.7.5 + &mdash; Documentation by YARD 0.8.6.1 </title> - <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" /> + <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" /> - <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" charset="utf-8" /> <script type="text/javascript" charset="utf-8"> - relpath = '../..'; - if (relpath != '') relpath += '/'; + hasFrames = window.top.frames.main ? true : false; + relpath = '../../'; + framesUrl = "../../frames.html#!" + escape(window.location.href); </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 (C)</a> &raquo; + <a href="../../_index.html">Index (C)</a> &raquo; <span class='title'><span class='object_link'><a href="../../Dynamoid.html" title="Dynamoid (module)">Dynamoid</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Fields.html" title="Dynamoid::Fields (module)">Fields</a></span></span> &raquo; <span class="title">ClassMethods</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 class="full_list_link" id="class_list_link" + href="../../class_list.html"> + Class List + </a> - <a id="method_list_link" href="#">Method List</a> + <a class="full_list_link" id="method_list_link" + href="../../method_list.html"> + Method List + </a> - <a id="file_list_link" href="#">File 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: Dynamoid::Fields::ClassMethods </h1> @@ -104,10 +111,11 @@ + <span class="summary_desc"><div class='inline'><p>Specify a field for a document.</p> </div></span> @@ -126,43 +134,90 @@ + <span class="summary_desc"><div class='inline'></div></span> </li> + <li class="public "> + <span class="summary_signature"> + + <a href="#remove_field-instance_method" title="#remove_field (instance method)">- (Object) <strong>remove_field</strong>(field) </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'></div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#table-instance_method" title="#table (instance method)">- (Object) <strong>table</strong>(options) </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'></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="field-instance_method"> + <h3 class="signature first" id="field-instance_method"> - (<tt>Object</tt>) <strong>field</strong>(name, type = :string, options = {}) -</p><div class="docstring"> + + +</h3><div class="docstring"> <div class="discussion"> - <p>Specify a field for a document. Its type determines how it is coerced when read in and out of the datastore: + <p>Specify a field for a document. Its type determines how it is coerced when read in and out of the datastore: default is string, but you can also specify :integer, :float, :set, :array, :datetime, and :serialized.</p> </div> </div> <div class="tags"> - <h3>Parameters:</h3> + <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>name</span> @@ -212,11 +267,11 @@ </li> </ul> -<h3>Since:</h3> +<p class="tag_title">Since:</p> <ul class="since"> <li> @@ -234,76 +289,150 @@ <tr> <td> <pre class="lines"> -30 31 32 33 34 35 36 37 -38 -39</pre> +38</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/dynamoid/fields.rb', line 30</span> + <pre class="code"><span class="info file"># File 'lib/dynamoid/fields.rb', line 31</span> <span class='kw'>def</span> <span class='id identifier rubyid_field'>field</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span> <span class='op'>=</span> <span class='symbol'>:string</span><span class='comma'>,</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_named'>named</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_attributes'>attributes</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='symbol'>:type</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_type'>type</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span> + <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_attributes'>attributes</span> <span class='op'>=</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span><span class='symbol'>:type</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_type'>type</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='id identifier rubyid_define_method'>define_method</span><span class='lparen'>(</span><span class='id identifier rubyid_named'>named</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_read_attribute'>read_attribute</span><span class='lparen'>(</span><span class='id identifier rubyid_named'>named</span><span class='rparen'>)</span> <span class='rbrace'>}</span> <span class='id identifier rubyid_define_method'>define_method</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_named'>named</span><span class='rbrace'>}</span><span class='tstring_content'>?</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='op'>!</span><span class='id identifier rubyid_read_attribute'>read_attribute</span><span class='lparen'>(</span><span class='id identifier rubyid_named'>named</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='rbrace'>}</span> <span class='id identifier rubyid_define_method'>define_method</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_named'>named</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_value'>value</span><span class='op'>|</span> <span class='id identifier rubyid_write_attribute'>write_attribute</span><span class='lparen'>(</span><span class='id identifier rubyid_named'>named</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span> <span class='rbrace'>}</span> - - <span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:define_attribute_method</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_define_attribute_method'>define_attribute_method</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id identifier rubyid_define_attribute_methods'>define_attribute_methods</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> - <p class="signature " id="range-instance_method"> + <h3 class="signature " id="range-instance_method"> - (<tt>Object</tt>) <strong>range</strong>(name, type = :string) -</p><table class="source_code"> + + +</h3><table class="source_code"> <tr> <td> <pre class="lines"> +40 41 42 -43 -44</pre> +43</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/dynamoid/fields.rb', line 41</span> + <pre class="code"><span class="info file"># File 'lib/dynamoid/fields.rb', line 40</span> <span class='kw'>def</span> <span class='id identifier rubyid_range'>range</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span> <span class='op'>=</span> <span class='symbol'>:string</span><span class='rparen'>)</span> <span class='id identifier rubyid_field'>field</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_range_key'>range_key</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> - </div> + <div class="method_details "> + <h3 class="signature " id="remove_field-instance_method"> + + - (<tt>Object</tt>) <strong>remove_field</strong>(field) + + + + +</h3><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +53 +54 +55 +56 +57 +58 +59</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/dynamoid/fields.rb', line 53</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_remove_field'>remove_field</span><span class='lparen'>(</span><span class='id identifier rubyid_field'>field</span><span class='rparen'>)</span> + <span class='id identifier rubyid_field'>field</span> <span class='op'>=</span> <span class='id identifier rubyid_field'>field</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span> + <span class='id identifier rubyid_attributes'>attributes</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_field'>field</span><span class='rparen'>)</span> <span class='kw'>or</span> <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>No such field</span><span class='tstring_end'>&quot;</span></span> + <span class='id identifier rubyid_remove_method'>remove_method</span> <span class='id identifier rubyid_field'>field</span> + <span class='id identifier rubyid_remove_method'>remove_method</span> <span class='symbol'>:#{</span><span class='id identifier rubyid_field'>field</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>&quot;</span></span> + <span class='id identifier rubyid_remove_method'>remove_method</span> <span class='symbol'>:#{</span><span class='id identifier rubyid_field'>field</span><span class='rbrace'>}</span><span class='tstring_content'>?</span><span class='tstring_end'>&quot;</span></span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> + <div class="method_details "> + <h3 class="signature " id="table-instance_method"> + + - (<tt>Object</tt>) <strong>table</strong>(options) + + + + + +</h3><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +45 +46 +47 +48 +49 +50 +51</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/dynamoid/fields.rb', line 45</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_table'>table</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span> + <span class='comment'>#a default 'id' column is created when Dynamoid::Document is included +</span> <span class='kw'>unless</span><span class='lparen'>(</span><span class='id identifier rubyid_attributes'>attributes</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span> <span class='id identifier rubyid_hash_key'>hash_key</span><span class='rparen'>)</span> + <span class='id identifier rubyid_remove_field'>remove_field</span> <span class='symbol'>:id</span> + <span class='id identifier rubyid_field'>field</span><span class='lparen'>(</span><span class='id identifier rubyid_hash_key'>hash_key</span><span class='rparen'>)</span> + <span class='kw'>end</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + <div id="footer"> - Generated on Thu Apr 26 01:26:24 2012 by + Generated on Thu Jun 27 21:59:09 2013 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.5 (ruby-1.9.3). + 0.8.6.1 (ruby-1.9.3). </div> </body> </html> \ No newline at end of file