fire_and_forget 0.2.0 → 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- data/Gemfile +0 -1
- data/Gemfile.lock +0 -2
- data/README.rdoc +7 -2
- data/bin/fire_forget +0 -3
- data/fire_and_forget.gemspec +3 -22
- data/lib/fire_and_forget/command/fire.rb +1 -1
- data/lib/fire_and_forget/utilities.rb +14 -4
- data/lib/fire_and_forget/version.rb +1 -1
- data/test/test_fire_and_forget.rb +3 -2
- metadata +14 -44
- data/vendor/json-1.5.0/COPYING +0 -58
- data/vendor/json-1.5.0/GPL +0 -340
- data/vendor/json-1.5.0/README +0 -356
- data/vendor/json-1.5.0/README-json-jruby.markdown +0 -33
- data/vendor/json-1.5.0/Rakefile +0 -397
- data/vendor/json-1.5.0/TODO +0 -1
- data/vendor/json-1.5.0/VERSION +0 -1
- data/vendor/json-1.5.0/lib/json/add/core.rb +0 -147
- data/vendor/json-1.5.0/lib/json/add/rails.rb +0 -8
- data/vendor/json-1.5.0/lib/json/common.rb +0 -419
- data/vendor/json-1.5.0/lib/json/editor.rb +0 -1369
- data/vendor/json-1.5.0/lib/json/pure/generator.rb +0 -441
- data/vendor/json-1.5.0/lib/json/pure/parser.rb +0 -320
- data/vendor/json-1.5.0/lib/json/pure.rb +0 -15
- data/vendor/json-1.5.0/lib/json/version.rb +0 -8
- data/vendor/json-1.5.0/lib/json.rb +0 -10
data/vendor/json-1.5.0/GPL
DELETED
@@ -1,340 +0,0 @@
|
|
1
|
-
GNU GENERAL PUBLIC LICENSE
|
2
|
-
Version 2, June 1991
|
3
|
-
|
4
|
-
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
|
5
|
-
59 Temple Place, Suite 330, Boston, MA 02111-1307 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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/vendor/json-1.5.0/README
DELETED
@@ -1,356 +0,0 @@
|
|
1
|
-
== Description
|
2
|
-
|
3
|
-
This is a implementation of the JSON specification according to RFC 4627
|
4
|
-
http://www.ietf.org/rfc/rfc4627.txt . Starting from version 1.0.0 on there
|
5
|
-
will be two variants available:
|
6
|
-
|
7
|
-
* A pure ruby variant, that relies on the iconv and the stringscan
|
8
|
-
extensions, which are both part of the ruby standard library.
|
9
|
-
* The quite a bit faster C extension variant, which is in parts implemented
|
10
|
-
in C and comes with its own unicode conversion functions and a parser
|
11
|
-
generated by the ragel state machine compiler
|
12
|
-
http://www.cs.queensu.ca/~thurston/ragel .
|
13
|
-
|
14
|
-
Both variants of the JSON generator generate UTF-8 character sequences by
|
15
|
-
default. If an :ascii_only option with a true value is given, they escape all
|
16
|
-
non-ASCII and control characters with \uXXXX escape sequences, and support
|
17
|
-
UTF-16 surrogate pairs in order to be able to generate the whole range of
|
18
|
-
unicode code points.
|
19
|
-
|
20
|
-
All strings, that are to be encoded as JSON strings, should be UTF-8 byte
|
21
|
-
sequences on the Ruby side. To encode raw binary strings, that aren't UTF-8
|
22
|
-
encoded, please use the to_json_raw_object method of String (which produces
|
23
|
-
an object, that contains a byte array) and decode the result on the receiving
|
24
|
-
endpoint.
|
25
|
-
|
26
|
-
The JSON parsers can parse UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE
|
27
|
-
JSON documents under Ruby 1.8. Under Ruby 1.9 they take advantage of Ruby's
|
28
|
-
M17n features and can parse all documents which have the correct
|
29
|
-
String#encoding set. If a document string has ASCII-8BIT as an encoding the
|
30
|
-
parser attempts to figure out which of the UTF encodings from above it is and
|
31
|
-
trys to parse it.
|
32
|
-
|
33
|
-
== Installation
|
34
|
-
|
35
|
-
It's recommended to use the extension variant of JSON, because it's faster than
|
36
|
-
the pure ruby variant. If you cannot build it on your system, you can settle
|
37
|
-
for the latter.
|
38
|
-
|
39
|
-
Just type into the command line as root:
|
40
|
-
|
41
|
-
# rake install
|
42
|
-
|
43
|
-
The above command will build the extensions and install them on your system.
|
44
|
-
|
45
|
-
# rake install_pure
|
46
|
-
|
47
|
-
or
|
48
|
-
|
49
|
-
# ruby install.rb
|
50
|
-
|
51
|
-
will just install the pure ruby implementation of JSON.
|
52
|
-
|
53
|
-
If you use Rubygems you can type
|
54
|
-
|
55
|
-
# gem install json
|
56
|
-
|
57
|
-
instead, to install the newest JSON version.
|
58
|
-
|
59
|
-
There is also a pure ruby json only variant of the gem, that can be installed
|
60
|
-
with:
|
61
|
-
|
62
|
-
# gem install json_pure
|
63
|
-
|
64
|
-
== Compiling the extensions yourself
|
65
|
-
|
66
|
-
If you want to build the extensions yourself you need rake:
|
67
|
-
|
68
|
-
You can get it from rubyforge:
|
69
|
-
http://rubyforge.org/projects/rake
|
70
|
-
|
71
|
-
or just type
|
72
|
-
|
73
|
-
# gem install rake
|
74
|
-
|
75
|
-
for the installation via rubygems.
|
76
|
-
|
77
|
-
If you want to create the parser.c file from its parser.rl file or draw nice
|
78
|
-
graphviz images of the state machines, you need ragel from: http://www.cs.queensu.ca/~thurston/ragel
|
79
|
-
|
80
|
-
|
81
|
-
== Usage
|
82
|
-
|
83
|
-
To use JSON you can
|
84
|
-
require 'json'
|
85
|
-
to load the installed variant (either the extension 'json' or the pure
|
86
|
-
variant 'json_pure'). If you have installed the extension variant, you can
|
87
|
-
pick either the extension variant or the pure variant by typing
|
88
|
-
require 'json/ext'
|
89
|
-
or
|
90
|
-
require 'json/pure'
|
91
|
-
|
92
|
-
Now you can parse a JSON document into a ruby data structure by calling
|
93
|
-
|
94
|
-
JSON.parse(document)
|
95
|
-
|
96
|
-
If you want to generate a JSON document from a ruby data structure call
|
97
|
-
JSON.generate(data)
|
98
|
-
|
99
|
-
You can also use the pretty_generate method (which formats the output more
|
100
|
-
verbosely and nicely) or fast_generate (which doesn't do any of the security
|
101
|
-
checks generate performs, e. g. nesting deepness checks).
|
102
|
-
|
103
|
-
To create a valid JSON document you have to make sure, that the output is
|
104
|
-
embedded in either a JSON array [] or a JSON object {}. The easiest way to do
|
105
|
-
this, is by putting your values in a Ruby Array or Hash instance.
|
106
|
-
|
107
|
-
There are also the JSON and JSON[] methods which use parse on a String or
|
108
|
-
generate a JSON document from an array or hash:
|
109
|
-
|
110
|
-
document = JSON 'test' => 23 # => "{\"test\":23}"
|
111
|
-
document = JSON['test'] => 23 # => "{\"test\":23}"
|
112
|
-
|
113
|
-
and
|
114
|
-
|
115
|
-
data = JSON '{"test":23}' # => {"test"=>23}
|
116
|
-
data = JSON['{"test":23}'] # => {"test"=>23}
|
117
|
-
|
118
|
-
You can choose to load a set of common additions to ruby core's objects if
|
119
|
-
you
|
120
|
-
require 'json/add/core'
|
121
|
-
|
122
|
-
After requiring this you can, e. g., serialise/deserialise Ruby ranges:
|
123
|
-
|
124
|
-
JSON JSON(1..10) # => 1..10
|
125
|
-
|
126
|
-
To find out how to add JSON support to other or your own classes, read the
|
127
|
-
section "More Examples" below.
|
128
|
-
|
129
|
-
To get the best compatibility to rails' JSON implementation, you can
|
130
|
-
require 'json/add/rails'
|
131
|
-
|
132
|
-
Both of the additions attempt to require 'json' (like above) first, if it has
|
133
|
-
not been required yet.
|
134
|
-
|
135
|
-
== More Examples
|
136
|
-
|
137
|
-
To create a JSON document from a ruby data structure, you can call
|
138
|
-
JSON.generate like that:
|
139
|
-
|
140
|
-
json = JSON.generate [1, 2, {"a"=>3.141}, false, true, nil, 4..10]
|
141
|
-
# => "[1,2,{\"a\":3.141},false,true,null,\"4..10\"]"
|
142
|
-
|
143
|
-
To get back a ruby data structure from a JSON document, you have to call
|
144
|
-
JSON.parse on it:
|
145
|
-
|
146
|
-
JSON.parse json
|
147
|
-
# => [1, 2, {"a"=>3.141}, false, true, nil, "4..10"]
|
148
|
-
|
149
|
-
Note, that the range from the original data structure is a simple
|
150
|
-
string now. The reason for this is, that JSON doesn't support ranges
|
151
|
-
or arbitrary classes. In this case the json library falls back to call
|
152
|
-
Object#to_json, which is the same as #to_s.to_json.
|
153
|
-
|
154
|
-
It's possible to add JSON support serialization to arbitrary classes by
|
155
|
-
simply implementing a more specialized version of the #to_json method, that
|
156
|
-
should return a JSON object (a hash converted to JSON with #to_json) like
|
157
|
-
this (don't forget the *a for all the arguments):
|
158
|
-
|
159
|
-
class Range
|
160
|
-
def to_json(*a)
|
161
|
-
{
|
162
|
-
'json_class' => self.class.name, # = 'Range'
|
163
|
-
'data' => [ first, last, exclude_end? ]
|
164
|
-
}.to_json(*a)
|
165
|
-
end
|
166
|
-
end
|
167
|
-
|
168
|
-
The hash key 'json_class' is the class, that will be asked to deserialise the
|
169
|
-
JSON representation later. In this case it's 'Range', but any namespace of
|
170
|
-
the form 'A::B' or '::A::B' will do. All other keys are arbitrary and can be
|
171
|
-
used to store the necessary data to configure the object to be deserialised.
|
172
|
-
|
173
|
-
If a the key 'json_class' is found in a JSON object, the JSON parser checks
|
174
|
-
if the given class responds to the json_create class method. If so, it is
|
175
|
-
called with the JSON object converted to a Ruby hash. So a range can
|
176
|
-
be deserialised by implementing Range.json_create like this:
|
177
|
-
|
178
|
-
class Range
|
179
|
-
def self.json_create(o)
|
180
|
-
new(*o['data'])
|
181
|
-
end
|
182
|
-
end
|
183
|
-
|
184
|
-
Now it possible to serialise/deserialise ranges as well:
|
185
|
-
|
186
|
-
json = JSON.generate [1, 2, {"a"=>3.141}, false, true, nil, 4..10]
|
187
|
-
# => "[1,2,{\"a\":3.141},false,true,null,{\"json_class\":\"Range\",\"data\":[4,10,false]}]"
|
188
|
-
JSON.parse json
|
189
|
-
# => [1, 2, {"a"=>3.141}, false, true, nil, 4..10]
|
190
|
-
|
191
|
-
JSON.generate always creates the shortest possible string representation of a
|
192
|
-
ruby data structure in one line. This is good for data storage or network
|
193
|
-
protocols, but not so good for humans to read. Fortunately there's also
|
194
|
-
JSON.pretty_generate (or JSON.pretty_generate) that creates a more readable
|
195
|
-
output:
|
196
|
-
|
197
|
-
puts JSON.pretty_generate([1, 2, {"a"=>3.141}, false, true, nil, 4..10])
|
198
|
-
[
|
199
|
-
1,
|
200
|
-
2,
|
201
|
-
{
|
202
|
-
"a": 3.141
|
203
|
-
},
|
204
|
-
false,
|
205
|
-
true,
|
206
|
-
null,
|
207
|
-
{
|
208
|
-
"json_class": "Range",
|
209
|
-
"data": [
|
210
|
-
4,
|
211
|
-
10,
|
212
|
-
false
|
213
|
-
]
|
214
|
-
}
|
215
|
-
]
|
216
|
-
|
217
|
-
There are also the methods Kernel#j for generate, and Kernel#jj for
|
218
|
-
pretty_generate output to the console, that work analogous to Core Ruby's p and
|
219
|
-
the pp library's pp methods.
|
220
|
-
|
221
|
-
The script tools/server.rb contains a small example if you want to test, how
|
222
|
-
receiving a JSON object from a webrick server in your browser with the
|
223
|
-
javasript prototype library http://www.prototypejs.org works.
|
224
|
-
|
225
|
-
== Speed Comparisons
|
226
|
-
|
227
|
-
I have created some benchmark results (see the benchmarks/data-p4-3Ghz
|
228
|
-
subdir of the package) for the JSON-parser to estimate the speed up in the C
|
229
|
-
extension:
|
230
|
-
|
231
|
-
Comparing times (call_time_mean):
|
232
|
-
1 ParserBenchmarkExt#parser 900 repeats:
|
233
|
-
553.922304770 ( real) -> 21.500x
|
234
|
-
0.001805307
|
235
|
-
2 ParserBenchmarkYAML#parser 1000 repeats:
|
236
|
-
224.513358139 ( real) -> 8.714x
|
237
|
-
0.004454078
|
238
|
-
3 ParserBenchmarkPure#parser 1000 repeats:
|
239
|
-
26.755020642 ( real) -> 1.038x
|
240
|
-
0.037376163
|
241
|
-
4 ParserBenchmarkRails#parser 1000 repeats:
|
242
|
-
25.763381731 ( real) -> 1.000x
|
243
|
-
0.038814780
|
244
|
-
calls/sec ( time) -> speed covers
|
245
|
-
secs/call
|
246
|
-
|
247
|
-
In the table above 1 is JSON::Ext::Parser, 2 is YAML.load with YAML
|
248
|
-
compatbile JSON document, 3 is is JSON::Pure::Parser, and 4 is
|
249
|
-
ActiveSupport::JSON.decode. The ActiveSupport JSON-decoder converts the
|
250
|
-
input first to YAML and then uses the YAML-parser, the conversion seems to
|
251
|
-
slow it down so much that it is only as fast as the JSON::Pure::Parser!
|
252
|
-
|
253
|
-
If you look at the benchmark data you can see that this is mostly caused by
|
254
|
-
the frequent high outliers - the median of the Rails-parser runs is still
|
255
|
-
overall smaller than the median of the JSON::Pure::Parser runs:
|
256
|
-
|
257
|
-
Comparing times (call_time_median):
|
258
|
-
1 ParserBenchmarkExt#parser 900 repeats:
|
259
|
-
800.592479481 ( real) -> 26.936x
|
260
|
-
0.001249075
|
261
|
-
2 ParserBenchmarkYAML#parser 1000 repeats:
|
262
|
-
271.002390644 ( real) -> 9.118x
|
263
|
-
0.003690004
|
264
|
-
3 ParserBenchmarkRails#parser 1000 repeats:
|
265
|
-
30.227910865 ( real) -> 1.017x
|
266
|
-
0.033082008
|
267
|
-
4 ParserBenchmarkPure#parser 1000 repeats:
|
268
|
-
29.722384421 ( real) -> 1.000x
|
269
|
-
0.033644676
|
270
|
-
calls/sec ( time) -> speed covers
|
271
|
-
secs/call
|
272
|
-
|
273
|
-
I have benchmarked the JSON-Generator as well. This generated a few more
|
274
|
-
values, because there are different modes that also influence the achieved
|
275
|
-
speed:
|
276
|
-
|
277
|
-
Comparing times (call_time_mean):
|
278
|
-
1 GeneratorBenchmarkExt#generator_fast 1000 repeats:
|
279
|
-
547.354332608 ( real) -> 15.090x
|
280
|
-
0.001826970
|
281
|
-
2 GeneratorBenchmarkExt#generator_safe 1000 repeats:
|
282
|
-
443.968212317 ( real) -> 12.240x
|
283
|
-
0.002252414
|
284
|
-
3 GeneratorBenchmarkExt#generator_pretty 900 repeats:
|
285
|
-
375.104545883 ( real) -> 10.341x
|
286
|
-
0.002665923
|
287
|
-
4 GeneratorBenchmarkPure#generator_fast 1000 repeats:
|
288
|
-
49.978706968 ( real) -> 1.378x
|
289
|
-
0.020008521
|
290
|
-
5 GeneratorBenchmarkRails#generator 1000 repeats:
|
291
|
-
38.531868759 ( real) -> 1.062x
|
292
|
-
0.025952543
|
293
|
-
6 GeneratorBenchmarkPure#generator_safe 1000 repeats:
|
294
|
-
36.927649925 ( real) -> 1.018x 7 (>=3859)
|
295
|
-
0.027079979
|
296
|
-
7 GeneratorBenchmarkPure#generator_pretty 1000 repeats:
|
297
|
-
36.272134441 ( real) -> 1.000x 6 (>=3859)
|
298
|
-
0.027569373
|
299
|
-
calls/sec ( time) -> speed covers
|
300
|
-
secs/call
|
301
|
-
|
302
|
-
In the table above 1-3 are JSON::Ext::Generator methods. 4, 6, and 7 are
|
303
|
-
JSON::Pure::Generator methods and 5 is the Rails JSON generator. It is now a
|
304
|
-
bit faster than the generator_safe and generator_pretty methods of the pure
|
305
|
-
variant but slower than the others.
|
306
|
-
|
307
|
-
To achieve the fastest JSON document output, you can use the fast_generate
|
308
|
-
method. Beware, that this will disable the checking for circular Ruby data
|
309
|
-
structures, which may cause JSON to go into an infinite loop.
|
310
|
-
|
311
|
-
Here are the median comparisons for completeness' sake:
|
312
|
-
|
313
|
-
Comparing times (call_time_median):
|
314
|
-
1 GeneratorBenchmarkExt#generator_fast 1000 repeats:
|
315
|
-
708.258020939 ( real) -> 16.547x
|
316
|
-
0.001411915
|
317
|
-
2 GeneratorBenchmarkExt#generator_safe 1000 repeats:
|
318
|
-
569.105020353 ( real) -> 13.296x
|
319
|
-
0.001757145
|
320
|
-
3 GeneratorBenchmarkExt#generator_pretty 900 repeats:
|
321
|
-
482.825371244 ( real) -> 11.280x
|
322
|
-
0.002071142
|
323
|
-
4 GeneratorBenchmarkPure#generator_fast 1000 repeats:
|
324
|
-
62.717626652 ( real) -> 1.465x
|
325
|
-
0.015944481
|
326
|
-
5 GeneratorBenchmarkRails#generator 1000 repeats:
|
327
|
-
43.965681162 ( real) -> 1.027x
|
328
|
-
0.022745013
|
329
|
-
6 GeneratorBenchmarkPure#generator_safe 1000 repeats:
|
330
|
-
43.929073409 ( real) -> 1.026x 7 (>=3859)
|
331
|
-
0.022763968
|
332
|
-
7 GeneratorBenchmarkPure#generator_pretty 1000 repeats:
|
333
|
-
42.802514491 ( real) -> 1.000x 6 (>=3859)
|
334
|
-
0.023363113
|
335
|
-
calls/sec ( time) -> speed covers
|
336
|
-
secs/call
|
337
|
-
|
338
|
-
== Author
|
339
|
-
|
340
|
-
Florian Frank <mailto:flori@ping.de>
|
341
|
-
|
342
|
-
== License
|
343
|
-
|
344
|
-
Ruby License, see the COPYING file included in the source distribution. The
|
345
|
-
Ruby License includes the GNU General Public License (GPL), Version 2, so see
|
346
|
-
the file GPL as well.
|
347
|
-
|
348
|
-
== Download
|
349
|
-
|
350
|
-
The latest version of this library can be downloaded at
|
351
|
-
|
352
|
-
* http://rubyforge.org/frs?group_id=953
|
353
|
-
|
354
|
-
Online Documentation should be located at
|
355
|
-
|
356
|
-
* http://json.rubyforge.org
|