named-parameters 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.document +5 -0
- data/.gitignore +21 -0
- data/GPL-LICENSE +278 -0
- data/MIT-LICENSE +18 -0
- data/README.md +169 -0
- data/RELEASENOTES +3 -0
- data/Rakefile +45 -0
- data/VERSION +1 -0
- data/lib/named-parameters.rb +2 -0
- data/lib/named-parameters/module.rb +90 -0
- data/lib/named-parameters/object.rb +3 -0
- data/named-parameters.gemspec +61 -0
- data/spec/named-parameters_spec.rb +46 -0
- data/spec/spec.opts +1 -0
- data/spec/spec_helper.rb +9 -0
- metadata +111 -0
data/.document
ADDED
data/.gitignore
ADDED
data/GPL-LICENSE
ADDED
@@ -0,0 +1,278 @@
|
|
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 Lesser 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.
|
data/MIT-LICENSE
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
2
|
+
a copy of this software and associated documentation files (the
|
3
|
+
"Software"), to deal in the Software without restriction, including
|
4
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
5
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
6
|
+
permit persons to whom the Software is furnished to do so, subject to
|
7
|
+
the following conditions:
|
8
|
+
|
9
|
+
The above copyright notice and this permission notice shall be
|
10
|
+
included in all copies or substantial portions of the Software.
|
11
|
+
|
12
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
13
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
14
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
15
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
16
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
17
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
18
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,169 @@
|
|
1
|
+
NamedParameters Gem
|
2
|
+
===================
|
3
|
+
This gem enables/simulates named-parameters in Ruby.
|
4
|
+
|
5
|
+
Installation
|
6
|
+
------------
|
7
|
+
|
8
|
+
gem install named-parameters
|
9
|
+
|
10
|
+
Usage
|
11
|
+
-----
|
12
|
+
To enable it everywhere (recommended):
|
13
|
+
|
14
|
+
require 'named-parameters'
|
15
|
+
|
16
|
+
And all your classes should be able to declare:
|
17
|
+
|
18
|
+
has_named_parameters :method, :optional => [ ... ], :required => [ ... ]
|
19
|
+
|
20
|
+
If you want to be selective about which classes will use it, do:
|
21
|
+
|
22
|
+
require 'named-parameters/module'
|
23
|
+
|
24
|
+
-- then mix-in the `NamedParameters` module into the class of your choice, for
|
25
|
+
example:
|
26
|
+
|
27
|
+
class FooBar
|
28
|
+
include NamedParameters
|
29
|
+
# ...
|
30
|
+
end
|
31
|
+
|
32
|
+
Using the has_named_parameters Method
|
33
|
+
-------------------------------------
|
34
|
+
The `has_named_parameters` method is used to declare that a method accepts a
|
35
|
+
`Hash` argument that should be treated like named-parameters:
|
36
|
+
|
37
|
+
class GoogleStorage
|
38
|
+
has_named_parameters :initialize,
|
39
|
+
:required => [ :'access-key', :'secret-key' ]
|
40
|
+
def initialize opts = { }
|
41
|
+
# ...
|
42
|
+
end
|
43
|
+
|
44
|
+
has_named_parameters :request, :optional => :timeout
|
45
|
+
def request path, opts = { }
|
46
|
+
# ...
|
47
|
+
end
|
48
|
+
end
|
49
|
+
|
50
|
+
Since the `GoogleStorage` class above declares that its initializer requires
|
51
|
+
`:'access-key'` and `:'secret-key'` to be specified, the following
|
52
|
+
invocation will (correctly) raise an `ArgumentError`
|
53
|
+
|
54
|
+
GoogleStorage.new # ArgumentError, GoogleStorage#initialize requires: access-key, secret-key
|
55
|
+
|
56
|
+
On the other-hand, it declares that the `request` method may accept a parameter
|
57
|
+
named `timeout`; so the following invocations will not raise error:
|
58
|
+
|
59
|
+
gs = GoogleStorage.new :'access-key' => '...', :'secret-key' => '...'
|
60
|
+
gs.request '/some/path'
|
61
|
+
gs.request '/some/path', :timeout => '500ms'
|
62
|
+
|
63
|
+
But specifiying an unrecognized parameter, will raise an error:
|
64
|
+
|
65
|
+
gs.request '/some/path', :ssl => true # ArgumentError, GoogleStorage#request unrecognized parameter: ssl
|
66
|
+
|
67
|
+
Optional and Required Parameters
|
68
|
+
--------------------------------
|
69
|
+
Optional and required parameters may be declared in a single
|
70
|
+
`has_named_parameters` declaration:
|
71
|
+
|
72
|
+
has_named_parameters :request, :required => :path, :optional => :timeout
|
73
|
+
|
74
|
+
To specify more than one optional or required parameter, use an `Array`:
|
75
|
+
|
76
|
+
has_named_parameters :request, :required => :path, :optional => [ :timeout, :ssl ]
|
77
|
+
|
78
|
+
How It Works
|
79
|
+
------------
|
80
|
+
The `has_named_parameters` declaration simply looks for the first `Hash`
|
81
|
+
argument when a method that has been declared with `has_named_parameters` is
|
82
|
+
called.
|
83
|
+
|
84
|
+
It does not know the name of the `Hash` parameter for the method. So the
|
85
|
+
following method declarations:
|
86
|
+
|
87
|
+
def service opts = { }
|
88
|
+
# ...
|
89
|
+
end
|
90
|
+
|
91
|
+
def service options = { }
|
92
|
+
# ...
|
93
|
+
end
|
94
|
+
|
95
|
+
def service params
|
96
|
+
# ...
|
97
|
+
end
|
98
|
+
|
99
|
+
-- behave the same way, when the `has_named_parameter` clause is used:
|
100
|
+
|
101
|
+
# the following...
|
102
|
+
has_named_parameters :service, :optional => :timeout
|
103
|
+
def service params
|
104
|
+
# ...
|
105
|
+
end
|
106
|
+
|
107
|
+
# is essentially the same as...
|
108
|
+
has_named_parameters :service, :optional => :timeout
|
109
|
+
def service opts = { }
|
110
|
+
# ...
|
111
|
+
end
|
112
|
+
|
113
|
+
# as well as...
|
114
|
+
has_named_parameters :service, :optional => :timeout
|
115
|
+
def service opts
|
116
|
+
# ...
|
117
|
+
end
|
118
|
+
|
119
|
+
Since when the method is invoked, each one of the above could receive a `Hash`
|
120
|
+
|
121
|
+
service :timeout => '500ms'
|
122
|
+
|
123
|
+
Dependencies
|
124
|
+
------------
|
125
|
+
Development:
|
126
|
+
|
127
|
+
* `yard >= 0`
|
128
|
+
* `rspec >= 1.2.9`
|
129
|
+
|
130
|
+
Download
|
131
|
+
--------
|
132
|
+
You can download this project in either
|
133
|
+
[zip](http://github.com/jurisgalang/named-parameters/zipball/master) or
|
134
|
+
[tar](http://github.com/jurisgalang/named-parameters/tarball/master") formats.
|
135
|
+
|
136
|
+
You can also clone the project with [Git](http://git-scm.com)
|
137
|
+
by running:
|
138
|
+
|
139
|
+
git clone git://github.com/jurisgalang/named-parameters
|
140
|
+
|
141
|
+
Note on Patches/Pull Requests
|
142
|
+
-----------------------------
|
143
|
+
* Fork the project.
|
144
|
+
* Make your feature addition or bug fix.
|
145
|
+
* Add tests for it. This is important so I don't break it in a future version
|
146
|
+
unintentionally.
|
147
|
+
* Commit, do not mess with rakefile, version, or history. (if you want to have
|
148
|
+
your own version, that is fine but bump version in a commit by itself I can
|
149
|
+
ignore when I pull)
|
150
|
+
* Send me a pull request. Bonus points for topic branches.
|
151
|
+
|
152
|
+
Releases
|
153
|
+
--------
|
154
|
+
Please read the `RELEASENOTES` file for the details of each release.
|
155
|
+
|
156
|
+
In general: patch releases will not include breaking changes while releases
|
157
|
+
that bumps the major or minor components of the version string may or may not
|
158
|
+
include breaking changes.
|
159
|
+
|
160
|
+
Author
|
161
|
+
------
|
162
|
+
[Juris Galang](http://github.com/jurisgalang/)
|
163
|
+
|
164
|
+
License
|
165
|
+
-------
|
166
|
+
Dual licensed under the MIT or GPL Version 2 licenses.
|
167
|
+
See the MIT-LICENSE and GPL-LICENSE files for details.
|
168
|
+
|
169
|
+
Copyright (c) 2010 Juris Galang. All Rights Reserved.
|
data/RELEASENOTES
ADDED
data/Rakefile
ADDED
@@ -0,0 +1,45 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
require 'rake'
|
3
|
+
|
4
|
+
begin
|
5
|
+
require 'jeweler'
|
6
|
+
Jeweler::Tasks.new do |gem|
|
7
|
+
gem.name = "named-parameters"
|
8
|
+
gem.summary = %Q{Poor man's named-parameters in Ruby}
|
9
|
+
gem.description = %Q{This gem enables/simulates named-parameters in Ruby}
|
10
|
+
gem.email = "jurisgalang@gmail.com"
|
11
|
+
gem.homepage = "http://github.com/jurisgalang/named-parameters"
|
12
|
+
gem.authors = ["Juris Galang"]
|
13
|
+
gem.add_development_dependency "rspec", ">= 1.2.9"
|
14
|
+
gem.add_development_dependency "yard", ">= 0"
|
15
|
+
# gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
|
16
|
+
end
|
17
|
+
Jeweler::GemcutterTasks.new
|
18
|
+
rescue LoadError
|
19
|
+
puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
|
20
|
+
end
|
21
|
+
|
22
|
+
require 'spec/rake/spectask'
|
23
|
+
Spec::Rake::SpecTask.new(:spec) do |spec|
|
24
|
+
spec.libs << 'lib' << 'spec'
|
25
|
+
spec.spec_files = FileList['spec/**/*_spec.rb']
|
26
|
+
end
|
27
|
+
|
28
|
+
Spec::Rake::SpecTask.new(:rcov) do |spec|
|
29
|
+
spec.libs << 'lib' << 'spec'
|
30
|
+
spec.pattern = 'spec/**/*_spec.rb'
|
31
|
+
spec.rcov = true
|
32
|
+
end
|
33
|
+
|
34
|
+
task :spec => :check_dependencies
|
35
|
+
|
36
|
+
task :default => :spec
|
37
|
+
|
38
|
+
begin
|
39
|
+
require 'yard'
|
40
|
+
YARD::Rake::YardocTask.new
|
41
|
+
rescue LoadError
|
42
|
+
task :yardoc do
|
43
|
+
abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
|
44
|
+
end
|
45
|
+
end
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
0.0.1
|
@@ -0,0 +1,90 @@
|
|
1
|
+
# When mixed-in, this module adds has_named_parameters class method, which
|
2
|
+
# can be used to declare methods that are supposed to accepts named-parameters.
|
3
|
+
#
|
4
|
+
# Sample usage:
|
5
|
+
#
|
6
|
+
# class FooBar
|
7
|
+
# include NamedParameters
|
8
|
+
#
|
9
|
+
# has_named_parameters :initialize, :required => [ :x ]
|
10
|
+
# def initialize opts = { }
|
11
|
+
# ...
|
12
|
+
# end
|
13
|
+
# end
|
14
|
+
#
|
15
|
+
# FooBar.new :x => '...' # instantiates FooBar
|
16
|
+
# FooBar.new :y => '...' # ArgumentError - since :x was not specified
|
17
|
+
#
|
18
|
+
module NamedParameters
|
19
|
+
def self.included base
|
20
|
+
base.extend ClassMethods
|
21
|
+
end
|
22
|
+
|
23
|
+
private
|
24
|
+
def self.validate name, params, spec
|
25
|
+
name = "#{self.class.name}##{name}"
|
26
|
+
spec[:required] ||= []
|
27
|
+
spec[:optional] ||= []
|
28
|
+
|
29
|
+
spec = Hash[ spec.map{ |k, v|
|
30
|
+
v = [ v ] unless v.instance_of? Array
|
31
|
+
[ k, v ]
|
32
|
+
} ]
|
33
|
+
|
34
|
+
sorter = lambda{ |x, y| x.to_s <=> y.to_s }
|
35
|
+
allowed = (spec[:optional] + spec[:required]).sort &sorter
|
36
|
+
keys = params.keys.map{ |k| k.to_sym }
|
37
|
+
|
38
|
+
keys.sort! &sorter
|
39
|
+
spec[:required].sort! &sorter
|
40
|
+
|
41
|
+
list = lambda{ |params| params.join(", ") }
|
42
|
+
|
43
|
+
unless spec[:required].empty?
|
44
|
+
k = spec[:required] & keys
|
45
|
+
raise ArgumentError, \
|
46
|
+
"#{name} requires arguments for parameters: #{list[spec[:required] - k]}" \
|
47
|
+
unless k == spec[:required]
|
48
|
+
end
|
49
|
+
|
50
|
+
k = keys - allowed
|
51
|
+
raise ArgumentError, \
|
52
|
+
"Unrecognized parameter specified on call to #{name}: #{list[k]}" \
|
53
|
+
unless k.empty?
|
54
|
+
end
|
55
|
+
|
56
|
+
module ClassMethods
|
57
|
+
protected
|
58
|
+
def method_added name
|
59
|
+
if specs.include?(name) && !instrumenting?
|
60
|
+
@instrumenting = true
|
61
|
+
method = instance_method(name)
|
62
|
+
spec = specs.delete(name)
|
63
|
+
define_method name do |*args, &block|
|
64
|
+
params = args.find{ |arg| arg.instance_of? Hash }
|
65
|
+
NamedParameters::validate name, params || {}, spec
|
66
|
+
method.bind(self).call(*args, &block)
|
67
|
+
end
|
68
|
+
@instrumenting = false
|
69
|
+
end
|
70
|
+
super
|
71
|
+
end
|
72
|
+
|
73
|
+
def has_named_parameters method, spec = { }
|
74
|
+
specs[method] = spec
|
75
|
+
end
|
76
|
+
|
77
|
+
private
|
78
|
+
def specs
|
79
|
+
@specs ||= { }
|
80
|
+
end
|
81
|
+
|
82
|
+
def instrumenting?
|
83
|
+
@instrumenting
|
84
|
+
end
|
85
|
+
|
86
|
+
def self.extended base
|
87
|
+
base.instance_variable_set :@instrumenting , false
|
88
|
+
end
|
89
|
+
end
|
90
|
+
end
|
@@ -0,0 +1,61 @@
|
|
1
|
+
# Generated by jeweler
|
2
|
+
# DO NOT EDIT THIS FILE DIRECTLY
|
3
|
+
# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
|
4
|
+
# -*- encoding: utf-8 -*-
|
5
|
+
|
6
|
+
Gem::Specification.new do |s|
|
7
|
+
s.name = %q{named-parameters}
|
8
|
+
s.version = "0.0.1"
|
9
|
+
|
10
|
+
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
11
|
+
s.authors = ["Juris Galang"]
|
12
|
+
s.date = %q{2010-11-10}
|
13
|
+
s.description = %q{This gem enables/simulates named-parameters in Ruby}
|
14
|
+
s.email = %q{jurisgalang@gmail.com}
|
15
|
+
s.extra_rdoc_files = [
|
16
|
+
"README.md"
|
17
|
+
]
|
18
|
+
s.files = [
|
19
|
+
".document",
|
20
|
+
".gitignore",
|
21
|
+
"GPL-LICENSE",
|
22
|
+
"MIT-LICENSE",
|
23
|
+
"README.md",
|
24
|
+
"RELEASENOTES",
|
25
|
+
"Rakefile",
|
26
|
+
"VERSION",
|
27
|
+
"lib/named-parameters.rb",
|
28
|
+
"lib/named-parameters/module.rb",
|
29
|
+
"lib/named-parameters/object.rb",
|
30
|
+
"named-parameters.gemspec",
|
31
|
+
"spec/named-parameters_spec.rb",
|
32
|
+
"spec/spec.opts",
|
33
|
+
"spec/spec_helper.rb"
|
34
|
+
]
|
35
|
+
s.homepage = %q{http://github.com/jurisgalang/named-parameters}
|
36
|
+
s.rdoc_options = ["--charset=UTF-8"]
|
37
|
+
s.require_paths = ["lib"]
|
38
|
+
s.rubygems_version = %q{1.3.7}
|
39
|
+
s.summary = %q{Poor man's named-parameters in Ruby}
|
40
|
+
s.test_files = [
|
41
|
+
"spec/named-parameters_spec.rb",
|
42
|
+
"spec/spec_helper.rb"
|
43
|
+
]
|
44
|
+
|
45
|
+
if s.respond_to? :specification_version then
|
46
|
+
current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
|
47
|
+
s.specification_version = 3
|
48
|
+
|
49
|
+
if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
|
50
|
+
s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
|
51
|
+
s.add_development_dependency(%q<yard>, [">= 0"])
|
52
|
+
else
|
53
|
+
s.add_dependency(%q<rspec>, [">= 1.2.9"])
|
54
|
+
s.add_dependency(%q<yard>, [">= 0"])
|
55
|
+
end
|
56
|
+
else
|
57
|
+
s.add_dependency(%q<rspec>, [">= 1.2.9"])
|
58
|
+
s.add_dependency(%q<yard>, [">= 0"])
|
59
|
+
end
|
60
|
+
end
|
61
|
+
|
@@ -0,0 +1,46 @@
|
|
1
|
+
require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
|
2
|
+
|
3
|
+
describe "NamedParameters" do
|
4
|
+
before :all do
|
5
|
+
class FooBar
|
6
|
+
has_named_parameters :initialize, :required => :x, :optional => [ :y, :z ]
|
7
|
+
def initialize(opts = {}); end
|
8
|
+
|
9
|
+
has_named_parameters :method_one, :required => :x, :optional => [ :y, :z ]
|
10
|
+
def method_one(x, y, opts = {}); end
|
11
|
+
|
12
|
+
def method_two(x, y, opts = {}); end
|
13
|
+
end
|
14
|
+
end
|
15
|
+
|
16
|
+
it "should allow declaration of has_named_parameters" do
|
17
|
+
FooBar.should respond_to :has_named_parameters
|
18
|
+
end
|
19
|
+
|
20
|
+
it "should enforce named parameters for constructor" do
|
21
|
+
lambda{ FooBar.new }.should raise_error ArgumentError
|
22
|
+
lambda{ FooBar.new :w => :w }.should raise_error ArgumentError
|
23
|
+
lambda{ FooBar.new :x => :x }.should_not raise_error
|
24
|
+
lambda{ FooBar.new :x => :x, :y => :y }.should_not raise_error
|
25
|
+
lambda{ FooBar.new :x => :x, :y => :y, :z => :z }.should_not raise_error
|
26
|
+
end
|
27
|
+
|
28
|
+
it "should enforce named parameters for instrumented methods" do
|
29
|
+
lambda{ @foobar = FooBar.new :x => :x, :y => :y, :z => :z }.should_not raise_error
|
30
|
+
lambda{ @foobar.method_one :x }.should raise_error ArgumentError
|
31
|
+
lambda{ @foobar.method_one :x, :y }.should raise_error ArgumentError
|
32
|
+
lambda{ @foobar.method_one :x, :y, :x => :x, :y => :y, :z => :z, :w => :w }.should raise_error ArgumentError
|
33
|
+
lambda{ @foobar.method_one :x => :x, :y => :y, :z => :z }.should raise_error ArgumentError
|
34
|
+
lambda{ @foobar.method_one :x, :y, :w => :w }.should raise_error ArgumentError
|
35
|
+
lambda{ @foobar.method_one :x, :y, :x => :x }.should_not raise_error
|
36
|
+
lambda{ @foobar.method_one :x, :y, :x => :x, :y => :y }.should_not raise_error
|
37
|
+
lambda{ @foobar.method_one :x, :y, :x => :x, :y => :y, :z => :z }.should_not raise_error
|
38
|
+
end
|
39
|
+
|
40
|
+
it "should not enforce named parameters for un-instrumented methods" do
|
41
|
+
lambda{ @foobar = FooBar.new :x => :x, :y => :y, :z => :z }.should_not raise_error
|
42
|
+
lambda{ @foobar.method_two :x }.should raise_error ArgumentError
|
43
|
+
lambda{ @foobar.method_two :x, :y }.should_not raise_error ArgumentError
|
44
|
+
lambda{ @foobar.method_two :x, :y, :w => :w }.should_not raise_error ArgumentError
|
45
|
+
end
|
46
|
+
end
|
data/spec/spec.opts
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
--color
|
data/spec/spec_helper.rb
ADDED
metadata
ADDED
@@ -0,0 +1,111 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: named-parameters
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
hash: 29
|
5
|
+
prerelease: false
|
6
|
+
segments:
|
7
|
+
- 0
|
8
|
+
- 0
|
9
|
+
- 1
|
10
|
+
version: 0.0.1
|
11
|
+
platform: ruby
|
12
|
+
authors:
|
13
|
+
- Juris Galang
|
14
|
+
autorequire:
|
15
|
+
bindir: bin
|
16
|
+
cert_chain: []
|
17
|
+
|
18
|
+
date: 2010-11-10 00:00:00 -08:00
|
19
|
+
default_executable:
|
20
|
+
dependencies:
|
21
|
+
- !ruby/object:Gem::Dependency
|
22
|
+
name: rspec
|
23
|
+
prerelease: false
|
24
|
+
requirement: &id001 !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ">="
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
hash: 13
|
30
|
+
segments:
|
31
|
+
- 1
|
32
|
+
- 2
|
33
|
+
- 9
|
34
|
+
version: 1.2.9
|
35
|
+
type: :development
|
36
|
+
version_requirements: *id001
|
37
|
+
- !ruby/object:Gem::Dependency
|
38
|
+
name: yard
|
39
|
+
prerelease: false
|
40
|
+
requirement: &id002 !ruby/object:Gem::Requirement
|
41
|
+
none: false
|
42
|
+
requirements:
|
43
|
+
- - ">="
|
44
|
+
- !ruby/object:Gem::Version
|
45
|
+
hash: 3
|
46
|
+
segments:
|
47
|
+
- 0
|
48
|
+
version: "0"
|
49
|
+
type: :development
|
50
|
+
version_requirements: *id002
|
51
|
+
description: This gem enables/simulates named-parameters in Ruby
|
52
|
+
email: jurisgalang@gmail.com
|
53
|
+
executables: []
|
54
|
+
|
55
|
+
extensions: []
|
56
|
+
|
57
|
+
extra_rdoc_files:
|
58
|
+
- README.md
|
59
|
+
files:
|
60
|
+
- .document
|
61
|
+
- .gitignore
|
62
|
+
- GPL-LICENSE
|
63
|
+
- MIT-LICENSE
|
64
|
+
- README.md
|
65
|
+
- RELEASENOTES
|
66
|
+
- Rakefile
|
67
|
+
- VERSION
|
68
|
+
- lib/named-parameters.rb
|
69
|
+
- lib/named-parameters/module.rb
|
70
|
+
- lib/named-parameters/object.rb
|
71
|
+
- named-parameters.gemspec
|
72
|
+
- spec/named-parameters_spec.rb
|
73
|
+
- spec/spec.opts
|
74
|
+
- spec/spec_helper.rb
|
75
|
+
has_rdoc: true
|
76
|
+
homepage: http://github.com/jurisgalang/named-parameters
|
77
|
+
licenses: []
|
78
|
+
|
79
|
+
post_install_message:
|
80
|
+
rdoc_options:
|
81
|
+
- --charset=UTF-8
|
82
|
+
require_paths:
|
83
|
+
- lib
|
84
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
85
|
+
none: false
|
86
|
+
requirements:
|
87
|
+
- - ">="
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
hash: 3
|
90
|
+
segments:
|
91
|
+
- 0
|
92
|
+
version: "0"
|
93
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
94
|
+
none: false
|
95
|
+
requirements:
|
96
|
+
- - ">="
|
97
|
+
- !ruby/object:Gem::Version
|
98
|
+
hash: 3
|
99
|
+
segments:
|
100
|
+
- 0
|
101
|
+
version: "0"
|
102
|
+
requirements: []
|
103
|
+
|
104
|
+
rubyforge_project:
|
105
|
+
rubygems_version: 1.3.7
|
106
|
+
signing_key:
|
107
|
+
specification_version: 3
|
108
|
+
summary: Poor man's named-parameters in Ruby
|
109
|
+
test_files:
|
110
|
+
- spec/named-parameters_spec.rb
|
111
|
+
- spec/spec_helper.rb
|