https://github.com/xwmx/iso-639
Ruby gem with ISO 639-1 and ISO 639-2 language code entries and convenience methods.
https://github.com/xwmx/iso-639
iso-639 iso-639-1 iso-639-2 languages ruby rubygems
Last synced: 11 days ago
JSON representation
Ruby gem with ISO 639-1 and ISO 639-2 language code entries and convenience methods.
- Host: GitHub
- URL: https://github.com/xwmx/iso-639
- Owner: xwmx
- License: mit
- Created: 2010-01-14T03:53:23.000Z (over 15 years ago)
- Default Branch: master
- Last Pushed: 2024-10-07T23:54:33.000Z (7 months ago)
- Last Synced: 2025-04-25T17:06:28.178Z (24 days ago)
- Topics: iso-639, iso-639-1, iso-639-2, languages, ruby, rubygems
- Language: Ruby
- Homepage:
- Size: 81.1 KB
- Stars: 69
- Watchers: 3
- Forks: 18
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# ISO 639
[](https://github.com/xwmx/iso-639/actions)
[](http://rubygems.org/gems/iso-639)
[](http://rubygems.org/gems/iso-639)
A Ruby gem that provides the ISO 639-2 and ISO 639-1 data sets along with some
convenience methods for accessing different entries and entry fields. The data
comes from the
[LOC ISO 639-2 UTF-8 data set](http://www.loc.gov/standards/iso639-2/ascii_8bits.html).
The [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) specification uses a
two-letter code to identify a language and is often the recommended way to
identify languages in computer applications. The ISO 639-1 specification covers
most developed and widely used languages.
The [ISO 639-2](http://www.loc.gov/standards/iso639-2/)
([Wikipedia](http://en.wikipedia.org/wiki/ISO_639-2)) specification uses a
three-letter code, is used primarily in bibliography and terminology and
covers many more languages than the ISO 639-1 specification.
## Installation
To install from [RubyGems](https://rubygems.org/gems/iso-639):
```bash
gem install iso-639
```
To install with [Bundler](https://bundler.io/), add the following to your
Gemfile:
```ruby
gem 'iso-639'
```
Then run `bundle install`
## Usage
```ruby
require 'iso-639'
```
To find a language entry:
```ruby
# by alpha-2 or alpha-3 code
ISO_639.find_by_code("en")
# or
ISO_639.find("en")
# by English name
ISO_639.find_by_english_name("Russian")
# by French name
ISO_639.find_by_french_name("français")
```
The `ISO_639.search` class method searches across all fields and will
match names in cases where a record has multiple names. This method
always returns an array of 0 or more results. For example:
```ruby
ISO_639.search("spanish")
# => [["spa", "", "es", "Spanish; Castilian", "espagnol; castillan"]]
```
Entries are arrays with convenience methods for accessing fields:
```ruby
@entry = ISO_639.find("slo")
# => ["slo", "slk", "sk", "Slovak", "slovaque"]
@entry.alpha3_bibliographic
# => "slo"
@entry.alpha3 # shortcut for #alpha3_bibliographic
# => "slo"
@entry.alpha3_terminologic
# => "slk"
@entry.alpha2
# => "sk"
@entry.english_name
# => "Slovak"
@entry.french_name
# => "slovaque"
```
The full data set is available through the `ISO_639::ISO_639_1` and
`ISO_639::ISO_639_2` constants.
## Note on Patches/Pull Requests
* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Commit, do not mess with rakefile, version, or history.
(if you want to have your own version, that is fine but
bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.
## Copyright
Copyright (c) 2010 William Melody. See LICENSE for details.