модуль ActionView::RecordIdentifier

RecordIdentifier инкапсулирует методы, используемые различными помощниками ActionView для сопоставления записей с элементами DOM.

Рассмотрим, например, следующий код формы для поста:

<%= form_for(post) do |f| %>
  <%= f.text_field :body %>
<% end %>

Когда post является новым, несохранённым экземпляром ActiveRecord::Base, результирующий HTML выглядит так:

<form class="new_post" id="new_post" action="/posts" accept-charset="UTF-8" method="post">
  <input type="text" name="post[body]" id="post_body" />
</form>

Когда post является сохранённым экземпляром ActiveRecord::Base, результирующий HTML выглядит так:

<form class="edit_post" id="edit_post_42" action="/posts/42" accept-charset="UTF-8" method="post">
  <input type="text" value="What a wonderful world!" name="post[body]" id="post_body" />
</form>

В обоих случаях, id и class обертывающего элемента DOM автоматически генерируются, следуя соглашениям об именовании, инкапсулированным методами RecordIdentifier dom_id и dom_class:

dom_id(Post.new)         # => "new_post"
dom_class(Post.new)      # => "post"
dom_id(Post.find 42)     # => "post_42"
dom_class(Post.find 42)  # => "post"

Обратите внимание, что эти методы не строго требуют, чтобы Post был подклассом ActiveRecord::Base. Любой Post класс будет работать, если его экземпляры реагируют на to_key и model_name, при условии, что model_name реагирует на param_key. Например:

class Post
  attr_accessor :to_key

  def model_name
    OpenStruct.new param_key: 'post'
  end

  def self.find(id)
    new.tap { |post| post.to_key = [id] }
  end
end

Константы

JOIN
NEW

Публичные методы экземпляра

dom_class(record_or_class, prefix = nil) Показать исходный код

# File actionview/lib/action_view/record_identifier.rb, line 72
def dom_class(record_or_class, prefix = nil)
  singular = model_name_from_record_or_class(record_or_class).param_key
  prefix ? "#{prefix}#{JOIN}#{singular}" : singular
end

Соглашение для класса DOM — использовать единственное число объекта или класса.

dom_class(post)   # => "post"
dom_class(Person) # => "person"

Если вам нужно обращаться к нескольким экземплярам одного класса в одном представлении, вы можете добавить префикс к #dom_class:

dom_class(post, :edit)   # => "edit_post"
dom_class(Person, :edit) # => "edit_person"

dom_id(record, prefix = nil) Показать исходный код

# File actionview/lib/action_view/record_identifier.rb, line 87
def dom_id(record, prefix = nil)
  if record_id = record_key_for_dom_id(record)
    "#{dom_class(record, prefix)}#{JOIN}#{record_id}"
  else
    dom_class(record, prefix || NEW)
  end
end

Соглашение для идентификатора DOM — использовать единственное число объекта или класса с идентификатором, идущим после нижнего подчёркивания. Если идентификатор не найден, использовать префикс «new_».

dom_id(Post.find(45))       # => "post_45"
dom_id(Post.new)            # => "new_post"

Если вам нужно обращаться к нескольким экземплярам одного класса в одном представлении, вы можете добавить префикс к #dom_id:

dom_id(Post.find(45), :edit) # => "edit_post_45"
dom_id(Post.new, :custom)    # => "custom_post"

Приватные методы экземпляра

record_key_for_dom_id(record) Показать исходный код

# File actionview/lib/action_view/record_identifier.rb, line 105
def record_key_for_dom_id(record) # :doc:
  key = convert_to_model(record).to_key
  key ? key.join(JOIN) : key
end

Возвращает строковое представление атрибута(ов) ключа, пригодного для использования в идентификаторе HTML DOM. Этот метод можно переопределить для настройки стандартного строкового представления, если необходимо. Если вам нужно считать ключ из #dom_id для запроса к исходной записи базы данных, вы должны написать помощник типа 'person_record_from_dom_id', который извлечёт ключ, либо на основе стандартной реализации (которая просто объединяет все атрибуты ключа с помощью «_»), либо на основе вашего переопределённого метода. По умолчанию эта реализация передаёт строку ключа через метод, который заменяет все символы, недопустимые в идентификаторах DOM, на допустимые. Вы должны самостоятельно убедиться, что ваши идентификаторы DOM допустимы, в случае переопределения этого метода.