Skip to content

Commit

Permalink
Readme explained
Browse files Browse the repository at this point in the history
  • Loading branch information
tanraya committed Apr 27, 2013
1 parent cc686a9 commit 86a4bd6
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@

$ gem install petrovich

## Зависимость ruby
## Зависимоси

* Ruby >= 1.9.1
* Не зависит от Rails

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

Expand All @@ -34,11 +35,11 @@ p.firstname('Пётр', :dative) # => Петру
p.middlename('Сергеевич', :dative) # => Сергеевичу
```

Конструктор класса `Petrovich` принимает в качестве единственного аргумента пол. Пол может иметь значения `:male`, `:female` или `:both`. Последнее означает, что имя не склоняется по родам (обычно, это не нужно).
Конструктор класса `Petrovich` принимает пол в качестве единственного аргумента. Пол может иметь значения `:male`, `:female` или `:both`. Последнее означает, что имя не склоняется по родам. Обычно, не склоняются украинские фамилии, как например фамилия Симоненко, а так же фамилии, пришедшие в русский язык из европейских языков, например - Нельсон. Но всегда лучше, если пол вам известен и вы указываете его - так увеличивается вероятность правильного распознавания.

### Продвинутое использование

Вы можете подмешать модуль `Petrovich::Extension` в любой класс. Это особенно полезно при использовании `ActiveRecord` и подобных ORM.
Вы можете подмешать модуль `Petrovich::Extension` в любой класс. Это особенно полезно при использовании `ActiveRecord` и подобных ORM:

```ruby
class User < ActiveRecord::Base
Expand Down Expand Up @@ -116,10 +117,8 @@ person.my_firstname_dative # => Ивану
person.my_middlename_dative # => Олеговичу
person.my_lastname_dative # => Сафронову
```
Изначальное имя должно быть в именительнои падеже. Вы просто добавляете `_падеж` в конец имени оригинального метода и получаете нужное значение. Вот список суффиксов, которые вы можете добавить к имени оригинального метода, чтобы получить имя в нужном падаже:

Вы просто добавляете `_падеж` в конец имени оригинального метода и получаете нужное значение. Вот список суффиксов, которые вы можете добавить к имени оригинального метода, чтобы получить имя в нужном падаже:

* nominative - именительный
* genitive - родительный
* dative - дательный
* accusative - винительный
Expand All @@ -135,10 +134,10 @@ person.my_lastname_dative # => Сафронову

Мы планируем и далее улучшать этот проект. Поэтому, нам важен отклик от других разработчиков, использующих этот гем. Вот наши планы:

* Тесты на базу фамилий.
* Добавить debug-mode, чтобы видеть, какое именно правило применилось
* Cli-interface, чтобы работать с гемом из коммандной строки
* Веб-интерфейс для проверки имён (ф.и.о) и их логгирования, для улучшения правил распознавания.
* Больше тестов
* Проверка работы с mongoid и mongo-mapper

Если вы хотите помочь этому проекту, вы можете реализовать любой план из перечисленных выше. Но прежде свяжитесь с разработчиками, чтобы ваши и наши планы не пересекались.
Expand Down

0 comments on commit 86a4bd6

Please sign in to comment.