Labelizer

add labels to enum

Installation

Add this line to your application's Gemfile:

gem 'labelizer'

And then execute:

$ bundle

Or install it yourself as:

$ gem install labelizer

Usage

# app/models/my_model.rb
class Customer < ApplicationModel
  enum registration_state: {
    starting: 0,
    confirming: 1,
    completed: 2,
  }

  include Labelizer

  labelize :registration_state, %w(label description color)
end

# config/locales/labelizer.ja.yml
ja:
  labelizer:
    customer:
      registration_state:
        starting:
          label: start
          description: registration starting...
          color: label label-info
        confirming:
          label: start
          description: registration confirming...
          color: label label-warning
        completed:
          label: start
          description: registration completed!!
          color: label label-success

# app/views/customers/show.html.erb
<% customer = Customer.find id %>

<%# status label %>
<span class="<%= customer.registration_state_color %>"><%= customer.registration_state_label %></span>

<% labels = customer.registration_state_labelized %>
<span class="<%= labels.color %>"><%= labels.label %></span>

<% labels = customer.labelized.registration_state %>
<span class="<%= labels.color %>"><%= labels.label %></span>

<% labels = customer.labelized[:registration_state] %>
<span class="<%= labels[:color] %>"><%= labels[:label] %></span>

<%# description %>
<ul>
  <% Customer.registration_state_labelized.each do |state,labels| %>
    <li><%= labels.label %> : <%= labels.description %></li>
  <% end %>
</ul>

<ul>
  <% Customer.labelized.registration_state.each do |state,labels| %>
    <li><%= labels.label %> : <%= labels.description %></li>
  <% end %>
</ul>

<ul>
  <% Customer.labelized[:registration_state].each do |state,labels| %>
    <li><%= labels[:label] %> : <%= labels[:description] %></li>
  <% end %>
</ul>

Customer.labelized[:unknown_attr] #=> KeyError
Customer.labelized[:registration_state]["unknown_state"] #=> KeyError
Customer.labelized[:registration_state]["starting"][:unknown_label_type] #=> KeyError

Converters

Convert label:

labelize :registration_state, %w(label description color), converter: {
  color: ->(value){
    # value : attribute value
    "label label-#{value}"
  },
}

ja:
  labelizer:
    customer:
      registration_state:
        starting:
          color: info

Customer.starting.last.color # => "label label-info"

default labels

ja:
  labelizer:
    color: ... # <= global default
    customer:
      color: ... # <= model default
      registration_state:
        color: ... # <= attribute default
        starting:
          color: ...

without enum

class Customer < ApplicationModel
  include Labelizer

  def self.registration_states
    ["starting", "confirming", "completed"]
  end

  labelize :registration_state, %w(label description color)
end

non string values

class Customer < ApplicationModel
  include Labelizer

  def self.is_checkeds
    [true,false]
  end
  def self.my_flags
    [1,2,3]
  end

  labelize :is_checked, %w(label)
  labelize :my_flag, %w(label)
end

ja:
  labelizer:
    customer:
      is_checked:
        "true":
          label: ...
        "false":
          label: ...
      my_flag:
        "1":
          label: ...
        "2":
          label: ...
        "3":
          label: ...

array value

class Customer < ApplicationModel
  include Labelizer

  def self.roles
    ["all", "admin", "user"]
  end

  labelize :roles, %w(label)

  serialize :roles
end

ja:
  labelizer:
    customer:
      roles:
        all:
          label: full access
        admin:
          label: admin access
        user:
          label: user access

customer = Customer.find id
customer.roles #=> ["admin","user"]

customer.roles_label #=> ["admin access", "user access"]

Customer.labelizes.roles.admin.label #=> "admin access"
Customer.labelizes.roles[["admin","user"]].label #=> ["admin access", "user access"]

nested class

class Namespace::Customer < ApplicationModel
  include Labelizer

  enum state: {
    starting: 0,
  }

  labelize :state, %w(label)
end

ja:
  labelizer:
    namespace/customer:
      state:
        starting:
          label: start

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/getto-systems/labelizer.

License

The gem is available as open source under the terms of the MIT License.