gingerice

Ruby wrapper for correcting spelling and grammar mistakes based on the context of complete sentences.

  • Owner: subosito/gingerice
  • Platform:
  • License::
  • Category::
  • Topic:
  • Like:
    0
      Compare:

Github stars Tracking Chart

Gingerice

Gem Version
Build Status
Coverage Status
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:

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 :)

Main metrics

Overview
Name With Ownersubosito/gingerice
Primary LanguageRuby
Program languageRuby (Language Count: 1)
Platform
License:
所有者活动
Created At2013-04-27 08:44:59
Pushed At2019-08-29 07:45:41
Last Commit At2019-07-04 23:34:22
Release Count7
Last Release Name1.3.0 (Posted on )
First Release Namev1.0.0 (Posted on 2013-04-27 19:27:11)
用户参与
Stargazers Count478
Watchers Count19
Fork Count21
Commits Count45
Has Issues Enabled
Issues Count4
Issue Open Count0
Pull Requests Count2
Pull Requests Open Count0
Pull Requests Close Count1
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private