Rails 5 I18n Enum Display Helper

in Software on May 11, 2019 | Ruby Rails I18n

Following the guide over at Rubyonrails.org, we can use human_attribute_name to help us translate our enum names for the view/display.

Suppose you have a Member model like this one:

class Member < ApplicationRecord
  enum role: %i[user vip admin]
end

Add the following to your config/locales/en.yml

en:
  activerecord:
    attributes:
      member/role:
        user: User
        vip: Very Important Person
        admin: Administrator

And this to your config/locales/pirate.yml

pirate:
  activerecord:
    attributes:
      member/role:
        user: Crew
        vip: First Mate
        admin: Captain

Now in our code we can use Member.human_attribute_name('role.vip') to obtain First Mate when using the pirate locale.

You can create this EnumDisplayHelper to clean this up just a little more:

module EnumDisplayHelper
  # enum_display(Member, :role)
  # enum_display(Member, :role, :vip)
  # enum_display(Member.find(1), :role)
  # Returns the translated enum_attr for a particular class and value
  def enum_display(klass, enum_attr, value = nil)
    if (!klass.is_a? Class)
      value = klass.send(enum_attr)
      klass = klass.class
    end
    klass.human_attribute_name([enum_attr, value].join('.'))
  end

  # enum_options_for_select(Member, :role)
  # Returns an array of enum translations and their raw versions for use
  # in select_tag
  def enum_options_for_select(klass, enum)
    klass.send(enum.to_s.pluralize).map do |key, _|
      [enum_display(klass, enum, key), key]
    end
  end
end

Thank you

Your comment has been submitted and will be published once it has been approved.

OOPS!

Your comment has not been submitted. Please go back and try again. Thank You!

If this error persists, please open an issue by clicking here.

Say something