Class: ActionController::MimeResponds::Collector
- Inherits:
-
Object
- Object
- ActionController::MimeResponds::Collector
- Includes:
- AbstractController::Collector
- Defined in:
- lib/action_controller/metal/mime_responds.rb
Overview
A container for responses available from the current controller for requests for different mime-types sent to a particular action.
The public controller methods respond_with
and respond_to
may be called with a block that is used to define responses to different mime-types, e.g. for respond_to
:
respond_to do |format|
format.html
format.xml { render xml: @people }
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.
Defined Under Namespace
Classes: VariantCollector
Instance Attribute Summary collapse
-
#format ⇒ Object
Returns the value of attribute format.
Instance Method Summary collapse
- #any(*args, &block) ⇒ Object (also: #all)
- #custom(mime_type, &block) ⇒ Object
-
#initialize(mimes, variant = nil) ⇒ Collector
constructor
A new instance of Collector.
- #negotiate_format(request) ⇒ Object
- #response ⇒ Object
Methods included from AbstractController::Collector
Constructor Details
#initialize(mimes, variant = nil) ⇒ Collector
Returns a new instance of Collector.
470 471 472 473 474 475 |
# File 'lib/action_controller/metal/mime_responds.rb', line 470 def initialize(mimes, variant = nil) @responses = {} @variant = variant mimes.each { |mime| @responses["Mime::#{mime.upcase}".constantize] = nil } end |
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class AbstractController::Collector
Instance Attribute Details
#format ⇒ Object
Returns the value of attribute format.
468 469 470 |
# File 'lib/action_controller/metal/mime_responds.rb', line 468 def format @format end |
Instance Method Details
#any(*args, &block) ⇒ Object Also known as: all
477 478 479 480 481 482 483 |
# File 'lib/action_controller/metal/mime_responds.rb', line 477 def any(*args, &block) if args.any? args.each { |type| send(type, &block) } else custom(Mime::ALL, &block) end end |
#custom(mime_type, &block) ⇒ Object
486 487 488 489 490 491 492 493 |
# File 'lib/action_controller/metal/mime_responds.rb', line 486 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 |
#negotiate_format(request) ⇒ Object
508 509 510 |
# File 'lib/action_controller/metal/mime_responds.rb', line 508 def negotiate_format(request) @format = request.negotiate_mime(@responses.keys) end |
#response ⇒ Object
495 496 497 498 499 500 501 502 503 504 505 506 |
# File 'lib/action_controller/metal/mime_responds.rb', line 495 def response response = @responses.fetch(format, @responses[Mime::ALL]) 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 response else # `format.html{ |variant| variant.phone }` - variant block syntax variant_collector = VariantCollector.new(@variant) response.call(variant_collector) # call format block with variants collector variant_collector.variant end end |