doc/CSVDecision/Header.html in csv_decision2-0.5.1 vs doc/CSVDecision/Header.html in csv_decision2-0.5.2
- old
+ new
@@ -1,432 +1,461 @@
<!DOCTYPE html>
<html>
- <head>
- <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
- Module: CSVDecision::Header
-
+
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <title>
+ Module: CSVDecision2::Header
+
— 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::Header";
- relpath = '../';
-</script>
+ <script type="text/javascript" charset="utf-8">
+ pathId = "CSVDecision2::Header";
+ 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 (H)</a> »
- <span class='title'><span class='object_link'><a href="../CSVDecision.html" title="CSVDecision (module)">CSVDecision</a></span></span>
- »
- <span class="title">Header</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 (H)</a> »
+ <span class='title'><span class='object_link'><a href="../CSVDecision2.html"
+ title="CSVDecision (module)">CSVDecision</a></span></span>
+ »
+ <span class="title">Header</span>
+
</div>
- <div id="content"><h1>Module: CSVDecision::Header
-
-
- <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/header.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::Header
-<p>Parse the CSV file's 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>Constant Summary</h2>
- <dl class="constants">
-
- <dt id="COLUMN_TYPE-constant" class="">COLUMN_TYPE =
- <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>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'>
+
+
+
+
+
+ <dl>
+ <dt>Defined in:</dt>
+ <dd>lib/csv_decision2/header.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 the CSV file's header row. These methods are only required at
+ table load time.</p>
+
+
+ </div>
+ </div>
+ <div class="tags">
+
+
+ </div>
+ <h2>Constant Summary</h2>
+ <dl class="constants">
+
+ <dt id="COLUMN_TYPE-constant" class="">COLUMN_TYPE =
+ <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>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(?<type>in/text|in|out/text|out|guard|if|set/nil\?|set/blank\?|set|path)
\s*:\s*(?<name>\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>
+</span><span class='regexp_end'>}xi</span></span></pre>
+ </dd>
-<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>
+ <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>
-</div>
-<div class="tags">
-
-</div>
- </dt>
- <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\w[\\w:/!?]*</span><span class='tstring_end'>"</span></span></pre></dd>
-
- </dl>
+ </div>
+ </div>
+ <div class="tags">
+ </div>
+ </dt>
+ <dd>
+ <pre
+ class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\w[\\w:/!?]*</span><span class='tstring_end'>"</span></span></pre>
+ </dd>
+ </dl>
-
- <h2>
- Class Method Summary
- <small><a href="#" class="summary_toggle">collapse</a></small>
- </h2>
- <ul class="summary">
-
+
+
+
+ <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_name%3F-class_method" title="column_name? (class method)">.<strong>column_name?</strong>(column_name) ⇒ Boolean </a>
-
+ <span class="summary_signature">
-
- </span>
-
-
-
-
-
-
- <span class="private note title">private</span>
+ <a href="#column_name%3F-class_method"
+ title="column_name? (class method)">.<strong>column_name?</strong>(column_name) ⇒ Boolean </a>
-
- <span class="summary_desc"><div class='inline'>
-<p>Return true if column name is valid.</p>
-</div></span>
-
-</li>
-
+
+ </span>
+
+
+
+
+
+
+ <span class="private note title">private</span>
+
+
+ <span class="summary_desc">
+ <div class='inline'>
+ <p>Return true if column name is valid.</p>
+ </div>
+ </span>
+
+ </li>
+
+
<li class="public ">
- <span class="summary_signature">
-
- <a href="#parse-class_method" title="parse (class method)">.<strong>parse</strong>(table:, matchers:) ⇒ CSVDecision::Columns </a>
-
+ <span class="summary_signature">
-
- </span>
-
-
-
-
-
-
- <span class="private note title">private</span>
+ <a href="#parse-class_method" title="parse (class method)">.<strong>parse</strong>(table:, matchers:)
+ ⇒ CSVDecision2::Columns </a>
-
- <span class="summary_desc"><div class='inline'>
-<p>Parse the header row, and the defaults row if present.</p>
-</div></span>
-
-</li>
-
+
+ </span>
+
+
+
+
+
+
+ <span class="private note title">private</span>
+
+
+ <span class="summary_desc">
+ <div class='inline'>
+ <p>Parse the header row, and the defaults row if present.</p>
+ </div>
+ </span>
+
+ </li>
+
+
<li class="public ">
- <span class="summary_signature">
-
- <a href="#row%3F-class_method" title="row? (class method)">.<strong>row?</strong>(row) ⇒ Boolean </a>
-
+ <span class="summary_signature">
-
- </span>
-
-
-
-
-
-
- <span class="private note title">private</span>
+ <a href="#row%3F-class_method" title="row? (class method)">.<strong>row?</strong>(row) ⇒ Boolean </a>
-
- <span class="summary_desc"><div class='inline'>
-<p>Check if the given row contains a recognisable header cell.</p>
-</div></span>
-
-</li>
-
+
+ </span>
+
+
+
+
+
+
+ <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>
+
+ </li>
+
+
<li class="public ">
- <span class="summary_signature">
-
- <a href="#strip_empty_columns-class_method" title="strip_empty_columns (class method)">.<strong>strip_empty_columns</strong>(rows:) ⇒ Array<Array<String>> </a>
-
+ <span class="summary_signature">
-
- </span>
-
-
-
-
-
-
- <span class="private note title">private</span>
+ <a href="#strip_empty_columns-class_method"
+ title="strip_empty_columns (class method)">.<strong>strip_empty_columns</strong>(rows:) ⇒
+ Array<Array<String>> </a>
-
- <span class="summary_desc"><div class='inline'>
-<p>Strip empty columns from all data rows.</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_name?-class_method">
-
- .<strong>column_name?</strong>(column_name) ⇒ <tt>Boolean</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>Return true if column name is valid.</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'>column_name</span>
-
-
- <span class='type'>(<tt>String</tt>)</span>
-
-
-
- </li>
-
-</ul>
+ <span class="summary_desc">
+ <div class='inline'>
+ <p>Strip empty columns from all data rows.</p>
+ </div>
+ </span>
-<p class="tag_title">Returns:</p>
-<ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
-
- </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_name?-class_method">
+
+ .<strong>column_name?</strong>(column_name) ⇒ <tt>Boolean</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>Return true if column name is valid.</p>
+
+
+ </div>
+ </div>
+ <div class="tags">
+ <p class="tag_title">Parameters:</p>
+ <ul class="param">
+
+ <li>
+
+ <span class='name'>column_name</span>
+
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+
+
+ </li>
+
+ </ul>
+
+ <p class="tag_title">Returns:</p>
+ <ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt>Boolean</tt>)</span>
+
+
+
+ </li>
+
+ </ul>
+
+ </div>
+ <table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
30
31
32</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/csv_decision/header.rb', line 30</span>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/csv_decision2/header.rb', line 30</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_column_name?'>column_name?</span><span class='lparen'>(</span><span class='id identifier rubyid_column_name'>column_name</span><span class='rparen'>)</span>
<span class='const'>COLUMN_NAME_RE</span><span class='period'>.</span><span class='id identifier rubyid_match?'>match?</span><span class='lparen'>(</span><span class='id identifier rubyid_column_name'>column_name</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- <div class="method_details ">
- <h3 class="signature " id="parse-class_method">
-
- .<strong>parse</strong>(table:, matchers:) ⇒ <tt><span class='object_link'><a href="Columns.html" title="CSVDecision::Columns (class)">CSVDecision::Columns</a></span></tt>
-
+ </td>
+ </tr>
+ </table>
+ </div>
-
+ <div class="method_details ">
+ <h3 class="signature " id="parse-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>
+ .<strong>parse</strong>(table:, matchers:) ⇒ <tt><span class='object_link'><a href="Columns.html"
+ title="CSVDecision2::Columns (class)">CSVDecision2::Columns</a></span></tt>
-<p>Parse the header row, and the defaults row if present.</p>
- </div>
-</div>
-<div class="tags">
- <p class="tag_title">Parameters:</p>
-<ul class="param">
-
- <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 being parsed.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>matchers</span>
-
-
- <span class='type'>(<tt>Array<<span class='object_link'><a href="Matchers/Matcher.html" title="CSVDecision::Matchers::Matcher (class)">Matchers::Matcher</a></span>></tt>)</span>
-
-
-
- —
- <div class='inline'>
-<p>Array of special cell matchers.</p>
-</div>
-
- </li>
-
-</ul>
-<p class="tag_title">Returns:</p>
-<ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt><span class='object_link'><a href="Columns.html" title="CSVDecision::Columns (class)">CSVDecision::Columns</a></span></tt>)</span>
-
-
-
- —
- <div class='inline'>
-<p>Table columns object.</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>Parse the header row, and the defaults row if present.</p>
+
+ </div>
+ </div>
+ <div class="tags">
+ <p class="tag_title">Parameters:</p>
+ <ul class="param">
+
+ <li>
+
+ <span class='name'>table</span>
+
+
+ <span class='type'>(<tt><span class='object_link'><a href="Table.html"
+ title="CSVDecision2::Table (class)">CSVDecision2::Table</a></span></tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+ <p>Decision table being parsed.</p>
+ </div>
+
+ </li>
+
+ <li>
+
+ <span class='name'>matchers</span>
+
+
+ <span class='type'>(<tt>Array<<span class='object_link'><a href="Matchers/Matcher.html"
+ title="CSVDecision2::Matchers::Matcher (class)">Matchers::Matcher</a></span>></tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+ <p>Array of special cell matchers.</p>
+ </div>
+
+ </li>
+
+ </ul>
+
+ <p class="tag_title">Returns:</p>
+ <ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt><span class='object_link'><a href="Columns.html"
+ title="CSVDecision2::Columns (class)">CSVDecision2::Columns</a></span></tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+ <p>Table columns object.</p>
+ </div>
+
+ </li>
+
+ </ul>
+
+ </div>
+ <table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
59
60
61
62
63
@@ -435,213 +464,218 @@
66
67
68
69
70</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/csv_decision/header.rb', line 59</span>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/csv_decision2/header.rb', line 59</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'>matchers:</span><span class='rparen'>)</span>
<span class='comment'># Parse the header row
-</span> <span class='id identifier rubyid_table'>table</span><span class='period'>.</span><span class='id identifier rubyid_columns'>columns</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../CSVDecision.html" title="CSVDecision (module)">CSVDecision</a></span></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='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Columns.html#initialize-instance_method" title="CSVDecision::Columns#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_table'>table</span><span class='rparen'>)</span>
+</span> <span class='id identifier rubyid_table'>table</span><span class='period'>.</span><span class='id identifier rubyid_columns'>columns</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../CSVDecision2.html" title="CSVDecision (module)">CSVDecision</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Columns.html" title="CSVDecision2::Columns (class)">Columns</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Columns.html#initialize-instance_method" title="CSVDecision2::Columns#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_table'>table</span><span class='rparen'>)</span>
<span class='comment'># Parse the defaults row if present
</span> <span class='kw'>return</span> <span class='id identifier rubyid_table'>table</span><span class='period'>.</span><span class='id identifier rubyid_columns'>columns</span> <span class='kw'>if</span> <span class='id identifier rubyid_table'>table</span><span class='period'>.</span><span class='id identifier rubyid_columns'>columns</span><span class='period'>.</span><span class='id identifier rubyid_defaults'>defaults</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span>
<span class='id identifier rubyid_table'>table</span><span class='period'>.</span><span class='id identifier rubyid_columns'>columns</span><span class='period'>.</span><span class='id identifier rubyid_defaults'>defaults</span> <span class='op'>=</span>
- <span class='const'><span class='object_link'><a href="Defaults.html" title="CSVDecision::Defaults (module)">Defaults</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse'><span class='object_link'><a href="Defaults.html#parse-class_method" title="CSVDecision::Defaults.parse (method)">parse</a></span></span><span class='lparen'>(</span><span class='label'>columns:</span> <span class='id identifier rubyid_table'>table</span><span class='period'>.</span><span class='id identifier rubyid_columns'>columns</span><span class='comma'>,</span> <span class='label'>matchers:</span> <span class='id identifier rubyid_matchers'>matchers</span><span class='period'>.</span><span class='id identifier rubyid_outs'>outs</span><span class='comma'>,</span> <span class='label'>row:</span> <span class='id identifier rubyid_table'>table</span><span class='period'>.</span><span class='id identifier rubyid_rows'>rows</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span><span class='rparen'>)</span>
+ <span class='const'><span class='object_link'><a href="Defaults.html" title="CSVDecision2::Defaults (module)">Defaults</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse'><span class='object_link'><a href="Defaults.html#parse-class_method" title="CSVDecision2::Defaults.parse (method)">parse</a></span></span><span class='lparen'>(</span><span class='label'>columns:</span> <span class='id identifier rubyid_table'>table</span><span class='period'>.</span><span class='id identifier rubyid_columns'>columns</span><span class='comma'>,</span> <span class='label'>matchers:</span> <span class='id identifier rubyid_matchers'>matchers</span><span class='period'>.</span><span class='id identifier rubyid_outs'>outs</span><span class='comma'>,</span> <span class='label'>row:</span> <span class='id identifier rubyid_table'>table</span><span class='period'>.</span><span class='id identifier rubyid_rows'>rows</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span><span class='rparen'>)</span>
<span class='id identifier rubyid_table'>table</span><span class='period'>.</span><span class='id identifier rubyid_columns'>columns</span>
<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- <div class="method_details ">
- <h3 class="signature " id="row?-class_method">
-
- .<strong>row?</strong>(row) ⇒ <tt>Boolean</tt>
-
+ </td>
+ </tr>
+ </table>
+ </div>
-
+ <div class="method_details ">
+ <h3 class="signature " id="row?-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>
+ .<strong>row?</strong>(row) ⇒ <tt>Boolean</tt>
-<p>Check if the given row contains a recognisable header cell.</p>
- </div>
-</div>
-<div class="tags">
- <p class="tag_title">Parameters:</p>
-<ul class="param">
-
- <li>
-
- <span class='name'>row</span>
-
-
- <span class='type'>(<tt>Array<String></tt>)</span>
-
-
-
- —
- <div class='inline'>
-<p>Header row.</p>
-</div>
-
- </li>
-
-</ul>
-<p class="tag_title">Returns:</p>
-<ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
-
- —
- <div class='inline'>
-<p>Return true if the row looks like a header.</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>Check if the given row contains a recognisable header cell.</p>
+
+ </div>
+ </div>
+ <div class="tags">
+ <p class="tag_title">Parameters:</p>
+ <ul class="param">
+
+ <li>
+
+ <span class='name'>row</span>
+
+
+ <span class='type'>(<tt>Array<String></tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+ <p>Header row.</p>
+ </div>
+
+ </li>
+
+ </ul>
+
+ <p class="tag_title">Returns:</p>
+ <ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt>Boolean</tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+ <p>Return true if the row looks like a header.</p>
+ </div>
+
+ </li>
+
+ </ul>
+
+ </div>
+ <table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
38
39
40</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/csv_decision/header.rb', line 38</span>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/csv_decision2/header.rb', line 38</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_any?'>any?</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_cell'>cell</span><span class='op'>|</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='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='rbrace'>}</span>
+ <span class='id identifier rubyid_row'>row</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_cell'>cell</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="#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='rbrace'>}</span>
<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- <div class="method_details ">
- <h3 class="signature " id="strip_empty_columns-class_method">
-
- .<strong>strip_empty_columns</strong>(rows:) ⇒ <tt>Array<Array<String>></tt>
-
+ </td>
+ </tr>
+ </table>
+ </div>
-
+ <div class="method_details ">
+ <h3 class="signature " id="strip_empty_columns-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>
+ .<strong>strip_empty_columns</strong>(rows:) ⇒ <tt>Array<Array<String>></tt>
-<p>Strip empty columns from all data rows.</p>
- </div>
-</div>
-<div class="tags">
- <p class="tag_title">Parameters:</p>
-<ul class="param">
-
- <li>
-
- <span class='name'>rows</span>
-
-
- <span class='type'>(<tt>Array<Array<String>></tt>)</span>
-
-
-
- —
- <div class='inline'>
-<p>Data rows.</p>
-</div>
-
- </li>
-
-</ul>
-<p class="tag_title">Returns:</p>
-<ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt>Array<Array<String>></tt>)</span>
-
-
-
- —
- <div class='inline'>
-<p>Data array after removing any empty columns and the header row.</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>Strip empty columns from all data rows.</p>
+
+ </div>
+ </div>
+ <div class="tags">
+ <p class="tag_title">Parameters:</p>
+ <ul class="param">
+
+ <li>
+
+ <span class='name'>rows</span>
+
+
+ <span class='type'>(<tt>Array<Array<String>></tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+ <p>Data rows.</p>
+ </div>
+
+ </li>
+
+ </ul>
+
+ <p class="tag_title">Returns:</p>
+ <ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt>Array<Array<String>></tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+ <p>Data array after removing any empty columns and the header row.</p>
+ </div>
+
+ </li>
+
+ </ul>
+
+ </div>
+ <table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
47
48
49
50
51
52
53</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/csv_decision/header.rb', line 47</span>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/csv_decision2/header.rb', line 47</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>
+ <span class='const'><span class='object_link'><a href="Data.html" title="CSVDecision2::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="CSVDecision2::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>
<span class='comment'># Remove header row from the data array.
</span> <span class='id identifier rubyid_rows'>rows</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</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>