dsl_maker 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitattributes +1 -0
- data/.gitignore +42 -0
- data/.rspec +4 -0
- data/.travis.yml +20 -0
- data/.yardopts +7 -0
- data/Gemfile +12 -0
- data/LICENSE +340 -0
- data/README.md +321 -0
- data/Rakefile +28 -0
- data/dsl_maker.gemspec +38 -0
- data/lib/dsl/maker.rb +207 -0
- data/lib/dsl/maker/version.rb +6 -0
- data/on_what.rb +15 -0
- data/spec/args_spec.rb +163 -0
- data/spec/error_spec.rb +47 -0
- data/spec/multi_level_spec.rb +158 -0
- data/spec/multiple_invocation_spec.rb +56 -0
- data/spec/single_level_spec.rb +131 -0
- data/spec/spec_helper.rb +31 -0
- metadata +172 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: b6149b9dfdb94cd22dec949a542d68eaf6ab8a58
|
4
|
+
data.tar.gz: 688c84bd9102359e839b2884967c610f6435a726
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: edd7f3990066e812e461e42981cc920517f434d34ceab0801f16dcd8f9ab385828b6faea8732cd7f9f638fa11a3e2e596075253d135b9063c9a1b5431bc08ec3
|
7
|
+
data.tar.gz: cf857c182b8145d4b47dcd8b08e12c3697f60f2ea9a50aed770607112178f40185ce23d0a9086c5147999341b18cbceb10512fa94cc2c0fe22b94435815b8036
|
data/.gitattributes
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
* text=auto
|
data/.gitignore
ADDED
@@ -0,0 +1,42 @@
|
|
1
|
+
# Swapfiles of various kinds
|
2
|
+
*.sw?
|
3
|
+
*~ # Randomness
|
4
|
+
|
5
|
+
Gemfile.lock
|
6
|
+
|
7
|
+
# Everything below here was auto-generated by GitHub
|
8
|
+
*.gem
|
9
|
+
*.rbc
|
10
|
+
/.config
|
11
|
+
/coverage/
|
12
|
+
/InstalledFiles
|
13
|
+
/pkg/
|
14
|
+
/spec/reports/
|
15
|
+
/test/tmp/
|
16
|
+
/test/version_tmp/
|
17
|
+
/tmp/
|
18
|
+
|
19
|
+
## Specific to RubyMotion:
|
20
|
+
.dat*
|
21
|
+
.repl_history
|
22
|
+
build/
|
23
|
+
|
24
|
+
## Documentation cache and generated files:
|
25
|
+
/.yardoc/
|
26
|
+
/_yardoc/
|
27
|
+
/doc/
|
28
|
+
/rdoc/
|
29
|
+
|
30
|
+
## Environment normalisation:
|
31
|
+
/.bundle/
|
32
|
+
/vendor/bundle
|
33
|
+
/lib/bundler/man/
|
34
|
+
|
35
|
+
# for a library or gem, you might want to ignore these files since the code is
|
36
|
+
# intended to run in multiple environments; otherwise, check them in:
|
37
|
+
# Gemfile.lock
|
38
|
+
# .ruby-version
|
39
|
+
# .ruby-gemset
|
40
|
+
|
41
|
+
# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
|
42
|
+
.rvmrc
|
data/.rspec
ADDED
data/.travis.yml
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
language: ruby
|
2
|
+
cache: bundler
|
3
|
+
rvm:
|
4
|
+
- ruby-head
|
5
|
+
- 2.2
|
6
|
+
- 2.1
|
7
|
+
- 2.0.0
|
8
|
+
- 1.9.3
|
9
|
+
- rbx-2
|
10
|
+
matrix:
|
11
|
+
include:
|
12
|
+
- rvm: jruby-head
|
13
|
+
env: JRUBY_OPTS="$JRUBY_OPTS -Xcli.debug=true --debug" # for simplecov
|
14
|
+
- rvm: jruby-21mode
|
15
|
+
env: JRUBY_OPTS="$JRUBY_OPTS -Xcli.debug=true --debug" # for simplecov
|
16
|
+
- rvm: jruby-20mode
|
17
|
+
env: JRUBY_OPTS="$JRUBY_OPTS -Xcli.debug=true --debug" # for simplecov
|
18
|
+
- rvm: jruby-19mode
|
19
|
+
env: JRUBY_OPTS="$JRUBY_OPTS -Xcli.debug=true --debug" # for simplecov
|
20
|
+
fast_finish: true
|
data/.yardopts
ADDED
data/Gemfile
ADDED
@@ -0,0 +1,12 @@
|
|
1
|
+
require File.expand_path('on_what', File.dirname(__FILE__))
|
2
|
+
source 'https://rubygems.org'
|
3
|
+
|
4
|
+
# Travis-only dependencies go here
|
5
|
+
if on_travis? && !on_1_8?
|
6
|
+
group :test do
|
7
|
+
gem 'codecov', '>= 0.0.9', :require => false
|
8
|
+
end
|
9
|
+
end
|
10
|
+
|
11
|
+
# Specify gem's dependencies in dsl_maker.gemspec
|
12
|
+
gemspec
|
data/LICENSE
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., <http://fsf.org/>
|
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.
|
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
|
+
{description}
|
294
|
+
Copyright (C) {year} {fullname}
|
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 along
|
307
|
+
with this program; if not, write to the Free Software Foundation, Inc.,
|
308
|
+
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
309
|
+
|
310
|
+
Also add information on how to contact you by electronic and paper mail.
|
311
|
+
|
312
|
+
If the program is interactive, make it output a short notice like this
|
313
|
+
when it starts in an interactive mode:
|
314
|
+
|
315
|
+
Gnomovision version 69, Copyright (C) year name of author
|
316
|
+
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
317
|
+
This is free software, and you are welcome to redistribute it
|
318
|
+
under certain conditions; type `show c' for details.
|
319
|
+
|
320
|
+
The hypothetical commands `show w' and `show c' should show the appropriate
|
321
|
+
parts of the General Public License. Of course, the commands you use may
|
322
|
+
be called something other than `show w' and `show c'; they could even be
|
323
|
+
mouse-clicks or menu items--whatever suits your program.
|
324
|
+
|
325
|
+
You should also get your employer (if you work as a programmer) or your
|
326
|
+
school, if any, to sign a "copyright disclaimer" for the program, if
|
327
|
+
necessary. Here is a sample; alter the names:
|
328
|
+
|
329
|
+
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
330
|
+
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
331
|
+
|
332
|
+
{signature of Ty Coon}, 1 April 1989
|
333
|
+
Ty Coon, President of Vice
|
334
|
+
|
335
|
+
This General Public License does not permit incorporating your program into
|
336
|
+
proprietary programs. If your program is a subroutine library, you may
|
337
|
+
consider it more useful to permit linking proprietary applications with the
|
338
|
+
library. If this is what you want to do, use the GNU Lesser General
|
339
|
+
Public License instead of this License.
|
340
|
+
|
data/README.md
ADDED
@@ -0,0 +1,321 @@
|
|
1
|
+
# DSL::Maker
|
2
|
+
|
3
|
+
[![Build Status](https://img.shields.io/travis/robkinyon/ruby-dsl-maker.svg)](https://travis-ci.org/robkinyon/ruby-dsl-maker)
|
4
|
+
[![Code Climate](https://img.shields.io/codeclimate/github/robkinyon/ruby-dsl-maker.svg)](https://codeclimate.com/github/robkinyon/ruby-dsl-maker)
|
5
|
+
[![Code Coverage](https://img.shields.io/codecov/c/github/robkinyon/ruby-dsl-maker.svg)](https://codecov.io/github/robkinyon/ruby-dsl-maker)
|
6
|
+
[![Inline docs](http://inch-ci.org/github/robkinyon/ruby-dsl-maker.png)](http://inch-ci.org/github/robkinyon/ruby-dsl-maker)
|
7
|
+
|
8
|
+
|
9
|
+
Writing single-level Ruby-like DSLs is really easy. Ruby practically builds them
|
10
|
+
for you with a little meta-programming. [Docile](https://github.com/ms-ati/docile)
|
11
|
+
makes it ridiculously easy and there are nearly a dozen other modules to do so.
|
12
|
+
|
13
|
+
Unfortunately, writing multi-level DSLs becomes repetitive and overly complex.
|
14
|
+
Which is dumb. Multi-level DSLs are where the sweetness lives. We write DSLs in
|
15
|
+
order to make things simpler for ourselves, particularly when we want to have
|
16
|
+
less-experienced individuals able to make changes because they have the business
|
17
|
+
or domain knowledge. Limiting everything to single-level DSLs makes no sense.
|
18
|
+
|
19
|
+
`DSL::Maker` provides a quasi-DSL-like structure that allows you to easily build
|
20
|
+
multi-level DSLs and handle the output.
|
21
|
+
|
22
|
+
## Usage
|
23
|
+
|
24
|
+
### Single-level DSLs
|
25
|
+
|
26
|
+
In its documentation, [Docile](https://github.com/ms-ati/docile) has a DSL that
|
27
|
+
builds pizza. An example would look like:
|
28
|
+
|
29
|
+
```ruby
|
30
|
+
@sauce_level = :extra
|
31
|
+
|
32
|
+
pizza do
|
33
|
+
cheese
|
34
|
+
pepperoni
|
35
|
+
sauce @sauce_level
|
36
|
+
end
|
37
|
+
#=> #<Pizza:0x00001009dc398 @cheese=true, @pepperoni=true, @bacon=false, @sauce=:extra>
|
38
|
+
```
|
39
|
+
|
40
|
+
The PizzaBuilder code (via Docile) looks like:
|
41
|
+
|
42
|
+
```ruby
|
43
|
+
Pizza = Struct.new(:cheese, :pepperoni, :bacon, :sauce)
|
44
|
+
|
45
|
+
class PizzaBuilder
|
46
|
+
def cheese(v=true); @cheese = v; self; end
|
47
|
+
def pepperoni(v=true); @pepperoni = v; self; end
|
48
|
+
def bacon(v=true); @bacon = v; self; end
|
49
|
+
def sauce(v=nil); @sauce = v; self; end
|
50
|
+
def build
|
51
|
+
Pizza.new(!!@cheese, !!@pepperoni, !!@bacon, @sauce)
|
52
|
+
end
|
53
|
+
end
|
54
|
+
|
55
|
+
PizzaBuilder.new.cheese.pepperoni.sauce(:extra).build
|
56
|
+
#=> #<Pizza:0x00001009dc398 @cheese=true, @pepperoni=true, @bacon=false, @sauce=:extra>
|
57
|
+
```
|
58
|
+
|
59
|
+
But, this doesn't actually implement the DSL. That is left for another snippet:
|
60
|
+
|
61
|
+
``` ruby
|
62
|
+
def pizza(&block)
|
63
|
+
Docile.dsl_eval(PizzaBuilder.new, &block).build
|
64
|
+
end
|
65
|
+
```
|
66
|
+
|
67
|
+
And it's not quite clear where to actually put this code so that you can ship this
|
68
|
+
DSL like Chef or Sinatra.
|
69
|
+
|
70
|
+
You would implement the same DSL using DSL::Maker as so:
|
71
|
+
|
72
|
+
```ruby
|
73
|
+
class PizzaBuilder < DSL::Maker
|
74
|
+
add_entrypoint(:pizza, {
|
75
|
+
:cheese => Boolean,
|
76
|
+
:pepperoni => Boolean,
|
77
|
+
:bacon => Boolean,
|
78
|
+
:sauce => String,
|
79
|
+
}) do
|
80
|
+
Pizza.new(cheese, pepperoni, bacon, sauce)
|
81
|
+
end
|
82
|
+
end
|
83
|
+
|
84
|
+
pizza = PizzaBuilder.parse_dsl(dsl_block)
|
85
|
+
```
|
86
|
+
|
87
|
+
Now, you accept the strings (possibly from `IO.read()`) and magically get the
|
88
|
+
result of your DSL.
|
89
|
+
|
90
|
+
(The PizzaBuilder is used in the test suite in `spec/single_level_spec.rb`.)
|
91
|
+
|
92
|
+
### Multi-level DSLs
|
93
|
+
|
94
|
+
So far, this isn't that impressive - slightly better type coercion and a method
|
95
|
+
for handling the parsing of a string isn't much to crow about.
|
96
|
+
|
97
|
+
```ruby
|
98
|
+
Person = Struct.new(:name, :mother, :father)
|
99
|
+
|
100
|
+
class FamilyTree < DSL::Maker
|
101
|
+
add_entrypoint(:person, {
|
102
|
+
:name => String,
|
103
|
+
:mother => generate_dsl({
|
104
|
+
:name => String,
|
105
|
+
}) do
|
106
|
+
Person.new(name, nil, nil)
|
107
|
+
end,
|
108
|
+
:father => generate_dsl({
|
109
|
+
:name => String,
|
110
|
+
}) do
|
111
|
+
Person.new(name, nil, nil)
|
112
|
+
end,
|
113
|
+
}) do
|
114
|
+
Person.new(name, mother, father)
|
115
|
+
end
|
116
|
+
end
|
117
|
+
|
118
|
+
john_smith = FamilyTree.parse_dsl("
|
119
|
+
person {
|
120
|
+
name 'John Smith'
|
121
|
+
mother {
|
122
|
+
name 'Mary Smith'
|
123
|
+
}
|
124
|
+
father {
|
125
|
+
name 'Tom Smith'
|
126
|
+
}
|
127
|
+
}
|
128
|
+
")
|
129
|
+
```
|
130
|
+
|
131
|
+
Refactor that a bit and we end up with:
|
132
|
+
|
133
|
+
```ruby
|
134
|
+
class FamilyTree < DSL::Maker
|
135
|
+
parent = generate_dsl({
|
136
|
+
:name => String,
|
137
|
+
}) do
|
138
|
+
Person.new(name)
|
139
|
+
end
|
140
|
+
|
141
|
+
add_entrypoint(:person, {
|
142
|
+
:name => String,
|
143
|
+
:mother => parent,
|
144
|
+
:father => parent,
|
145
|
+
}) do
|
146
|
+
Person.new(name, mother, father)
|
147
|
+
end
|
148
|
+
end
|
149
|
+
```
|
150
|
+
|
151
|
+
There's no limit to the number of levels you can go define.
|
152
|
+
|
153
|
+
### Handling Arguments
|
154
|
+
|
155
|
+
We can improve the family tree DSL a bit by handling arguments. An example works
|
156
|
+
best to explain.
|
157
|
+
|
158
|
+
```ruby
|
159
|
+
Person = Struct.new(:name, :age, :mother, :father)
|
160
|
+
class FamilyTree < DSL::Maker
|
161
|
+
parent = generate_dsl({
|
162
|
+
:name => String,
|
163
|
+
:age => String,
|
164
|
+
}) do |*args|
|
165
|
+
default(:name, args)
|
166
|
+
Person.new(name, age)
|
167
|
+
end
|
168
|
+
|
169
|
+
add_entrypoint(:person, {
|
170
|
+
:name => String,
|
171
|
+
:age => String,
|
172
|
+
:mother => parent,
|
173
|
+
:father => parent,
|
174
|
+
}) do |*args|
|
175
|
+
default('name', args, 0)
|
176
|
+
Person.new(name, age, mother, father)
|
177
|
+
end
|
178
|
+
end
|
179
|
+
|
180
|
+
john_smith = FamilyTree.parse_dsl("
|
181
|
+
person 'John Smith' do
|
182
|
+
age 20
|
183
|
+
mother 'Mary Smith' do
|
184
|
+
age 50
|
185
|
+
end
|
186
|
+
father {
|
187
|
+
name 'Tom Smith'
|
188
|
+
age 49
|
189
|
+
}
|
190
|
+
end
|
191
|
+
")
|
192
|
+
```
|
193
|
+
|
194
|
+
The result is exactly the same as before.
|
195
|
+
|
196
|
+
### Handling multiple items
|
197
|
+
|
198
|
+
Chef's recipe files have many entries of different types in them. It doesn't do
|
199
|
+
you any good if you can't do the same thing.
|
200
|
+
|
201
|
+
```ruby
|
202
|
+
Car = Struct.new(:make, :model)
|
203
|
+
Truck = Struct.new(:make, :model)
|
204
|
+
|
205
|
+
class VehicleDSL < DSL::Maker
|
206
|
+
add_entrypoint(:car, {
|
207
|
+
:make => String,
|
208
|
+
:model => String,
|
209
|
+
}) {
|
210
|
+
Car.new(make, model)
|
211
|
+
}
|
212
|
+
|
213
|
+
add_entrypoint(:truck, {
|
214
|
+
:make => String,
|
215
|
+
:model => String,
|
216
|
+
}) {
|
217
|
+
Truck.new(make, model)
|
218
|
+
}
|
219
|
+
end
|
220
|
+
|
221
|
+
vehicles = VehicleDSL.parse_dsl("
|
222
|
+
car {
|
223
|
+
make 'Honda'
|
224
|
+
model 'Civic'
|
225
|
+
}
|
226
|
+
|
227
|
+
truck {
|
228
|
+
make 'Ford'
|
229
|
+
model 'F150'
|
230
|
+
}
|
231
|
+
")
|
232
|
+
```
|
233
|
+
|
234
|
+
`vehicles` is an `Array` with a `Car` and a `Truck` in it, in that order. If your
|
235
|
+
DSL snippet has only one item, you get back that item. If it has multiple items,
|
236
|
+
you get back an `Array` with everything in the right order.
|
237
|
+
|
238
|
+
## API
|
239
|
+
|
240
|
+
### Class Methods
|
241
|
+
|
242
|
+
DSL::Maker provides three class methods - two for constructing your DSL and one
|
243
|
+
for parsing your DSL.
|
244
|
+
|
245
|
+
* `add_entrypoint(Symbol, Hash={}, Block)`
|
246
|
+
|
247
|
+
This is used in defining your DSL class to create an entrypoint - the highest
|
248
|
+
level of your DSL. `add_entrypoint()` will create the right class methods for
|
249
|
+
Docile to use when `parse_dsl()` is called. It will also invoke `generate_dsl()`
|
250
|
+
with the Hash you give it to create the parsing.
|
251
|
+
|
252
|
+
* `generate_dsl(Hash={}, Block)`
|
253
|
+
|
254
|
+
This is used in defining your DSL to describe the innards - the guts that actually
|
255
|
+
have meaning. Once this level has been completed, the Block will be called and the
|
256
|
+
return value provided back to the name.
|
257
|
+
|
258
|
+
* `build_dsl_element(Class, String, Type)`
|
259
|
+
|
260
|
+
This is normally called by `generate_dsl()` to actually construct the DSL element.
|
261
|
+
It is provided for you so that you can create recursive DSL definitions. Look at
|
262
|
+
the tests in `spec/multi_level_spec.rb` for an example of this.
|
263
|
+
|
264
|
+
* `parse_dsl(String)`
|
265
|
+
|
266
|
+
You call this on your DSL class when you're ready to invoke your DSL. It will
|
267
|
+
return whatever the block provided `add_entrypoint()` returns.
|
268
|
+
|
269
|
+
In the case of multiple DSL entrypoints (for example, a normal Chef recipe),
|
270
|
+
`parse_dsl()` will return an array with all the return values in the order of
|
271
|
+
invocation.
|
272
|
+
|
273
|
+
### Coercions
|
274
|
+
|
275
|
+
There are three defined coercions for use within `generate_dsl()`:
|
276
|
+
|
277
|
+
* String - This takes any string.
|
278
|
+
* Boolean - This takes whatever you give it and returns the truthiness of it.
|
279
|
+
* `generate_dsl()` - This descends into another level of DSL.
|
280
|
+
|
281
|
+
You will be able to add your own coercions in a forthcoming version of DSL::Maker.
|
282
|
+
|
283
|
+
### Helpers
|
284
|
+
|
285
|
+
There is one pre-defined helper.
|
286
|
+
|
287
|
+
* `default(String, Array, Integer=0)`
|
288
|
+
|
289
|
+
This takes a method name and the args provided to the block. It then ensures that
|
290
|
+
the method defaults to the value in the args at the optional third argument.
|
291
|
+
|
292
|
+
## Installation
|
293
|
+
|
294
|
+
``` bash
|
295
|
+
$ gem install dsl_maker
|
296
|
+
```
|
297
|
+
|
298
|
+
## Links
|
299
|
+
* [Source](https://github.com/robkinyon/ruby-dsl-maker)
|
300
|
+
* [Documentation](http://rubydoc.info/gems/ruby-dsl-maker)
|
301
|
+
* [Bug Tracker](https://github.com/robkinyon/ruby-dsl-maker/issues)
|
302
|
+
|
303
|
+
## Status
|
304
|
+
|
305
|
+
Works on [all ruby versions since 1.9.3](https://github.com/robkinyon/ruby-dsl-maker/blob/master/.travis.yml), or so Travis CI [tells us](https://travis-ci.org/robkinyon/ruby-dsl-maker).
|
306
|
+
|
307
|
+
## Note on Patches/Pull Requests
|
308
|
+
|
309
|
+
* Fork the project.
|
310
|
+
* Setup your development environment with:
|
311
|
+
`gem install bundler; bundle install`
|
312
|
+
* Make your feature addition or bug fix in a branch.
|
313
|
+
* Add tests for it. This is important so I don't break it in a future version
|
314
|
+
unintentionally. Plus, I maintain 100% code coverage.
|
315
|
+
* Commit.
|
316
|
+
* Send me a pull request.
|
317
|
+
* I will only accept PRs from branches, never master.
|
318
|
+
|
319
|
+
## Copyright & License
|
320
|
+
|
321
|
+
Copyright (c) 2015 Rob Kinyon
|