Implements the "Metaphone" phonetic algorithm adapted for Russian language
Ruby
Permalink
Failed to load latest commit information.
lib extracts default filters set into a constant, preparing to true filte… Jul 27, 2013
spec
.gitignore
Gemfile initial import of code Jul 21, 2013
LICENSE.txt
README.md minor changes to readme and gitignore Oct 23, 2013
Rakefile initial import of code Jul 21, 2013
russian_metaphone.gemspec adds license information to gemspec file Jul 28, 2013

README.md

RussianMetaphone

This gem provides an implementation of 'Metaphone' phonetic algorithm adapted for Russian language. Check this Wikipedia article for Metaphone intro.

Installation

Add this line to your application's Gemfile:

gem 'russian_metaphone'

And then execute:

$ bundle

Or install it yourself as:

$ gem install russian_metaphone

Usage

Going to switch to Russian at this point, drop me a line if you'd like me to translate the Usage section to English...

Алгоритм русского "Метафон" был предложен Петром Каньковски более 10 лет назад. Именно он и лег в основу этой реализации. Оригинал статьи, за давностью лет, не сохранился, но его можно посмотреть в архиве.

Реализация RussianMetaphone не претендует на высокую производительность. Основной упор сделан на модульность реализации - позволяет легко менять, настраивать, тестировать и подстраивать его под нужды конкретного проекта. Думаю оптимизация хорошо настроенного алгоритма не будет сложной задачей, гораздо сложнее "оттюнить" сам алгоритм.

Как пользоваться

puts RussianMetaphone::process("Ахматова") # => ахмат%5
puts RussianMetaphone::process("Бродский") # => працк%9
puts RussianMetaphone::process("Мальденштам") # => малдинштам

Как это работает

Входные данные проходят через набор фильтров и каждый фильтр по-своему модифицирует строку. Та строка, которую вернет последний в цепочке фильтр и будет конечным результатом.

Фильтры

Фильтр - это руби модуль или экземпляр класса, который реализует метод filter:

def filter(string, options = {})

результатом выполнения фильтра должна быть строка.

RussianMetaphone имеет готовый набор фильтров для работы с именами и фамилиями, эти фильтры перечислены ниже. Вы можете добавить свои фильтры в цепочку если алгоритм не совсем четко справляется с Вашей задачей. Про добавление "кастомных" фильтров в цепочку смотрите ниже.

RussianMetaphone::Filter::Normalization

Нормализует строку - убирает из нее все не кириллическое, а так-же символы твердого и мягкого знаков ('Ъ' и 'Ь')

RussianMetaphone::Filter::DuplicatesRemoval

Исключает повторяющиеся символы - (Метревели многие напишут как Метревелли)

RussianMetaphone::Filter::LastnameEnding

При работе с фамилиями бывает полезным заменить часто употребимые окончания фамилий на что-то более короткое. Этот фильтр заменяет окончание овский на %1, евский на %2 и т.д. Остальные замены см. в исходниках.

RussianMetaphone::Filter::Replacement

Заменяет символы следующим образом:

Символы Заменяются на
ТС, ДС Ц
І, Ї И
Є Е
ЙО, ИО, ЙЕ, ИЕ И
О, Ы, А, Я A
Ю, У У
Е, Ё, Э, И И

RussianMetaphone::Filter::BreathConsonants

Производит оглушение согласных в слабой позиции. См. исходник - там описаны детали.

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

License

The MIT License (MIT)

Copyright (c) 2013 CleverUA

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.