ActionController#respond_to - code reading
requestのMIME TYPEに応じたレスポンスを定義する機能
定義は
rails/mime_responds.rb at 48f140cf7459c963a54637c897448b959dbbfd26 · rails/rails · GitHub
ActionController:: MimeResponds#respond_to
def respond_to(*mimes) raise ArgumentError, "respond_to takes either types or a block, never both" if mimes.any? && block_given? collector = Collector.new(mimes, request.variant) yield collector if block_given? if format = collector.negotiate_format(request) _process_format(format) _set_rendered_content_type format response = collector.response response.call if response else raise ActionController::UnknownFormat end end
Collectorを生成して、blockが与えられている場合は、collector を yield させる。
なので、よくある下記のようなコードのformatの中身はCollectorのインスタンス。
respond_to do |format| if @kihu.save format.html { redirect_to @kihu, notice: 'Kihu was successfully created.' } format.json { render :show, status: :created, location: @kihu } else format.html { render :new } format.json { render json: @kihu.errors, status: :unprocessable_entity } end end
与えられたブロックの処理を通した後に、negotiate_formatで返信すべきMIMEタイプを取得し、
collector.responseでレスポンスを生成するProcを取得し、実行している。
ActionController:: MimeResponds::Collector
いわゆるformatの実態で、respond_toで渡されるブロックで定義されるMIMEタイプごとの処理を保持する。
format.html を呼び出した場合、includeされているAbstractController::Collectorで定義されているmethod_missingを通して、下記の処理が呼び出され、mimeタイプの名前のメソッドが作成され、実行される。
# AbstractController::Collector. generate_method_for_mimeを実行し、呼び出している。 def method_missing(symbol, &block) unless mime_constant = Mime[symbol] raise NoMethodError, "To respond to a custom format, register it as a MIME type first: " \ "http://guides.rubyonrails.org/action_controller_overview.html#restful-downloads. " \ "If you meant to respond to a variant like :tablet or :phone, not a custom format, " \ "be sure to nest your variant response within a format response: " \ "format.html { |html| html.tablet { ... } }" end if Mime::SET.include?(mime_constant) AbstractController::Collector.generate_method_for_mime(mime_constant) send(symbol, &block) else super end end
rails/collector.rb at 565094a8b5cdfa158fef6ae75252fd98a4ba8fe4 · rails/rails · GitHub
def self.generate_method_for_mime(mime) sym = mime.is_a?(Symbol) ? mime : mime.to_sym class_eval <<-RUBY, __FILE__, __LINE__ + 1 def #{sym}(*args, &block) custom(Mime[:#{sym}], *args, &block) end RUBY end
customを実行するメソッドを定義している。
custom内では、@responses[mime_type]にレスポンス処理をするProcを保管。
blockが与えられていない場合、VariantCollectorを生成して保管しているが、この辺りはよくわからないので後回し。
def custom(mime_type, &block) mime_type = Mime::Type.lookup(mime_type.to_s) unless mime_type.is_a?(Mime::Type) @responses[mime_type] ||= if block_given? block else VariantCollector.new(@variant) end end
上記で保持されたProcが、#responseで返され、#respond_to内で呼び出される。