Skip to content
No description or website provided.
Ruby
Find file
Pull request Compare This branch is 14 commits ahead of mendicant-original:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
bench
examples
lib
.gitignore
Gemfile
README.md
Rakefile
speller.gemspec

README.md

Speller: Spell check using Ruby

Speller provides an interface (using ffi) to the GUN ASpell library. Currently, it offers the ability to check words or a string of words for correctness, and return suggestions.

Usage

Config

Before you can spell check a string, you need to set your configuration options. To do so, you create an instance of the Speller::Config class.

When creating an instance of Speller::Config, you must specify one arguement, the language code to be used:

my_config = Speller::Config.new("en_US")

You can then set any additional configuration options:

my_config["ignore-case"] = "true"

To retrieve configuration options:

my_config["ignore-case"]    # returns 'true'

For info on what options are available, see the GNU ASpell Documentation

Once you've set all your configuration options, create a new instance of Speller::Checker:

my_checker = Speller::Checker.new(my_config.config)

Note that you must set all options before creating a new Speller::Checker instance.

Checking Spelling

Speller:Checker has a couple of methods for checking spelling:

To check for correctness, use the correct? method:

my_checker.correct?("word")     #returns true
my_checker.correct?("wordd")    #returns false

To get suggestions for a word, use the suggest method. This method returns the suggested corrections as an array of strings. If the word is spelled correctly, it returns an empty array.

my_checker.suggest("word")
my_checker.suggest("wordd")

To check an entire string, use the check_string method, providing the string to check, and an optional integer offset indicating where to begin checking. If no offset is provided, the method will check from the beginning of the string.

The check_string method returns an array. Each element in this array is another array, corresponding to a misspelled word in the string. The first element of the inner array is a string equal to the misspelled word detected; the second is the offset at which the word was found; the third is an array of suggested corrections.

If no misspellings are found, check_string returns an empty array.

string = "This longg string has two misspelled words. The secondd misspelling is in the second sentence."

result = my_checker.check_string(string)
result.each do |misspelling|
    puts "The word '#{misspelling[0]}' is misspelled at offset #{mispelling[1]}"
    puts "Suggested spellings: #{mispelling[2].join(", ")}"
end
Something went wrong with that request. Please try again.