raspell 0.3 → 1.0

data/CHANGELOG

@@ -0,0 +1,4 @@
+
+v1.0. documentation
+
+v0.3. fix OS X compilation problem; rubyforge release

data/LICENSE

@@ -0,0 +1,339 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

data/Manifest

@@ -0,0 +1,10 @@
+test/simple_test.rb
+lib/raspell_stub.rb
+ext/raspell.h
+ext/raspell.c
+ext/extconf.rb
+Rakefile
+README
+Manifest
+LICENSE
+CHANGELOG

data/README

@@ -1,133 +1,50 @@
 
-RASPELL - an interface binding for ruby to aspell.
-==================================================
-
-Author:
--------
-  - Matthias Veit  <matthias_veit@yahoo.de>
-
-Requirements:
--------------
-  - aspell Ver 0.5 (or later) - see aspell.net.
-
-Documentation:
---------------
-Aspell comes with a very brief description of every functionality.
-Read the manual for the use of aspell.
-
-Notes for the Wrapper:
-----------------------
-Aspell comes with a lot of classes (iterators, stringhelpers etc.) 
-that are not needed by ruby and are therefore not bridged.
-Only 2 classes are introduced:
-
-  => Aspell:
-  Almost all functionality of aspell is accessible via this class:
- 
-    *inheritance tree:
-       -Object
-       
-    *included modules:
-       -Kernel
-       
-    *defined constants:
-       ULTRA,               - option of suggestion mode
-       NORMAL,              - option of suggestion mode
-       FAST,                - option of suggestion mode
-       BADSPELLERS,         - option of suggestion mode
-       CheckerOptions       - list of checker options
-       DictionaryOptions,   - list of dictionary options
-       FilterOptions,       - list of filter options
-       MiscOptions,         - list of misc options
-       RunTogetherOptions,  - list of run together options
-       UtilityOptions,      - list of utility options
-
-    *class methods:
-       -list_dicts()
-            List of all available dictionaries.
-            Return a list of AspellDictInfo objects.
-       -new(language, jargon, size, encoding)
-            Constructor.
-             -language ISO639 language code plus optional ISO 3166 counry code as string (eg: "de" or "us_US")
-             -jargon a special jargon of the selected language
-             -size the size of the dictionary to chose (if there are options)
-             -encoding the encoding to use
-            Note: All parameters are optional and have default values.
-                  In most cases it is enough to create an Aspell-instance by eg: Aspell.new("us").
-
-    *instance methods:
-       -add_to_personal(word)   
-            Add the word to the private dictionary.
-       -add_to_session(word)
-            Add the word to the session list (Ignore the
-            word for the rest of the session). The session
-            relates to the lifetime of the object.
-       -check(word)
-            Check given word for correctnes. Returns true
-            if word is correct, otherwise false.
-       -correct_file(filename)
-            Check the whole file with name filename.
-            This method needs a block, which will yield
-            each misspelled word.
-       -correct_lines(array_of_strings)
-            Check an array of strings for correctnes.
-            This method needs a block, which will yield
-            each misspelled word.
-       -clear_session()
-            Delete all words inside the session-wordlist.
-       -get_option(option)
-            Value of option in config.
-       -get_option_as_list(option)
-            Value of option in config.
-            The result is a list of strings.
-       -list_misspelled(array_of_strings)
-            Check an array of strings for correctnes.
-            Return a list of all words, that are misspelled.
-       -personal_wordlist()
-            Return a list of words inside private dictionary.
-       -save_all_word_lists()
-            All changed dictionaries get synchronized.
-       -session_wordlist()
-            Return a list of words inside session wordlist.
-       -set_option(option, value)
-            Set a specified configurable option to value.
-       -suggest(word)
-            Make a suggestion to the given misspelled word.
-            Return a list of words, that are possible suggestions
-            to the misspelled given word.
-       -suggestion_mode=(mode)
-            Set the suggestion mode to one of:
-            Aspell::ULTRA   - look for soundslikes with one edit distance
-            Aspell::FAST    - like ultra, but with typo analysis
-            Aspell::NORMAL  - look for soundslikes with two edit distances + typo analysis
-            Aspell::BADSPELLERS  - tailored for bad spellers
-
-
-  => AspellDictInfo:
-     Aspell.list_dicts return a list of AspellDictInfo-objects. Each dictionary is
-     described by an instance of AspellDictInfo:
-
-    *inheritance tree:
-       -Object
-
-    *included modules:
-       -Kernel
-
-    *class methods:
-       -new()
-            Constructor. Never invoke this method by hand.
-
-    *instance methods:
-       -code()
-            The code of the dictionary.
-       -jargon()
-            The jargon of the dictionary.
-       -name()
-            The name of the dictionary.
-       -size()
-            The size of the dictionary.
-
-Example:
---------
-See in examples directory inside distribution.
+raspell
+
+An interface binding for Aspell.
+
+== License
+
+Copyright 2007 Cloudburst, LLC. Portions copyright 2005 Matthias Veit, Biro Eszter. Used with permission. Licensed under the GPL 2.0. See included LICENSE file. 
+
+== Requirements
+
+* Aspell version 0.6 (http://www.aspell.net)
+
+== Basic usage
+
+Aspell lets you <tt>check</tt> words and <tt>suggest</tt> corrections. For example:
+   
+  require 'rubygems'
+  require 'raspell'
+  
+  speller = Aspell.new("en_US")
+  speller.suggestion_mode = Aspell::NORMAL
+  
+  string = "my haert wil go on"
+  
+  string.gsub(/[\w\']+/) do |word| 
+    if !speller.check(word) 
+      # word is wrong
+      puts "Possible correction for #{word}:"
+      puts speller.suggest(word).first
+    end
+  end
+
+This outputs:
+
+  Possible correction for haert:
+  heart
+  Possible correction for wil:
+  Will
+
+Note that <tt>suggest</tt> returns an array of suggestions even for words that are correctly spelled.
+
+== Options
+
+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:
+
+  speller.set_option("ignore-case", "true")
+
+See http://aspell.net/man-html/The-Options.html for a list of the passthrough options. 
 

data/Rakefile

@@ -0,0 +1,13 @@
+
+require 'rubygems'
+require 'echoe'
+
+Echoe.new("raspell") do |p|  
+  p.rubyforge_name = "fauna"
+  p.description = p.summary = "An interface binding for Aspell."
+  p.url = "http://blog.evanweaver.com/pages/code#raspell"  
+  p.docs_host = "blog.evanweaver.com:~/www/snax/public/files/doc/"
+
+  p.rdoc_pattern = /CHANGELOG|EXAMPLE|LICENSE|README|lib/
+  p.rdoc_options = [] # don't want to include the stubbed out source
+end

data/ext/raspell.c

@@ -1,28 +1,6 @@
 
 #include "raspell.h"
 
-/**
- * raspell      September 2002      
- *
- * Copyright (c) aquanauten (resp: matthias_veit@yahoo.de)
- * 
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2, or (at your option) 
- * any later version.
- *  
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of 
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the  
- * GNU General Public License for more details.
- *  
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  
- * 02111-1307, USA.
- *
- */
-
 extern void Init_dictinfo();
 extern void Init_aspell();
 

data/ext/raspell.h

@@ -1,3 +1,4 @@
+
 #ifndef _RASPELL_GLOBAL_H
 #define _RASPELL_GLOBAL_H
 
@@ -10,25 +11,3 @@ VALUE cDictInfo;
 VALUE cAspellError;
 
 #endif
-
-/**
- * raspell      September 2002      
- *
- * Copyright (c) aquanauten (resp: matthias_veit@yahoo.de)
- * 
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2, or (at your option) 
- * any later version.
- *  
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of 
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the  
- * GNU General Public License for more details.
- *  
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  
- * 02111-1307, USA.
- *
- */

data/lib/raspell_stub.rb

@@ -0,0 +1,113 @@
+
+# Stub for documentation purposes
+raise "This file is only for documentation purposes. Require #{File.dirname(__FILE__)}/../ext/raspell} instead."
+
+# The functionality of Aspell is accessible via this class.
+class ::Aspell
+
+  # Creates an Aspell instance. All parameters are optional and have default values. In most situations it is enough to create an Aspell-instance with only a language.
+  # * <tt>language</tt> -  ISO639 language code plus optional ISO 3166 counry code as string (eg: "de" or "us_US").
+  # * <tt>jargon</tt> - A special jargon of the selected language.
+  # * <tt>size</tt> - The size of the dictionary to chose (if there are options).
+  # * <tt>encoding</tt> - The encoding to use.
+  def initialize(language, jargon, size, encoding); end
+
+  # Returns a list of AspellDictInfo-objects describing each dictionary.
+  def self.list_dicts; end
+  
+  # Returns a list of checker options.
+  def self.CheckerOptions; end
+  
+  # Returns a list of dictionary options.
+  def self.DictionaryOptions; end 
+  
+  # Returns a list of filter options.
+  def self.FilterOptions; end
+  
+  # Returns a list of misc options.
+  def self.MiscOptions; end 
+  
+  # Returns a list of run-together options.
+  def self.RunTogetherOptions; end 
+  
+  # Returns a list of utility options.
+  def self.UtilityOptions; end 
+  
+  
+
+  # Add a word to the private dictionary.
+  def add_to_personal(word); end
+
+  # Add a word to the session ignore list. The session persists for the lifetime of <tt>self</tt>.
+  def add_to_session(word); end
+
+  # Check given word for correctness. Returns <tt>true</tt> or <tt>false</tt>.
+  def check(word); end
+
+  # Check an entire file for correctness. This method requires a block, which will yield each misspelled word.
+  def correct_file(filename); end
+
+  # Check an array of strings for correctness. This method requires a block, which will yield each misspelled word.
+  def correct_lines(array_of_strings)
+    yield
+  end
+
+  # Clear the the session wordlist.
+  def clear_session(); end
+
+  # Value of an option in config. Returns a string.
+  def get_option(option); end
+
+  # Value of option in config. Returns a list of strings.
+  def get_option_as_list(option); end
+
+  # Returns a list of all words in the passed array that are misspelled.
+  def list_misspelled(array_of_strings); end
+
+  # Return a list of words inside the private dictionary.
+  def personal_wordlist(); end
+
+  # Sync changed dictionaries to disk.
+  def save_all_word_lists(); end
+
+  # Return the session wordlist.
+  def session_wordlist(); end
+
+  # Set a passthrough option to a value. Use the strings "true" and "false" for <tt>true</tt> and <tt>false</tt>.
+  def set_option(option, value); end
+
+  # Returns an array of suggestions for the given word. Note that <tt>suggest</tt> returns multiple corrections even for words that are not wrong.
+  def suggest(word); end
+
+  # Sets the suggestion mode. Use Aspell::ULTRA, Aspell::FAST, Aspell::NORMAL, or Aspell::BADSPELLERS as the parameter.
+  def suggestion_mode=(mode); end
+
+  ULTRA = Fastest mode. Look only for sound-a-likes within one edit distance. No typo analysis.;
+  
+  NORMAL = Normal speed mode. Look for sound-a-likes within two edit distances, with typo analysis.;
+  
+  FAST = Fast mode. Look for sound-a-likes within one edit distance, with typo analysis.;
+  
+  BADSPELLERS = Slowest mode. Tailored for bad spellers.;
+  
+end
+
+=begin rdoc
+Represents an Aspell dictionary. Returned by <tt>Aspell. list_dicts</tt>.     
+=end
+
+class ::AspellDictInfo
+
+  # Returns the code of the dictionary.
+  def code; end
+
+  # Returns the jargon of the dictionary.
+  def jargon; end
+
+  # Returns the name of the dictionary.
+  def name; end
+
+  # Returns the size of the dictionary.
+  def size; end
+    
+end

metadata

@@ -1,21 +1,22 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
+rubygems_version: 0.9.4
 specification_version: 1
 name: raspell
 version: !ruby/object:Gem::Version 
-  version: "0.3"
-date: 2007-03-10 00:00:00 -05:00
-summary: an interface binding for ruby to aspell (aspell.net)
+  version: "1.0"
+date: 2007-08-03 00:00:00 -04:00
+summary: An interface binding for Aspell.
 require_paths: 
 - lib
-email: evan at cloudbur st
-homepage: http://rubyforge.org/projects/fauna
-rubyforge_project: 
-description: 
-autorequire: raspell
+- ext
+email: ""
+homepage: http://blog.evanweaver.com/pages/code#raspell
+rubyforge_project: fauna
+description: An interface binding for Aspell.
+autorequire: 
 default_executable: 
 bindir: bin
-has_rdoc: false
+has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
   - - ">"
@@ -27,37 +28,28 @@ signing_key:
 cert_chain: 
 post_install_message: 
 authors: 
-- Evan Weaver
+- ""
 files: 
-- ./README
-- ./examples
-- ./ext
-- ./lib
-- ./raspell.gemspec
-- ./test
-- ./examples/check_correct.rb
-- ./examples/dictionaries.rb
-- ./ext/extconf.rb
-- ./ext/raspell.c
-- ./ext/raspell.h
-- ./test/simple_test.rb
-- ext/extconf.rb
-- ext/raspell.c
-- ext/raspell.h
 - test/simple_test.rb
-- examples/check_correct.rb
-- examples/dictionaries.rb
+- lib/raspell_stub.rb
+- ext/raspell.h
+- ext/raspell.c
+- ext/extconf.rb
+- Rakefile
 - README
-test_files: 
-- test/simple_test.rb
+- Manifest
+- LICENSE
+- CHANGELOG
+test_files: []
+
 rdoc_options: []
 
-extra_rdoc_files: 
-- README
+extra_rdoc_files: []
+
 executables: []
 
-extensions: 
-- ext/extconf.rb
+extensions: []
+
 requirements: []
 
 dependencies: []

data/examples/check_correct.rb

@@ -1,46 +0,0 @@
-$:.unshift(File.dirname(__FILE__) + "/../lib/")
-begin
-  require 'rubygems'
-  require_gem 'raspell'
-rescue LoadError
-  require 'raspell'
-end
-
-aspell = Aspell.new
-# Set suggestion mode: one of [ULTRA|FAST|NORMAL|BADSPELLERS]
-aspell.suggestion_mode = Aspell::ULTRA
-
-  
-# some content to check - with many errors
-content = ["This is a simpel sample texxt, with manny erors to find.",
-           "To check this, we need an englishh diktionary!"]
-puts content.join("\n")+ "\n\nChecking..."
-
-# get a list of all misspelled words
-misspelled = aspell.list_misspelled(content).sort
-puts "\n#{misspelled.length} misspelled words:\n  -"+misspelled.join("\n  -")
-
-# correct content
-correctreadme = aspell.correct_lines(content) { |badword|
-  puts "\nMisspelled: #{badword}\n"
-  suggestions = aspell.suggest(badword)
-  suggestions.each_with_index { |word, num|
-    puts "  [#{num+1}] #{word}\n"
-  }
-  puts "Enter number or correct word: "
-  input = gets.chomp
-  if (input.to_i != 0)
-    input = suggestions[input.to_i-1] 
-  else
-    if (!aspell.check(input))
-      puts "\nthe word #{input} is not known inside dictionary." 
-      #possible to add the word into private dictionary or into session
-      #via aspell.add_to_personal or aspell.add_to_session
-    end
-  end
-  input #return input
-}
-
-puts "\n\nThe correct text is:\n"+correctreadme.join("\n")
-
-# It is possible to correct files directly via aspell.correct_file(filename)

data/examples/dictionaries.rb

@@ -1,38 +0,0 @@
-$:.unshift(File.dirname(__FILE__) + "/../lib/")
-begin
-  require 'rubygems'
-  require_gem 'raspell'
-rescue LoadError
-  require 'raspell'
-end
-
-# Show all installed dictionaries.
-# Select one to use.
-puts "Choose Dictionary:\n"
-dicts = Aspell.list_dicts
-raise "\nNo dictionary installed!\nYou have to install some dictionaries (see: www.aspell.net)" if dicts.empty?
-dicts.each_with_index { |dict, num|
-  puts " [#{num+1}] #{dict.name}    (code:#{dict.code}, jargon:#{dict.jargon}, size:#{dict.size})\n"
-}
-puts "enter number of dictionary:"
-dictionary = dicts[gets.to_i-1]
-
-
-# Create a new aspell instance
-# Aspell.new(language, jargon, size, encoding) 
-# It is possible to omit all parameters (just forget or nil as placeholder).
-aspell = Aspell.new(dictionary.code, dictionary.jargon, dictionary.size.to_s)
-# Set suggestion mode: one of [ULTRA|FAST|NORMAL|BADSPELLERS]
-aspell.suggestion_mode = Aspell::ULTRA
-
-puts "\n\nCurrent Dictionary config=====================\n"
-Aspell::DictionaryOptions.each { |option|
-  begin
-    option_details = aspell.get_option(option)
-  rescue 
-    option_details = "unknown"
-  end
-  puts "  -#{option}: #{option_details}\n"
-}
-puts "==============================================\n"
-

data/raspell.gemspec

@@ -1,25 +0,0 @@
-require 'rubygems'
-spec = Gem::Specification.new do |s|
-  s.name = "raspell"
-  s.version = "0.3"
-  s.author = "Evan Weaver"
-  s.email = "evan at cloudbur st"
-  s.homepage = "http://rubyforge.org/projects/fauna"
-  s.platform = Gem::Platform::RUBY
-  s.summary = "an interface binding for ruby to aspell (aspell.net)"
-  candidates = Dir.glob("{.,ext,lib,test,examples}/**/*")
-  s.files = candidates.delete_if do |item|
-                  item.include?("CVS") || item.include?("rdoc") || item.include?("svn")
-                end
-  s.require_path = "lib"
-  s.autorequire = "raspell"
-  s.extensions = ["ext/extconf.rb"]
-  s.test_file = "test/simple_test.rb"
-  s.has_rdoc = false
-  s.extra_rdoc_files = ["README"]
-end
-
-if $0 == __FILE__
-  Gem::manage_gems
-  Gem::Builder.new(spec).build
-end