Railsのform helper周りのコードリーディングをしました。Railsのバージョンは5.1.5です。
今回はこのパターンを追ってみます。
<%= form_with url: hoge_path, model: @model do |f| %>
<%= f.label :email %>
<%= f.text_field :email %>
<% end %>
#form_withはActionView::Helpers::FormHelperに定義されています。
module ActionView
module Helpers
module FormHelper
def form_with(model: nil, scope: nil, url: nil, format: nil, **options)
options[:allow_method_names_outside_object] = true
options[:skip_default_ids] = true
if model
url ||= polymorphic_path(model, format: format)
model = model.last if model.is_a?(Array)
scope ||= model_name_from_record_or_class(model).param_key
end
if block_given?
builder = instantiate_builder(scope, model, options)
output = capture(builder, &Proc.new)
options[:multipart] ||= builder.multipart?
html_options = html_options_for_form_with(url, model, options)
form_tag_with_body(html_options, output)
else
html_options = html_options_for_form_with(url, model, options)
form_tag_html(html_options)
end
end
blockが渡されているのでblock_given?はtrueになります。builderは特に設定されていなければ::ActionView::Helpers::FormBuilderのインスタンスになります。default_form_builderのデフォルト値はlib/action_view/helpers/form_helper.rbに定義されています。
ActiveSupport.on_load(:action_view) do
cattr_accessor(:default_form_builder, instance_writer: false, instance_reader: false) do
::ActionView::Helpers::FormBuilder
end
end
#form_tag_with_bodyは#form_tag_htmlを呼び出し、#form_tag_htmlとcontentとを連結して返します。
def form_tag_with_body(html_options, content)
output = form_tag_html(html_options)
output << content
output.safe_concat("</form>")
end
def form_tag_html(html_options)
extra_tags = extra_tags_for_form(html_options)
tag(:form, html_options, true) + extra_tags
end
def extra_tags_for_form(html_options)
authenticity_token = html_options.delete("authenticity_token")
method = html_options.delete("method").to_s.downcase
method_tag = \
case method
when "get"
html_options["method"] = "get"
""
when "post", ""
html_options["method"] = "post"
token_tag(authenticity_token, form_options: {
action: html_options["action"],
method: "post"
})
else
html_options["method"] = "post"
method_tag(method) + token_tag(authenticity_token, form_options: {
action: html_options["action"],
method: method
})
end
if html_options.delete("enforce_utf8") { true }
utf8_enforcer_tag + method_tag
else
method_tag
end
end
#extra_tags_for_formはUTF8用のタグ、メソッドタグ（HTML的にはformからはPOSTとGETしか打てないので、DELETEやPUTなどのメソッドを呼び出すように_methodのクエリパラメータを入れてRailsにメソッドを認識させる）、CSRF用のトークンのタグを生成しています。
#tagはタグを生成します。tag_builderはActionView::Helpers::TagHelper::TagBuilderのインスタンスで#tag_optionsでoptionsからよしなにタグの属性値を出力します。
module ActionView
module Helpers #:nodoc:
module TagHelper
def tag(name = nil, options = nil, open = false, escape = true)
if name.nil?
tag_builder
else
"<#{name}#{tag_builder.tag_options(options, escape) if options}#{open ? ">" : " />"}".html_safe
end
end
formの中身はActionView::Helpers::CaptureHelper#captureで生成します。
module ActionView
module Helpers
module CaptureHelper
def capture(*args)
value = nil
buffer = with_output_buffer { value = yield(*args) }
if (string = buffer.presence || value) && string.is_a?(String)
ERB::Util.html_escape string
end
end
yieldの引数はbuilderなので |f|で指定する変数はFormBuilderのインスタンスになります。
ActionView::Helpers::FormBuilder#labelは@template.labelを呼び出します。
def label(method, text = nil, options = {}, &block)
@template.label(@object_name, method, text, objectify_options(options), &block)
end
@templateはviewの実行コンテキストで最終的にActionView::Helpers::FormHelper#labelが呼ばれます。
def label(object_name, method, content_or_options = nil, options = nil, &block)
Tags::Label.new(object_name, method, self, content_or_options, options).render(&block)
end
AtionView::Helpers::Tags::Label#renderがlabelのタグを生成している部分になります。
text_fieldはclass_evalで定義されたメソッド経由で@templateのtext_fieldメソッドを呼び出します。
(field_helpers - [:label, :check_box, :radio_button, :fields_for, :fields, :hidden_field, :file_field]).each do |selector|
class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
def #{selector}(method, options = {}) # def text_field(method, options = {})
@template.send( # @template.send(
#{selector.inspect}, # "text_field",
@object_name, # @object_name,
method, # method,
objectify_options(options)) # objectify_options(options))
end # end
RUBY_EVAL
end
text_fieldメソッドはlabelと同じような感じでActionView::Helpers::Tags::TextField#renderによってinputタグが生成されます。
module ActionView
module Helpers
module Tags # :nodoc:
class TextField < Base # :nodoc:
include Placeholderable
def render
options = @options.stringify_keys
options["size"] = options["maxlength"] unless options.key?("size")
options["type"] ||= field_type
options["value"] = options.fetch("value") { value_before_type_cast(object) } unless field_type == "file"
add_default_name_and_id(options)
tag("input", options)
end
class << self
def field_type
@field_type ||= name.split("::").last.sub("Field", "").downcase
end
end
private
def field_type
self.class.field_type
end
end
end
end
end
ちなみにinputタグのnameはActionView::Helpers::Tags::Base#tag_nameで生成されます。
module ActionView
module Helpers
module Tags # :nodoc:
class Base # :nodoc:
private
def tag_name(multiple = false, index = nil)
# a little duplication to construct less strings
case
when @object_name.empty?
"#{sanitized_method_name}#{"[]" if multiple}"
when index
"#{@object_name}[#{index}][#{sanitized_method_name}]#{"[]" if multiple}"
else
"#{@object_name}[#{sanitized_method_name}]#{"[]" if multiple}"
end
end
