From 59f222dbf7c05e3d1f9e71831bc79e2a5ed4a5b5 Mon Sep 17 00:00:00 2001 From: Jeremy Kemper Date: Thu, 10 Jan 2008 02:51:09 +0000 Subject: UrlWriter respects relative_url_root. Closes #10748. git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@8616 5ecf4fe2-1ee6-0310-87b1-e25e094e27de --- actionpack/CHANGELOG | 2 + actionpack/lib/action_controller/url_rewriter.rb | 57 ++++++++++++------------ actionpack/test/controller/url_rewriter_test.rb | 38 ++++++++++++++-- 3 files changed, 65 insertions(+), 32 deletions(-) diff --git a/actionpack/CHANGELOG b/actionpack/CHANGELOG index 1fd3bfee7f..b4f07e451e 100644 --- a/actionpack/CHANGELOG +++ b/actionpack/CHANGELOG @@ -1,5 +1,7 @@ *SVN* +* UrlWriter respects relative_url_root. #10748 [Cheah Chu Yeow] + * The asset_host block takes the controller request as an optional second argument. Example: use a single asset host for SSL requests. #10549 [Cheah Chu Yeow, Peter B, Tom Taylor] * Support render :text => nil. #6684 [tjennings, PotatoSalad, Cheah Chu Yeow] diff --git a/actionpack/lib/action_controller/url_rewriter.rb b/actionpack/lib/action_controller/url_rewriter.rb index c650763fdb..d19e70fa1c 100644 --- a/actionpack/lib/action_controller/url_rewriter.rb +++ b/actionpack/lib/action_controller/url_rewriter.rb @@ -1,17 +1,17 @@ -module ActionController +module ActionController # Write URLs from arbitrary places in your codebase, such as your mailers. - # + # # Example: - # + # # class MyMailer # include ActionController::UrlWriter # default_url_options[:host] = 'www.basecamphq.com' - # + # # def signup_url(token) # url_for(:controller => 'signup', action => 'index', :token => token) # end # end - # + # # In addition to providing +url_for+, named routes are also accessible after # including UrlWriter. module UrlWriter @@ -19,64 +19,65 @@ module ActionController # is provided. mattr_accessor :default_url_options self.default_url_options = {} - + def self.included(base) #:nodoc: - ActionController::Routing::Routes.install_helpers base + ActionController::Routing::Routes.install_helpers(base) base.mattr_accessor :default_url_options base.default_url_options ||= default_url_options end - - # Generate a url based on the options provided, default_url_options and the + + # Generate a url based on the options provided, default_url_options and the # routes defined in routes.rb. The following options are supported: - # + # # * :only_path If true, the relative url is returned. Defaults to false. # * :protocol The protocol to connect to. Defaults to 'http'. - # * :host Specifies the host the link should be targetted at. If :only_path is false, this option must be - # provided either explicitly, or via default_url_options. + # * :host Specifies the host the link should be targetted at. If :only_path is false, this option must be + # provided either explicitly, or via default_url_options. # * :port Optionally specify the port to connect to. # * :anchor An anchor name to be appended to the path. - # + # * :skip_relative_url_root If true, the url is not constructed using the relative_url_root set in ActionController::AbstractRequest.relative_url_root. + # # Any other key(:controller, :action, etc...) given to url_for is forwarded to the Routes module. - # + # # Examples: - # + # # url_for :controller => 'tasks', :action => 'testing', :host=>'somehost.org', :port=>'8080' # => 'http://somehost.org:8080/tasks/testing' # url_for :controller => 'tasks', :action => 'testing', :host=>'somehost.org', :anchor => 'ok', :only_path => true # => '/tasks/testing#ok' # url_for :controller => 'tasks', :action => 'testing', :host=>'somehost.org', :number => '33' # => 'http://somehost.org/tasks/testing?number=33' - # def url_for(options) options = self.class.default_url_options.merge(options) - + url = '' - unless options.delete :only_path + unless options.delete(:only_path) url << (options.delete(:protocol) || 'http') - url << '://' unless url.match("://") #dont add separator if its already been specified in :protocol - + url << '://' unless url.match("://") + raise "Missing host to link to! Please provide :host parameter or set default_url_options[:host]" unless options[:host] url << options.delete(:host) url << ":#{options.delete(:port)}" if options.key?(:port) else - # Delete the unused options to prevent their appearance in the query string - [:protocol, :host, :port].each { |k| options.delete k } + # Delete the unused options to prevent their appearance in the query string. + [:protocol, :host, :port, :skip_relative_url_root].each { |k| options.delete(k) } end - anchor = "##{CGI.escape options.delete(:anchor).to_param.to_s}" if options.key?(:anchor) + url << ActionController::AbstractRequest.relative_url_root.to_s unless options[:skip_relative_url_root] + anchor = "##{CGI.escape options.delete(:anchor).to_param.to_s}" if options[:anchor] url << Routing::Routes.generate(options, {}) url << anchor if anchor - return url - end + url + end end - + # Rewrites URLs for Base.redirect_to and Base.url_for in the controller. class UrlRewriter #:nodoc: RESERVED_OPTIONS = [:anchor, :params, :only_path, :host, :protocol, :port, :trailing_slash, :skip_relative_url_root] def initialize(request, parameters) @request, @parameters = request, parameters end - + def rewrite(options = {}) rewrite_url(options) end @@ -123,7 +124,7 @@ module ActionController # Generates the query string, too Routing::Routes.generate(options, @request.symbolized_path_parameters) end - + def rewrite_authentication(options) if options[:user] && options[:password] "#{CGI.escape(options.delete(:user))}:#{CGI.escape(options.delete(:password))}@" diff --git a/actionpack/test/controller/url_rewriter_test.rb b/actionpack/test/controller/url_rewriter_test.rb index ffc45b513e..41ea9ed98b 100644 --- a/actionpack/test/controller/url_rewriter_test.rb +++ b/actionpack/test/controller/url_rewriter_test.rb @@ -149,27 +149,57 @@ class UrlWriterTests < Test::Unit::TestCase ) end - def test_named_route + def test_relative_url_root_is_respected + orig_relative_url_root = ActionController::AbstractRequest.relative_url_root + ActionController::AbstractRequest.relative_url_root = '/subdir' + + add_host! + assert_equal('https://www.basecamphq.com/subdir/c/a/i', + W.new.url_for(:controller => 'c', :action => 'a', :id => 'i', :protocol => 'https') + ) + ensure + ActionController::AbstractRequest.relative_url_root = orig_relative_url_root + end + + def test_named_routes ActionController::Routing::Routes.draw do |map| map.no_args '/this/is/verbose', :controller => 'home', :action => 'index' map.home '/home/sweet/home/:user', :controller => 'home', :action => 'index' map.connect ':controller/:action/:id' end - + # We need to create a new class in order to install the new named route. kls = Class.new { include ActionController::UrlWriter } controller = kls.new assert controller.respond_to?(:home_url) assert_equal 'http://www.basecamphq.com/home/sweet/home/again', controller.send(:home_url, :host => 'www.basecamphq.com', :user => 'again') - + assert_equal("/home/sweet/home/alabama", controller.send(:home_path, :user => 'alabama', :host => 'unused')) assert_equal("http://www.basecamphq.com/home/sweet/home/alabama", controller.send(:home_url, :user => 'alabama', :host => 'www.basecamphq.com')) assert_equal("http://www.basecamphq.com/this/is/verbose", controller.send(:no_args_url, :host=>'www.basecamphq.com')) ensure ActionController::Routing::Routes.load! end - + + def test_relative_url_root_is_respected_for_named_routes + orig_relative_url_root = ActionController::AbstractRequest.relative_url_root + ActionController::AbstractRequest.relative_url_root = '/subdir' + + ActionController::Routing::Routes.draw do |map| + map.home '/home/sweet/home/:user', :controller => 'home', :action => 'index' + end + + kls = Class.new { include ActionController::UrlWriter } + controller = kls.new + + assert_equal 'http://www.basecamphq.com/subdir/home/sweet/home/again', + controller.send(:home_url, :host => 'www.basecamphq.com', :user => 'again') + ensure + ActionController::Routing::Routes.load! + ActionController::AbstractRequest.relative_url_root = orig_relative_url_root + end + def test_only_path ActionController::Routing::Routes.draw do |map| map.home '/home/sweet/home/:user', :controller => 'home', :action => 'index' -- cgit v1.2.3