mbleigh-subdomain-fu 0.0.1 → 0.0.2

data/README

@@ -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

data/lib/subdomain-fu.rb

@@ -1,4 +1,4 @@
-require 'subdomain_fu/routing_extensions'
+#require 'subdomain_fu/routing_extensions'
 require 'subdomain_fu/url_rewriter'
 
 module SubdomainFu
@@ -49,10 +49,14 @@ 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)
+        host
+      else
+        change_subdomain_of_host(SubdomainFu.preferred_mirror, host)
+      end
     else
-      change_subdomain_of_host(subdomain, host)
+      change_subdomain_of_host(subdomain || SubdomainFu.preferred_mirror, host)
     end
   end
   
@@ -65,9 +69,24 @@ 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)
+    subdomain = request.subdomains(SubdomainFu.tld_size).join(".")
+    if has_subdomain?(subdomain)
+      subdomain
+    else
+      nil
+    end
   end
   
   module Controller
@@ -78,7 +97,7 @@ module SubdomainFu
     protected
     
     def current_subdomain
-      request.subdomains(SubdomainFu.tld_size).join(".")
+      SubdomainFu.current_subdomain(request)
     end
   end
 end

data/lib/subdomain_fu/routing_extensions.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
@@ -9,15 +10,16 @@ module SubdomainFu
 
     def recognition_conditions_with_subdomain
       result = recognition_conditions_without_subdomain
-      result << "conditions[:subdomain] === env[:subdomain]" if conditions[:subdomain] && conditions[:subdomain] != true
+      result << "conditions[:subdomain] === env[:subdomain]" if conditions[:subdomain] && conditions[:subdomain] != true && conditions[:subdomain] != false
       result << "SubdomainFu.has_subdomain?(env[:subdomain])" if conditions[:subdomain] == true
+      result << "!SubdomainFu.has_subdomain?(env[:subdomain])" if conditions[:subdomain] == false
       result
     end
   end
   
   module RouteSetExtensions
     def self.included(base)
-      base.alias_method_chain :extract_request_environment, :subdomain      
+      base.alias_method_chain :extract_request_environment, :subdomain  
     end
 
     def extract_request_environment_with_subdomain(request)
@@ -25,4 +27,7 @@ module SubdomainFu
       env.merge(:host => request.host, :domain => request.domain, :subdomain => SubdomainFu.subdomain_from(request.host))
     end
   end
-end
+end
+
+ActionController::Routing::RouteSet.send :include, SubdomainFu::RouteSetExtensions
+ActionController::Routing::Route.send :include, SubdomainFu::RouteExtensions

data/lib/subdomain_fu/url_rewriter.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

data/rails/init.rb

@@ -2,7 +2,4 @@ require 'subdomain-fu'
 
 ActionController::Base.send :include, SubdomainFu::Controller
 
-ActionController::Routing::RouteSet.send :include, SubdomainFu::RouteSetExtensions
-ActionController::Routing::Route.send :include, SubdomainFu::RouteExtensions
-
 RAILS_DEFAULT_LOGGER.info("** SubdomainFu: initialized properly")

data/spec/spec_helper.rb

@@ -9,11 +9,25 @@ plugin_spec_dir = File.dirname(__FILE__)
 ActiveRecord::Base.logger = Logger.new(plugin_spec_dir + "/debug.log")
 
 ActionController::Routing::Routes.draw do |map|
-  map.needs_subdomain '/needs_subdomain', :controller => "fu", :action => "awesome", :conditions => {:subdomain => true}
-  map.resources :fu_somethings, :conditions => {:subdomain => true}
+  map.needs_subdomain '/needs_subdomain', :controller => "fu", :action => "awesome"
+  map.no_subdomain '/no_subdomain', :controller => "fu", :action => "lame"
+  map.needs_awesome '/needs_awesome', :controller => "fu", :action => "lame"
+  
+  map.resources :foos do |fu|
+    fu.resources :bars
+  end
+  
   map.connect '/:controller/:action/:id'
 end
 
+class Paramed
+  def initialize(param)
+    @param = param
+  end
+  
+  def to_param
+    @param || "param"
+  end
+end
 
-include ActionController::UrlWriter
-default_url_options[:host] = "testapp.com"
+include ActionController::UrlWriter

data/spec/subdomain_fu_spec.rb

@@ -98,6 +98,28 @@ describe "SubdomainFu" do
     end
   end
   
+  describe "#current_subdomain" do
+    it "should return the current subdomain if there is one" do
+      request = mock("request", :subdomains => ["awesome"])
+      SubdomainFu.current_subdomain(request).should == "awesome"
+    end
+    
+    it "should return nil if there's no subdomain" do
+      request = mock("request", :subdomains => [])
+      SubdomainFu.current_subdomain(request).should be_nil
+    end
+    
+    it "should return nil if the current subdomain is a mirror" do
+      request = mock("request", :subdomains => ["www"])
+      SubdomainFu.current_subdomain(request).should be_nil
+    end
+    
+    it "should return the whole thing (including a .) if there's multiple subdomains" do
+      request = mock("request", :subdomains => ["awesome","rad"])
+      SubdomainFu.current_subdomain(request).should == "awesome.rad"
+    end
+  end
+  
   describe "#same_subdomain?" do
     it { SubdomainFu.same_subdomain?("www","www.localhost").should be_true }
     it { SubdomainFu.same_subdomain?("www","localhost").should be_true }

data/spec/url_rewriter_spec.rb

@@ -3,6 +3,7 @@ require File.dirname(__FILE__) + '/spec_helper'
 describe "SubdomainFu URL Writing" do
   before do
     SubdomainFu.tld_size = 1
+    default_url_options[:host] = "testapp.com"
   end
   
   describe "#url_for" do
@@ -43,8 +44,52 @@ describe "SubdomainFu URL Writing" do
     end
   end
   
+  describe "Resourced Routes" do
+    it "should be able to add a subdomain" do
+      foo_path(:id => "something", :subdomain => "awesome").should == "http://awesome.testapp.com/foos/something"
+    end
+    
+    it "should be able to remove a subdomain" do
+      default_url_options[:host] = "awesome.testapp.com"
+      foo_path(:id => "something", :subdomain => false).should == "http://testapp.com/foos/something"
+    end
+
+    it "should work when passed in a paramable object" do
+      foo_path(Paramed.new("something"), :subdomain => "awesome").should == "http://awesome.testapp.com/foos/something"
+    end
+    
+    it "should work on nested resource collections" do
+      foo_bars_path(Paramed.new("something"), :subdomain => "awesome").should == "http://awesome.testapp.com/foos/something/bars"
+    end
+    
+    it "should work on nested resource members" do
+      foo_bar_path(Paramed.new("something"),Paramed.new("else"), :subdomain => "awesome").should == "http://awesome.testapp.com/foos/something/bars/else"
+    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] = "testapp.com"
+    default_url_options[:host] = "localhost"
   end
 end

data/subdomain-fu.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = "subdomain-fu"
-  s.version = "0.0.1"
-  s.date = "2008-06-13"
+  s.version = "0.0.2"
+  s.date = "2008-06-25"
   s.summary = "Provides a simple solution for route handling and linking between subdomains in a Rails application."
   s.email = "michael@intridea.com"
   s.homepage = "http://www.actsascommunity.com/projects/subdomain-fu"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mbleigh-subdomain-fu
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Michael Bleigh
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-13 00:00:00 -07:00
+date: 2008-06-25 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -57,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.0.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Provides a simple solution for route handling and linking between subdomains in a Rails application.