patrickod-raspell 1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/CHANGELOG ADDED
@@ -0,0 +1,6 @@
1
+
2
+ v1.1. Would be nice if it actually compiled again.
3
+
4
+ v1.0. Documentation.
5
+
6
+ v0.3. Fix OS X compilation problem; Rubyforge release.
data/LICENSE ADDED
@@ -0,0 +1,342 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+
3
+ Version 2, June 1991
4
+
5
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
6
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
7
+
8
+ Everyone is permitted to copy and distribute verbatim copies
9
+ of this license document, but changing it is not allowed.
10
+
11
+ == Preamble
12
+
13
+ The licenses for most software are designed to take away your
14
+ freedom to share and change it. By contrast, the GNU General Public
15
+ License is intended to guarantee your freedom to share and change free
16
+ software--to make sure the software is free for all its users. This
17
+ General Public License applies to most of the Free Software
18
+ Foundation's software and to any other program whose authors commit to
19
+ using it. (Some other Free Software Foundation software is covered by
20
+ the GNU Lesser General Public License instead.) You can apply it to
21
+ your programs, too.
22
+
23
+ When we speak of free software, we are referring to freedom, not
24
+ price. Our General Public Licenses are designed to make sure that you
25
+ have the freedom to distribute copies of free software (and charge for
26
+ this service if you wish), that you receive source code or can get it
27
+ if you want it, that you can change the software or use pieces of it
28
+ in new free programs; and that you know you can do these things.
29
+
30
+ To protect your rights, we need to make restrictions that forbid
31
+ anyone to deny you these rights or to ask you to surrender the rights.
32
+ These restrictions translate to certain responsibilities for you if you
33
+ distribute copies of the software, or if you modify it.
34
+
35
+ For example, if you distribute copies of such a program, whether
36
+ gratis or for a fee, you must give the recipients all the rights that
37
+ you have. You must make sure that they, too, receive or can get the
38
+ source code. And you must show them these terms so they know their
39
+ rights.
40
+
41
+ We protect your rights with two steps: (1) copyright the software, and
42
+ (2) offer you this license which gives you legal permission to copy,
43
+ distribute and/or modify the software.
44
+
45
+ Also, for each author's protection and ours, we want to make certain
46
+ that everyone understands that there is no warranty for this free
47
+ software. If the software is modified by someone else and passed on, we
48
+ want its recipients to know that what they have is not the original, so
49
+ that any problems introduced by others will not reflect on the original
50
+ authors' reputations.
51
+
52
+ Finally, any free program is threatened constantly by software
53
+ patents. We wish to avoid the danger that redistributors of a free
54
+ program will individually obtain patent licenses, in effect making the
55
+ program proprietary. To prevent this, we have made it clear that any
56
+ patent must be licensed for everyone's free use or not licensed at all.
57
+
58
+ The precise terms and conditions for copying, distribution and
59
+ modification follow.
60
+
61
+ == GNU GENERAL PUBLIC LICENSE
62
+
63
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
64
+
65
+ 0. This License applies to any program or other work which contains
66
+ a notice placed by the copyright holder saying it may be distributed
67
+ under the terms of this General Public License. The "Program", below,
68
+ refers to any such program or work, and a "work based on the Program"
69
+ means either the Program or any derivative work under copyright law:
70
+ that is to say, a work containing the Program or a portion of it,
71
+ either verbatim or with modifications and/or translated into another
72
+ language. (Hereinafter, translation is included without limitation in
73
+ the term "modification".) Each licensee is addressed as "you".
74
+
75
+ Activities other than copying, distribution and modification are not
76
+ covered by this License; they are outside its scope. The act of
77
+ running the Program is not restricted, and the output from the Program
78
+ is covered only if its contents constitute a work based on the
79
+ Program (independent of having been made by running the Program).
80
+ Whether that is true depends on what the Program does.
81
+
82
+ 1. You may copy and distribute verbatim copies of the Program's
83
+ source code as you receive it, in any medium, provided that you
84
+ conspicuously and appropriately publish on each copy an appropriate
85
+ copyright notice and disclaimer of warranty; keep intact all the
86
+ notices that refer to this License and to the absence of any warranty;
87
+ and give any other recipients of the Program a copy of this License
88
+ along with the Program.
89
+
90
+ You may charge a fee for the physical act of transferring a copy, and
91
+ you may at your option offer warranty protection in exchange for a fee.
92
+
93
+ 2. You may modify your copy or copies of the Program or any portion
94
+ of it, thus forming a work based on the Program, and copy and
95
+ distribute such modifications or work under the terms of Section 1
96
+ above, provided that you also meet all of these conditions:
97
+
98
+ a) You must cause the modified files to carry prominent notices
99
+ stating that you changed the files and the date of any change.
100
+
101
+ b) You must cause any work that you distribute or publish, that in
102
+ whole or in part contains or is derived from the Program or any
103
+ part thereof, to be licensed as a whole at no charge to all third
104
+ parties under the terms of this License.
105
+
106
+ c) If the modified program normally reads commands interactively
107
+ when run, you must cause it, when started running for such
108
+ interactive use in the most ordinary way, to print or display an
109
+ announcement including an appropriate copyright notice and a
110
+ notice that there is no warranty (or else, saying that you provide
111
+ a warranty) and that users may redistribute the program under
112
+ these conditions, and telling the user how to view a copy of this
113
+ License. (Exception: if the Program itself is interactive but
114
+ does not normally print such an announcement, your work based on
115
+ the Program is not required to print an announcement.)
116
+
117
+ These requirements apply to the modified work as a whole. If
118
+ identifiable sections of that work are not derived from the Program,
119
+ and can be reasonably considered independent and separate works in
120
+ themselves, then this License, and its terms, do not apply to those
121
+ sections when you distribute them as separate works. But when you
122
+ distribute the same sections as part of a whole which is a work based
123
+ on the Program, the distribution of the whole must be on the terms of
124
+ this License, whose permissions for other licensees extend to the
125
+ entire whole, and thus to each and every part regardless of who wrote it.
126
+
127
+ Thus, it is not the intent of this section to claim rights or contest
128
+ your rights to work written entirely by you; rather, the intent is to
129
+ exercise the right to control the distribution of derivative or
130
+ collective works based on the Program.
131
+
132
+ In addition, mere aggregation of another work not based on the Program
133
+ with the Program (or with a work based on the Program) on a volume of
134
+ a storage or distribution medium does not bring the other work under
135
+ the scope of this License.
136
+
137
+ 3. You may copy and distribute the Program (or a work based on it,
138
+ under Section 2) in object code or executable form under the terms of
139
+ Sections 1 and 2 above provided that you also do one of the following:
140
+
141
+ a) Accompany it with the complete corresponding machine-readable
142
+ source code, which must be distributed under the terms of Sections
143
+ 1 and 2 above on a medium customarily used for software interchange; or,
144
+
145
+ b) Accompany it with a written offer, valid for at least three
146
+ years, to give any third party, for a charge no more than your
147
+ cost of physically performing source distribution, a complete
148
+ machine-readable copy of the corresponding source code, to be
149
+ distributed under the terms of Sections 1 and 2 above on a medium
150
+ customarily used for software interchange; or,
151
+
152
+ c) Accompany it with the information you received as to the offer
153
+ to distribute corresponding source code. (This alternative is
154
+ allowed only for noncommercial distribution and only if you
155
+ received the program in object code or executable form with such
156
+ an offer, in accord with Subsection b above.)
157
+
158
+ The source code for a work means the preferred form of the work for
159
+ making modifications to it. For an executable work, complete source
160
+ code means all the source code for all modules it contains, plus any
161
+ associated interface definition files, plus the scripts used to
162
+ control compilation and installation of the executable. However, as a
163
+ special exception, the source code distributed need not include
164
+ anything that is normally distributed (in either source or binary
165
+ form) with the major components (compiler, kernel, and so on) of the
166
+ operating system on which the executable runs, unless that component
167
+ itself accompanies the executable.
168
+
169
+ If distribution of executable or object code is made by offering
170
+ access to copy from a designated place, then offering equivalent
171
+ access to copy the source code from the same place counts as
172
+ distribution of the source code, even though third parties are not
173
+ compelled to copy the source along with the object code.
174
+
175
+ 4. You may not copy, modify, sublicense, or distribute the Program
176
+ except as expressly provided under this License. Any attempt
177
+ otherwise to copy, modify, sublicense or distribute the Program is
178
+ void, and will automatically terminate your rights under this License.
179
+ However, parties who have received copies, or rights, from you under
180
+ this License will not have their licenses terminated so long as such
181
+ parties remain in full compliance.
182
+
183
+ 5. You are not required to accept this License, since you have not
184
+ signed it. However, nothing else grants you permission to modify or
185
+ distribute the Program or its derivative works. These actions are
186
+ prohibited by law if you do not accept this License. Therefore, by
187
+ modifying or distributing the Program (or any work based on the
188
+ Program), you indicate your acceptance of this License to do so, and
189
+ all its terms and conditions for copying, distributing or modifying
190
+ the Program or works based on it.
191
+
192
+ 6. Each time you redistribute the Program (or any work based on the
193
+ Program), the recipient automatically receives a license from the
194
+ original licensor to copy, distribute or modify the Program subject to
195
+ these terms and conditions. You may not impose any further
196
+ restrictions on the recipients' exercise of the rights granted herein.
197
+ You are not responsible for enforcing compliance by third parties to
198
+ this License.
199
+
200
+ 7. If, as a consequence of a court judgment or allegation of patent
201
+ infringement or for any other reason (not limited to patent issues),
202
+ conditions are imposed on you (whether by court order, agreement or
203
+ otherwise) that contradict the conditions of this License, they do not
204
+ excuse you from the conditions of this License. If you cannot
205
+ distribute so as to satisfy simultaneously your obligations under this
206
+ License and any other pertinent obligations, then as a consequence you
207
+ may not distribute the Program at all. For example, if a patent
208
+ license would not permit royalty-free redistribution of the Program by
209
+ all those who receive copies directly or indirectly through you, then
210
+ the only way you could satisfy both it and this License would be to
211
+ refrain entirely from distribution of the Program.
212
+
213
+ If any portion of this section is held invalid or unenforceable under
214
+ any particular circumstance, the balance of the section is intended to
215
+ apply and the section as a whole is intended to apply in other
216
+ circumstances.
217
+
218
+ It is not the purpose of this section to induce you to infringe any
219
+ patents or other property right claims or to contest validity of any
220
+ such claims; this section has the sole purpose of protecting the
221
+ integrity of the free software distribution system, which is
222
+ implemented by public license practices. Many people have made
223
+ generous contributions to the wide range of software distributed
224
+ through that system in reliance on consistent application of that
225
+ system; it is up to the author/donor to decide if he or she is willing
226
+ to distribute software through any other system and a licensee cannot
227
+ impose that choice.
228
+
229
+ This section is intended to make thoroughly clear what is believed to
230
+ be a consequence of the rest of this License.
231
+
232
+ 8. If the distribution and/or use of the Program is restricted in
233
+ certain countries either by patents or by copyrighted interfaces, the
234
+ original copyright holder who places the Program under this License
235
+ may add an explicit geographical distribution limitation excluding
236
+ those countries, so that distribution is permitted only in or among
237
+ countries not thus excluded. In such case, this License incorporates
238
+ the limitation as if written in the body of this License.
239
+
240
+ 9. The Free Software Foundation may publish revised and/or new versions
241
+ of the General Public License from time to time. Such new versions will
242
+ be similar in spirit to the present version, but may differ in detail to
243
+ address new problems or concerns.
244
+
245
+ Each version is given a distinguishing version number. If the Program
246
+ specifies a version number of this License which applies to it and "any
247
+ later version", you have the option of following the terms and conditions
248
+ either of that version or of any later version published by the Free
249
+ Software Foundation. If the Program does not specify a version number of
250
+ this License, you may choose any version ever published by the Free Software
251
+ Foundation.
252
+
253
+ 10. If you wish to incorporate parts of the Program into other free
254
+ programs whose distribution conditions are different, write to the author
255
+ to ask for permission. For software which is copyrighted by the Free
256
+ Software Foundation, write to the Free Software Foundation; we sometimes
257
+ make exceptions for this. Our decision will be guided by the two goals
258
+ of preserving the free status of all derivatives of our free software and
259
+ of promoting the sharing and reuse of software generally.
260
+
261
+ == NO WARRANTY
262
+
263
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
264
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
265
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
266
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
267
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
268
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
269
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
270
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
271
+ REPAIR OR CORRECTION.
272
+
273
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
274
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
275
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
276
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
277
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
278
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
279
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
280
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
281
+ POSSIBILITY OF SUCH DAMAGES.
282
+
283
+ == END OF TERMS AND CONDITIONS
284
+
285
+ How to Apply These Terms to Your New Programs
286
+
287
+ If you develop a new program, and you want it to be of the greatest
288
+ possible use to the public, the best way to achieve this is to make it
289
+ free software which everyone can redistribute and change under these terms.
290
+
291
+ To do so, attach the following notices to the program. It is safest
292
+ to attach them to the start of each source file to most effectively
293
+ convey the exclusion of warranty; and each file should have at least
294
+ the "copyright" line and a pointer to where the full notice is found.
295
+
296
+ <one line to give the program's name and a brief idea of what it does.>
297
+ Copyright (C) <year> <name of author>
298
+
299
+ This program is free software; you can redistribute it and/or modify
300
+ it under the terms of the GNU General Public License as published by
301
+ the Free Software Foundation; either version 2 of the License, or
302
+ (at your option) any later version.
303
+
304
+ This program is distributed in the hope that it will be useful,
305
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
306
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
307
+ GNU General Public License for more details.
308
+
309
+ You should have received a copy of the GNU General Public License along
310
+ with this program; if not, write to the Free Software Foundation, Inc.,
311
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
312
+
313
+ Also add information on how to contact you by electronic and paper mail.
314
+
315
+ If the program is interactive, make it output a short notice like this
316
+ when it starts in an interactive mode:
317
+
318
+ Gnomovision version 69, Copyright (C) year name of author
319
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
320
+ This is free software, and you are welcome to redistribute it
321
+ under certain conditions; type `show c' for details.
322
+
323
+ The hypothetical commands `show w' and `show c' should show the appropriate
324
+ parts of the General Public License. Of course, the commands you use may
325
+ be called something other than `show w' and `show c'; they could even be
326
+ mouse-clicks or menu items--whatever suits your program.
327
+
328
+ You should also get your employer (if you work as a programmer) or your
329
+ school, if any, to sign a "copyright disclaimer" for the program, if
330
+ necessary. Here is a sample; alter the names:
331
+
332
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
333
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
334
+
335
+ <signature of Ty Coon>, 1 April 1989
336
+ Ty Coon, President of Vice
337
+
338
+ This General Public License does not permit incorporating your program into
339
+ proprietary programs. If your program is a subroutine library, you may
340
+ consider it more useful to permit linking proprietary applications with the
341
+ library. If this is what you want to do, use the GNU Lesser General
342
+ Public License instead of this License.
data/README ADDED
@@ -0,0 +1,78 @@
1
+
2
+ raspell
3
+
4
+ An interface binding for the Aspell spelling checker.
5
+
6
+ == License
7
+
8
+ Copyright 2007, 2008 Cloudburst, LLC. Licensed under the GPL 2.0. See included LICENSE file. Portions copyright 2005 Matthias Veit, Biro Eszter and used with permission.
9
+
10
+ The public certificate for the gem is here[http://rubyforge.org/frs/download.php/25331/evan_weaver-original-public_cert.pem].
11
+
12
+ If you use this software, please {make a donation}[http://blog.evanweaver.com/donate/], or {recommend Evan}[http://www.workingwithrails.com/person/7739-evan-weaver] at Working with Rails.
13
+
14
+ == Requirements
15
+
16
+ Raspell requires Aspell version 0.6 (http://www.aspell.net) and at least one Aspell dictionary.
17
+
18
+ Mac:
19
+ sudo port install aspell aspell-dict-en
20
+
21
+ Ubuntu:
22
+ sudo apt-get install aspell libaspell-dev aspell-en
23
+
24
+ == Installation
25
+
26
+ Mac:
27
+ sudo gem install raspell -- --with-opt-dir=/opt/local
28
+
29
+ Ubuntu:
30
+ sudo gem install raspell
31
+
32
+ == Usage
33
+
34
+ Aspell lets you <tt>check</tt> words and <tt>suggest</tt> corrections. For example:
35
+
36
+ require 'rubygems'
37
+ require 'raspell'
38
+
39
+ speller = Aspell.new("en_US")
40
+ speller.suggestion_mode = Aspell::NORMAL
41
+
42
+ string = "my haert wil go on"
43
+
44
+ string.gsub(/[\w\']+/) do |word|
45
+ if !speller.check(word)
46
+ # word is wrong
47
+ puts "Possible correction for #{word}:"
48
+ puts speller.suggest(word).first
49
+ end
50
+ end
51
+
52
+ This outputs:
53
+
54
+ Possible correction for haert:
55
+ heart
56
+ Possible correction for wil:
57
+ Will
58
+
59
+ Note that <tt>suggest</tt> returns an array of suggestions even for words that are correctly spelled.
60
+
61
+ == Options
62
+
63
+ The most useful options are <tt>suggestion_mode</tt>, and the passthrough option <tt>ignore_case</tt>. Passthrough options have to be set as so:
64
+
65
+ speller.set_option("ignore-case", "true")
66
+
67
+ See http://aspell.net/man-html/The-Options.html for a list of the passthrough options.
68
+
69
+ == Reporting problems
70
+
71
+ The support forum is here[http://rubyforge.org/forum/forum.php?forum_id=13988].
72
+
73
+ Patches and contributions are very welcome. Please note that contributors are required to assign copyright for their additions to Cloudburst, LLC.
74
+
75
+ == Futher resources
76
+
77
+ * http://blog.evanweaver.com/articles/2007/03/10/add-gud-spelning-to-ur-railz-app-or-wharever
78
+
data/Rakefile ADDED
@@ -0,0 +1,16 @@
1
+
2
+ require 'rubygems'
3
+ gem 'echoe', '>=2.3'
4
+ require 'echoe'
5
+
6
+ Echoe.new("raspell") do |p|
7
+ p.description = p.summary = "A fork of raspell for ruby 1.9.1"
8
+ p.url = "http://github.com/patrickod/raspell"
9
+ p.docs_host = "blog.evanweaver.com:~/www/bax/public/files/doc/"
10
+ p.has_rdoc = false # avoids warnings on gem install
11
+ p.rdoc_pattern = /CHANGELOG|EXAMPLE|LICENSE|README|lib/
12
+ p.rdoc_options = [] # don't want to include the stubbed out source
13
+ p.require_signed = true
14
+ p.name = "patrickod-raspell"
15
+ p.author = "Patrick O'Doherty"
16
+ end
data/ext/extconf.rb ADDED
@@ -0,0 +1,6 @@
1
+ require "mkmf"
2
+
3
+ have_header("ruby.h")
4
+ have_header("aspell.h")
5
+ have_library("aspell")
6
+ create_makefile("raspell")