<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title> Class: Discorb::Dictionary — Documentation by YARD 0.9.26 </title> <link rel="stylesheet" href="../css/style.css" type="text/css" /> <link rel="stylesheet" href="../css/common.css" type="text/css" /> <script type="text/javascript"> pathId = "Discorb::Dictionary"; relpath = '../'; </script> <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> <script type="text/javascript" charset="utf-8" src="../js/app.js"></script> </head> <body> <div class="nav_wrap"> <iframe id="nav" src="../class_list.html?1"></iframe> <div id="resizer"></div> </div> <div id="main" tabindex="-1"> <div id="header"> <div id="menu"> <a href="../a_index.html">Index (D)</a> » <span class='title'><span class='object_link'><a href="../Discorb.html" title="Discorb (module)">Discorb</a></span></span> » <span class="title">Dictionary</span> </div> <div id="search"> <a class="full_list_link" id="class_list_link" href="../class_list.html"> <svg width="24" height="24"> <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect> <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect> <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect> </svg> </a> </div> <div class="clear"></div> </div> <div id="content"><h1>Class: Discorb::Dictionary </h1> <div class="box_info"> <dl> <dt>Inherits:</dt> <dd> <span class="inheritName">Object</span> <ul class="fullTree"> <li>Object</li> <li class="next">Discorb::Dictionary</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> </dl> <dl> <dt>Defined in:</dt> <dd>lib/discorb/dictionary.rb</dd> </dl> </div> <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2> <ul class="summary"> <li class="public "> <span class="summary_signature"> <a href="#limit-instance_method" title="#limit (instance method)">#<strong>limit</strong> ⇒ Integer </a> </span> <span class="summary_desc"><div class='inline'><p>The maximum number of items in the dictionary.</p> </div></span> </li> </ul> <h2> Instance Method Summary <small><a href="#" class="summary_toggle">collapse</a></small> </h2> <ul class="summary"> <li class="public "> <span class="summary_signature"> <a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(index) ⇒ Object<sup>?</sup> </a> (also: #[]) </span> <span class="summary_desc"><div class='inline'><p>Get an item from the dictionary.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#has%3F-instance_method" title="#has? (instance method)">#<strong>has?</strong>(id) ⇒ Boolean </a> </span> <span class="summary_desc"><div class='inline'><p>Checks if the dictionary has an ID.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(hash = {}, limit: nil, sort: false) ⇒ Dictionary </a> </span> <span class="note title constructor">constructor</span> <span class="summary_desc"><div class='inline'><p>Initialize a new Dictionary.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#inspect-instance_method" title="#inspect (instance method)">#<strong>inspect</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#merge-instance_method" title="#merge (instance method)">#<strong>merge</strong>(other) ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'><p>Merges another dictionary into this one.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#method_missing-instance_method" title="#method_missing (instance method)">#<strong>method_missing</strong>(name) ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#register-instance_method" title="#register (instance method)">#<strong>register</strong>(id, body) ⇒ self </a> (also: #[]=) </span> <span class="summary_desc"><div class='inline'><p>Registers a new item in the dictionary.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#remove-instance_method" title="#remove (instance method)">#<strong>remove</strong>(id) ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'><p>Removes an item from the dictionary.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#respond_to_missing%3F-instance_method" title="#respond_to_missing? (instance method)">#<strong>respond_to_missing?</strong>(name, args, kwargs) ⇒ Boolean </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#values-instance_method" title="#values (instance method)">#<strong>values</strong> ⇒ Array </a> </span> <span class="summary_desc"><div class='inline'><p>Returns the values of the dictionary.</p> </div></span> </li> </ul> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method"> #<strong>initialize</strong>(hash = {}, limit: nil, sort: false) ⇒ <tt><span class='object_link'><a href="" title="Discorb::Dictionary (class)">Dictionary</a></span></tt> </h3><div class="docstring"> <div class="discussion"> <p>Initialize a new Dictionary.</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>hash</span> <span class='type'>(<tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>{}</tt>)</em> — <div class='inline'><p>A hash of items to add to the dictionary.</p> </div> </li> <li> <span class='name'>limit</span> <span class='type'>(<tt>Integer</tt>)</span> <em class="default">(defaults to: <tt>nil</tt>)</em> — <div class='inline'><p>The maximum number of items in the dictionary.</p> </div> </li> <li> <span class='name'>sort</span> <span class='type'>(<tt>false</tt>, <tt>Proc</tt>)</span> <em class="default">(defaults to: <tt>false</tt>)</em> — <div class='inline'><p>Whether to sort the items in the dictionary.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 15 16 17 18 19</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/dictionary.rb', line 15</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>sort:</span> <span class='kw'>false</span><span class='rparen'>)</span> <span class='ivar'>@cache</span> <span class='op'>=</span> <span class='id identifier rubyid_hash'>hash</span><span class='period'>.</span><span class='id identifier rubyid_transform_keys'>transform_keys</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:to_s</span><span class='rparen'>)</span> <span class='ivar'>@limit</span> <span class='op'>=</span> <span class='id identifier rubyid_limit'>limit</span> <span class='ivar'>@sort</span> <span class='op'>=</span> <span class='id identifier rubyid_sort'>sort</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> <div id="method_missing_details" class="method_details_list"> <h2>Dynamic Method Handling</h2> <p class="notice this"> This class handles dynamic methods through the <tt>method_missing</tt> method </p> <div class="method_details first"> <h3 class="signature first" id="method_missing-instance_method"> #<strong>method_missing</strong>(name) ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 96 97 98 99 100 101 102</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/dictionary.rb', line 96</span> <span class='kw'>def</span> <span class='id identifier rubyid_method_missing'>method_missing</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='op'>...</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_values'>values</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span> <span class='id identifier rubyid_values'>values</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='op'>...</span><span class='rparen'>)</span> <span class='kw'>else</span> <span class='kw'>super</span> <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> <div id="instance_attr_details" class="attr_details"> <h2>Instance Attribute Details</h2> <span id="limit=-instance_method"></span> <div class="method_details first"> <h3 class="signature first" id="limit-instance_method"> #<strong>limit</strong> ⇒ <tt>Integer</tt> </h3><div class="docstring"> <div class="discussion"> <p>Returns The maximum number of items in the dictionary.</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Integer</tt>)</span> — <div class='inline'><p>The maximum number of items in the dictionary.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 6 7 8</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/dictionary.rb', line 6</span> <span class='kw'>def</span> <span class='id identifier rubyid_limit'>limit</span> <span class='ivar'>@limit</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="get-instance_method"> #<strong>get</strong>(index) ⇒ <tt>Object</tt><sup>?</sup> <span class="aliases">Also known as: <span class="names"><span id='[]-instance_method'>[]</span></span> </span> </h3><div class="docstring"> <div class="discussion"> <p>Get an item from the dictionary.</p> </div> </div> <div class="tags"> <div class="docstring"> <div class="discussion"> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>index</span> <span class='type'>(<tt>Integer</tt>)</span> — <div class='inline'><p>The index of the item.</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Object</tt>)</span> — <div class='inline'><p>The item.</p> </div> </li> <li> <span class='type'>(<tt>nil</tt>)</span> — <div class='inline'><p>if the item is not found.</p> </div> </li> </ul> </div> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>id</span> <span class='type'>(<tt>#to_s</tt>)</span> — <div class='inline'><p>The ID of the item.</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Object</tt>)</span> — <div class='inline'><p>The item.</p> </div> </li> <li> <span class='type'>(<tt>nil</tt>)</span> — <div class='inline'><p>if the item was not found.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 67 68 69 70 71 72 73 74</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/dictionary.rb', line 67</span> <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span> <span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <span class='ivar'>@cache</span><span class='lbracket'>[</span><span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_res'>res</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>&&</span> <span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Integer</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_id'>id</span> <span class='op'><</span> <span class='ivar'>@cache</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='ivar'>@cache</span><span class='period'>.</span><span class='id identifier rubyid_values'>values</span><span class='lbracket'>[</span><span class='id identifier rubyid_id'>id</span><span class='rbracket'>]</span> <span class='kw'>else</span> <span class='id identifier rubyid_res'>res</span> <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="has?-instance_method"> #<strong>has?</strong>(id) ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> <p>Checks if the dictionary has an ID.</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>id</span> <span class='type'>(<tt>#to_s</tt>)</span> — <div class='inline'><p>The ID to check.</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Boolean</tt>)</span> — <div class='inline'><p><code>true</code> if the dictionary has the ID, <code>false</code> otherwise.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 92 93 94</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/dictionary.rb', line 92</span> <span class='kw'>def</span> <span class='id identifier rubyid_has?'>has?</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span> <span class='op'>!</span><span class='kw'>self</span><span class='lbracket'>[</span><span class='id identifier rubyid_id'>id</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="inspect-instance_method"> #<strong>inspect</strong> ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 115 116 117</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/dictionary.rb', line 115</span> <span class='kw'>def</span> <span class='id identifier rubyid_inspect'>inspect</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>#<</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_values'>values</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span><span class='embexpr_end'>}</span><span class='tstring_content'> items></span><span class='tstring_end'>"</span></span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="merge-instance_method"> #<strong>merge</strong>(other) ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>Merges another dictionary into this one.</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>other</span> <span class='type'>(<tt><span class='object_link'><a href="" title="Discorb::Dictionary (class)">Discorb::Dictionary</a></span></tt>)</span> — <div class='inline'><p>The dictionary to merge.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 41 42 43</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/dictionary.rb', line 41</span> <span class='kw'>def</span> <span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span> <span class='ivar'>@cache</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="register-instance_method"> #<strong>register</strong>(id, body) ⇒ <tt>self</tt> <span class="aliases">Also known as: <span class="names"><span id='[]=-instance_method'>[]=</span></span> </span> </h3><div class="docstring"> <div class="discussion"> <p>Registers a new item in the dictionary.</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>id</span> <span class='type'>(<tt>#to_s</tt>)</span> — <div class='inline'><p>The ID of the item.</p> </div> </li> <li> <span class='name'>body</span> <span class='type'>(<tt>Object</tt>)</span> — <div class='inline'><p>The item to register.</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>self</tt>)</span> — <div class='inline'><p>The dictionary.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 29 30 31 32 33 34</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/dictionary.rb', line 29</span> <span class='kw'>def</span> <span class='id identifier rubyid_register'>register</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span> <span class='ivar'>@cache</span><span class='lbracket'>[</span><span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_body'>body</span> <span class='ivar'>@cache</span> <span class='op'>=</span> <span class='ivar'>@cache</span><span class='period'>.</span><span class='id identifier rubyid_sort_by'>sort_by</span><span class='lparen'>(</span><span class='op'>&</span><span class='ivar'>@sort</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_h'>to_h</span> <span class='kw'>if</span> <span class='ivar'>@sort</span> <span class='ivar'>@cache</span><span class='period'>.</span><span class='id identifier rubyid_remove'>remove</span><span class='lparen'>(</span><span class='ivar'>@cache</span><span class='period'>.</span><span class='id identifier rubyid_values'>values</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='op'>!</span><span class='ivar'>@limit</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>&&</span> <span class='ivar'>@cache</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>></span> <span class='ivar'>@limit</span> <span class='id identifier rubyid_body'>body</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="remove-instance_method"> #<strong>remove</strong>(id) ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>Removes an item from the dictionary.</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>id</span> <span class='type'>(<tt>#to_s</tt>)</span> — <div class='inline'><p>The ID of the item to remove.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 50 51 52</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/dictionary.rb', line 50</span> <span class='kw'>def</span> <span class='id identifier rubyid_remove'>remove</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span> <span class='ivar'>@cache</span><span class='period'>.</span><span class='id identifier rubyid_remove'>remove</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="respond_to_missing?-instance_method"> #<strong>respond_to_missing?</strong>(name, args, kwargs) ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Boolean</tt>)</span> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 104 105 106 107 108 109 110</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/dictionary.rb', line 104</span> <span class='kw'>def</span> <span class='id identifier rubyid_respond_to_missing?'>respond_to_missing?</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_values'>values</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span> <span class='kw'>true</span> <span class='kw'>else</span> <span class='kw'>super</span> <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="values-instance_method"> #<strong>values</strong> ⇒ <tt>Array</tt> </h3><div class="docstring"> <div class="discussion"> <p>Returns the values of the dictionary.</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Array</tt>)</span> — <div class='inline'><p>The values of the dictionary.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 81 82 83</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/dictionary.rb', line 81</span> <span class='kw'>def</span> <span class='id identifier rubyid_values'>values</span> <span class='ivar'>@cache</span><span class='period'>.</span><span class='id identifier rubyid_values'>values</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated from <a href="https://github.com/discorb-lib/discorb/tree/27a4a46a8d847860751d0c3758742f6c09cec01b"><code>27a4a46a8d847860751d0c3758742f6c09cec01b</code></a>, version v0.0.5, with YARD 0.9.26. </div> </div> </body> </html>