require 'abstract_unit' require 'controller/fake_models' require 'active_support/core_ext/hash/conversions' class RespondToController < ActionController::Base layout :set_layout def html_xml_or_rss respond_to do |type| type.html { render :text => "HTML" } type.xml { render :text => "XML" } type.rss { render :text => "RSS" } type.all { render :text => "Nothing" } end end def js_or_html respond_to do |type| type.html { render :text => "HTML" } type.js { render :text => "JS" } type.all { render :text => "Nothing" } end end def json_or_yaml respond_to do |type| type.json { render :text => "JSON" } type.yaml { render :text => "YAML" } end end def html_or_xml respond_to do |type| type.html { render :text => "HTML" } type.xml { render :text => "XML" } type.all { render :text => "Nothing" } end end def json_xml_or_html respond_to do |type| type.json { render :text => 'JSON' } type.xml { render :xml => 'XML' } type.html { render :text => 'HTML' } end end def forced_xml request.format = :xml respond_to do |type| type.html { render :text => "HTML" } type.xml { render :text => "XML" } end end def just_xml respond_to do |type| type.xml { render :text => "XML" } end end def using_defaults respond_to do |type| type.html type.js type.xml end end def using_defaults_with_type_list respond_to(:html, :js, :xml) end def made_for_content_type respond_to do |type| type.rss { render :text => "RSS" } type.atom { render :text => "ATOM" } type.all { render :text => "Nothing" } end end def custom_type_handling respond_to do |type| type.html { render :text => "HTML" } type.custom("application/crazy-xml") { render :text => "Crazy XML" } type.all { render :text => "Nothing" } end end Mime::Type.register("text/x-mobile", :mobile) def custom_constant_handling respond_to do |type| type.html { render :text => "HTML" } type.mobile { render :text => "Mobile" } end end def custom_constant_handling_without_block respond_to do |type| type.html { render :text => "HTML" } type.mobile end end def handle_any respond_to do |type| type.html { render :text => "HTML" } type.any(:js, :xml) { render :text => "Either JS or XML" } end end def handle_any_any respond_to do |type| type.html { render :text => 'HTML' } type.any { render :text => 'Whatever you ask for, I got it' } end end def all_types_with_layout respond_to do |type| type.html type.js end end Mime::Type.register_alias("text/html", :iphone) def iphone_with_html_response_type request.format = :iphone if request.env["HTTP_ACCEPT"] == "text/iphone" respond_to do |type| type.html { @type = "Firefox" } type.iphone { @type = "iPhone" } end end def iphone_with_html_response_type_without_layout request.format = "iphone" if request.env["HTTP_ACCEPT"] == "text/iphone" respond_to do |type| type.html { @type = "Firefox"; render :action => "iphone_with_html_response_type" } type.iphone { @type = "iPhone" ; render :action => "iphone_with_html_response_type" } end end def rescue_action(e) raise end protected def set_layout if ["all_types_with_layout", "iphone_with_html_response_type"].include?(action_name) "respond_to/layouts/standard" elsif action_name == "iphone_with_html_response_type_without_layout" "respond_to/layouts/missing" end end end class RespondToControllerTest < ActionController::TestCase tests RespondToController def setup super @request.host = "www.example.com" end def teardown super end def test_html @request.accept = "text/html" get :js_or_html assert_equal 'HTML', @response.body get :html_or_xml assert_equal 'HTML', @response.body get :just_xml assert_response 406 end def test_all @request.accept = "*/*" get :js_or_html assert_equal 'HTML', @response.body # js is not part of all get :html_or_xml assert_equal 'HTML', @response.body get :just_xml assert_equal 'XML', @response.body end def test_xml @request.accept = "application/xml" get :html_xml_or_rss assert_equal 'XML', @response.body end def test_js_or_html @request.accept = "text/javascript, text/html" xhr :get, :js_or_html assert_equal 'JS', @response.body @request.accept = "text/javascript, text/html" xhr :get, :html_or_xml assert_equal 'HTML', @response.body @request.accept = "text/javascript, text/html" xhr :get, :just_xml assert_response 406 end def test_json_or_yaml xhr :get, :json_or_yaml assert_equal 'JSON', @response.body get :json_or_yaml, :format => 'json' assert_equal 'JSON', @response.body get :json_or_yaml, :format => 'yaml' assert_equal 'YAML', @response.body { 'YAML' => %w(text/yaml), 'JSON' => %w(application/json text/x-json) }.each do |body, content_types| content_types.each do |content_type| @request.accept = content_type get :json_or_yaml assert_equal body, @response.body end end end def test_js_or_anything @request.accept = "text/javascript, */*" xhr :get, :js_or_html assert_equal 'JS', @response.body xhr :get, :html_or_xml assert_equal 'HTML', @response.body xhr :get, :just_xml assert_equal 'XML', @response.body end def test_using_defaults @request.accept = "*/*" get :using_defaults assert_equal "text/html", @response.content_type assert_equal 'Hello world!', @response.body @request.accept = "text/javascript" get :using_defaults assert_equal "text/javascript", @response.content_type assert_equal '$("body").visualEffect("highlight");', @response.body @request.accept = "application/xml" get :using_defaults assert_equal "application/xml", @response.content_type assert_equal "

Hello world!

\n", @response.body end def test_using_defaults_with_type_list @request.accept = "*/*" get :using_defaults_with_type_list assert_equal "text/html", @response.content_type assert_equal 'Hello world!', @response.body @request.accept = "text/javascript" get :using_defaults_with_type_list assert_equal "text/javascript", @response.content_type assert_equal '$("body").visualEffect("highlight");', @response.body @request.accept = "application/xml" get :using_defaults_with_type_list assert_equal "application/xml", @response.content_type assert_equal "

Hello world!

\n", @response.body end def test_with_atom_content_type @request.accept = "" @request.env["CONTENT_TYPE"] = "application/atom+xml" xhr :get, :made_for_content_type assert_equal "ATOM", @response.body end def test_with_rss_content_type @request.accept = "" @request.env["CONTENT_TYPE"] = "application/rss+xml" xhr :get, :made_for_content_type assert_equal "RSS", @response.body end def test_synonyms @request.accept = "application/javascript" get :js_or_html assert_equal 'JS', @response.body @request.accept = "application/x-xml" get :html_xml_or_rss assert_equal "XML", @response.body end def test_custom_types @request.accept = "application/crazy-xml" get :custom_type_handling assert_equal "application/crazy-xml", @response.content_type assert_equal 'Crazy XML', @response.body @request.accept = "text/html" get :custom_type_handling assert_equal "text/html", @response.content_type assert_equal 'HTML', @response.body end def test_xhtml_alias @request.accept = "application/xhtml+xml,application/xml" get :html_or_xml assert_equal 'HTML', @response.body end def test_firefox_simulation @request.accept = "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5" get :html_or_xml assert_equal 'HTML', @response.body end def test_handle_any @request.accept = "*/*" get :handle_any assert_equal 'HTML', @response.body @request.accept = "text/javascript" get :handle_any assert_equal 'Either JS or XML', @response.body @request.accept = "text/xml" get :handle_any assert_equal 'Either JS or XML', @response.body end def test_handle_any_any @request.accept = "*/*" get :handle_any_any assert_equal 'HTML', @response.body end def test_handle_any_any_parameter_format get :handle_any_any, {:format=>'html'} assert_equal 'HTML', @response.body end def test_handle_any_any_explicit_html @request.accept = "text/html" get :handle_any_any assert_equal 'HTML', @response.body end def test_handle_any_any_javascript @request.accept = "text/javascript" get :handle_any_any assert_equal 'Whatever you ask for, I got it', @response.body end def test_handle_any_any_xml @request.accept = "text/xml" get :handle_any_any assert_equal 'Whatever you ask for, I got it', @response.body end def test_browser_check_with_any_any @request.accept = "application/json, application/xml" get :json_xml_or_html assert_equal 'JSON', @response.body @request.accept = "application/json, application/xml, */*" get :json_xml_or_html assert_equal 'HTML', @response.body end def test_rjs_type_skips_layout @request.accept = "text/javascript" get :all_types_with_layout assert_equal 'RJS for all_types_with_layout', @response.body end def test_html_type_with_layout @request.accept = "text/html" get :all_types_with_layout assert_equal '
HTML for all_types_with_layout
', @response.body end def test_xhr xhr :get, :js_or_html assert_equal 'JS', @response.body xhr :get, :using_defaults assert_equal '$("body").visualEffect("highlight");', @response.body end def test_custom_constant get :custom_constant_handling, :format => "mobile" assert_equal "text/x-mobile", @response.content_type assert_equal "Mobile", @response.body end def test_custom_constant_handling_without_block get :custom_constant_handling_without_block, :format => "mobile" assert_equal "text/x-mobile", @response.content_type assert_equal "Mobile", @response.body end def test_forced_format get :html_xml_or_rss assert_equal "HTML", @response.body get :html_xml_or_rss, :format => "html" assert_equal "HTML", @response.body get :html_xml_or_rss, :format => "xml" assert_equal "XML", @response.body get :html_xml_or_rss, :format => "rss" assert_equal "RSS", @response.body end def test_internally_forced_format get :forced_xml assert_equal "XML", @response.body get :forced_xml, :format => "html" assert_equal "XML", @response.body end def test_extension_synonyms get :html_xml_or_rss, :format => "xhtml" assert_equal "HTML", @response.body end def test_render_action_for_html @controller.instance_eval do def render(*args) @action = args.first[:action] unless args.empty? @action ||= action_name response.body = "#{@action} - #{formats}" end end get :using_defaults assert_equal "using_defaults - #{[:html].to_s}", @response.body get :using_defaults, :format => "xml" assert_equal "using_defaults - #{[:xml].to_s}", @response.body end def test_format_with_custom_response_type get :iphone_with_html_response_type assert_equal '
Hello future from Firefox!
', @response.body get :iphone_with_html_response_type, :format => "iphone" assert_equal "text/html", @response.content_type assert_equal '
Hello iPhone future from iPhone!
', @response.body end def test_format_with_custom_response_type_and_request_headers @request.accept = "text/iphone" get :iphone_with_html_response_type assert_equal '
Hello iPhone future from iPhone!
', @response.body assert_equal "text/html", @response.content_type end end class RespondWithController < ActionController::Base respond_to :html, :json respond_to :xml, :except => :using_resource_with_block respond_to :js, :only => [ :using_resource_with_block, :using_resource ] def using_resource respond_with(resource) end def using_resource_with_block respond_with(resource) do |format| format.csv { render :text => "CSV" } end end def using_resource_with_overwrite_block respond_with(resource) do |format| format.html { render :text => "HTML" } end end def using_resource_with_collection respond_with([resource, Customer.new("jamis", 9)]) end def using_resource_with_parent respond_with(Quiz::Store.new("developer?", 11), Customer.new("david", 13)) end def using_resource_with_status_and_location respond_with(resource, :location => "http://test.host/", :status => :created) end def using_resource_with_responder responder = proc { |c, r, o| c.render :text => "Resource name is #{r.first.name}" } respond_with(resource, :responder => responder) end def using_resource_with_action respond_with(resource, :action => :foo) do |format| format.html { raise ActionView::MissingTemplate.new([], "foo/bar", {}, false) } end end def using_responder_with_respond responder = Class.new(ActionController::Responder) do def respond; @controller.render :text => "respond #{format}"; end end respond_with(resource, :responder => responder) end protected def resource Customer.new("david", request.delete? ? nil : 13) end def _render_js(js, options) self.content_type ||= Mime::JS self.response_body = js.respond_to?(:to_js) ? js.to_js : js end end class InheritedRespondWithController < RespondWithController clear_respond_to respond_to :xml, :json def index respond_with(resource) do |format| format.json { render :text => "JSON" } end end end class EmptyRespondWithController < ActionController::Base def index respond_with(Customer.new("david", 13)) end end class RespondWithControllerTest < ActionController::TestCase tests RespondWithController def setup super @request.host = "www.example.com" end def teardown super end def test_using_resource @request.accept = "text/javascript" get :using_resource assert_equal "text/javascript", @response.content_type assert_equal '$("body").visualEffect("highlight");', @response.body @request.accept = "application/xml" get :using_resource assert_equal "application/xml", @response.content_type assert_equal "david", @response.body @request.accept = "application/json" assert_raise ActionView::MissingTemplate do get :using_resource end end def test_using_resource_with_block @request.accept = "*/*" get :using_resource_with_block assert_equal "text/html", @response.content_type assert_equal 'Hello world!', @response.body @request.accept = "text/csv" get :using_resource_with_block assert_equal "text/csv", @response.content_type assert_equal "CSV", @response.body @request.accept = "application/xml" get :using_resource assert_equal "application/xml", @response.content_type assert_equal "david", @response.body end def test_using_resource_with_overwrite_block get :using_resource_with_overwrite_block assert_equal "text/html", @response.content_type assert_equal "HTML", @response.body end def test_not_acceptable @request.accept = "application/xml" get :using_resource_with_block assert_equal 406, @response.status @request.accept = "text/javascript" get :using_resource_with_overwrite_block assert_equal 406, @response.status end def test_using_resource_for_post_with_html_redirects_on_success with_test_route_set do post :using_resource assert_equal "text/html", @response.content_type assert_equal 302, @response.status assert_equal "http://www.example.com/customers/13", @response.location assert @response.redirect? end end def test_using_resource_for_post_with_html_rerender_on_failure with_test_route_set do errors = { :name => :invalid } Customer.any_instance.stubs(:errors).returns(errors) post :using_resource assert_equal "text/html", @response.content_type assert_equal 200, @response.status assert_equal "New world!\n", @response.body assert_nil @response.location end end def test_using_resource_for_post_with_xml_yields_created_on_success with_test_route_set do @request.accept = "application/xml" post :using_resource assert_equal "application/xml", @response.content_type assert_equal 201, @response.status assert_equal "david", @response.body assert_equal "http://www.example.com/customers/13", @response.location end end def test_using_resource_for_post_with_xml_yields_unprocessable_entity_on_failure with_test_route_set do @request.accept = "application/xml" errors = { :name => :invalid } Customer.any_instance.stubs(:errors).returns(errors) post :using_resource assert_equal "application/xml", @response.content_type assert_equal 422, @response.status assert_equal errors.to_xml, @response.body assert_nil @response.location end end def test_using_resource_for_put_with_html_redirects_on_success with_test_route_set do put :using_resource assert_equal "text/html", @response.content_type assert_equal 302, @response.status assert_equal "http://www.example.com/customers/13", @response.location assert @response.redirect? end end def test_using_resource_for_put_with_html_rerender_on_failure with_test_route_set do errors = { :name => :invalid } Customer.any_instance.stubs(:errors).returns(errors) put :using_resource assert_equal "text/html", @response.content_type assert_equal 200, @response.status assert_equal "Edit world!\n", @response.body assert_nil @response.location end end def test_using_resource_for_put_with_html_rerender_on_failure_even_on_method_override with_test_route_set do errors = { :name => :invalid } Customer.any_instance.stubs(:errors).returns(errors) @request.env["rack.methodoverride.original_method"] = "POST" put :using_resource assert_equal "text/html", @response.content_type assert_equal 200, @response.status assert_equal "Edit world!\n", @response.body assert_nil @response.location end end def test_using_resource_for_put_with_xml_yields_ok_on_success @request.accept = "application/xml" put :using_resource assert_equal "application/xml", @response.content_type assert_equal 200, @response.status assert_equal " ", @response.body end def test_using_resource_for_put_with_xml_yields_unprocessable_entity_on_failure @request.accept = "application/xml" errors = { :name => :invalid } Customer.any_instance.stubs(:errors).returns(errors) put :using_resource assert_equal "application/xml", @response.content_type assert_equal 422, @response.status assert_equal errors.to_xml, @response.body assert_nil @response.location end def test_using_resource_for_delete_with_html_redirects_on_success with_test_route_set do Customer.any_instance.stubs(:destroyed?).returns(true) delete :using_resource assert_equal "text/html", @response.content_type assert_equal 302, @response.status assert_equal "http://www.example.com/customers", @response.location end end def test_using_resource_for_delete_with_xml_yields_ok_on_success Customer.any_instance.stubs(:destroyed?).returns(true) @request.accept = "application/xml" delete :using_resource assert_equal "application/xml", @response.content_type assert_equal 200, @response.status assert_equal " ", @response.body end def test_using_resource_for_delete_with_html_redirects_on_failure with_test_route_set do errors = { :name => :invalid } Customer.any_instance.stubs(:errors).returns(errors) Customer.any_instance.stubs(:destroyed?).returns(false) delete :using_resource assert_equal "text/html", @response.content_type assert_equal 302, @response.status assert_equal "http://www.example.com/customers", @response.location end end def test_using_resource_with_parent_for_get @request.accept = "application/xml" get :using_resource_with_parent assert_equal "application/xml", @response.content_type assert_equal 200, @response.status assert_equal "david", @response.body end def test_using_resource_with_parent_for_post with_test_route_set do @request.accept = "application/xml" post :using_resource_with_parent assert_equal "application/xml", @response.content_type assert_equal 201, @response.status assert_equal "david", @response.body assert_equal "http://www.example.com/quiz_stores/11/customers/13", @response.location errors = { :name => :invalid } Customer.any_instance.stubs(:errors).returns(errors) post :using_resource assert_equal "application/xml", @response.content_type assert_equal 422, @response.status assert_equal errors.to_xml, @response.body assert_nil @response.location end end def test_using_resource_with_collection @request.accept = "application/xml" get :using_resource_with_collection assert_equal "application/xml", @response.content_type assert_equal 200, @response.status assert_match /david<\/name>/, @response.body assert_match /jamis<\/name>/, @response.body end def test_using_resource_with_action @controller.instance_eval do def render(params={}) self.response_body = "#{params[:action]} - #{formats}" end end errors = { :name => :invalid } Customer.any_instance.stubs(:errors).returns(errors) post :using_resource_with_action assert_equal "foo - #{[:html].to_s}", @controller.response.body end def test_respond_as_responder_entry_point @request.accept = "text/html" get :using_responder_with_respond assert_equal "respond html", @response.body @request.accept = "application/xml" get :using_responder_with_respond assert_equal "respond xml", @response.body end def test_clear_respond_to @controller = InheritedRespondWithController.new @request.accept = "text/html" get :index assert_equal 406, @response.status end def test_first_in_respond_to_has_higher_priority @controller = InheritedRespondWithController.new @request.accept = "*/*" get :index assert_equal "application/xml", @response.content_type assert_equal "david", @response.body end def test_block_inside_respond_with_is_rendered @controller = InheritedRespondWithController.new @request.accept = "application/json" get :index assert_equal "JSON", @response.body end def test_no_double_render_is_raised @request.accept = "text/html" assert_raise ActionView::MissingTemplate do get :using_resource end end def test_using_resource_with_status_and_location @request.accept = "text/html" post :using_resource_with_status_and_location assert @response.redirect? assert_equal "http://test.host/", @response.location @request.accept = "application/xml" get :using_resource_with_status_and_location assert_equal 201, @response.status end def test_using_resource_with_responder get :using_resource_with_responder assert_equal "Resource name is david", @response.body end def test_using_resource_with_set_responder RespondWithController.responder = proc { |c, r, o| c.render :text => "Resource name is #{r.first.name}" } get :using_resource assert_equal "Resource name is david", @response.body ensure RespondWithController.responder = ActionController::Responder end def test_error_is_raised_if_no_respond_to_is_declared_and_respond_with_is_called @controller = EmptyRespondWithController.new @request.accept = "*/*" assert_raise RuntimeError do get :index end end private def with_test_route_set with_routing do |set| set.draw do |map| resources :customers resources :quiz_stores do resources :customers end match ":controller/:action" end yield end end end class AbstractPostController < ActionController::Base self.view_paths = File.dirname(__FILE__) + "/../fixtures/post_test/" end # For testing layouts which are set automatically class PostController < AbstractPostController around_filter :with_iphone def index respond_to(:html, :iphone) end protected def with_iphone request.format = "iphone" if request.env["HTTP_ACCEPT"] == "text/iphone" yield end end class SuperPostController < PostController end class MimeControllerLayoutsTest < ActionController::TestCase tests PostController def setup super @request.host = "www.example.com" end def test_missing_layout_renders_properly get :index assert_equal '
Hello Firefox
', @response.body @request.accept = "text/iphone" get :index assert_equal 'Hello iPhone', @response.body end def test_format_with_inherited_layouts @controller = SuperPostController.new get :index assert_equal '
Super Firefox
', @response.body @request.accept = "text/iphone" get :index assert_equal '
Super iPhone
', @response.body end end