doc/CSVDecision/Matchers/Constant.html in csv_decision-0.0.6 vs doc/CSVDecision/Matchers/Constant.html in csv_decision-0.0.7

- old
+ new

@@ -60,11 +60,11 @@ </div> <div id="content"><h1>Class: CSVDecision::Matchers::Constant - + <span class="private note title">Private</span> </h1> <div class="box_info"> <dl> <dt>Inherits:</dt> @@ -101,11 +101,15 @@ </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>Cell constant matcher - e.g., := true, = nil.</p> </div> </div> @@ -119,35 +123,97 @@ <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="#matches%3F-class_method" title="matches? (class method)">.<strong>matches?</strong>(cell) &#x21d2; false, CSVDecision::Proc </a> + + + + </span> + + + + + + + <span class="private note title">private</span> + + + <span class="summary_desc"><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></span> + +</li> + + + </ul> + + <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="#matches%3F-instance_method" title="#matches? (instance method)">#<strong>matches?</strong>(cell) &#x21d2; Boolean </a> + <a href="#matches%3F-instance_method" title="#matches? (instance method)">#<strong>matches?</strong>(cell) &#x21d2; false, CSVDecision::Proc </a> </span> + <span class="private note title">private</span> + + <span class="summary_desc"><div class='inline'> +<p>If a constant expression returns a Proc of type :constant, otherwise +return false.</p> +</div></span> + +</li> + + <li class="public "> + <span class="summary_signature"> + + <a href="#outs%3F-instance_method" title="#outs? (instance method)">#<strong>outs?</strong> &#x21d2; Boolean </a> + + + + </span> - <span class="summary_desc"><div class='inline'></div></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> </ul> @@ -160,36 +226,232 @@ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Matcher.html" title="CSVDecision::Matchers::Matcher (class)">Matcher</a></span></h3> - <p class="inherited"><span class='object_link'><a href="Matcher.html#initialize-instance_method" title="CSVDecision::Matchers::Matcher#initialize (method)">#initialize</a></span></p> + <p class="inherited"><span class='object_link'><a href="Matcher.html#initialize-instance_method" title="CSVDecision::Matchers::Matcher#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Matcher.html#ins%3F-instance_method" title="CSVDecision::Matchers::Matcher#ins? (method)">#ins?</a></span></p> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Matcher.html#initialize-instance_method" title="CSVDecision::Matchers::Matcher#initialize (method)">CSVDecision::Matchers::Matcher</a></span></p> </div> + <div id="class_method_details" class="method_details_list"> + <h2>Class Method Details</h2> + + + <div class="method_details first"> + <h3 class="signature first" id="matches?-class_method"> + + .<strong>matches?</strong>(cell) &#x21d2; <tt>false</tt>, <tt>CSVDecision::Proc</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 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> +</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> + + + + &mdash; + <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> + + + + &mdash; + <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"> + + +31 +32 +33 +34 +35 +36 +37 +38</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/csv_decision/matchers/constant.rb', line 31</span> + +<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</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='kw'>return</span> <span class='kw'>false</span> <span class='kw'>unless</span> <span class='lparen'>(</span><span class='id identifier rubyid_match'>match</span> <span class='op'>=</span> <span class='const'>EXPRESSION</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='rparen'>)</span> + + <span class='id identifier rubyid_proc'>proc</span> <span class='op'>=</span> <span class='id identifier rubyid_non_numeric?'>non_numeric?</span><span class='lparen'>(</span><span class='id identifier rubyid_match'>match</span><span class='rparen'>)</span> + <span class='kw'>return</span> <span class='id identifier rubyid_proc'>proc</span> <span class='kw'>if</span> <span class='id identifier rubyid_proc'>proc</span> + + <span class='id identifier rubyid_numeric?'>numeric?</span><span class='lparen'>(</span><span class='id identifier rubyid_match'>match</span><span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </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="matches?-instance_method"> - #<strong>matches?</strong>(cell) &#x21d2; <tt>Boolean</tt> + #<strong>matches?</strong>(cell) &#x21d2; <tt>false</tt>, <tt>CSVDecision::Proc</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>If a constant expression returns a Proc of type :constant,</p> + +<pre class="code ruby"><code class="ruby">otherwise return false.</code></pre> + + + </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> + + + + &mdash; + <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> + + + + &mdash; + <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"> + + +66 +67 +68</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/csv_decision/matchers/constant.rb', line 66</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='const'><span class='object_link'><a href="../Matchers.html" title="CSVDecision::Matchers (class)">Matchers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="CSVDecision::Matchers::Constant (class)">Constant</a></span></span><span class='period'>.</span><span class='id identifier rubyid_matches?'><span class='object_link'><a href="#matches%3F-class_method" title="CSVDecision::Matchers::Constant.matches? (method)">matches?</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_cell'>cell</span><span class='rparen'>)</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> &#x21d2; <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>Does this matcher apply to output cells?</p> + + </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> @@ -200,29 +462,34 @@ <span class='type'>(<tt>Boolean</tt>)</span> + &mdash; + <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"> -13 -14 -15</pre> +71 +72 +73</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/csv_decision/matchers/constant.rb', line 13</span> + <pre class="code"><span class="info file"># File 'lib/csv_decision/matchers/constant.rb', line 71</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='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="../Constant.html" title="CSVDecision::Constant (module)">Constant</a></span></span><span class='period'>.</span><span class='id identifier rubyid_matches?'><span class='object_link'><a href="../Constant.html#matches%3F-class_method" title="CSVDecision::Constant.matches? (method)">matches?</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_cell'>cell</span><span class='rparen'>)</span> +<span class='kw'>def</span> <span class='id identifier rubyid_outs?'>outs?</span> + <span class='kw'>true</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> @@ -230,10 +497,10 @@ </div> </div> <div id="footer"> - Generated on Tue Dec 26 21:20:20 2017 by + Generated on Sat Dec 30 13:04:06 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