Whatlang

Ruby bindings for Whatlang, a natural language detection for Rust.

Features

Features are derived from original Whatlang library, which includes:

Supports 69 languages
Lightweight, fast and simple
Recognizes not only a language, but also a script (Latin, Cyrillic, etc)
Provides reliability information

Installation

Requirements

You need Rust's build environment to install this gem.

For Unix like system, run

% curl https://sh.rustup.rs -sSf | sh

For Windows, download and run installer.

See Rust official installation page for details.

Gem installation

Add this line to your application's Gemfile:

gem 'whatlang'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install whatlang

Usage

require "whatlang"

text = "Благодаря Эсперанто вы обрётете друзей по всему миру!"

info = Whatlang.detect(text)
info.lang.code     # => "bul"
info.lang.name     # => "Български"
info.lang.eng_name # => "Bulgarian"
info.script        # => "Cyrillic"
info.confidence    # => 0.2568924409819 (0 to 1 value)
info.reliable?     # => false

text = "Jen la trinkejo fermitis, ni iras tra mallumo kaj pluvo."
list = ["eng", "ita"]
Whatlang.detect(text, allowlist: list).lang.code # => "ita"
Whatlang.detect(text, denylist: list).lang.code # => "epo"

If you're interested in only language information, use detect_lang function:

lang = Whatlang.detect_lang(text)
lang.code # => "bul"
lang.name # => "Български"
lang.eng_name # => "Bulgarian"

Also, Whatlang can detect only scripts:

Whatlang.detect_script(text) # => "Cyrillic"

Development

After checking out the repo, run bundle config set --local vendor/bundle && bundle install to install dependencies. Then, run bundle exec rake test to run the tests. You can also run bundle exec rake 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 Cargo.toml, 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://gitlab.com/KitaitiMakoto/whatlang-rb.

License

This RubyGem distributed under the Ruby's license. See {file:COPYING} file.

KitaitiMakoto / whatlang-rb