Stemmers

Rust bindings for https://whatlang.org and https://github.com/testuj-to/tantivy-stemmers for language detection and stemming.

Install the gem and add to the application's Gemfile by executing:

bundle add stemmers

If bundler is not being used to manage dependencies, install the gem by executing:

gem install stemmers

The language detection works in the context of the supported stemmers. If language doesn't have a stemmer, then it'll return nil.

require "stemmers"

Stemmers.detect_language("Hello there!")
#=> "en"

Stemmers.detect_language("Olá, mundo!")
#=> "pt"

To stem a word, you can use the Stemmers.stem_word(word, **options) method.

require "stemmers"

Stemmers.stem_word("running", language: "en")
#=> "run"

Stemmers.stem_word("correndo", language: "pt")
#=> "corr"

You have a few options when stemming a word with Stemmers.stem_word(input, **options):

• language: The language to use for stemming. If not provided, it will try to detect the language.
• normalize: If set to true, it will normalize the word after stemming. This is useful for languages that have diacritics or special characters.
• lowercase: If set to true, it will lowercase the word before stemming (stemming requires lowercase strings, but this is not done automatically to avoid unnecessary transformations when using Stemmers.stem(phrase).

To stem a phrase, you can use Stemmers.stem(input, **options).

require "stemmers"

Stemmers.stem("Testing this phrase", language: "en")
#=> ["test", "this", "phrase"]

The Stemmers.stem(input, **options) method has the following options:

• language: The language to use for stemming. If not provided, it will try to detect the language.
• normalize: If set to true, it will normalize the word after stemming. This is useful for languages that have diacritics or special characters.
• lowercase: If set to true, it will lowercase the word before stemming (stemming requires lowercase strings, but this is not done automatically to avoid unnecessary transformations when using Stemmers.stem(phrase)).
• clean: If set to true, it will remove stop words from the phrase (beware that you may end up with an empty array). It uses the list of stop words from https://github.com/stopwords-iso/stopwords-iso (it's not a great list—it has too much surprising words that shouldn't be in the list, but I couldn't find anything better).

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/fnando/stemmers. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Stemmers project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.