doc/TermUtils/AP/Flag.html in term_utils-0.3.2 vs doc/TermUtils/AP/Flag.html in term_utils-0.4.0

- old
+ new

@@ -4,19 +4,19 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title> Class: TermUtils::AP::Flag - &mdash; Documentation by YARD 0.9.20 + &mdash; Documentation by YARD 0.9.25 </title> - <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" /> + <link rel="stylesheet" href="../../css/style.css" type="text/css" /> - <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" /> + <link rel="stylesheet" href="../../css/common.css" type="text/css" /> -<script type="text/javascript" charset="utf-8"> +<script type="text/javascript"> pathId = "TermUtils::AP::Flag"; relpath = '../../'; </script> @@ -127,20 +127,22 @@ </span> + <span class="note title readonly">readonly</span> + <span class="summary_desc"><div class='inline'> -<p>`:anchor`, `:long`, `:short`.</p> +<p>`:long`, `:short`.</p> </div></span> </li> @@ -154,11 +156,13 @@ </span> + <span class="note title readonly">readonly</span> + @@ -183,17 +187,41 @@ <ul class="summary"> <li class="public "> <span class="summary_signature"> - <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(opts = {}) &#x21d2; Flag </a> + <a href="#==-instance_method" title="#== (instance method)">#<strong>==</strong>(other) &#x21d2; Object </a> </span> + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>Tests whether this one is equal to a given Flag.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(label, flavor) &#x21d2; Flag </a> + + + + </span> + + <span class="note title constructor">constructor</span> @@ -209,10 +237,58 @@ <li class="public "> <span class="summary_signature"> + <a href="#long%3F-instance_method" title="#long? (instance method)">#<strong>long?</strong> &#x21d2; Boolean </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>Tests whether this one represents a long flag.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#short%3F-instance_method" title="#short? (instance method)">#<strong>short?</strong> &#x21d2; Boolean </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>Tests whether this one represents a short flag.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + <a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> &#x21d2; String </a> </span> @@ -239,11 +315,11 @@ <h2>Constructor Details</h2> <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method"> - #<strong>initialize</strong>(opts = {}) &#x21d2; <tt><span class='object_link'><a href="" title="TermUtils::AP::Flag (class)">Flag</a></span></tt> + #<strong>initialize</strong>(label, flavor) &#x21d2; <tt><span class='object_link'><a href="" title="TermUtils::AP::Flag (class)">Flag</a></span></tt> @@ -259,72 +335,74 @@ <p class="tag_title">Parameters:</p> <ul class="param"> <li> - <span class='name'>opts</span> + <span class='name'>label</span> - <span class='type'>(<tt>Hash</tt>)</span> + <span class='type'>(<tt>String</tt>)</span> - <em class="default">(defaults to: <tt>{}</tt>)</em> + </li> + + <li> + <span class='name'>flavor</span> + + + <span class='type'>(<tt>Symbol</tt>)</span> + + + + &mdash; + <div class='inline'> +<p>`:short`, `:long`.</p> +</div> + </li> </ul> +<p class="tag_title">Raises:</p> +<ul class="raise"> - - - <p class="tag_title">Options Hash (<tt>opts</tt>):</p> - <ul class="option"> + <li> - <li> - <span class="name">:label</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - <li> - <span class="name">:flavor</span> - <span class="type">(<tt>Symbol</tt>)</span> - <span class="default"> - - </span> - - &mdash; <div class='inline'> -<p>`:anchor`, `:long`, `:short`.</p> -</div> - - </li> + <span class='type'>(<tt><span class='object_link'><a href="SyntaxError.html" title="TermUtils::AP::SyntaxError (class)">TermUtils::AP::SyntaxError</a></span></tt>)</span> - </ul> + + + </li> +</ul> - </div><table class="source_code"> <tr> <td> <pre class="lines"> -30 31 32 -33</pre> +33 +34 +35 +36 +37</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/term_utils/ap/flag.rb', line 30</span> + <pre class="code"><span class="info file"># File 'lib/term_utils/ap/flag.rb', line 31</span> -<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@label</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:label</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span> - <span class='ivar'>@flavor</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:flavor</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span> +<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_label'>label</span><span class='comma'>,</span> <span class='id identifier rubyid_flavor'>flavor</span><span class='rparen'>)</span> + <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../../TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../AP.html" title="TermUtils::AP (module)">AP</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="SyntaxError.html" title="TermUtils::AP::SyntaxError (class)">SyntaxError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>wrong flag label</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^-+$</span><span class='regexp_end'>/</span></span><span class='period'>.</span><span class='id identifier rubyid_match?'>match?</span><span class='lparen'>(</span><span class='id identifier rubyid_label'>label</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='op'>!</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^-[0-9A-Za-z_-]+$</span><span class='regexp_end'>/</span></span><span class='period'>.</span><span class='id identifier rubyid_match?'>match?</span><span class='lparen'>(</span><span class='id identifier rubyid_label'>label</span><span class='rparen'>)</span> + <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../../TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../AP.html" title="TermUtils::AP (module)">AP</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="SyntaxError.html" title="TermUtils::AP::SyntaxError (class)">SyntaxError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>unless</span> <span class='qsymbols_beg'>%i[</span><span class='tstring_content'>short</span><span class='words_sep'> </span><span class='tstring_content'>long</span><span class='tstring_end'>]</span></span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_flavor'>flavor</span><span class='rparen'>)</span> + + <span class='ivar'>@label</span> <span class='op'>=</span> <span class='id identifier rubyid_label'>label</span> + <span class='ivar'>@flavor</span> <span class='op'>=</span> <span class='id identifier rubyid_flavor'>flavor</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> @@ -333,24 +411,24 @@ <div id="instance_attr_details" class="attr_details"> <h2>Instance Attribute Details</h2> - <span id="flavor=-instance_method"></span> + <span id=""></span> <div class="method_details first"> <h3 class="signature first" id="flavor-instance_method"> - #<strong>flavor</strong> &#x21d2; <tt>Symbol</tt> + #<strong>flavor</strong> &#x21d2; <tt>Symbol</tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> -<p>Returns `:anchor`, `:long`, `:short`.</p> +<p>Returns `:long`, `:short`.</p> </div> </div> <div class="tags"> @@ -365,11 +443,11 @@ &mdash; <div class='inline'> -<p>`:anchor`, `:long`, `:short`.</p> +<p>`:long`, `:short`.</p> </div> </li> </ul> @@ -378,31 +456,31 @@ <tr> <td> <pre class="lines"> -25 26 -27</pre> +27 +28</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/term_utils/ap/flag.rb', line 25</span> + <pre class="code"><span class="info file"># File 'lib/term_utils/ap/flag.rb', line 26</span> <span class='kw'>def</span> <span class='id identifier rubyid_flavor'>flavor</span> <span class='ivar'>@flavor</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> - <span id="label=-instance_method"></span> + <span id=""></span> <div class="method_details "> <h3 class="signature " id="label-instance_method"> - #<strong>label</strong> &#x21d2; <tt>String</tt> + #<strong>label</strong> &#x21d2; <tt>String</tt> <span class="extras">(readonly)</span> @@ -432,16 +510,16 @@ <tr> <td> <pre class="lines"> -23 24 -25</pre> +25 +26</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/term_utils/ap/flag.rb', line 23</span> + <pre class="code"><span class="info file"># File 'lib/term_utils/ap/flag.rb', line 24</span> <span class='kw'>def</span> <span class='id identifier rubyid_label'>label</span> <span class='ivar'>@label</span> <span class='kw'>end</span></pre> </td> @@ -455,12 +533,165 @@ <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> - <h3 class="signature first" id="to_s-instance_method"> + <h3 class="signature first" id="==-instance_method"> + #<strong>==</strong>(other) &#x21d2; <tt>Object</tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>Tests whether this one is equal to a given Flag.</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +40 +41 +42 +43 +44</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/term_utils/ap/flag.rb', line 40</span> + +<span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span> + <span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>unless</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../AP.html" title="TermUtils::AP (module)">AP</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="TermUtils::AP::Flag (class)">Flag</a></span></span><span class='rparen'>)</span> + + <span class='ivar'>@label</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_label'>label</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="long?-instance_method"> + + #<strong>long?</strong> &#x21d2; <tt>Boolean</tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>Tests whether this one represents a long flag.</p> + + + </div> +</div> +<div class="tags"> + +<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"> + + +48 +49 +50</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/term_utils/ap/flag.rb', line 48</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_long?'>long?</span> + <span class='ivar'>@flavor</span> <span class='op'>==</span> <span class='symbol'>:long</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="short?-instance_method"> + + #<strong>short?</strong> &#x21d2; <tt>Boolean</tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>Tests whether this one represents a short flag.</p> + + + </div> +</div> +<div class="tags"> + +<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"> + + +54 +55 +56</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/term_utils/ap/flag.rb', line 54</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_short?'>short?</span> + <span class='ivar'>@flavor</span> <span class='op'>==</span> <span class='symbol'>:short</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="to_s-instance_method"> + #<strong>to_s</strong> &#x21d2; <tt>String</tt> @@ -493,33 +724,19 @@ <tr> <td> <pre class="lines"> -36 -37 -38 -39 -40 -41 -42 -43 -44 -45</pre> +60 +61 +62</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/term_utils/ap/flag.rb', line 36</span> + <pre class="code"><span class="info file"># File 'lib/term_utils/ap/flag.rb', line 60</span> <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span> - <span class='kw'>case</span> <span class='ivar'>@flavor</span> - <span class='kw'>when</span> <span class='symbol'>:anchor</span> - <span class='ivar'>@label</span> - <span class='kw'>when</span> <span class='symbol'>:long</span> - <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--%s</span><span class='tstring_end'>&quot;</span></span> <span class='op'>%</span> <span class='ivar'>@label</span> - <span class='kw'>when</span> <span class='symbol'>:short</span> - <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>-%s</span><span class='tstring_end'>&quot;</span></span> <span class='op'>%</span> <span class='ivar'>@label</span> - <span class='kw'>end</span> + <span class='ivar'>@label</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> @@ -527,12 +744,12 @@ </div> </div> <div id="footer"> - Generated on Fri Feb 7 18:54:39 2020 by + Generated on Sun Aug 2 18:35:09 2020 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.9.20 (ruby-2.6.5). + 0.9.25 (ruby-2.6.5). </div> </div> </body> </html> \ No newline at end of file