@@ -18,6 +18,36 @@ To use it as a GemPlugin, add it to your environment.rb: config.gem 'mbleigh-subdomain-fu', :source => "http://gems.github.com", :lib => "subdomain-fu" + +Examples +======== + +SubdomainFu works inside of Rails's URL Writing mechanisms to provide an easy and seamless +way to link and otherwise understand cross-subdomain routing. You can use the :subdomain +option both in named and non-named routes as well as in generated resources routes. + +Let's say my domain is 'intridea.com'. Here are some examples of the use of the :subdomain +option: + +url_for(:controller => "my_controller", + :action => "my_action", + :subdomain => "awesome") # => http://awesome.intridea.com/my_controller/my_action + +Now let's say I'm at http://awesome.intridea.com/ and I want back to the root. +Specifying "false" will remove any current subdomain: + +users_url(:subdomain => false) # => http://intridea.com/users + +Note that this plugin does not honor the :only_path notion of routing when doing +so would go against the intent of the command. For example, if I were at http://intridea.com +again: + +users_path(:subdomain => "fun") # => http://fun.intridea.com/users +users_path(:subdomain => false) # => /users + +In this way you can rest assured that you will never misdirect your links to the +same subdomain when you meant to change it. + Configuration ============= @@ -43,22 +73,30 @@ the usage of the root domain. SubdomainFu.mirrors = %w(www site we) # Defaults to %w(www) -Examples -======== +preferred_mirror +---------------- + +SubdomainFu also understands the notion of a 'preferred mirror', that is, if you +always want your links going to 'www.yourdomain.com' instead of 'yourdomain.com', +you can set the preferred mirror like so: + +SubdomainFu.preferred_mirror = "www" + +Now when you create a link to a false subdomain -SubdomainFu works in both the URL writing parts of Rails and the routes. For -URL writing, it provides you an option you can pass into any URL-generating -call to use (or lose) a subdomain: +Known Issues / Future Work +========================== -url_for(:controller => "my_controller", :action => "my_action", :subdomain => "awesome") -users_url(:subdomain => false) # specifying "false" will remove any current subdomain +SubdomainFu will eventually integrate with Rails' routing internals to provide +the ability to specify routes based on the condition of a specific subdomain or +simply whether a subdomain is present (or a mirror). -Known Issues / TODO -=================== +Resources +========= -* TODO: Implement route conditions that require either a subdomain or no subdomain -* TODO: Spec out URL Rewriting more completely, test with different domain levels etc. -* TODO: Implement "preferred_mirror" to automatically use "www" for example if that's desired. +* Acts As Community Project: http://actsascommunity.com/projects/subdomain-fu +* GitHub Repository: http://github.com/mbleigh/subdomain-fu +* Lighthouse: http://mbleigh.lighthouseapp.com/projects/13148-subdomain-fu Copyright (c) 2008 Michael Bleigh (http://www.mbleigh.com/) and Intridea, Inc. (http://www.intridea.com/). Released under the MIT license \ No newline at end of file README @@ -1,4 +1,4 @@ -require 'subdomain_fu/routing_extensions' +# require 'subdomain_fu/routing_extensions' require 'subdomain_fu/url_rewriter' module SubdomainFu @@ -49,10 +49,17 @@ module SubdomainFu # Rewrites the subdomain of the host unless they are equivalent (i.e. mirrors of each other) def self.rewrite_host_for_subdomains(subdomain, host) - if same_subdomain?(subdomain, host) - host + unless needs_rewrite?(subdomain, host) + if has_subdomain?(subdomain) || (subdomain_from(host) == SubdomainFu.preferred_mirror) || (!has_subdomain?(subdomain) && SubdomainFu.preferred_mirror == nil) + puts "We're not changing the host." + host + else + puts "We're using the preferred mirror." + change_subdomain_of_host(SubdomainFu.preferred_mirror, host) + end else - change_subdomain_of_host(subdomain, host) + puts "We're changing the host." + change_subdomain_of_host(subdomain || SubdomainFu.preferred_mirror, host) end end @@ -65,9 +72,15 @@ module SubdomainFu # Is this subdomain equivalent to the subdomain found in this host string? def self.same_subdomain?(subdomain, host) - result = subdomain == SubdomainFu.subdomain_from(host) || + subdomain = nil unless subdomain + (subdomain == SubdomainFu.subdomain_from(host)) || (!SubdomainFu.has_subdomain?(subdomain) && !SubdomainFu.has_subdomain?(SubdomainFu.subdomain_from(host))) - result + end + + def self.needs_rewrite?(subdomain, host) + subdomain = nil if subdomain.blank? + (!has_subdomain?(subdomain) && subdomain != SubdomainFu.preferred_mirror && SubdomainFu.preferred_mirror != nil) || + !same_subdomain?(subdomain, host) end def self.current_subdomain(request) lib/subdomain-fu.rb @@ -1,5 +1,6 @@ # Thanks to Jamis Buck for ideas on this stuff # http://weblog.jamisbuck.org/2006/10/26/monkey-patching-rails-extending-routes-2 +# This is not yet a working part of SubdomainFu. module SubdomainFu module RouteExtensions lib/subdomain_fu/routing_extensions.rb @@ -1,7 +1,7 @@ module ActionController module UrlWriter def url_for_with_subdomains(options) - if SubdomainFu.same_subdomain?(options[:subdomain], options[:host] || default_url_options[:host]) + unless SubdomainFu.needs_rewrite?(options[:subdomain], options[:host] || default_url_options[:host]) options.delete(:subdomain) else options[:only_path] = false @@ -16,7 +16,7 @@ module ActionController private def rewrite_url_with_subdomains(options) - if SubdomainFu.same_subdomain?(options[:subdomain], (options[:host] || @request.host_with_port)) + unless SubdomainFu.needs_rewrite?(options[:subdomain], (options[:host] || @request.host_with_port)) options.delete(:subdomain) else options[:only_path] = false lib/subdomain_fu/url_rewriter.rb @@ -67,6 +67,27 @@ describe "SubdomainFu URL Writing" do end end + describe "Preferred Mirror" do + before do + SubdomainFu.preferred_mirror = "www" + end + + it "should switch to the preferred mirror instead of no subdomain" do + default_url_options[:host] = "awesome.testapp.com" + needs_subdomain_url(:subdomain => false).should == "http://www.testapp.com/needs_subdomain" + end + + it "should force a switch to no subdomain on a mirror if preferred_mirror is false" do + SubdomainFu.preferred_mirror = false + default_url_options[:host] = "www.testapp.com" + needs_subdomain_url(:subdomain => false).should == "http://testapp.com/needs_subdomain" + end + + after do + SubdomainFu.preferred_mirror = nil + end + end + after do SubdomainFu.tld_size = 0 default_url_options[:host] = "localhost" spec/url_rewriter_spec.rb fc8d2bc55ff4082de43f61259bc7113f6b467117 Michael Bleigh michael@intridea.com http://github.com/mbleigh/subdomain-fu/commit/64bef4cc9958da2c6d9686ca5b534298593d086d 64bef4cc9958da2c6d9686ca5b534298593d086d 2008-06-20T13:03:29-07:00 2008-06-20T13:03:29-07:00 Added Preferred Mirror, updated README in prep for plugin release. 85fd0d05aad14e01c614add6b300540a3230f796 Michael Bleigh michael@intridea.com