RubyGems - facets - Versions diffs - 2.5.2 → 2.6.0 - Mend

facets 2.5.2 → 2.6.0

Files changed (677) hide show

data/doc/rdoc/more/classes/Argvector.html DELETED

@@ -1,487 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html>
-  <head>
-    <title>Class: Argvector</title>
-    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-    <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
-    <script language="JavaScript" type="text/javascript">
-    // <![CDATA[
-        function toggleSource( id )
-        {
-          var elem
-          var link
-          if( document.getElementById )
-          {
-            elem = document.getElementById( id )
-            link = document.getElementById( "l_" + id )
-          }
-          else if ( document.all )
-          {
-            elem = eval( "document.all." + id )
-            link = eval( "document.all.l_" + id )
-          }
-          else
-            return false;
-          if( elem.style.display == "block" )
-          {
-            elem.style.display = "none"
-            link.innerHTML = "+"
-          }
-          else
-          {
-            elem.style.display = "block"
-            link.innerHTML = "-"
-          }
-        }
-        function openCode( url )
-        {
-          window.open( url, "SOURCE_CODE", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=480,width=750" ).focus();
-        }
-      // ]]>
-    </script>
-  </head>
-  <body>
-  <table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'><tr>
-  <td class="file-title"><span class="file-title-prefix">Class</span><br />Argvector</td>
-  <td align="right">
-    <table cellspacing="0" cellpadding="2">
-      <tr valign="top">
-        <td>In:</td>
-        <td>
-<a href="../files/lib/more/facets/argvector_rb.html">lib/more/facets/argvector.rb</a>
-        </td>
-      </tr>
-    <tr>
-      <td>Parent:</td>
-      <td>
-Object
-     </td>
-   </tr>
-         </table>
-        </td>
-        </tr>
-      </table>
- <!-- banner header -->
-  <div id="bodyContent">
-      <div id="content">
-  <div class="description"><h1><a href="Argvector.html">Argvector</a></h1>
-<p>
-<a href="Argvector.html">Argvector</a> provides a very simple means of
-parsing command line <a href="Argvector.html#M000421">arguments</a>.
-</p>
-<p>
-Unlike other more complex libs this provides only the most basic and
-standard parsing functionality. In many cases that&#8216;s all one really
-needs.
-</p>
-<p>
-Usage is straight foward. Simply instantiate the class and query it for the
-particular &quot;views&quot; of the command line you want.
-</p>
-<pre>
-  cargs = Argvector.new(&quot;-a foo -b=2&quot;)
-  cargs.parameters    #=&gt; [['foo'],{'a'=&gt;true,'b'=&gt;'2'}]
-  cargs.flags         #=&gt; ['a']
-  cargs.preoptions    #=&gt; {'a'=&gt;true}
-  cargs.preflags      #=&gt; ['a']
-  cargs.subcommand    #=&gt; ['foo',{'b'=&gt;'2'}]
-</pre>
-</div>
-  <div class="sectiontitle">Methods</div>
-  <span style="padding-right: 5px;"><a href="#M000421">arguments</a></span>
-  <span style="padding-right: 5px;"><a href="#M000424">flags</a></span>
-  <span style="padding-right: 5px;"><a href="#M000419">new</a></span>
-  <span style="padding-right: 5px;"><a href="#M000420">operands</a></span>
-  <span style="padding-right: 5px;"><a href="#M000422">options</a></span>
-  <span style="padding-right: 5px;"><a href="#M000423">parameters</a></span>
-  <span style="padding-right: 5px;"><a href="#M000418">parameters</a></span>
-  <span style="padding-right: 5px;"><a href="#M000431">parameters_without_duplicates</a></span>
-  <span style="padding-right: 5px;"><a href="#M000430">preflags</a></span>
-  <span style="padding-right: 5px;"><a href="#M000429">preoptions</a></span>
-  <span style="padding-right: 5px;"><a href="#M000426">subcommand</a></span>
-  <span style="padding-right: 5px;"><a href="#M000428">subcommand_with_arguments</a></span>
-  <span style="padding-right: 5px;"><a href="#M000425">subcommand_with_parameters</a></span>
-  <span style="padding-right: 5px;"><a href="#M000427">subcommand_with_preoptions</a></span>
-  <div class="sectiontitle">Attributes</div>
-  <table border='0' cellpadding='5'>
-  <tr valign='top'>
-    <td class='attr-rw'>
-[R]
-    </td>
-    <td class='attr-name'>argv</td>
-    <td class='attr-desc'></td>
-  </tr>
-  <tr valign='top'>
-    <td class='attr-rw'>
-[R]
-    </td>
-    <td class='attr-name'>arity</td>
-    <td class='attr-desc'></td>
-  </tr>
-  <tr valign='top'>
-    <td class='attr-rw'>
-[R]
-    </td>
-    <td class='attr-name'>line</td>
-    <td class='attr-desc'></td>
-  </tr>
-  </table>
-<div class="sectiontitle">Public Class methods</div>
-<div class="method">
-  <div class="title">
-    <a name="M000419"></a><b>new</b>(line=nil, arity=nil)
-  </div>
-  <div class="description">
-  <p>
-Takes the command line string (or array) and <a
-href="Argvector.html#M000422">options</a>. Options have <a
-href="Argvector.html#M000424">flags</a> and end with a hash of option
-arity.
-</p>
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000419_source')" id="l_M000419_source">+</a> ]</p>
-  <div id="M000419_source" class="dyn-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/more/facets/argvector.rb, line 81</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">line</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">arity</span>=<span class="ruby-keyword kw">nil</span>)
-    <span class="ruby-ivar">@line</span>, <span class="ruby-ivar">@argv</span>  = <span class="ruby-identifier">parse_line</span>(<span class="ruby-identifier">line</span>)
-    <span class="ruby-ivar">@arity</span> = <span class="ruby-identifier">parse_arity</span>(<span class="ruby-identifier">arity</span><span class="ruby-operator">||</span>{})
-    <span class="ruby-identifier">parse</span>
-  <span class="ruby-keyword kw">end</span>
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000418"></a><b>parameters</b>(*args)
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000418_source')" id="l_M000418_source">+</a> ]</p>
-  <div id="M000418_source" class="dyn-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/more/facets/argvector.rb, line 67</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">parameters</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
-    <span class="ruby-identifier">new</span>.<span class="ruby-identifier">parameters</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
-  <span class="ruby-keyword kw">end</span>
-</pre>
-  </div>
-</div>
-</div>
-<div class="sectiontitle">Public Instance methods</div>
-<div class="method">
-  <div class="title">
-    <a name="M000421"></a><b>arguments</b>()
-  </div>
-  <div class="description">
-  <p>
-Alias for <a href="Argvector.html#M000420">operands</a>
-</p>
-  </div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000424"></a><b>flags</b>()
-  </div>
-  <div class="description">
-  <p>
-Return <a href="Argvector.html#M000424">flags</a>, which are true <a
-href="Argvector.html#M000422">options</a>.
-</p>
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000424_source')" id="l_M000424_source">+</a> ]</p>
-  <div id="M000424_source" class="dyn-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/more/facets/argvector.rb, line 113</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">flags</span>
-    <span class="ruby-identifier">f</span> = []
-    <span class="ruby-ivar">@options</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
-      <span class="ruby-keyword kw">if</span> <span class="ruby-constant">TrueClass</span><span class="ruby-operator">===</span><span class="ruby-identifier">v</span> <span class="ruby-keyword kw">or</span> <span class="ruby-constant">FalseClass</span><span class="ruby-operator">===</span><span class="ruby-identifier">v</span>  <span class="ruby-comment cmt"># not that it's ever false</span>
-        <span class="ruby-identifier">f</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">k</span>
-      <span class="ruby-keyword kw">end</span>
-    <span class="ruby-keyword kw">end</span>
-    <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">f</span>
-  <span class="ruby-keyword kw">end</span>
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000420"></a><b>operands</b>()
-  </div>
-  <div class="description">
-  <p>
-Returns operand array.
-</p>
-  </div>
-<div class="aka">
-  This method is also aliased as
-  <a href="Argvector.html#M000421">arguments</a>
-</div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000420_source')" id="l_M000420_source">+</a> ]</p>
-  <div id="M000420_source" class="dyn-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/more/facets/argvector.rb, line 91</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">operands</span>
-    <span class="ruby-ivar">@operands</span>
-  <span class="ruby-keyword kw">end</span>
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000422"></a><b>options</b>()
-  </div>
-  <div class="description">
-  <p>
-Returns <a href="Argvector.html#M000422">options</a> hash.
-</p>
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000422_source')" id="l_M000422_source">+</a> ]</p>
-  <div id="M000422_source" class="dyn-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/more/facets/argvector.rb, line 100</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">options</span>
-    <span class="ruby-ivar">@options</span>
-  <span class="ruby-keyword kw">end</span>
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000423"></a><b>parameters</b>()
-  </div>
-  <div class="description">
-  <p>
-Returns [<a href="Argvector.html#M000420">operands</a>, <a
-href="Argvector.html#M000422">options</a>], which is good for plugging
-directly into a method.
-</p>
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000423_source')" id="l_M000423_source">+</a> ]</p>
-  <div id="M000423_source" class="dyn-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/more/facets/argvector.rb, line 107</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parameters</span>
-    <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@operands</span>, <span class="ruby-ivar">@options</span>
-  <span class="ruby-keyword kw">end</span>
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000431"></a><b>parameters_without_duplicates</b>()
-  </div>
-  <div class="description">
-  <p>
-Like <a href="Argvector.html#M000418">parameters</a> but without allowing
-for duplicate <a href="Argvector.html#M000422">options</a>.
-</p>
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000431_source')" id="l_M000431_source">+</a> ]</p>
-  <div id="M000431_source" class="dyn-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/more/facets/argvector.rb, line 188</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parameters_without_duplicates</span>
-    <span class="ruby-identifier">opts</span> = {}
-    <span class="ruby-ivar">@options</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
-      <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Array</span><span class="ruby-operator">===</span><span class="ruby-identifier">v</span>
-        <span class="ruby-identifier">opts</span>[<span class="ruby-identifier">k</span>] = <span class="ruby-identifier">v</span>[<span class="ruby-value">0</span>]
-      <span class="ruby-keyword kw">else</span>
-        <span class="ruby-identifier">opts</span>[<span class="ruby-identifier">k</span>] =  <span class="ruby-identifier">v</span>
-      <span class="ruby-keyword kw">end</span>
-    <span class="ruby-keyword kw">end</span>
-    <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@operands</span>, <span class="ruby-identifier">opts</span>
-  <span class="ruby-keyword kw">end</span>
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000430"></a><b>preflags</b>()
-  </div>
-  <div class="description">
-  <p>
-Same as <tt><a href="Argvector.html#M000424">flags</a></tt> but only
-returns <a href="Argvector.html#M000424">flags</a> in the <a
-href="Argvector.html#M000429">preoptions</a>.
-</p>
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000430_source')" id="l_M000430_source">+</a> ]</p>
-  <div id="M000430_source" class="dyn-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/more/facets/argvector.rb, line 175</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">preflags</span>
-    <span class="ruby-identifier">preopts</span>, <span class="ruby-identifier">remainder</span> = <span class="ruby-operator">*</span><span class="ruby-identifier">parse_preoptions</span>(<span class="ruby-identifier">argv</span>)
-    <span class="ruby-identifier">f</span> = []
-    <span class="ruby-identifier">preopts</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
-      <span class="ruby-keyword kw">if</span> <span class="ruby-constant">TrueClass</span><span class="ruby-operator">===</span><span class="ruby-identifier">v</span> <span class="ruby-keyword kw">or</span> <span class="ruby-constant">FalseClass</span><span class="ruby-operator">===</span><span class="ruby-identifier">v</span>  <span class="ruby-comment cmt"># not that it's ever false</span>
-        <span class="ruby-identifier">f</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">k</span>
-      <span class="ruby-keyword kw">end</span>
-    <span class="ruby-keyword kw">end</span>
-    <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">f</span>
-  <span class="ruby-keyword kw">end</span>
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000429"></a><b>preoptions</b>()
-  </div>
-  <div class="description">
-  <p>
-Returns a hash of <a href="Argvector.html#M000422">options</a> that occur
-before the first operand. This works well with <a
-href="Argvector.html#M000426">subcommand</a> to get the main
-command&#8216;s <a href="Argvector.html#M000422">options</a>.
-</p>
-<pre>
-  line = &quot;--trace stamp --file VERSION&quot;
-  cargs = Argvector.new(line)
-  opts = cargs.preoptions
-  opts #=&gt; {&quot;trace&quot;=&gt;true}
-</pre>
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000429_source')" id="l_M000429_source">+</a> ]</p>
-  <div id="M000429_source" class="dyn-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/more/facets/argvector.rb, line 167</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">preoptions</span>
-    <span class="ruby-identifier">preopts</span>, <span class="ruby-identifier">remainder</span> = <span class="ruby-operator">*</span><span class="ruby-identifier">parse_preoptions</span>(<span class="ruby-identifier">argv</span>)
-    <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">preopts</span>
-  <span class="ruby-keyword kw">end</span>
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000426"></a><b>subcommand</b>()
-  </div>
-  <div class="description">
-  <p>
-Alias for <a href="Argvector.html#M000425">subcommand_with_parameters</a>
-</p>
-  </div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000428"></a><b>subcommand_with_arguments</b>()
-  </div>
-  <div class="description">
-  <p>
-Assumes the first operand is a &quot;<a
-href="Argvector.html#M000426">subcommand</a>&quot; and returns it and the
-argments following it as another Arguments object.
-</p>
-<p>
-TODO: This probably should be called &#8216;<a
-href="Argvector.html#M000426">subcommand</a>&#8217;.
-</p>
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000428_source')" id="l_M000428_source">+</a> ]</p>
-  <div id="M000428_source" class="dyn-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/more/facets/argvector.rb, line 151</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">subcommand_with_arguments</span>
-    <span class="ruby-identifier">opts</span>, <span class="ruby-identifier">args</span> = <span class="ruby-operator">*</span><span class="ruby-identifier">parse_preoptions</span>(<span class="ruby-identifier">argv</span>)
-    <span class="ruby-identifier">cmd</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">shift</span>
-    <span class="ruby-identifier">subargs</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">args</span>, <span class="ruby-ivar">@arity</span>)
-    <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">cmd</span>, <span class="ruby-identifier">subargs</span>
-  <span class="ruby-keyword kw">end</span>
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000425"></a><b>subcommand_with_parameters</b>()
-  </div>
-  <div class="description">
-  <p>
-Assumes the first operand is a &quot;<a
-href="Argvector.html#M000426">subcommand</a>&quot; and returns it and the
-argments following it as <a href="Argvector.html#M000418">parameters</a>.
-</p>
-  </div>
-<div class="aka">
-  This method is also aliased as
-  <a href="Argvector.html#M000426">subcommand</a>
-</div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000425_source')" id="l_M000425_source">+</a> ]</p>
-  <div id="M000425_source" class="dyn-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/more/facets/argvector.rb, line 127</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">subcommand_with_parameters</span>
-    <span class="ruby-identifier">opts</span>, <span class="ruby-identifier">args</span> = <span class="ruby-operator">*</span><span class="ruby-identifier">parse_preoptions</span>(<span class="ruby-identifier">argv</span>)
-    <span class="ruby-identifier">cmd</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">shift</span>
-    <span class="ruby-identifier">subargs</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">args</span>, <span class="ruby-ivar">@arity</span>)
-    <span class="ruby-keyword kw">return</span> [<span class="ruby-identifier">cmd</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">subargs</span>.<span class="ruby-identifier">parameters</span>]
-  <span class="ruby-keyword kw">end</span>
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000427"></a><b>subcommand_with_preoptions</b>()
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000427_source')" id="l_M000427_source">+</a> ]</p>
-  <div id="M000427_source" class="dyn-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/more/facets/argvector.rb, line 137</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">subcommand_with_preoptions</span>
-    <span class="ruby-identifier">pre</span>, <span class="ruby-identifier">args</span> = <span class="ruby-operator">*</span><span class="ruby-identifier">parse_preoptions</span>(<span class="ruby-identifier">argv</span>)
-    <span class="ruby-identifier">cmd</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">shift</span>
-    <span class="ruby-identifier">subargs</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">args</span>, <span class="ruby-ivar">@arity</span>)
-    <span class="ruby-identifier">args</span>, <span class="ruby-identifier">opts</span> = <span class="ruby-operator">*</span><span class="ruby-identifier">subargs</span>.<span class="ruby-identifier">parameters</span>
-    <span class="ruby-keyword kw">return</span> [<span class="ruby-identifier">cmd</span>, <span class="ruby-identifier">args</span>, <span class="ruby-identifier">pre</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">opts</span>)]
-  <span class="ruby-keyword kw">end</span>
-</pre>
-  </div>
-</div>
-</div>
-</div>
-  </div>
-    </body>
-</html>