Simple, zero-dependant enum translation gem for Rails
gem install translate_enum
Here is a regular use case. ActiveRecord model:
class Post < ActiveRecord::Base
include TranslateEnum
enum status: { published: 0, archive: 1 }
translate_enum :status
endLocalization file
en:
activerecord:
attributes:
post:
status_list:
published: Was published
archive: Was archivedOr if you wish your locales to be available across all models
en:
attributes:
status_list:
published: Was published
archive: Was archivedPost.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)= form_for @post do |f|
= f.select :status, options_for_select(f.object.class.translated_statuses.map { |translation, k, _v| [translation, k] })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:
gem 'translate_enum', require: 'translate_enum/active_record'Initializer:
# config/initializers/translate_enum.rb
require 'translate_enum/active_record'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
enden:
activerecord:
attributes:
person:
gender_list:
male:
zero: No males
one: One male
other: %{count} males
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"Example for Grape:
class Feedback < ApplicationRecord
include TranslateEnum
enum topic: {
question: 'question', issue: 'issue', complaint: 'complaint', offer: 'offer',
investment: 'investment'
}
translate_enum :topic
endclass FeedbacksApi < Grape::API
resource :feedbacks do
get 'enums' do
present Feedback.method(:translated_topics), with: TranslateEnumSerializer
end
end
endclass 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
endcurl http://localhost:3000/feedbacks/enums{
"topics": [
{
"value": "question",
"translation": "Vopros"
},
{
"value": "issue",
"translation": "Problema"
},
{
"value": "complaint",
"translation": "Zhaloba"
},
{
"value": "offer",
"translation": "Predlozhenie"
},
{
"value": "investment",
"translation": "Invisticii"
}
]
}