lucasdecastro-immutable 0.3

Sign up to get free protection for your applications and to get access to all the features.
data/COPYING ADDED
@@ -0,0 +1,340 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
5
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ Preamble
10
+
11
+ The licenses for most software are designed to take away your
12
+ freedom to share and change it. By contrast, the GNU General Public
13
+ License is intended to guarantee your freedom to share and change free
14
+ software--to make sure the software is free for all its users. This
15
+ General Public License applies to most of the Free Software
16
+ Foundation's software and to any other program whose authors commit to
17
+ using it. (Some other Free Software Foundation software is covered by
18
+ the GNU Library General Public License instead.) You can apply it to
19
+ your programs, too.
20
+
21
+ When we speak of free software, we are referring to freedom, not
22
+ price. Our General Public Licenses are designed to make sure that you
23
+ have the freedom to distribute copies of free software (and charge for
24
+ this service if you wish), that you receive source code or can get it
25
+ if you want it, that you can change the software or use pieces of it
26
+ in new free programs; and that you know you can do these things.
27
+
28
+ To protect your rights, we need to make restrictions that forbid
29
+ anyone to deny you these rights or to ask you to surrender the rights.
30
+ These restrictions translate to certain responsibilities for you if you
31
+ distribute copies of the software, or if you modify it.
32
+
33
+ For example, if you distribute copies of such a program, whether
34
+ gratis or for a fee, you must give the recipients all the rights that
35
+ you have. You must make sure that they, too, receive or can get the
36
+ source code. And you must show them these terms so they know their
37
+ rights.
38
+
39
+ We protect your rights with two steps: (1) copyright the software, and
40
+ (2) offer you this license which gives you legal permission to copy,
41
+ distribute and/or modify the software.
42
+
43
+ Also, for each author's protection and ours, we want to make certain
44
+ that everyone understands that there is no warranty for this free
45
+ software. If the software is modified by someone else and passed on, we
46
+ want its recipients to know that what they have is not the original, so
47
+ that any problems introduced by others will not reflect on the original
48
+ authors' reputations.
49
+
50
+ Finally, any free program is threatened constantly by software
51
+ patents. We wish to avoid the danger that redistributors of a free
52
+ program will individually obtain patent licenses, in effect making the
53
+ program proprietary. To prevent this, we have made it clear that any
54
+ patent must be licensed for everyone's free use or not licensed at all.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ GNU GENERAL PUBLIC LICENSE
60
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61
+
62
+ 0. This License applies to any program or other work which contains
63
+ a notice placed by the copyright holder saying it may be distributed
64
+ under the terms of this General Public License. The "Program", below,
65
+ refers to any such program or work, and a "work based on the Program"
66
+ means either the Program or any derivative work under copyright law:
67
+ that is to say, a work containing the Program or a portion of it,
68
+ either verbatim or with modifications and/or translated into another
69
+ language. (Hereinafter, translation is included without limitation in
70
+ the term "modification".) Each licensee is addressed as "you".
71
+
72
+ Activities other than copying, distribution and modification are not
73
+ covered by this License; they are outside its scope. The act of
74
+ running the Program is not restricted, and the output from the Program
75
+ is covered only if its contents constitute a work based on the
76
+ Program (independent of having been made by running the Program).
77
+ Whether that is true depends on what the Program does.
78
+
79
+ 1. You may copy and distribute verbatim copies of the Program's
80
+ source code as you receive it, in any medium, provided that you
81
+ conspicuously and appropriately publish on each copy an appropriate
82
+ copyright notice and disclaimer of warranty; keep intact all the
83
+ notices that refer to this License and to the absence of any warranty;
84
+ and give any other recipients of the Program a copy of this License
85
+ along with the Program.
86
+
87
+ You may charge a fee for the physical act of transferring a copy, and
88
+ you may at your option offer warranty protection in exchange for a fee.
89
+
90
+ 2. You may modify your copy or copies of the Program or any portion
91
+ of it, thus forming a work based on the Program, and copy and
92
+ distribute such modifications or work under the terms of Section 1
93
+ above, provided that you also meet all of these conditions:
94
+
95
+ a) You must cause the modified files to carry prominent notices
96
+ stating that you changed the files and the date of any change.
97
+
98
+ b) You must cause any work that you distribute or publish, that in
99
+ whole or in part contains or is derived from the Program or any
100
+ part thereof, to be licensed as a whole at no charge to all third
101
+ parties under the terms of this License.
102
+
103
+ c) If the modified program normally reads commands interactively
104
+ when run, you must cause it, when started running for such
105
+ interactive use in the most ordinary way, to print or display an
106
+ announcement including an appropriate copyright notice and a
107
+ notice that there is no warranty (or else, saying that you provide
108
+ a warranty) and that users may redistribute the program under
109
+ these conditions, and telling the user how to view a copy of this
110
+ License. (Exception: if the Program itself is interactive but
111
+ does not normally print such an announcement, your work based on
112
+ the Program is not required to print an announcement.)
113
+
114
+ These requirements apply to the modified work as a whole. If
115
+ identifiable sections of that work are not derived from the Program,
116
+ and can be reasonably considered independent and separate works in
117
+ themselves, then this License, and its terms, do not apply to those
118
+ sections when you distribute them as separate works. But when you
119
+ distribute the same sections as part of a whole which is a work based
120
+ on the Program, the distribution of the whole must be on the terms of
121
+ this License, whose permissions for other licensees extend to the
122
+ entire whole, and thus to each and every part regardless of who wrote it.
123
+
124
+ Thus, it is not the intent of this section to claim rights or contest
125
+ your rights to work written entirely by you; rather, the intent is to
126
+ exercise the right to control the distribution of derivative or
127
+ collective works based on the Program.
128
+
129
+ In addition, mere aggregation of another work not based on the Program
130
+ with the Program (or with a work based on the Program) on a volume of
131
+ a storage or distribution medium does not bring the other work under
132
+ the scope of this License.
133
+
134
+ 3. You may copy and distribute the Program (or a work based on it,
135
+ under Section 2) in object code or executable form under the terms of
136
+ Sections 1 and 2 above provided that you also do one of the following:
137
+
138
+ a) Accompany it with the complete corresponding machine-readable
139
+ source code, which must be distributed under the terms of Sections
140
+ 1 and 2 above on a medium customarily used for software interchange; or,
141
+
142
+ b) Accompany it with a written offer, valid for at least three
143
+ years, to give any third party, for a charge no more than your
144
+ cost of physically performing source distribution, a complete
145
+ machine-readable copy of the corresponding source code, to be
146
+ distributed under the terms of Sections 1 and 2 above on a medium
147
+ customarily used for software interchange; or,
148
+
149
+ c) Accompany it with the information you received as to the offer
150
+ to distribute corresponding source code. (This alternative is
151
+ allowed only for noncommercial distribution and only if you
152
+ received the program in object code or executable form with such
153
+ an offer, in accord with Subsection b above.)
154
+
155
+ The source code for a work means the preferred form of the work for
156
+ making modifications to it. For an executable work, complete source
157
+ code means all the source code for all modules it contains, plus any
158
+ associated interface definition files, plus the scripts used to
159
+ control compilation and installation of the executable. However, as a
160
+ special exception, the source code distributed need not include
161
+ anything that is normally distributed (in either source or binary
162
+ form) with the major components (compiler, kernel, and so on) of the
163
+ operating system on which the executable runs, unless that component
164
+ itself accompanies the executable.
165
+
166
+ If distribution of executable or object code is made by offering
167
+ access to copy from a designated place, then offering equivalent
168
+ access to copy the source code from the same place counts as
169
+ distribution of the source code, even though third parties are not
170
+ compelled to copy the source along with the object code.
171
+
172
+ 4. You may not copy, modify, sublicense, or distribute the Program
173
+ except as expressly provided under this License. Any attempt
174
+ otherwise to copy, modify, sublicense or distribute the Program is
175
+ void, and will automatically terminate your rights under this License.
176
+ However, parties who have received copies, or rights, from you under
177
+ this License will not have their licenses terminated so long as such
178
+ parties remain in full compliance.
179
+
180
+ 5. You are not required to accept this License, since you have not
181
+ signed it. However, nothing else grants you permission to modify or
182
+ distribute the Program or its derivative works. These actions are
183
+ prohibited by law if you do not accept this License. Therefore, by
184
+ modifying or distributing the Program (or any work based on the
185
+ Program), you indicate your acceptance of this License to do so, and
186
+ all its terms and conditions for copying, distributing or modifying
187
+ the Program or works based on it.
188
+
189
+ 6. Each time you redistribute the Program (or any work based on the
190
+ Program), the recipient automatically receives a license from the
191
+ original licensor to copy, distribute or modify the Program subject to
192
+ these terms and conditions. You may not impose any further
193
+ restrictions on the recipients' exercise of the rights granted herein.
194
+ You are not responsible for enforcing compliance by third parties to
195
+ this License.
196
+
197
+ 7. If, as a consequence of a court judgment or allegation of patent
198
+ infringement or for any other reason (not limited to patent issues),
199
+ conditions are imposed on you (whether by court order, agreement or
200
+ otherwise) that contradict the conditions of this License, they do not
201
+ excuse you from the conditions of this License. If you cannot
202
+ distribute so as to satisfy simultaneously your obligations under this
203
+ License and any other pertinent obligations, then as a consequence you
204
+ may not distribute the Program at all. For example, if a patent
205
+ license would not permit royalty-free redistribution of the Program by
206
+ all those who receive copies directly or indirectly through you, then
207
+ the only way you could satisfy both it and this License would be to
208
+ refrain entirely from distribution of the Program.
209
+
210
+ If any portion of this section is held invalid or unenforceable under
211
+ any particular circumstance, the balance of the section is intended to
212
+ apply and the section as a whole is intended to apply in other
213
+ circumstances.
214
+
215
+ It is not the purpose of this section to induce you to infringe any
216
+ patents or other property right claims or to contest validity of any
217
+ such claims; this section has the sole purpose of protecting the
218
+ integrity of the free software distribution system, which is
219
+ implemented by public license practices. Many people have made
220
+ generous contributions to the wide range of software distributed
221
+ through that system in reliance on consistent application of that
222
+ system; it is up to the author/donor to decide if he or she is willing
223
+ to distribute software through any other system and a licensee cannot
224
+ impose that choice.
225
+
226
+ This section is intended to make thoroughly clear what is believed to
227
+ be a consequence of the rest of this License.
228
+
229
+ 8. If the distribution and/or use of the Program is restricted in
230
+ certain countries either by patents or by copyrighted interfaces, the
231
+ original copyright holder who places the Program under this License
232
+ may add an explicit geographical distribution limitation excluding
233
+ those countries, so that distribution is permitted only in or among
234
+ countries not thus excluded. In such case, this License incorporates
235
+ the limitation as if written in the body of this License.
236
+
237
+ 9. The Free Software Foundation may publish revised and/or new versions
238
+ of the General Public License from time to time. Such new versions will
239
+ be similar in spirit to the present version, but may differ in detail to
240
+ address new problems or concerns.
241
+
242
+ Each version is given a distinguishing version number. If the Program
243
+ specifies a version number of this License which applies to it and "any
244
+ later version", you have the option of following the terms and conditions
245
+ either of that version or of any later version published by the Free
246
+ Software Foundation. If the Program does not specify a version number of
247
+ this License, you may choose any version ever published by the Free Software
248
+ Foundation.
249
+
250
+ 10. If you wish to incorporate parts of the Program into other free
251
+ programs whose distribution conditions are different, write to the author
252
+ to ask for permission. For software which is copyrighted by the Free
253
+ Software Foundation, write to the Free Software Foundation; we sometimes
254
+ make exceptions for this. Our decision will be guided by the two goals
255
+ of preserving the free status of all derivatives of our free software and
256
+ of promoting the sharing and reuse of software generally.
257
+
258
+ NO WARRANTY
259
+
260
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
+ REPAIR OR CORRECTION.
269
+
270
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
+ POSSIBILITY OF SUCH DAMAGES.
279
+
280
+ END OF TERMS AND CONDITIONS
281
+
282
+ How to Apply These Terms to Your New Programs
283
+
284
+ If you develop a new program, and you want it to be of the greatest
285
+ possible use to the public, the best way to achieve this is to make it
286
+ free software which everyone can redistribute and change under these terms.
287
+
288
+ To do so, attach the following notices to the program. It is safest
289
+ to attach them to the start of each source file to most effectively
290
+ convey the exclusion of warranty; and each file should have at least
291
+ the "copyright" line and a pointer to where the full notice is found.
292
+
293
+ <one line to give the program's name and a brief idea of what it does.>
294
+ Copyright (C) <year> <name of author>
295
+
296
+ This program is free software; you can redistribute it and/or modify
297
+ it under the terms of the GNU General Public License as published by
298
+ the Free Software Foundation; either version 2 of the License, or
299
+ (at your option) any later version.
300
+
301
+ This program is distributed in the hope that it will be useful,
302
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
303
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304
+ GNU General Public License for more details.
305
+
306
+ You should have received a copy of the GNU General Public License
307
+ along with this program; if not, write to the Free Software
308
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
309
+
310
+
311
+ Also add information on how to contact you by electronic and paper mail.
312
+
313
+ If the program is interactive, make it output a short notice like this
314
+ when it starts in an interactive mode:
315
+
316
+ Gnomovision version 69, Copyright (C) year name of author
317
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
318
+ This is free software, and you are welcome to redistribute it
319
+ under certain conditions; type `show c' for details.
320
+
321
+ The hypothetical commands `show w' and `show c' should show the appropriate
322
+ parts of the General Public License. Of course, the commands you use may
323
+ be called something other than `show w' and `show c'; they could even be
324
+ mouse-clicks or menu items--whatever suits your program.
325
+
326
+ You should also get your employer (if you work as a programmer) or your
327
+ school, if any, to sign a "copyright disclaimer" for the program, if
328
+ necessary. Here is a sample; alter the names:
329
+
330
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
331
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
332
+
333
+ <signature of Ty Coon>, 1 April 1989
334
+ Ty Coon, President of Vice
335
+
336
+ This General Public License does not permit incorporating your program into
337
+ proprietary programs. If your program is a subroutine library, you may
338
+ consider it more useful to permit linking proprietary applications with the
339
+ library. If this is what you want to do, use the GNU Library General
340
+ Public License instead of this License.
data/README ADDED
@@ -0,0 +1,226 @@
1
+ =========
2
+ Immutable
3
+ =========
4
+
5
+ :Author: Garry Dolley
6
+ :Date: 09-21-2008
7
+ :Version: v0.2
8
+
9
+ The ``Immutable`` module provides a method (immutable_method) that let's one
10
+ declare method(s) as immutable. That is, other code will not be able to
11
+ open your class and replace your method with one of the same name.
12
+
13
+ Child classes, however, can still override the method. So this is not like
14
+ Java's "final" method modifier.
15
+
16
+ One can argue that in OOP, if you want to reimplement or extend a method, a
17
+ child class is the only place where you should be doing that anyway.
18
+
19
+ Alpha
20
+ -----
21
+
22
+ This code is very new and despite a pretty comprehensive spec, I'm sure there's
23
+ cases where someone can figure out how to defeat this. So be it. :)
24
+
25
+ This code has been tested on the following systems:
26
+
27
+ * GNU/Linux (Ubuntu 8.04.1) with Ruby 1.8.6
28
+ * FreeBSD 7.0 with Ruby 1.8.6
29
+ * OpenBSD 4.3 with Ruby 1.8.6
30
+ * Mac OS X 10.5 with Ruby 1.8.6
31
+
32
+ Please see the Author section below and report any problems.
33
+
34
+ Motivation
35
+ ----------
36
+
37
+ My motivation for writing something that provides what some may call "evil"
38
+ functionality of closed methods/classes came from my trials of trying to
39
+ improve Rails loading time by reimplementing some ActiveSupport methods in C
40
+ (Ruby extension). I absolutely needed my C versions of certain methods to be
41
+ present, and not clobbered by ActiveSupport.
42
+
43
+ So why didn't I just load my extension after ActiveSupport? Because by then it
44
+ is too late. Rails is already loaded, along with slow running methods that get
45
+ called over 10,000 times. Run the profiler and see for yourself:
46
+
47
+ ::
48
+
49
+ ./script/performance/profiler "require 'config/environment'"
50
+
51
+ Releases
52
+ --------
53
+
54
+ The latest code is in git::
55
+
56
+ * git://github.com/up_the_irons/immutable.git
57
+
58
+ Requirements
59
+ ------------
60
+
61
+ * None
62
+
63
+ Optionals
64
+ ---------
65
+
66
+ * RubyGems 1.2.0 or higher
67
+
68
+ Installation
69
+ ------------
70
+
71
+ git
72
+ ~~~
73
+
74
+ ::
75
+
76
+ git clone git://github.com/up_the_irons/immutable.git
77
+
78
+ Add the path where the repo was cloned on your filesystem to $RUBYLIB, or just
79
+ use the full path when you "require". See "Getting Started" section.
80
+
81
+ RubyGems
82
+ ~~~~~~~~
83
+
84
+ ::
85
+
86
+ gem sources -a http://gems.github.com
87
+ sudo gem install up_the_irons-immutable
88
+
89
+
90
+ Getting Started
91
+ ---------------
92
+
93
+ If you installed ``Immutable`` by cloning the git repo, put the path to the repo in
94
+ $RUBYLIB, then put::
95
+
96
+ require 'lib/immutable'
97
+
98
+ at the top of your programs. Alternatively, you can just require the full path
99
+ to immutable.rb and not mess with $RUBYLIB.
100
+
101
+ If you installed ``Immutable`` from RubyGems, put::
102
+
103
+ require 'rubygems'
104
+ require 'immutable'
105
+
106
+ at the top of your programs.
107
+
108
+ Using
109
+ -----
110
+
111
+ There's not much to say, so let me present a fully working example:
112
+
113
+ ::
114
+
115
+ require 'rubygems'
116
+ require 'immutable'
117
+
118
+ module Foo
119
+ include Immutable
120
+
121
+ def foo
122
+ :foo
123
+ end
124
+
125
+ def bar
126
+ :bar
127
+ end
128
+
129
+ immutable_method :foo, :bar
130
+ end
131
+
132
+ Now methods foo() and bar() cannot be overridden by other code opening Foo and
133
+ reimplementing them. So the following:
134
+
135
+ ::
136
+
137
+ module Foo
138
+ def foo
139
+ :baz
140
+ end
141
+ end
142
+
143
+ Will raise an error:
144
+
145
+ ::
146
+
147
+ Cannot override the immutable method: foo (Immutable::CannotOverrideMethod)
148
+
149
+ There is one option to immutable_method() called :silent. If :silent is true,
150
+ no exception will be raised. One can then do:
151
+
152
+ ::
153
+
154
+ module Foo
155
+ include Immutable
156
+
157
+ def foo
158
+ :foo
159
+ end
160
+
161
+ immutable_method :foo, :silent => true
162
+ end
163
+
164
+ module Foo
165
+ def foo
166
+ :baz
167
+ end
168
+ end
169
+
170
+ include Foo
171
+
172
+ foo # => :foo
173
+
174
+ foo() returns :foo, not :baz. It did not allow itself to be overriden. Using
175
+ :silent can bring a great deal of confusion to other developers wondering why
176
+ their method overrides aren't working. I would consider using :silent bad
177
+ practice in all but very limited cases. Use with extreme caution.
178
+
179
+ There is an alias for immutable_method() called immutable_methods() (plural).
180
+ Use whichever style you prefer.
181
+
182
+ To Do
183
+ -----
184
+
185
+ I finished my TODOs, cool.
186
+
187
+ Author
188
+ ------
189
+
190
+ Garry C. Dolley
191
+
192
+ gdolley [at] NOSPAM- ucla.edu
193
+
194
+ AIM: garry97531
195
+
196
+ IRC: up_the_irons in #git and #caboose on Freenode (and usually many other
197
+ channels)
198
+
199
+ Formatting
200
+ ----------
201
+
202
+ This README is formatted in reStructredText [RST]_. It has the best
203
+ correlation between what a document looks like as plain text vs. its
204
+ formatted output (HTML, LaTeX, etc...). What I like best is, markup doesn't
205
+ look like markup, even though it is.
206
+
207
+ .. [RST] http://docutils.sourceforge.net/rst.html
208
+
209
+ Copyright
210
+ ---------
211
+
212
+ Copyright (c) 2008 Garry C. Dolley
213
+
214
+ Immutable is free software; you can redistribute it and/or modify it under the
215
+ terms of the GNU General Public License as published by the Free Software
216
+ Foundation; either version 2 of the License, or (at your option) any later
217
+ version.
218
+
219
+ Immutable is distributed in the hope that it will be useful, but WITHOUT ANY
220
+ WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
221
+ FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
222
+ details.
223
+
224
+ You should have received a copy of the GNU General Public License along with
225
+ Immutable; if not, write to the Free Software Foundation, Inc., 51 Franklin
226
+ Street, Fifth Floor, Boston, MA 02110-1301, USA
@@ -0,0 +1,11 @@
1
+ spec = Gem::Specification.new do |s|
2
+ s.name = "immutable"
3
+ s.version = "0.3"
4
+ s.authors = ["Garry Dolley", "Lucas de Castro"]
5
+ s.email = "email@dolucas.com"
6
+ s.homepage = "http://github.com/lucasdecastro/immutable"
7
+ s.description = "Declare methods as immutable."
8
+ s.summary = "Declare methods as immutable, somewhat like Java's 'final' keyword but still allowing child classes to override."
9
+ s.files = ['lib/immutable.rb', 'spec/immutable_spec.rb', 'immutable.gemspec', 'README', 'COPYING']
10
+ s.has_rdoc = false
11
+ end
@@ -0,0 +1,74 @@
1
+ module Immutable
2
+ class CannotOverrideMethod < StandardError; end
3
+
4
+ # Random ID changed at each interpreter load
5
+ UNIQ = "_#{object_id.abs}"
6
+
7
+ def self.included(mod)
8
+ mod.extend(ClassMethods)
9
+ end
10
+
11
+ module ClassMethods
12
+ def immutable_method(*args)
13
+ # Initialize variables
14
+ @immutable_methods = [] if @immutable_methods.nil?
15
+ @silent_immutable_methods = [] if @silent_immutable_methods.nil?
16
+ instance_variable_set("@#{UNIQ}_in_method_added", false)
17
+
18
+ opts = args.last.is_a?(Hash) ? args.pop : {}
19
+
20
+ args.each do |method|
21
+ alias_method "#{UNIQ}_old_#{method}", method
22
+ end
23
+
24
+ # Build list of immutable methods
25
+ @immutable_methods += args
26
+ @silent_immutable_methods += args if opts[:silent]
27
+
28
+ @opts = opts
29
+ module_eval do
30
+ def self.method_added(sym)
31
+ if @immutable_methods
32
+ @immutable_methods.each do |method|
33
+ if method && sym == method.to_sym && !in_method_added?
34
+ unless @silent_immutable_methods.include?(method)
35
+ raise CannotOverrideMethod, "Cannot override the immutable method: #{sym}"
36
+ end
37
+
38
+ allow_method_override do
39
+ self.module_eval <<-"end;"
40
+ def #{method}(*args, &block)
41
+ #{UNIQ}_old_#{method}(*args, &block)
42
+ end
43
+ end;
44
+ end
45
+ end
46
+ end # @args.each
47
+ end # @immutable_methods
48
+ end # def self.method_added()
49
+
50
+ def self.method_undefined(sym)
51
+ method_added(sym)
52
+ end
53
+
54
+ def self.method_removed(sym)
55
+ method_added(sym)
56
+ end
57
+ end # module_eval
58
+
59
+ def self.allow_method_override
60
+ instance_variable_set("@#{UNIQ}_in_method_added", true)
61
+ yield
62
+ ensure
63
+ instance_variable_set("@#{UNIQ}_in_method_added", false)
64
+ end
65
+
66
+ def self.in_method_added?
67
+ instance_variable_get("@#{UNIQ}_in_method_added")
68
+ end
69
+ end # def immutable_method()
70
+
71
+ alias immutable_methods immutable_method
72
+
73
+ end # module ClassMethods
74
+ end # module Immutable
@@ -0,0 +1,288 @@
1
+ require 'rubygems'
2
+ require 'spec'
3
+ require 'ruby-debug'
4
+
5
+ require File.join(File.dirname(__FILE__), '..', 'lib', 'immutable')
6
+
7
+ ##################
8
+ # Module version #
9
+ ##################
10
+
11
+ module Foo
12
+ include Immutable
13
+
14
+ def foo
15
+ :fast
16
+ end
17
+
18
+ def bar
19
+ :fast
20
+ end
21
+
22
+ immutable_method :foo, :bar, :silent => true
23
+ end
24
+
25
+ # Other Foo modules we can screw with, so specs don't step on each other
26
+ Foo2 = Foo.clone
27
+ Foo3 = Foo.clone
28
+
29
+ describe "Module Foo" do
30
+ describe "after redefining" do
31
+ it "should not let foo() be redefined" do
32
+ redefine(Foo, :foo)
33
+ test_it(Foo, :foo)
34
+ end
35
+
36
+ it "should not let foo() be redefined even if we try twice" do
37
+ redefine(Foo, :foo)
38
+ redefine(Foo, :foo)
39
+ test_it(Foo, :foo)
40
+ end
41
+
42
+ it "should not let bar() be redefined" do
43
+ redefine(Foo, :bar)
44
+ test_it(Foo, :bar)
45
+ end
46
+
47
+ it "should not let bar() be redefined even if we try twice" do
48
+ redefine(Foo, :bar)
49
+ redefine(Foo, :bar)
50
+ test_it(Foo, :bar)
51
+ end
52
+ end
53
+
54
+ describe "after undefining" do
55
+ it "should not let foo() be undefined" do
56
+ undefine(Foo2, :foo)
57
+ test_it(Foo2, :foo)
58
+ end
59
+
60
+ it "should not let bar() be undefined" do
61
+ undefine(Foo2, :bar)
62
+ test_it(Foo2, :bar)
63
+ end
64
+ end
65
+
66
+ describe "after removing" do
67
+ it "should not let foo() be removed" do
68
+ remove(Foo3, :foo)
69
+ test_it(Foo3, :foo)
70
+ end
71
+
72
+ it "should not let bar() be removed" do
73
+ remove(Foo3, :bar)
74
+ test_it(Foo3, :bar)
75
+ end
76
+ end
77
+ end
78
+
79
+ #################
80
+ # Class version #
81
+ #################
82
+
83
+ class Bar
84
+ include Immutable
85
+
86
+ def foo
87
+ :fast
88
+ end
89
+
90
+ def bar
91
+ :fast
92
+ end
93
+
94
+ immutable_method :foo, :bar, :silent => true
95
+ end
96
+
97
+ # Other Bar modules we can screw with, so specs don't step on each other
98
+ Bar2 = Bar.clone
99
+ Bar3 = Bar.clone
100
+
101
+ class ChildOfBar < Bar
102
+ def foo
103
+ :slow
104
+ end
105
+ end
106
+
107
+ describe "Class Bar" do
108
+ def test_it(klass, method)
109
+ @value = klass.new.send(method)
110
+ @value.should == :fast
111
+ end
112
+
113
+ describe "after redefining" do
114
+ it "should not let foo() be redefined" do
115
+ redefine(Bar, :foo)
116
+ test_it(Bar, :foo)
117
+ end
118
+
119
+ it "should not let foo() be redefined even if we try twice" do
120
+ redefine(Bar, :foo)
121
+ redefine(Bar, :foo)
122
+ test_it(Bar, :foo)
123
+ end
124
+
125
+ it "should not let bar() be redefined" do
126
+ redefine(Bar, :bar)
127
+ test_it(Bar, :bar)
128
+ end
129
+
130
+ it "should not let bar() be redefined even if we try twice" do
131
+ redefine(Bar, :bar)
132
+ redefine(Bar, :bar)
133
+ test_it(Bar, :bar)
134
+ end
135
+ end
136
+
137
+ describe "after undefining" do
138
+ it "should not let foo() be undefined" do
139
+ undefine(Bar2, :foo)
140
+ test_it(Bar2, :foo)
141
+ end
142
+
143
+ it "should not let bar() be undefined" do
144
+ undefine(Bar2, :bar)
145
+ test_it(Bar2, :bar)
146
+ end
147
+ end
148
+
149
+ describe "after removing" do
150
+ it "should not let foo() be removed" do
151
+ remove(Bar3, :foo)
152
+ test_it(Bar3, :foo)
153
+ end
154
+
155
+ it "should not let bar() be removed" do
156
+ remove(Bar3, :bar)
157
+ test_it(Bar3, :bar)
158
+ end
159
+ end
160
+
161
+ describe "child classes" do
162
+ it "should still be able to override method" do
163
+ ChildOfBar.new.foo.should == :slow
164
+ end
165
+ end
166
+ end
167
+
168
+ ##############
169
+ # Exceptions #
170
+ ##############
171
+
172
+ module Boo
173
+ include Immutable
174
+
175
+ def boo
176
+ :fast
177
+ end
178
+
179
+ def boofoo
180
+ :boofoo_fast
181
+ end
182
+
183
+ immutable_method :boofoo, :silent => true
184
+ immutable_method :boo
185
+ end
186
+
187
+ describe "Exceptions" do
188
+ describe "by default" do
189
+ it "should raise exception upon override" do
190
+ lambda do
191
+ redefine(Boo, :boo)
192
+ end.should raise_error(Immutable::CannotOverrideMethod, /Cannot override the immutable method: boo$/)
193
+ end
194
+ end
195
+
196
+ it "should not raise if :silent => true" do
197
+ redefine(Boo, :boofoo)
198
+ test_it(Boo, :boofoo, :boofoo_fast)
199
+ end
200
+ end
201
+
202
+ #########
203
+ # Other #
204
+ #########
205
+
206
+ module Bear
207
+ include Immutable
208
+
209
+ def foo
210
+ :foo_fast
211
+ end
212
+
213
+ def bar
214
+ :bar_fast
215
+ end
216
+
217
+ def baz
218
+ :baz_fast
219
+ end
220
+
221
+ def boo
222
+ :boo_fast
223
+ end
224
+
225
+ # Make sure we can make independent calls to immutable_method
226
+ immutable_method :foo
227
+ immutable_method :bar
228
+ immutable_method :baz, :silent => true
229
+ immutable_method :boo
230
+ end
231
+
232
+ describe "Multiple independent calls to immutable_method()" do
233
+ it "should still recognize foo() is immutable" do
234
+ lambda do
235
+ redefine(Bear, :foo)
236
+ end.should raise_error(Immutable::CannotOverrideMethod, /Cannot override the immutable method: foo$/)
237
+ end
238
+
239
+ it "should still recognize bar() is immutable" do
240
+ lambda do
241
+ redefine(Bear, :bar)
242
+ end.should raise_error(Immutable::CannotOverrideMethod, /Cannot override the immutable method: bar$/)
243
+ end
244
+
245
+ it "should still recognize baz() is immutable" do
246
+ redefine(Bear, :baz)
247
+ test_it(Bear, :baz, :baz_fast)
248
+ end
249
+
250
+ it "should still recognize boo() is immutable" do
251
+ lambda do
252
+ redefine(Bear, :boo)
253
+ end.should raise_error(Immutable::CannotOverrideMethod, /Cannot override the immutable method: boo$/)
254
+ end
255
+ end
256
+
257
+ ##################
258
+ # Helper methods #
259
+ ##################
260
+
261
+ def redefine(mod, method)
262
+ mod.module_eval <<-"end;"
263
+ def #{method.to_s}
264
+ :slow
265
+ end
266
+ end;
267
+ end
268
+
269
+ def undefine(mod, method)
270
+ mod.module_eval do
271
+ undef_method(method)
272
+ end
273
+ end
274
+
275
+ def remove(mod, method)
276
+ mod.module_eval do
277
+ remove_method(method)
278
+ end
279
+ end
280
+
281
+ def test_it(mod, method, value = :fast)
282
+ @value = Object.instance_eval do
283
+ include mod
284
+ send(method)
285
+ end
286
+
287
+ @value.should == value
288
+ end
metadata ADDED
@@ -0,0 +1,58 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: lucasdecastro-immutable
3
+ version: !ruby/object:Gem::Version
4
+ version: "0.3"
5
+ platform: ruby
6
+ authors:
7
+ - Garry Dolley
8
+ - Lucas de Castro
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+
13
+ date: 2009-05-16 00:00:00 -07:00
14
+ default_executable:
15
+ dependencies: []
16
+
17
+ description: Declare methods as immutable.
18
+ email: email@dolucas.com
19
+ executables: []
20
+
21
+ extensions: []
22
+
23
+ extra_rdoc_files: []
24
+
25
+ files:
26
+ - lib/immutable.rb
27
+ - spec/immutable_spec.rb
28
+ - immutable.gemspec
29
+ - README
30
+ - COPYING
31
+ has_rdoc: false
32
+ homepage: http://github.com/lucasdecastro/immutable
33
+ post_install_message:
34
+ rdoc_options: []
35
+
36
+ require_paths:
37
+ - lib
38
+ required_ruby_version: !ruby/object:Gem::Requirement
39
+ requirements:
40
+ - - ">="
41
+ - !ruby/object:Gem::Version
42
+ version: "0"
43
+ version:
44
+ required_rubygems_version: !ruby/object:Gem::Requirement
45
+ requirements:
46
+ - - ">="
47
+ - !ruby/object:Gem::Version
48
+ version: "0"
49
+ version:
50
+ requirements: []
51
+
52
+ rubyforge_project:
53
+ rubygems_version: 1.2.0
54
+ signing_key:
55
+ specification_version: 2
56
+ summary: Declare methods as immutable, somewhat like Java's 'final' keyword but still allowing child classes to override.
57
+ test_files: []
58
+