memoizable_method_missing 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
data/CHANGELOG ADDED
@@ -0,0 +1 @@
1
+ v0.0.1. First release.
data/LICENSE ADDED
@@ -0,0 +1,481 @@
1
+ GNU LIBRARY GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1991 Free Software Foundation, Inc.
5
+ 675 Mass Ave, Cambridge, MA 02139, USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ [This is the first released version of the library GPL. It is
10
+ numbered 2 because it goes with version 2 of the ordinary GPL.]
11
+
12
+ Preamble
13
+
14
+ The licenses for most software are designed to take away your
15
+ freedom to share and change it. By contrast, the GNU General Public
16
+ Licenses are intended to guarantee your freedom to share and change
17
+ free software--to make sure the software is free for all its users.
18
+
19
+ This license, the Library General Public License, applies to some
20
+ specially designated Free Software Foundation software, and to any
21
+ other libraries whose authors decide to use it. You can use it for
22
+ your libraries, too.
23
+
24
+ When we speak of free software, we are referring to freedom, not
25
+ price. Our General Public Licenses are designed to make sure that you
26
+ have the freedom to distribute copies of free software (and charge for
27
+ this service if you wish), that you receive source code or can get it
28
+ if you want it, that you can change the software or use pieces of it
29
+ in new free programs; and that you know you can do these things.
30
+
31
+ To protect your rights, we need to make restrictions that forbid
32
+ anyone to deny you these rights or to ask you to surrender the rights.
33
+ These restrictions translate to certain responsibilities for you if
34
+ you distribute copies of the library, or if you modify it.
35
+
36
+ For example, if you distribute copies of the library, whether gratis
37
+ or for a fee, you must give the recipients all the rights that we gave
38
+ you. You must make sure that they, too, receive or can get the source
39
+ code. If you link a program with the library, you must provide
40
+ complete object files to the recipients so that they can relink them
41
+ with the library, after making changes to the library and recompiling
42
+ it. And you must show them these terms so they know their rights.
43
+
44
+ Our method of protecting your rights has two steps: (1) copyright
45
+ the library, and (2) offer you this license which gives you legal
46
+ permission to copy, distribute and/or modify the library.
47
+
48
+ Also, for each distributor's protection, we want to make certain
49
+ that everyone understands that there is no warranty for this free
50
+ library. If the library is modified by someone else and passed on, we
51
+ want its recipients to know that what they have is not the original
52
+ version, so that any problems introduced by others will not reflect on
53
+ the original authors' reputations.
54
+
55
+ Finally, any free program is threatened constantly by software
56
+ patents. We wish to avoid the danger that companies distributing free
57
+ software will individually obtain patent licenses, thus in effect
58
+ transforming the program into proprietary software. To prevent this,
59
+ we have made it clear that any patent must be licensed for everyone's
60
+ free use or not licensed at all.
61
+
62
+ Most GNU software, including some libraries, is covered by the ordinary
63
+ GNU General Public License, which was designed for utility programs. This
64
+ license, the GNU Library General Public License, applies to certain
65
+ designated libraries. This license is quite different from the ordinary
66
+ one; be sure to read it in full, and don't assume that anything in it is
67
+ the same as in the ordinary license.
68
+
69
+ The reason we have a separate public license for some libraries is that
70
+ they blur the distinction we usually make between modifying or adding to a
71
+ program and simply using it. Linking a program with a library, without
72
+ changing the library, is in some sense simply using the library, and is
73
+ analogous to running a utility program or application program. However, in
74
+ a textual and legal sense, the linked executable is a combined work, a
75
+ derivative of the original library, and the ordinary General Public License
76
+ treats it as such.
77
+
78
+ Because of this blurred distinction, using the ordinary General
79
+ Public License for libraries did not effectively promote software
80
+ sharing, because most developers did not use the libraries. We
81
+ concluded that weaker conditions might promote sharing better.
82
+
83
+ However, unrestricted linking of non-free programs would deprive the
84
+ users of those programs of all benefit from the free status of the
85
+ libraries themselves. This Library General Public License is intended to
86
+ permit developers of non-free programs to use free libraries, while
87
+ preserving your freedom as a user of such programs to change the free
88
+ libraries that are incorporated in them. (We have not seen how to achieve
89
+ this as regards changes in header files, but we have achieved it as regards
90
+ changes in the actual functions of the Library.) The hope is that this
91
+ will lead to faster development of free libraries.
92
+
93
+ The precise terms and conditions for copying, distribution and
94
+ modification follow. Pay close attention to the difference between a
95
+ "work based on the library" and a "work that uses the library". The
96
+ former contains code derived from the library, while the latter only
97
+ works together with the library.
98
+
99
+ Note that it is possible for a library to be covered by the ordinary
100
+ General Public License rather than by this special one.
101
+
102
+ GNU LIBRARY GENERAL PUBLIC LICENSE
103
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
104
+
105
+ 0. This License Agreement applies to any software library which
106
+ contains a notice placed by the copyright holder or other authorized
107
+ party saying it may be distributed under the terms of this Library
108
+ General Public License (also called "this License"). Each licensee is
109
+ addressed as "you".
110
+
111
+ A "library" means a collection of software functions and/or data
112
+ prepared so as to be conveniently linked with application programs
113
+ (which use some of those functions and data) to form executables.
114
+
115
+ The "Library", below, refers to any such software library or work
116
+ which has been distributed under these terms. A "work based on the
117
+ Library" means either the Library or any derivative work under
118
+ copyright law: that is to say, a work containing the Library or a
119
+ portion of it, either verbatim or with modifications and/or translated
120
+ straightforwardly into another language. (Hereinafter, translation is
121
+ included without limitation in the term "modification".)
122
+
123
+ "Source code" for a work means the preferred form of the work for
124
+ making modifications to it. For a library, complete source code means
125
+ all the source code for all modules it contains, plus any associated
126
+ interface definition files, plus the scripts used to control compilation
127
+ and installation of the library.
128
+
129
+ Activities other than copying, distribution and modification are not
130
+ covered by this License; they are outside its scope. The act of
131
+ running a program using the Library is not restricted, and output from
132
+ such a program is covered only if its contents constitute a work based
133
+ on the Library (independent of the use of the Library in a tool for
134
+ writing it). Whether that is true depends on what the Library does
135
+ and what the program that uses the Library does.
136
+
137
+ 1. You may copy and distribute verbatim copies of the Library's
138
+ complete source code as you receive it, in any medium, provided that
139
+ you conspicuously and appropriately publish on each copy an
140
+ appropriate copyright notice and disclaimer of warranty; keep intact
141
+ all the notices that refer to this License and to the absence of any
142
+ warranty; and distribute a copy of this License along with the
143
+ Library.
144
+
145
+ You may charge a fee for the physical act of transferring a copy,
146
+ and you may at your option offer warranty protection in exchange for a
147
+ fee.
148
+
149
+ 2. You may modify your copy or copies of the Library or any portion
150
+ of it, thus forming a work based on the Library, and copy and
151
+ distribute such modifications or work under the terms of Section 1
152
+ above, provided that you also meet all of these conditions:
153
+
154
+ a) The modified work must itself be a software library.
155
+
156
+ b) You must cause the files modified to carry prominent notices
157
+ stating that you changed the files and the date of any change.
158
+
159
+ c) You must cause the whole of the work to be licensed at no
160
+ charge to all third parties under the terms of this License.
161
+
162
+ d) If a facility in the modified Library refers to a function or a
163
+ table of data to be supplied by an application program that uses
164
+ the facility, other than as an argument passed when the facility
165
+ is invoked, then you must make a good faith effort to ensure that,
166
+ in the event an application does not supply such function or
167
+ table, the facility still operates, and performs whatever part of
168
+ its purpose remains meaningful.
169
+
170
+ (For example, a function in a library to compute square roots has
171
+ a purpose that is entirely well-defined independent of the
172
+ application. Therefore, Subsection 2d requires that any
173
+ application-supplied function or table used by this function must
174
+ be optional: if the application does not supply it, the square
175
+ root function must still compute square roots.)
176
+
177
+ These requirements apply to the modified work as a whole. If
178
+ identifiable sections of that work are not derived from the Library,
179
+ and can be reasonably considered independent and separate works in
180
+ themselves, then this License, and its terms, do not apply to those
181
+ sections when you distribute them as separate works. But when you
182
+ distribute the same sections as part of a whole which is a work based
183
+ on the Library, the distribution of the whole must be on the terms of
184
+ this License, whose permissions for other licensees extend to the
185
+ entire whole, and thus to each and every part regardless of who wrote
186
+ it.
187
+
188
+ Thus, it is not the intent of this section to claim rights or contest
189
+ your rights to work written entirely by you; rather, the intent is to
190
+ exercise the right to control the distribution of derivative or
191
+ collective works based on the Library.
192
+
193
+ In addition, mere aggregation of another work not based on the Library
194
+ with the Library (or with a work based on the Library) on a volume of
195
+ a storage or distribution medium does not bring the other work under
196
+ the scope of this License.
197
+
198
+ 3. You may opt to apply the terms of the ordinary GNU General Public
199
+ License instead of this License to a given copy of the Library. To do
200
+ this, you must alter all the notices that refer to this License, so
201
+ that they refer to the ordinary GNU General Public License, version 2,
202
+ instead of to this License. (If a newer version than version 2 of the
203
+ ordinary GNU General Public License has appeared, then you can specify
204
+ that version instead if you wish.) Do not make any other change in
205
+ these notices.
206
+
207
+ Once this change is made in a given copy, it is irreversible for
208
+ that copy, so the ordinary GNU General Public License applies to all
209
+ subsequent copies and derivative works made from that copy.
210
+
211
+ This option is useful when you wish to copy part of the code of
212
+ the Library into a program that is not a library.
213
+
214
+ 4. You may copy and distribute the Library (or a portion or
215
+ derivative of it, under Section 2) in object code or executable form
216
+ under the terms of Sections 1 and 2 above provided that you accompany
217
+ it with the complete corresponding machine-readable source code, which
218
+ must be distributed under the terms of Sections 1 and 2 above on a
219
+ medium customarily used for software interchange.
220
+
221
+ If distribution of object code is made by offering access to copy
222
+ from a designated place, then offering equivalent access to copy the
223
+ source code from the same place satisfies the requirement to
224
+ distribute the source code, even though third parties are not
225
+ compelled to copy the source along with the object code.
226
+
227
+ 5. A program that contains no derivative of any portion of the
228
+ Library, but is designed to work with the Library by being compiled or
229
+ linked with it, is called a "work that uses the Library". Such a
230
+ work, in isolation, is not a derivative work of the Library, and
231
+ therefore falls outside the scope of this License.
232
+
233
+ However, linking a "work that uses the Library" with the Library
234
+ creates an executable that is a derivative of the Library (because it
235
+ contains portions of the Library), rather than a "work that uses the
236
+ library". The executable is therefore covered by this License.
237
+ Section 6 states terms for distribution of such executables.
238
+
239
+ When a "work that uses the Library" uses material from a header file
240
+ that is part of the Library, the object code for the work may be a
241
+ derivative work of the Library even though the source code is not.
242
+ Whether this is true is especially significant if the work can be
243
+ linked without the Library, or if the work is itself a library. The
244
+ threshold for this to be true is not precisely defined by law.
245
+
246
+ If such an object file uses only numerical parameters, data
247
+ structure layouts and accessors, and small macros and small inline
248
+ functions (ten lines or less in length), then the use of the object
249
+ file is unrestricted, regardless of whether it is legally a derivative
250
+ work. (Executables containing this object code plus portions of the
251
+ Library will still fall under Section 6.)
252
+
253
+ Otherwise, if the work is a derivative of the Library, you may
254
+ distribute the object code for the work under the terms of Section 6.
255
+ Any executables containing that work also fall under Section 6,
256
+ whether or not they are linked directly with the Library itself.
257
+
258
+ 6. As an exception to the Sections above, you may also compile or
259
+ link a "work that uses the Library" with the Library to produce a
260
+ work containing portions of the Library, and distribute that work
261
+ under terms of your choice, provided that the terms permit
262
+ modification of the work for the customer's own use and reverse
263
+ engineering for debugging such modifications.
264
+
265
+ You must give prominent notice with each copy of the work that the
266
+ Library is used in it and that the Library and its use are covered by
267
+ this License. You must supply a copy of this License. If the work
268
+ during execution displays copyright notices, you must include the
269
+ copyright notice for the Library among them, as well as a reference
270
+ directing the user to the copy of this License. Also, you must do one
271
+ of these things:
272
+
273
+ a) Accompany the work with the complete corresponding
274
+ machine-readable source code for the Library including whatever
275
+ changes were used in the work (which must be distributed under
276
+ Sections 1 and 2 above); and, if the work is an executable linked
277
+ with the Library, with the complete machine-readable "work that
278
+ uses the Library", as object code and/or source code, so that the
279
+ user can modify the Library and then relink to produce a modified
280
+ executable containing the modified Library. (It is understood
281
+ that the user who changes the contents of definitions files in the
282
+ Library will not necessarily be able to recompile the application
283
+ to use the modified definitions.)
284
+
285
+ b) Accompany the work with a written offer, valid for at
286
+ least three years, to give the same user the materials
287
+ specified in Subsection 6a, above, for a charge no more
288
+ than the cost of performing this distribution.
289
+
290
+ c) If distribution of the work is made by offering access to copy
291
+ from a designated place, offer equivalent access to copy the above
292
+ specified materials from the same place.
293
+
294
+ d) Verify that the user has already received a copy of these
295
+ materials or that you have already sent this user a copy.
296
+
297
+ For an executable, the required form of the "work that uses the
298
+ Library" must include any data and utility programs needed for
299
+ reproducing the executable from it. However, as a special exception,
300
+ the source code distributed need not include anything that is normally
301
+ distributed (in either source or binary form) with the major
302
+ components (compiler, kernel, and so on) of the operating system on
303
+ which the executable runs, unless that component itself accompanies
304
+ the executable.
305
+
306
+ It may happen that this requirement contradicts the license
307
+ restrictions of other proprietary libraries that do not normally
308
+ accompany the operating system. Such a contradiction means you cannot
309
+ use both them and the Library together in an executable that you
310
+ distribute.
311
+
312
+ 7. You may place library facilities that are a work based on the
313
+ Library side-by-side in a single library together with other library
314
+ facilities not covered by this License, and distribute such a combined
315
+ library, provided that the separate distribution of the work based on
316
+ the Library and of the other library facilities is otherwise
317
+ permitted, and provided that you do these two things:
318
+
319
+ a) Accompany the combined library with a copy of the same work
320
+ based on the Library, uncombined with any other library
321
+ facilities. This must be distributed under the terms of the
322
+ Sections above.
323
+
324
+ b) Give prominent notice with the combined library of the fact
325
+ that part of it is a work based on the Library, and explaining
326
+ where to find the accompanying uncombined form of the same work.
327
+
328
+ 8. You may not copy, modify, sublicense, link with, or distribute
329
+ the Library except as expressly provided under this License. Any
330
+ attempt otherwise to copy, modify, sublicense, link with, or
331
+ distribute the Library is void, and will automatically terminate your
332
+ rights under this License. However, parties who have received copies,
333
+ or rights, from you under this License will not have their licenses
334
+ terminated so long as such parties remain in full compliance.
335
+
336
+ 9. You are not required to accept this License, since you have not
337
+ signed it. However, nothing else grants you permission to modify or
338
+ distribute the Library or its derivative works. These actions are
339
+ prohibited by law if you do not accept this License. Therefore, by
340
+ modifying or distributing the Library (or any work based on the
341
+ Library), you indicate your acceptance of this License to do so, and
342
+ all its terms and conditions for copying, distributing or modifying
343
+ the Library or works based on it.
344
+
345
+ 10. Each time you redistribute the Library (or any work based on the
346
+ Library), the recipient automatically receives a license from the
347
+ original licensor to copy, distribute, link with or modify the Library
348
+ subject to these terms and conditions. You may not impose any further
349
+ restrictions on the recipients' exercise of the rights granted herein.
350
+ You are not responsible for enforcing compliance by third parties to
351
+ this License.
352
+
353
+ 11. If, as a consequence of a court judgment or allegation of patent
354
+ infringement or for any other reason (not limited to patent issues),
355
+ conditions are imposed on you (whether by court order, agreement or
356
+ otherwise) that contradict the conditions of this License, they do not
357
+ excuse you from the conditions of this License. If you cannot
358
+ distribute so as to satisfy simultaneously your obligations under this
359
+ License and any other pertinent obligations, then as a consequence you
360
+ may not distribute the Library at all. For example, if a patent
361
+ license would not permit royalty-free redistribution of the Library by
362
+ all those who receive copies directly or indirectly through you, then
363
+ the only way you could satisfy both it and this License would be to
364
+ refrain entirely from distribution of the Library.
365
+
366
+ If any portion of this section is held invalid or unenforceable under any
367
+ particular circumstance, the balance of the section is intended to apply,
368
+ and the section as a whole is intended to apply in other circumstances.
369
+
370
+ It is not the purpose of this section to induce you to infringe any
371
+ patents or other property right claims or to contest validity of any
372
+ such claims; this section has the sole purpose of protecting the
373
+ integrity of the free software distribution system which is
374
+ implemented by public license practices. Many people have made
375
+ generous contributions to the wide range of software distributed
376
+ through that system in reliance on consistent application of that
377
+ system; it is up to the author/donor to decide if he or she is willing
378
+ to distribute software through any other system and a licensee cannot
379
+ impose that choice.
380
+
381
+ This section is intended to make thoroughly clear what is believed to
382
+ be a consequence of the rest of this License.
383
+
384
+ 12. If the distribution and/or use of the Library is restricted in
385
+ certain countries either by patents or by copyrighted interfaces, the
386
+ original copyright holder who places the Library under this License may add
387
+ an explicit geographical distribution limitation excluding those countries,
388
+ so that distribution is permitted only in or among countries not thus
389
+ excluded. In such case, this License incorporates the limitation as if
390
+ written in the body of this License.
391
+
392
+ 13. The Free Software Foundation may publish revised and/or new
393
+ versions of the Library General Public License from time to time.
394
+ Such new versions will be similar in spirit to the present version,
395
+ but may differ in detail to address new problems or concerns.
396
+
397
+ Each version is given a distinguishing version number. If the Library
398
+ specifies a version number of this License which applies to it and
399
+ "any later version", you have the option of following the terms and
400
+ conditions either of that version or of any later version published by
401
+ the Free Software Foundation. If the Library does not specify a
402
+ license version number, you may choose any version ever published by
403
+ the Free Software Foundation.
404
+
405
+ 14. If you wish to incorporate parts of the Library into other free
406
+ programs whose distribution conditions are incompatible with these,
407
+ write to the author to ask for permission. For software which is
408
+ copyrighted by the Free Software Foundation, write to the Free
409
+ Software Foundation; we sometimes make exceptions for this. Our
410
+ decision will be guided by the two goals of preserving the free status
411
+ of all derivatives of our free software and of promoting the sharing
412
+ and reuse of software generally.
413
+
414
+ NO WARRANTY
415
+
416
+ 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
417
+ WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
418
+ EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
419
+ OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
420
+ KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
421
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
422
+ PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
423
+ LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
424
+ THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
425
+
426
+ 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
427
+ WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
428
+ AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
429
+ FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
430
+ CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
431
+ LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
432
+ RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
433
+ FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
434
+ SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
435
+ DAMAGES.
436
+
437
+ END OF TERMS AND CONDITIONS
438
+
439
+ Appendix: How to Apply These Terms to Your New Libraries
440
+
441
+ If you develop a new library, and you want it to be of the greatest
442
+ possible use to the public, we recommend making it free software that
443
+ everyone can redistribute and change. You can do so by permitting
444
+ redistribution under these terms (or, alternatively, under the terms of the
445
+ ordinary General Public License).
446
+
447
+ To apply these terms, attach the following notices to the library. It is
448
+ safest to attach them to the start of each source file to most effectively
449
+ convey the exclusion of warranty; and each file should have at least the
450
+ "copyright" line and a pointer to where the full notice is found.
451
+
452
+ <one line to give the library's name and a brief idea of what it does.>
453
+ Copyright (C) <year> <name of author>
454
+
455
+ This library is free software; you can redistribute it and/or
456
+ modify it under the terms of the GNU Library General Public
457
+ License as published by the Free Software Foundation; either
458
+ version 2 of the License, or (at your option) any later version.
459
+
460
+ This library is distributed in the hope that it will be useful,
461
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
462
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
463
+ Library General Public License for more details.
464
+
465
+ You should have received a copy of the GNU Library General Public
466
+ License along with this library; if not, write to the Free
467
+ Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
468
+
469
+ Also add information on how to contact you by electronic and paper mail.
470
+
471
+ You should also get your employer (if you work as a programmer) or your
472
+ school, if any, to sign a "copyright disclaimer" for the library, if
473
+ necessary. Here is a sample; alter the names:
474
+
475
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the
476
+ library `Frob' (a library for tweaking knobs) written by James Random Hacker.
477
+
478
+ <signature of Ty Coon>, 1 April 1990
479
+ Ty Coon, President of Vice
480
+
481
+ That's all there is to it!
data/Manifest ADDED
@@ -0,0 +1,7 @@
1
+ CHANGELOG
2
+ LICENSE
3
+ README.rdoc
4
+ Rakefile
5
+ lib/epublishing/memoizable_method_missing.rb
6
+ spec/epublishing/memoizable_method_missing_spec.rb
7
+ Manifest
data/README.rdoc ADDED
@@ -0,0 +1,80 @@
1
+ = MemoizableMethodMissing - Optimizes method_missing use
2
+
3
+ == Introduction
4
+
5
+ We Rubyists love method_missing, but it isn't always the most
6
+ efficient way to do things. Following ActiveRecord's lead, we
7
+ want to have the ability to create a method definition for a given
8
+ missing method (that would otherwise be handled by method_missing
9
+ logic) so that subsequent requests to that method do not have to
10
+ get handled by method_missing.
11
+
12
+ == Notes
13
+
14
+ NOTE: This can be used in conjunction with method_missing in the
15
+ case that there is some method_missing_logic that is dependant
16
+ on the args and not just the method name.
17
+
18
+ NOTE: The return value of the memoize_method_missing block
19
+ should be one of:
20
+
21
+ 1) String -- which can be evaled into the method definition
22
+ 2) Proc -- which can be set as the method definition
23
+ 4) nil -- meaning the call should be forwarded along to method_missing
24
+
25
+ NOTE: Profiling with ruby-prof has shown speed improvements of 40-60%
26
+ in using memoize_method_missing over just method_missing (after the initial
27
+ cost of creating the method on the fly). The test was minimal and only
28
+ involved a simple regex. More complex logic may result in even greater
29
+ performance gains. The performance difference between using an eval'ed
30
+ String and a Proc (see NOTE above) was negligible.
31
+
32
+ == Installation
33
+
34
+ gem install memoizable_method_missing
35
+
36
+ == Git Repository
37
+
38
+ http://github.com/ePublishing/memoizable_method_missing
39
+
40
+ == Usage
41
+
42
+ class Foo
43
+
44
+ extend Epublishing::MemoizableMethodMissing
45
+
46
+ def method_missing(method, *args, &block)
47
+ if method.to_s =~ /^by_array_(.*)/ and args.first == :all
48
+ do_something($1.to_sym, args.last)
49
+ else
50
+ super
51
+ end
52
+ end
53
+
54
+ memoize_method_missing do |method|
55
+ case method.to_s
56
+ when /^by_xyz_(.*)$/
57
+ "do_something #{$1.inspect}, args.first, yield"
58
+ when /^by_id_(\d+)$/
59
+ id = $1.to_i
60
+ lambda { do_something(id) }
61
+ when /^by_name_(.*)$/
62
+ name = $1
63
+ lambda do |a1, a2, &block|
64
+ do_something(name, a1 * a2, block.call)
65
+ end
66
+ end
67
+ end
68
+
69
+ end
70
+
71
+ Foo.new.by_xyz_bar(42) { :foo } => do_something("bar", 42, :foo)
72
+ Foo.new.by_id_33 => do_something(33)
73
+ Foo.new.by_name_chris(3, 2) { :foo } => do_something('chris', 6, :foo)
74
+ Foo.new.by_array_foo(:all, 7) => do_something(:foo, 7)
75
+ Foo.new.by_array_foo(:bogus) => NoSuchMethodError
76
+
77
+ ---
78
+ Author:: David McCullars <mailto:dmccullars@ePublishing.com>
79
+ Copyright:: (C) 2011 ePublishing
80
+ Licence:: GPL[http://www.gnu.org/copyleft/gpl.html]
data/Rakefile ADDED
@@ -0,0 +1,29 @@
1
+ require 'rake'
2
+ require 'echoe'
3
+ require 'rake/rdoctask'
4
+ require 'spec/rake/spectask'
5
+
6
+ task :default => :gem
7
+
8
+ Echoe.new("memoizable_method_missing") do |s|
9
+ s.author = "David McCullars"
10
+ s.project = "memoizable_method_missing"
11
+ s.email = "dmccullars@ePublishing.com"
12
+ s.url = "http://github.com/ePublishing/memoizable_method_missing"
13
+ sdocs_host = "http://rdoc.info/github/ePublishing/memoizable_method_missing/master/frames"
14
+ s.rdoc_pattern = /README|TODO|LICENSE|CHANGELOG|BENCH|COMPAT|exceptions|behaviors|memoizable_method_missing.rb/
15
+ s.clean_pattern += ["ext/lib", "ext/include", "ext/share", "ext/libmemoizable_method_missing-?.??", "ext/bin", "ext/conftest.dSYM"]
16
+ s.summary = 'Optimize method_missing usage'
17
+ end
18
+
19
+ desc 'generate API documentation to doc/rdocs/index.html'
20
+ Rake::RDocTask.new do |rd|
21
+ rd.rdoc_dir = 'doc/rdocs'
22
+ rd.main = 'README.rdoc'
23
+ rd.rdoc_files.include 'README.rdoc', 'CHANGELOG', 'lib/**/*.rb'
24
+ rd.rdoc_files.exclude '**/string_ext.rb', '**/net_https_hack.rb'
25
+ rd.options << '--inline-source'
26
+ rd.options << '--line-numbers'
27
+ rd.options << '--all'
28
+ rd.options << '--fileboxes'
29
+ end
@@ -0,0 +1,95 @@
1
+ #--
2
+ # memoizable_method_missing.rb - Optimize method_missing usage
3
+ #++
4
+ #
5
+ # == Overview
6
+ #
7
+ # We Rubyists love method_missing, but it isn't always the most
8
+ # efficient way to do things. Following ActiveRecord's lead, we
9
+ # want to have the ability to create a method definition for a given
10
+ # missing method (that would otherwise be handled by method_missing
11
+ # logic) so that subsequent requests to that method do not have to
12
+ # get handled by method_missing.
13
+ #
14
+ # NOTE: This can be used in conjunction with method_missing in the
15
+ # case that there is some method_missing_logic that is dependant
16
+ # on the args and not just the method name.
17
+ #
18
+ # NOTE: The return value of the memoize_method_missing block
19
+ # should be one of:
20
+ #
21
+ # 1) String -- which can be evaled into the method definition
22
+ # 2) Proc -- which can be set as the method definition
23
+ # 4) nil -- meaning the call should be forwarded along to method_missing
24
+ #
25
+ # NOTE: Profiling with ruby-prof has shown speed improvements of 40-60%
26
+ # in using memoize_method_missing over just method_missing (after the initial
27
+ # cost of creating the method on the fly). The test was minimal and only
28
+ # involved a simple regex. More complex logic may result in even greater
29
+ # performance gains. The performance difference between using an eval'ed
30
+ # String and a Proc (see NOTE above) was negligible.
31
+ #
32
+ # == Use
33
+ #
34
+ # class Foo
35
+ #
36
+ # extend Epublishing::MemoizableMethodMissing
37
+ #
38
+ # def method_missing(method, *args, &block)
39
+ # if method.to_s =~ /^by_array_(.*)/ and args.first == :all
40
+ # do_something($1.to_sym, args.last)
41
+ # else
42
+ # super
43
+ # end
44
+ # end
45
+ #
46
+ # memoize_method_missing do |method|
47
+ # case method.to_s
48
+ # when /^by_xyz_(.*)$/
49
+ # "do_something #{$1.inspect}, args.first, yield"
50
+ # when /^by_id_(\d+)$/
51
+ # id = $1.to_i
52
+ # lambda { do_something(id) }
53
+ # when /^by_name_(.*)$/
54
+ # name = $1
55
+ # lambda do |a1, a2, &block|
56
+ # do_something(name, a1 * a2, block.call)
57
+ # end
58
+ # end
59
+ # end
60
+ #
61
+ # end
62
+ #
63
+ # Foo.new.by_xyz_bar(42) { :foo } => do_something("bar", 42, :foo)
64
+ # Foo.new.by_id_33 => do_something(33)
65
+ # Foo.new.by_name_chris(3, 2) { :foo } => do_something('chris', 6, :foo)
66
+ # Foo.new.by_array_foo(:all, 7) => do_something(:foo, 7)
67
+ # Foo.new.by_array_foo(:bogus) => NoSuchMethodError
68
+ #
69
+ # == Contact
70
+ #
71
+ # - David McCullars <dmccullars@ePublishing.com>
72
+ #
73
+ module Epublishing
74
+ module MemoizableMethodMissing
75
+
76
+ def memoize_method_missing(&what_to_do)
77
+ define_method :method_missing_with_memoization do |method, *args, &block|
78
+ case to_do = what_to_do.call(method)
79
+ when String
80
+ self.class.class_eval "def #{method}(*args, &block); #{to_do} end", __FILE__, __LINE__
81
+ send(method, *args, &block)
82
+ when Proc
83
+ self.class.send :define_method, method, &to_do
84
+ send(method, *args, &block)
85
+ else
86
+ method_missing_without_memoization(method, *args, &block)
87
+ end
88
+ end
89
+
90
+ alias_method :method_missing_without_memoization, :method_missing
91
+ alias_method :method_missing, :method_missing_with_memoization
92
+ end
93
+
94
+ end
95
+ end
@@ -0,0 +1,30 @@
1
+ # -*- encoding: utf-8 -*-
2
+
3
+ Gem::Specification.new do |s|
4
+ s.name = %q{memoizable_method_missing}
5
+ s.version = "0.0.1"
6
+
7
+ s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
8
+ s.authors = ["David McCullars"]
9
+ s.date = %q{2011-04-29}
10
+ s.description = %q{Optimize method_missing usage}
11
+ s.email = %q{dmccullars@ePublishing.com}
12
+ s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.rdoc", "lib/epublishing/memoizable_method_missing.rb"]
13
+ s.files = ["CHANGELOG", "LICENSE", "README.rdoc", "Rakefile", "lib/epublishing/memoizable_method_missing.rb", "spec/epublishing/memoizable_method_missing_spec.rb", "Manifest", "memoizable_method_missing.gemspec"]
14
+ s.homepage = %q{http://github.com/ePublishing/memoizable_method_missing}
15
+ s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Memoizable_method_missing", "--main", "README.rdoc"]
16
+ s.require_paths = ["lib"]
17
+ s.rubyforge_project = %q{memoizable_method_missing}
18
+ s.rubygems_version = %q{1.3.6}
19
+ s.summary = %q{Optimize method_missing usage}
20
+
21
+ if s.respond_to? :specification_version then
22
+ current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
23
+ s.specification_version = 3
24
+
25
+ if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
26
+ else
27
+ end
28
+ else
29
+ end
30
+ end
@@ -0,0 +1,52 @@
1
+ require 'epublishing/memoizable_method_missing'
2
+
3
+ describe Epublishing::MemoizableMethodMissing do
4
+
5
+ before(:all) do
6
+ @dummy = DummyMmm.new
7
+ end
8
+
9
+ it "should call method_missing once" do
10
+ @dummy.no_such_foo(22) { :a }.should == 'foo/22/a' # Call once to create method
11
+ @dummy.should_not_receive(:method_missing)
12
+ @dummy.no_such_foo(73) { :b }.should == 'foo/73/b'
13
+ end
14
+
15
+ it "should work with lambdas" do
16
+ @dummy.no_lambda_foo.should == 'foofoofoo' # Call once to create method
17
+ @dummy.should_not_receive(:method_missing)
18
+ @dummy.no_lambda_foo.should == 'foofoofoo'
19
+ end
20
+
21
+ it "should call original method_missing if not memoized" do
22
+ @dummy.not_memoized(5, 'z') { :foo }.should == [:handled_manually, 5, "z", :foo]
23
+ end
24
+
25
+ it "should throw missing method if not handled" do
26
+ expect { @dummy.not_handled }.should raise_error(NoMethodError)
27
+ end
28
+
29
+ class DummyMmm
30
+
31
+ extend Epublishing::MemoizableMethodMissing
32
+
33
+ def method_missing(method, *args, &block)
34
+ if method == :not_memoized
35
+ [:handled_manually, args, yield].flatten
36
+ else
37
+ super
38
+ end
39
+ end
40
+
41
+ memoize_method_missing do |method|
42
+ if method.to_s =~ /^no_such_(.*)/
43
+ "[#{$1.to_sym.inspect}, args.first, yield] * '/'"
44
+ elsif method.to_s =~ /^no_lambda_(.*)/
45
+ name = $1
46
+ lambda { name * 3 }
47
+ end
48
+ end
49
+
50
+ end
51
+
52
+ end
metadata ADDED
@@ -0,0 +1,78 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: memoizable_method_missing
3
+ version: !ruby/object:Gem::Version
4
+ prerelease: false
5
+ segments:
6
+ - 0
7
+ - 0
8
+ - 1
9
+ version: 0.0.1
10
+ platform: ruby
11
+ authors:
12
+ - David McCullars
13
+ autorequire:
14
+ bindir: bin
15
+ cert_chain: []
16
+
17
+ date: 2011-04-29 00:00:00 -04:00
18
+ default_executable:
19
+ dependencies: []
20
+
21
+ description: Optimize method_missing usage
22
+ email: dmccullars@ePublishing.com
23
+ executables: []
24
+
25
+ extensions: []
26
+
27
+ extra_rdoc_files:
28
+ - CHANGELOG
29
+ - LICENSE
30
+ - README.rdoc
31
+ - lib/epublishing/memoizable_method_missing.rb
32
+ files:
33
+ - CHANGELOG
34
+ - LICENSE
35
+ - README.rdoc
36
+ - Rakefile
37
+ - lib/epublishing/memoizable_method_missing.rb
38
+ - spec/epublishing/memoizable_method_missing_spec.rb
39
+ - Manifest
40
+ - memoizable_method_missing.gemspec
41
+ has_rdoc: true
42
+ homepage: http://github.com/ePublishing/memoizable_method_missing
43
+ licenses: []
44
+
45
+ post_install_message:
46
+ rdoc_options:
47
+ - --line-numbers
48
+ - --inline-source
49
+ - --title
50
+ - Memoizable_method_missing
51
+ - --main
52
+ - README.rdoc
53
+ require_paths:
54
+ - lib
55
+ required_ruby_version: !ruby/object:Gem::Requirement
56
+ requirements:
57
+ - - ">="
58
+ - !ruby/object:Gem::Version
59
+ segments:
60
+ - 0
61
+ version: "0"
62
+ required_rubygems_version: !ruby/object:Gem::Requirement
63
+ requirements:
64
+ - - ">="
65
+ - !ruby/object:Gem::Version
66
+ segments:
67
+ - 1
68
+ - 2
69
+ version: "1.2"
70
+ requirements: []
71
+
72
+ rubyforge_project: memoizable_method_missing
73
+ rubygems_version: 1.3.6
74
+ signing_key:
75
+ specification_version: 3
76
+ summary: Optimize method_missing usage
77
+ test_files: []
78
+