2017-07-24 16:20:53 -04:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2016-08-06 12:51:43 -04:00
|
|
|
require "abstract_controller/collector"
|
2010-01-23 04:23:06 -05:00
|
|
|
|
2006-03-10 20:23:29 -05:00
|
|
|
module ActionController #:nodoc:
|
2011-04-08 14:56:38 -04:00
|
|
|
module MimeResponds
|
2009-05-20 18:33:08 -04:00
|
|
|
# Without web-service support, an action which collects the data for displaying a list of people
|
|
|
|
# might look something like this:
|
|
|
|
#
|
|
|
|
# def index
|
2010-12-18 22:14:02 -05:00
|
|
|
# @people = Person.all
|
2009-05-20 18:33:08 -04:00
|
|
|
# end
|
|
|
|
#
|
2018-08-24 16:10:17 -04:00
|
|
|
# That action implicitly responds to all formats, but formats can also be explicitly enumerated:
|
2016-01-21 02:39:46 -05:00
|
|
|
#
|
|
|
|
# def index
|
|
|
|
# @people = Person.all
|
|
|
|
# respond_to :html, :js
|
|
|
|
# end
|
|
|
|
#
|
2009-05-20 18:33:08 -04:00
|
|
|
# Here's the same action, with web-service support baked in:
|
|
|
|
#
|
|
|
|
# def index
|
2010-12-18 22:14:02 -05:00
|
|
|
# @people = Person.all
|
2009-05-20 18:33:08 -04:00
|
|
|
#
|
|
|
|
# respond_to do |format|
|
|
|
|
# format.html
|
2016-01-21 02:39:46 -05:00
|
|
|
# format.js
|
2012-10-27 16:05:27 -04:00
|
|
|
# format.xml { render xml: @people }
|
2009-05-20 18:33:08 -04:00
|
|
|
# end
|
|
|
|
# end
|
|
|
|
#
|
2016-01-21 02:39:46 -05:00
|
|
|
# What that says is, "if the client wants HTML or JS in response to this action, just respond as we
|
2009-05-20 18:33:08 -04:00
|
|
|
# would have before, but if the client wants XML, return them the list of people in XML format."
|
|
|
|
# (Rails determines the desired response format from the HTTP Accept header submitted by the client.)
|
|
|
|
#
|
|
|
|
# Supposing you have an action that adds a new person, optionally creating their company
|
|
|
|
# (by name) if it does not already exist, without web-services, it might look like this:
|
|
|
|
#
|
|
|
|
# def create
|
2013-01-01 15:07:32 -05:00
|
|
|
# @company = Company.find_or_create_by(name: params[:company][:name])
|
2009-05-20 18:33:08 -04:00
|
|
|
# @person = @company.people.create(params[:person])
|
|
|
|
#
|
|
|
|
# redirect_to(person_list_url)
|
|
|
|
# end
|
|
|
|
#
|
|
|
|
# Here's the same action, with web-service support baked in:
|
|
|
|
#
|
|
|
|
# def create
|
|
|
|
# company = params[:person].delete(:company)
|
2013-01-01 15:07:32 -05:00
|
|
|
# @company = Company.find_or_create_by(name: company[:name])
|
2009-05-20 18:33:08 -04:00
|
|
|
# @person = @company.people.create(params[:person])
|
|
|
|
#
|
|
|
|
# respond_to do |format|
|
|
|
|
# format.html { redirect_to(person_list_url) }
|
|
|
|
# format.js
|
2012-10-27 16:05:27 -04:00
|
|
|
# format.xml { render xml: @person.to_xml(include: @company) }
|
2009-05-20 18:33:08 -04:00
|
|
|
# end
|
|
|
|
# end
|
|
|
|
#
|
2011-03-25 18:12:09 -04:00
|
|
|
# If the client wants HTML, we just redirect them back to the person list. If they want JavaScript,
|
|
|
|
# then it is an Ajax request and we render the JavaScript template associated with this action.
|
2009-05-20 18:33:08 -04:00
|
|
|
# Lastly, if the client wants XML, we render the created person as XML, but with a twist: we also
|
|
|
|
# include the person's company in the rendered XML, so you get something like this:
|
|
|
|
#
|
|
|
|
# <person>
|
|
|
|
# <id>...</id>
|
|
|
|
# ...
|
|
|
|
# <company>
|
|
|
|
# <id>...</id>
|
|
|
|
# <name>...</name>
|
|
|
|
# ...
|
|
|
|
# </company>
|
|
|
|
# </person>
|
|
|
|
#
|
|
|
|
# Note, however, the extra bit at the top of that action:
|
|
|
|
#
|
|
|
|
# company = params[:person].delete(:company)
|
2013-01-01 15:07:32 -05:00
|
|
|
# @company = Company.find_or_create_by(name: company[:name])
|
2009-05-20 18:33:08 -04:00
|
|
|
#
|
|
|
|
# This is because the incoming XML document (if a web-service request is in process) can only contain a
|
|
|
|
# single root-node. So, we have to rearrange things so that the request looks like this (url-encoded):
|
|
|
|
#
|
|
|
|
# person[name]=...&person[company][name]=...&...
|
|
|
|
#
|
|
|
|
# And, like this (xml-encoded):
|
|
|
|
#
|
|
|
|
# <person>
|
|
|
|
# <name>...</name>
|
|
|
|
# <company>
|
|
|
|
# <name>...</name>
|
|
|
|
# </company>
|
|
|
|
# </person>
|
|
|
|
#
|
|
|
|
# In other words, we make the request so that it operates on a single entity's person. Then, in the action,
|
|
|
|
# we extract the company data from the request, find or create the company, and then create the new person
|
|
|
|
# with the remaining data.
|
|
|
|
#
|
|
|
|
# Note that you can define your own XML parameter parser which would allow you to describe multiple entities
|
|
|
|
# in a single request (i.e., by wrapping them all in a single root node), but if you just go with the flow
|
|
|
|
# and accept Rails' defaults, life will be much easier.
|
|
|
|
#
|
|
|
|
# If you need to use a MIME type which isn't supported by default, you can register your own handlers in
|
2015-10-25 08:25:16 -04:00
|
|
|
# +config/initializers/mime_types.rb+ as follows.
|
2009-05-20 18:33:08 -04:00
|
|
|
#
|
|
|
|
# Mime::Type.register "image/jpg", :jpg
|
2009-07-29 06:18:03 -04:00
|
|
|
#
|
2018-08-25 05:11:01 -04:00
|
|
|
# +respond_to+ also allows you to specify a common block for different formats by using +any+:
|
2009-07-29 06:18:03 -04:00
|
|
|
#
|
|
|
|
# def index
|
2010-12-18 22:14:02 -05:00
|
|
|
# @people = Person.all
|
2009-07-29 06:18:03 -04:00
|
|
|
#
|
|
|
|
# respond_to do |format|
|
|
|
|
# format.html
|
|
|
|
# format.any(:xml, :json) { render request.format.to_sym => @people }
|
|
|
|
# end
|
|
|
|
# end
|
|
|
|
#
|
|
|
|
# In the example above, if the format is xml, it will render:
|
|
|
|
#
|
2012-10-27 16:05:27 -04:00
|
|
|
# render xml: @people
|
2009-07-29 06:18:03 -04:00
|
|
|
#
|
|
|
|
# Or if the format is json:
|
|
|
|
#
|
2012-10-27 16:05:27 -04:00
|
|
|
# render json: @people
|
2009-07-29 06:18:03 -04:00
|
|
|
#
|
2019-01-16 05:13:48 -05:00
|
|
|
# +any+ can also be used with no arguments, in which case it will be used for any format requested by
|
|
|
|
# the user:
|
|
|
|
#
|
|
|
|
# respond_to do |format|
|
|
|
|
# format.html
|
|
|
|
# format.any { redirect_to support_path }
|
|
|
|
# end
|
|
|
|
#
|
2013-12-03 05:17:01 -05:00
|
|
|
# Formats can have different variants.
|
|
|
|
#
|
|
|
|
# The request variant is a specialization of the request format, like <tt>:tablet</tt>,
|
2013-12-17 01:08:58 -05:00
|
|
|
# <tt>:phone</tt>, or <tt>:desktop</tt>.
|
2013-12-03 05:17:01 -05:00
|
|
|
#
|
|
|
|
# We often want to render different html/json/xml templates for phones,
|
|
|
|
# tablets, and desktop browsers. Variants make it easy.
|
|
|
|
#
|
|
|
|
# You can set the variant in a +before_action+:
|
|
|
|
#
|
2019-07-29 01:23:10 -04:00
|
|
|
# request.variant = :tablet if /iPad/.match?(request.user_agent)
|
2013-12-03 05:17:01 -05:00
|
|
|
#
|
|
|
|
# Respond to variants in the action just like you respond to formats:
|
|
|
|
#
|
|
|
|
# respond_to do |format|
|
2013-12-07 18:00:35 -05:00
|
|
|
# format.html do |variant|
|
|
|
|
# variant.tablet # renders app/views/projects/show.html+tablet.erb
|
|
|
|
# variant.phone { extra_setup; render ... }
|
|
|
|
# variant.none { special_setup } # executed only if there is no variant set
|
2013-12-03 05:17:01 -05:00
|
|
|
# end
|
|
|
|
# end
|
|
|
|
#
|
|
|
|
# Provide separate templates for each format and variant:
|
|
|
|
#
|
|
|
|
# app/views/projects/show.html.erb
|
|
|
|
# app/views/projects/show.html+tablet.erb
|
|
|
|
# app/views/projects/show.html+phone.erb
|
|
|
|
#
|
2013-12-12 05:02:06 -05:00
|
|
|
# When you're not sharing any code within the format, you can simplify defining variants
|
|
|
|
# using the inline syntax:
|
|
|
|
#
|
|
|
|
# respond_to do |format|
|
|
|
|
# format.js { render "trash" }
|
|
|
|
# format.html.phone { redirect_to progress_path }
|
|
|
|
# format.html.none { render "trash" }
|
|
|
|
# end
|
2014-08-17 14:54:09 -04:00
|
|
|
#
|
2015-10-25 08:25:16 -04:00
|
|
|
# Variants also support common +any+/+all+ block that formats have.
|
2013-12-24 10:53:10 -05:00
|
|
|
#
|
|
|
|
# It works for both inline:
|
|
|
|
#
|
|
|
|
# respond_to do |format|
|
2015-07-17 21:48:00 -04:00
|
|
|
# format.html.any { render html: "any" }
|
|
|
|
# format.html.phone { render html: "phone" }
|
2013-12-24 10:53:10 -05:00
|
|
|
# end
|
|
|
|
#
|
|
|
|
# and block syntax:
|
|
|
|
#
|
|
|
|
# respond_to do |format|
|
|
|
|
# format.html do |variant|
|
2015-07-17 21:48:00 -04:00
|
|
|
# variant.any(:tablet, :phablet){ render html: "any" }
|
|
|
|
# variant.phone { render html: "phone" }
|
2013-12-24 10:53:10 -05:00
|
|
|
# end
|
|
|
|
# end
|
2013-12-12 05:02:06 -05:00
|
|
|
#
|
2014-02-13 09:59:09 -05:00
|
|
|
# You can also set an array of variants:
|
|
|
|
#
|
|
|
|
# request.variant = [:tablet, :phone]
|
|
|
|
#
|
2017-03-11 08:17:44 -05:00
|
|
|
# This will work similarly to formats and MIME types negotiation. If there
|
2017-03-22 15:44:19 -04:00
|
|
|
# is no +:tablet+ variant declared, the +:phone+ variant will be used:
|
2014-02-13 09:59:09 -05:00
|
|
|
#
|
|
|
|
# respond_to do |format|
|
|
|
|
# format.html.none
|
|
|
|
# format.html.phone # this gets rendered
|
|
|
|
# end
|
2014-10-17 14:52:32 -04:00
|
|
|
def respond_to(*mimes)
|
2009-07-29 04:09:21 -04:00
|
|
|
raise ArgumentError, "respond_to takes either types or a block, never both" if mimes.any? && block_given?
|
2009-08-29 11:48:11 -04:00
|
|
|
|
2013-12-24 10:53:10 -05:00
|
|
|
collector = Collector.new(mimes, request.variant)
|
2014-10-17 14:52:32 -04:00
|
|
|
yield collector if block_given?
|
2009-08-29 10:18:37 -04:00
|
|
|
|
2014-08-16 16:24:08 -04:00
|
|
|
if format = collector.negotiate_format(request)
|
2019-04-17 02:37:16 -04:00
|
|
|
if media_type && media_type != format
|
2018-07-26 12:29:57 -04:00
|
|
|
raise ActionController::RespondToMismatchError
|
|
|
|
end
|
2013-09-09 11:32:39 -04:00
|
|
|
_process_format(format)
|
2015-09-08 17:57:33 -04:00
|
|
|
_set_rendered_content_type format
|
2014-08-16 16:24:08 -04:00
|
|
|
response = collector.response
|
2015-12-30 13:59:23 -05:00
|
|
|
response.call if response
|
2009-08-29 10:18:37 -04:00
|
|
|
else
|
2012-05-06 01:34:08 -04:00
|
|
|
raise ActionController::UnknownFormat
|
2009-08-29 10:18:37 -04:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2012-03-17 23:29:17 -04:00
|
|
|
# A container for responses available from the current controller for
|
|
|
|
# requests for different mime-types sent to a particular action.
|
2012-03-13 03:36:59 -04:00
|
|
|
#
|
2014-11-05 23:36:45 -05:00
|
|
|
# The public controller methods +respond_to+ may be called with a block
|
|
|
|
# that is used to define responses to different mime-types, e.g.
|
2012-03-13 03:36:59 -04:00
|
|
|
# for +respond_to+ :
|
|
|
|
#
|
|
|
|
# respond_to do |format|
|
|
|
|
# format.html
|
2012-10-27 16:05:27 -04:00
|
|
|
# format.xml { render xml: @people }
|
2012-03-13 03:36:59 -04:00
|
|
|
# end
|
|
|
|
#
|
|
|
|
# In this usage, the argument passed to the block (+format+ above) is an
|
|
|
|
# instance of the ActionController::MimeResponds::Collector class. This
|
|
|
|
# object serves as a container in which available responses can be stored by
|
|
|
|
# calling any of the dynamically generated, mime-type-specific methods such
|
|
|
|
# as +html+, +xml+ etc on the Collector. Each response is represented by a
|
|
|
|
# corresponding block if present.
|
|
|
|
#
|
|
|
|
# A subsequent call to #negotiate_format(request) will enable the Collector
|
|
|
|
# to determine which specific mime-type it should respond with for the current
|
|
|
|
# request, with this response then being accessible by calling #response.
|
|
|
|
class Collector
|
2010-01-23 04:23:06 -05:00
|
|
|
include AbstractController::Collector
|
2013-11-11 00:29:53 -05:00
|
|
|
attr_accessor :format
|
2009-07-28 09:49:59 -04:00
|
|
|
|
2013-12-24 10:53:10 -05:00
|
|
|
def initialize(mimes, variant = nil)
|
2013-11-11 00:29:53 -05:00
|
|
|
@responses = {}
|
2013-12-24 10:53:10 -05:00
|
|
|
@variant = variant
|
2013-12-10 05:46:50 -05:00
|
|
|
|
2015-10-05 01:14:04 -04:00
|
|
|
mimes.each { |mime| @responses[Mime[mime]] = nil }
|
2006-03-12 01:02:44 -05:00
|
|
|
end
|
2006-03-15 13:27:26 -05:00
|
|
|
|
|
|
|
def any(*args, &block)
|
2008-03-07 06:17:05 -05:00
|
|
|
if args.any?
|
|
|
|
args.each { |type| send(type, &block) }
|
|
|
|
else
|
2015-10-05 01:14:04 -04:00
|
|
|
custom(Mime::ALL, &block)
|
2008-03-07 06:17:05 -05:00
|
|
|
end
|
2006-06-02 00:38:28 -04:00
|
|
|
end
|
2009-07-29 03:36:29 -04:00
|
|
|
alias :all :any
|
2009-07-28 09:49:59 -04:00
|
|
|
|
|
|
|
def custom(mime_type, &block)
|
2010-11-22 15:47:47 -05:00
|
|
|
mime_type = Mime::Type.lookup(mime_type.to_s) unless mime_type.is_a?(Mime::Type)
|
2013-12-09 18:36:18 -05:00
|
|
|
@responses[mime_type] ||= if block_given?
|
|
|
|
block
|
|
|
|
else
|
2013-12-24 10:53:10 -05:00
|
|
|
VariantCollector.new(@variant)
|
2013-12-09 18:36:18 -05:00
|
|
|
end
|
2008-12-26 16:37:42 -05:00
|
|
|
end
|
2007-05-25 23:11:34 -04:00
|
|
|
|
2013-12-24 10:53:10 -05:00
|
|
|
def response
|
2015-10-05 01:14:04 -04:00
|
|
|
response = @responses.fetch(format, @responses[Mime::ALL])
|
2013-12-24 10:53:10 -05:00
|
|
|
if response.is_a?(VariantCollector) # `format.html.phone` - variant inline syntax
|
|
|
|
response.variant
|
|
|
|
elsif response.nil? || response.arity == 0 # `format.html` - just a format, call its block
|
2013-12-03 05:17:01 -05:00
|
|
|
response
|
2013-12-24 10:53:10 -05:00
|
|
|
else # `format.html{ |variant| variant.phone }` - variant block syntax
|
|
|
|
variant_collector = VariantCollector.new(@variant)
|
2014-02-13 09:59:09 -05:00
|
|
|
response.call(variant_collector) # call format block with variants collector
|
2013-12-24 10:53:10 -05:00
|
|
|
variant_collector.variant
|
2013-12-03 05:17:01 -05:00
|
|
|
end
|
2012-02-04 10:00:02 -05:00
|
|
|
end
|
|
|
|
|
|
|
|
def negotiate_format(request)
|
2013-11-11 00:29:53 -05:00
|
|
|
@format = request.negotiate_mime(@responses.keys)
|
2009-07-28 09:49:59 -04:00
|
|
|
end
|
2013-12-03 05:17:01 -05:00
|
|
|
|
2013-12-09 18:36:18 -05:00
|
|
|
class VariantCollector #:nodoc:
|
2013-12-24 10:53:10 -05:00
|
|
|
def initialize(variant = nil)
|
|
|
|
@variant = variant
|
2013-12-09 18:36:18 -05:00
|
|
|
@variants = {}
|
|
|
|
end
|
|
|
|
|
2013-12-24 10:53:10 -05:00
|
|
|
def any(*args, &block)
|
|
|
|
if block_given?
|
2016-08-16 03:30:11 -04:00
|
|
|
if args.any? && args.none? { |a| a == @variant }
|
|
|
|
args.each { |v| @variants[v] = block }
|
2013-12-24 10:53:10 -05:00
|
|
|
else
|
|
|
|
@variants[:any] = block
|
|
|
|
end
|
|
|
|
end
|
2013-12-09 18:36:18 -05:00
|
|
|
end
|
2013-12-24 10:53:10 -05:00
|
|
|
alias :all :any
|
2013-12-09 18:36:18 -05:00
|
|
|
|
2013-12-24 10:53:10 -05:00
|
|
|
def method_missing(name, *args, &block)
|
|
|
|
@variants[name] = block if block_given?
|
2013-12-03 05:17:01 -05:00
|
|
|
end
|
|
|
|
|
2013-12-24 10:53:10 -05:00
|
|
|
def variant
|
2015-02-13 23:41:19 -05:00
|
|
|
if @variant.empty?
|
2014-02-13 14:38:33 -05:00
|
|
|
@variants[:none] || @variants[:any]
|
2013-12-24 10:53:10 -05:00
|
|
|
else
|
2015-02-13 23:41:19 -05:00
|
|
|
@variants[variant_key]
|
2013-12-07 19:32:38 -05:00
|
|
|
end
|
2013-12-03 05:17:01 -05:00
|
|
|
end
|
2015-02-13 23:41:19 -05:00
|
|
|
|
|
|
|
private
|
|
|
|
def variant_key
|
|
|
|
@variant.find { |variant| @variants.key?(variant) } || :any
|
|
|
|
end
|
2013-12-03 05:17:01 -05:00
|
|
|
end
|
2006-03-10 20:23:29 -05:00
|
|
|
end
|
|
|
|
end
|
2007-10-02 01:32:14 -04:00
|
|
|
end
|