doc/CSVDecision/Validate.html in csv_decision2-0.5.1 vs doc/CSVDecision/Validate.html in csv_decision2-0.5.2
- old
+ new
@@ -1,262 +1,274 @@
<!DOCTYPE html>
<html>
- <head>
- <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
- Module: CSVDecision::Validate
-
+
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <title>
+ Module: CSVDecision2::Validate
+
— Documentation by YARD 0.9.12
-
-</title>
+ </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">
- pathId = "CSVDecision::Validate";
- relpath = '../';
-</script>
+ <script type="text/javascript" charset="utf-8">
+ pathId = "CSVDecision2::Validate";
+ 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>
- <div class="nav_wrap">
- <iframe id="nav" src="../class_list.html?1"></iframe>
- <div id="resizer"></div>
- </div>
+</head>
- <div id="main" tabindex="-1">
- <div id="header">
- <div id="menu">
-
- <a href="../_index.html">Index (V)</a> »
- <span class='title'><span class='object_link'><a href="../CSVDecision.html" title="CSVDecision (module)">CSVDecision</a></span></span>
- »
- <span class="title">Validate</span>
-
-</div>
+<body>
+ <div class="nav_wrap">
+ <iframe id="nav" src="../class_list.html?1"></iframe>
+ <div id="resizer"></div>
+ </div>
- <div id="search">
-
- <a class="full_list_link" id="class_list_link"
- href="../class_list.html">
+ <div id="main" tabindex="-1">
+ <div id="header">
+ <div id="menu">
- <svg width="24" height="24">
- <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
- <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
- <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
- </svg>
- </a>
-
-</div>
- <div class="clear"></div>
+ <a href="../_index.html">Index (V)</a> »
+ <span class='title'><span class='object_link'><a href="../CSVDecision2.html"
+ title="CSVDecision (module)">CSVDecision</a></span></span>
+ »
+ <span class="title">Validate</span>
+
</div>
- <div id="content"><h1>Module: CSVDecision::Validate
-
-
- <span class="private note title">Private</span>
-</h1>
-<div class="box_info">
-
+ <div id="search">
-
-
-
-
-
+ <a class="full_list_link" id="class_list_link" href="../class_list.html">
-
+ <svg width="24" height="24">
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+ </svg>
+ </a>
-
- <dl>
- <dt>Defined in:</dt>
- <dd>lib/csv_decision/validate.rb</dd>
- </dl>
-
-</div>
+ </div>
+ <div class="clear"></div>
+ </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>
+ <div id="content">
+ <h1>Module: CSVDecision2::Validate
-<p>Parse and validate the column names in the header row. These methods are
-only required at table load time.</p>
+ <span class="private note title">Private</span>
+ </h1>
+ <div class="box_info">
- </div>
-</div>
-<div class="tags">
-
-</div>
-
- <h2>
- Class Method Summary
- <small><a href="#" class="summary_toggle">collapse</a></small>
- </h2>
- <ul class="summary">
-
+
+
+ <dl>
+ <dt>Defined in:</dt>
+ <dd>lib/csv_decision2/validate.rb</dd>
+ </dl>
+
+ </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 and validate the column names in the header row. These methods are
+ only required at table load time.</p>
+
+
+ </div>
+ </div>
+ <div class="tags">
+
+
+ </div>
+
+
+
+
+
+
+
+ <h2>
+ Class Method Summary
+ <small><a href="#" class="summary_toggle">collapse</a></small>
+ </h2>
+
+ <ul class="summary">
+
<li class="public ">
- <span class="summary_signature">
-
- <a href="#column-class_method" title="column (class method)">.<strong>column</strong>(cell:, index:) ⇒ Array<(Symbol, Symbol)> </a>
-
+ <span class="summary_signature">
-
- </span>
-
-
-
-
-
-
- <span class="private note title">private</span>
+ <a href="#column-class_method" title="column (class method)">.<strong>column</strong>(cell:, index:)
+ ⇒ Array<(Symbol, Symbol)> </a>
-
- <span class="summary_desc"><div class='inline'>
-<p>Validate a column header cell and return its type and name.</p>
-</div></span>
-
-</li>
-
+
+ </span>
+
+
+
+
+
+
+ <span class="private note title">private</span>
+
+
+ <span class="summary_desc">
+ <div class='inline'>
+ <p>Validate a column header cell and return its type and name.</p>
+ </div>
+ </span>
+
+ </li>
+
+
<li class="public ">
- <span class="summary_signature">
-
- <a href="#name-class_method" title="name (class method)">.<strong>name</strong>(columns:, name:, out:) ⇒ void </a>
-
+ <span class="summary_signature">
-
- </span>
-
-
-
-
-
-
- <span class="private note title">private</span>
+ <a href="#name-class_method" title="name (class method)">.<strong>name</strong>(columns:, name:, out:)
+ ⇒ void </a>
-
- <span class="summary_desc"><div class='inline'>
-<p>Validate the column name against the dictionary of column names.</p>
-</div></span>
-
-</li>
-
- </ul>
-
+ </span>
- <div id="class_method_details" class="method_details_list">
- <h2>Class Method Details</h2>
-
- <div class="method_details first">
- <h3 class="signature first" id="column-class_method">
-
- .<strong>column</strong>(cell:, index:) ⇒ <tt>Array<(Symbol, Symbol)></tt>
-
-
-
-</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>Validate a column header cell and return its type and name.</p>
+ <span class="private note title">private</span>
- </div>
-</div>
-<div class="tags">
- <p class="tag_title">Parameters:</p>
-<ul class="param">
-
- <li>
-
- <span class='name'>cell</span>
-
-
- <span class='type'>(<tt>String</tt>)</span>
-
-
-
- —
- <div class='inline'>
-<p>Header cell.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>index</span>
-
-
- <span class='type'>(<tt>Integer</tt>)</span>
-
-
-
- —
- <div class='inline'>
-<p>The header column's index.</p>
-</div>
-
- </li>
-
-</ul>
+ <span class="summary_desc">
+ <div class='inline'>
+ <p>Validate the column name against the dictionary of column names.</p>
+ </div>
+ </span>
-<p class="tag_title">Returns:</p>
-<ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt>Array<(Symbol, Symbol)></tt>)</span>
-
-
-
- —
- <div class='inline'>
-<p>Column type and column name symbols.</p>
-</div>
-
- </li>
-
-</ul>
+ </li>
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
+ </ul>
+
+
+
+ <div id="class_method_details" class="method_details_list">
+ <h2>Class Method Details</h2>
+
+
+ <div class="method_details first">
+ <h3 class="signature first" id="column-class_method">
+
+ .<strong>column</strong>(cell:, index:) ⇒ <tt>Array<(Symbol, Symbol)></tt>
+
+
+
+
+
+ </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>Validate a column header cell and return its type and name.</p>
+
+
+ </div>
+ </div>
+ <div class="tags">
+ <p class="tag_title">Parameters:</p>
+ <ul class="param">
+
+ <li>
+
+ <span class='name'>cell</span>
+
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+ <p>Header cell.</p>
+ </div>
+
+ </li>
+
+ <li>
+
+ <span class='name'>index</span>
+
+
+ <span class='type'>(<tt>Integer</tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+ <p>The header column's index.</p>
+ </div>
+
+ </li>
+
+ </ul>
+
+ <p class="tag_title">Returns:</p>
+ <ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt>Array<(Symbol, Symbol)></tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+ <p>Column type and column name symbols.</p>
+ </div>
+
+ </li>
+
+ </ul>
+
+ </div>
+ <table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
21
22
23
24
25
@@ -264,159 +276,163 @@
27
28
29
30
31</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/csv_decision/validate.rb', line 21</span>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/csv_decision2/validate.rb', line 21</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_column'>column</span><span class='lparen'>(</span><span class='label'>cell:</span><span class='comma'>,</span> <span class='label'>index:</span><span class='rparen'>)</span>
- <span class='id identifier rubyid_match'>match</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Header.html" title="CSVDecision::Header (module)">Header</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Header.html#COLUMN_TYPE-constant" title="CSVDecision::Header::COLUMN_TYPE (constant)">COLUMN_TYPE</a></span></span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='id identifier rubyid_cell'>cell</span><span class='rparen'>)</span>
- <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="CellValidationError.html" title="CSVDecision::CellValidationError (class)">CellValidationError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>column name is not well formed</span><span class='tstring_end'>'</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_match'>match</span>
+ <span class='id identifier rubyid_match'>match</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Header.html" title="CSVDecision2::Header (module)">Header</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Header.html#COLUMN_TYPE-constant" title="CSVDecision2::Header::COLUMN_TYPE (constant)">COLUMN_TYPE</a></span></span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='id identifier rubyid_cell'>cell</span><span class='rparen'>)</span>
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="CellValidationError.html" title="CSVDecision2::CellValidationError (class)">CellValidationError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>column name is not well formed</span><span class='tstring_end'>'</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_match'>match</span>
<span class='id identifier rubyid_column_type'>column_type</span> <span class='op'>=</span> <span class='id identifier rubyid_match'>match</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>type</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='op'>&.</span><span class='id identifier rubyid_downcase'>downcase</span><span class='op'>&.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
<span class='id identifier rubyid_column_name'>column_name</span> <span class='op'>=</span> <span class='id identifier rubyid_column_name'>column_name</span><span class='lparen'>(</span><span class='label'>type:</span> <span class='id identifier rubyid_column_type'>column_type</span><span class='comma'>,</span> <span class='label'>name:</span> <span class='id identifier rubyid_match'>match</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>name</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>index:</span> <span class='id identifier rubyid_index'>index</span><span class='rparen'>)</span>
<span class='lbracket'>[</span><span class='id identifier rubyid_column_type'>column_type</span><span class='comma'>,</span> <span class='id identifier rubyid_column_name'>column_name</span><span class='rbracket'>]</span>
-<span class='kw'>rescue</span> <span class='const'><span class='object_link'><a href="CellValidationError.html" title="CSVDecision::CellValidationError (class)">CellValidationError</a></span></span> <span class='op'>=></span> <span class='id identifier rubyid_exp'>exp</span>
- <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="CellValidationError.html" title="CSVDecision::CellValidationError (class)">CellValidationError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>header column '</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_cell'>cell</span><span class='embexpr_end'>}</span><span class='tstring_content'>' is not valid as the </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_exp'>exp</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
+<span class='kw'>rescue</span> <span class='const'><span class='object_link'><a href="CellValidationError.html" title="CSVDecision2::CellValidationError (class)">CellValidationError</a></span></span> <span class='op'>=></span> <span class='id identifier rubyid_exp'>exp</span>
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="CellValidationError.html" title="CSVDecision2::CellValidationError (class)">CellValidationError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>header column '</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_cell'>cell</span><span class='embexpr_end'>}</span><span class='tstring_content'>' is not valid as the </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_exp'>exp</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- <div class="method_details ">
- <h3 class="signature " id="name-class_method">
-
- .<strong>name</strong>(columns:, name:, out:) ⇒ <tt>void</tt>
-
+ </td>
+ </tr>
+ </table>
+ </div>
-
+ <div class="method_details ">
+ <h3 class="signature " id="name-class_method">
-
-</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 class="note returns_void">This method returns an undefined value.</p>
-<p>Validate the column name against the dictionary of column names.</p>
+ .<strong>name</strong>(columns:, name:, out:) ⇒ <tt>void</tt>
- </div>
-</div>
-<div class="tags">
- <p class="tag_title">Parameters:</p>
-<ul class="param">
-
- <li>
-
- <span class='name'>columns</span>
-
-
- <span class='type'>(<tt>Symbol=>[false, Integer]</tt>)</span>
-
-
-
- —
- <div class='inline'>
-<p>Column name dictionary.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>name</span>
-
-
- <span class='type'>(<tt>Symbol</tt>)</span>
-
-
-
- —
- <div class='inline'>
-<p>Column name.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>out</span>
-
-
- <span class='type'>(<tt>false</tt>, <tt>Integer</tt>)</span>
-
-
-
- —
- <div class='inline'>
-<p>False if an input column, otherwise the column index of the output column.</p>
-</div>
-
- </li>
-
-</ul>
-<p class="tag_title">Raises:</p>
-<ul class="raise">
-
- <li>
-
-
- <span class='type'>(<tt><span class='object_link'><a href="CellValidationError.html" title="CSVDecision::CellValidationError (class)">CellValidationError</a></span></tt>)</span>
-
-
-
- —
- <div class='inline'>
-<p>Column name invalid.</p>
-</div>
-
- </li>
-
-</ul>
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
+ </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 class="note returns_void">This method returns an undefined value.</p>
+ <p>Validate the column name against the dictionary of column names.</p>
+
+ </div>
+ </div>
+ <div class="tags">
+ <p class="tag_title">Parameters:</p>
+ <ul class="param">
+
+ <li>
+
+ <span class='name'>columns</span>
+
+
+ <span class='type'>(<tt>Symbol=>[false, Integer]</tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+ <p>Column name dictionary.</p>
+ </div>
+
+ </li>
+
+ <li>
+
+ <span class='name'>name</span>
+
+
+ <span class='type'>(<tt>Symbol</tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+ <p>Column name.</p>
+ </div>
+
+ </li>
+
+ <li>
+
+ <span class='name'>out</span>
+
+
+ <span class='type'>(<tt>false</tt>, <tt>Integer</tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+ <p>False if an input column, otherwise the column index of the output column.</p>
+ </div>
+
+ </li>
+
+ </ul>
+
+ <p class="tag_title">Raises:</p>
+ <ul class="raise">
+
+ <li>
+
+
+ <span class='type'>(<tt><span class='object_link'><a href="CellValidationError.html"
+ title="CSVDecision2::CellValidationError (class)">CellValidationError</a></span></tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+ <p>Column name invalid.</p>
+ </div>
+
+ </li>
+
+ </ul>
+
+ </div>
+ <table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
41
42
43
44
45
46</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/csv_decision/validate.rb', line 41</span>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/csv_decision2/validate.rb', line 41</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='lparen'>(</span><span class='label'>columns:</span><span class='comma'>,</span> <span class='label'>name:</span><span class='comma'>,</span> <span class='label'>out:</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='lparen'>(</span><span class='id identifier rubyid_in_out'>in_out</span> <span class='op'>=</span> <span class='id identifier rubyid_columns'>columns</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='id identifier rubyid_validate_out_name'>validate_out_name</span><span class='lparen'>(</span><span class='label'>in_out:</span> <span class='id identifier rubyid_in_out'>in_out</span><span class='comma'>,</span> <span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_out'>out</span>
<span class='id identifier rubyid_validate_in_name'>validate_in_name</span><span class='lparen'>(</span><span class='label'>in_out:</span> <span class='id identifier rubyid_in_out'>in_out</span><span class='comma'>,</span> <span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- </div>
+ </td>
+ </tr>
+ </table>
+ </div>
-</div>
+ </div>
- <div id="footer">
- Generated on Sun Feb 11 10:26:07 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>
+ <div id="footer">
+ Generated on Sun Feb 11 10:26:07 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>
- </body>
-</html>
\ No newline at end of file
+
+ </div>
+</body>
+
+</html>