term_utils 0.3.2 → 0.5.0

data/doc/TermUtils/AP.html

@@ -6,15 +6,15 @@
 <title>
   Module: TermUtils::AP
   
-    &mdash; Documentation by YARD 0.9.20
+    &mdash; Documentation by YARD 0.9.34
   
 </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";
   relpath = '../';
 </script>
@@ -79,7 +79,7 @@
   <dl>
     <dt>Defined in:</dt>
     <dd>lib/term_utils/ap.rb<span class="defines">,<br />
-  lib/term_utils/ap/flag.rb,<br /> lib/term_utils/ap/level.rb,<br /> lib/term_utils/ap/parser.rb,<br /> lib/term_utils/ap/result.rb,<br /> lib/term_utils/ap/syntax.rb,<br /> lib/term_utils/ap/article.rb,<br /> lib/term_utils/ap/element.rb,<br /> lib/term_utils/ap/parameter.rb,<br /> lib/term_utils/ap/parse_error.rb,<br /> lib/term_utils/ap/syntax_error.rb,<br /> lib/term_utils/ap/no_such_value_error.rb</span>
+  lib/term_utils/ap/flag.rb,<br /> lib/term_utils/ap/parser.rb,<br /> lib/term_utils/ap/result.rb,<br /> lib/term_utils/ap/syntax.rb,<br /> lib/term_utils/ap/article.rb,<br /> lib/term_utils/ap/parameter.rb</span>
 </dd>
   </dl>
   
@@ -88,7 +88,7 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
     
-<p>The Argument Parser module provides a way to parse command arguments.</p>
+<p>The Argument Parser module provides a way to parse arguments.</p>
 
 
   </div>
@@ -102,7 +102,7 @@
     
   
     
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="AP/Article.html" title="TermUtils::AP::Article (class)">Article</a></span>, <span class='object_link'><a href="AP/Element.html" title="TermUtils::AP::Element (class)">Element</a></span>, <span class='object_link'><a href="AP/Flag.html" title="TermUtils::AP::Flag (class)">Flag</a></span>, <span class='object_link'><a href="AP/Level.html" title="TermUtils::AP::Level (class)">Level</a></span>, <span class='object_link'><a href="AP/NoSuchValueError.html" title="TermUtils::AP::NoSuchValueError (class)">NoSuchValueError</a></span>, <span class='object_link'><a href="AP/Parameter.html" title="TermUtils::AP::Parameter (class)">Parameter</a></span>, <span class='object_link'><a href="AP/ParseError.html" title="TermUtils::AP::ParseError (class)">ParseError</a></span>, <span class='object_link'><a href="AP/Parser.html" title="TermUtils::AP::Parser (class)">Parser</a></span>, <span class='object_link'><a href="AP/Result.html" title="TermUtils::AP::Result (class)">Result</a></span>, <span class='object_link'><a href="AP/Syntax.html" title="TermUtils::AP::Syntax (class)">Syntax</a></span>, <span class='object_link'><a href="AP/SyntaxError.html" title="TermUtils::AP::SyntaxError (class)">SyntaxError</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="AP/Article.html" title="TermUtils::AP::Article (class)">Article</a></span>, <span class='object_link'><a href="AP/ArticleResult.html" title="TermUtils::AP::ArticleResult (class)">ArticleResult</a></span>, <span class='object_link'><a href="AP/Flag.html" title="TermUtils::AP::Flag (class)">Flag</a></span>, <span class='object_link'><a href="AP/Parameter.html" title="TermUtils::AP::Parameter (class)">Parameter</a></span>, <span class='object_link'><a href="AP/ParameterResult.html" title="TermUtils::AP::ParameterResult (class)">ParameterResult</a></span>, <span class='object_link'><a href="AP/ParameterWalkerHooks.html" title="TermUtils::AP::ParameterWalkerHooks (class)">ParameterWalkerHooks</a></span>, <span class='object_link'><a href="AP/ParseError.html" title="TermUtils::AP::ParseError (class)">ParseError</a></span>, <span class='object_link'><a href="AP/Parser.html" title="TermUtils::AP::Parser (class)">Parser</a></span>, <span class='object_link'><a href="AP/Result.html" title="TermUtils::AP::Result (class)">Result</a></span>, <span class='object_link'><a href="AP/Syntax.html" title="TermUtils::AP::Syntax (class)">Syntax</a></span>, <span class='object_link'><a href="AP/SyntaxError.html" title="TermUtils::AP::SyntaxError (class)">SyntaxError</a></span>, <span class='object_link'><a href="AP/Walker.html" title="TermUtils::AP::Walker (class)">Walker</a></span>
     
   
 </p>
@@ -148,7 +148,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#parse_arguments-class_method" title="parse_arguments (class method)">.<strong>parse_arguments</strong>(syntax, arguments, opts = {})  &#x21d2; TermUtils::AP::Result </a>
+      <a href="#parse_arguments-class_method" title="parse_arguments (class method)">.<strong>parse_arguments</strong>(syntax, arguments, opts = {}, &amp;block)  &#x21d2; Result </a>
     
 
     
@@ -166,30 +166,6 @@
 <p>Parses a given list of arguments.</p>
 </div></span>
   
-</li>
-
-      
-        <li class="public ">
-  <span class="summary_signature">
-    
-      <a href="#parse_command-class_method" title="parse_command (class method)">.<strong>parse_command</strong>(syntax, command, opts = {})  &#x21d2; TermUtils::AP::Result </a>
-    
-
-    
-  </span>
-  
-  
-  
-  
-  
-  
-  
-
-  
-    <span class="summary_desc"><div class='inline'>
-<p>Parses a given command.</p>
-</div></span>
-  
 </li>
 
       
@@ -241,14 +217,14 @@
       <pre class="lines">
 
 
-33
-34
-35
-36
-37</pre>
+96
+97
+98
+99
+100</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/term_utils/ap.rb', line 33</span>
+      <pre class="code"><span class="info file"># File 'lib/term_utils/ap.rb', line 96</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_create_syntax'>create_syntax</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_new_syntax'>new_syntax</span> <span class='op'>=</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="" title="TermUtils::AP (module)">AP</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="AP/Syntax.html" title="TermUtils::AP::Syntax (class)">Syntax</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="AP/Syntax.html#initialize-instance_method" title="TermUtils::AP::Syntax#initialize (method)">new</a></span></span>
@@ -263,7 +239,7 @@
       <div class="method_details ">
   <h3 class="signature " id="parse_arguments-class_method">
   
-    .<strong>parse_arguments</strong>(syntax, arguments, opts = {})  &#x21d2; <tt><span class='object_link'><a href="AP/Result.html" title="TermUtils::AP::Result (class)">TermUtils::AP::Result</a></span></tt> 
+    .<strong>parse_arguments</strong>(syntax, arguments, opts = {}, &amp;block)  &#x21d2; <tt><span class='object_link'><a href="AP/Result.html" title="TermUtils::AP::Result (class)">Result</a></span></tt> 
   
 
   
@@ -286,7 +262,7 @@
         <span class='name'>syntax</span>
       
       
-        <span class='type'>(<tt><span class='object_link'><a href="AP/Syntax.html" title="TermUtils::AP::Syntax (class)">TermUtils::AP::Syntax</a></span></tt>)</span>
+        <span class='type'>(<tt><span class='object_link'><a href="AP/Syntax.html" title="TermUtils::AP::Syntax (class)">Syntax</a></span></tt>)</span>
       
       
       
@@ -318,120 +294,33 @@
   
 </ul>
 
-<p class="tag_title">Returns:</p>
-<ul class="return">
-  
-    <li>
-      
-      
-        <span class='type'>(<tt><span class='object_link'><a href="AP/Result.html" title="TermUtils::AP::Result (class)">TermUtils::AP::Result</a></span></tt>)</span>
-      
-      
-      
-    </li>
-  
-</ul>
-<p class="tag_title">Raises:</p>
-<ul class="raise">
-  
-    <li>
-      
-      
-        <span class='type'>(<tt><span class='object_link'><a href="AP/ParseError.html" title="TermUtils::AP::ParseError (class)">TermUtils::AP::ParseError</a></span></tt>)</span>
-      
-      
-      
-    </li>
   
-    <li>
-      
-      
-        <span class='type'>(<tt><span class='object_link'><a href="AP/SyntaxError.html" title="TermUtils::AP::SyntaxError (class)">TermUtils::AP::SyntaxError</a></span></tt>)</span>
-      
-      
-      
-    </li>
-  
-</ul>
-
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-
-
-55
-56
-57</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/term_utils/ap.rb', line 55</span>
-
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_parse_arguments'>parse_arguments</span><span class='lparen'>(</span><span class='id identifier rubyid_syntax'>syntax</span><span class='comma'>,</span> <span class='id identifier rubyid_arguments'>arguments</span><span class='comma'>,</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='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="" title="TermUtils::AP (module)">AP</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="AP/Parser.html" title="TermUtils::AP::Parser (class)">Parser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="AP/Parser.html#initialize-instance_method" title="TermUtils::AP::Parser#initialize (method)">new</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_arguments'><span class='object_link'><a href="AP/Parser.html#parse_arguments-instance_method" title="TermUtils::AP::Parser#parse_arguments (method)">parse_arguments</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_syntax'>syntax</span><span class='comma'>,</span> <span class='id identifier rubyid_arguments'>arguments</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
     
-      <div class="method_details ">
-  <h3 class="signature " id="parse_command-class_method">
-  
-    .<strong>parse_command</strong>(syntax, command, opts = {})  &#x21d2; <tt><span class='object_link'><a href="AP/Result.html" title="TermUtils::AP::Result (class)">TermUtils::AP::Result</a></span></tt> 
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
     
-<p>Parses a given command.</p>
-
-
-  </div>
+    
+    
+    
+    
+    <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
+    <ul class="option">
+      
+        <li>
+          <span class="name">:strict</span>
+          <span class="type">(<tt>Boolean</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>Whether the Syntax must be considered as strict.</p>
 </div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-  
-    <li>
-      
-        <span class='name'>syntax</span>
-      
+          
+        </li>
       
-        <span class='type'>(<tt><span class='object_link'><a href="AP/Syntax.html" title="TermUtils::AP::Syntax (class)">TermUtils::AP::Syntax</a></span></tt>)</span>
-      
-      
-      
-    </li>
-  
-    <li>
-      
-        <span class='name'>command</span>
-      
-      
-        <span class='type'>(<tt>String</tt>)</span>
-      
-      
-      
-    </li>
-  
-    <li>
-      
-        <span class='name'>opts</span>
-      
-      
-        <span class='type'>(<tt>Hash</tt>)</span>
-      
-      
-        <em class="default">(defaults to: <tt>{}</tt>)</em>
-      
-      
-    </li>
+    </ul>
   
-</ul>
+    
+    
 
 <p class="tag_title">Returns:</p>
 <ul class="return">
@@ -439,7 +328,7 @@
     <li>
       
       
-        <span class='type'>(<tt><span class='object_link'><a href="AP/Result.html" title="TermUtils::AP::Result (class)">TermUtils::AP::Result</a></span></tt>)</span>
+        <span class='type'>(<tt><span class='object_link'><a href="AP/Result.html" title="TermUtils::AP::Result (class)">Result</a></span></tt>)</span>
       
       
       
@@ -452,7 +341,7 @@
     <li>
       
       
-        <span class='type'>(<tt><span class='object_link'><a href="AP/ParseError.html" title="TermUtils::AP::ParseError (class)">TermUtils::AP::ParseError</a></span></tt>)</span>
+        <span class='type'>(<tt><span class='object_link'><a href="AP/ParseError.html" title="TermUtils::AP::ParseError (class)">ParseError</a></span></tt>)</span>
       
       
       
@@ -461,7 +350,7 @@
     <li>
       
       
-        <span class='type'>(<tt><span class='object_link'><a href="AP/SyntaxError.html" title="TermUtils::AP::SyntaxError (class)">TermUtils::AP::SyntaxError</a></span></tt>)</span>
+        <span class='type'>(<tt><span class='object_link'><a href="AP/SyntaxError.html" title="TermUtils::AP::SyntaxError (class)">SyntaxError</a></span></tt>)</span>
       
       
       
@@ -475,15 +364,15 @@
       <pre class="lines">
 
 
-45
-46
-47</pre>
+110
+111
+112</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/term_utils/ap.rb', line 45</span>
+      <pre class="code"><span class="info file"># File 'lib/term_utils/ap.rb', line 110</span>
 
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_parse_command'>parse_command</span><span class='lparen'>(</span><span class='id identifier rubyid_syntax'>syntax</span><span class='comma'>,</span> <span class='id identifier rubyid_command'>command</span><span class='comma'>,</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='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="" title="TermUtils::AP (module)">AP</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="AP/Parser.html" title="TermUtils::AP::Parser (class)">Parser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="AP/Parser.html#initialize-instance_method" title="TermUtils::AP::Parser#initialize (method)">new</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_command'><span class='object_link'><a href="AP/Parser.html#parse_command-instance_method" title="TermUtils::AP::Parser#parse_command (method)">parse_command</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_syntax'>syntax</span><span class='comma'>,</span> <span class='id identifier rubyid_command'>command</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_parse_arguments'>parse_arguments</span><span class='lparen'>(</span><span class='id identifier rubyid_syntax'>syntax</span><span class='comma'>,</span> <span class='id identifier rubyid_arguments'>arguments</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</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="" title="TermUtils::AP (module)">AP</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="AP/Parser.html" title="TermUtils::AP::Parser (class)">Parser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="AP/Parser.html#initialize-instance_method" title="TermUtils::AP::Parser#initialize (method)">new</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_arguments'><span class='object_link'><a href="AP/Parser.html#parse_arguments-instance_method" title="TermUtils::AP::Parser#parse_arguments (method)">parse_arguments</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_syntax'>syntax</span><span class='comma'>,</span> <span class='id identifier rubyid_arguments'>arguments</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -495,9 +384,9 @@
 </div>
 
       <div id="footer">
-  Generated on Fri Feb  7 18:54:38 2020 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.20 (ruby-2.6.5).
+  Generated on Wed Aug  9 17:34:25 2023 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.34 (ruby-3.2.2).
 </div>
 
     </div>