Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/subosito/gingerice
Ruby wrapper for correcting spelling and grammar mistakes based on the context of complete sentences.
https://github.com/subosito/gingerice
ruby rubygem
Last synced: about 1 month ago
JSON representation
Ruby wrapper for correcting spelling and grammar mistakes based on the context of complete sentences.
- Host: GitHub
- URL: https://github.com/subosito/gingerice
- Owner: subosito
- Archived: true
- Created: 2013-04-27T08:44:59.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2019-08-29T07:45:41.000Z (over 5 years ago)
- Last Synced: 2024-04-13T22:42:50.300Z (9 months ago)
- Topics: ruby, rubygem
- Language: Ruby
- Homepage:
- Size: 40 KB
- Stars: 480
- Watchers: 20
- Forks: 22
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Gingerice
[](https://badge.fury.io/rb/gingerice)
[](https://travis-ci.org/subosito/gingerice)
[](https://coveralls.io/github/subosito/gingerice?branch=master)
[](https://codeclimate.com/github/subosito/gingerice/maintainability)
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:
```ruby
gem 'gingerice'
```
And then execute:
```bash
$ bundle
```
Or install it yourself as:
```bash
$ gem install gingerice
```
## Usage
```ruby
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:
```bash
$ gingerice "Edwards will be sck yesterday"
```
```
# output:
Edwards was sick yesterday
```
Or if you want verbose output you can add `--verbose` or `-v` argument:
```bash
$ 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
- PHP library by @Aitboudad: https://github.com/Aitboudad/GingerLight.git
- Python library by @Azd325: https://github.com/Azd325/gingerit
## Thanks
Thank you for [Ginger Proofreader](http://www.gingersoftware.com/) for such awesome service. Hope they will keep it free :)