doc/CSVDecision/Matchers/Matcher.html in csv_decision2-0.5.1 vs doc/CSVDecision/Matchers/Matcher.html in csv_decision2-0.5.2
- old
+ new
@@ -1,507 +1,551 @@
<!DOCTYPE html>
<html>
- <head>
- <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
- Class: CSVDecision::Matchers::Matcher
-
+
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <title>
+ Class: CSVDecision2::Matchers::Matcher
+
— 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::Matchers::Matcher";
- relpath = '../../';
-</script>
+ <script type="text/javascript" charset="utf-8">
+ pathId = "CSVDecision2::Matchers::Matcher";
+ 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 (M)</a> »
- <span class='title'><span class='object_link'><a href="../../CSVDecision.html" title="CSVDecision (module)">CSVDecision</a></span></span> » <span class='title'><span class='object_link'><a href="../Matchers.html" title="CSVDecision::Matchers (class)">Matchers</a></span></span>
- »
- <span class="title">Matcher</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 (M)</a> »
+ <span class='title'><span class='object_link'><a href="../../CSVDecision2.html"
+ title="CSVDecision (module)">CSVDecision</a></span></span> » <span class='title'><span
+ class='object_link'><a href="../Matchers.html"
+ title="CSVDecision2::Matchers (class)">Matchers</a></span></span>
+ »
+ <span class="title">Matcher</span>
+
</div>
- <div id="content"><h1>Class: CSVDecision::Matchers::Matcher
-
-
- <span class="private note title">Private</span>
-</h1>
-<div class="box_info">
-
- <dl>
- <dt>Inherits:</dt>
- <dd>
- <span class="inheritName">Object</span>
-
- <ul class="fullTree">
- <li>Object</li>
-
- <li class="next">CSVDecision::Matchers::Matcher</li>
-
- </ul>
- <a href="#" class="inheritanceTree">show all</a>
-
- </dd>
- </dl>
-
+ <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/matchers.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 class is part of a private API.</strong>
- You should avoid using this class if possible, as it may be removed or be changed in the future.
-</p>
+ <div id="content">
+ <h1>Class: CSVDecision2::Matchers::Matcher
-<p>Subclass and override <span class='object_link'><a href="#matches%3F-instance_method" title="CSVDecision::Matchers::Matcher#matches? (method)">#matches?</a></span> to implement a custom Matcher class.</p>
+ <span class="private note title">Private</span>
+ </h1>
+ <div class="box_info">
- </div>
-</div>
-<div class="tags">
-
+ <dl>
+ <dt>Inherits:</dt>
+ <dd>
+ <span class="inheritName">Object</span>
-</div><div id="subclasses">
- <h2>Direct Known Subclasses</h2>
- <p class="children"><span class='object_link'><a href="Constant.html" title="CSVDecision::Matchers::Constant (class)">Constant</a></span>, <span class='object_link'><a href="Function.html" title="CSVDecision::Matchers::Function (class)">Function</a></span>, <span class='object_link'><a href="Guard.html" title="CSVDecision::Matchers::Guard (class)">Guard</a></span>, <span class='object_link'><a href="Numeric.html" title="CSVDecision::Matchers::Numeric (class)">Numeric</a></span>, <span class='object_link'><a href="Pattern.html" title="CSVDecision::Matchers::Pattern (class)">Pattern</a></span>, <span class='object_link'><a href="Range.html" title="CSVDecision::Matchers::Range (class)">Range</a></span>, <span class='object_link'><a href="Symbol.html" title="CSVDecision::Matchers::Symbol (class)">Symbol</a></span></p>
-</div>
+ <ul class="fullTree">
+ <li>Object</li>
+ <li class="next">CSVDecision2::Matchers::Matcher</li>
+ </ul>
+ <a href="#" class="inheritanceTree">show all</a>
+ </dd>
+ </dl>
-
- <h2>
- Instance Method Summary
- <small><a href="#" class="summary_toggle">collapse</a></small>
- </h2>
- <ul class="summary">
-
+
+
+
+
+
+
+ <dl>
+ <dt>Defined in:</dt>
+ <dd>lib/csv_decision2/matchers.rb</dd>
+ </dl>
+
+ </div>
+
+ <h2>Overview</h2>
+ <div class="docstring">
+ <div class="discussion">
+ <p class="note private">
+ <strong>This class is part of a private API.</strong>
+ You should avoid using this class if possible, as it may be removed or be changed in the future.
+ </p>
+
+ <p>Subclass and override <span class='object_link'><a href="#matches%3F-instance_method"
+ title="CSVDecision2::Matchers::Matcher#matches? (method)">#matches?</a></span> to implement a custom
+ Matcher class.</p>
+
+
+ </div>
+ </div>
+ <div class="tags">
+
+
+ </div>
+ <div id="subclasses">
+ <h2>Direct Known Subclasses</h2>
+ <p class="children"><span class='object_link'><a href="Constant.html"
+ title="CSVDecision2::Matchers::Constant (class)">Constant</a></span>, <span class='object_link'><a
+ href="Function.html" title="CSVDecision2::Matchers::Function (class)">Function</a></span>, <span
+ class='object_link'><a href="Guard.html" title="CSVDecision2::Matchers::Guard (class)">Guard</a></span>,
+ <span class='object_link'><a href="Numeric.html"
+ title="CSVDecision2::Matchers::Numeric (class)">Numeric</a></span>, <span class='object_link'><a
+ href="Pattern.html" title="CSVDecision2::Matchers::Pattern (class)">Pattern</a></span>, <span
+ class='object_link'><a href="Range.html" title="CSVDecision2::Matchers::Range (class)">Range</a></span>,
+ <span class='object_link'><a href="Symbol.html"
+ title="CSVDecision2::Matchers::Symbol (class)">Symbol</a></span>
+ </p>
+ </div>
+
+
+
+
+
+
+
+
+ <h2>
+ Instance Method Summary
+ <small><a href="#" class="summary_toggle">collapse</a></small>
+ </h2>
+
+ <ul class="summary">
+
<li class="public ">
- <span class="summary_signature">
-
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(_options = nil) ⇒ Matcher </a>
-
+ <span class="summary_signature">
-
- </span>
-
-
- <span class="note title constructor">constructor</span>
-
-
-
-
-
- <span class="private note title">private</span>
+ <a href="#initialize-instance_method"
+ title="#initialize (instance method)">#<strong>initialize</strong>(_options = nil) ⇒ Matcher </a>
-
- <span class="summary_desc"><div class='inline'>
-<p>A new instance of Matcher.</p>
-</div></span>
-
-</li>
-
+
+ </span>
+
+
+ <span class="note title constructor">constructor</span>
+
+
+
+
+
+ <span class="private note title">private</span>
+
+
+ <span class="summary_desc">
+ <div class='inline'>
+ <p>A new instance of Matcher.</p>
+ </div>
+ </span>
+
+ </li>
+
+
<li class="public ">
- <span class="summary_signature">
-
- <a href="#ins%3F-instance_method" title="#ins? (instance method)">#<strong>ins?</strong> ⇒ Boolean </a>
-
+ <span class="summary_signature">
-
- </span>
-
-
-
-
-
-
- <span class="private note title">private</span>
+ <a href="#ins%3F-instance_method" title="#ins? (instance method)">#<strong>ins?</strong> ⇒ Boolean
+ </a>
-
- <span class="summary_desc"><div class='inline'>
-<p>Does this matcher apply to output cells?.</p>
-</div></span>
-
-</li>
-
+
+ </span>
+
+
+
+
+
+
+ <span class="private note title">private</span>
+
+
+ <span class="summary_desc">
+ <div class='inline'>
+ <p>Does this matcher apply to output cells?.</p>
+ </div>
+ </span>
+
+ </li>
+
+
<li class="public ">
- <span class="summary_signature">
-
- <a href="#matches%3F-instance_method" title="#matches? (instance method)">#<strong>matches?</strong>(cell) ⇒ false, CSVDecision::Proc </a>
-
+ <span class="summary_signature">
-
- </span>
-
-
-
-
-
-
- <span class="private note title">private</span>
+ <a href="#matches%3F-instance_method" title="#matches? (instance method)">#<strong>matches?</strong>(cell)
+ ⇒ false, CSVDecision2::Proc </a>
-
- <span class="summary_desc"><div class='inline'>
-<p>Determine if the input cell string is recognised by this Matcher.</p>
-</div></span>
-
-</li>
-
+
+ </span>
+
+
+
+
+
+
+ <span class="private note title">private</span>
+
+
+ <span class="summary_desc">
+ <div class='inline'>
+ <p>Determine if the input cell string is recognised by this Matcher.</p>
+ </div>
+ </span>
+
+ </li>
+
+
<li class="public ">
- <span class="summary_signature">
-
- <a href="#outs%3F-instance_method" title="#outs? (instance method)">#<strong>outs?</strong> ⇒ Boolean </a>
-
+ <span class="summary_signature">
-
- </span>
-
-
-
-
-
-
- <span class="private note title">private</span>
+ <a href="#outs%3F-instance_method" title="#outs? (instance method)">#<strong>outs?</strong> ⇒ Boolean
+ </a>
-
- <span class="summary_desc"><div class='inline'>
-<p>Does this matcher apply to output cells?.</p>
-</div></span>
-
-</li>
-
- </ul>
-
-<div id="constructor_details" class="method_details_list">
- <h2>Constructor Details</h2>
-
- <div class="method_details first">
- <h3 class="signature first" id="initialize-instance_method">
-
- #<strong>initialize</strong>(_options = nil) ⇒ <tt><span class='object_link'><a href="" title="CSVDecision::Matchers::Matcher (class)">Matcher</a></span></tt>
-
+ </span>
-
-
-</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>Returns a new instance of Matcher</p>
- </div>
-</div>
-<div class="tags">
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
+ <span class="private note title">private</span>
+ <span class="summary_desc">
+ <div class='inline'>
+ <p>Does this matcher apply to output cells?.</p>
+ </div>
+ </span>
+
+ </li>
+
+
+ </ul>
+
+
+ <div id="constructor_details" class="method_details_list">
+ <h2>Constructor Details</h2>
+
+ <div class="method_details first">
+ <h3 class="signature first" id="initialize-instance_method">
+
+ #<strong>initialize</strong>(_options = nil) ⇒ <tt><span class='object_link'><a href=""
+ title="CSVDecision2::Matchers::Matcher (class)">Matcher</a></span></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>Returns a new instance of Matcher</p>
+
+
+ </div>
+ </div>
+ <div class="tags">
+
+
+ </div>
+ <table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
193</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/csv_decision/matchers.rb', line 193</span>
+ </td>
+ <td>
+ <pre
+ class="code"><span class="info file"># File 'lib/csv_decision2/matchers.rb', line 193</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid__options'>_options</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
-</div>
+ </td>
+ </tr>
+ </table>
+ </div>
+ </div>
- <div id="instance_method_details" class="method_details_list">
- <h2>Instance Method Details</h2>
-
- <div class="method_details first">
- <h3 class="signature first" id="ins?-instance_method">
-
- #<strong>ins?</strong> ⇒ <tt>Boolean</tt>
-
+ <div id="instance_method_details" class="method_details_list">
+ <h2>Instance Method Details</h2>
-
-
-</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>
+ <div class="method_details first">
+ <h3 class="signature first" id="ins?-instance_method">
-<p>Does this matcher apply to output cells?</p>
+ #<strong>ins?</strong> ⇒ <tt>Boolean</tt>
- </div>
-</div>
-<div class="tags">
-
-<p class="tag_title">Returns:</p>
-<ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
-
- —
- <div class='inline'>
-<p>Return true if this matcher applies to input cells, false otherwise.</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>Does this matcher apply to output cells?</p>
+
+
+ </div>
+ </div>
+ <div class="tags">
+
+ <p class="tag_title">Returns:</p>
+ <ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt>Boolean</tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+ <p>Return true if this matcher applies to input cells, false otherwise.</p>
+ </div>
+
+ </li>
+
+ </ul>
+
+ </div>
+ <table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
215
216
217</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/csv_decision/matchers.rb', line 215</span>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/csv_decision2/matchers.rb', line 215</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ins?'>ins?</span>
<span class='kw'>true</span>
<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- <div class="method_details ">
- <h3 class="signature " id="matches?-instance_method">
-
- #<strong>matches?</strong>(cell) ⇒ <tt>false</tt>, <tt>CSVDecision::Proc</tt>
-
+ </td>
+ </tr>
+ </table>
+ </div>
-
+ <div class="method_details ">
+ <h3 class="signature " id="matches?-instance_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>matches?</strong>(cell) ⇒ <tt>false</tt>, <tt>CSVDecision2::Proc</tt>
-<p>Determine if the input cell string is recognised by this Matcher.</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>Data row cell.</p>
-</div>
-
- </li>
-
-</ul>
-<p class="tag_title">Returns:</p>
-<ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt>false</tt>, <tt>CSVDecision::Proc</tt>)</span>
-
-
-
- —
- <div class='inline'>
-<p>Returns false if this cell is not a match; otherwise returns the
-<code>CSVDecision::Proc</code> object indicating if this is a constant or
-some type of function.</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>Determine if the input cell string is recognised by this Matcher.</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>Data row cell.</p>
+ </div>
+
+ </li>
+
+ </ul>
+
+ <p class="tag_title">Returns:</p>
+ <ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt>false</tt>, <tt>CSVDecision2::Proc</tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+ <p>Returns false if this cell is not a match; otherwise returns the
+ <code>CSVDecision2::Proc</code> object indicating if this is a constant or
+ some type of function.
+ </p>
+ </div>
+
+ </li>
+
+ </ul>
+
+ </div>
+ <table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
201</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/csv_decision/matchers.rb', line 201</span>
+ </td>
+ <td>
+ <pre
+ class="code"><span class="info file"># File 'lib/csv_decision2/matchers.rb', line 201</span>
<span class='kw'>def</span> <span class='id identifier rubyid_matches?'>matches?</span><span class='lparen'>(</span><span class='id identifier rubyid_cell'>cell</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- <div class="method_details ">
- <h3 class="signature " id="outs?-instance_method">
-
- #<strong>outs?</strong> ⇒ <tt>Boolean</tt>
-
+ </td>
+ </tr>
+ </table>
+ </div>
-
+ <div class="method_details ">
+ <h3 class="signature " id="outs?-instance_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>outs?</strong> ⇒ <tt>Boolean</tt>
-<p>Does this matcher apply to output cells?</p>
- </div>
-</div>
-<div class="tags">
-
-<p class="tag_title">Returns:</p>
-<ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
-
- —
- <div class='inline'>
-<p>Return true if this matcher applies to output cells, false otherwise.</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>Does this matcher apply to output cells?</p>
+
+
+ </div>
+ </div>
+ <div class="tags">
+
+ <p class="tag_title">Returns:</p>
+ <ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt>Boolean</tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+ <p>Return true if this matcher applies to output cells, false otherwise.</p>
+ </div>
+
+ </li>
+
+ </ul>
+
+ </div>
+ <table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
207
208
209</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/csv_decision/matchers.rb', line 207</span>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/csv_decision2/matchers.rb', line 207</span>
<span class='kw'>def</span> <span class='id identifier rubyid_outs?'>outs?</span>
<span class='kw'>false</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:08 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:08 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>