petrovich / Petrovich Ruby

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

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

Установка

Добавьте в Gemfile:

gem 'petrovich', '~> 1.0'

Установите гем cредствами Bundler:

$ bundle

Или установите его отдельно:

$ gem install petrovich

Зависимости

Для работы гема требуется Ruby не младше версии 1.9.3. Petrovich не привязан к Ruby on Rails и может свободно использоваться практически в любых приложениях и библиотеках на языке Ruby.

Использование

Вы задаёте начальные значения (фамилию, имя и отчество) в именительном падеже, а библиотека делает всё остальное. Если вам известен пол - укажите его, это повысит скорость работы и даст более точные результаты. Если пол не указан, то Petrovich попытается определить его автоматически. Примеры:

# Склонение в дательный падеж при помощи метода `dative`. Существуют методы `genitive`,
# `dative`, `accusative`, `instrumental`, `prepositional`.
Petrovich(
  lastname: 'Салтыков-Щедрин',
  firstname: 'Михаил',
  middlename: 'Евграфович',
).dative.to_s # => Салтыкову-Щедрину Михаилу Евграфовичу

# Склонение в творительный падеж с использованием метода `to` и возвратом отчества.
# Аналогично можно вызвать метод `firstname`, чтобы получить имя.
Petrovich(
  firstname: 'Иван',
  middlename: 'Петрович',
).to(:instrumental).middlename # => Петровича

# Склонение с указанием пола. В данном случае, по имени и фамилии невозможно определить пол
# человека, поэтому, если вам известен пол, то всегда передавайте его в аргументах,
# чтобы склонение было верным.
# Если пол неизвестен, то гем попытается определить его самостоятельно.
# Пол должен быть указан в виде строки или символа. Возможные значения: male, female.
Petrovich(
  lastname: 'Андрейчук',
  firstname: 'Саша',
  gender: :male
).to(:instrumental).to_s # => Андрейчуку Саше

Полный список поддерживаемых методов склонения приведён в таблице ниже.

Определение пола

Примеры:

Petrovich(
  lastname: 'Склифасовский'
).gender # => :male

Petrovich(
  firstname: 'Александра',
  lastname: 'Склифасовская'
).female? # => true

Petrovich(
  lastname: 'Склифасовский'
).male? # => true

Petrovich(
  firstname: 'Саша',
  lastname: 'Андрейчук'
).androgynous? # => true

Petrovich(
  firstname: 'Саша',
  lastname: 'Андрейчук'
  gender: :male,
).male? # => true

Интерфейс командной строки

Примеры вызовов:

petrovich -l Иванов -f Иван -m Иванович -g male -c accusative
petrovich -l Иванов -f Иван -m Иванович -c accusative -n
petrovich -l Иванов -f Иван -m Иванович -c accusative -o

Подробное руководство: petrovich --help.

Модульные тесты

Для запуска тестов достаточно выполнить команду rake. Чтобы запустить тесты "аккуратности" по словарю фамилий, выполните команду rake evaluate, после выполнения вы увидите подробный отчёт.

Разработчики

• Андрей Козлов
• Дмитрий Усталов

Благодарности

Эта библиотека не была бы столь замечательна без содействия Павла Скрылёва, Никиты Помящего, Игоря Бочкарёва, и других хороших людей.

Отдельная благодарность Андрею Бильжо за то, что разрешил нам использовать персонаж Петровича в нашем логотипе.

Портирование

Существуют официальные порты Petrovich на другие языке и платформы. Их список доступен по адресу https://github.com/petrovich. Ребята, спасибо!

Содействие

Если вы нашли баги как программной части, так и в базе правил, то вы всегда можете форкнуть репозиторий и внести необходимые изменения. Ваша помощь не останется незамеченной! Если вы заметили ошибки при склонении падежей имён, фамилий или отчеств, можете написать об этом в Issues на GitHub. Проблема будет сразу же исследована и, по возможности, решена.

Не стесняйтесь добавлять улучшения.

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