Permalink
Browse files

Add UrlWriter to allow writing urls from Mailers and scripts.

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@4814 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
  • Loading branch information...
1 parent 4b4dd54 commit 3b1972a8969ec193233642643659c73fd781aec3 @seckar seckar committed Aug 24, 2006
View
@@ -1,5 +1,7 @@
*SVN*
+* Add UrlWriter to allow writing urls from Mailers and scripts. [Nicholas Seckar]
+
* Clean up and run the Active Record integration tests by default. #5854 [kevin.clark@gmail.com, Jeremy Kemper]
* Correct example in cookies docs. #5832 [jessemerriman@warpmail.net]
@@ -1,6 +1,59 @@
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
+
+ # The default options for urls written by this writer. Typically a :host pair
+ # is provided.
+ mattr_accessor :default_url_options
+ self.default_url_options = {}
+
+ def self.included(base) #:nodoc:
+ ActionController::Routing::Routes.named_routes.install base
+ base.mattr_accessor :default_url_options
+ base.default_url_options ||= default_url_options
+ end
+
+ # Generate a url with the provided options. The following special options may
+ # effect the constructed url:
+ #
+ # * :host Specifies the host the link should be targetted at. This option
+ # must be provided either explicitly, or via default_url_options.
+ # * :protocol The protocol to connect to. Defaults to 'http'
+ # * :port Optionally specify the port to connect to.
+ #
+ def url_for(options)
+ options = self.class.default_url_options.merge(options)
+
+ raise "Missing host to link to! Please provide :host parameter or set default_url_options[:host]" unless options[:host]
+
+ url = ''
+ url << (options.delete(:protocol) || 'http')
+ url << '://'
+ url << options.delete(:host)
+ url << ":#{options.delete(:port)}" if options.key?(:port)
+ url << Routing::Routes.generate(options, {})
+ return 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, :trailing_slash, :skip_relative_url_root]
def initialize(request, parameters)
@@ -46,4 +99,5 @@ def rewrite_path(options)
Routing::Routes.generate(options, @request.symbolized_path_parameters)
end
end
+
end
@@ -27,3 +27,68 @@ def assert_query_equal(q1, q2)
assert_equal(split_query_string(q1), split_query_string(q2))
end
end
+
+class UrlWriterTests < Test::Unit::TestCase
+
+ class W
+ include ActionController::UrlWriter
+ end
+
+ def teardown
+ W.default_url_options.clear
+ end
+
+ def add_host!
+ W.default_url_options[:host] = 'www.basecamphq.com'
+ end
+
+ def test_exception_is_thrown_without_host
+ assert_raises RuntimeError do
+ W.new.url_for :controller => 'c', :action => 'a', :id => 'i'
+ end
+ end
+
+ def test_default_host
+ add_host!
+ assert_equal('http://www.basecamphq.com/c/a/i',
+ W.new.url_for(:controller => 'c', :action => 'a', :id => 'i')
+ )
+ end
+
+ def test_host_may_be_overridden
+ add_host!
+ assert_equal('http://37signals.basecamphq.com/c/a/i',
+ W.new.url_for(:host => '37signals.basecamphq.com', :controller => 'c', :action => 'a', :id => 'i')
+ )
+ end
+
+ def test_port
+ add_host!
+ assert_equal('http://www.basecamphq.com:3000/c/a/i',
+ W.new.url_for(:controller => 'c', :action => 'a', :id => 'i', :port => 3000)
+ )
+ end
+
+ def test_protocol
+ add_host!
+ assert_equal('https://www.basecamphq.com/c/a/i',
+ W.new.url_for(:controller => 'c', :action => 'a', :id => 'i', :protocol => 'https')
+ )
+ end
+
+ def test_named_route
+ ActionController::Routing::Routes.draw do |map|
+ map.home '/home/sweet/home/:user'
+ 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 }
+ assert kls.new.respond_to?(:home_url)
+ assert_equal 'http://www.basecamphq.com/home/sweet/home/again',
+ kls.new.send(:home_url, :host => 'www.basecamphq.com', :user => 'again')
+ ensure
+ ActionController::Routing::Routes.load!
+ end
+
+end

0 comments on commit 3b1972a

Please sign in to comment.