Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shlima/translate_enum
Easily Translate Enums in Rails
https://github.com/shlima/translate_enum
enum i18n rails
Last synced: about 4 hours ago
JSON representation
Easily Translate Enums in Rails
- Host: GitHub
- URL: https://github.com/shlima/translate_enum
- Owner: shlima
- License: mit
- Created: 2017-03-07T13:30:14.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-11-13T15:04:55.000Z (about 2 years ago)
- Last Synced: 2024-11-07T22:51:20.502Z (7 days ago)
- Topics: enum, i18n, rails
- Language: Ruby
- Homepage:
- Size: 29.3 KB
- Stars: 121
- Watchers: 5
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
[](https://codeclimate.com/github/shlima/translate_enum)
[](https://rubygems.org/gems/translate_enum)
# TranslateEnum
Simple, zero-dependant `enum` translation gem for Rails
## Installation
`gem install translate_enum`
## Usage
Here is a regular use case. ActiveRecord model:
```ruby
class Post < ActiveRecord::Base
include TranslateEnum
enum status: { published: 0, archive: 1 }
translate_enum :status
end
```
Localization file
```yaml
en:
activerecord:
attributes:
post:
status_list:
published: Was published
archive: Was archived
```
Or if you wish your locales to be available across all models
```yaml
en:
attributes:
status_list:
published: Was published
archive: Was archived
```
```ruby
Post.translated_status(:published) #=> "Was published"
Post.translated_statuses => [["Was published", :published, 0], ["Was archived", :archive, 1]]
@post = Post.new(status: :published)
@post.translated_status #=> "Was published"
# Each `translated` method supports
# I18n.translate attributes:
Post.translated_status(:published, raise: true, throw: true, locale: :en, count: 10)
```
### Use in a Form
```haml
= form_for @post do |f|
= f.select :status, options_for_select(f.object.class.translated_statuses.map { |translation, k, _v| [translation, k] })
```
## Extending ActiveRecord
Be default you should extend each `ActiveRecord` model manually by including `TranslateEnum` module in it.
You can extend `ActiveRecord` by requiring `translate_enum/active_record` in initializer or inside yout `Gemfile`:
Gemfile:
```ruby
gem 'translate_enum', require: 'translate_enum/active_record'
```
Initializer:
```ruby
# config/initializers/translate_enum.rb
require 'translate_enum/active_record'
```
## Advanced options
```ruby
class User < ActiveRecord::Base
enum gender: [:male, :female]
translate_enum :gender do |tr|
tr.i18n_scope = 'activerecord.attributes'
tr.i18n_key = 'gender_list'
tr.enum_klass_method_name = 'genders'
tr.enum_instance_method_name = 'gender'
tr.method_name_singular = 'translated_gender'
tr.method_name_plural = 'translated_genders'
end
# Or even provide your own logic
def self.translated_gender(key)
I18n.t(key, scope: 'global.gender_list')
end
end
```
# How To?
## How to use pluralization
```yaml
en:
activerecord:
attributes:
person:
gender_list:
male:
zero: No males
one: One male
other: %{count} males
```
```ruby
Person.translated_gender(:make, count: 0) #=> "No males"
Person.translated_genders => [["One male", :male, 0]] # and others
Person.translated_genders(count: 0) => [["No males", :male, 0]] # and others
@person = Person.new(gender: :male)
@person.translated_gender #=> "One male"
@person.translated_gender(count: 10) #=> "10 Males"
```
## How use translate enum in serializer
Example for Grape:
```ruby
class Feedback < ApplicationRecord
include TranslateEnum
enum topic: {
question: 'question', issue: 'issue', complaint: 'complaint', offer: 'offer',
investment: 'investment'
}
translate_enum :topic
end
```
```ruby
class FeedbacksApi < Grape::API
resource :feedbacks do
get 'enums' do
present Feedback.method(:translated_topics), with: TranslateEnumSerializer
end
end
end
```
```ruby
class TranslateEnumSerializer < Grape::Entity
expose :enum, as: ->(method) { method.name[/translated_(.*)/, 1] } do |method|
method.call.map do |translation, key, _value|
{ value: key, translation: translation }
end
end
end
```
```bash
curl http://localhost:3000/feedbacks/enums
```
```json
{
"topics": [
{
"value": "question",
"translation": "Vopros"
},
{
"value": "issue",
"translation": "Problema"
},
{
"value": "complaint",
"translation": "Zhaloba"
},
{
"value": "offer",
"translation": "Predlozhenie"
},
{
"value": "investment",
"translation": "Invisticii"
}
]
}
```