From 3b1972a8969ec193233642643659c73fd781aec3 Mon Sep 17 00:00:00 2001
From: Nicholas Seckar <nseckar@gmail.com>
Date: Thu, 24 Aug 2006 06:15:01 +0000
Subject: 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
---
 actionpack/lib/action_controller/url_rewriter.rb | 56 +++++++++++++++++++++++-
 1 file changed, 55 insertions(+), 1 deletion(-)

(limited to 'actionpack/lib')

diff --git a/actionpack/lib/action_controller/url_rewriter.rb b/actionpack/lib/action_controller/url_rewriter.rb
index d0615bc023..4735d03035 100644
--- a/actionpack/lib/action_controller/url_rewriter.rb
+++ b/actionpack/lib/action_controller/url_rewriter.rb
@@ -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 @@ module ActionController
         Routing::Routes.generate(options, @request.symbolized_path_parameters)
       end
   end
+  
 end
-- 
cgit v1.2.3