Move multisite into trunk

git-svn-id: https://rails-multisite.googlecode.com/svn/trunk@13 64db17d9-5632-0410-b012-75deaefb9678

Author: gabriel.d

multisite/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Gabe da Silveira, based on code from theme_support by Matt McCray, based on code from Typo by Tobias Luetke
+
+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

multisite/README

@@ -0,0 +1,66 @@
+= Multisite for Rails Applications
+
+This plugin provides basic support for hosting multiple sites on the same Rails code base.  It is based on Matt McCray's theme_support plugin, but is essentially completely gutted and rewritten with a different focus.  
+
+The essential functionality of the plugin is to add a specific site's views to the view path.  The concept of a view_path is new to Rails 2.0.
+
+== Requirements
+
+* This plugin is tested in Rails 2.0.2.
+* Template caching must be disabled (this includes both cache_template_loading and cache_template_extensions action_view config options)
+
+== Differences from theme_support 
+
+If you are familiar with theme_support, a 'site' is equivalent to a 'theme' in the old system.  The big difference is that this plugin doesn't make any arrangements for presenting public files.  Although a public directory is created by the generator, this can just as easily be a symlink to another directory.  The intended use is to configure Apache to provide access to static files for each domain, possibly with a rewrite rule falling back to the main Rails public directory.  This approach was chosen because the static file caching in theme_support required long paths to static files that should be unnecessary when they are created on a per-domain basis.  By letting Apache handle the specifics, static files are much simpler (no image URL coupling to the theme name, or cache expiration problems), and converting raw HTML mockups from designers tends to be much easier as well.
+
+While theme_support only officially worked through Rails 1.1, and 1.2 with some 3rd party patches (Matt where are you?), this plugin requires Rails 2.0 for the Multiple View Path functionality (http://weblog.rubyonrails.com/2007/2/4/new-feature-for-rails-2-0-multiple-controller-view-paths).  This addition to Rails makes much of the remaining complexity of the theme_support plugin disappear.  One big bonus is that templates can now be created on a per-site basis without a parent template having to exist in the base directory.  This is handy for creating extra content pages or breaking things down into partials.  
+
+== Usage
+
+You can use the site_generator to create the file structure needed, or create it 
+yourself.
+
+It expects the following site folder structure.
+
+  $app_root
+    sites/
+      [site_name]
+        views/           <- you can override application views
+        public/          <- intended to be the DOCUMENT_ROOT of the site
+
+  You specify which site to use in your controller by using 
+the declarative 'site' syntax.  Although this could be automated based on domain
+name, the relationship between domains and sites is not necessarily 1:1, so you will
+need to develop a mechanism for choosing a 'site'.
+
+  class ApplicationController < ActionController::Base
+    site 'blue_bird'
+
+    ...
+  end
+
+You can also defer the theme lookup to a controller method:
+
+  class ApplicationController < ActionController::Base
+    site :get_site
+
+    def get_site
+      domain = Domain.find_by_name(request.domain)
+      domain.theme
+    end
+
+    ...
+  end
+
+
+Note: By setting the site in the ApplicationController you can set 
+the site for the whole application.
+
+== Changelog
+
+  1.0.0 - Initial release
+
+
+---
+Copyright (c) 2007-2008 Gabe da Silveira, based on code from theme_support by Matt McCray, based on code from Typo by Tobias Luetke 
+released under the MIT license

multisite/generators/site/USAGE

@@ -0,0 +1,15 @@
+NAME
+     site - Creates the folder structure for a new site using multisite
+
+SYNOPSIS
+     site [site_name]
+
+DESCRIPTION
+     This generator creates the folder structure for a new site. It creates one folder for views,
+     and one for any public files.  The public files can be setup as the DOCUMENT_ROOT in Apache
+     with a redirect to the base public directory.
+
+EXAMPLE
+     ./script/generate site domain
+
+     This will generate the file structure for a site named 'domain'. 

multisite/generators/site/site_generator.rb

@@ -0,0 +1,12 @@
+class SiteGenerator < Rails::Generator::NamedBase
+     
+   def manifest
+      record do |m|
+          # Site folder(s)
+          m.directory File.join( "sites", file_name )
+          # Site content folders
+          m.directory File.join( "sites", file_name, "views" )
+          m.directory File.join( "sites", file_name, "public" )
+      end
+   end
+end

multisite/init.rb

@@ -0,0 +1,2 @@
+# Initializes multisite support by adding a macro to ActionController::Base
+require 'patches/actioncontroller_ex'

multisite/lib/patches/actioncontroller_ex.rb

@@ -0,0 +1,45 @@
+# Extend the Base ActionController to support multiple site
+ActionController::Base.class_eval do 
+
+  attr_accessor :current_site
+
+  # Use this in your controller just like the <tt>layout</tt> macro.
+  # Example:
+  #
+  #  site 'maybe_domain'
+  #
+  # -or-
+  #
+  #  site :get_site
+  #
+  #  def get_site
+  #    'maybe_domain'
+  #  end
+  def self.site(site_name)
+    write_inheritable_attribute "site", site_name
+    before_filter :add_multisite_path
+  end
+
+  # Retrieves the current set site
+  def current_site(passed_site=nil)
+    site = passed_site || self.class.read_inheritable_attribute("site")
+
+    @active_site = case site
+      when Symbol then send(site)
+      when Proc   then site.call(self)
+      when String then site
+    end
+  end
+
+  protected
+  def add_multisite_path
+    if current_site
+      raise "Multisite plugin is incompatible with template caching.  You must set config.action_view.cache_template_loading to false in your environment." if ActionView::Base.cache_template_loading
+      raise "Multisite plugin is incompatible with template extension caching.  You must set config.action_view.cache_template_extensions to false in your environment." if ActionView::Base.cache_template_extensions
+      new_path = File.join(RAILS_ROOT, 'sites', @active_site, 'views')
+      @template.prepend_view_path(new_path)
+      logger.info "  Template View Paths: #{@template.view_paths.inspect}"
+    end
+    return true
+  end
+end