diff options
-rw-r--r-- | actionpack/CHANGELOG | 2 | ||||
-rw-r--r-- | actionpack/lib/action_view/helpers/url_helper.rb | 128 | ||||
-rw-r--r-- | actionpack/test/template/url_helper_test.rb | 57 |
3 files changed, 66 insertions, 121 deletions
diff --git a/actionpack/CHANGELOG b/actionpack/CHANGELOG index 15394b2b98..12c903e8fe 100644 --- a/actionpack/CHANGELOG +++ b/actionpack/CHANGELOG @@ -1,6 +1,6 @@ *SVN* -* Deprecation: remove deprecated request, redirect, and dependency methods. Remove deprecated instance variables. Remove uses_component_template_root for toplevel components directory. Privatize deprecated render_partial and render_partial_collection view methods. [Jeremy Kemper] +* Deprecation: remove deprecated request, redirect, and dependency methods. Remove deprecated instance variables. Remove uses_component_template_root for toplevel components directory. Privatize deprecated render_partial and render_partial_collection view methods. Remove deprecated link_to_image and link_image_to helper methods. [Jeremy Kemper] * Consistent public/protected/private visibility for chained methods. #7813 [Dan Manges] diff --git a/actionpack/lib/action_view/helpers/url_helper.rb b/actionpack/lib/action_view/helpers/url_helper.rb index dc9154dea5..a573ee1961 100644 --- a/actionpack/lib/action_view/helpers/url_helper.rb +++ b/actionpack/lib/action_view/helpers/url_helper.rb @@ -2,19 +2,19 @@ require 'action_view/helpers/javascript_helper' module ActionView module Helpers #:nodoc: - # Provides a set of methods for making easy links and getting urls that - # depend on the controller and action. This means that you can use the + # Provides a set of methods for making easy links and getting urls that + # depend on the controller and action. This means that you can use the # same format for links in the views that you do in the controller. module UrlHelper include JavaScriptHelper - - # Returns the URL for the set of +options+ provided. This takes the - # same options as url_for in action controller. For a list, see the - # documentation for ActionController::Base#url_for. Note that it'll - # set :only_path => true so you'll get the relative /controller/action + + # Returns the URL for the set of +options+ provided. This takes the + # same options as url_for in action controller. For a list, see the + # documentation for ActionController::Base#url_for. Note that it'll + # set :only_path => true so you'll get the relative /controller/action # instead of the fully qualified http://example.com/controller/action. - # - # When called from a view, url_for returns an HTML escaped url. If you + # + # When called from a view, url_for returns an HTML escaped url. If you # need an unescaped url, pass :escape => false in the +options+. def url_for(options = {}, *parameters_for_method_reference) if options.kind_of? Hash @@ -28,29 +28,29 @@ module ActionView escape ? html_escape(url) : url end - # Creates a link tag of the given +name+ using a URL created by the set - # of +options+. See the valid options in the documentation for - # ActionController::Base#url_for. It's also possible to pass a string instead - # of an options hash to get a link tag that uses the value of the string as the - # href for the link. If nil is passed as a name, the link itself will become + # Creates a link tag of the given +name+ using a URL created by the set + # of +options+. See the valid options in the documentation for + # ActionController::Base#url_for. It's also possible to pass a string instead + # of an options hash to get a link tag that uses the value of the string as the + # href for the link. If nil is passed as a name, the link itself will become # the name. # # The +html_options+ will accept a hash of html attributes for the link tag. - # It also accepts 3 modifiers that specialize the link behavior. + # It also accepts 3 modifiers that specialize the link behavior. # - # * <tt>:confirm => 'question?'</tt>: This will add a JavaScript confirm - # prompt with the question specified. If the user accepts, the link is + # * <tt>:confirm => 'question?'</tt>: This will add a JavaScript confirm + # prompt with the question specified. If the user accepts, the link is # processed normally, otherwise no action is taken. - # * <tt>:popup => true || array of window options</tt>: This will force the - # link to open in a popup window. By passing true, a default browser window - # will be opened with the URL. You can also specify an array of options + # * <tt>:popup => true || array of window options</tt>: This will force the + # link to open in a popup window. By passing true, a default browser window + # will be opened with the URL. You can also specify an array of options # that are passed-thru to JavaScripts window.open method. # * <tt>:method => symbol of HTTP verb</tt>: This modifier will dynamically - # create an HTML form and immediately submit the form for processing using + # create an HTML form and immediately submit the form for processing using # the HTTP verb specified. Useful for having links perform a POST operation # in dangerous actions like deleting a record (which search bots can follow # while spidering your site). Supported verbs are :post, :delete and :put. - # Note that if the user has JavaScript disabled, the request will fall back + # Note that if the user has JavaScript disabled, the request will fall back # to using GET. If you are relying on the POST behavior, your should check # for it in your controllers action by using the request objects methods # for post?, delete? or put?. @@ -88,7 +88,7 @@ module ActionView # the form submission and input element behavior using +html_options+. # This method accepts the <tt>:method</tt> and <tt>:confirm</tt> modifiers # described in the link_to documentation. If no <tt>:method</tt> modifier - # is given, it will default to performing a POST operation. You can also + # is given, it will default to performing a POST operation. You can also # disable the button by passing <tt>:disabled => true</tt> in +html_options+. # # button_to "New", :action => "new" @@ -133,52 +133,14 @@ module ActionView name ||= url html_options.merge!("type" => "submit", "value" => name) - - "<form method=\"#{form_method}\" action=\"#{escape_once url}\" class=\"button-to\"><div>" + - method_tag + tag("input", html_options) + "</div></form>" - end - - - # DEPRECATED. It is reccommended to use the AssetTagHelper::image_tag within - # a link_to method to generate a linked image. - # - # link_to(image_tag("rss", :size => "30x45", :border => 0), "http://www.example.com") - def link_image_to(src, options = {}, html_options = {}, *parameters_for_method_reference) - image_options = { "src" => src.include?("/") ? src : "/images/#{src}" } - image_options["src"] += ".png" unless image_options["src"].include?(".") - - html_options = html_options.stringify_keys - if html_options["alt"] - image_options["alt"] = html_options["alt"] - html_options.delete "alt" - else - image_options["alt"] = src.split("/").last.split(".").first.capitalize - end - - if html_options["size"] - image_options["width"], image_options["height"] = html_options["size"].split("x") - html_options.delete "size" - end - - if html_options["border"] - image_options["border"] = html_options["border"] - html_options.delete "border" - end - - if html_options["align"] - image_options["align"] = html_options["align"] - html_options.delete "align" - end - link_to(tag("img", image_options), options, html_options, *parameters_for_method_reference) + "<form method=\"#{form_method}\" action=\"#{escape_once url}\" class=\"button-to\"><div>" + + method_tag + tag("input", html_options) + "</div></form>" end - alias_method :link_to_image, :link_image_to - deprecate :link_to_image => "use link_to(image_tag(...), url)", - :link_image_to => "use link_to(image_tag(...), url)" # Creates a link tag of the given +name+ using a URL created by the set of - # +options+ unless the current request uri is the same as the links, in + # +options+ unless the current request uri is the same as the links, in # which case only the name is returned (or the given block is yielded, if # one exists). Refer to the documentation for link_to_unless for block usage. # @@ -198,7 +160,7 @@ module ActionView end # Creates a link tag of the given +name+ using a URL created by the set of - # +options+ unless +condition+ is true, in which case only the name is + # +options+ unless +condition+ is true, in which case only the name is # returned. To specialize the default behavior, you can pass a block that # accepts the name or the full argument list for link_to_unless (see the example). # @@ -208,7 +170,7 @@ module ActionView # # <%= link_to_unless(@current_user.nil?, "Reply", { :action => "reply" }) do |name| # link_to(name, { :controller => "accounts", :action => "signup" }) - # end %> + # end %> def link_to_unless(condition, name, options = {}, html_options = {}, *parameters_for_method_reference, &block) if condition if block_given? @@ -218,11 +180,11 @@ module ActionView end else link_to(name, options, html_options, *parameters_for_method_reference) - end + end end - + # Creates a link tag of the given +name+ using a URL created by the set of - # +options+ if +condition+ is true, in which case only the name is + # +options+ if +condition+ is true, in which case only the name is # returned. To specialize the default behavior, you can pass a block that # accepts the name or the full argument list for link_to_unless (see the examples # in link_to_unless). @@ -268,7 +230,7 @@ module ActionView # mail_to "me@domain.com", nil, :replace_at => "_at_", :replace_dot => "_dot_", :class => "email" # => # <a href="mailto:me@domain.com" class="email">me_at_domain_dot_com</a> # - # mail_to "me@domain.com", "My email", :cc => "ccaddress@domain.com", + # mail_to "me@domain.com", "My email", :cc => "ccaddress@domain.com", # :subject => "This is an example email" # => # <a href="mailto:me@domain.com?cc=ccaddress@domain.com&subject=This%20is%20an%20example%20email">My email</a> def mail_to(email_address, name = nil, html_options = {}) @@ -333,19 +295,11 @@ module ActionView def convert_options_to_javascript!(html_options) confirm, popup = html_options.delete("confirm"), html_options.delete("popup") - # post is deprecated, but if its specified and method is not, assume that method = :post - method, post = html_options.delete("method"), html_options.delete("post") - if !method && post - ActiveSupport::Deprecation.warn( - "Passing :post as a link modifier is deprecated. " + - "Use :method => \"post\" instead. :post will be removed in Rails 2.0." - ) - method = :post - end - + method = html_options.delete("method") + html_options["onclick"] = case when popup && method - raise ActionView::ActionViewError, "You can't use :popup and :post in the same link" + raise ActionView::ActionViewError, "You can't use :popup and :method in the same link" when confirm && popup "if (#{confirm_javascript_function(confirm)}) { #{popup_javascript_function(popup)} };return false;" when confirm && method @@ -360,25 +314,25 @@ module ActionView html_options["onclick"] end end - + def confirm_javascript_function(confirm) "confirm('#{escape_javascript(confirm)}')" end - + def popup_javascript_function(popup) popup.is_a?(Array) ? "window.open(this.href,'#{popup.first}','#{popup.last}');" : "window.open(this.href);" end - + def method_javascript_function(method) - submit_function = + submit_function = "var f = document.createElement('form'); f.style.display = 'none'; " + "this.parentNode.appendChild(f); f.method = 'POST'; f.action = this.href;" - + unless method == :post submit_function << "var m = document.createElement('input'); m.setAttribute('type', 'hidden'); " submit_function << "m.setAttribute('name', '_method'); m.setAttribute('value', '#{method}'); f.appendChild(m);" end - + submit_function << "f.submit();" end diff --git a/actionpack/test/template/url_helper_test.rb b/actionpack/test/template/url_helper_test.rb index 8cef4ffe14..9ecbc77a4e 100644 --- a/actionpack/test/template/url_helper_test.rb +++ b/actionpack/test/template/url_helper_test.rb @@ -17,7 +17,7 @@ class UrlHelperTest < Test::Unit::TestCase @controller = @controller.new @controller.url = "http://www.example.com" end - + def test_url_for_escapes_urls @controller.url = "http://www.example.com?a=b&c=d" assert_equal "http://www.example.com?a=b&c=d", url_for(:a => 'b', :c => 'd') @@ -59,14 +59,14 @@ class UrlHelperTest < Test::Unit::TestCase button_to("Hello", "http://www.example.com", :disabled => true) ) end - + def test_button_to_with_method_delete assert_dom_equal( "<form method=\"post\" action=\"http://www.example.com\" class=\"button-to\"><div><input type=\"hidden\" name=\"_method\" value=\"delete\" /><input type=\"submit\" value=\"Hello\" /></div></form>", button_to("Hello", "http://www.example.com", :method => :delete) ) end - + def test_button_to_with_method_get assert_dom_equal( "<form method=\"get\" action=\"http://www.example.com\" class=\"button-to\"><div><input type=\"submit\" value=\"Hello\" /></div></form>", @@ -97,18 +97,18 @@ class UrlHelperTest < Test::Unit::TestCase def test_link_tag_with_custom_onclick assert_dom_equal "<a href=\"http://www.example.com\" onclick=\"alert('yay!')\">Hello</a>", link_to("Hello", "http://www.example.com", :onclick => "alert('yay!')") end - + def test_link_tag_with_javascript_confirm assert_dom_equal( "<a href=\"http://www.example.com\" onclick=\"return confirm('Are you sure?');\">Hello</a>", link_to("Hello", "http://www.example.com", :confirm => "Are you sure?") ) assert_dom_equal( - "<a href=\"http://www.example.com\" onclick=\"return confirm('You can\\'t possibly be sure, can you?');\">Hello</a>", + "<a href=\"http://www.example.com\" onclick=\"return confirm('You can\\'t possibly be sure, can you?');\">Hello</a>", link_to("Hello", "http://www.example.com", :confirm => "You can't possibly be sure, can you?") ) assert_dom_equal( - "<a href=\"http://www.example.com\" onclick=\"return confirm('You can\\'t possibly be sure,\\n can you?');\">Hello</a>", + "<a href=\"http://www.example.com\" onclick=\"return confirm('You can\\'t possibly be sure,\\n can you?');\">Hello</a>", link_to("Hello", "http://www.example.com", :confirm => "You can't possibly be sure,\n can you?") ) end @@ -119,15 +119,15 @@ class UrlHelperTest < Test::Unit::TestCase link_to("Hello", "http://www.example.com", :popup => true) ) assert_dom_equal( - "<a href=\"http://www.example.com\" onclick=\"window.open(this.href);return false;\">Hello</a>", + "<a href=\"http://www.example.com\" onclick=\"window.open(this.href);return false;\">Hello</a>", link_to("Hello", "http://www.example.com", :popup => 'true') ) assert_dom_equal( - "<a href=\"http://www.example.com\" onclick=\"window.open(this.href,'window_name','width=300,height=300');return false;\">Hello</a>", + "<a href=\"http://www.example.com\" onclick=\"window.open(this.href,'window_name','width=300,height=300');return false;\">Hello</a>", link_to("Hello", "http://www.example.com", :popup => ['window_name', 'width=300,height=300']) ) end - + def test_link_tag_with_popup_and_javascript_confirm assert_dom_equal( "<a href=\"http://www.example.com\" onclick=\"if (confirm('Fo\\' sho\\'?')) { window.open(this.href); };return false;\">Hello</a>", @@ -138,16 +138,7 @@ class UrlHelperTest < Test::Unit::TestCase link_to("Hello", "http://www.example.com", { :popup => ['window_name', 'width=300,height=300'], :confirm => "Are you serious?" }) ) end - - def test_link_tag_with_post_is_deprecated - assert_deprecated 'post' do - assert_dom_equal( - "<a href='http://www.example.com' onclick=\"var f = document.createElement('form'); f.style.display = 'none'; this.parentNode.appendChild(f); f.method = 'POST'; f.action = this.href;f.submit();return false;\">Hello</a>", - link_to("Hello", "http://www.example.com", :post => true) - ) - end - end - + def test_link_tag_using_post_javascript assert_dom_equal( "<a href='http://www.example.com' onclick=\"var f = document.createElement('form'); f.style.display = 'none'; this.parentNode.appendChild(f); f.method = 'POST'; f.action = this.href;f.submit();return false;\">Hello</a>", @@ -161,18 +152,18 @@ class UrlHelperTest < Test::Unit::TestCase link_to("Destroy", "http://www.example.com", :method => :delete) ) end - + def test_link_tag_using_post_javascript_and_confirm assert_dom_equal( "<a href=\"http://www.example.com\" onclick=\"if (confirm('Are you serious?')) { var f = document.createElement('form'); f.style.display = 'none'; this.parentNode.appendChild(f); f.method = 'POST'; f.action = this.href;f.submit(); };return false;\">Hello</a>", link_to("Hello", "http://www.example.com", :method => :post, :confirm => "Are you serious?") - ) + ) end - + def test_link_tag_using_post_javascript_and_popup assert_raises(ActionView::ActionViewError) { link_to("Hello", "http://www.example.com", :popup => true, :method => :post, :confirm => "Are you serious?") } end - + def test_link_to_unless assert_equal "Showing", link_to_unless(true, "Showing", :action => "show", :controller => "weblog") assert_dom_equal "<a href=\"http://www.example.com\">Listing</a>", link_to_unless(false, "Listing", :action => "list", :controller => "weblog") @@ -182,12 +173,12 @@ class UrlHelperTest < Test::Unit::TestCase } assert_equal "<strong>Showing</strong>", link_to_unless(true, "Showing", :action => "show", :controller => "weblog", :id => 1) { |name| "<strong>#{name}</strong>" - } + } assert_equal "test", link_to_unless(true, "Showing", :action => "show", :controller => "weblog", :id => 1) { "test" - } + } end - + def test_link_to_if assert_equal "Showing", link_to_if(false, "Showing", :action => "show", :controller => "weblog") assert_dom_equal "<a href=\"http://www.example.com\">Listing</a>", link_to_if(true, "Listing", :action => "list", :controller => "weblog") @@ -222,14 +213,14 @@ class UrlHelperTest < Test::Unit::TestCase def test_mail_to_with_javascript assert_dom_equal "<script type=\"text/javascript\">eval(unescape('%64%6f%63%75%6d%65%6e%74%2e%77%72%69%74%65%28%27%3c%61%20%68%72%65%66%3d%22%6d%61%69%6c%74%6f%3a%6d%65%40%64%6f%6d%61%69%6e%2e%63%6f%6d%22%3e%4d%79%20%65%6d%61%69%6c%3c%2f%61%3e%27%29%3b'))</script>", mail_to("me@domain.com", "My email", :encode => "javascript") end - + def test_mail_with_options assert_dom_equal( %(<a href="mailto:me@example.com?cc=ccaddress%40example.com&bcc=bccaddress%40example.com&body=This%20is%20the%20body%20of%20the%20message.&subject=This%20is%20an%20example%20email">My email</a>), mail_to("me@example.com", "My email", :cc => "ccaddress@example.com", :bcc => "bccaddress@example.com", :subject => "This is an example email", :body => "This is the body of the message.") ) end - + def test_mail_to_with_img assert_dom_equal %(<a href="mailto:feedback@example.com"><img src="/feedback.png" /></a>), mail_to('feedback@example.com', '<img src="/feedback.png" />') end @@ -257,7 +248,7 @@ class UrlHelperWithControllerTest < Test::Unit::TestCase def show_url_for render :inline => "<%= url_for :controller => 'url_helper_with_controller', :action => 'show_url_for' %>" end - + def show_named_route render :inline => "<%= show_named_route_#{params[:kind]} %>" end @@ -272,26 +263,26 @@ class UrlHelperWithControllerTest < Test::Unit::TestCase @response = ActionController::TestResponse.new @controller = UrlHelperController.new end - + def test_url_for_shows_only_path get :show_url_for assert_equal '/url_helper_with_controller/show_url_for', @response.body end - + def test_named_route_shows_host_and_path with_url_helper_routing do get :show_named_route, :kind => 'url' assert_equal 'http://test.host/url_helper_with_controller/show_named_route', @response.body end end - + def test_named_route_path_shows_only_path with_url_helper_routing do get :show_named_route, :kind => 'path' assert_equal '/url_helper_with_controller/show_named_route', @response.body end end - + protected def with_url_helper_routing with_routing do |set| |