mbleigh-subdomain-fu 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2008 Michael Bleigh (http://www.mbleigh.com) and 
+                   Intridea, Inc (http://www.intridea.com)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,64 @@
+SubdomainFu
+===========
+
+SubdomainFu provides a modern implementation of subdomain handling in Rails.
+It takes aspects from account_location, request_routing, and other snippets
+found around the web and combines them to provide a single, simple solution
+for subdomain-based route and url management.
+
+Installation
+============
+
+SubdomainFu is available both as a traditional plugin and a GemPlugin. To
+install it as a traditional plugin (Rails 2.1 or later):
+
+  script/plugin install git://github.com/mbleigh/subdomain-fu.git
+  
+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"
+
+Configuration
+=============
+
+You may need to configure SubdomainFu based on your development setup. The
+configuration required is:
+
+tld_size
+--------
+
+A hash for each environment of the size of the top-level domain name. 
+(something.com = 1, localhost = 0, etc.)
+
+SubdomainFu.tld_size = 1 # sets for current environment
+SubdomainFu.tld_sizes = {:development => 0,
+                         :test => 0,
+                         :production => 1} # set all at once (also the defaults)
+                         
+mirrors
+-------
+
+Mirrors are the subdomains that are equivalent to no subdomain (i.e. they 'mirror')
+the usage of the root domain.
+
+SubdomainFu.mirrors = %w(www site we) # Defaults to %w(www)
+
+Examples
+========
+
+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:
+
+url_for(:controller => "my_controller", :action => "my_action", :subdomain => "awesome")
+users_url(:subdomain => false) # specifying "false" will remove any current subdomain
+
+Known Issues / TODO
+===================
+
+* 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.
+
+Copyright (c) 2008 Michael Bleigh (http://www.mbleigh.com/) and 
+Intridea, Inc. (http://www.intridea.com/). Released under the MIT license

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/lib/subdomain-fu.rb

@@ -0,0 +1,84 @@
+require 'subdomain_fu/routing_extensions'
+require 'subdomain_fu/url_rewriter'
+
+module SubdomainFu
+  # The length of the period-split top-level domain for each environment.
+  # For example, "localhost" has a tld_size of zero, and "something.co.uk"
+  # has a tld_size of two.
+  #
+  # To set a tld size for a given environment, just call SubdomainFu.tld_sizes[:environment] = value
+  DEFAULT_TLD_SIZES = {:development => 0, :test => 0, :production => 1}
+  mattr_accessor :tld_sizes
+  @@tld_sizes = DEFAULT_TLD_SIZES.dup
+  
+  # Subdomains that are equivalent to going to the website with no subdomain at all.
+  # Defaults to "www" as the only member.
+  mattr_accessor :mirrors
+  @@mirrors = %w(www)
+  
+  mattr_accessor :preferred_mirror
+  @@preferred_mirror = nil
+  
+  # Returns the TLD Size of the current environment.
+  def self.tld_size
+    tld_sizes[RAILS_ENV.to_sym]
+  end
+  
+  # Sets the TLD Size of the current environment
+  def self.tld_size=(value)
+    tld_sizes[RAILS_ENV.to_sym] = value
+  end
+  
+  # Is the current subdomain either nil or a mirror?
+  def self.has_subdomain?(subdomain)
+    !subdomain.blank? && !SubdomainFu.mirrors.include?(subdomain)
+  end
+  
+  # Gets the subdomain from the host based on the TLD size
+  def self.subdomain_from(host)
+    return nil unless host
+    parts = host.split('.')
+    sub = parts[0..-(SubdomainFu.tld_size+2)].join(".")
+    sub.blank? ? nil : sub
+  end
+  
+  def self.host_without_subdomain(host)
+    parts = host.split('.')
+    parts[-(SubdomainFu.tld_size+1)..-1].join(".")
+  end
+  
+  # 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
+    else
+      change_subdomain_of_host(subdomain, host)
+    end
+  end
+  
+  # Changes the subdomain of the host to whatever is passed in.
+  def self.change_subdomain_of_host(subdomain, host)
+    host = SubdomainFu.host_without_subdomain(host)
+    host = "#{subdomain}.#{host}" if subdomain
+    host
+  end
+  
+  # Is this subdomain equivalent to the subdomain found in this host string?
+  def self.same_subdomain?(subdomain, host)
+    result = subdomain == SubdomainFu.subdomain_from(host) || 
+      (!SubdomainFu.has_subdomain?(subdomain) && !SubdomainFu.has_subdomain?(SubdomainFu.subdomain_from(host)))
+    result
+  end
+  
+  module Controller
+    def self.included(controller)
+      controller.helper_method(:current_subdomain)
+    end
+    
+    protected
+    
+    def current_subdomain
+      request.subdomains(SubdomainFu.tld_size).join(".")
+    end
+  end
+end

data/lib/subdomain_fu/routing_extensions.rb

@@ -0,0 +1,28 @@
+# Thanks to Jamis Buck for ideas on this stuff
+# http://weblog.jamisbuck.org/2006/10/26/monkey-patching-rails-extending-routes-2
+
+module SubdomainFu
+  module RouteExtensions
+    def self.included(base)
+      base.alias_method_chain :recognition_conditions, :subdomain
+    end
+
+    def recognition_conditions_with_subdomain
+      result = recognition_conditions_without_subdomain
+      result << "conditions[:subdomain] === env[:subdomain]" if conditions[:subdomain] && conditions[:subdomain] != true
+      result << "SubdomainFu.has_subdomain?(env[:subdomain])" if conditions[:subdomain] == true
+      result
+    end
+  end
+  
+  module RouteSetExtensions
+    def self.included(base)
+      base.alias_method_chain :extract_request_environment, :subdomain      
+    end
+
+    def extract_request_environment_with_subdomain(request)
+      env = extract_request_environment_without_subdomain(request)
+      env.merge(:host => request.host, :domain => request.domain, :subdomain => SubdomainFu.subdomain_from(request.host))
+    end
+  end
+end

data/lib/subdomain_fu/url_rewriter.rb

@@ -0,0 +1,29 @@
+module ActionController
+  module UrlWriter
+    def url_for_with_subdomains(options)
+      if SubdomainFu.same_subdomain?(options[:subdomain], options[:host] || default_url_options[:host])
+        options.delete(:subdomain)
+      else
+        options[:only_path] = false 
+        options[:host] = SubdomainFu.rewrite_host_for_subdomains(options.delete(:subdomain), options[:host] || default_url_options[:host])
+      end
+      url_for_without_subdomains(options)
+    end
+    alias_method_chain :url_for, :subdomains
+  end
+  
+  class UrlRewriter #:nodoc:
+    private
+    
+    def rewrite_url_with_subdomains(options)
+      if SubdomainFu.same_subdomain?(options[:subdomain], (options[:host] || @request.host_with_port))
+        options.delete(:subdomain)
+      else
+        options[:only_path] = false
+        options[:host] = SubdomainFu.rewrite_host_for_subdomains(options.delete(:subdomain), options[:host] || @request.host_with_port)
+      end
+      rewrite_url_without_subdomains(options)
+    end
+    alias_method_chain :rewrite_url, :subdomains
+  end
+end

data/rails/init.rb

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,19 @@
+begin
+  require File.dirname(__FILE__) + '/../../../../spec/spec_helper'
+rescue LoadError
+  puts "You need to install rspec in your base app"
+  exit
+end
+
+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.connect '/:controller/:action/:id'
+end
+
+
+include ActionController::UrlWriter
+default_url_options[:host] = "testapp.com"

data/spec/subdomain_fu_spec.rb

@@ -0,0 +1,109 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "SubdomainFu" do
+  describe "TLD Sizes" do
+    before do
+      SubdomainFu.tld_sizes = SubdomainFu::DEFAULT_TLD_SIZES.dup
+    end
+    
+    it { SubdomainFu.tld_sizes.should be_kind_of(Hash) }
+  
+    it "should have default values for development, test, and production" do
+      SubdomainFu.tld_sizes[:development].should == 0
+      SubdomainFu.tld_sizes[:test].should        == 0
+      SubdomainFu.tld_sizes[:production].should  == 1
+    end
+    
+    it "#tld_size should be for the current environment" do
+      SubdomainFu.tld_size.should == SubdomainFu.tld_sizes[RAILS_ENV.to_sym]
+    end
+    
+    it "should be able to be set for the current environment" do
+      SubdomainFu.tld_size = 5
+      SubdomainFu.tld_size.should == 5
+      SubdomainFu.tld_sizes[:test].should == 5
+    end
+  end
+  
+  describe "#has_subdomain?" do
+    it "should be true for non-mirrored subdomains" do
+      SubdomainFu.has_subdomain?("awesome").should be_true
+    end
+    
+    it "should be false for mirrored subdomains" do
+      SubdomainFu.has_subdomain?(SubdomainFu.mirrors.first).should be_false
+    end
+    
+    it "shoud be false for a nil or blank subdomain" do
+      SubdomainFu.has_subdomain?("").should be_false
+      SubdomainFu.has_subdomain?(nil).should be_false
+    end
+  end
+  
+  describe "#subdomain_from" do
+    it "should return the subdomain based on the TLD of the current environment" do
+      SubdomainFu.subdomain_from("awesome.localhost").should == "awesome"
+      SubdomainFu.tld_size = 1
+      SubdomainFu.subdomain_from("awesome.localhost.com").should == "awesome"
+      SubdomainFu.tld_size = 0
+    end
+    
+    it "should join deep subdomains with a period" do
+      SubdomainFu.subdomain_from("awesome.coolguy.localhost").should == "awesome.coolguy"
+    end
+    
+    it "should return nil for no subdomain" do
+      SubdomainFu.subdomain_from("localhost").should be_nil
+    end
+  end
+  
+  it "#host_without_subdomain should chop of the subdomain and return the rest" do
+    SubdomainFu.host_without_subdomain("awesome.localhost:3000").should == "localhost:3000"
+    SubdomainFu.host_without_subdomain("something.awful.localhost:3000").should == "localhost:3000"
+  end
+  
+  describe "#rewrite_host_for_subdomains" do
+    it "should not change the same subdomain" do
+      SubdomainFu.rewrite_host_for_subdomains("awesome","awesome.localhost").should == "awesome.localhost"
+    end
+    
+    it "should not change an equivalent (mirrored) subdomain" do
+      SubdomainFu.rewrite_host_for_subdomains("www","localhost").should == "localhost"
+    end
+    
+    it "should change the subdomain if it's different" do
+      SubdomainFu.rewrite_host_for_subdomains("cool","www.localhost").should == "cool.localhost"
+    end
+    
+    it "should remove the subdomain if passed nil when it's not a mirror" do
+      SubdomainFu.rewrite_host_for_subdomains(nil,"cool.localhost").should == "localhost"
+    end
+    
+    it "should not remove the subdomain if passed nil when it is a mirror" do
+      SubdomainFu.rewrite_host_for_subdomains(nil,"www.localhost").should == "www.localhost"
+    end
+  end
+  
+  describe "#change_subdomain_of_host" do
+    it "should change it if passed a different one" do
+      SubdomainFu.change_subdomain_of_host("awesome","cool.localhost").should == "awesome.localhost"
+    end
+    
+    it "should remove it if passed nil" do
+      SubdomainFu.change_subdomain_of_host(nil,"cool.localhost").should == "localhost"
+    end
+    
+    it "should add it if there isn't one" do
+      SubdomainFu.change_subdomain_of_host("awesome","localhost").should == "awesome.localhost"
+    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 }
+    it { SubdomainFu.same_subdomain?("awesome","www.localhost").should be_false }
+    it { SubdomainFu.same_subdomain?("cool","awesome.localhost").should be_false }
+    it { SubdomainFu.same_subdomain?(nil,"www.localhost").should be_true }
+    it { SubdomainFu.same_subdomain?("www","awesome.localhost").should be_false }
+  end
+end

data/spec/url_rewriter_spec.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "SubdomainFu URL Writing" do
+  before do
+    SubdomainFu.tld_size = 1
+  end
+  
+  describe "#url_for" do
+    it "should be able to add a subdomain" do
+      url_for(:controller => "something", :action => "other", :subdomain => "awesome").should == "http://awesome.testapp.com/something/other" 
+    end
+  
+    it "should be able to remove a subdomain" do
+      url_for(:controller => "something", :action => "other", :subdomain => false, :host => "awesome.testapp.com").should == "http://testapp.com/something/other" 
+    end
+    
+    it "should not change a mirrored subdomain" do
+      url_for(:controller => "something", :action => "other", :subdomain => false, :host => "www.testapp.com").should == "http://www.testapp.com/something/other" 
+    end
+    
+    it "should should force the full url, even with :only_path" do
+      url_for(:controller => "something", :action => "other", :subdomain => "awesome", :only_path => true).should == "http://awesome.testapp.com/something/other" 
+    end
+  end
+  
+  describe "Standard Routes" do
+    it "should be able to add a subdomain" do
+      needs_subdomain_url(:subdomain => "awesome").should == "http://awesome.testapp.com/needs_subdomain"
+    end
+
+    it "should be able to remove a subdomain" do
+      default_url_options[:host] = "awesome.testapp.com"
+      needs_subdomain_url(:subdomain => false).should == "http://testapp.com/needs_subdomain"
+    end
+
+    it "should not change a mirrored subdomain" do
+      default_url_options[:host] = "www.testapp.com"
+      needs_subdomain_url(:subdomain => false).should == "http://www.testapp.com/needs_subdomain"
+    end
+
+    it "should should force the full url, even with _path" do
+      needs_subdomain_path(:subdomain => "awesome").should == needs_subdomain_url(:subdomain => "awesome")
+    end
+  end
+  
+  after do
+    SubdomainFu.tld_size = 0
+    default_url_options[:host] = "testapp.com"
+  end
+end

data/subdomain-fu.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+  s.name = "subdomain-fu"
+  s.version = "0.0.1"
+  s.date = "2008-06-13"
+  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"
+  s.description = "SubdomainFu aims to solve the problem of subdomain-based routing and in a unified way, establishing simple conventions for linking between subdomains of a Rails app."
+  s.has_rdoc = true
+  s.authors = ["Michael Bleigh"]
+  s.files = [ "MIT-LICENSE",
+              "README",
+              "init.rb",
+              "lib/subdomain_fu",
+              "lib/subdomain_fu/routing_extensions.rb",
+              "lib/subdomain_fu/url_rewriter.rb",
+              "lib/subdomain-fu.rb",
+              "rails/init.rb",
+              "spec/spec_helper.rb",
+              "spec/subdomain_fu_spec.rb",
+              "spec/url_rewriter_spec.rb",
+              "subdomain-fu.gemspec" ]
+  s.rdoc_options = ["--main", "README"]
+  #s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+  #s.add_dependency("mbleigh-mash", [">= 0.0.5"])
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: mbleigh-subdomain-fu
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michael Bleigh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-13 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: SubdomainFu aims to solve the problem of subdomain-based routing and in a unified way, establishing simple conventions for linking between subdomains of a Rails app.
+email: michael@intridea.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- README
+- init.rb
+- lib/subdomain_fu
+- lib/subdomain_fu/routing_extensions.rb
+- lib/subdomain_fu/url_rewriter.rb
+- lib/subdomain-fu.rb
+- rails/init.rb
+- spec/spec_helper.rb
+- spec/subdomain_fu_spec.rb
+- spec/url_rewriter_spec.rb
+- subdomain-fu.gemspec
+has_rdoc: true
+homepage: http://www.actsascommunity.com/projects/subdomain-fu
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Provides a simple solution for route handling and linking between subdomains in a Rails application.
+test_files: []
+