rack-auth-ip 0.0.1 → 0.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (21) hide show
  1. data/Rakefile +2 -2
  2. data/doc/output/coverage/-Library-Ruby-Gems-gems-diff-lcs-1_1_2-lib-diff-lcs-block_rb.html +1 -1
  3. data/doc/output/coverage/-Library-Ruby-Gems-gems-diff-lcs-1_1_2-lib-diff-lcs-callbacks_rb.html +1 -1
  4. data/doc/output/coverage/-Library-Ruby-Gems-gems-diff-lcs-1_1_2-lib-diff-lcs-change_rb.html +1 -1
  5. data/doc/output/coverage/-Library-Ruby-Gems-gems-diff-lcs-1_1_2-lib-diff-lcs-hunk_rb.html +1 -1
  6. data/doc/output/coverage/-Library-Ruby-Gems-gems-diff-lcs-1_1_2-lib-diff-lcs_rb.html +1 -1
  7. data/doc/output/coverage/-Library-Ruby-Gems-gems-rcov-0_8_1_2_0-lib-rcov_rb.html +989 -989
  8. data/doc/output/coverage/-System-Library-Frameworks-Ruby_framework-Versions-1_8-usr-lib-ruby-1_8-drb-drb_rb.html +1764 -1764
  9. data/doc/output/coverage/-System-Library-Frameworks-Ruby_framework-Versions-1_8-usr-lib-ruby-1_8-drb-eq_rb.html +17 -17
  10. data/doc/output/coverage/-System-Library-Frameworks-Ruby_framework-Versions-1_8-usr-lib-ruby-1_8-drb-invokemethod_rb.html +37 -37
  11. data/doc/output/coverage/-System-Library-Frameworks-Ruby_framework-Versions-1_8-usr-lib-ruby-1_8-forwardable_rb.html +219 -219
  12. data/doc/output/coverage/-System-Library-Frameworks-Ruby_framework-Versions-1_8-usr-lib-ruby-1_8-ipaddr_rb.html +530 -530
  13. data/doc/output/coverage/-System-Library-Frameworks-Ruby_framework-Versions-1_8-usr-lib-ruby-1_8-pp_rb.html +648 -648
  14. data/doc/output/coverage/-System-Library-Frameworks-Ruby_framework-Versions-1_8-usr-lib-ruby-1_8-prettyprint_rb.html +897 -897
  15. data/doc/output/coverage/-System-Library-Frameworks-Ruby_framework-Versions-1_8-usr-lib-ruby-1_8-timeout_rb.html +106 -106
  16. data/doc/output/coverage/index.html +11 -65
  17. data/doc/output/coverage/lib-rack-auth-ip_rb.html +51 -53
  18. data/lib/rack/auth/ip.rb +1 -1
  19. metadata +2 -4
  20. data/doc/output/coverage/-Library-Ruby-Gems-gems-rack-0_3_0-lib-rack-auth-abstract-handler_rb.html +0 -638
  21. data/doc/output/coverage/-Library-Ruby-Gems-gems-rack-0_3_0-lib-rack-auth-abstract-request_rb.html +0 -647
@@ -553,7 +553,7 @@ span.run100 {
553
553
  </style>
554
554
  </head>
555
555
  <body><h3>C0 code coverage information</h3>
556
- <p>Generated on Sat May 24 14:04:39 +0900 2008 with <a href='http://eigenclass.org/hiki/rcov'>rcov 0.8.1.2</a>
556
+ <p>Generated on Sat May 24 15:19:18 +0900 2008 with <a href='http://eigenclass.org/hiki/rcov'>rcov 0.8.1.2</a>
557
557
  </p>
558
558
  <hr/>
559
559
  <pre><span class='marked0'>Code reported as executed by Ruby looks like this...
@@ -598,224 +598,224 @@ span.run100 {
598
598
  </tr>
599
599
  </tbody>
600
600
  </table>
601
- <pre><span class="inferred1"><a name="line1"></a> 1 # = forwardable - Support for the Delegation Pattern
602
- </span><span class="inferred0"><a name="line2"></a> 2 #
603
- </span><span class="inferred1"><a name="line3"></a> 3 # $Release Version: 1.1$
604
- </span><span class="inferred0"><a name="line4"></a> 4 # $Revision: 11708 $
605
- </span><span class="inferred1"><a name="line5"></a> 5 # $Date: 2007-02-13 08:01:19 +0900 (Tue, 13 Feb 2007) $
606
- </span><span class="inferred0"><a name="line6"></a> 6 # by Keiju ISHITSUKA(keiju@ishitsuka.com)
607
- </span><span class="inferred1"><a name="line7"></a> 7 #
608
- </span><span class="inferred0"><a name="line8"></a> 8 # Documentation by James Edward Gray II and Gavin Sinclair
609
- </span><span class="inferred1"><a name="line9"></a> 9 #
610
- </span><span class="inferred0"><a name="line10"></a> 10 # == Introduction
611
- </span><span class="inferred1"><a name="line11"></a> 11 #
612
- </span><span class="inferred0"><a name="line12"></a> 12 # This library allows you delegate method calls to an object, on a method by
613
- </span><span class="inferred1"><a name="line13"></a> 13 # method basis. You can use Forwardable to setup this delegation at the class
614
- </span><span class="inferred0"><a name="line14"></a> 14 # level, or SingleForwardable to handle it at the object level.
615
- </span><span class="inferred1"><a name="line15"></a> 15 #
616
- </span><span class="inferred0"><a name="line16"></a> 16 # == Notes
617
- </span><span class="inferred1"><a name="line17"></a> 17 #
618
- </span><span class="inferred0"><a name="line18"></a> 18 # Be advised, RDoc will not detect delegated methods.
619
- </span><span class="inferred1"><a name="line19"></a> 19 #
620
- </span><span class="inferred0"><a name="line20"></a> 20 # &lt;b&gt;forwardable.rb provides single-method delegation via the
621
- </span><span class="inferred1"><a name="line21"></a> 21 # def_delegator() and def_delegators() methods. For full-class
622
- </span><span class="inferred0"><a name="line22"></a> 22 # delegation via DelegateClass(), see delegate.rb.&lt;/b&gt;
623
- </span><span class="inferred1"><a name="line23"></a> 23 #
624
- </span><span class="inferred0"><a name="line24"></a> 24 # == Examples
625
- </span><span class="inferred1"><a name="line25"></a> 25 #
626
- </span><span class="inferred0"><a name="line26"></a> 26 # === Forwardable
627
- </span><span class="inferred1"><a name="line27"></a> 27 #
628
- </span><span class="inferred0"><a name="line28"></a> 28 # Forwardable makes building a new class based on existing work, with a proper
629
- </span><span class="inferred1"><a name="line29"></a> 29 # interface, almost trivial. We want to rely on what has come before obviously,
630
- </span><span class="inferred0"><a name="line30"></a> 30 # but with delegation we can take just the methods we need and even rename them
631
- </span><span class="inferred1"><a name="line31"></a> 31 # as appropriate. In many cases this is preferable to inheritance, which gives
632
- </span><span class="inferred0"><a name="line32"></a> 32 # us the entire old interface, even if much of it isn't needed.
633
- </span><span class="inferred1"><a name="line33"></a> 33 #
634
- </span><span class="inferred0"><a name="line34"></a> 34 # class Queue
635
- </span><span class="inferred1"><a name="line35"></a> 35 # extend Forwardable
636
- </span><span class="inferred0"><a name="line36"></a> 36 #
637
- </span><span class="inferred1"><a name="line37"></a> 37 # def initialize
638
- </span><span class="inferred0"><a name="line38"></a> 38 # @q = [ ] # prepare delegate object
639
- </span><span class="inferred1"><a name="line39"></a> 39 # end
640
- </span><span class="inferred0"><a name="line40"></a> 40 #
641
- </span><span class="inferred1"><a name="line41"></a> 41 # # setup prefered interface, enq() and deq()...
642
- </span><span class="inferred0"><a name="line42"></a> 42 # def_delegator :@q, :push, :enq
643
- </span><span class="inferred1"><a name="line43"></a> 43 # def_delegator :@q, :shift, :deq
644
- </span><span class="inferred0"><a name="line44"></a> 44 #
645
- </span><span class="inferred1"><a name="line45"></a> 45 # # support some general Array methods that fit Queues well
646
- </span><span class="inferred0"><a name="line46"></a> 46 # def_delegators :@q, :clear, :first, :push, :shift, :size
647
- </span><span class="inferred1"><a name="line47"></a> 47 # end
648
- </span><span class="inferred0"><a name="line48"></a> 48 #
649
- </span><span class="inferred1"><a name="line49"></a> 49 # q = Queue.new
650
- </span><span class="inferred0"><a name="line50"></a> 50 # q.enq 1, 2, 3, 4, 5
651
- </span><span class="inferred1"><a name="line51"></a> 51 # q.push 6
652
- </span><span class="inferred0"><a name="line52"></a> 52 #
653
- </span><span class="inferred1"><a name="line53"></a> 53 # q.shift # =&gt; 1
654
- </span><span class="inferred0"><a name="line54"></a> 54 # while q.size &gt; 0
655
- </span><span class="inferred1"><a name="line55"></a> 55 # puts q.deq
656
- </span><span class="inferred0"><a name="line56"></a> 56 # end
657
- </span><span class="inferred1"><a name="line57"></a> 57 #
658
- </span><span class="inferred0"><a name="line58"></a> 58 # q.enq &quot;Ruby&quot;, &quot;Perl&quot;, &quot;Python&quot;
659
- </span><span class="inferred1"><a name="line59"></a> 59 # puts q.first
660
- </span><span class="inferred0"><a name="line60"></a> 60 # q.clear
661
- </span><span class="inferred1"><a name="line61"></a> 61 # puts q.first
662
- </span><span class="inferred0"><a name="line62"></a> 62 #
663
- </span><span class="inferred1"><a name="line63"></a> 63 # &lt;i&gt;Prints:&lt;/i&gt;
664
- </span><span class="inferred0"><a name="line64"></a> 64 #
665
- </span><span class="inferred1"><a name="line65"></a> 65 # 2
666
- </span><span class="inferred0"><a name="line66"></a> 66 # 3
667
- </span><span class="inferred1"><a name="line67"></a> 67 # 4
668
- </span><span class="inferred0"><a name="line68"></a> 68 # 5
669
- </span><span class="inferred1"><a name="line69"></a> 69 # 6
670
- </span><span class="inferred0"><a name="line70"></a> 70 # Ruby
671
- </span><span class="inferred1"><a name="line71"></a> 71 # nil
672
- </span><span class="inferred0"><a name="line72"></a> 72 #
673
- </span><span class="inferred1"><a name="line73"></a> 73 # === SingleForwardable
674
- </span><span class="inferred0"><a name="line74"></a> 74 #
675
- </span><span class="inferred1"><a name="line75"></a> 75 # printer = String.new
676
- </span><span class="inferred0"><a name="line76"></a> 76 # printer.extend SingleForwardable # prepare object for delegation
677
- </span><span class="inferred1"><a name="line77"></a> 77 # printer.def_delegator &quot;STDOUT&quot;, &quot;puts&quot; # add delegation for STDOUT.puts()
678
- </span><span class="inferred0"><a name="line78"></a> 78 # printer.puts &quot;Howdy!&quot;
679
- </span><span class="inferred1"><a name="line79"></a> 79 #
680
- </span><span class="inferred0"><a name="line80"></a> 80 # &lt;i&gt;Prints:&lt;/i&gt;
681
- </span><span class="inferred1"><a name="line81"></a> 81 #
682
- </span><span class="inferred0"><a name="line82"></a> 82 # Howdy!
683
- </span><span class="inferred1"><a name="line83"></a> 83
684
- </span><span class="inferred0"><a name="line84"></a> 84 #
685
- </span><span class="inferred1"><a name="line85"></a> 85 # The Forwardable module provides delegation of specified
686
- </span><span class="inferred0"><a name="line86"></a> 86 # methods to a designated object, using the methods #def_delegator
687
- </span><span class="inferred1"><a name="line87"></a> 87 # and #def_delegators.
688
- </span><span class="inferred0"><a name="line88"></a> 88 #
689
- </span><span class="inferred1"><a name="line89"></a> 89 # For example, say you have a class RecordCollection which
690
- </span><span class="inferred0"><a name="line90"></a> 90 # contains an array &lt;tt&gt;@records&lt;/tt&gt;. You could provide the lookup method
691
- </span><span class="inferred1"><a name="line91"></a> 91 # #record_number(), which simply calls #[] on the &lt;tt&gt;@records&lt;/tt&gt;
692
- </span><span class="inferred0"><a name="line92"></a> 92 # array, like this:
693
- </span><span class="inferred1"><a name="line93"></a> 93 #
694
- </span><span class="inferred0"><a name="line94"></a> 94 # class RecordCollection
695
- </span><span class="inferred1"><a name="line95"></a> 95 # extend Forwardable
696
- </span><span class="inferred0"><a name="line96"></a> 96 # def_delegator :@records, :[], :record_number
697
- </span><span class="inferred1"><a name="line97"></a> 97 # end
698
- </span><span class="inferred0"><a name="line98"></a> 98 #
699
- </span><span class="inferred1"><a name="line99"></a> 99 # Further, if you wish to provide the methods #size, #&lt;&lt;, and #map,
700
- </span><span class="inferred0"><a name="line100"></a>100 # all of which delegate to @records, this is how you can do it:
701
- </span><span class="inferred1"><a name="line101"></a>101 #
702
- </span><span class="inferred0"><a name="line102"></a>102 # class RecordCollection
703
- </span><span class="inferred1"><a name="line103"></a>103 # # extend Forwardable, but we did that above
704
- </span><span class="inferred0"><a name="line104"></a>104 # def_delegators :@records, :size, :&lt;&lt;, :map
705
- </span><span class="inferred1"><a name="line105"></a>105 # end
706
- </span><span class="inferred0"><a name="line106"></a>106 #
707
- </span><span class="inferred1"><a name="line107"></a>107 # Also see the example at forwardable.rb.
708
- </span><span class="inferred0"><a name="line108"></a>108 #
709
- </span><span class="marked1"><a name="line109"></a>109 module Forwardable
710
- </span><span class="inferred0"><a name="line110"></a>110
711
- </span><span class="marked1"><a name="line111"></a>111 @debug = nil
712
- </span><span class="marked0"><a name="line112"></a>112 class&lt;&lt;self
713
- </span><span class="inferred1"><a name="line113"></a>113 # force Forwardable to show up in stack backtraces of delegated methods
714
- </span><span class="marked0"><a name="line114"></a>114 attr_accessor :debug
715
- </span><span class="inferred1"><a name="line115"></a>115 end
716
- </span><span class="inferred0"><a name="line116"></a>116
717
- </span><span class="inferred1"><a name="line117"></a>117 #
718
- </span><span class="inferred0"><a name="line118"></a>118 # Shortcut for defining multiple delegator methods, but with no
719
- </span><span class="inferred1"><a name="line119"></a>119 # provision for using a different name. The following two code
720
- </span><span class="inferred0"><a name="line120"></a>120 # samples have the same effect:
721
- </span><span class="inferred1"><a name="line121"></a>121 #
722
- </span><span class="inferred0"><a name="line122"></a>122 # def_delegators :@records, :size, :&lt;&lt;, :map
723
- </span><span class="inferred1"><a name="line123"></a>123 #
724
- </span><span class="inferred0"><a name="line124"></a>124 # def_delegator :@records, :size
725
- </span><span class="inferred1"><a name="line125"></a>125 # def_delegator :@records, :&lt;&lt;
726
- </span><span class="inferred0"><a name="line126"></a>126 # def_delegator :@records, :map
727
- </span><span class="inferred1"><a name="line127"></a>127 #
728
- </span><span class="inferred0"><a name="line128"></a>128 # See the examples at Forwardable and forwardable.rb.
729
- </span><span class="inferred1"><a name="line129"></a>129 #
730
- </span><span class="marked0"><a name="line130"></a>130 def def_instance_delegators(accessor, *methods)
731
- </span><span class="uncovered1"><a name="line131"></a>131 for method in methods
732
- </span><span class="uncovered0"><a name="line132"></a>132 def_instance_delegator(accessor, method)
733
- </span><span class="uncovered1"><a name="line133"></a>133 end
734
- </span><span class="uncovered0"><a name="line134"></a>134 end
735
- </span><span class="inferred1"><a name="line135"></a>135
736
- </span><span class="inferred0"><a name="line136"></a>136 #
737
- </span><span class="inferred1"><a name="line137"></a>137 # Defines a method _method_ which delegates to _obj_ (i.e. it calls
738
- </span><span class="inferred0"><a name="line138"></a>138 # the method of the same name in _obj_). If _new_name_ is
739
- </span><span class="inferred1"><a name="line139"></a>139 # provided, it is used as the name for the delegate method.
740
- </span><span class="inferred0"><a name="line140"></a>140 #
741
- </span><span class="inferred1"><a name="line141"></a>141 # See the examples at Forwardable and forwardable.rb.
742
- </span><span class="inferred0"><a name="line142"></a>142 #
743
- </span><span class="marked1"><a name="line143"></a>143 def def_instance_delegator(accessor, method, ali = method)
744
- </span><span class="uncovered0"><a name="line144"></a>144 accessor = accessor.id2name if accessor.kind_of?(Integer)
745
- </span><span class="uncovered1"><a name="line145"></a>145 method = method.id2name if method.kind_of?(Integer)
746
- </span><span class="uncovered0"><a name="line146"></a>146 ali = ali.id2name if ali.kind_of?(Integer)
747
- </span><span class="uncovered1"><a name="line147"></a>147
748
- </span><span class="uncovered0"><a name="line148"></a>148 module_eval(&lt;&lt;-EOS, &quot;(__FORWARDABLE__)&quot;, 1)
749
- </span><span class="uncovered1"><a name="line149"></a>149 def #{ali}(*args, &amp;block)
750
- </span><span class="uncovered0"><a name="line150"></a>150 begin
751
- </span><span class="uncovered1"><a name="line151"></a>151 #{accessor}.__send__(:#{method}, *args, &amp;block)
752
- </span><span class="uncovered0"><a name="line152"></a>152 rescue Exception
753
- </span><span class="uncovered1"><a name="line153"></a>153 $@.delete_if{|s| /^\\(__FORWARDABLE__\\):/ =~ s} unless Forwardable::debug
754
- </span><span class="uncovered0"><a name="line154"></a>154 Kernel::raise
755
- </span><span class="uncovered1"><a name="line155"></a>155 end
756
- </span><span class="uncovered0"><a name="line156"></a>156 end
757
- </span><span class="uncovered1"><a name="line157"></a>157 EOS
758
- </span><span class="uncovered0"><a name="line158"></a>158 end
759
- </span><span class="inferred1"><a name="line159"></a>159
760
- </span><span class="marked0"><a name="line160"></a>160 alias def_delegators def_instance_delegators
761
- </span><span class="marked1"><a name="line161"></a>161 alias def_delegator def_instance_delegator
762
- </span><span class="inferred0"><a name="line162"></a>162 end
763
- </span><span class="inferred1"><a name="line163"></a>163
764
- </span><span class="inferred0"><a name="line164"></a>164 #
765
- </span><span class="inferred1"><a name="line165"></a>165 # The SingleForwardable module provides delegation of specified
766
- </span><span class="inferred0"><a name="line166"></a>166 # methods to a designated object, using the methods #def_delegator
767
- </span><span class="inferred1"><a name="line167"></a>167 # and #def_delegators. This module is similar to Forwardable, but it works on
768
- </span><span class="inferred0"><a name="line168"></a>168 # objects themselves, instead of their defining classes.
769
- </span><span class="inferred1"><a name="line169"></a>169 #
770
- </span><span class="inferred0"><a name="line170"></a>170 # Also see the example at forwardable.rb.
771
- </span><span class="inferred1"><a name="line171"></a>171 #
772
- </span><span class="marked0"><a name="line172"></a>172 module SingleForwardable
773
- </span><span class="inferred1"><a name="line173"></a>173 #
774
- </span><span class="inferred0"><a name="line174"></a>174 # Shortcut for defining multiple delegator methods, but with no
775
- </span><span class="inferred1"><a name="line175"></a>175 # provision for using a different name. The following two code
776
- </span><span class="inferred0"><a name="line176"></a>176 # samples have the same effect:
777
- </span><span class="inferred1"><a name="line177"></a>177 #
778
- </span><span class="inferred0"><a name="line178"></a>178 # single_forwardable.def_delegators :@records, :size, :&lt;&lt;, :map
779
- </span><span class="inferred1"><a name="line179"></a>179 #
780
- </span><span class="inferred0"><a name="line180"></a>180 # single_forwardable.def_delegator :@records, :size
781
- </span><span class="inferred1"><a name="line181"></a>181 # single_forwardable.def_delegator :@records, :&lt;&lt;
782
- </span><span class="inferred0"><a name="line182"></a>182 # single_forwardable.def_delegator :@records, :map
783
- </span><span class="inferred1"><a name="line183"></a>183 #
784
- </span><span class="inferred0"><a name="line184"></a>184 # See the example at forwardable.rb.
785
- </span><span class="inferred1"><a name="line185"></a>185 #
786
- </span><span class="marked0"><a name="line186"></a>186 def def_singleton_delegators(accessor, *methods)
787
- </span><span class="uncovered1"><a name="line187"></a>187 for method in methods
788
- </span><span class="uncovered0"><a name="line188"></a>188 def_singleton_delegator(accessor, method)
789
- </span><span class="uncovered1"><a name="line189"></a>189 end
790
- </span><span class="uncovered0"><a name="line190"></a>190 end
791
- </span><span class="inferred1"><a name="line191"></a>191
792
- </span><span class="inferred0"><a name="line192"></a>192 #
793
- </span><span class="inferred1"><a name="line193"></a>193 # Defines a method _method_ which delegates to _obj_ (i.e. it calls
794
- </span><span class="inferred0"><a name="line194"></a>194 # the method of the same name in _obj_). If _new_name_ is
795
- </span><span class="inferred1"><a name="line195"></a>195 # provided, it is used as the name for the delegate method.
796
- </span><span class="inferred0"><a name="line196"></a>196 #
797
- </span><span class="inferred1"><a name="line197"></a>197 # See the example at forwardable.rb.
798
- </span><span class="inferred0"><a name="line198"></a>198 #
799
- </span><span class="marked1"><a name="line199"></a>199 def def_singleton_delegator(accessor, method, ali = method)
800
- </span><span class="uncovered0"><a name="line200"></a>200 accessor = accessor.id2name if accessor.kind_of?(Integer)
801
- </span><span class="uncovered1"><a name="line201"></a>201 method = method.id2name if method.kind_of?(Integer)
802
- </span><span class="uncovered0"><a name="line202"></a>202 ali = ali.id2name if ali.kind_of?(Integer)
803
- </span><span class="uncovered1"><a name="line203"></a>203
804
- </span><span class="uncovered0"><a name="line204"></a>204 instance_eval(&lt;&lt;-EOS, &quot;(__FORWARDABLE__)&quot;, 1)
805
- </span><span class="uncovered1"><a name="line205"></a>205 def #{ali}(*args, &amp;block)
806
- </span><span class="uncovered0"><a name="line206"></a>206 begin
807
- </span><span class="uncovered1"><a name="line207"></a>207 #{accessor}.__send__(:#{method}, *args,&amp;block)
808
- </span><span class="uncovered0"><a name="line208"></a>208 rescue Exception
809
- </span><span class="uncovered1"><a name="line209"></a>209 $@.delete_if{|s| /^\\(__FORWARDABLE__\\):/ =~ s} unless Forwardable::debug
810
- </span><span class="uncovered0"><a name="line210"></a>210 Kernel::raise
811
- </span><span class="uncovered1"><a name="line211"></a>211 end
812
- </span><span class="uncovered0"><a name="line212"></a>212 end
813
- </span><span class="uncovered1"><a name="line213"></a>213 EOS
814
- </span><span class="uncovered0"><a name="line214"></a>214 end
815
- </span><span class="inferred1"><a name="line215"></a>215
816
- </span><span class="marked0"><a name="line216"></a>216 alias def_delegators def_singleton_delegators
817
- </span><span class="marked1"><a name="line217"></a>217 alias def_delegator def_singleton_delegator
818
- </span><span class="inferred0"><a name="line218"></a>218 end
601
+ <pre><span class="inferred0"><a name="line1"></a> 1 # = forwardable - Support for the Delegation Pattern
602
+ </span><span class="inferred1"><a name="line2"></a> 2 #
603
+ </span><span class="inferred0"><a name="line3"></a> 3 # $Release Version: 1.1$
604
+ </span><span class="inferred1"><a name="line4"></a> 4 # $Revision: 11708 $
605
+ </span><span class="inferred0"><a name="line5"></a> 5 # $Date: 2007-02-13 08:01:19 +0900 (Tue, 13 Feb 2007) $
606
+ </span><span class="inferred1"><a name="line6"></a> 6 # by Keiju ISHITSUKA(keiju@ishitsuka.com)
607
+ </span><span class="inferred0"><a name="line7"></a> 7 #
608
+ </span><span class="inferred1"><a name="line8"></a> 8 # Documentation by James Edward Gray II and Gavin Sinclair
609
+ </span><span class="inferred0"><a name="line9"></a> 9 #
610
+ </span><span class="inferred1"><a name="line10"></a> 10 # == Introduction
611
+ </span><span class="inferred0"><a name="line11"></a> 11 #
612
+ </span><span class="inferred1"><a name="line12"></a> 12 # This library allows you delegate method calls to an object, on a method by
613
+ </span><span class="inferred0"><a name="line13"></a> 13 # method basis. You can use Forwardable to setup this delegation at the class
614
+ </span><span class="inferred1"><a name="line14"></a> 14 # level, or SingleForwardable to handle it at the object level.
615
+ </span><span class="inferred0"><a name="line15"></a> 15 #
616
+ </span><span class="inferred1"><a name="line16"></a> 16 # == Notes
617
+ </span><span class="inferred0"><a name="line17"></a> 17 #
618
+ </span><span class="inferred1"><a name="line18"></a> 18 # Be advised, RDoc will not detect delegated methods.
619
+ </span><span class="inferred0"><a name="line19"></a> 19 #
620
+ </span><span class="inferred1"><a name="line20"></a> 20 # &lt;b&gt;forwardable.rb provides single-method delegation via the
621
+ </span><span class="inferred0"><a name="line21"></a> 21 # def_delegator() and def_delegators() methods. For full-class
622
+ </span><span class="inferred1"><a name="line22"></a> 22 # delegation via DelegateClass(), see delegate.rb.&lt;/b&gt;
623
+ </span><span class="inferred0"><a name="line23"></a> 23 #
624
+ </span><span class="inferred1"><a name="line24"></a> 24 # == Examples
625
+ </span><span class="inferred0"><a name="line25"></a> 25 #
626
+ </span><span class="inferred1"><a name="line26"></a> 26 # === Forwardable
627
+ </span><span class="inferred0"><a name="line27"></a> 27 #
628
+ </span><span class="inferred1"><a name="line28"></a> 28 # Forwardable makes building a new class based on existing work, with a proper
629
+ </span><span class="inferred0"><a name="line29"></a> 29 # interface, almost trivial. We want to rely on what has come before obviously,
630
+ </span><span class="inferred1"><a name="line30"></a> 30 # but with delegation we can take just the methods we need and even rename them
631
+ </span><span class="inferred0"><a name="line31"></a> 31 # as appropriate. In many cases this is preferable to inheritance, which gives
632
+ </span><span class="inferred1"><a name="line32"></a> 32 # us the entire old interface, even if much of it isn't needed.
633
+ </span><span class="inferred0"><a name="line33"></a> 33 #
634
+ </span><span class="inferred1"><a name="line34"></a> 34 # class Queue
635
+ </span><span class="inferred0"><a name="line35"></a> 35 # extend Forwardable
636
+ </span><span class="inferred1"><a name="line36"></a> 36 #
637
+ </span><span class="inferred0"><a name="line37"></a> 37 # def initialize
638
+ </span><span class="inferred1"><a name="line38"></a> 38 # @q = [ ] # prepare delegate object
639
+ </span><span class="inferred0"><a name="line39"></a> 39 # end
640
+ </span><span class="inferred1"><a name="line40"></a> 40 #
641
+ </span><span class="inferred0"><a name="line41"></a> 41 # # setup prefered interface, enq() and deq()...
642
+ </span><span class="inferred1"><a name="line42"></a> 42 # def_delegator :@q, :push, :enq
643
+ </span><span class="inferred0"><a name="line43"></a> 43 # def_delegator :@q, :shift, :deq
644
+ </span><span class="inferred1"><a name="line44"></a> 44 #
645
+ </span><span class="inferred0"><a name="line45"></a> 45 # # support some general Array methods that fit Queues well
646
+ </span><span class="inferred1"><a name="line46"></a> 46 # def_delegators :@q, :clear, :first, :push, :shift, :size
647
+ </span><span class="inferred0"><a name="line47"></a> 47 # end
648
+ </span><span class="inferred1"><a name="line48"></a> 48 #
649
+ </span><span class="inferred0"><a name="line49"></a> 49 # q = Queue.new
650
+ </span><span class="inferred1"><a name="line50"></a> 50 # q.enq 1, 2, 3, 4, 5
651
+ </span><span class="inferred0"><a name="line51"></a> 51 # q.push 6
652
+ </span><span class="inferred1"><a name="line52"></a> 52 #
653
+ </span><span class="inferred0"><a name="line53"></a> 53 # q.shift # =&gt; 1
654
+ </span><span class="inferred1"><a name="line54"></a> 54 # while q.size &gt; 0
655
+ </span><span class="inferred0"><a name="line55"></a> 55 # puts q.deq
656
+ </span><span class="inferred1"><a name="line56"></a> 56 # end
657
+ </span><span class="inferred0"><a name="line57"></a> 57 #
658
+ </span><span class="inferred1"><a name="line58"></a> 58 # q.enq &quot;Ruby&quot;, &quot;Perl&quot;, &quot;Python&quot;
659
+ </span><span class="inferred0"><a name="line59"></a> 59 # puts q.first
660
+ </span><span class="inferred1"><a name="line60"></a> 60 # q.clear
661
+ </span><span class="inferred0"><a name="line61"></a> 61 # puts q.first
662
+ </span><span class="inferred1"><a name="line62"></a> 62 #
663
+ </span><span class="inferred0"><a name="line63"></a> 63 # &lt;i&gt;Prints:&lt;/i&gt;
664
+ </span><span class="inferred1"><a name="line64"></a> 64 #
665
+ </span><span class="inferred0"><a name="line65"></a> 65 # 2
666
+ </span><span class="inferred1"><a name="line66"></a> 66 # 3
667
+ </span><span class="inferred0"><a name="line67"></a> 67 # 4
668
+ </span><span class="inferred1"><a name="line68"></a> 68 # 5
669
+ </span><span class="inferred0"><a name="line69"></a> 69 # 6
670
+ </span><span class="inferred1"><a name="line70"></a> 70 # Ruby
671
+ </span><span class="inferred0"><a name="line71"></a> 71 # nil
672
+ </span><span class="inferred1"><a name="line72"></a> 72 #
673
+ </span><span class="inferred0"><a name="line73"></a> 73 # === SingleForwardable
674
+ </span><span class="inferred1"><a name="line74"></a> 74 #
675
+ </span><span class="inferred0"><a name="line75"></a> 75 # printer = String.new
676
+ </span><span class="inferred1"><a name="line76"></a> 76 # printer.extend SingleForwardable # prepare object for delegation
677
+ </span><span class="inferred0"><a name="line77"></a> 77 # printer.def_delegator &quot;STDOUT&quot;, &quot;puts&quot; # add delegation for STDOUT.puts()
678
+ </span><span class="inferred1"><a name="line78"></a> 78 # printer.puts &quot;Howdy!&quot;
679
+ </span><span class="inferred0"><a name="line79"></a> 79 #
680
+ </span><span class="inferred1"><a name="line80"></a> 80 # &lt;i&gt;Prints:&lt;/i&gt;
681
+ </span><span class="inferred0"><a name="line81"></a> 81 #
682
+ </span><span class="inferred1"><a name="line82"></a> 82 # Howdy!
683
+ </span><span class="inferred0"><a name="line83"></a> 83
684
+ </span><span class="inferred1"><a name="line84"></a> 84 #
685
+ </span><span class="inferred0"><a name="line85"></a> 85 # The Forwardable module provides delegation of specified
686
+ </span><span class="inferred1"><a name="line86"></a> 86 # methods to a designated object, using the methods #def_delegator
687
+ </span><span class="inferred0"><a name="line87"></a> 87 # and #def_delegators.
688
+ </span><span class="inferred1"><a name="line88"></a> 88 #
689
+ </span><span class="inferred0"><a name="line89"></a> 89 # For example, say you have a class RecordCollection which
690
+ </span><span class="inferred1"><a name="line90"></a> 90 # contains an array &lt;tt&gt;@records&lt;/tt&gt;. You could provide the lookup method
691
+ </span><span class="inferred0"><a name="line91"></a> 91 # #record_number(), which simply calls #[] on the &lt;tt&gt;@records&lt;/tt&gt;
692
+ </span><span class="inferred1"><a name="line92"></a> 92 # array, like this:
693
+ </span><span class="inferred0"><a name="line93"></a> 93 #
694
+ </span><span class="inferred1"><a name="line94"></a> 94 # class RecordCollection
695
+ </span><span class="inferred0"><a name="line95"></a> 95 # extend Forwardable
696
+ </span><span class="inferred1"><a name="line96"></a> 96 # def_delegator :@records, :[], :record_number
697
+ </span><span class="inferred0"><a name="line97"></a> 97 # end
698
+ </span><span class="inferred1"><a name="line98"></a> 98 #
699
+ </span><span class="inferred0"><a name="line99"></a> 99 # Further, if you wish to provide the methods #size, #&lt;&lt;, and #map,
700
+ </span><span class="inferred1"><a name="line100"></a>100 # all of which delegate to @records, this is how you can do it:
701
+ </span><span class="inferred0"><a name="line101"></a>101 #
702
+ </span><span class="inferred1"><a name="line102"></a>102 # class RecordCollection
703
+ </span><span class="inferred0"><a name="line103"></a>103 # # extend Forwardable, but we did that above
704
+ </span><span class="inferred1"><a name="line104"></a>104 # def_delegators :@records, :size, :&lt;&lt;, :map
705
+ </span><span class="inferred0"><a name="line105"></a>105 # end
706
+ </span><span class="inferred1"><a name="line106"></a>106 #
707
+ </span><span class="inferred0"><a name="line107"></a>107 # Also see the example at forwardable.rb.
708
+ </span><span class="inferred1"><a name="line108"></a>108 #
709
+ </span><span class="marked0"><a name="line109"></a>109 module Forwardable
710
+ </span><span class="inferred1"><a name="line110"></a>110
711
+ </span><span class="marked0"><a name="line111"></a>111 @debug = nil
712
+ </span><span class="marked1"><a name="line112"></a>112 class&lt;&lt;self
713
+ </span><span class="inferred0"><a name="line113"></a>113 # force Forwardable to show up in stack backtraces of delegated methods
714
+ </span><span class="marked1"><a name="line114"></a>114 attr_accessor :debug
715
+ </span><span class="inferred0"><a name="line115"></a>115 end
716
+ </span><span class="inferred1"><a name="line116"></a>116
717
+ </span><span class="inferred0"><a name="line117"></a>117 #
718
+ </span><span class="inferred1"><a name="line118"></a>118 # Shortcut for defining multiple delegator methods, but with no
719
+ </span><span class="inferred0"><a name="line119"></a>119 # provision for using a different name. The following two code
720
+ </span><span class="inferred1"><a name="line120"></a>120 # samples have the same effect:
721
+ </span><span class="inferred0"><a name="line121"></a>121 #
722
+ </span><span class="inferred1"><a name="line122"></a>122 # def_delegators :@records, :size, :&lt;&lt;, :map
723
+ </span><span class="inferred0"><a name="line123"></a>123 #
724
+ </span><span class="inferred1"><a name="line124"></a>124 # def_delegator :@records, :size
725
+ </span><span class="inferred0"><a name="line125"></a>125 # def_delegator :@records, :&lt;&lt;
726
+ </span><span class="inferred1"><a name="line126"></a>126 # def_delegator :@records, :map
727
+ </span><span class="inferred0"><a name="line127"></a>127 #
728
+ </span><span class="inferred1"><a name="line128"></a>128 # See the examples at Forwardable and forwardable.rb.
729
+ </span><span class="inferred0"><a name="line129"></a>129 #
730
+ </span><span class="marked1"><a name="line130"></a>130 def def_instance_delegators(accessor, *methods)
731
+ </span><span class="uncovered0"><a name="line131"></a>131 for method in methods
732
+ </span><span class="uncovered1"><a name="line132"></a>132 def_instance_delegator(accessor, method)
733
+ </span><span class="uncovered0"><a name="line133"></a>133 end
734
+ </span><span class="uncovered1"><a name="line134"></a>134 end
735
+ </span><span class="inferred0"><a name="line135"></a>135
736
+ </span><span class="inferred1"><a name="line136"></a>136 #
737
+ </span><span class="inferred0"><a name="line137"></a>137 # Defines a method _method_ which delegates to _obj_ (i.e. it calls
738
+ </span><span class="inferred1"><a name="line138"></a>138 # the method of the same name in _obj_). If _new_name_ is
739
+ </span><span class="inferred0"><a name="line139"></a>139 # provided, it is used as the name for the delegate method.
740
+ </span><span class="inferred1"><a name="line140"></a>140 #
741
+ </span><span class="inferred0"><a name="line141"></a>141 # See the examples at Forwardable and forwardable.rb.
742
+ </span><span class="inferred1"><a name="line142"></a>142 #
743
+ </span><span class="marked0"><a name="line143"></a>143 def def_instance_delegator(accessor, method, ali = method)
744
+ </span><span class="uncovered1"><a name="line144"></a>144 accessor = accessor.id2name if accessor.kind_of?(Integer)
745
+ </span><span class="uncovered0"><a name="line145"></a>145 method = method.id2name if method.kind_of?(Integer)
746
+ </span><span class="uncovered1"><a name="line146"></a>146 ali = ali.id2name if ali.kind_of?(Integer)
747
+ </span><span class="uncovered0"><a name="line147"></a>147
748
+ </span><span class="uncovered1"><a name="line148"></a>148 module_eval(&lt;&lt;-EOS, &quot;(__FORWARDABLE__)&quot;, 1)
749
+ </span><span class="uncovered0"><a name="line149"></a>149 def #{ali}(*args, &amp;block)
750
+ </span><span class="uncovered1"><a name="line150"></a>150 begin
751
+ </span><span class="uncovered0"><a name="line151"></a>151 #{accessor}.__send__(:#{method}, *args, &amp;block)
752
+ </span><span class="uncovered1"><a name="line152"></a>152 rescue Exception
753
+ </span><span class="uncovered0"><a name="line153"></a>153 $@.delete_if{|s| /^\\(__FORWARDABLE__\\):/ =~ s} unless Forwardable::debug
754
+ </span><span class="uncovered1"><a name="line154"></a>154 Kernel::raise
755
+ </span><span class="uncovered0"><a name="line155"></a>155 end
756
+ </span><span class="uncovered1"><a name="line156"></a>156 end
757
+ </span><span class="uncovered0"><a name="line157"></a>157 EOS
758
+ </span><span class="uncovered1"><a name="line158"></a>158 end
759
+ </span><span class="inferred0"><a name="line159"></a>159
760
+ </span><span class="marked1"><a name="line160"></a>160 alias def_delegators def_instance_delegators
761
+ </span><span class="marked0"><a name="line161"></a>161 alias def_delegator def_instance_delegator
762
+ </span><span class="inferred1"><a name="line162"></a>162 end
763
+ </span><span class="inferred0"><a name="line163"></a>163
764
+ </span><span class="inferred1"><a name="line164"></a>164 #
765
+ </span><span class="inferred0"><a name="line165"></a>165 # The SingleForwardable module provides delegation of specified
766
+ </span><span class="inferred1"><a name="line166"></a>166 # methods to a designated object, using the methods #def_delegator
767
+ </span><span class="inferred0"><a name="line167"></a>167 # and #def_delegators. This module is similar to Forwardable, but it works on
768
+ </span><span class="inferred1"><a name="line168"></a>168 # objects themselves, instead of their defining classes.
769
+ </span><span class="inferred0"><a name="line169"></a>169 #
770
+ </span><span class="inferred1"><a name="line170"></a>170 # Also see the example at forwardable.rb.
771
+ </span><span class="inferred0"><a name="line171"></a>171 #
772
+ </span><span class="marked1"><a name="line172"></a>172 module SingleForwardable
773
+ </span><span class="inferred0"><a name="line173"></a>173 #
774
+ </span><span class="inferred1"><a name="line174"></a>174 # Shortcut for defining multiple delegator methods, but with no
775
+ </span><span class="inferred0"><a name="line175"></a>175 # provision for using a different name. The following two code
776
+ </span><span class="inferred1"><a name="line176"></a>176 # samples have the same effect:
777
+ </span><span class="inferred0"><a name="line177"></a>177 #
778
+ </span><span class="inferred1"><a name="line178"></a>178 # single_forwardable.def_delegators :@records, :size, :&lt;&lt;, :map
779
+ </span><span class="inferred0"><a name="line179"></a>179 #
780
+ </span><span class="inferred1"><a name="line180"></a>180 # single_forwardable.def_delegator :@records, :size
781
+ </span><span class="inferred0"><a name="line181"></a>181 # single_forwardable.def_delegator :@records, :&lt;&lt;
782
+ </span><span class="inferred1"><a name="line182"></a>182 # single_forwardable.def_delegator :@records, :map
783
+ </span><span class="inferred0"><a name="line183"></a>183 #
784
+ </span><span class="inferred1"><a name="line184"></a>184 # See the example at forwardable.rb.
785
+ </span><span class="inferred0"><a name="line185"></a>185 #
786
+ </span><span class="marked1"><a name="line186"></a>186 def def_singleton_delegators(accessor, *methods)
787
+ </span><span class="uncovered0"><a name="line187"></a>187 for method in methods
788
+ </span><span class="uncovered1"><a name="line188"></a>188 def_singleton_delegator(accessor, method)
789
+ </span><span class="uncovered0"><a name="line189"></a>189 end
790
+ </span><span class="uncovered1"><a name="line190"></a>190 end
791
+ </span><span class="inferred0"><a name="line191"></a>191
792
+ </span><span class="inferred1"><a name="line192"></a>192 #
793
+ </span><span class="inferred0"><a name="line193"></a>193 # Defines a method _method_ which delegates to _obj_ (i.e. it calls
794
+ </span><span class="inferred1"><a name="line194"></a>194 # the method of the same name in _obj_). If _new_name_ is
795
+ </span><span class="inferred0"><a name="line195"></a>195 # provided, it is used as the name for the delegate method.
796
+ </span><span class="inferred1"><a name="line196"></a>196 #
797
+ </span><span class="inferred0"><a name="line197"></a>197 # See the example at forwardable.rb.
798
+ </span><span class="inferred1"><a name="line198"></a>198 #
799
+ </span><span class="marked0"><a name="line199"></a>199 def def_singleton_delegator(accessor, method, ali = method)
800
+ </span><span class="uncovered1"><a name="line200"></a>200 accessor = accessor.id2name if accessor.kind_of?(Integer)
801
+ </span><span class="uncovered0"><a name="line201"></a>201 method = method.id2name if method.kind_of?(Integer)
802
+ </span><span class="uncovered1"><a name="line202"></a>202 ali = ali.id2name if ali.kind_of?(Integer)
803
+ </span><span class="uncovered0"><a name="line203"></a>203
804
+ </span><span class="uncovered1"><a name="line204"></a>204 instance_eval(&lt;&lt;-EOS, &quot;(__FORWARDABLE__)&quot;, 1)
805
+ </span><span class="uncovered0"><a name="line205"></a>205 def #{ali}(*args, &amp;block)
806
+ </span><span class="uncovered1"><a name="line206"></a>206 begin
807
+ </span><span class="uncovered0"><a name="line207"></a>207 #{accessor}.__send__(:#{method}, *args,&amp;block)
808
+ </span><span class="uncovered1"><a name="line208"></a>208 rescue Exception
809
+ </span><span class="uncovered0"><a name="line209"></a>209 $@.delete_if{|s| /^\\(__FORWARDABLE__\\):/ =~ s} unless Forwardable::debug
810
+ </span><span class="uncovered1"><a name="line210"></a>210 Kernel::raise
811
+ </span><span class="uncovered0"><a name="line211"></a>211 end
812
+ </span><span class="uncovered1"><a name="line212"></a>212 end
813
+ </span><span class="uncovered0"><a name="line213"></a>213 EOS
814
+ </span><span class="uncovered1"><a name="line214"></a>214 end
815
+ </span><span class="inferred0"><a name="line215"></a>215
816
+ </span><span class="marked1"><a name="line216"></a>216 alias def_delegators def_singleton_delegators
817
+ </span><span class="marked0"><a name="line217"></a>217 alias def_delegator def_singleton_delegator
818
+ </span><span class="inferred1"><a name="line218"></a>218 end
819
819
  </span></pre><hr/>
820
820
  <p>Generated using the <a href='http://eigenclass.org/hiki.rb?rcov'>rcov code coverage analysis tool for Ruby</a>
821
821
  version 0.8.1.2.</p>