PageRenderTime 57ms CodeModel.GetById 28ms RepoModel.GetById 0ms app.codeStats 1ms

/gems/gems/facets-2.4.3/doc/rdoc/more/classes/EnumerablePass.html

https://github.com/teejayvanslyke/terminus
HTML | 216 lines | 193 code | 22 blank | 1 comment | 0 complexity | ceac151044897acb86366f6e65165e8a MD5 | raw file
Possible License(s): AGPL-1.0, GPL-2.0 
    

  1. <?xml version="1.0" encoding="iso-8859-1"?>
    2. 

  2. <!DOCTYPE html 
    3. 

  3.      PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    4. 

  4.      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    5. 

  5. <html>
    6. 

  6.   <head>
    7. 

  7.     <title>Module: EnumerablePass</title>
    8. 

  8.     <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
    9. 

  9.     <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
    10. 

  10. 

  11.     <script language="JavaScript" type="text/javascript">
    12. 

  12.     // <![CDATA[
    13. 

  13. 

  14.         function toggleSource( id )
    15. 

  15.         {
    16. 

  16.           var elem
    17. 

  17.           var link
    18. 

  18. 

  19.           if( document.getElementById )
    20. 

  20.           {
    21. 

  21.             elem = document.getElementById( id )
    22. 

  22.             link = document.getElementById( "l_" + id )
    23. 

  23.           }
    24. 

  24.           else if ( document.all )
    25. 

  25.           {
    26. 

  26.             elem = eval( "document.all." + id )
    27. 

  27.             link = eval( "document.all.l_" + id )
    28. 

  28.           }
    29. 

  29.           else
    30. 

  30.             return false;
    31. 

  31. 

  32.           if( elem.style.display == "block" )
    33. 

  33.           {
    34. 

  34.             elem.style.display = "none"
    35. 

  35.             link.innerHTML = "show source"
    36. 

  36.           }
    37. 

  37.           else
    38. 

  38.           {
    39. 

  39.             elem.style.display = "block"
    40. 

  40.             link.innerHTML = "hide source"
    41. 

  41.           }
    42. 

  42.         }
    43. 

  43. 

  44.         function openCode( url )
    45. 

  45.         {
    46. 

  46.           window.open( url, "SOURCE_CODE", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=480,width=750" ).focus();
    47. 

  47.         }
    48. 

  48.       // ]]>
    49. 

  49.     </script>
    50. 

  50.   </head>
    51. 

  51. 

  52.   <body>
    53. 

  53.   <table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'><tr>
    54. 

  54.   <td class="file-title"><span class="file-title-prefix">Module</span><br />EnumerablePass</td>
    55. 

  55.   <td align="right">
    56. 

  56.     <table cellspacing="0" cellpadding="2">
    57. 

  57.       <tr valign="top">
    58. 

  58.         <td>In:</td>
    59. 

  59.         <td>
    60. 

  60. <a href="../files/lib/more/facets/enumerablepass_rb.html">lib/more/facets/enumerablepass.rb</a>
    61. 

  61.         </td>
    62. 

  62.       </tr>
    63. 

  63.          </table>
    64. 

  64.         </td>
    65. 

  65.         </tr>
    66. 

  66.       </table>
    67. 

  67.  <!-- banner header -->
    68. 

  68. 

  69.   <div id="bodyContent">
    70. 

  70.       <div id="content">
    71. 

  71. 

  72.   <div class="description"><h1><a href="EnumerablePass.html">EnumerablePass</a></h1>
    73. 

  73. <p>
    74. 

  74. This is a simple reimplementation of the core <a
    75. 

  75. href="Enumerable.html">Enumerable</a> module to allow the methods to take
    76. 

  76. and pass-on arbitrary arguments to the underlying each call. This library
    77. 

  77. uses Enumerator and scans <a href="Enumerable.html">Enumerable</a> so it
    78. 

  78. can alwasy stay in sync.
    79. 

  79. </p>
    80. 

  80. <p>
    81. 

  81. NOTE Any <a href="Enumerable.html">Enumerable</a> method with a negative
    82. 

  82. arity cannot do pass arguments due to ambiguity in the argument count. So
    83. 

  83. the methods inject and zip do NOT work this way, but simply work as they do
    84. 

  84. in <a href="Enumerable.html">Enumerable</a>. The method <a
    85. 

  85. href="EnumerablePass.html#M000782">find</a> (and <a
    86. 

  86. href="EnumerablePass.html#M000783">detect</a>) though has been made to work
    87. 

  87. by removing its rarely used optional parameter and providing instead an
    88. 

  88. optional keyword parameter (:ifnone =&gt; &#8230;). Please keep these
    89. 

  89. difference in mind.
    90. 

  90. </p>
    91. 

  91. <pre>
    92. 

  92.   class T
    93. 

  93.     include EnumerablePass
    94. 

  94.     def initialize(arr)
    95. 

  95.       @arr = arr
    96. 

  96.     end
    97. 

  97.     def each(n)
    98. 

  98.       arr.each{ |e| yield(e+n) }
    99. 

  99.     end
    100. 

  100.   end
    101. 

  101. 

  102.   t = T.new([1,2,3])
    103. 

  103.   t.collect(4)
    104. 

  104.   #=&gt; [5,6,7]
    105. 

  105. </pre>
    106. 

  106. </div>
    107. 

  107. 

  108. 

  109. 

  110.   <div class="sectiontitle">Methods</div>
    111. 

  111.   <ul>
    112. 

  112.   <li><a href="#M000783">detect</a></li>
    113. 

  113.   <li><a href="#M000782">find</a></li>
    114. 

  114.   <li><a href="#M000781">wrap_enumerable_method</a></li>
    115. 

  115.   </ul>
    116. 

  116. 

  117. 

  118. 

  119. 

  120. 

  121. 

  122. <div class="sectiontitle">Public Class methods</div>
    123. 

  123. <div class="method">
    124. 

  124.   <div class="title">
    125. 

  125.     <a name="M000781"></a><b>wrap_enumerable_method</b>( methodname )
    126. 

  126.   </div>
    127. 

  127. <div class="sourcecode">
    128. 

  128.   <p class="source-link">[ <a href="javascript:toggleSource('M000781_source')" id="l_M000781_source">show source</a> ]</p>
    129. 

  129.   <div id="M000781_source" class="dyn-source">
    130. 

  130. <pre>
    131. 

  131. <span class="ruby-comment cmt"># File lib/more/facets/enumerablepass.rb, line 78</span>
    132. 

  132.   <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">wrap_enumerable_method</span>( <span class="ruby-identifier">methodname</span> )
    133. 

  133. 

  134.     <span class="ruby-identifier">m</span> = <span class="ruby-identifier">methodname</span>
    135. 

  135.     <span class="ruby-identifier">meth</span> = <span class="ruby-constant">Enumerable</span>.<span class="ruby-identifier">instance_method</span>(<span class="ruby-identifier">m</span>)
    136. 

  136.     <span class="ruby-identifier">arity</span> = <span class="ruby-identifier">meth</span>.<span class="ruby-identifier">arity</span>
    137. 

  137. 

  138.     <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">arity</span> <span class="ruby-operator">&lt;=&gt;</span> <span class="ruby-value">0</span>
    139. 

  139.     <span class="ruby-keyword kw">when</span> <span class="ruby-value">0</span>
    140. 

  140.       <span class="ruby-identifier">class_eval</span> <span class="ruby-node">%{
    141. 

  141.         def #{m}( *args, &amp;yld )
    142. 

  142.           enum_for(:each, *args).#{m}( &amp;yld )
    143. 

  143.         end
    144. 

  144.       }</span>
    145. 

  145.     <span class="ruby-keyword kw">when</span> <span class="ruby-value">1</span>
    146. 

  146.       <span class="ruby-identifier">class_eval</span> <span class="ruby-node">%{
    147. 

  147.         def #{m}( *args, &amp;yld )
    148. 

  148.           args, each_args = args[0...#{arity}], args[#{arity}..-1]
    149. 

  149.           enum_for(:each, *each_args).#{m}( *args, &amp;yld )
    150. 

  150.         end
    151. 

  151.       }</span>
    152. 

  152.     <span class="ruby-keyword kw">else</span>
    153. 

  153.       <span class="ruby-identifier">class_eval</span> <span class="ruby-node">%{
    154. 

  154.         def #{m}( *args, &amp;yld )
    155. 

  155.           enum_for(:each).#{m}( *args, &amp;yld )
    156. 

  156.         end
    157. 

  157.       }</span>
    158. 

  158.     <span class="ruby-keyword kw">end</span>
    159. 

  159.   <span class="ruby-keyword kw">end</span>
    160. 

  160. </pre>
    161. 

  161.   </div>
    162. 

  162. </div>
    163. 

  163. </div>
    164. 

  164. <div class="sectiontitle">Public Instance methods</div>
    165. 

  165. <div class="method">
    166. 

  166.   <div class="title">
    167. 

  167.     <a name="M000783"></a><b>detect</b>(*args, &amp;yld)
    168. 

  168.   </div>
    169. 

  169.   <div class="description">
    170. 

  170.   <p>
    171. 

  171. Alias for <a href="EnumerablePass.html#M000782">find</a>
    172. 

  172. </p>
    173. 

  173.   </div>
    174. 

  174. </div>
    175. 

  175. <div class="method">
    176. 

  176.   <div class="title">
    177. 

  177.     <a name="M000782"></a><b>find</b>(*args, &amp;yld)
    178. 

  178.   </div>
    179. 

  179.   <div class="description">
    180. 

  180.   <p>
    181. 

  181. Make exception for <a href="EnumerablePass.html#M000782">find</a> (a
    182. 

  182. negative arity method) to accept keyword argument.
    183. 

  183. </p>
    184. 

  184. <pre>
    185. 

  185.   ObjectSpace.find(Class, :ifnone=&gt;lambda{1}) { |e| ... }
    186. 

  186.   ObjectSpace.find(Class, :ifnone=&gt;lambda{1}) { |e| ... }
    187. 

  187. </pre>
    188. 

  188.   </div>
    189. 

  189. <div class="aka">
    190. 

  190.   This method is also aliased as
    191. 

  191.   <a href="EnumerablePass.html#M000783">detect</a>
    192. 

  192. </div>
    193. 

  193. <div class="sourcecode">
    194. 

  194.   <p class="source-link">[ <a href="javascript:toggleSource('M000782_source')" id="l_M000782_source">show source</a> ]</p>
    195. 

  195.   <div id="M000782_source" class="dyn-source">
    196. 

  196. <pre>
    197. 

  197. <span class="ruby-comment cmt"># File lib/more/facets/enumerablepass.rb, line 117</span>
    198. 

  198.   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">find</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">yld</span>)  <span class="ruby-comment cmt"># future use **keys ?</span>
    199. 

  199.     <span class="ruby-keyword kw">if</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-keyword kw">and</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-identifier">:ifnone</span>)
    200. 

  200.       <span class="ruby-identifier">ifnone</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">:ifnone</span>)
    201. 

  201.       <span class="ruby-identifier">args</span>.<span class="ruby-identifier">pop</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">empty?</span>
    202. 

  202.       <span class="ruby-identifier">enum_for</span>(<span class="ruby-identifier">:each</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>).<span class="ruby-identifier">find</span>( <span class="ruby-identifier">ifnone</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">yld</span> )
    203. 

  203.     <span class="ruby-keyword kw">else</span>
    204. 

  204.       <span class="ruby-identifier">enum_for</span>(<span class="ruby-identifier">:each</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>).<span class="ruby-identifier">find</span>( <span class="ruby-operator">&amp;</span><span class="ruby-identifier">yld</span> )
    205. 

  205.     <span class="ruby-keyword kw">end</span>
    206. 

  206.   <span class="ruby-keyword kw">end</span>
    207. 

  207. </pre>
    208. 

  208.   </div>
    209. 

  209. </div>
    210. 

  210. </div>
    211. 

  211. </div>
    212. 

  212. 

  213.   </div>
    214. 

  214. 

  215.     </body>
    216. 

  216. </html>
    217.