Class: ActionController::Responder

Inherits:
Object
  • Object
show all
Defined in:
lib/vendor/plugins/inherited_resources/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) respond_with searches for a template at people/index.xml;

2) if the template is not available, it will create a responder, passing
   the controller and the resource and invoke :to_xml on it;

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.

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.



84
85
86
87
88
89
90
91
92
 
# File 'lib/vendor/plugins/inherited_resources/lib/inherited_resources/legacy/responder.rb', line 84

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

Instance Attribute Details

#controller ⇒ Object (readonly)

Returns the value of attribute controller.



82
83
84
 
# File 'lib/vendor/plugins/inherited_resources/lib/inherited_resources/legacy/responder.rb', line 82

def controller
  @controller
end

#format ⇒ Object (readonly)

Returns the value of attribute format.



82
83
84
 
# File 'lib/vendor/plugins/inherited_resources/lib/inherited_resources/legacy/responder.rb', line 82

def format
  @format
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



82
83
84
 
# File 'lib/vendor/plugins/inherited_resources/lib/inherited_resources/legacy/responder.rb', line 82

def options
  @options
end

#request ⇒ Object (readonly)

Returns the value of attribute request.



82
83
84
 
# File 'lib/vendor/plugins/inherited_resources/lib/inherited_resources/legacy/responder.rb', line 82

def request
  @request
end

#resource ⇒ Object (readonly)

Returns the value of attribute resource.



82
83
84
 
# File 'lib/vendor/plugins/inherited_resources/lib/inherited_resources/legacy/responder.rb', line 82

def resource
  @resource
end

#resources ⇒ Object (readonly)

Returns the value of attribute resources.



82
83
84
 
# File 'lib/vendor/plugins/inherited_resources/lib/inherited_resources/legacy/responder.rb', line 82

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.



103
104
105
106
107
 
# File 'lib/vendor/plugins/inherited_resources/lib/inherited_resources/legacy/responder.rb', line 103

def self.call(*args)
  responder = new(*args)
  method = :"to_#{responder.format}"
  responder.respond_to?(method) ? responder.send(method) : responder.to_format
end

Instance Method Details

#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.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/vendor/plugins/inherited_resources/lib/inherited_resources/legacy/responder.rb', line 128

def to_format
  default_render
rescue ActionView::MissingTemplate
  raise unless resourceful?

  if get?
    display resource
  elsif has_errors?
    display resource.errors, :status => :unprocessable_entity
  elsif post?
    display resource, :status => :created, :location => resource_location
  else
    head :ok
  end
end

#to_html ⇒ Object

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



112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/vendor/plugins/inherited_resources/lib/inherited_resources/legacy/responder.rb', line 112

def to_html
  default_render
rescue ActionView::MissingTemplate
  if get?
    raise
  elsif has_errors?
    render :action => default_action
  else
    redirect_to resource_location
  end
end