Class: ActionController::Responder

Inherits:
Object
  • Object
show all
Defined in:
actionpack/lib/action_controller/metal/responder.rb

Overview

Responder is responsible for exposing a resource to different mime requests, usually depending on the HTTP verb. The responder is triggered when respond_with is called. The simplest case to study is a GET request:

class PeopleController < ApplicationController
  respond_to :html, :xml, :json

  def index
    @people = Person.find(:all)
    respond_with(@people)
  end
end

When a request comes in, for example for an XML response, three steps happen:

1) the responder searches for a template at people/index.xml;

2) if the template is not available, it will invoke <code>#to_xml</code> on the given resource;

3) if the responder does not <code>respond_to :to_xml</code>, call <code>#to_format</code> on it.

Builtin HTTP verb semantics

The default Rails responder holds semantics for each HTTP verb. Depending on the content type, verb and the resource status, it will behave differently.

Using Rails default responder, a POST request for creating an object could be written as:

def create
  @user = User.new(params[:user])
  flash[:notice] = 'User was successfully created.' if @user.save
  respond_with(@user)
end

Which is exactly the same as:

def create
  @user = User.new(params[:user])

  respond_to do |format|
    if @user.save
      flash[:notice] = 'User was successfully created.'
      format.html { redirect_to(@user) }
      format.xml { render :xml => @user, :status => :created, :location => @user }
    else
      format.html { render :action => "new" }
      format.xml { render :xml => @user.errors, :status => :unprocessable_entity }
    end
  end
end

The same happens for PUT and DELETE requests.

Nested resources

You can supply nested resources as you do in form_for and polymorphic_url. Consider the project has many tasks example. The create action for TasksController would be like:

def create
  @project = Project.find(params[:project_id])
  @task = @project.comments.build(params[:task])
  flash[:notice] = 'Task was successfully created.' if @task.save
  respond_with(@project, @task)
end

Giving an array of resources, you ensure that the responder will redirect to project_task_url instead of task_url.

Namespaced and singleton resources require a symbol to be given, as in polymorphic urls. If a project has one manager which has many tasks, it should be invoked as:

respond_with(@project, :manager, @task)

Check polymorphic_url documentation for more examples.

Constant Summary

ACTIONS_FOR_VERBS =
{
  :post => :new,
  :put => :edit
}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(controller, resources, options = {}) ⇒ Responder

Returns a new instance of Responder



90
91
92
93
94
95
96
97
98
99
# File 'actionpack/lib/action_controller/metal/responder.rb', line 90

def initialize(controller, resources, options={})
  @controller = controller
  @request = @controller.request
  @format = @controller.formats.first
  @resource = resources.last
  @resources = resources
  @options = options
  @action = options.delete(:action)
  @default_response = options.delete(:default_response)
end

Instance Attribute Details

#controllerObject (readonly)

Returns the value of attribute controller



83
84
85
# File 'actionpack/lib/action_controller/metal/responder.rb', line 83

def controller
  @controller
end

#formatObject (readonly)

Returns the value of attribute format



83
84
85
# File 'actionpack/lib/action_controller/metal/responder.rb', line 83

def format
  @format
end

#optionsObject (readonly)

Returns the value of attribute options



83
84
85
# File 'actionpack/lib/action_controller/metal/responder.rb', line 83

def options
  @options
end

#requestObject (readonly)

Returns the value of attribute request



83
84
85
# File 'actionpack/lib/action_controller/metal/responder.rb', line 83

def request
  @request
end

#resourceObject (readonly)

Returns the value of attribute resource



83
84
85
# File 'actionpack/lib/action_controller/metal/responder.rb', line 83

def resource
  @resource
end

#resourcesObject (readonly)

Returns the value of attribute resources



83
84
85
# File 'actionpack/lib/action_controller/metal/responder.rb', line 83

def resources
  @resources
end

Class Method Details

.call(*args) ⇒ Object

Initializes a new responder an invoke the proper format. If the format is not defined, call to_format.



111
112
113
# File 'actionpack/lib/action_controller/metal/responder.rb', line 111

def self.call(*args)
  new(*args).respond
end

Instance Method Details

#respondObject

Main entry point for responder responsible to dispatch to the proper format.



117
118
119
120
# File 'actionpack/lib/action_controller/metal/responder.rb', line 117

def respond
  method = :to_#{format}"
  respond_to?(method) ? send(method) : to_format
end

#to_formatObject

All other formats follow the procedure below. First we try to render a template, if the template is not available, we verify if the resource responds to :to_format and display it.



135
136
137
138
139
# File 'actionpack/lib/action_controller/metal/responder.rb', line 135

def to_format
  default_render
rescue ActionView::MissingTemplate => e
  api_behavior(e)
end

#to_htmlObject

HTML format does not render the resource, it always attempt to render a template.



125
126
127
128
129
# File 'actionpack/lib/action_controller/metal/responder.rb', line 125

def to_html
  default_render
rescue ActionView::MissingTemplate => e
  navigation_behavior(e)
end