Giter VIP home page Giter VIP logo

spelly's Introduction

Spelly

This is a simple to use spell check gem that returns back the misspelled words and their common suggestions.

Installation

Add this line to your application's Gemfile:

gem 'spelly'

And then execute:

$ bundle

Or install it yourself as:

$ gem install spelly

Usage

You can create the Spelly object by calling

# passing in the language dictionary
spelly = Spelly.new("en_US")

A full list of dictionaries can be found here: http://wiki.openoffice.org/wiki/Dictionaries#English_.28AU.2CCA.2CGB.2CNZ.2CUS.2CZA.29

Then you can run your spell check against an array of words by simply calling

> spelly = Spelly.new("en_US")
> words = %w/car bat yardd/
> spelly.spell_check words
=> [{:word=>"yardd", :suggest=>["yards", "yard", "yard d"]}] 

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

TODO:

Add ability to allow end users to easily upload new dictionary files.

spelly's People

Contributors

gogogarrett avatar saouddk avatar smithjunior avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.