Ruby wrapper for correcting spelling and grammar mistakes based on the context of complete sentences.
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
test
.editorconfig completed ginger parser and executable Apr 27, 2013
.gitignore
.travis.yml
Gemfile
README.markdown
Rakefile add test tasks; set version Apr 27, 2013
gingerice.gemspec refactor options logic Apr 30, 2013

README.markdown

Gingerice

Gem Version Build Status Coverage Status Dependency Status Code Climate

Ruby wrapper of Ginger Proofreader which corrects spelling and grammar mistakes based on the context of complete sentences by comparing each sentence to billions of similar sentences from the web.

Installation

Add this line to your application's Gemfile:

gem 'gingerice'

And then execute:

$ bundle

Or install it yourself as:

$ gem install gingerice

Usage

require 'gingerice'

text = 'The smelt of fliwers bring back memories.'

parser = Gingerice::Parser.new
parser.parse text
# output:

{
           "text" => "The smelt of fliwers bring back memories.",
         "result" => "The smell of flowers brings back memories.",
    "corrections" => [
        [0] {
                  "text" => "smelt",
               "correct" => "smell",
            "definition" => nil,
                 "start" => 4,
                "length" => 5
        },
        [1] {
                  "text" => "fliwers",
               "correct" => "flowers",
            "definition" => "a plant cultivated for its blooms or blossoms",
                 "start" => 13,
                "length" => 7
        },
        [2] {
                  "text" => "bring",
               "correct" => "brings",
            "definition" => nil,
                 "start" => 21,
                "length" => 5
        }
    ]
}

This gem also provides executable which can be executed:

$ gingerice "Edwards will be sck yesterday"
# output:

Edwards was sick yesterday

Or if you want verbose output you can add --verbose or -v argument:

$ gingerice --verbose "Edwards will be sck yesterday"
# output:

{
           "text" => "Edwards will be sck yesterday",
         "result" => "Edwards was sick yesterday",
    "corrections" => [
        [0] {
                  "text" => "will be",
               "correct" => "was",
            "definition" => nil,
                 "start" => 8,
                "length" => 7
        },
        [1] {
                  "text" => "sck",
               "correct" => "sick",
            "definition" => "affected by an impairment of normal physical or mental function",
                 "start" => 16,
                "length" => 3
        }
    ]
}

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

Ports

Thanks

Thank you for Ginger Proofreader for such awesome service. Hope they will keep it free :)