Class: ActionController::Responder
- Inherits:
-
Object
- Object
- ActionController::Responder
- Defined in:
- lib/inherited_resources/legacy/responder.rb
Overview
Responder is responsible to expose a resource for 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, for example with format :xml, three steps happen:
1) responder searches for a template at people/index.xml;
2) if the template is not available, it will invoke :to_xml in the given resource;
3) if the responder does not respond_to :to_xml, call :to_format on it.
Builtin HTTP verb semantics
Rails default 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 given nested resource 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 requires 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.
Direct Known Subclasses
Constant Summary collapse
- ACTIONS_FOR_VERBS =
{ :post => :new, :put => :edit }
Instance Attribute Summary collapse
-
#controller ⇒ Object
readonly
Returns the value of attribute controller.
-
#format ⇒ Object
readonly
Returns the value of attribute format.
-
#options ⇒ Object
readonly
Returns the value of attribute options.
-
#request ⇒ Object
readonly
Returns the value of attribute request.
-
#resource ⇒ Object
readonly
Returns the value of attribute resource.
-
#resources ⇒ Object
readonly
Returns the value of attribute resources.
Class Method Summary collapse
-
.call(*args) ⇒ Object
Initializes a new responder an invoke the proper format.
Instance Method Summary collapse
-
#initialize(controller, resources, options = {}) ⇒ Responder
constructor
A new instance of Responder.
-
#respond ⇒ Object
Main entry point for responder responsible to dispatch to the proper format.
-
#to_format ⇒ Object
All others formats follow the procedure below.
-
#to_html ⇒ Object
HTML format does not render the resource, it always attempt to render a template.
Constructor Details
#initialize(controller, resources, options = {}) ⇒ Responder
Returns a new instance of Responder.
88 89 90 91 92 93 94 95 96 97 |
# File 'lib/inherited_resources/legacy/responder.rb', line 88 def initialize(controller, resources, ={}) @controller = controller @request = controller.request @format = controller.formats.first @resource = resources.is_a?(Array) ? resources.last : resources @resources = resources @options = @action = .delete(:action) @default_response = .delete(:default_response) end |
Instance Attribute Details
#controller ⇒ Object (readonly)
Returns the value of attribute controller.
81 82 83 |
# File 'lib/inherited_resources/legacy/responder.rb', line 81 def controller @controller end |
#format ⇒ Object (readonly)
Returns the value of attribute format.
81 82 83 |
# File 'lib/inherited_resources/legacy/responder.rb', line 81 def format @format end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
81 82 83 |
# File 'lib/inherited_resources/legacy/responder.rb', line 81 def @options end |
#request ⇒ Object (readonly)
Returns the value of attribute request.
81 82 83 |
# File 'lib/inherited_resources/legacy/responder.rb', line 81 def request @request end |
#resource ⇒ Object (readonly)
Returns the value of attribute resource.
81 82 83 |
# File 'lib/inherited_resources/legacy/responder.rb', line 81 def resource @resource end |
#resources ⇒ Object (readonly)
Returns the value of attribute resources.
81 82 83 |
# File 'lib/inherited_resources/legacy/responder.rb', line 81 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.
109 110 111 |
# File 'lib/inherited_resources/legacy/responder.rb', line 109 def self.call(*args) new(*args).respond end |
Instance Method Details
#respond ⇒ Object
Main entry point for responder responsible to dispatch to the proper format.
115 116 117 118 |
# File 'lib/inherited_resources/legacy/responder.rb', line 115 def respond method = :"to_#{format}" respond_to?(method) ? send(method) : to_format end |
#to_format ⇒ Object
All others 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.
133 134 135 136 137 138 |
# File 'lib/inherited_resources/legacy/responder.rb', line 133 def to_format default_render rescue ActionView::MissingTemplate => e raise unless resourceful? api_behavior(e) end |
#to_html ⇒ Object
HTML format does not render the resource, it always attempt to render a template.
123 124 125 126 127 |
# File 'lib/inherited_resources/legacy/responder.rb', line 123 def to_html default_render rescue ActionView::MissingTemplate => e (e) end |