RubyGems - facets - Versions diffs - 1.4.0 → 1.4.1 - Mend

facets 1.4.0 → 1.4.1

Files changed (1260) hide show

data/web/doc/api/core/classes/Regexp.html ADDED Viewed

@@ -0,0 +1,185 @@
+<?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: Regexp</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 = "show source"
+          }
+          else
+          {
+            elem.style.display = "block"
+            link.innerHTML = "hide source"
+          }
+        }
+        function openCode( url )
+        {
+          window.open( url, "SOURCE_CODE", "width=400,height=400,scrollbars=yes" )
+        }
+      // ]]>
+    </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 />Regexp</td>
+  <td align="right">
+    <table cellspacing=0 cellpadding=2>
+      <tr valign="top">
+        <td>In:</td>
+        <td>
+<a href="../files/lib/facets/core/regexp/to_regexp_rb.html">lib/facets/core/regexp/to_regexp.rb</a>
+<a href="../files/lib/facets/core/regexp/to_re_rb.html">lib/facets/core/regexp/to_re.rb</a>
+<a href="../files/lib/facets/core/regexp/arity_rb.html">lib/facets/core/regexp/arity.rb</a>
+        </td>
+      </tr>
+    <tr>
+      <td>Parent:</td>
+      <td>
+        <a href="Object.html">
+Object
+         </a>
+     </td>
+   </tr>
+         </table>
+        </td>
+        </tr>
+      </table>
+ <!-- banner header -->
+  <div id="bodyContent">
+      <div id="content">
+  <div class="sectiontitle">Methods</div>
+  <ul>
+  <li><a href="#M000042">arity</a></li>
+  <li><a href="#M000041">to_re</a></li>
+  <li><a href="#M000040">to_regexp</a></li>
+  </ul>
+<div class="sectiontitle">Public Instance methods</div>
+<div class="method">
+  <div class="title">
+    <a name="M000042"></a><b>arity</b>()
+  </div>
+  <div class="description">
+  <p>
+Returns the number of backreferencing subexpressions.
+</p>
+<pre>
+  /(a)(b)(c)/.arity  #=&gt; 3
+  /(a(b(c)))/.arity  #=&gt; 3
+</pre>
+<p>
+Note: This is not perfect, especially with regards to \x and embedded
+comments.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000042_source')" id="l_M000042_source">show source</a> ]</p>
+  <div id="M000042_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/regexp/arity.rb, line 9</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">arity</span>
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">source</span>.<span class="ruby-identifier">scan</span>( <span class="ruby-regexp re">/(?!\\)[(](?!\?[#=:!&gt;-imx])/</span> ).<span class="ruby-identifier">length</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000041"></a><b>to_re</b>( esc=false )
+  </div>
+  <div class="description">
+  <p>
+Simply returns itself. Helpful when converting strings to regular
+expressions, where regexp might occur as well &#8212;in the same vien as
+using to_s on symbols. The parameter is actaully a dummy parameter to
+coincide with <a href="String.html#M000339">String#to_re</a>.
+</p>
+<pre>
+  /abc/.to_re  #=&gt; /abc/
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000041_source')" id="l_M000041_source">show source</a> ]</p>
+  <div id="M000041_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/regexp/to_re.rb, line 11</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_re</span>( <span class="ruby-identifier">esc</span>=<span class="ruby-keyword kw">false</span> )
+    <span class="ruby-keyword kw">self</span>  <span class="ruby-comment cmt"># Of course, things really should know how to say &quot;I&quot; ;)</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000040"></a><b>to_regexp</b>()
+  </div>
+  <div class="description">
+  <p>
+Like <a href="Regexp.html#M000041">to_re</a>, but following Ruby&#8217;s
+formal definitions, only a Regular expression type object will respond to
+this.
+</p>
+<p>
+Note: To be of much real use this should be defined in core Ruby.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000040_source')" id="l_M000040_source">show source</a> ]</p>
+  <div id="M000040_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/regexp/to_regexp.rb, line 8</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_regexp</span>
+    <span class="ruby-keyword kw">self</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+</div>
+  </div>
+    </body>
+</html>

data/web/doc/api/core/classes/ScriptBug.html ADDED Viewed

@@ -0,0 +1,92 @@
+<?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: ScriptBug</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 = "show source"
+          }
+          else
+          {
+            elem.style.display = "block"
+            link.innerHTML = "hide source"
+          }
+        }
+        function openCode( url )
+        {
+          window.open( url, "SOURCE_CODE", "width=400,height=400,scrollbars=yes" )
+        }
+      // ]]>
+    </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 />ScriptBug</td>
+  <td align="right">
+    <table cellspacing=0 cellpadding=2>
+      <tr valign="top">
+        <td>In:</td>
+        <td>
+<a href="../files/lib/facets/core/kernel/bug_rb.html">lib/facets/core/kernel/bug.rb</a>
+        </td>
+      </tr>
+    <tr>
+      <td>Parent:</td>
+      <td>
+Exception
+     </td>
+   </tr>
+         </table>
+        </td>
+        </tr>
+      </table>
+ <!-- banner header -->
+  <div id="bodyContent">
+      <div id="content">
+</div>
+  </div>
+    </body>
+</html>

data/web/doc/api/core/classes/String.html ADDED Viewed

@@ -0,0 +1,3286 @@
+<?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: String</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 = "show source"
+          }
+          else
+          {
+            elem.style.display = "block"
+            link.innerHTML = "hide source"
+          }
+        }
+        function openCode( url )
+        {
+          window.open( url, "SOURCE_CODE", "width=400,height=400,scrollbars=yes" )
+        }
+      // ]]>
+    </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 />String</td>
+  <td align="right">
+    <table cellspacing=0 cellpadding=2>
+      <tr valign="top">
+        <td>In:</td>
+        <td>
+<a href="../files/lib/facets/core/enumerable/entropy_rb.html">lib/facets/core/enumerable/entropy.rb</a>
+<a href="../files/lib/facets/core/string/pull_rb.html">lib/facets/core/string/pull.rb</a>
+<a href="../files/lib/facets/core/string/push_rb.html">lib/facets/core/string/push.rb</a>
+<a href="../files/lib/facets/core/string/shift_rb.html">lib/facets/core/string/shift.rb</a>
+<a href="../files/lib/facets/core/string/dresner_rb.html">lib/facets/core/string/dresner.rb</a>
+<a href="../files/lib/facets/core/string/word_filter_rb.html">lib/facets/core/string/word_filter.rb</a>
+<a href="../files/lib/facets/core/string/unix_crypt_rb.html">lib/facets/core/string/unix_crypt.rb</a>
+<a href="../files/lib/facets/core/string/camelcase_rb.html">lib/facets/core/string/camelcase.rb</a>
+<a href="../files/lib/facets/core/string/humanize_rb.html">lib/facets/core/string/humanize.rb</a>
+<a href="../files/lib/facets/core/string/at_rb.html">lib/facets/core/string/at.rb</a>
+<a href="../files/lib/facets/core/string/margin_rb.html">lib/facets/core/string/margin.rb</a>
+<a href="../files/lib/facets/core/string/dequote_rb.html">lib/facets/core/string/dequote.rb</a>
+<a href="../files/lib/facets/core/string/word_wrap_rb.html">lib/facets/core/string/word_wrap.rb</a>
+<a href="../files/lib/facets/core/string/last_rb.html">lib/facets/core/string/last.rb</a>
+<a href="../files/lib/facets/core/string/unpack_rb.html">lib/facets/core/string/unpack.rb</a>
+<a href="../files/lib/facets/core/string/rand_index_rb.html">lib/facets/core/string/rand_index.rb</a>
+<a href="../files/lib/facets/core/string/nchar_rb.html">lib/facets/core/string/nchar.rb</a>
+<a href="../files/lib/facets/core/string/singular_rb.html">lib/facets/core/string/singular.rb</a>
+<a href="../files/lib/facets/core/string/brief_rb.html">lib/facets/core/string/brief.rb</a>
+<a href="../files/lib/facets/core/string/similarity_rb.html">lib/facets/core/string/similarity.rb</a>
+<a href="../files/lib/facets/core/string/rand_byte_rb.html">lib/facets/core/string/rand_byte.rb</a>
+<a href="../files/lib/facets/core/string/to_proc_rb.html">lib/facets/core/string/to_proc.rb</a>
+<a href="../files/lib/facets/core/string/blank_rb.html">lib/facets/core/string/blank.rb</a>
+<a href="../files/lib/facets/core/string/demodulize_rb.html">lib/facets/core/string/demodulize.rb</a>
+<a href="../files/lib/facets/core/string/to_date_rb.html">lib/facets/core/string/to_date.rb</a>
+<a href="../files/lib/facets/core/string/chars_rb.html">lib/facets/core/string/chars.rb</a>
+<a href="../files/lib/facets/core/string/pot_rb.html">lib/facets/core/string/pot.rb</a>
+<a href="../files/lib/facets/core/string/starts_with_rb.html">lib/facets/core/string/starts_with.rb</a>
+<a href="../files/lib/facets/core/string/first_char_rb.html">lib/facets/core/string/first_char.rb</a>
+<a href="../files/lib/facets/core/string/capitalized_rb.html">lib/facets/core/string/capitalized.rb</a>
+<a href="../files/lib/facets/core/string/bytes_rb.html">lib/facets/core/string/bytes.rb</a>
+<a href="../files/lib/facets/core/string/basename_rb.html">lib/facets/core/string/basename.rb</a>
+<a href="../files/lib/facets/core/string/downcase_rb.html">lib/facets/core/string/downcase.rb</a>
+<a href="../files/lib/facets/core/string/succ_rb.html">lib/facets/core/string/succ.rb</a>
+<a href="../files/lib/facets/core/string/probability_rb.html">lib/facets/core/string/probability.rb</a>
+<a href="../files/lib/facets/core/string/cmp_rb.html">lib/facets/core/string/cmp.rb</a>
+<a href="../files/lib/facets/core/string/whitespace_rb.html">lib/facets/core/string/whitespace.rb</a>
+<a href="../files/lib/facets/core/string/at_rand_rb.html">lib/facets/core/string/at_rand.rb</a>
+<a href="../files/lib/facets/core/string/first_rb.html">lib/facets/core/string/first.rb</a>
+<a href="../files/lib/facets/core/string/fold_rb.html">lib/facets/core/string/fold.rb</a>
+<a href="../files/lib/facets/core/string/camelize_rb.html">lib/facets/core/string/camelize.rb</a>
+<a href="../files/lib/facets/core/string/unbracket_rb.html">lib/facets/core/string/unbracket.rb</a>
+<a href="../files/lib/facets/core/string/range_rb.html">lib/facets/core/string/range.rb</a>
+<a href="../files/lib/facets/core/string/to_a_rb.html">lib/facets/core/string/to_a.rb</a>
+<a href="../files/lib/facets/core/string/to_b_rb.html">lib/facets/core/string/to_b.rb</a>
+<a href="../files/lib/facets/core/string/to_re_rb.html">lib/facets/core/string/to_re.rb</a>
+<a href="../files/lib/facets/core/string/last_char_rb.html">lib/facets/core/string/last_char.rb</a>
+<a href="../files/lib/facets/core/string/line_wrap_rb.html">lib/facets/core/string/line_wrap.rb</a>
+<a href="../files/lib/facets/core/string/align_center_rb.html">lib/facets/core/string/align_center.rb</a>
+<a href="../files/lib/facets/core/string/words_rb.html">lib/facets/core/string/words.rb</a>
+<a href="../files/lib/facets/core/string/indent_rb.html">lib/facets/core/string/indent.rb</a>
+<a href="../files/lib/facets/core/string/upcase_rb.html">lib/facets/core/string/upcase.rb</a>
+<a href="../files/lib/facets/core/string/format_rb.html">lib/facets/core/string/format.rb</a>
+<a href="../files/lib/facets/core/string/to_const_rb.html">lib/facets/core/string/to_const.rb</a>
+<a href="../files/lib/facets/core/string/pop_rb.html">lib/facets/core/string/pop.rb</a>
+<a href="../files/lib/facets/core/string/range_of_line_rb.html">lib/facets/core/string/range_of_line.rb</a>
+<a href="../files/lib/facets/core/string/frequency_rb.html">lib/facets/core/string/frequency.rb</a>
+<a href="../files/lib/facets/core/string/lowercase_rb.html">lib/facets/core/string/lowercase.rb</a>
+<a href="../files/lib/facets/core/string/to_time_rb.html">lib/facets/core/string/to_time.rb</a>
+<a href="../files/lib/facets/core/string/ordinal_rb.html">lib/facets/core/string/ordinal.rb</a>
+<a href="../files/lib/facets/core/string/shuffle_rb.html">lib/facets/core/string/shuffle.rb</a>
+<a href="../files/lib/facets/core/string/each_char_rb.html">lib/facets/core/string/each_char.rb</a>
+<a href="../files/lib/facets/core/string/unshift_rb.html">lib/facets/core/string/unshift.rb</a>
+<a href="../files/lib/facets/core/string/each_word_rb.html">lib/facets/core/string/each_word.rb</a>
+<a href="../files/lib/facets/core/string/bracket_rb.html">lib/facets/core/string/bracket.rb</a>
+<a href="../files/lib/facets/core/string/index_all_rb.html">lib/facets/core/string/index_all.rb</a>
+<a href="../files/lib/facets/core/string/quote_rb.html">lib/facets/core/string/quote.rb</a>
+<a href="../files/lib/facets/core/string/regesc_rb.html">lib/facets/core/string/regesc.rb</a>
+<a href="../files/lib/facets/core/string/soundex_rb.html">lib/facets/core/string/soundex.rb</a>
+<a href="../files/lib/facets/core/string/range_all_rb.html">lib/facets/core/string/range_all.rb</a>
+<a href="../files/lib/facets/core/string/mscan_rb.html">lib/facets/core/string/mscan.rb</a>
+<a href="../files/lib/facets/core/string/shatter_rb.html">lib/facets/core/string/shatter.rb</a>
+<a href="../files/lib/facets/core/string/underscore_rb.html">lib/facets/core/string/underscore.rb</a>
+<a href="../files/lib/facets/core/string/natcmp_rb.html">lib/facets/core/string/natcmp.rb</a>
+<a href="../files/lib/facets/core/string/lines_rb.html">lib/facets/core/string/lines.rb</a>
+<a href="../files/lib/facets/core/string/modulize_rb.html">lib/facets/core/string/modulize.rb</a>
+<a href="../files/lib/facets/core/string/pathize_rb.html">lib/facets/core/string/pathize.rb</a>
+<a href="../files/lib/facets/core/string/methodize_rb.html">lib/facets/core/string/methodize.rb</a>
+<a href="../files/lib/facets/core/string/shell_escape_rb.html">lib/facets/core/string/shell_escape.rb</a>
+<a href="../files/lib/facets/core/string/self/patterns_rb.html">lib/facets/core/string/self/patterns.rb</a>
+<a href="../files/lib/facets/core/string/self/rand_letter_rb.html">lib/facets/core/string/self/rand_letter.rb</a>
+<a href="../files/lib/facets/core/string/self/interpolate_rb.html">lib/facets/core/string/self/interpolate.rb</a>
+        </td>
+      </tr>
+    <tr>
+      <td>Parent:</td>
+      <td>
+        <a href="Object.html">
+Object
+         </a>
+     </td>
+   </tr>
+         </table>
+        </td>
+        </tr>
+      </table>
+ <!-- banner header -->
+  <div id="bodyContent">
+      <div id="content">
+  <div class="sectiontitle">Methods</div>
+  <ul>
+  <li><a href="#M000345">align_center</a></li>
+  <li><a href="#M000344">align_left</a></li>
+  <li><a href="#M000343">align_right</a></li>
+  <li><a href="#M000327">at_rand</a></li>
+  <li><a href="#M000328">at_rand!</a></li>
+  <li><a href="#M000321">basename</a></li>
+  <li><a href="#M000311">blank?</a></li>
+  <li><a href="#M000365">bra2ket</a></li>
+  <li><a href="#M000366">bracket</a></li>
+  <li><a href="#M000367">bracket!</a></li>
+  <li><a href="#M000305">brief</a></li>
+  <li><a href="#M000320">bytes</a></li>
+  <li><a href="#M000289">camelcase</a></li>
+  <li><a href="#M000333">camelize</a></li>
+  <li><a href="#M000319">capitalized?</a></li>
+  <li><a href="#M000314">chars</a></li>
+  <li><a href="#M000325">cmp</a></li>
+  <li><a href="#M000292">dequote</a></li>
+  <li><a href="#M000322">downcase?</a></li>
+  <li><a href="#M000283">dresner</a></li>
+  <li><a href="#M000284">dresner!</a></li>
+  <li><a href="#M000362">each_char</a></li>
+  <li><a href="#M000364">each_word</a></li>
+  <li><a href="#M000317">ends_with?</a></li>
+  <li><a href="#M000279">entropy</a></li>
+  <li><a href="#M000329">first</a></li>
+  <li><a href="#M000330">first!</a></li>
+  <li><a href="#M000331">first=</a></li>
+  <li><a href="#M000318">first_char</a></li>
+  <li><a href="#M000332">fold</a></li>
+  <li><a href="#M000352">format</a></li>
+  <li><a href="#M000386">format</a></li>
+  <li><a href="#M000356">frequency</a></li>
+  <li><a href="#M000307">fuzzy_match</a></li>
+  <li><a href="#M000290">humanize</a></li>
+  <li><a href="#M000349">indent</a></li>
+  <li><a href="#M000368">index_all</a></li>
+  <li><a href="#M000388">interpolate</a></li>
+  <li><a href="#M000295">last</a></li>
+  <li><a href="#M000297">last!</a></li>
+  <li><a href="#M000296">last=</a></li>
+  <li><a href="#M000341">last_char</a></li>
+  <li><a href="#M000342">line_wrap</a></li>
+  <li><a href="#M000378">lines</a></li>
+  <li><a href="#M000357">lowercase?</a></li>
+  <li><a href="#M000291">margin</a></li>
+  <li><a href="#M000381">methodize</a></li>
+  <li><a href="#M000379">modulize</a></li>
+  <li><a href="#M000374">mscan</a></li>
+  <li><a href="#M000377">natcmp</a></li>
+  <li><a href="#M000300">nchar</a></li>
+  <li><a href="#M000359">ordinal</a></li>
+  <li><a href="#M000380">pathize</a></li>
+  <li><a href="#M000383">patterns</a></li>
+  <li><a href="#M000302">plural</a></li>
+  <li><a href="#M000304">pluralize</a></li>
+  <li><a href="#M000354">pop</a></li>
+  <li><a href="#M000315">pot</a></li>
+  <li><a href="#M000324">probability</a></li>
+  <li><a href="#M000280">pull</a></li>
+  <li><a href="#M000281">push</a></li>
+  <li><a href="#M000369">quote</a></li>
+  <li><a href="#M000308">rand_byte</a></li>
+  <li><a href="#M000309">rand_byte!</a></li>
+  <li><a href="#M000299">rand_index</a></li>
+  <li><a href="#M000384">rand_letter</a></li>
+  <li><a href="#M000385">random</a></li>
+  <li><a href="#M000336">range</a></li>
+  <li><a href="#M000373">range_all</a></li>
+  <li><a href="#M000355">range_of_line</a></li>
+  <li><a href="#M000370">regesc</a></li>
+  <li><a href="#M000375">shatter</a></li>
+  <li><a href="#M000382">shell_escape</a></li>
+  <li><a href="#M000282">shift</a></li>
+  <li><a href="#M000360">shuffle</a></li>
+  <li><a href="#M000361">shuffle!</a></li>
+  <li><a href="#M000306">similarity</a></li>
+  <li><a href="#M000301">singular</a></li>
+  <li><a href="#M000303">singularize</a></li>
+  <li><a href="#M000371">soundex</a></li>
+  <li><a href="#M000372">soundex_code</a></li>
+  <li><a href="#M000387">sprintf</a></li>
+  <li><a href="#M000316">starts_with?</a></li>
+  <li><a href="#M000323">succ</a></li>
+  <li><a href="#M000347">tab</a></li>
+  <li><a href="#M000348">tabto</a></li>
+  <li><a href="#M000337">to_a</a></li>
+  <li><a href="#M000338">to_b</a></li>
+  <li><a href="#M000353">to_const</a></li>
+  <li><a href="#M000313">to_date</a></li>
+  <li><a href="#M000310">to_proc</a></li>
+  <li><a href="#M000339">to_re</a></li>
+  <li><a href="#M000340">to_rx</a></li>
+  <li><a href="#M000358">to_time</a></li>
+  <li><a href="#M000334">unbracket</a></li>
+  <li><a href="#M000335">unbracket!</a></li>
+  <li><a href="#M000376">underscore</a></li>
+  <li><a href="#M000287">unix_crypt</a></li>
+  <li><a href="#M000288">unix_crypt!</a></li>
+  <li><a href="#M000298">unpack</a></li>
+  <li><a href="#M000363">unshift</a></li>
+  <li><a href="#M000350">upcase?</a></li>
+  <li><a href="#M000351">uppercase?</a></li>
+  <li><a href="#M000312">whitespace?</a></li>
+  <li><a href="#M000326">whitespace?</a></li>
+  <li><a href="#M000285">word_filter</a></li>
+  <li><a href="#M000286">word_filter!</a></li>
+  <li><a href="#M000293">word_wrap</a></li>
+  <li><a href="#M000294">word_wrap!</a></li>
+  <li><a href="#M000346">words</a></li>
+  </ul>
+  <div class="sectiontitle">Constants</div>
+  <table border='0' cellpadding='5'>
+  <tr valign='top'>
+    <td class="attr-name">SINGULAR_RULES</td>
+    <td>=</td>
+    <td class="attr-value">[     [/(matr)ices$/i, '\1ix'],     [/(vert)ices$/i, '\1ex'],     [/^(ox)en/i, '\1'],     [/(alias)es$/i, '\1'],     [/([octop|vir])i$/i, '\1us'],     [/(cris|ax|test)es$/i, '\1is'],     [/(shoe)s$/i, '\1'],     [/(o)es$/i, '\1'],     [/(bus)es$/i, '\1'],     [/([m|l])ice$/i, '\1ouse'],     [/(x|ch|ss|sh)es$/i, '\1'],     [/(m)ovies$/i, '\1\2ovie'],     [/(s)eries$/i, '\1\2eries'],     [/([^aeiouy]|qu)ies$/i, '\1y'],     [/([lr])ves$/i, '\1f'],     [/(tive)s$/i, '\1'],     [/(hive)s$/i, '\1'],     [/([^f])ves$/i, '\1fe'],     [/(^analy)ses$/i, '\1sis'],     [/((a)naly|(b)a|(d)iagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)ses$/i, '\1\2sis'],     [/([ti])a$/i, '\1um'],     [/(p)eople$/i, '\1\2erson'],     [/(m)en$/i, '\1an'],     [/(s)tatus$/i, '\1\2tatus'],     [/(c)hildren$/i, '\1\2hild'],     [/(n)ews$/i, '\1\2ews'],     [/s$/i, '']</td>
+  </tr>
+  <tr valign='top'>
+    <td class="attr-name">PLURAL_RULES</td>
+    <td>=</td>
+    <td class="attr-value">[     [/^(ox)$/i, '\1\2en'],                 # ox     [/([m|l])ouse$/i, '\1ice'],            # mouse, louse     [/(matr|vert)ix|ex$/i, '\1ices'],      # matrix, vertex, index     [/(x|ch|ss|sh)$/i, '\1es'],            # search, switch, fix, box, process, address     [/([^aeiouy]|qu)ies$/i, '\1y'],     [/([^aeiouy]|qu)y$/i, '\1ies'],        # query, ability, agency     [/(hive)$/i, '\1s'],                   # archive, hive     [/(?:([^f])fe|([lr])f)$/i, '\1\2ves'], # half, safe, wife     [/sis$/i, 'ses'],                      # basis, diagnosis     [/([ti])um$/i, '\1a'],                 # datum, medium     [/(p)erson$/i, '\1eople'],             # person, salesperson     [/(m)an$/i, '\1en'],                   # man, woman, spokesman     [/(c)hild$/i, '\1hildren'],            # child     [/(buffal|tomat|potat)o$/i, '\1\2oes'],      # buffalo, tomato     [/(bu)s$/i, '\1\2ses'],                # bus     [/(alias)/i, '\1es'],                  # alias     [/(octop|vir)us$/i, '\1i'],            # octopus, virus - virus has no defined plural, but viri is better than viruses/viruss     [/(ax|cri|test)is$/i, '\1es'],         # axis, crisis       [/s$/i, 's'],                          # no change (compatibility)     [/$/, 's']</td>
+  </tr>
+  </table>
+<div class="sectiontitle">Public Class methods</div>
+<div class="method">
+  <div class="title">
+    <a name="M000365"></a><b>bra2ket</b>()
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000365_source')" id="l_M000365_source">show source</a> ]</p>
+  <div id="M000365_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/bracket.rb, line 4</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">bra2ket</span>
+    <span class="ruby-ivar">@bra2ket</span> <span class="ruby-operator">||=</span> { <span class="ruby-value str">'['</span>=<span class="ruby-operator">&gt;</span><span class="ruby-value str">']'</span>, <span class="ruby-value str">'('</span>=<span class="ruby-operator">&gt;</span><span class="ruby-value str">')'</span>, <span class="ruby-value str">'{'</span>=<span class="ruby-operator">&gt;</span><span class="ruby-value str">'}'</span>, <span class="ruby-value str">'&lt;'</span>=<span class="ruby-operator">&gt;</span><span class="ruby-value str">'&gt;'</span> }
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000386"></a><b>format</b>(*args)
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000386_source')" id="l_M000386_source">show source</a> ]</p>
+  <div id="M000386_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/self/format.rb, line 2</span>
+<span class="ruby-keyword kw">def</span> <span class="ruby-constant">String</span>.<span class="ruby-identifier">format</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
+  <span class="ruby-constant">Kernel</span>.<span class="ruby-identifier">format</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="method">
+  <div class="title">
+    <a name="M000388"></a><b>interpolate</b>(&amp;str)
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000388_source')" id="l_M000388_source">show source</a> ]</p>
+  <div id="M000388_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/self/interpolate.rb, line 4</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">interpolate</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">str</span>)
+    <span class="ruby-identifier">eval</span> <span class="ruby-node">&quot;%{#{str.call}}&quot;</span>, <span class="ruby-identifier">str</span>.<span class="ruby-identifier">binding</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000383"></a><b>patterns</b>( pattern )
+  </div>
+  <div class="description">
+  <p>
+Returns a <a href="Regexp.html">Regexp</a> pattern based on the given
+pattern string or symbolic name.
+</p>
+<p>
+Recognized names are:
+</p>
+<ul>
+<li>:char
+</li>
+<li>:word
+</li>
+<li>:line
+</li>
+</ul>
+<p>
+They are also recognizied in plural form.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000383_source')" id="l_M000383_source">show source</a> ]</p>
+  <div id="M000383_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/self/patterns.rb, line 14</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">patterns</span>( <span class="ruby-identifier">pattern</span> )
+    <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">pattern</span>
+    <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:char</span>, <span class="ruby-identifier">:chars</span>, <span class="ruby-identifier">:character</span>, <span class="ruby-identifier">:characters</span>
+      <span class="ruby-identifier">pattern</span> = <span class="ruby-regexp re">//</span>
+    <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:word</span>, <span class="ruby-identifier">:words</span>
+      <span class="ruby-identifier">pattern</span> = <span class="ruby-regexp re">/\s+|\Z/</span>
+    <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:line</span>, <span class="ruby-identifier">:lines</span>
+      <span class="ruby-identifier">pattern</span> = <span class="ruby-regexp re">/\Z/</span>
+    <span class="ruby-keyword kw">when</span> <span class="ruby-constant">String</span>
+      <span class="ruby-identifier">pattern</span> = <span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">escape</span>(<span class="ruby-identifier">pattern</span>))
+    <span class="ruby-keyword kw">end</span>
+    <span class="ruby-identifier">pattern</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000384"></a><b>rand_letter</b>()
+  </div>
+  <div class="description">
+  <p>
+<a href="Module.html">Module</a> method to generate a random letter.
+</p>
+<pre>
+  String::Random.rand_letter  #=&gt; &quot;q&quot;
+  String::Random.rand_letter  #=&gt; &quot;r&quot;
+  String::Random.rand_letter  #=&gt; &quot;a&quot;
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000384_source')" id="l_M000384_source">show source</a> ]</p>
+  <div id="M000384_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/self/rand_letter.rb, line 9</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">rand_letter</span>
+    (<span class="ruby-identifier">rand</span>(<span class="ruby-value">26</span>) <span class="ruby-operator">+</span> (<span class="ruby-identifier">rand</span>(<span class="ruby-value">2</span>) <span class="ruby-operator">==</span> <span class="ruby-value">0</span> <span class="ruby-operator">?</span> <span class="ruby-value">65</span> <span class="ruby-operator">:</span> <span class="ruby-value">97</span>) ).<span class="ruby-identifier">chr</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000385"></a><b>random</b>(max_length = 8, char_re = /[\w\d]/)
+  </div>
+  <div class="description">
+  <p>
+Returns a randomly generated string. One possible use is password
+initialization. Takes a max legnth of characters (default 8) and an
+optional valid char <a href="Regexp.html">Regexp</a> (default /\w\d/).
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000385_source')" id="l_M000385_source">show source</a> ]</p>
+  <div id="M000385_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/self/random.rb, line 14</span>
+<span class="ruby-keyword kw">def</span> <span class="ruby-constant">String</span>.<span class="ruby-identifier">random</span>(<span class="ruby-identifier">max_length</span> = <span class="ruby-value">8</span>, <span class="ruby-identifier">char_re</span> = <span class="ruby-regexp re">/[\w\d]/</span>)
+  <span class="ruby-comment cmt"># gmosx: this is a nice example of input parameter checking.</span>
+  <span class="ruby-comment cmt"># this is NOT a real time called method so we can add this</span>
+  <span class="ruby-comment cmt"># check. Congrats to the author.</span>
+  <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'char_re must be a regular expression!'</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">char_re</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Regexp</span>)
+  <span class="ruby-identifier">string</span> = <span class="ruby-value str">&quot;&quot;</span>
+  <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">string</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">&lt;</span> <span class="ruby-identifier">max_length</span>
+      <span class="ruby-identifier">ch</span> = <span class="ruby-identifier">rand</span>(<span class="ruby-value">255</span>).<span class="ruby-identifier">chr</span>
+      <span class="ruby-identifier">string</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">ch</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">ch</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">char_re</span>
+  <span class="ruby-keyword kw">end</span>
+  <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">string</span>
+<span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000372"></a><b>soundex_code</b>(character)
+  </div>
+  <div class="description">
+  <p>
+Support function for <a href="String.html#M000371">String#soundex</a>.
+Returns code for a single character.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000372_source')" id="l_M000372_source">show source</a> ]</p>
+  <div id="M000372_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/soundex.rb, line 40</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-constant">String</span>.<span class="ruby-identifier">soundex_code</span>(<span class="ruby-identifier">character</span>)
+    <span class="ruby-identifier">character</span>.<span class="ruby-identifier">tr!</span> <span class="ruby-value str">&quot;AEIOUYWHBPFVCSKGJQXZDTLMNR&quot;</span>, <span class="ruby-value str">&quot;00000000111122222222334556&quot;</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000387"></a><b>sprintf</b>(*args)
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000387_source')" id="l_M000387_source">show source</a> ]</p>
+  <div id="M000387_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/self/format.rb, line 6</span>
+<span class="ruby-keyword kw">def</span> <span class="ruby-constant">String</span>.<span class="ruby-identifier">sprintf</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
+  <span class="ruby-constant">Kernel</span>.<span class="ruby-identifier">format</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="M000345"></a><b>align_center</b>( n, sep=&quot;\n&quot;, c=' ' )
+  </div>
+  <div class="description">
+  <p>
+Centers each line of a string.
+</p>
+<pre>
+  s = &lt;&lt;-EOS
+  This is a test
+  and
+  so on
+  EOS
+  puts s.align_center(14)
+</pre>
+<p>
+<em>produces</em>
+</p>
+<pre>
+  This is a test
+       and
+      so on
+</pre>
+<p>
+Align a string to the center. The defualt alignment seperation is a new
+line (&quot;/n&quot;) This can be changed as can be the padding string
+which defaults to a single space (&#8217; &#8217;).
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000345_source')" id="l_M000345_source">show source</a> ]</p>
+  <div id="M000345_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/align_center.rb, line 47</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">align_center</span>( <span class="ruby-identifier">n</span>, <span class="ruby-identifier">sep</span>=<span class="ruby-value str">&quot;\n&quot;</span>, <span class="ruby-identifier">c</span>=<span class="ruby-value str">' '</span> )
+    <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">center</span>(<span class="ruby-identifier">n</span>.<span class="ruby-identifier">to_i</span>,<span class="ruby-identifier">c</span>.<span class="ruby-identifier">to_s</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">sep</span><span class="ruby-operator">==</span><span class="ruby-keyword kw">nil</span>
+    <span class="ruby-identifier">q</span> = <span class="ruby-identifier">split</span>(<span class="ruby-identifier">sep</span>.<span class="ruby-identifier">to_s</span>).<span class="ruby-identifier">collect</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
+      <span class="ruby-identifier">line</span>.<span class="ruby-identifier">center</span>(<span class="ruby-identifier">n</span>.<span class="ruby-identifier">to_i</span>,<span class="ruby-identifier">c</span>.<span class="ruby-identifier">to_s</span>)
+    }
+    <span class="ruby-identifier">q</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">sep</span>.<span class="ruby-identifier">to_s</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000344"></a><b>align_left</b>( n, sep=&quot;\n&quot;, c=' ' )
+  </div>
+  <div class="description">
+  <p>
+Align a string to the left. The defualt alignment seperation is a new line
+(&quot;/n&quot;) This can be changes as can be the padding string which
+defaults to a single space (&#8217; &#8217;).
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000344_source')" id="l_M000344_source">show source</a> ]</p>
+  <div id="M000344_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/align_center.rb, line 20</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">align_left</span>( <span class="ruby-identifier">n</span>, <span class="ruby-identifier">sep</span>=<span class="ruby-value str">&quot;\n&quot;</span>, <span class="ruby-identifier">c</span>=<span class="ruby-value str">' '</span> )
+    <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">ljust</span>(<span class="ruby-identifier">n</span>.<span class="ruby-identifier">to_i</span>,<span class="ruby-identifier">c</span>.<span class="ruby-identifier">to_s</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">sep</span><span class="ruby-operator">==</span><span class="ruby-keyword kw">nil</span>
+    <span class="ruby-identifier">q</span> = <span class="ruby-identifier">split</span>(<span class="ruby-identifier">sep</span>.<span class="ruby-identifier">to_s</span>).<span class="ruby-identifier">collect</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
+      <span class="ruby-identifier">line</span>.<span class="ruby-identifier">ljust</span>(<span class="ruby-identifier">n</span>.<span class="ruby-identifier">to_i</span>,<span class="ruby-identifier">c</span>.<span class="ruby-identifier">to_s</span>)
+    }
+    <span class="ruby-identifier">q</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">sep</span>.<span class="ruby-identifier">to_s</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000343"></a><b>align_right</b>( n, sep=&quot;\n&quot;, c=' ' )
+  </div>
+  <div class="description">
+  <p>
+Align a string to the right. The defualt alignment seperation is a new line
+(&quot;/n&quot;) This can be changes as can be the padding string which
+defaults to a single space (&#8217; &#8217;).
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000343_source')" id="l_M000343_source">show source</a> ]</p>
+  <div id="M000343_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/align_center.rb, line 8</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">align_right</span>( <span class="ruby-identifier">n</span>, <span class="ruby-identifier">sep</span>=<span class="ruby-value str">&quot;\n&quot;</span>, <span class="ruby-identifier">c</span>=<span class="ruby-value str">' '</span> )
+    <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">rjust</span>(<span class="ruby-identifier">n</span>.<span class="ruby-identifier">to_i</span>,<span class="ruby-identifier">c</span>.<span class="ruby-identifier">to_s</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">sep</span><span class="ruby-operator">==</span><span class="ruby-keyword kw">nil</span>
+    <span class="ruby-identifier">q</span> = <span class="ruby-identifier">split</span>(<span class="ruby-identifier">sep</span>.<span class="ruby-identifier">to_s</span>).<span class="ruby-identifier">collect</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
+      <span class="ruby-identifier">line</span>.<span class="ruby-identifier">rjust</span>(<span class="ruby-identifier">n</span>.<span class="ruby-identifier">to_i</span>,<span class="ruby-identifier">c</span>.<span class="ruby-identifier">to_s</span>)
+    }
+    <span class="ruby-identifier">q</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">sep</span>.<span class="ruby-identifier">to_s</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000327"></a><b>at_rand</b>( separator=// )
+  </div>
+  <div class="description">
+  <p>
+Return a random separation of the string. Default separation is by
+charaacter.
+</p>
+<pre>
+  &quot;Ruby rules&quot;.at_rand(' ')  #=&gt; [&quot;Ruby&quot;]
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000327_source')" id="l_M000327_source">show source</a> ]</p>
+  <div id="M000327_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/at_rand.rb, line 13</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">at_rand</span>( <span class="ruby-identifier">separator</span>=<span class="ruby-regexp re">//</span> )
+    <span class="ruby-identifier">separator</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">patterns</span>( <span class="ruby-identifier">separator</span> )
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">split</span>(<span class="ruby-identifier">separator</span>,<span class="ruby-value">-1</span>).<span class="ruby-identifier">at_rand</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000328"></a><b>at_rand!</b>( separator=// )
+  </div>
+  <div class="description">
+  <p>
+Return a random separation while removing it from the string. Default
+separation is by character.
+</p>
+<pre>
+  s = &quot;Ruby rules&quot;
+  s = at_rand!(' ')  #=&gt; &quot;Ruby&quot;
+  s                  #=&gt; &quot;rules&quot;
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000328_source')" id="l_M000328_source">show source</a> ]</p>
+  <div id="M000328_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/at_rand.rb, line 25</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">at_rand!</span>( <span class="ruby-identifier">separator</span>=<span class="ruby-regexp re">//</span> )
+    <span class="ruby-identifier">separator</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">patterns</span>( <span class="ruby-identifier">separator</span> )
+    <span class="ruby-identifier">a</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">shatter</span>( <span class="ruby-identifier">separator</span> )
+    <span class="ruby-identifier">w</span> = []; <span class="ruby-identifier">a</span>.<span class="ruby-identifier">each_with_index</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">s</span>,<span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-identifier">i</span> <span class="ruby-operator">%</span> <span class="ruby-value">2</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">w</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">s</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">w</span>.<span class="ruby-identifier">last</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">s</span> }
+    <span class="ruby-identifier">i</span> = <span class="ruby-identifier">rand</span>( <span class="ruby-identifier">w</span>.<span class="ruby-identifier">size</span> )
+    <span class="ruby-identifier">r</span> = <span class="ruby-identifier">w</span>.<span class="ruby-identifier">delete_at</span>( <span class="ruby-identifier">i</span> )
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">replace</span>( <span class="ruby-identifier">w</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">''</span>) )
+    <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">r</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000321"></a><b>basename</b>()
+  </div>
+  <div class="description">
+  <p>
+Removes prepend module namespace.
+</p>
+<pre>
+  &quot;Test::Unit&quot;.basename  #=&gt; &quot;Unit&quot;
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000321_source')" id="l_M000321_source">show source</a> ]</p>
+  <div id="M000321_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/basename.rb, line 8</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">basename</span>
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/^.*::/</span>, <span class="ruby-value str">''</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000311"></a><b>blank?</b>()
+  </div>
+  <div class="description">
+  <p>
+Is this string just whitespace?
+</p>
+<pre>
+  &quot;abc&quot;.blank?  #=&gt; false
+  &quot;   &quot;.blank?  #=&gt; true
+</pre>
+  </div>
+<div class="aka">
+  This method is also aliased as
+  <a href="String.html#M000312">whitespace?</a>
+  <a href="String.html#M000326">whitespace?</a>
+</div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000311_source')" id="l_M000311_source">show source</a> ]</p>
+  <div id="M000311_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/blank.rb, line 9</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">blank?</span>
+    <span class="ruby-keyword kw">self</span> <span class="ruby-operator">!~</span> <span class="ruby-regexp re">/\S/</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000366"></a><b>bracket</b>(bra, ket=nil)
+  </div>
+  <div class="description">
+  <p>
+Return a new string embraced by given brakets. If only one bracket char is
+given it will be placed on either side.
+</p>
+<pre>
+  &quot;wrap me&quot;.bracket('{')        #=&gt; &quot;{wrap me}&quot;
+  &quot;wrap me&quot;.bracket('--','!')   #=&gt; &quot;--wrap me!&quot;
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000366_source')" id="l_M000366_source">show source</a> ]</p>
+  <div id="M000366_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/bracket.rb, line 15</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">bracket</span>(<span class="ruby-identifier">bra</span>, <span class="ruby-identifier">ket</span>=<span class="ruby-keyword kw">nil</span>)
+    <span class="ruby-comment cmt">#ket = String.bra2ket[$&amp;] if ! ket &amp;&amp; /^[\[({&lt;]$/ =~ bra</span>
+    <span class="ruby-identifier">ket</span> = <span class="ruby-constant">String</span>.<span class="ruby-identifier">bra2ket</span>[<span class="ruby-identifier">bra</span>] <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">ket</span>
+    <span class="ruby-node">&quot;#{bra}#{self}#{ket ? ket : bra}&quot;</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000367"></a><b>bracket!</b>(bra, ket=nil)
+  </div>
+  <div class="description">
+  <p>
+Inplace version of braket.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000367_source')" id="l_M000367_source">show source</a> ]</p>
+  <div id="M000367_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/bracket.rb, line 22</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">bracket!</span>(<span class="ruby-identifier">bra</span>, <span class="ruby-identifier">ket</span>=<span class="ruby-keyword kw">nil</span>)
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">replace</span>( <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">bracket</span>(<span class="ruby-identifier">bra</span>, <span class="ruby-identifier">ket</span>) )
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000305"></a><b>brief</b>(string, count = 128, force_cutoff = false, ellipsis=&quot;...&quot;)
+  </div>
+  <div class="description">
+  <p>
+Returns short abstract of long strings (first &#8216;count&#8217;
+characters, chopped at the nearest word, appended by &#8217;&#8230;&#8217;)
+force_cutoff: break forcibly at &#8216;count&#8217; chars. Does not accept
+count &lt; 2.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000305_source')" id="l_M000305_source">show source</a> ]</p>
+  <div id="M000305_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/brief.rb, line 10</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">brief</span>(<span class="ruby-identifier">string</span>, <span class="ruby-identifier">count</span> = <span class="ruby-value">128</span>, <span class="ruby-identifier">force_cutoff</span> = <span class="ruby-keyword kw">false</span>, <span class="ruby-identifier">ellipsis</span>=<span class="ruby-value str">&quot;...&quot;</span>)
+    <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">string</span>
+    <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">count</span> <span class="ruby-operator">&lt;</span> <span class="ruby-value">2</span>
+    <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">string</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">&gt;</span> <span class="ruby-identifier">count</span>
+      <span class="ruby-identifier">cut_at</span> = <span class="ruby-identifier">force_cutoff</span> <span class="ruby-value">? </span><span class="ruby-identifier">count</span> <span class="ruby-operator">:</span> (<span class="ruby-identifier">string</span>.<span class="ruby-identifier">index</span>(<span class="ruby-value str">' '</span>, <span class="ruby-identifier">count</span><span class="ruby-operator">-</span><span class="ruby-value">1</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">count</span>)
+      <span class="ruby-identifier">xstring</span> = <span class="ruby-identifier">string</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-value">0</span>, <span class="ruby-identifier">cut_at</span>)
+      <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">xstring</span>.<span class="ruby-identifier">chomp</span>(<span class="ruby-value str">&quot; &quot;</span>) <span class="ruby-operator">+</span> <span class="ruby-identifier">ellipsis</span>
+    <span class="ruby-keyword kw">else</span>
+      <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">string</span>
+    <span class="ruby-keyword kw">end</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000320"></a><b>bytes</b>()
+  </div>
+  <div class="description">
+  <p>
+Upacks string ginto bytes.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000320_source')" id="l_M000320_source">show source</a> ]</p>
+  <div id="M000320_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/bytes.rb, line 6</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">bytes</span>
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">unpack</span>(<span class="ruby-value str">'C*'</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000289"></a><b>camelcase</b>( first=false, on='_\s' )
+  </div>
+  <div class="description">
+  <p>
+Converts a string to camelcase. By default capitalization occurs on
+whitespace and underscores. By setting the first parameter to <tt>true</tt>
+the first character can also be captizlized. The second parameter can be
+assigned a valid Regualr Expression characeter set to determine which
+characters to match for capitalizing subsequent parts of the string.
+</p>
+<pre>
+  &quot;this_is a test&quot;.camelcase             #=&gt; &quot;thisIsATest&quot;
+  &quot;this_is a test&quot;.camelcase(true)       #=&gt; &quot;ThisIsATest&quot;
+  &quot;this_is a test&quot;.camelcase(true, ' ')  #=&gt; &quot;This_isATest&quot;
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000289_source')" id="l_M000289_source">show source</a> ]</p>
+  <div id="M000289_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/camelcase.rb, line 16</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">camelcase</span>( <span class="ruby-identifier">first</span>=<span class="ruby-keyword kw">false</span>, <span class="ruby-identifier">on</span>=<span class="ruby-value str">'_\s'</span> )
+    <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">first</span>
+      <span class="ruby-identifier">gsub</span>(<span class="ruby-node">/(^|[#{on}]+)([A-Za-z])/</span>){ <span class="ruby-identifier">$2</span>.<span class="ruby-identifier">upcase</span> }
+    <span class="ruby-keyword kw">else</span>
+      <span class="ruby-identifier">gsub</span>(<span class="ruby-node">/([#{on}]+)([A-Za-z])/</span>){ <span class="ruby-identifier">$2</span>.<span class="ruby-identifier">upcase</span> }
+    <span class="ruby-keyword kw">end</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000333"></a><b>camelize</b>()
+  </div>
+  <div class="description">
+  <p>
+Variation of coverting a string to camelcase. This is unlike <a
+href="String.html#M000289">camelcase</a> in that it is geared toward code
+reflection use.
+</p>
+<pre>
+  &quot;this/is_a_test&quot;.camelize  #=&gt; This::IsATest
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000333_source')" id="l_M000333_source">show source</a> ]</p>
+  <div id="M000333_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/camelize.rb, line 9</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">camelize</span>
+    <span class="ruby-comment cmt">#to_s.gsub(/(^|_)(.)/){$2.upcase}</span>
+    <span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/\/(.?)/</span>){ <span class="ruby-value str">&quot;::&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">$1</span>.<span class="ruby-identifier">upcase</span> }.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/(^|_)(.)/</span>){ <span class="ruby-identifier">$2</span>.<span class="ruby-identifier">upcase</span> }
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000319"></a><b>capitalized?</b>()
+  </div>
+  <div class="description">
+  <p>
+Return true if the string is capitalized, otherwise false.
+</p>
+<pre>
+  &quot;THIS&quot;.capitalized?  #=&gt; true
+  &quot;This&quot;.capitalized?  #=&gt; true
+  &quot;this&quot;.capitalized?  #=&gt; false
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000319_source')" id="l_M000319_source">show source</a> ]</p>
+  <div id="M000319_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/capitalized.rb, line 13</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">capitalized?</span>
+    <span class="ruby-keyword kw">self</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^[A-Z]/</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000314"></a><b>chars</b>()
+  </div>
+  <div class="description">
+  <p>
+Returns an array of characters.
+</p>
+<pre>
+  &quot;abc&quot;.chars  #=&gt; [&quot;a&quot;,&quot;b&quot;,&quot;c&quot;]
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000314_source')" id="l_M000314_source">show source</a> ]</p>
+  <div id="M000314_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/chars.rb, line 8</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">chars</span>
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp re">//</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000325"></a><b>cmp</b>(other)
+  </div>
+  <div class="description">
+  <p>
+Compare method that takes length into account. Unlike #&lt;=&gt;, this is
+compatible with <a href="String.html#M000323">succ</a>.
+</p>
+<pre>
+  &quot;abc&quot;.cmp(&quot;abc&quot;)   #=&gt;  0
+  &quot;abcd&quot;.cmp(&quot;abc&quot;)  #=&gt;  1
+  &quot;abc&quot;.cmp(&quot;abcd&quot;)  #=&gt; -1
+  &quot;xyz&quot;.cmp(&quot;abc&quot;)   #=&gt;  1
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000325_source')" id="l_M000325_source">show source</a> ]</p>
+  <div id="M000325_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/cmp.rb, line 12</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">cmp</span>(<span class="ruby-identifier">other</span>)
+    <span class="ruby-keyword kw">return</span> <span class="ruby-value">-1</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">length</span> <span class="ruby-operator">&lt;</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">length</span>
+    <span class="ruby-keyword kw">return</span> <span class="ruby-value">1</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">length</span> <span class="ruby-operator">&gt;</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">length</span>
+    <span class="ruby-keyword kw">self</span> <span class="ruby-operator">&lt;=&gt;</span> <span class="ruby-identifier">other</span>  <span class="ruby-comment cmt"># alphabetic compare</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000292"></a><b>dequote</b>()
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000292_source')" id="l_M000292_source">show source</a> ]</p>
+  <div id="M000292_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/dequote.rb, line 3</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">dequote</span>
+    <span class="ruby-identifier">s</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">dup</span>
+    <span class="ruby-keyword kw">case</span> <span class="ruby-keyword kw">self</span>[<span class="ruby-value">0</span>,<span class="ruby-value">1</span>]
+    <span class="ruby-keyword kw">when</span> <span class="ruby-value str">&quot;'&quot;</span>, <span class="ruby-value str">'&quot;'</span>, <span class="ruby-value str">'`'</span>
+      <span class="ruby-identifier">s</span>[<span class="ruby-value">0</span>] = <span class="ruby-value str">''</span>
+    <span class="ruby-keyword kw">end</span>
+    <span class="ruby-keyword kw">case</span> <span class="ruby-keyword kw">self</span>[<span class="ruby-value">-1</span>,<span class="ruby-value">1</span>]
+    <span class="ruby-keyword kw">when</span> <span class="ruby-value str">&quot;'&quot;</span>, <span class="ruby-value str">'&quot;'</span>, <span class="ruby-value str">'`'</span>
+      <span class="ruby-identifier">s</span>[<span class="ruby-value">-1</span>] = <span class="ruby-value str">''</span>
+    <span class="ruby-keyword kw">end</span>
+    <span class="ruby-identifier">s</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000322"></a><b>downcase?</b>()
+  </div>
+  <div class="description">
+  <p>
+Return true if the string is lowercase (downcase), otherwise false.
+</p>
+<pre>
+  &quot;THIS&quot;.downcase?  #=&gt; false
+  &quot;This&quot;.downcase?  #=&gt; false
+  &quot;this&quot;.downcase?  #=&gt; true
+</pre>
+  </div>
+<div class="aka">
+  This method is also aliased as
+  <a href="String.html#M000357">lowercase?</a>
+</div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000322_source')" id="l_M000322_source">show source</a> ]</p>
+  <div id="M000322_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/downcase.rb, line 12</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">downcase?</span>
+    <span class="ruby-identifier">downcase</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">self</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000283"></a><b>dresner</b>()
+  </div>
+  <div class="description">
+  <p>
+Scramble the inner characters of words leaving the text still readable
+(research at Cambridge University, code by KurtDresner).
+</p>
+<p>
+For example, the above text may result in:
+</p>
+<pre>
+  Srblamce the iennr cchrteaars of wodrs lvenaig the txet stlil rbeaadle
+  (rreceash at Cbamigdre Uverintisy, cdoe by KrneruestDr?)
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000283_source')" id="l_M000283_source">show source</a> ]</p>
+  <div id="M000283_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/dresner.rb, line 12</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">dresner</span>
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/\B\w+\B/</span>){<span class="ruby-identifier">$&amp;</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp re">//</span>).<span class="ruby-identifier">sort_by</span>{<span class="ruby-identifier">rand</span>}}
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000284"></a><b>dresner!</b>()
+  </div>
+  <div class="description">
+  <p>
+Inplace version of <a href="String.html#M000283">dresner</a> method.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000284_source')" id="l_M000284_source">show source</a> ]</p>
+  <div id="M000284_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/dresner.rb, line 18</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">dresner!</span>
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">replace</span>(<span class="ruby-identifier">dresner</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000362"></a><b>each_char</b>( {|| ...}
+  </div>
+  <div class="description">
+  <p>
+Iterates through each character.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000362_source')" id="l_M000362_source">show source</a> ]</p>
+  <div id="M000362_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/each_char.rb, line 5</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">each_char</span>  <span class="ruby-comment cmt"># :yield:</span>
+    <span class="ruby-identifier">split</span>(<span class="ruby-regexp re">//</span>).<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
+      <span class="ruby-keyword kw">yield</span>( <span class="ruby-identifier">c</span> )
+    }
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000364"></a><b>each_word</b>( &amp;yld )
+  </div>
+  <div class="description">
+  <p>
+Iterate through each word of a string.
+</p>
+<pre>
+  &quot;a string&quot;.each_word { |word, range| ... }
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000364_source')" id="l_M000364_source">show source</a> ]</p>
+  <div id="M000364_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/each_word.rb, line 8</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">each_word</span>( <span class="ruby-operator">&amp;</span><span class="ruby-identifier">yld</span> )
+    <span class="ruby-identifier">rest_of_string</span> = <span class="ruby-keyword kw">self</span>
+    <span class="ruby-identifier">wordfind</span> = <span class="ruby-regexp re">/([-'\w]+)/</span>
+    <span class="ruby-identifier">arity</span> = <span class="ruby-identifier">yld</span>.<span class="ruby-identifier">arity</span>
+    <span class="ruby-identifier">offset</span> = <span class="ruby-value">0</span>
+    <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">wmatch</span> = <span class="ruby-identifier">wordfind</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">rest_of_string</span>)
+      <span class="ruby-identifier">word</span> = <span class="ruby-identifier">wmatch</span>[<span class="ruby-value">0</span>]
+      <span class="ruby-identifier">range</span> = <span class="ruby-identifier">offset</span><span class="ruby-operator">+</span><span class="ruby-identifier">wmatch</span>.<span class="ruby-identifier">begin</span>(<span class="ruby-value">0</span>) <span class="ruby-operator">...</span> <span class="ruby-identifier">offset</span><span class="ruby-operator">+</span><span class="ruby-identifier">wmatch</span>.<span class="ruby-identifier">end</span>(<span class="ruby-value">0</span>)
+      <span class="ruby-identifier">rest_of_string</span> = <span class="ruby-identifier">wmatch</span>.<span class="ruby-identifier">post_match</span>
+      <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">arity</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
+        <span class="ruby-identifier">yld</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">word</span>)
+      <span class="ruby-keyword kw">else</span>
+        <span class="ruby-identifier">yld</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">word</span>, <span class="ruby-identifier">range</span>)
+      <span class="ruby-keyword kw">end</span>
+      <span class="ruby-identifier">offset</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">rest_of_string</span>.<span class="ruby-identifier">length</span>
+    <span class="ruby-keyword kw">end</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000317"></a><b>ends_with?</b>(str)
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000317_source')" id="l_M000317_source">show source</a> ]</p>
+  <div id="M000317_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/starts_with.rb, line 11</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">ends_with?</span>(<span class="ruby-identifier">str</span>)
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">rindex</span>( <span class="ruby-identifier">str</span> ) <span class="ruby-operator">==</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">length</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000279"></a><b>entropy</b>()
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000279_source')" id="l_M000279_source">show source</a> ]</p>
+  <div id="M000279_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/enumerable/entropy.rb, line 27</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">entropy</span>
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp re">//</span>).<span class="ruby-identifier">entropy</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000329"></a><b>first</b>(separator_pattern=//)
+  </div>
+  <div class="description">
+  <p>
+Returns the first separation of a string. Default seperation is by
+character.
+</p>
+<pre>
+  &quot;Hello World&quot;.first       #=&gt; &quot;H&quot;
+  &quot;Hello World&quot;.first(' ')  #=&gt; &quot;Hello&quot;
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000329_source')" id="l_M000329_source">show source</a> ]</p>
+  <div id="M000329_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/first.rb, line 14</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">first</span>(<span class="ruby-identifier">separator_pattern</span>=<span class="ruby-regexp re">//</span>)
+    <span class="ruby-identifier">pattern</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">patterns</span>(<span class="ruby-identifier">separator_pattern</span>)
+    <span class="ruby-identifier">split</span>(<span class="ruby-identifier">separator_pattern</span>).<span class="ruby-identifier">at</span>(<span class="ruby-value">0</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000330"></a><b>first!</b>(separator_pattern=//)
+  </div>
+  <div class="description">
+  <p>
+Removes the first separation from a string. Defualt separation is by
+characters.
+</p>
+<pre>
+  a = &quot;Hello World&quot;
+  a.first!       #=&gt; &quot;H&quot;
+  a              #=&gt; &quot;ello World&quot;
+  a = &quot;Hello World&quot;
+  a.first!(' ')  #=&gt; &quot;Hello&quot;
+  a              #=&gt; &quot;World&quot;
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000330_source')" id="l_M000330_source">show source</a> ]</p>
+  <div id="M000330_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/first.rb, line 36</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">first!</span>(<span class="ruby-identifier">separator_pattern</span>=<span class="ruby-regexp re">//</span>)
+    <span class="ruby-identifier">pattern</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">patterns</span>(<span class="ruby-identifier">separator_pattern</span>)
+    <span class="ruby-identifier">a</span> = <span class="ruby-identifier">shatter</span>(<span class="ruby-identifier">pattern</span>)
+    <span class="ruby-identifier">r</span> = <span class="ruby-identifier">a</span>.<span class="ruby-identifier">first</span>
+    <span class="ruby-identifier">a</span>.<span class="ruby-identifier">shift</span>
+    <span class="ruby-identifier">a</span>.<span class="ruby-identifier">shift</span>
+    <span class="ruby-identifier">replace</span>( <span class="ruby-identifier">a</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">''</span>) )
+    <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">r</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000331"></a><b>first=</b>( x )
+  </div>
+  <div class="description">
+  <p>
+Prepends to a string.
+</p>
+<pre>
+  &quot;Hello World&quot;.first = &quot;Hello,&quot;  #=&gt; &quot;Hello, Hello World&quot;
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000331_source')" id="l_M000331_source">show source</a> ]</p>
+  <div id="M000331_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/first.rb, line 52</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">first=</span>( <span class="ruby-identifier">x</span> )
+    <span class="ruby-identifier">insert</span>(<span class="ruby-value">0</span>, <span class="ruby-identifier">x</span>.<span class="ruby-identifier">to_s</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000318"></a><b>first_char</b>(n=1)
+  </div>
+  <div class="description">
+  <p>
+Returns first <em>n</em> characters.
+</p>
+<pre>
+  &quot;Hello World&quot;.first_char(3)  #=&gt; &quot;Hel&quot;
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000318_source')" id="l_M000318_source">show source</a> ]</p>
+  <div id="M000318_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/first_char.rb, line 8</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">first_char</span>(<span class="ruby-identifier">n</span>=<span class="ruby-value">1</span>)
+    <span class="ruby-identifier">slice</span>(<span class="ruby-value">0</span>, <span class="ruby-identifier">n</span>.<span class="ruby-identifier">to_i</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000332"></a><b>fold</b>(ignore_indented=false)
+  </div>
+  <div class="description">
+  <p>
+Returns a new string with all new lines removed from adjacent lines of
+text.
+</p>
+<pre>
+  s = &quot;This is\na test.\n\nIt clumps\nlines of text.&quot;
+  s.fold
+</pre>
+<p>
+<em>produces</em>
+</p>
+<pre>
+  &quot;This is a test.\n\nIt clumps lines of text. &quot;
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000332_source')" id="l_M000332_source">show source</a> ]</p>
+  <div id="M000332_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/fold.rb, line 19</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fold</span>(<span class="ruby-identifier">ignore_indented</span>=<span class="ruby-keyword kw">false</span>)
+    <span class="ruby-identifier">ns</span> = <span class="ruby-value str">''</span>
+    <span class="ruby-identifier">i</span> = <span class="ruby-value">0</span>
+    <span class="ruby-identifier">br</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-regexp re">/(\n\s*\n|\Z)/</span><span class="ruby-identifier">m</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">m</span><span class="ruby-operator">|</span>
+      <span class="ruby-identifier">b</span> = <span class="ruby-identifier">$~</span>.<span class="ruby-identifier">begin</span>(<span class="ruby-value">1</span>)
+      <span class="ruby-identifier">e</span> = <span class="ruby-identifier">$~</span>.<span class="ruby-identifier">end</span>(<span class="ruby-value">1</span>)
+      <span class="ruby-identifier">nl</span> = <span class="ruby-identifier">$&amp;</span>
+      <span class="ruby-identifier">tx</span> = <span class="ruby-identifier">slice</span>(<span class="ruby-identifier">i</span><span class="ruby-operator">...</span><span class="ruby-identifier">b</span>)
+      <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">ignore_indented</span> <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">slice</span>(<span class="ruby-identifier">i</span><span class="ruby-operator">...</span><span class="ruby-identifier">b</span>) <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^[ ]+/</span>
+        <span class="ruby-identifier">ns</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">tx</span>
+      <span class="ruby-keyword kw">else</span>
+        <span class="ruby-identifier">ns</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">tx</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/[ ]*\n+/</span>,<span class="ruby-value str">' '</span>)
+      <span class="ruby-keyword kw">end</span>
+      <span class="ruby-identifier">ns</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">nl</span>
+      <span class="ruby-identifier">i</span> = <span class="ruby-identifier">e</span>
+    <span class="ruby-keyword kw">end</span>
+    <span class="ruby-identifier">ns</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000352"></a><b>format</b>( *args )
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000352_source')" id="l_M000352_source">show source</a> ]</p>
+  <div id="M000352_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/format.rb, line 4</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">format</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">args</span> )
+    <span class="ruby-keyword kw">self</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="method">
+  <div class="title">
+    <a name="M000356"></a><b>frequency</b>(*args)
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000356_source')" id="l_M000356_source">show source</a> ]</p>
+  <div id="M000356_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/frequency.rb, line 7</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">frequency</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
+    <span class="ruby-identifier">to_arr</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>).<span class="ruby-identifier">frequency</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000307"></a><b>fuzzy_match</b>( str_in )
+  </div>
+  <div class="description">
+  <p>
+Alias for <a href="String.html#M000306">similarity</a>
+</p>
+  </div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000290"></a><b>humanize</b>()
+  </div>
+  <div class="description">
+  <p>
+Replaces underscores with spaces and capitalizes word.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000290_source')" id="l_M000290_source">show source</a> ]</p>
+  <div id="M000290_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/humanize.rb, line 6</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">humanize</span>
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/_/</span>, <span class="ruby-value str">&quot; &quot;</span>).<span class="ruby-identifier">capitalize</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000349"></a><b>indent</b>(n)
+  </div>
+  <div class="description">
+  <p>
+Indent left or right by n spaces. (This used to be called <a
+href="String.html#M000347">tab</a> and aliased as <a
+href="String.html#M000349">indent</a>.)
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000349_source')" id="l_M000349_source">show source</a> ]</p>
+  <div id="M000349_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/indent.rb, line 25</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">indent</span>(<span class="ruby-identifier">n</span>)
+    <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">n</span> <span class="ruby-operator">&gt;=</span> <span class="ruby-value">0</span>
+      <span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/^/</span>, <span class="ruby-value str">' '</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">n</span>)
+    <span class="ruby-keyword kw">else</span>
+      <span class="ruby-identifier">gsub</span>(<span class="ruby-node">/^ {0,#{-n}}/</span>, <span class="ruby-value str">&quot;&quot;</span>)
+    <span class="ruby-keyword kw">end</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000368"></a><b>index_all</b>(s, reuse=false)
+  </div>
+  <div class="description">
+  <p>
+Like index but returns an array of all index locations. The reuse flag
+allows the trailing portion of a match to be reused for subsquent matches.
+</p>
+<pre>
+  &quot;abcabcabc&quot;.index_all('a')  #=&gt; [0,3,6]
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000368_source')" id="l_M000368_source">show source</a> ]</p>
+  <div id="M000368_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/index_all.rb, line 10</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">index_all</span>(<span class="ruby-identifier">s</span>, <span class="ruby-identifier">reuse</span>=<span class="ruby-keyword kw">false</span>)
+    <span class="ruby-identifier">ia</span> = []; <span class="ruby-identifier">i</span> = <span class="ruby-value">0</span>
+    <span class="ruby-keyword kw">while</span> (<span class="ruby-identifier">i</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">index</span>(<span class="ruby-identifier">s</span>,<span class="ruby-identifier">i</span>))
+      <span class="ruby-identifier">ia</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">i</span>
+      <span class="ruby-identifier">i</span> <span class="ruby-operator">+=</span> (<span class="ruby-identifier">reuse</span> <span class="ruby-value">? </span><span class="ruby-value">1</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">$~</span>.<span class="ruby-identifier">length</span>)
+    <span class="ruby-keyword kw">end</span>
+    <span class="ruby-identifier">ia</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000295"></a><b>last</b>(separator_pattern=//)
+  </div>
+  <div class="description">
+  <p>
+Returns the last separation of a string. Default separation is by
+character.
+</p>
+<pre>
+  &quot;Hello World&quot;.last(' ')  #=&gt; &quot;World&quot;
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000295_source')" id="l_M000295_source">show source</a> ]</p>
+  <div id="M000295_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/last.rb, line 13</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">last</span>(<span class="ruby-identifier">separator_pattern</span>=<span class="ruby-regexp re">//</span>)
+    <span class="ruby-identifier">pattern</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">patterns</span>(<span class="ruby-identifier">separator_pattern</span>)
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">split</span>(<span class="ruby-identifier">separator_pattern</span>).<span class="ruby-identifier">at</span>(<span class="ruby-value">-1</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000297"></a><b>last!</b>(separator_pattern=//)
+  </div>
+  <div class="description">
+  <p>
+Removes the last separation from a string. Default seperation is by
+characeter.
+</p>
+<pre>
+  a = &quot;Hello World&quot;
+  a.last!       #=&gt; &quot;d&quot;
+  a             #=&gt; &quot;Hello Worl&quot;
+  a = &quot;Hello World&quot;
+  a.last!(' ')  #=&gt; &quot;World&quot;
+  a             #=&gt; &quot;Hello&quot;
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000297_source')" id="l_M000297_source">show source</a> ]</p>
+  <div id="M000297_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/last.rb, line 43</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">last!</span>(<span class="ruby-identifier">separator_pattern</span>=<span class="ruby-regexp re">//</span>)
+    <span class="ruby-identifier">pattern</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">patterns</span>(<span class="ruby-identifier">separator_pattern</span>)
+    <span class="ruby-identifier">a</span> = <span class="ruby-identifier">shatter</span>(<span class="ruby-identifier">pattern</span>)
+    <span class="ruby-identifier">r</span> = <span class="ruby-identifier">a</span>.<span class="ruby-identifier">last</span>
+    <span class="ruby-identifier">a</span>.<span class="ruby-identifier">pop</span>
+    <span class="ruby-identifier">a</span>.<span class="ruby-identifier">pop</span>
+    <span class="ruby-identifier">replace</span>( <span class="ruby-identifier">a</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">''</span>) )
+    <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">r</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000296"></a><b>last=</b>(str)
+  </div>
+  <div class="description">
+  <p>
+Appends to a string.
+</p>
+<pre>
+  &quot;Hello World&quot;.last = &quot;, Bye.&quot;  #=&gt;  &quot;Hello World, Bye.&quot;
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000296_source')" id="l_M000296_source">show source</a> ]</p>
+  <div id="M000296_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/last.rb, line 22</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">last=</span>(<span class="ruby-identifier">str</span>)
+    <span class="ruby-keyword kw">self</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">str</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000341"></a><b>last_char</b>(n=1)
+  </div>
+  <div class="description">
+  <p>
+Returns last <em>n</em> characters.
+</p>
+<pre>
+  &quot;Hello World&quot;.last_char(3)  #=&gt; &quot;rld&quot;
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000341_source')" id="l_M000341_source">show source</a> ]</p>
+  <div id="M000341_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/last_char.rb, line 8</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">last_char</span>(<span class="ruby-identifier">n</span>=<span class="ruby-value">1</span>)
+    <span class="ruby-identifier">n</span> = <span class="ruby-identifier">n</span>.<span class="ruby-identifier">to_i</span>
+    <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">self</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">n</span> <span class="ruby-operator">&gt;</span> <span class="ruby-identifier">size</span>
+    <span class="ruby-identifier">slice</span>(<span class="ruby-operator">-</span><span class="ruby-identifier">n</span>, <span class="ruby-identifier">n</span>) <span class="ruby-comment cmt">#self[-n..-1]</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000342"></a><b>line_wrap</b>(width)
+  </div>
+  <div class="description">
+  <p>
+Line wrap at width.
+</p>
+<pre>
+  puts &quot;1234567890&quot;.line_wrap(5)
+</pre>
+<p>
+<em>produces</em>
+</p>
+<pre>
+  12345
+  67890
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000342_source')" id="l_M000342_source">show source</a> ]</p>
+  <div id="M000342_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/line_wrap.rb, line 13</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">line_wrap</span>(<span class="ruby-identifier">width</span>)
+    <span class="ruby-identifier">s</span> = <span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/\t/</span>,<span class="ruby-value str">' '</span><span class="ruby-operator">*</span><span class="ruby-value">4</span>) <span class="ruby-comment cmt"># tabs default to 4 spaces.</span>
+    <span class="ruby-identifier">s</span> = <span class="ruby-identifier">s</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/\n/</span>,<span class="ruby-value str">' '</span>)
+    <span class="ruby-identifier">r</span> = <span class="ruby-identifier">s</span>.<span class="ruby-identifier">scan</span>( <span class="ruby-node">/.{1,#{width}}/</span> )
+    <span class="ruby-identifier">r</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">&quot;\n&quot;</span>) <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">&quot;\n&quot;</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000378"></a><b>lines</b>()
+  </div>
+  <div class="description">
+  <p>
+Returns an array of characters.
+</p>
+<pre>
+  &quot;abc\n123&quot;.lines  #=&gt; [&quot;abc&quot;,&quot;123&quot;]
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000378_source')" id="l_M000378_source">show source</a> ]</p>
+  <div id="M000378_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/lines.rb, line 8</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">lines</span>
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp re">/\n/</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000357"></a><b>lowercase?</b>()
+  </div>
+  <div class="description">
+  <p>
+Alias for <a href="String.html#M000322">downcase?</a>
+</p>
+  </div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000291"></a><b>margin</b>(n=0)
+  </div>
+  <div class="description">
+  <p>
+Provides a margin controlled string.
+</p>
+<pre>
+  x = %Q{
+        | This
+        |   is
+        |     margin controlled!
+        }.margin
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000291_source')" id="l_M000291_source">show source</a> ]</p>
+  <div id="M000291_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/margin.rb, line 15</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">margin</span>(<span class="ruby-identifier">n</span>=<span class="ruby-value">0</span>)
+    <span class="ruby-identifier">d</span> = <span class="ruby-regexp re">/\A.*\n\s*(.)/</span>.<span class="ruby-identifier">match</span>( <span class="ruby-keyword kw">self</span> )[<span class="ruby-value">1</span>]
+    <span class="ruby-identifier">d</span> = <span class="ruby-regexp re">/\A\s*(.)/</span>.<span class="ruby-identifier">match</span>( <span class="ruby-keyword kw">self</span>)[<span class="ruby-value">1</span>] <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">d</span>
+    <span class="ruby-keyword kw">return</span> <span class="ruby-value str">''</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">d</span>
+    <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">n</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
+      <span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/\n\s*\Z/</span>,<span class="ruby-value str">''</span>).<span class="ruby-identifier">gsub</span>(<span class="ruby-node">/^\s*[#{d}]/</span>, <span class="ruby-value str">''</span>)
+    <span class="ruby-keyword kw">else</span>
+      <span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/\n\s*\Z/</span>,<span class="ruby-value str">''</span>).<span class="ruby-identifier">gsub</span>(<span class="ruby-node">/^\s*[#{d}]/</span>, <span class="ruby-value str">' '</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">n</span>)
+    <span class="ruby-keyword kw">end</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000381"></a><b>methodize</b>()
+  </div>
+  <div class="description">
+  <p>
+Converts a string into a valid ruby method name This method is geared
+toward code reflection.
+</p>
+<pre>
+  &quot;MyModule::MyClass&quot;.methodize  #=&gt; &quot;my_module__my_class&quot;
+</pre>
+<p>
+See also <a href="String.html#M000379">String#modulize</a>, <a
+href="String.html#M000380">String#pathize</a>
+</p>
+<h2>TODO</h2>
+<ul>
+<li>Make sure that all scenarios return a valid ruby class name
+</li>
+<li>Make sure it is revertible
+</li>
+</ul>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000381_source')" id="l_M000381_source">show source</a> ]</p>
+  <div id="M000381_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/methodize.rb, line 18</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">methodize</span>
+    <span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/([A-Z])/</span>, <span class="ruby-value str">'_\1'</span>).<span class="ruby-identifier">downcase</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/^_/</span>,<span class="ruby-value str">''</span>).<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/(::|\/)_?/</span>, <span class="ruby-value str">'__'</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000379"></a><b>modulize</b>()
+  </div>
+  <div class="description">
+  <p>
+Converts a string into a valid ruby class or module name This method is
+geared toward code reflection.
+</p>
+<pre>
+  &quot;my_module__my_path&quot;.modulize  #=&gt; &quot;MyModule::MyPath&quot;
+</pre>
+<p>
+See also <a href="String.html#M000381">String#methodize</a>, <a
+href="String.html#M000380">String#pathize</a>
+</p>
+<p>
+TODO
+</p>
+<ul>
+<li>Make sure that all scenarios return a valid ruby class name
+</li>
+<li>Make sure it is revertible
+</li>
+</ul>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000379_source')" id="l_M000379_source">show source</a> ]</p>
+  <div id="M000379_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/modulize.rb, line 16</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">modulize</span>
+    <span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/(__|\/)(.?)/</span>){ <span class="ruby-value str">&quot;::&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">$2</span>.<span class="ruby-identifier">upcase</span> }.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/(^|_)(.)/</span>){ <span class="ruby-identifier">$2</span>.<span class="ruby-identifier">upcase</span> }
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000374"></a><b>mscan</b>(re) {|| ...}
+  </div>
+  <div class="description">
+  <p>
+Like scan but returns <a href="MatchData.html">MatchData</a> ($~) rather
+then matched string ($&amp;).
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000374_source')" id="l_M000374_source">show source</a> ]</p>
+  <div id="M000374_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/mscan.rb, line 7</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">mscan</span>(<span class="ruby-identifier">re</span>) <span class="ruby-comment cmt">#:yield:</span>
+    <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
+      <span class="ruby-identifier">scan</span>(<span class="ruby-identifier">re</span>) { <span class="ruby-keyword kw">yield</span>(<span class="ruby-identifier">$~</span>) }
+    <span class="ruby-keyword kw">else</span>
+      <span class="ruby-identifier">m</span> = []
+      <span class="ruby-identifier">scan</span>(<span class="ruby-identifier">re</span>) { <span class="ruby-identifier">m</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">$~</span> }
+      <span class="ruby-identifier">m</span>
+    <span class="ruby-keyword kw">end</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000377"></a><b>natcmp</b>(str2, caseInsensitive=false)
+  </div>
+  <div class="description">
+  <p>
+&#8216;Natural order&#8217; comparison of two strings, e.g.
+</p>
+<pre>
+  &quot;my_prog_v1.1.0&quot; &lt; &quot;my_prog_v1.2.0&quot; &lt; &quot;my_prog_v1.10.0&quot;
+</pre>
+<p>
+which does not follow alphabetically. A secondary parameter, if set to
+<em>true</em>, makes the comparison case insensitive.
+</p>
+<pre>
+  &quot;Hello.10&quot;.natcmp(&quot;Hello.1&quot;)  #=&gt; -1
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000377_source')" id="l_M000377_source">show source</a> ]</p>
+  <div id="M000377_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/natcmp.rb, line 42</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">natcmp</span>(<span class="ruby-identifier">str2</span>, <span class="ruby-identifier">caseInsensitive</span>=<span class="ruby-keyword kw">false</span>)
+    <span class="ruby-identifier">str1</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">dup</span>
+    <span class="ruby-identifier">str2</span> = <span class="ruby-identifier">str2</span>.<span class="ruby-identifier">dup</span>
+    <span class="ruby-identifier">compareExpression</span> = <span class="ruby-regexp re">/^(\D*)(\d*)(.*)$/</span>
+    <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">caseInsensitive</span>
+      <span class="ruby-identifier">str1</span>.<span class="ruby-identifier">downcase!</span>
+      <span class="ruby-identifier">str2</span>.<span class="ruby-identifier">downcase!</span>
+    <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># remove all whitespace</span>
+    <span class="ruby-identifier">str1</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp re">/\s*/</span>, <span class="ruby-value str">''</span>)
+    <span class="ruby-identifier">str2</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp re">/\s*/</span>, <span class="ruby-value str">''</span>)
+    <span class="ruby-keyword kw">while</span> (<span class="ruby-identifier">str1</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span>) <span class="ruby-keyword kw">or</span> (<span class="ruby-identifier">str2</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span>) <span class="ruby-keyword kw">do</span>
+      <span class="ruby-comment cmt"># Extract non-digits, digits and rest of string</span>
+      <span class="ruby-identifier">str1</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">compareExpression</span>
+      <span class="ruby-identifier">chars1</span>, <span class="ruby-identifier">num1</span>, <span class="ruby-identifier">str1</span> = <span class="ruby-identifier">$1</span>.<span class="ruby-identifier">dup</span>, <span class="ruby-identifier">$2</span>.<span class="ruby-identifier">dup</span>, <span class="ruby-identifier">$3</span>.<span class="ruby-identifier">dup</span>
+      <span class="ruby-identifier">str2</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">compareExpression</span>
+      <span class="ruby-identifier">chars2</span>, <span class="ruby-identifier">num2</span>, <span class="ruby-identifier">str2</span> = <span class="ruby-identifier">$1</span>.<span class="ruby-identifier">dup</span>, <span class="ruby-identifier">$2</span>.<span class="ruby-identifier">dup</span>, <span class="ruby-identifier">$3</span>.<span class="ruby-identifier">dup</span>
+      <span class="ruby-comment cmt"># Compare the non-digits</span>
+      <span class="ruby-keyword kw">case</span> (<span class="ruby-identifier">chars1</span> <span class="ruby-operator">&lt;=&gt;</span> <span class="ruby-identifier">chars2</span>)
+        <span class="ruby-keyword kw">when</span> <span class="ruby-value">0</span> <span class="ruby-comment cmt"># Non-digits are the same, compare the digits...</span>
+          <span class="ruby-comment cmt"># If either number begins with a zero, then compare alphabetically,</span>
+          <span class="ruby-comment cmt"># otherwise compare numerically</span>
+          <span class="ruby-keyword kw">if</span> (<span class="ruby-identifier">num1</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">!=</span> <span class="ruby-value">48</span>) <span class="ruby-keyword kw">and</span> (<span class="ruby-identifier">num2</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">!=</span> <span class="ruby-value">48</span>)
+            <span class="ruby-identifier">num1</span>, <span class="ruby-identifier">num2</span> = <span class="ruby-identifier">num1</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">num2</span>.<span class="ruby-identifier">to_i</span>
+          <span class="ruby-keyword kw">end</span>
+          <span class="ruby-keyword kw">case</span> (<span class="ruby-identifier">num1</span> <span class="ruby-operator">&lt;=&gt;</span> <span class="ruby-identifier">num2</span>)
+            <span class="ruby-keyword kw">when</span> <span class="ruby-value">-1</span> <span class="ruby-keyword kw">then</span> <span class="ruby-keyword kw">return</span> <span class="ruby-value">-1</span>
+            <span class="ruby-keyword kw">when</span> <span class="ruby-value">1</span> <span class="ruby-keyword kw">then</span> <span class="ruby-keyword kw">return</span> <span class="ruby-value">1</span>
+          <span class="ruby-keyword kw">end</span>
+        <span class="ruby-keyword kw">when</span> <span class="ruby-value">-1</span> <span class="ruby-keyword kw">then</span> <span class="ruby-keyword kw">return</span> <span class="ruby-value">-1</span>
+        <span class="ruby-keyword kw">when</span> <span class="ruby-value">1</span> <span class="ruby-keyword kw">then</span> <span class="ruby-keyword kw">return</span> <span class="ruby-value">1</span>
+      <span class="ruby-keyword kw">end</span> <span class="ruby-comment cmt"># case</span>
+    <span class="ruby-keyword kw">end</span> <span class="ruby-comment cmt"># while</span>
+    <span class="ruby-comment cmt"># strings are naturally equal.</span>
+    <span class="ruby-keyword kw">return</span> <span class="ruby-value">0</span>
+  <span class="ruby-keyword kw">end</span>
+<span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000300"></a><b>nchar</b>( n, replacement=nil )
+  </div>
+  <div class="description">
+  <p>
+Retrns <em>n</em> characters of the string. If <em>n</em> is positive the
+characters are from the beginning of the string. If <em>n</em> is negative
+from the end of the string.
+</p>
+<p>
+Alternatively a replacement string can be given, which will replace the
+<em>n</em> characters.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000300_source')" id="l_M000300_source">show source</a> ]</p>
+  <div id="M000300_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/nchar.rb, line 11</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">nchar</span>( <span class="ruby-identifier">n</span>, <span class="ruby-identifier">replacement</span>=<span class="ruby-keyword kw">nil</span> )
+    <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">replacement</span>
+      <span class="ruby-identifier">s</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">dup</span>
+      <span class="ruby-identifier">n</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span> <span class="ruby-operator">?</span> (<span class="ruby-identifier">s</span>[<span class="ruby-value">0</span><span class="ruby-operator">...</span><span class="ruby-identifier">n</span>] = <span class="ruby-identifier">replacement</span>) <span class="ruby-operator">:</span> (<span class="ruby-identifier">s</span>[<span class="ruby-identifier">n</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>] = <span class="ruby-identifier">replacement</span>)
+      <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">s</span>
+    <span class="ruby-keyword kw">else</span>
+      <span class="ruby-identifier">n</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span> <span class="ruby-operator">?</span> <span class="ruby-keyword kw">self</span>[<span class="ruby-value">0</span><span class="ruby-operator">...</span><span class="ruby-identifier">n</span>] <span class="ruby-operator">:</span> <span class="ruby-keyword kw">self</span>[<span class="ruby-identifier">n</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>]
+    <span class="ruby-keyword kw">end</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000359"></a><b>ordinal</b>()
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000359_source')" id="l_M000359_source">show source</a> ]</p>
+  <div id="M000359_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/ordinal.rb, line 4</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">ordinal</span>
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">to_i</span>.<span class="ruby-identifier">ordinal</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000380"></a><b>pathize</b>()
+  </div>
+  <div class="description">
+  <p>
+Converts a string into a unix path. This method is geared toward code
+reflection.
+</p>
+<p>
+See : <a href="String.html#M000379">String#modulize</a>, <a
+href="String.html#M000381">String#methodize</a>
+</p>
+<pre>
+  &quot;MyModule::MyClass&quot;.pathize   #=&gt; my_module/my_class
+  &quot;my_module__my_class&quot;.pathize #=&gt; my_module/my_class
+</pre>
+<p>
+TODO :
+</p>
+<ul>
+<li>Make sure that all scenarios return a valid unix path
+</li>
+<li>Make sure it is revertible
+</li>
+</ul>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000380_source')" id="l_M000380_source">show source</a> ]</p>
+  <div id="M000380_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/pathize.rb, line 17</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pathize</span>
+    <span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/([A-Z])/</span>, <span class="ruby-value str">'_\1'</span>).<span class="ruby-identifier">downcase</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/^_/</span>,<span class="ruby-value str">''</span>).<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/(::|__)_?/</span>, <span class="ruby-value str">'/'</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000302"></a><b>plural</b>()
+  </div>
+  <div class="description">
+  <p>
+Convert an English word from singular to plurel.
+</p>
+<pre>
+  &quot;boy&quot;.plural     #=&gt; boys
+  &quot;tomato&quot;.plural  #=&gt; tomatoes
+</pre>
+  </div>
+<div class="aka">
+  This method is also aliased as
+  <a href="String.html#M000304">pluralize</a>
+</div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000302_source')" id="l_M000302_source">show source</a> ]</p>
+  <div id="M000302_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/singular.rb, line 76</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">plural</span>
+    <span class="ruby-identifier">result</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">dup</span>
+    <span class="ruby-constant">String</span><span class="ruby-operator">::</span><span class="ruby-constant">PLURAL_RULES</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span>(<span class="ruby-identifier">rule</span>, <span class="ruby-identifier">replacement</span>)<span class="ruby-operator">|</span>
+      <span class="ruby-keyword kw">break</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-identifier">rule</span>, <span class="ruby-identifier">replacement</span>)
+    <span class="ruby-keyword kw">end</span>
+    <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">result</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000304"></a><b>pluralize</b>()
+  </div>
+  <div class="description">
+  <p>
+Alias for <a href="String.html#M000302">plural</a>
+</p>
+  </div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000354"></a><b>pop</b>()
+  </div>
+  <div class="description">
+  <p>
+Polymorphic with <a href="Array.html">Array</a> of characters.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000354_source')" id="l_M000354_source">show source</a> ]</p>
+  <div id="M000354_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/pop.rb, line 5</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pop</span>
+    <span class="ruby-keyword kw">return</span> <span class="ruby-value str">''</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
+    <span class="ruby-identifier">r</span> = <span class="ruby-keyword kw">self</span>[<span class="ruby-value">-1</span>,<span class="ruby-value">1</span>]
+    <span class="ruby-keyword kw">self</span>[<span class="ruby-value">-1</span>] = <span class="ruby-value str">''</span>
+    <span class="ruby-identifier">r</span> <span class="ruby-comment cmt">#self</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000315"></a><b>pot</b>( str=' ' )
+  </div>
+  <div class="description">
+  <p>
+Like push but works from the other end of the string.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000315_source')" id="l_M000315_source">show source</a> ]</p>
+  <div id="M000315_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/pot.rb, line 6</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pot</span>( <span class="ruby-identifier">str</span>=<span class="ruby-value str">' '</span> )
+    <span class="ruby-identifier">insert</span>(<span class="ruby-value">0</span>, <span class="ruby-identifier">str</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000324"></a><b>probability</b>(*args)
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000324_source')" id="l_M000324_source">show source</a> ]</p>
+  <div id="M000324_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/probability.rb, line 7</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">probability</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
+    <span class="ruby-identifier">to_arr</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>).<span class="ruby-identifier">probability</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000280"></a><b>pull</b>()
+  </div>
+  <div class="description">
+  <p>
+Same as <a href="String.html#M000282">shift</a>.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000280_source')" id="l_M000280_source">show source</a> ]</p>
+  <div id="M000280_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/pull.rb, line 3</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pull</span>
+    <span class="ruby-keyword kw">return</span> <span class="ruby-value str">''</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
+    <span class="ruby-keyword kw">self</span>[<span class="ruby-value">0</span>] = <span class="ruby-value str">''</span>
+    <span class="ruby-keyword kw">self</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000281"></a><b>push</b>(str=' ')
+  </div>
+  <div class="description">
+  <p>
+Polymorphic with <a href="Array.html">Array</a> of characters.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000281_source')" id="l_M000281_source">show source</a> ]</p>
+  <div id="M000281_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/push.rb, line 5</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">push</span>(<span class="ruby-identifier">str</span>=<span class="ruby-value str">' '</span>)
+    <span class="ruby-identifier">concat</span>(<span class="ruby-identifier">str</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000369"></a><b>quote</b>(type=:s)
+  </div>
+  <div class="description">
+  <p>
+Return a new string embraced by given quotes. If no quotes are specified,
+then assumes single quotes.
+</p>
+<pre>
+  &quot;quote me&quot;.quote     #=&gt; &quot;'quote me'&quot;
+  &quot;quote me&quot;.quote(2)  #=&gt; &quot;\&quot;quote me\&quot;&quot;
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000369_source')" id="l_M000369_source">show source</a> ]</p>
+  <div id="M000369_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/quote.rb, line 11</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">quote</span>(<span class="ruby-identifier">type</span>=<span class="ruby-identifier">:s</span>)
+    <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">type</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">downcase</span>
+    <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'s'</span>, <span class="ruby-value str">'single'</span>
+      <span class="ruby-identifier">bracket</span>(<span class="ruby-value str">&quot;'&quot;</span>)
+    <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'d'</span>, <span class="ruby-value str">'double'</span>
+      <span class="ruby-identifier">bracket</span>(<span class="ruby-value str">'&quot;'</span>)
+    <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'b'</span>, <span class="ruby-value str">'back'</span>
+      <span class="ruby-identifier">bracket</span>(<span class="ruby-value str">'`'</span>)
+    <span class="ruby-keyword kw">else</span>
+      <span class="ruby-identifier">bracket</span>(<span class="ruby-value str">&quot;'&quot;</span>)
+    <span class="ruby-keyword kw">end</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000308"></a><b>rand_byte</b>()
+  </div>
+  <div class="description">
+  <p>
+Return a random byte of <em>self</em>.
+</p>
+<pre>
+  &quot;Ruby rules&quot;.rand_byte  #=&gt; 121
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000308_source')" id="l_M000308_source">show source</a> ]</p>
+  <div id="M000308_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/rand_byte.rb, line 8</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rand_byte</span>
+    <span class="ruby-keyword kw">self</span>[<span class="ruby-identifier">rand</span>( <span class="ruby-identifier">size</span> )]
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000309"></a><b>rand_byte!</b>()
+  </div>
+  <div class="description">
+  <p>
+Destructive <a href="String.html#M000308">rand_byte</a>. Delete a random
+byte of <em>self</em> and return it.
+</p>
+<pre>
+  s = &quot;Ruby rules&quot;
+  s.rand_byte!      #=&gt; 121
+  s                 #=&gt; &quot;Rub rules&quot;
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000309_source')" id="l_M000309_source">show source</a> ]</p>
+  <div id="M000309_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/rand_byte.rb, line 18</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rand_byte!</span>
+    <span class="ruby-identifier">i</span> = <span class="ruby-identifier">rand</span>( <span class="ruby-identifier">size</span> )
+    <span class="ruby-identifier">rv</span> = <span class="ruby-keyword kw">self</span>[<span class="ruby-identifier">i</span>,<span class="ruby-value">1</span>]
+    <span class="ruby-keyword kw">self</span>[<span class="ruby-identifier">i</span>,<span class="ruby-value">1</span>] = <span class="ruby-value str">''</span>
+    <span class="ruby-identifier">rv</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000299"></a><b>rand_index</b>()
+  </div>
+  <div class="description">
+  <p>
+Return a random string index.
+</p>
+<pre>
+  &quot;Ruby rules&quot;.rand_index  #=&gt; 3
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000299_source')" id="l_M000299_source">show source</a> ]</p>
+  <div id="M000299_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/rand_index.rb, line 6</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rand_index</span>
+    <span class="ruby-identifier">rand</span>( <span class="ruby-identifier">size</span> )
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000336"></a><b>range</b>(s, offset=0)
+  </div>
+  <div class="description">
+  <p>
+Like index but returns a <a href="Range.html">Range</a>.
+</p>
+<pre>
+  &quot;This is a test!&quot;.range('test')  #=&gt; 10..13
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000336_source')" id="l_M000336_source">show source</a> ]</p>
+  <div id="M000336_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/range.rb, line 8</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">range</span>(<span class="ruby-identifier">s</span>, <span class="ruby-identifier">offset</span>=<span class="ruby-value">0</span>)
+    <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">index</span>(<span class="ruby-identifier">s</span>, <span class="ruby-identifier">offset</span>)
+      <span class="ruby-keyword kw">return</span> (<span class="ruby-identifier">$~</span>.<span class="ruby-identifier">begin</span>(<span class="ruby-value">0</span>))<span class="ruby-operator">..</span>(<span class="ruby-identifier">$~</span>.<span class="ruby-identifier">end</span>(<span class="ruby-value">0</span>)<span class="ruby-operator">-</span><span class="ruby-value">1</span>)
+    <span class="ruby-keyword kw">end</span>
+    <span class="ruby-keyword kw">nil</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000373"></a><b>range_all</b>(s, reuse=false)
+  </div>
+  <div class="description">
+  <p>
+Like <a href="String.html#M000368">index_all</a> but returns an array of
+Ranges.
+</p>
+<pre>
+  &quot;abc123abc123&quot;.range_all('abc')  #=&gt; [0..2, 6..8]
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000373_source')" id="l_M000373_source">show source</a> ]</p>
+  <div id="M000373_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/range_all.rb, line 12</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">range_all</span>(<span class="ruby-identifier">s</span>, <span class="ruby-identifier">reuse</span>=<span class="ruby-keyword kw">false</span>)
+    <span class="ruby-identifier">r</span> = []; <span class="ruby-identifier">i</span> = <span class="ruby-value">0</span>
+    <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">i</span> <span class="ruby-operator">&lt;</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">length</span>
+      <span class="ruby-identifier">rng</span> = <span class="ruby-identifier">range</span>(<span class="ruby-identifier">s</span>, <span class="ruby-identifier">i</span>)
+      <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">rng</span>
+        <span class="ruby-identifier">r</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">rng</span>
+        <span class="ruby-identifier">i</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">reuse</span> <span class="ruby-value">? </span><span class="ruby-value">1</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">rng</span>.<span class="ruby-identifier">end</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>
+      <span class="ruby-keyword kw">else</span>
+        <span class="ruby-keyword kw">break</span>
+      <span class="ruby-keyword kw">end</span>
+    <span class="ruby-keyword kw">end</span>
+    <span class="ruby-identifier">r</span>.<span class="ruby-identifier">uniq</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000355"></a><b>range_of_line</b>()
+  </div>
+  <div class="description">
+  <p>
+Returns an array of ranges mapping the characters per line.
+</p>
+<pre>
+  &quot;this\nis\na\ntest&quot;.range_of_line
+  #=&gt; [0..4, 5..7, 8..9, 10..13]
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000355_source')" id="l_M000355_source">show source</a> ]</p>
+  <div id="M000355_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/range_of_line.rb, line 10</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">range_of_line</span>
+    <span class="ruby-identifier">offset</span>=<span class="ruby-value">0</span>; <span class="ruby-identifier">charmap</span> = []
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
+      <span class="ruby-identifier">charmap</span> <span class="ruby-operator">&lt;&lt;</span> (<span class="ruby-identifier">offset</span><span class="ruby-operator">..</span>(<span class="ruby-identifier">offset</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">line</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>))
+      <span class="ruby-identifier">offset</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">line</span>.<span class="ruby-identifier">length</span>
+    <span class="ruby-keyword kw">end</span>
+    <span class="ruby-identifier">charmap</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000370"></a><b>regesc</b>()
+  </div>
+  <div class="description">
+  <p>
+Escape string for <a href="Regexp.html">Regexp</a> use.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000370_source')" id="l_M000370_source">show source</a> ]</p>
+  <div id="M000370_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/regesc.rb, line 5</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">regesc</span>
+    <span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">escape</span>( <span class="ruby-keyword kw">self</span> )
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000375"></a><b>shatter</b>( re )
+  </div>
+  <div class="description">
+  <p>
+Breaks a string up into an array based on a regular expression. Similar to
+scan, but includes the matches.
+</p>
+<pre>
+  s = &quot;&lt;p&gt;This&lt;b&gt;is&lt;/b&gt;a test.&lt;/p&gt;&quot;
+  s.shatter( /\&lt;.*?\&gt;/ )
+</pre>
+<p>
+<em>produces</em>
+</p>
+<pre>
+  [&quot;&lt;p&gt;&quot;, &quot;This&quot;, &quot;&lt;b&gt;&quot;, &quot;is&quot;, &quot;&lt;/b&gt;&quot;, &quot;a test.&quot;, &quot;&lt;/p&gt;&quot;]
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000375_source')" id="l_M000375_source">show source</a> ]</p>
+  <div id="M000375_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/shatter.rb, line 14</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">shatter</span>( <span class="ruby-identifier">re</span> )
+    <span class="ruby-identifier">r</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">gsub</span>( <span class="ruby-identifier">re</span> ){ <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-value str">&quot;\1&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">s</span> <span class="ruby-operator">+</span> <span class="ruby-value str">&quot;\1&quot;</span> }
+    <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">r</span>[<span class="ruby-value">0</span>,<span class="ruby-value">1</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;\1&quot;</span> ; <span class="ruby-identifier">r</span>[<span class="ruby-value">0</span>] = <span class="ruby-value str">''</span> ; <span class="ruby-keyword kw">end</span>
+    <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">r</span>[<span class="ruby-value">-1</span>,<span class="ruby-value">1</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;\1&quot;</span> ; <span class="ruby-identifier">r</span>[<span class="ruby-value">-1</span>] = <span class="ruby-value str">''</span> ; <span class="ruby-keyword kw">end</span>
+    <span class="ruby-identifier">r</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">&quot;\1&quot;</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000382"></a><b>shell_escape</b>()
+  </div>
+  <div class="description">
+  <p>
+Escape special characters used in most unix shells to use it, eg. with
+system().
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000382_source')" id="l_M000382_source">show source</a> ]</p>
+  <div id="M000382_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/shell_escape.rb, line 7</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">shell_escape</span>
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/([\\\t\| &amp;`&lt;&gt;)('&quot;])/</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-value str">'\\'</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">s</span> }
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000282"></a><b>shift</b>()
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000282_source')" id="l_M000282_source">show source</a> ]</p>
+  <div id="M000282_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/shift.rb, line 2</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">shift</span>
+    <span class="ruby-keyword kw">return</span> <span class="ruby-value str">''</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
+    <span class="ruby-keyword kw">self</span>[<span class="ruby-value">0</span>] = <span class="ruby-value str">''</span>
+    <span class="ruby-keyword kw">self</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000360"></a><b>shuffle</b>(separator=//)
+  </div>
+  <div class="description">
+  <p>
+Return the string with seperated sections arranged in a random order. The
+default seperation is by character.
+</p>
+<pre>
+  &quot;Ruby rules&quot;.shuffle  #=&gt; &quot;e lybRsuur&quot;
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000360_source')" id="l_M000360_source">show source</a> ]</p>
+  <div id="M000360_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/shuffle.rb, line 10</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">shuffle</span>(<span class="ruby-identifier">separator</span>=<span class="ruby-regexp re">//</span>)
+    <span class="ruby-identifier">split</span>(<span class="ruby-identifier">separator</span>).<span class="ruby-identifier">shuffle</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">''</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000361"></a><b>shuffle!</b>(separator=//)
+  </div>
+  <div class="description">
+  <p>
+In place version of shuffle.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000361_source')" id="l_M000361_source">show source</a> ]</p>
+  <div id="M000361_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/shuffle.rb, line 16</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">shuffle!</span>(<span class="ruby-identifier">separator</span>=<span class="ruby-regexp re">//</span>)
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">replace</span>( <span class="ruby-identifier">shuffle</span>(<span class="ruby-identifier">separator</span>) )
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000306"></a><b>similarity</b>( str_in )
+  </div>
+  <div class="description">
+  <p>
+A fuzzy matching mechanism. Returns a score from 0-1, based on the number
+of shared edges. To be effective, the strings must be of length 2 or
+greater.
+</p>
+<pre>
+  &quot;Alexsander&quot;.fuzzy_match( &quot;Aleksander&quot; )  #=&gt; 0.9
+</pre>
+<p>
+The way it works:
+</p>
+<ul>
+<li>Converts each string into a &quot;graph like&quot; object, with edges
+<pre>
+  &quot;alexsander&quot; -&gt; [ alexsander, alexsand, alexsan ... lexsand ... san ... an, etc ]
+  &quot;aleksander&quot; -&gt; [ aleksander, aleksand ... etc. ]
+</pre>
+</li>
+<li>Perform match, then remove any subsets from this matched set (i.e. a hit on
+&quot;san&quot; is a subset of a hit on &quot;sander&quot;)
+<pre>
+  Above example, once reduced -&gt; [ ale, sander ]
+</pre>
+</li>
+<li>See&#8217;s how many of the matches remain, and calculates a score based on
+how many matches, their length, and compare to the length of the larger of
+the two words.
+</li>
+</ul>
+  </div>
+<div class="aka">
+  This method is also aliased as
+  <a href="String.html#M000307">fuzzy_match</a>
+</div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000306_source')" id="l_M000306_source">show source</a> ]</p>
+  <div id="M000306_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/similarity.rb, line 25</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">similarity</span>( <span class="ruby-identifier">str_in</span> )
+    <span class="ruby-keyword kw">return</span> <span class="ruby-value">0</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">str_in</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">nil</span>
+    <span class="ruby-keyword kw">return</span> <span class="ruby-value">1</span> <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">self</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">str_in</span>
+    <span class="ruby-comment cmt"># Make a graph of each word (okay, so its not a true graph, but is similar)</span>
+    <span class="ruby-identifier">graph_A</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>
+    <span class="ruby-identifier">graph_B</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>
+    <span class="ruby-comment cmt"># &quot;graph&quot; self</span>
+    <span class="ruby-identifier">last</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">length</span>
+    (<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-identifier">last</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ff</span><span class="ruby-operator">|</span>
+      <span class="ruby-identifier">loc</span>  = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">length</span>
+      <span class="ruby-keyword kw">break</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">ff</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">last</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>
+      <span class="ruby-identifier">wordB</span> = (<span class="ruby-value">1</span><span class="ruby-operator">..</span>(<span class="ruby-identifier">last</span><span class="ruby-operator">-</span><span class="ruby-value">1</span>)).<span class="ruby-identifier">to_a</span>.<span class="ruby-identifier">reverse!</span>
+      <span class="ruby-keyword kw">if</span> (<span class="ruby-identifier">wordB</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword kw">nil</span>)
+        <span class="ruby-identifier">wordB</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ss</span><span class="ruby-operator">|</span>
+          <span class="ruby-keyword kw">break</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">ss</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">ff</span>
+          <span class="ruby-identifier">graph_A</span>.<span class="ruby-identifier">push</span>( <span class="ruby-node">&quot;#{self[ff..ss]}&quot;</span> )
+        <span class="ruby-keyword kw">end</span>
+      <span class="ruby-keyword kw">end</span>
+    <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># &quot;graph&quot; input string</span>
+    <span class="ruby-identifier">last</span> = <span class="ruby-identifier">str_in</span>.<span class="ruby-identifier">length</span>
+    (<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-identifier">last</span>).<span class="ruby-identifier">each</span>{ <span class="ruby-operator">|</span><span class="ruby-identifier">ff</span><span class="ruby-operator">|</span>
+      <span class="ruby-identifier">loc</span>  = <span class="ruby-identifier">str_in</span>.<span class="ruby-identifier">length</span>
+      <span class="ruby-keyword kw">break</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">ff</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">last</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>
+      <span class="ruby-identifier">wordB</span> = (<span class="ruby-value">1</span><span class="ruby-operator">..</span>(<span class="ruby-identifier">last</span><span class="ruby-operator">-</span><span class="ruby-value">1</span>)).<span class="ruby-identifier">to_a</span>.<span class="ruby-identifier">reverse!</span>
+      <span class="ruby-identifier">wordB</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ss</span><span class="ruby-operator">|</span>
+        <span class="ruby-keyword kw">break</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">ss</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">ff</span>
+        <span class="ruby-identifier">graph_B</span>.<span class="ruby-identifier">push</span>( <span class="ruby-node">&quot;#{str_in[ff..ss]}&quot;</span> )
+      <span class="ruby-keyword kw">end</span>
+    }
+    <span class="ruby-comment cmt"># count how many of these &quot;graph edges&quot; we have that are the same</span>
+    <span class="ruby-identifier">matches</span> = <span class="ruby-identifier">graph_A</span> <span class="ruby-operator">&amp;</span> <span class="ruby-identifier">graph_B</span>
+    <span class="ruby-comment cmt">#matches = Array.new</span>
+    <span class="ruby-comment cmt">#graph_A.each do |aa|</span>
+    <span class="ruby-comment cmt">#  matches.push( aa ) if( graph_B.include?( aa ) )</span>
+    <span class="ruby-comment cmt">#end</span>
+    <span class="ruby-comment cmt"># For eliminating subsets, we want to start with the smallest hits.</span>
+    <span class="ruby-identifier">matches</span>.<span class="ruby-identifier">sort!</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">x</span>,<span class="ruby-identifier">y</span><span class="ruby-operator">|</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">&lt;=&gt;</span> <span class="ruby-identifier">y</span>.<span class="ruby-identifier">length</span>}
+    <span class="ruby-comment cmt"># eliminate any subsets</span>
+    <span class="ruby-identifier">mclone</span> = <span class="ruby-identifier">matches</span>.<span class="ruby-identifier">dup</span>
+    <span class="ruby-identifier">mclone</span>.<span class="ruby-identifier">each_index</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ii</span><span class="ruby-operator">|</span>
+      <span class="ruby-identifier">reg</span> = <span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">compile</span>( <span class="ruby-identifier">mclone</span>[<span class="ruby-identifier">ii</span>] )
+      <span class="ruby-identifier">count</span> = <span class="ruby-value">0</span><span class="ruby-value">.0</span>
+      <span class="ruby-identifier">matches</span>.<span class="ruby-identifier">each</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">xx</span><span class="ruby-operator">|</span> <span class="ruby-identifier">count</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">xx</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">reg</span>}
+      <span class="ruby-identifier">matches</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">mclone</span>[<span class="ruby-identifier">ii</span>]) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">count</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">1</span>
+    <span class="ruby-keyword kw">end</span>
+    <span class="ruby-identifier">score</span> = <span class="ruby-value">0</span><span class="ruby-value">.0</span>
+    <span class="ruby-identifier">matches</span>.<span class="ruby-identifier">each</span>{ <span class="ruby-operator">|</span><span class="ruby-identifier">mm</span><span class="ruby-operator">|</span> <span class="ruby-identifier">score</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">mm</span>.<span class="ruby-identifier">length</span> }
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">&gt;</span> <span class="ruby-identifier">str_in</span>.<span class="ruby-identifier">length</span> <span class="ruby-value">? </span><span class="ruby-identifier">largest</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">largest</span> = <span class="ruby-identifier">str_in</span>.<span class="ruby-identifier">length</span>
+    <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">score</span><span class="ruby-operator">/</span><span class="ruby-identifier">largest</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000301"></a><b>singular</b>()
+  </div>
+  <div class="description">
+  <p>
+Convert an English word from plurel to singular.
+</p>
+<pre>
+  &quot;boys&quot;.singular      #=&gt; boy
+  &quot;tomatoes&quot;.singular  #=&gt; tomato
+</pre>
+  </div>
+<div class="aka">
+  This method is also aliased as
+  <a href="String.html#M000303">singularize</a>
+</div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000301_source')" id="l_M000301_source">show source</a> ]</p>
+  <div id="M000301_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/singular.rb, line 63</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">singular</span>
+    <span class="ruby-identifier">result</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">dup</span>
+    <span class="ruby-constant">String</span><span class="ruby-operator">::</span><span class="ruby-constant">SINGULAR_RULES</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span>(<span class="ruby-identifier">rule</span>, <span class="ruby-identifier">replacement</span>)<span class="ruby-operator">|</span>
+      <span class="ruby-keyword kw">break</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-identifier">rule</span>, <span class="ruby-identifier">replacement</span>)
+    <span class="ruby-keyword kw">end</span>
+    <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">result</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000303"></a><b>singularize</b>()
+  </div>
+  <div class="description">
+  <p>
+Alias for <a href="String.html#M000301">singular</a>
+</p>
+  </div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000371"></a><b>soundex</b>()
+  </div>
+  <div class="description">
+  <p>
+Implementation of the soundex algorithm as described by Knuth in volume 3
+of The Art of Computer Programming. Returns nil if the value couldn&#8217;t
+be calculated b/c of empty-string or invalid character.
+</p>
+<pre>
+  &quot;Ruby&quot;.soundex  #=&gt; &quot;R100&quot;
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000371_source')" id="l_M000371_source">show source</a> ]</p>
+  <div id="M000371_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/soundex.rb, line 14</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">soundex</span>
+    <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">empty?</span>
+    <span class="ruby-identifier">str</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">upcase</span>
+    <span class="ruby-identifier">last_code</span> = <span class="ruby-constant">String</span>.<span class="ruby-identifier">soundex_code</span>(<span class="ruby-identifier">str</span>[<span class="ruby-value">0</span>,<span class="ruby-value">1</span>])
+    <span class="ruby-identifier">soundex_code</span> = <span class="ruby-identifier">str</span>[<span class="ruby-value">0</span>,<span class="ruby-value">1</span>]
+    <span class="ruby-keyword kw">for</span> <span class="ruby-identifier">index</span> <span class="ruby-keyword kw">in</span> <span class="ruby-value">1</span><span class="ruby-operator">...</span>(<span class="ruby-identifier">str</span>.<span class="ruby-identifier">size</span>) <span class="ruby-keyword kw">do</span>
+      <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">soundex_code</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">soundex_code</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">4</span>
+      <span class="ruby-identifier">code</span> = <span class="ruby-constant">String</span>.<span class="ruby-identifier">soundex_code</span>(<span class="ruby-identifier">str</span>[<span class="ruby-identifier">index</span>,<span class="ruby-value">1</span>])
+      <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">code</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;0&quot;</span> <span class="ruby-keyword kw">then</span>
+        <span class="ruby-identifier">last_code</span> = <span class="ruby-keyword kw">nil</span>
+      <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">code</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">then</span>
+        <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
+      <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">code</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">last_code</span> <span class="ruby-keyword kw">then</span>
+        <span class="ruby-identifier">soundex_code</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">code</span>
+        <span class="ruby-identifier">last_code</span> = <span class="ruby-identifier">code</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">soundex_code</span> <span class="ruby-operator">+</span> <span class="ruby-value str">&quot;000&quot;</span>[<span class="ruby-value">0</span>,<span class="ruby-value">4</span><span class="ruby-operator">-</span><span class="ruby-identifier">soundex_code</span>.<span class="ruby-identifier">size</span>]
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000316"></a><b>starts_with?</b>(str)
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000316_source')" id="l_M000316_source">show source</a> ]</p>
+  <div id="M000316_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/starts_with.rb, line 7</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">starts_with?</span>(<span class="ruby-identifier">str</span>)
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">index</span>( <span class="ruby-identifier">str</span> ) <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000323"></a><b>succ</b>(n=1)
+  </div>
+  <div class="description">
+  <p>
+Allows <a href="String.html#M000323">succ</a> to take <em>n</em> step
+increments.
+</p>
+<pre>
+  &quot;abc&quot;.succ      #=&gt; &quot;abd&quot;
+  &quot;abc&quot;.succ(4)   #=&gt; &quot;abg&quot;
+  &quot;abc&quot;.succ(24)  #=&gt; &quot;aca&quot;
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000323_source')" id="l_M000323_source">show source</a> ]</p>
+  <div id="M000323_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/succ.rb, line 9</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">succ</span>(<span class="ruby-identifier">n</span>=<span class="ruby-value">1</span>)
+    <span class="ruby-identifier">s</span> = <span class="ruby-keyword kw">self</span>
+    <span class="ruby-identifier">n</span>.<span class="ruby-identifier">times</span> { <span class="ruby-identifier">s</span> = <span class="ruby-identifier">s</span>.<span class="ruby-identifier">succ_once</span> }
+    <span class="ruby-identifier">s</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000347"></a><b>tab</b>(n)
+  </div>
+  <div class="description">
+  <p>
+Aligns each line n spaces. (This used to be taballto.)
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000347_source')" id="l_M000347_source">show source</a> ]</p>
+  <div id="M000347_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/indent.rb, line 7</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">tab</span>(<span class="ruby-identifier">n</span>)
+    <span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/^ */</span>, <span class="ruby-value str">' '</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">n</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000348"></a><b>tabto</b>(n)
+  </div>
+  <div class="description">
+  <p>
+Preserves relative tabbing. The first non-empty line ends up with n spaces
+before nonspace.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000348_source')" id="l_M000348_source">show source</a> ]</p>
+  <div id="M000348_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/indent.rb, line 14</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">tabto</span>(<span class="ruby-identifier">n</span>)
+    <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">self</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^( *)\S/</span>
+      <span class="ruby-identifier">indent</span>(<span class="ruby-identifier">n</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">$1</span>.<span class="ruby-identifier">length</span>)
+    <span class="ruby-keyword kw">else</span>
+      <span class="ruby-keyword kw">self</span>
+    <span class="ruby-keyword kw">end</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000337"></a><b>to_a</b>(div=//,limit=0)
+  </div>
+  <div class="description">
+  <p>
+Essentially makes <a href="String.html#M000337">to_a</a> an alias for
+split, with the excpetion that if no divider is given then the array is
+split on charaters, and NOT on the global input record divider ($/).
+</p>
+<p>
+WARNING There is a slight chance of incompatability with other libraries
+which depend on spliting with $/ (although doing so is a very bad idea!).
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000337_source')" id="l_M000337_source">show source</a> ]</p>
+  <div id="M000337_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/to_a.rb, line 14</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_a</span>(<span class="ruby-identifier">div</span>=<span class="ruby-regexp re">//</span>,<span class="ruby-identifier">limit</span>=<span class="ruby-value">0</span>)
+    <span class="ruby-identifier">split</span>(<span class="ruby-identifier">div</span>,<span class="ruby-identifier">limit</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000338"></a><b>to_b</b>()
+  </div>
+  <div class="description">
+  <p>
+Interpret common affirmative string meanings as true, otherwise false.
+Balnk sapce and case are ignored. The following strings that will return
+true:
+</p>
+<pre>
+  &lt;tt&gt;true&lt;/tt&gt;,&lt;tt&gt;yes&lt;/tt&gt;,&lt;tt&gt;on&lt;/tt&gt;,&lt;tt&gt;t&lt;/tt&gt;,&lt;tt&gt;1&lt;/tt&gt;,&lt;tt&gt;y&lt;/tt&gt;,&lt;tt&gt;==&lt;/tt&gt;
+</pre>
+<p>
+Examples:
+</p>
+<pre>
+  &quot;true&quot;.to_b   #=&gt; true
+  &quot;yes&quot;.to_b    #=&gt; true
+  &quot;no&quot;.to_b     #=&gt; false
+  &quot;123&quot;.to_b    #=&gt; false
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000338_source')" id="l_M000338_source">show source</a> ]</p>
+  <div id="M000338_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/to_b.rb, line 17</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_b</span>
+    <span class="ruby-keyword kw">case</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">downcase</span>.<span class="ruby-identifier">strip</span>
+    <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'true'</span>, <span class="ruby-value str">'yes'</span>, <span class="ruby-value str">'on'</span>, <span class="ruby-value str">'t'</span>, <span class="ruby-value str">'1'</span>, <span class="ruby-value str">'y'</span>, <span class="ruby-value str">'=='</span>
+      <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
+    <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'nil'</span>, <span class="ruby-value str">'null'</span>
+      <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
+    <span class="ruby-keyword kw">else</span>
+      <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
+    <span class="ruby-keyword kw">end</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000353"></a><b>to_const</b>()
+  </div>
+  <div class="description">
+  <p>
+Get a constant by a given string name.
+</p>
+<pre>
+  &quot;Class&quot;.to_const   #=&gt; Class
+</pre>
+<p>
+Note this method is not as verstile as it should be, since it can not
+access contants relative to the current execution context. But without a
+binding_of_caller that does not seem possible.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000353_source')" id="l_M000353_source">show source</a> ]</p>
+  <div id="M000353_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/to_const.rb, line 12</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_const</span>
+    <span class="ruby-identifier">split</span>(<span class="ruby-value str">'::'</span>).<span class="ruby-identifier">inject</span>(<span class="ruby-constant">Object</span>){ <span class="ruby-operator">|</span><span class="ruby-identifier">namespace</span>,<span class="ruby-identifier">name</span><span class="ruby-operator">|</span> <span class="ruby-identifier">namespace</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-identifier">name</span>) }
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000313"></a><b>to_date</b>()
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000313_source')" id="l_M000313_source">show source</a> ]</p>
+  <div id="M000313_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/to_date.rb, line 4</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_date</span>
+    <span class="ruby-identifier">require</span> <span class="ruby-value str">'date'</span>
+    <span class="ruby-identifier">require</span> <span class="ruby-value str">'parsedate'</span>
+    <span class="ruby-operator">::</span><span class="ruby-constant">Date</span><span class="ruby-operator">::</span><span class="ruby-identifier">civil</span>(<span class="ruby-operator">*</span><span class="ruby-constant">ParseDate</span>.<span class="ruby-identifier">parsedate</span>(<span class="ruby-keyword kw">self</span>)[<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-value">2</span>])
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000310"></a><b>to_proc</b>(context=nil)
+  </div>
+  <div class="description">
+  <p>
+Evaluates a <a href="String.html">String</a> as a <a
+href="Proc.html">Proc</a>.
+</p>
+<pre>
+  xyp = &quot;|x,y| x + y&quot;.to_proc
+  xyp.class      #=&gt; Proc
+  xyp.call(1,2)  #=&gt; 3
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000310_source')" id="l_M000310_source">show source</a> ]</p>
+  <div id="M000310_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/to_proc.rb, line 14</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_proc</span>(<span class="ruby-identifier">context</span>=<span class="ruby-keyword kw">nil</span>)
+    <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">context</span>
+      <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">context</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Binding</span>) <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">context</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Proc</span>)
+        <span class="ruby-constant">Kernel</span>.<span class="ruby-identifier">eval</span> <span class="ruby-node">&quot;proc { #{self} }&quot;</span>, <span class="ruby-identifier">context</span>
+      <span class="ruby-keyword kw">else</span> <span class="ruby-identifier">context</span>
+        <span class="ruby-identifier">context</span>.<span class="ruby-identifier">instance_eval</span> <span class="ruby-node">&quot;proc { #{self} }&quot;</span>
+      <span class="ruby-keyword kw">end</span>
+    <span class="ruby-keyword kw">else</span>
+      <span class="ruby-constant">Kernel</span>.<span class="ruby-identifier">eval</span> <span class="ruby-node">&quot;proc { #{self} }&quot;</span>
+    <span class="ruby-keyword kw">end</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000339"></a><b>to_re</b>(esc=true)
+  </div>
+  <div class="description">
+  <p>
+Turns a string into a regular expression. By default it will escape all
+characters. Use <tt>false</tt> argument to turn off escaping.
+</p>
+<pre>
+  &quot;[&quot;.to_re  #=&gt; /\[/
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000339_source')" id="l_M000339_source">show source</a> ]</p>
+  <div id="M000339_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/to_re.rb, line 10</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_re</span>(<span class="ruby-identifier">esc</span>=<span class="ruby-keyword kw">true</span>)
+    <span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">new</span>((<span class="ruby-identifier">esc</span> <span class="ruby-value">? </span><span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">escape</span>(<span class="ruby-keyword kw">self</span>) <span class="ruby-operator">:</span> <span class="ruby-keyword kw">self</span>))
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000340"></a><b>to_rx</b>()
+  </div>
+  <div class="description">
+  <p>
+Turns a string into a regular expression. Unlike <a
+href="String.html#M000339">to_re</a> this will not escape characters.
+</p>
+<pre>
+  &quot;a?&quot;.to_rx  #=&gt; /a?/
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000340_source')" id="l_M000340_source">show source</a> ]</p>
+  <div id="M000340_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/to_re.rb, line 19</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_rx</span>
+    <span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000358"></a><b>to_time</b>()
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000358_source')" id="l_M000358_source">show source</a> ]</p>
+  <div id="M000358_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/to_time.rb, line 4</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_time</span>
+    <span class="ruby-identifier">require</span> <span class="ruby-value str">'time'</span>
+    <span class="ruby-constant">Time</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-keyword kw">self</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000334"></a><b>unbracket</b>(bra=nil, ket=nil)
+  </div>
+  <div class="description">
+  <p>
+Return a new string embraced by given brakets. If only one bracket char is
+given it will be placed on either side.
+</p>
+<pre>
+  &quot;{unwrap me}&quot;.debracket('{')        #=&gt; &quot;unwrap me&quot;
+  &quot;--unwrap me!&quot;.debracket('--','!')  #=&gt; &quot;unwrap me!&quot;
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000334_source')" id="l_M000334_source">show source</a> ]</p>
+  <div id="M000334_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/unbracket.rb, line 16</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unbracket</span>(<span class="ruby-identifier">bra</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">ket</span>=<span class="ruby-keyword kw">nil</span>)
+    <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">bra</span>
+      <span class="ruby-identifier">ket</span> = <span class="ruby-constant">Sring</span>.<span class="ruby-identifier">bra2ket</span>[<span class="ruby-identifier">bra</span>] <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">ket</span>
+      <span class="ruby-identifier">ket</span> = <span class="ruby-identifier">ket</span> <span class="ruby-value">? </span><span class="ruby-identifier">ket</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">bra</span>
+      <span class="ruby-identifier">s</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">dup</span>
+      <span class="ruby-identifier">s</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-node">%r[^#{Regexp.escape(bra)}]</span>, <span class="ruby-value str">''</span>)
+      <span class="ruby-identifier">s</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-node">%r[#{Regexp.escape(ket)}$]</span>, <span class="ruby-value str">''</span>)
+      <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">s</span>
+    <span class="ruby-keyword kw">else</span>
+      <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">m</span> = <span class="ruby-constant">String</span>.<span class="ruby-identifier">bra2ket</span>[ <span class="ruby-keyword kw">self</span>[<span class="ruby-value">0</span>,<span class="ruby-value">1</span>] ]
+        <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-value">1</span><span class="ruby-operator">...</span><span class="ruby-value">-1</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">self</span>[<span class="ruby-value">-1</span>,<span class="ruby-value">1</span>]  <span class="ruby-operator">==</span> <span class="ruby-identifier">m</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-keyword kw">self</span>.<span class="ruby-identifier">dup</span>  <span class="ruby-comment cmt"># if nothing else</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000335"></a><b>unbracket!</b>(bra=nil, ket=nil)
+  </div>
+  <div class="description">
+  <p>
+Inplace version of debraket.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000335_source')" id="l_M000335_source">show source</a> ]</p>
+  <div id="M000335_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/unbracket.rb, line 33</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unbracket!</span>(<span class="ruby-identifier">bra</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">ket</span>=<span class="ruby-keyword kw">nil</span>)
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">replace</span>( <span class="ruby-identifier">unbracket</span>(<span class="ruby-identifier">bra</span>, <span class="ruby-identifier">ket</span>) )
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000376"></a><b>underscore</b>(
+  </div>
+  <div class="description">
+  <p>
+Underscore string based on camelcase characteristics.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000376_source')" id="l_M000376_source">show source</a> ]</p>
+  <div id="M000376_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/underscore.rb, line 5</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">underscore</span> <span class="ruby-comment cmt">#(camel_cased_word)</span>
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/([A-Z]+)([A-Z])/</span>,<span class="ruby-value str">'\1_\2'</span>).<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/([a-z])([A-Z])/</span>,<span class="ruby-value str">'\1_\2'</span>).<span class="ruby-identifier">downcase</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000287"></a><b>unix_crypt</b>()
+  </div>
+  <div class="description">
+  <p>
+Common Unix cryptography method.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000287_source')" id="l_M000287_source">show source</a> ]</p>
+  <div id="M000287_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/unix_crypt.rb, line 7</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unix_crypt</span>
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">crypt</span>(<span class="ruby-constant">String</span>.<span class="ruby-identifier">rand_letter</span> <span class="ruby-operator">+</span> <span class="ruby-constant">String</span>.<span class="ruby-identifier">rand_letter</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000288"></a><b>unix_crypt!</b>()
+  </div>
+  <div class="description">
+  <p>
+Common Unix cryptography in-place method.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000288_source')" id="l_M000288_source">show source</a> ]</p>
+  <div id="M000288_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/unix_crypt.rb, line 12</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unix_crypt!</span>
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">replace</span>( <span class="ruby-identifier">unix_crypt</span> )
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000298"></a><b>unpack</b>(format, offset=nil)
+  </div>
+  <div class="description">
+  <p>
+Upack with offset. Extends <a href="String.html#M000298">unpack</a> to
+allow a string to be unpacked starting at an offset position within it.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000298_source')" id="l_M000298_source">show source</a> ]</p>
+  <div id="M000298_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/unpack.rb, line 8</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unpack</span>(<span class="ruby-identifier">format</span>, <span class="ruby-identifier">offset</span>=<span class="ruby-keyword kw">nil</span>)
+    <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">offset</span>.<span class="ruby-identifier">nil?</span>
+      <span class="ruby-identifier">unpack_from_orgin</span>(<span class="ruby-identifier">format</span>)
+    <span class="ruby-keyword kw">else</span>
+      <span class="ruby-keyword kw">self</span>[<span class="ruby-identifier">offset</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>].<span class="ruby-identifier">unpack_from_orgin</span>(<span class="ruby-identifier">format</span>)
+    <span class="ruby-keyword kw">end</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000363"></a><b>unshift</b>( str=' ' )
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000363_source')" id="l_M000363_source">show source</a> ]</p>
+  <div id="M000363_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/unshift.rb, line 4</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unshift</span>( <span class="ruby-identifier">str</span>=<span class="ruby-value str">' '</span> )
+    <span class="ruby-identifier">insert</span>(<span class="ruby-value">0</span>, <span class="ruby-identifier">str</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000350"></a><b>upcase?</b>()
+  </div>
+  <div class="description">
+  <p>
+Is the string upcase/uppercase?
+</p>
+<pre>
+  &quot;THIS&quot;.upcase?  #=&gt; true
+  &quot;This&quot;.upcase?  #=&gt; false
+  &quot;this&quot;.upcase?  #=&gt; false
+</pre>
+  </div>
+<div class="aka">
+  This method is also aliased as
+  <a href="String.html#M000351">uppercase?</a>
+</div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000350_source')" id="l_M000350_source">show source</a> ]</p>
+  <div id="M000350_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/upcase.rb, line 13</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">upcase?</span>
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">upcase</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">self</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000351"></a><b>uppercase?</b>()
+  </div>
+  <div class="description">
+  <p>
+Alias for <a href="String.html#M000350">upcase?</a>
+</p>
+  </div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000312"></a><b>whitespace?</b>()
+  </div>
+  <div class="description">
+  <p>
+Alias for <a href="String.html#M000311">blank?</a>
+</p>
+  </div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000326"></a><b>whitespace?</b>()
+  </div>
+  <div class="description">
+  <p>
+Alias for <a href="String.html#M000311">blank?</a>
+</p>
+  </div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000285"></a><b>word_filter</b>( &amp;blk )
+  </div>
+  <div class="description">
+  <p>
+Filters out words from a string based on block test.
+</p>
+<pre>
+  &quot;a string&quot;.word_filter { |word| word =~ /^a/ }  #=&gt; &quot;string&quot;
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000285_source')" id="l_M000285_source">show source</a> ]</p>
+  <div id="M000285_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/word_filter.rb, line 8</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">word_filter</span>( <span class="ruby-operator">&amp;</span><span class="ruby-identifier">blk</span> )
+    <span class="ruby-identifier">s</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">dup</span>
+    <span class="ruby-identifier">s</span>.<span class="ruby-identifier">word_filter!</span>( <span class="ruby-operator">&amp;</span><span class="ruby-identifier">blk</span> )
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000286"></a><b>word_filter!</b>( {|| ...}
+  </div>
+  <div class="description">
+  <p>
+In place version of <a href="String.html#M000285">word_filter</a>.
+</p>
+<pre>
+  &quot;a string&quot;.word_filter { |word| ... }
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000286_source')" id="l_M000286_source">show source</a> ]</p>
+  <div id="M000286_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/word_filter.rb, line 17</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">word_filter!</span> <span class="ruby-comment cmt">#:yield:</span>
+    <span class="ruby-identifier">rest_of_string</span> = <span class="ruby-keyword kw">self</span>
+    <span class="ruby-identifier">wordfind</span> = <span class="ruby-regexp re">/(\w+)/</span>
+    <span class="ruby-identifier">offset</span> = <span class="ruby-value">0</span>
+    <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">wmatch</span> = <span class="ruby-identifier">wordfind</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">rest_of_string</span>)
+      <span class="ruby-identifier">word</span> = <span class="ruby-identifier">wmatch</span>[<span class="ruby-value">0</span>]
+      <span class="ruby-identifier">range</span> = <span class="ruby-identifier">offset</span><span class="ruby-operator">+</span><span class="ruby-identifier">wmatch</span>.<span class="ruby-identifier">begin</span>(<span class="ruby-value">0</span>) <span class="ruby-operator">...</span> <span class="ruby-identifier">offset</span><span class="ruby-operator">+</span><span class="ruby-identifier">wmatch</span>.<span class="ruby-identifier">end</span>(<span class="ruby-value">0</span>)
+      <span class="ruby-identifier">rest_of_string</span> = <span class="ruby-identifier">wmatch</span>.<span class="ruby-identifier">post_match</span>
+      <span class="ruby-keyword kw">self</span>[<span class="ruby-identifier">range</span>] = <span class="ruby-keyword kw">yield</span>( <span class="ruby-identifier">word</span> ).<span class="ruby-identifier">to_s</span>
+      <span class="ruby-identifier">offset</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">rest_of_string</span>.<span class="ruby-identifier">length</span>
+    <span class="ruby-keyword kw">end</span>
+    <span class="ruby-keyword kw">self</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000293"></a><b>word_wrap</b>( col_width=80 )
+  </div>
+  <div class="description">
+  <p>
+Word wrap a string not exceeding max width.
+</p>
+<pre>
+  puts &quot;this is a test&quot;.word_wrap(4)
+</pre>
+<p>
+<em>produces</em>
+</p>
+<pre>
+  this
+  is a
+  test
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000293_source')" id="l_M000293_source">show source</a> ]</p>
+  <div id="M000293_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/word_wrap.rb, line 18</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">word_wrap</span>( <span class="ruby-identifier">col_width</span>=<span class="ruby-value">80</span> )
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">dup</span>.<span class="ruby-identifier">word_wrap!</span>( <span class="ruby-identifier">col_width</span> )
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000294"></a><b>word_wrap!</b>( col_width=80 )
+  </div>
+  <div class="description">
+  <p>
+As with <a href="String.html#M000293">word_wrap</a>, but modifies the
+string in place.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000294_source')" id="l_M000294_source">show source</a> ]</p>
+  <div id="M000294_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/word_wrap.rb, line 24</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">word_wrap!</span>( <span class="ruby-identifier">col_width</span>=<span class="ruby-value">80</span> )
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">gsub!</span>( <span class="ruby-node">/(\S{#{col_width}})(?=\S)/</span>, <span class="ruby-value str">'\1 '</span> )
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">gsub!</span>( <span class="ruby-node">/(.{1,#{col_width}})(?:\s+|$)/</span>, <span class="ruby-value str">&quot;\\1\n&quot;</span> )
+    <span class="ruby-keyword kw">self</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000346"></a><b>words</b>()
+  </div>
+  <div class="description">
+  <p>
+Returns an array of characters.
+</p>
+<pre>
+  &quot;abc 123&quot;.words  #=&gt; [&quot;abc&quot;,&quot;123&quot;]
+</pre>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000346_source')" id="l_M000346_source">show source</a> ]</p>
+  <div id="M000346_source" class="dyn-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/facets/core/string/words.rb, line 8</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">words</span>
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp re">/\s+/</span>)
+  <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+</div>
+  </div>
+    </body>
+</html>