doc/CSVDecision/Input.html in csv_decision-0.3.0 vs doc/CSVDecision/Input.html in csv_decision-0.3.1
- old
+ new
@@ -114,11 +114,11 @@
<ul class="summary">
<li class="public ">
<span class="summary_signature">
- <a href="#parse-class_method" title="parse (class method)">.<strong>parse</strong>(table:, input:, symbolize_keys:) ⇒ Hash{Symbol => Hash{Symbol=>Object}, Hash{Integer=>Object}} </a>
+ <a href="#parse-class_method" title="parse (class method)">.<strong>parse</strong>(table:, input:, symbolize_keys:) ⇒ Hash{Symbol=>Object} </a>
</span>
@@ -128,15 +128,11 @@
<span class="private note title">private</span>
- <span class="summary_desc"><div class='inline'>
-<p>Returns a hash of two hashes: * hash: either a copy with keys symbolized
-or the original input object * scan_cols: Picks out the value in the input
-hash for each table input column.</p>
-</div></span>
+ <span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
@@ -149,11 +145,11 @@
<div class="method_details first">
<h3 class="signature first" id="parse-class_method">
- .<strong>parse</strong>(table:, input:, symbolize_keys:) ⇒ <tt>Hash{Symbol => Hash{Symbol=>Object}, Hash{Integer=>Object}}</tt>
+ .<strong>parse</strong>(table:, input:, symbolize_keys:) ⇒ <tt>Hash{Symbol=>Object}</tt>
@@ -162,85 +158,107 @@
<p class="note private">
<strong>This method is part of a private API.</strong>
You should avoid using this method if possible, as it may be removed or be changed in the future.
</p>
-<p>Returns a hash of two hashes:</p>
-<ul><li>
-<p>hash: either a copy with keys symbolized or the original input object</p>
-</li><li>
-<p>scan_cols: Picks out the value in the input hash for each table input
-column. Defaults to nil if the key is missing in the input hash.</p>
-</li></ul>
-
</div>
</div>
<div class="tags">
+ <p class="tag_title">Parameters:</p>
+<ul class="param">
-<p class="tag_title">Returns:</p>
-<ul class="return">
+ <li>
+
+ <span class='name'>table</span>
+
+
+ <span class='type'>(<tt><span class='object_link'><a href="Table.html" title="CSVDecision::Table (class)">CSVDecision::Table</a></span></tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+<p>Decision table.</p>
+</div>
+
+ </li>
<li>
+ <span class='name'>input</span>
- <span class='type'>(<tt>Hash{Symbol => Hash{Symbol=>Object}, Hash{Integer=>Object}}</tt>)</span>
+ <span class='type'>(<tt>Hash</tt>)</span>
+
—
<div class='inline'>
-<p>Returns a hash of two hashes:</p>
-<ul><li>
-<p>hash: either a copy with keys symbolized or the original input object</p>
-</li><li>
-<p>scan_cols: Picks out the value in the input hash for each table input
-column. Defaults to nil if the key is missing in the input hash.</p>
-</li></ul>
+<p>Input hash (keys may or may not be symbolized)</p>
</div>
</li>
+ <li>
+
+ <span class='name'>symbolize_keys</span>
+
+
+ <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+<p>Set to false if keys are symbolized and it's OK to mutate the input
+hash. Otherwise a copy of the input hash is symbolized.</p>
+</div>
+
+ </li>
+
</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt>Hash{Symbol=>Object}</tt>)</span>
+
+
+
+ </li>
+
+</ul>
+
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
+13
+14
+15
+16
17
18
19
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
-30</pre>
+20</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/csv_decision/input.rb', line 17</span>
+ <pre class="code"><span class="info file"># File 'lib/csv_decision/input.rb', line 13</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='label'>table:</span><span class='comma'>,</span> <span class='label'>input:</span><span class='comma'>,</span> <span class='label'>symbolize_keys:</span><span class='rparen'>)</span>
<span class='id identifier rubyid_validate'>validate</span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='rparen'>)</span>
- <span class='id identifier rubyid_hash'>hash</span><span class='comma'>,</span> <span class='id identifier rubyid_scan_cols'>scan_cols</span> <span class='op'>=</span>
- <span class='id identifier rubyid_parse_input'>parse_input</span><span class='lparen'>(</span><span class='label'>table:</span> <span class='id identifier rubyid_table'>table</span><span class='comma'>,</span> <span class='label'>input:</span> <span class='id identifier rubyid_symbolize_keys'>symbolize_keys</span> <span class='op'>?</span> <span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_symbolize_keys'>symbolize_keys</span> <span class='op'>:</span> <span class='id identifier rubyid_input'>input</span><span class='rparen'>)</span>
+ <span class='id identifier rubyid_parsed_input'>parsed_input</span> <span class='op'>=</span> <span class='id identifier rubyid_parse_input'>parse_input</span><span class='lparen'>(</span><span class='label'>table:</span> <span class='id identifier rubyid_table'>table</span><span class='comma'>,</span> <span class='label'>input:</span> <span class='id identifier rubyid_symbolize_keys'>symbolize_keys</span> <span class='op'>?</span> <span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_symbolize_keys'>symbolize_keys</span> <span class='op'>:</span> <span class='id identifier rubyid_input'>input</span><span class='rparen'>)</span>
- <span class='lbrace'>{</span>
- <span class='comment'># We can freeze the input hash for safety if we made our own copy.
-</span> <span class='label'>hash:</span> <span class='id identifier rubyid_symbolize_keys'>symbolize_keys</span> <span class='op'>?</span> <span class='id identifier rubyid_hash'>hash</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span> <span class='op'>:</span> <span class='id identifier rubyid_hash'>hash</span><span class='comma'>,</span>
- <span class='label'>scan_cols:</span> <span class='id identifier rubyid_scan_cols'>scan_cols</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span><span class='comma'>,</span>
- <span class='comment'># Build the index key if this table is indexed.
-</span> <span class='label'>key:</span> <span class='id identifier rubyid_table'>table</span><span class='period'>.</span><span class='id identifier rubyid_index'>index</span> <span class='op'>?</span> <span class='id identifier rubyid_parse_key'>parse_key</span><span class='lparen'>(</span><span class='label'>table:</span> <span class='id identifier rubyid_table'>table</span><span class='comma'>,</span> <span class='label'>hash:</span> <span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='kw'>nil</span>
- <span class='rbrace'>}</span>
+ <span class='id identifier rubyid_parsed_input'>parsed_input</span><span class='lbracket'>[</span><span class='symbol'>:key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_parse_key'>parse_key</span><span class='lparen'>(</span><span class='label'>table:</span> <span class='id identifier rubyid_table'>table</span><span class='comma'>,</span> <span class='label'>hash:</span> <span class='id identifier rubyid_parsed_input'>parsed_input</span><span class='lbracket'>[</span><span class='symbol'>:hash</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_table'>table</span><span class='period'>.</span><span class='id identifier rubyid_index'>index</span>
+ <span class='id identifier rubyid_parsed_input'>parsed_input</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
@@ -248,10 +266,10 @@
</div>
</div>
<div id="footer">
- Generated on Sat Jan 20 15:44:34 2018 by
+ Generated on Sun Jan 21 08:56:46 2018 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.12 (ruby-2.4.0).
</div>
</div>
\ No newline at end of file