Project

phonetic

0.01
No commit activity in last 3 years
No release in over 3 years
Ruby library for phonetic algorithms. It supports Soundex, Metaphone, Caverphone, NYSIIS and others.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.3
>= 0
>= 0
>= 0
 Project Readme

Phonetic

Build Status Gem Version Coverage Status Code Climate Dependency Status

Ruby library for phonetic algorithms. It supports Soundex, Metaphone, Double Metaphone, Caverphone, NYSIIS and others.

Installation

Add this line to your application's Gemfile:

gem 'phonetic'

And then execute:

$ bundle

Or install it yourself as:

$ gem install phonetic

Dependencies

Ruby >= 1.9, JRuby 1.7.6, Rubinius 2.1.1

Usage

require 'phonetic'

Soundex

'Ackerman'.soundex # => 'A265'
'ammonium'.soundex # => 'A500'
'implementation'.soundex # => 'I514'

Refined Soundex

'Caren'.refined_soundex   # => 'C30908'
'Hayers'.refined_soundex  # => 'H093'
'Lambard'.refined_soundex # => 'L7081096'

Metaphone

'Accola'.metaphone # => 'AKKL'
'Nikki'.metaphone # => 'NK'
'Wright'.metaphone #=> 'RT'

Double Metaphone

'czerny'.double_metaphone # => ['SRN', 'XRN']
'dumb'.double_metaphone   # => ['TM', 'TM']
'edgar'.double_metaphone  # => ['ATKR', 'ATKR']

or use alias:

'czerny'.metaphone2 # => ['SRN', 'XRN']
'dumb'.metaphone2   # => ['TM', 'TM']
'edgar'.metaphone2  # => ['ATKR', 'ATKR']

Caverphone

'Lashaunda'.caverphone # => 'LSNT11'
'Vidaurri'.caverphone # => 'FTR111'

Caverphone 2

'Stevenson'.caverphone2 # => 'STFNSN1111'
'Peter'.caverphone2 # => 'PTA1111111'

NYSIIS

'Alexandra'.nysiis # => 'ALAXANDR'
'Aumont'.nysiis # => 'AANAD'
'Bonnie'.nysiis # => 'BANY'

Refined NYSIIS

'Aumont'.refined_nysiis  # => 'ANAD'
'Phoenix'.refined_nysiis # => 'FANAC'
'Schmidt'.refined_nysiis # => 'SNAD'

Daitch–Mokotoff Soundex (D–M Soundex)

'Anja'.dm_soundex # => ['060000', '064000']
'Schwarz'.dm_soundex # => ['474000', '479400']
'Schtolteheim'.dm_soundex # => ['283560']

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