<?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 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Module: </title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <meta http-equiv="Content-Script-Type" content="text/javascript" />
  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
  <script type="text/javascript">
  // <![CDATA[

  function popupCode( url ) {
    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  }

  function toggleCode( id ) {
    if ( document.getElementById )
      elem = document.getElementById( id );
    else if ( document.all )
      elem = eval( "document.all." + id );
    else
      return false;

    elemStyle = elem.style;
    
    if ( elemStyle.display != "block" ) {
      elemStyle.display = "block"
    } else {
      elemStyle.display = "none"
    }

    return true;
  }
  
  // Make codeblocks hidden by default
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  
  // ]]>
  </script>

</head>
<body>



    <div id="classHeader">
        <table class="header-table">
        <tr class="top-aligned-row">
          <td><strong>Module</strong></td>
          <td class="class-name-in-header"></td>
        </tr>
        <tr class="top-aligned-row">
            <td><strong>In:</strong></td>
            <td>
                <a href="../files/lib/rbot/irc_rb.html">
                lib/rbot/irc.rb
                </a>
        <br />
                <a href="../files/lib/rbot/core/userdata_rb.html">
                lib/rbot/core/userdata.rb
                </a>
        <br />
                <a href="../files/lib/rbot/core/utils/httputil_rb.html">
                lib/rbot/core/utils/httputil.rb
                </a>
        <br />
                <a href="../files/lib/rbot/core/utils/utils_rb.html">
                lib/rbot/core/utils/utils.rb
                </a>
        <br />
                <a href="../files/lib/rbot/core/utils/filters_rb.html">
                lib/rbot/core/utils/filters.rb
                </a>
        <br />
                <a href="../files/lib/rbot/core/utils/parse_time_rb.html">
                lib/rbot/core/utils/parse_time.rb
                </a>
        <br />
                <a href="../files/lib/rbot/core/utils/wordlist_rb.html">
                lib/rbot/core/utils/wordlist.rb
                </a>
        <br />
                <a href="../files/lib/rbot/core/utils/extends_rb.html">
                lib/rbot/core/utils/extends.rb
                </a>
        <br />
                <a href="../files/lib/rbot/core/remote_rb.html">
                lib/rbot/core/remote.rb
                </a>
        <br />
            </td>
        </tr>

        </table>
    </div>
  <!-- banner header -->

  <div id="bodyContent">



  <div id="contextContent">
    <div id="diagram">
      <map id="map" name="map">
  <area shape="rect" coords="939,96,1011,144"      href="User.html" alt="User" />
  <area shape="rect" coords="765,96,875,144"      href="HTTPResponse.html" alt="HTTPResponse" />
  <area shape="rect" coords="591,96,724,144"      href="BasicUserMessage.html" alt="BasicUserMessage" />
  <area shape="rect" coords="335,65,559,175"      href="Bot.html" alt="Bot\n[lib/rbot/core/remote.rb\nlib/rbot/core/utils/extends.rb\nlib/rbot/core/utils/filters.rb\nlib/rbot/core/utils/wordlist.rb]" />
  <area shape="rect" coords="192,96,264,144"      href="Utils/HttpUtil.html" alt="HttpUtil" />
  <area shape="rect" coords="905,61,1044,155"      href=".././classes.html" alt="lib/rbot/core/userdata.rb" />
  <area shape="rect" coords="747,61,895,155"      href=".././classes.html" alt="lib/rbot/core/utils/httputil.rb" />
  <area shape="rect" coords="580,61,736,155"      href=".././classes.html" alt="lib/rbot/core/utils/extends.rb" />
  <area shape="rect" coords="324,31,569,185"      href=".././classes.html" alt="lib/rbot/core/remote.rb" />
  <area shape="rect" coords="155,61,303,155"      href="Utils.html" alt="lib/rbot/core/utils/httputil.rb" />
  <area shape="rect" coords="51,84,144,132"      href="Utils/ParseTime.html" alt="ParseTime" />
  <area shape="rect" coords="27,27,313,165"      href="Utils.html" alt="Utils" />
  <area shape="rect" coords="16,16,1055,196"      href=".././classes.html" alt="(null)" />
</map>
<img src="../dot/m_15_0.png" usemap="#map" border="0" alt="dot/m_15_0.png">
    </div>

    <div id="description">
      <p>
DottedIndex mixin: extend a Hash or <a href="Array.html">Array</a> class
with this module to achieve [] and []= methods that automatically split
indices at dots (indices are automatically converted to symbols, too)
</p>
<p>
You have to define the single_retrieve(<em>key</em>) and
single_assign(<em>key</em>,<em>value</em>) methods (usually aliased at the
original :[] and :[]= methods)
</p>

    </div>


   </div>

    <div id="method-list">
      <h3 class="section-bar">Methods</h3>

      <div class="name-list">
      <a href="#M000222">[]</a>&nbsp;&nbsp;
      <a href="#M000223">[]=</a>&nbsp;&nbsp;
      <a href="#M000224">conjoin</a>&nbsp;&nbsp;
      <a href="#M000221">rbot_index_split</a>&nbsp;&nbsp;
      </div>
    </div>

  </div>


    <!-- if includes -->

    <div id="section">

    <div id="class-list">
      <h3 class="section-bar">Classes and Modules</h3>

      Module <a href="Utils.html" class="link">::Utils</a><br />
Class <a href="BasicUserMessage.html" class="link">::BasicUserMessage</a><br />
Class <a href="Bot.html" class="link">::Bot</a><br />
Class <a href="HTTPResponse.html" class="link">::HTTPResponse</a><br />
Class <a href="User.html" class="link">::User</a><br />

    </div>




      


    <!-- if method_list -->
    <div id="methods">
      <h3 class="section-bar">Public Instance methods</h3>

      <div id="method-M000222" class="method-detail">
        <a name="M000222"></a>

        <div class="method-heading">
          <a href="#M000222" class="method-signature">
          <span class="method-name">[]</span><span class="method-args">(*ar)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p><a class="source-toggle" href="#"
            onclick="toggleCode('M000222-source');return false;">[Source]</a></p>
          <div class="method-source-code" id="M000222-source">
<pre>
    <span class="ruby-comment cmt"># File lib/rbot/core/utils/extends.rb, line 55</span>
55:   <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">ar</span>)
56:     <span class="ruby-identifier">keys</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">rbot_index_split</span>(<span class="ruby-identifier">ar</span>)
57:     <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">single_retrieve</span>(<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">first</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">keys</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
58:     <span class="ruby-identifier">h</span> = <span class="ruby-keyword kw">self</span>
59:     <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">keys</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">1</span>
60:       <span class="ruby-identifier">k</span> = <span class="ruby-identifier">keys</span>.<span class="ruby-identifier">shift</span>
61:       <span class="ruby-identifier">h</span>[<span class="ruby-identifier">k</span>] <span class="ruby-operator">||=</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">new</span>
62:       <span class="ruby-identifier">h</span> = <span class="ruby-identifier">h</span>[<span class="ruby-identifier">k</span>]
63:     <span class="ruby-keyword kw">end</span>
64:     <span class="ruby-identifier">h</span>[<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">last</span>]
65:   <span class="ruby-keyword kw">end</span>
</pre>
          </div>
        </div>
      </div>

      <div id="method-M000223" class="method-detail">
        <a name="M000223"></a>

        <div class="method-heading">
          <a href="#M000223" class="method-signature">
          <span class="method-name">[]=</span><span class="method-args">(*arr)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p><a class="source-toggle" href="#"
            onclick="toggleCode('M000223-source');return false;">[Source]</a></p>
          <div class="method-source-code" id="M000223-source">
<pre>
    <span class="ruby-comment cmt"># File lib/rbot/core/utils/extends.rb, line 67</span>
67:   <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]=</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">arr</span>)
68:     <span class="ruby-identifier">val</span> = <span class="ruby-identifier">arr</span>.<span class="ruby-identifier">last</span>
69:     <span class="ruby-identifier">ar</span> = <span class="ruby-identifier">arr</span>[<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-value">-2</span>]
70:     <span class="ruby-identifier">keys</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">rbot_index_split</span>(<span class="ruby-identifier">ar</span>)
71:     <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">single_assign</span>(<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">first</span>, <span class="ruby-identifier">val</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">keys</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
72:     <span class="ruby-identifier">h</span> = <span class="ruby-keyword kw">self</span>
73:     <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">keys</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">1</span>
74:       <span class="ruby-identifier">k</span> = <span class="ruby-identifier">keys</span>.<span class="ruby-identifier">shift</span>
75:       <span class="ruby-identifier">h</span>[<span class="ruby-identifier">k</span>] <span class="ruby-operator">||=</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">new</span>
76:       <span class="ruby-identifier">h</span> = <span class="ruby-identifier">h</span>[<span class="ruby-identifier">k</span>]
77:     <span class="ruby-keyword kw">end</span>
78:     <span class="ruby-identifier">h</span>[<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">last</span>] = <span class="ruby-identifier">val</span>
79:   <span class="ruby-keyword kw">end</span>
</pre>
          </div>
        </div>
      </div>

      <div id="method-M000224" class="method-detail">
        <a name="M000224"></a>

        <div class="method-heading">
          <a href="#M000224" class="method-signature">
          <span class="method-name">conjoin</span><span class="method-args">(*args) {|i, *slice(i, 2)| ...}</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
This method is an advanced version of join allowing fine control of
separators:
</p>
<pre>
  [1,2,3].conjoin(', ', ' and ')
  =&gt; &quot;1, 2 and 3

  [1,2,3,4].conjoin{ |i, a, b| i % 2 == 0 ? '.' : '-' }
  =&gt; &quot;1.2-3.4&quot;
</pre>
<p>
Code lifted from the ruby facets project: &lt;<a
href="http://facets.rubyforge.org">facets.rubyforge.org</a>&gt; git-rev:
c8b7395255b977d3c7de268ff563e3c5bc7f1441 file:
lib/core/facets/array/conjoin.rb
</p>
          <p><a class="source-toggle" href="#"
            onclick="toggleCode('M000224-source');return false;">[Source]</a></p>
          <div class="method-source-code" id="M000224-source">
<pre>
     <span class="ruby-comment cmt"># File lib/rbot/core/utils/extends.rb, line 143</span>
143:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">conjoin</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
144:     <span class="ruby-identifier">num</span> = <span class="ruby-identifier">count</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>
145: 
146:     <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">first</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">num</span> <span class="ruby-operator">&lt;</span> <span class="ruby-value">1</span>
147: 
148:     <span class="ruby-identifier">sep</span> = []
149: 
150:     <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
151:       <span class="ruby-identifier">num</span>.<span class="ruby-identifier">times</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
152:         <span class="ruby-identifier">sep</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-keyword kw">yield</span>(<span class="ruby-identifier">i</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">slice</span>(<span class="ruby-identifier">i</span>, <span class="ruby-value">2</span>))
153:       <span class="ruby-keyword kw">end</span>
154:     <span class="ruby-keyword kw">else</span>
155:       <span class="ruby-identifier">options</span> = (<span class="ruby-constant">Hash</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">last</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">pop</span> <span class="ruby-operator">:</span> {}
156:       <span class="ruby-identifier">separator</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">shift</span> <span class="ruby-operator">||</span> <span class="ruby-value str">&quot;&quot;</span>
157:       <span class="ruby-identifier">options</span>[<span class="ruby-value">-1</span>] = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">shift</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">empty?</span>
158: 
159:       <span class="ruby-identifier">sep</span> = [<span class="ruby-identifier">separator</span>] <span class="ruby-operator">*</span> <span class="ruby-identifier">num</span>
160: 
161:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-identifier">:last</span>)
162:         <span class="ruby-identifier">options</span>[<span class="ruby-value">-1</span>] = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">:last</span>)
163:       <span class="ruby-keyword kw">end</span>
164:       <span class="ruby-identifier">options</span>[<span class="ruby-value">-1</span>] <span class="ruby-operator">||=</span> <span class="ruby-identifier">_</span>(<span class="ruby-value str">&quot; and &quot;</span>)
165: 
166:       <span class="ruby-identifier">options</span>.<span class="ruby-identifier">each</span>{ <span class="ruby-operator">|</span><span class="ruby-identifier">i</span>, <span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">sep</span>[<span class="ruby-identifier">i</span>] = <span class="ruby-identifier">s</span> }
167:     <span class="ruby-keyword kw">end</span>
168: 
169:     <span class="ruby-identifier">zip</span>(<span class="ruby-identifier">sep</span>).<span class="ruby-identifier">join</span>
170:   <span class="ruby-keyword kw">end</span>
</pre>
          </div>
        </div>
      </div>

      <div id="method-M000221" class="method-detail">
        <a name="M000221"></a>

        <div class="method-heading">
          <a href="#M000221" class="method-signature">
          <span class="method-name">rbot_index_split</span><span class="method-args">(*ar)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p><a class="source-toggle" href="#"
            onclick="toggleCode('M000221-source');return false;">[Source]</a></p>
          <div class="method-source-code" id="M000221-source">
<pre>
    <span class="ruby-comment cmt"># File lib/rbot/core/utils/extends.rb, line 48</span>
48:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rbot_index_split</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">ar</span>)
49:     <span class="ruby-identifier">keys</span> = ([] <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">ar</span>).<span class="ruby-identifier">flatten</span>
50:     <span class="ruby-identifier">keys</span>.<span class="ruby-identifier">map!</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span><span class="ruby-operator">|</span>
51:       <span class="ruby-identifier">k</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">'.'</span>).<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">kk</span><span class="ruby-operator">|</span> <span class="ruby-identifier">kk</span>.<span class="ruby-identifier">to_sym</span> <span class="ruby-keyword kw">rescue</span> <span class="ruby-keyword kw">nil</span> }.<span class="ruby-identifier">compact</span>
52:     }.<span class="ruby-identifier">flatten</span>
53:   <span class="ruby-keyword kw">end</span>
</pre>
          </div>
        </div>
      </div>


    </div>


  </div>


<div id="validator-badges">
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>