doc/CSVDecision/Header.html in csv_decision-0.0.6 vs doc/CSVDecision/Header.html in csv_decision-0.0.7

- old
+ new

@@ -60,11 +60,11 @@ </div> <div id="content"><h1>Module: CSVDecision::Header - + <span class="private note title">Private</span> </h1> <div class="box_info"> @@ -83,11 +83,15 @@ </div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> - + <p class="note private"> + <strong>This module is part of a private API.</strong> + You should avoid using this module if possible, as it may be removed or be changed in the future. +</p> + <p>Parse the CSV file&#39;s header row. These methods are only required at table load time.</p> </div> @@ -100,30 +104,38 @@ <dl class="constants"> <dt id="COLUMN_TYPE-constant" class="">COLUMN_TYPE = <div class="docstring"> <div class="discussion"> - -<p>Column types recognise din the header row.</p> + <p class="note private"> + <strong>This constant is part of a private API.</strong> + You should avoid using this constant if possible, as it may be removed or be changed in the future. +</p> +<p>Column types recognised in the header row.</p> + </div> </div> <div class="tags"> </div> </dt> <dd><pre class="code"><span class='tstring'><span class='regexp_beg'>%r{</span><span class='tstring_content'> - \A(?&lt;type&gt;in|out|in/text|out/text) + \A(?&lt;type&gt;in|out|in/text|out/text|guard) \s*:\s*(?&lt;name&gt;\S?.*)\z </span><span class='regexp_end'>}xi</span></span></pre></dd> <dt id="COLUMN_NAME-constant" class="">COLUMN_NAME = <div class="docstring"> <div class="discussion"> - + <p class="note private"> + <strong>This constant is part of a private API.</strong> + You should avoid using this constant if possible, as it may be removed or be changed in the future. +</p> + <p>Regular expression string for a column name. More lenient than a Ruby method name - note any spaces will have been replaced with underscores.</p> </div> @@ -133,26 +145,10 @@ </div> </dt> <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\\w[\\w:/!?]*</span><span class='tstring_end'>&quot;</span></span></pre></dd> - <dt id="COLUMN_NAME_RE-constant" class="">COLUMN_NAME_RE = - <div class="docstring"> - <div class="discussion"> - -<p>Column name regular expression.</p> - - - </div> -</div> -<div class="tags"> - - -</div> - </dt> - <dd><pre class="code"><span class='const'><span class='object_link'><a href="Matchers.html" title="CSVDecision::Matchers (class)">Matchers</a></span></span><span class='period'>.</span><span class='id identifier rubyid_regexp'><span class='object_link'><a href="Matchers.html#regexp-class_method" title="CSVDecision::Matchers.regexp (method)">regexp</a></span></span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#COLUMN_NAME-constant" title="CSVDecision::Header::COLUMN_NAME (constant)">COLUMN_NAME</a></span></span><span class='rparen'>)</span></pre></dd> - </dl> @@ -179,11 +175,11 @@ - + <span class="private note title">private</span> <span class="summary_desc"><div class='inline'> <p>Classify and build a dictionary of all input and output columns.</p> </div></span> @@ -203,11 +199,11 @@ - + <span class="private note title">private</span> <span class="summary_desc"><div class='inline'> <p>Check if the given row contains a recognisable header cell.</p> </div></span> @@ -227,11 +223,11 @@ - + <span class="private note title">private</span> <span class="summary_desc"><div class='inline'> <p>Strip empty columns from all data rows.</p> </div></span> @@ -257,11 +253,15 @@ </h3><div class="docstring"> <div class="discussion"> - + <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>Classify and build a dictionary of all input and output columns.</p> </div> </div> @@ -310,31 +310,31 @@ <tr> <td> <pre class="lines"> -57 -58 -59 -60 -61 -62 63 64 -65</pre> +65 +66 +67 +68 +69 +70 +71</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/csv_decision/header.rb', line 57</span> + <pre class="code"><span class="info file"># File 'lib/csv_decision/header.rb', line 63</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_dictionary'>dictionary</span><span class='lparen'>(</span><span class='label'>row:</span><span class='rparen'>)</span> <span class='id identifier rubyid_dictionary'>dictionary</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Columns.html" title="CSVDecision::Columns (class)">Columns</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Columns/Dictionary.html" title="CSVDecision::Columns::Dictionary (class)">Dictionary</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Columns/Dictionary.html#initialize-instance_method" title="CSVDecision::Columns::Dictionary#initialize (method)">new</a></span></span> <span class='id identifier rubyid_row'>row</span><span class='period'>.</span><span class='id identifier rubyid_each_with_index'>each_with_index</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_cell'>cell</span><span class='comma'>,</span> <span class='id identifier rubyid_index'>index</span><span class='op'>|</span> <span class='id identifier rubyid_dictionary'>dictionary</span> <span class='op'>=</span> <span class='id identifier rubyid_parse_cell'>parse_cell</span><span class='lparen'>(</span><span class='label'>cell:</span> <span class='id identifier rubyid_cell'>cell</span><span class='comma'>,</span> <span class='label'>index:</span> <span class='id identifier rubyid_index'>index</span><span class='comma'>,</span> <span class='label'>dictionary:</span> <span class='id identifier rubyid_dictionary'>dictionary</span><span class='rparen'>)</span> <span class='kw'>end</span> - <span class='id identifier rubyid_dictionary'>dictionary</span> + <span class='id identifier rubyid_validate'>validate</span><span class='lparen'>(</span><span class='label'>dictionary:</span> <span class='id identifier rubyid_dictionary'>dictionary</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> @@ -348,11 +348,15 @@ </h3><div class="docstring"> <div class="discussion"> - + <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>Check if the given row contains a recognisable header cell.</p> </div> </div> @@ -401,16 +405,16 @@ <tr> <td> <pre class="lines"> -36 -37 -38</pre> +42 +43 +44</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/csv_decision/header.rb', line 36</span> + <pre class="code"><span class="info file"># File 'lib/csv_decision/header.rb', line 42</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_row?'>row?</span><span class='lparen'>(</span><span class='id identifier rubyid_row'>row</span><span class='rparen'>)</span> <span class='id identifier rubyid_row'>row</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_cell'>cell</span><span class='op'>|</span> <span class='id identifier rubyid_cell'>cell</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#COLUMN_TYPE-constant" title="CSVDecision::Header::COLUMN_TYPE (constant)">COLUMN_TYPE</a></span></span><span class='rparen'>)</span> <span class='rbrace'>}</span> <span class='kw'>end</span></pre> </td> @@ -427,11 +431,15 @@ </h3><div class="docstring"> <div class="discussion"> - + <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>Strip empty columns from all data rows.</p> </div> </div> @@ -480,20 +488,20 @@ <tr> <td> <pre class="lines"> -45 -46 -47 -48 -49 -50 -51</pre> +51 +52 +53 +54 +55 +56 +57</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/csv_decision/header.rb', line 45</span> + <pre class="code"><span class="info file"># File 'lib/csv_decision/header.rb', line 51</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_strip_empty_columns'>strip_empty_columns</span><span class='lparen'>(</span><span class='label'>rows:</span><span class='rparen'>)</span> <span class='id identifier rubyid_empty_cols'>empty_cols</span> <span class='op'>=</span> <span class='id identifier rubyid_empty_columns?'>empty_columns?</span><span class='lparen'>(</span><span class='label'>row:</span> <span class='id identifier rubyid_rows'>rows</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='rparen'>)</span> <span class='const'><span class='object_link'><a href="Data.html" title="CSVDecision::Data (module)">Data</a></span></span><span class='period'>.</span><span class='id identifier rubyid_strip_columns'><span class='object_link'><a href="Data.html#strip_columns-class_method" title="CSVDecision::Data.strip_columns (method)">strip_columns</a></span></span><span class='lparen'>(</span><span class='label'>data:</span> <span class='id identifier rubyid_rows'>rows</span><span class='comma'>,</span> <span class='label'>empty_columns:</span> <span class='id identifier rubyid_empty_cols'>empty_cols</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_empty_cols'>empty_cols</span> @@ -508,10 +516,10 @@ </div> </div> <div id="footer"> - Generated on Tue Dec 26 21:20:19 2017 by + Generated on Sat Dec 30 13:04:04 2017 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.12 (ruby-2.3.0). </div> </div> \ No newline at end of file