trusty-multi-site-extension 1.0.0

data/multi_site_extension.rb

@@ -0,0 +1,66 @@
+require_dependency 'application_controller'
+
+class MultiSiteExtension < TrustyCms::Extension
+  version "1.0.0"
+  description %{ Enables virtual sites to be created with associated domain names.
+                 Also scopes the sitemap view to any given page (or the root of an
+                 individual site) and allows model classes to be scoped by site. }
+  url "http://trustarts.org/"
+
+
+  def activate
+    # ActionController::Routing modules are required rather than sent as includes
+    # because the routing persists between dev. requests and is not compatible
+    # with multiple alias_method_chain calls.
+    
+    # likewise for ScopedValidation, which is a pre-emptive hack that shouldn't run more than once.
+
+
+    # Model extensions
+    ActiveRecord::Base.send :include, MultiSite::ScopedModel
+    Page.send :include, MultiSite::PageExtensions
+
+    # Controller extensions
+    ApplicationController.send :include, MultiSite::ApplicationControllerExtensions
+    Admin::ResourceController.send :include, MultiSite::ApplicationControllerExtensions
+    ApplicationController.send :include, MultiSite::ApplicationControllerFilterExtensions
+    #ActionController::Base.send :include, MultiSite::ApplicationControllerExtensions
+    SiteController.send :include, MultiSite::SiteControllerExtensions
+    Admin::ResourceController.send :include, MultiSite::ResourceControllerExtensions
+    Admin::PagesController.send :include, MultiSite::PagesControllerExtensions
+    Admin::ResourceController.send :helper, MultiSite::SiteChooserHelper
+    Admin::PagesController.send :helper, MultiSite::SiteChooserHelper
+    admin.layouts.index.add(:top, "site_chooser")
+    admin.pages.index.add(:top, "admin/layouts/site_chooser")
+    admin.snippets.index.add(:top, "admin/layouts/site_chooser")
+    Layout.send :is_site_scoped
+    Snippet.send :is_site_scoped
+    User.send :is_site_scoped, :shareable => true
+    ApplicationHelper.send :include, ScopedHelper
+
+    unless admin.users.edit.form && admin.users.edit.form.include?('choose_site')
+      admin.users.edit.add :form, "choose_site", :after => "edit_roles"
+      admin.layouts.edit.add :form, "choose_site", :before => "edit_timestamp"
+      admin.snippets.edit.add :form, "choose_site", :before => "edit_filter" unless admin.snippets.edit.form.include?("choose_site")
+    end
+
+
+    unless defined? admin.site
+      TrustyCms::AdminUI.send :include, MultiSite::AdminUI
+      admin.site = TrustyCms::AdminUI.load_default_site_regions
+    end
+    
+    if respond_to?(:tab)
+      tab("Settings") do
+        add_item "Sites", "/admin/sites", :after => "Extensions", :visibility => [:admin]
+      end
+    else
+      admin.tabs.add "Sites", "/admin/sites", :visibility => [:admin]
+    end
+  end
+
+  def deactivate
+  end
+end
+
+class ActiveRecord::SiteNotFound < Exception; end

data/spec/controllers/extended_site_controller_spec.rb

@@ -0,0 +1,61 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe SiteController do
+  dataset :sites
+
+  before do
+    # I don't know why we're not getting the site routes
+    # possibly because of the routing tests?
+    # but without them, controller tests fail
+    ActionController::Routing::Routes.draw do |map|
+      map.connect '*url', :controller => 'site', :action => 'show_page'
+    end
+  end
+  
+  describe "with a request that matches no site" do
+    before do
+      Page.current_site = nil
+      @host = 'nosite.domain.com'
+      controller.request.stub!(:host).and_return(@host)
+    end
+    
+    it "should have chosen the catchall site" do
+      Page.should_receive(:current_site=).with(sites(:default)).at_least(:once)
+      get :show_page, :url => '/'
+    end
+  end 
+  
+  describe "with a request that matches a site" do
+    before do
+      Page.current_site = nil
+      @host = 'yoursite.domain.com'
+      controller.request.stub!(:host).and_return(@host)
+    end
+        
+    it "should have chosen the matching site" do
+      Page.should_not_receive(:current_site=).with(sites(:default))
+      Page.should_receive(:current_site=).with(sites(:yoursite)).at_least(:once)
+      get :show_page, :url => '/yourpage'
+    end
+    
+    it "should return a page from the present site" do
+      get :show_page, :url => '/yourpage'
+      response.should be_success
+      response.body.should == "This is your other page body."
+    end
+    
+    describe "but for a page from another site" do
+      it "should return 404" do
+        get :show_page, :url => '/mypage'
+        response.should be_missing
+      end
+    end
+
+    describe "but for a page that doesn't exist" do
+      it "should still return 404" do
+        get :show_page, :url => '/notanyonespage'
+        response.should be_missing
+      end
+    end
+  end
+end

data/spec/datasets/site_pages_dataset.rb

@@ -0,0 +1,13 @@
+class SitePagesDataset < Dataset::Base
+  uses :home_page
+  
+  def load
+    create_page "Myhomepage", :body => 'This is my page', :slug => '/' do
+      create_page "Myotherpage", :body => 'This is my other page', :slug => 'mypage'
+    end
+    create_page "Yourhomepage", :body => 'This is your home page', :slug => '/' do
+      create_page "Yourotherpage", :body => 'This is your other page', :slug => 'yourpage'
+    end
+  end
+  
+end

data/spec/datasets/sites_dataset.rb

@@ -0,0 +1,10 @@
+class SitesDataset < Dataset::Base
+  uses :site_pages
+  
+  def load
+    create_record Site, :mysite, :name => 'My Site', :domain => 'mysite.domain.com', :base_domain => 'mysite.domain.com', :position => 1, :homepage_id => page_id(:myhomepage)
+    create_record Site, :yoursite, :name => 'Your Site', :domain => '^yoursite', :base_domain => 'yoursite.test.com', :position => 2, :homepage_id => page_id(:yourhomepage)
+    create_record Site, :default, :name => 'Default', :base_domain => 'digitalpulp\.com', :position => 3, :homepage_id => page_id(:home)
+    create_record Site, :testing, :name => 'Test host', :domain => '^test\.', :base_domain => 'test.host', :position => 6
+  end
+end

data/spec/functional/multi_site_routing_spec.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+TestController = Class.new(ApplicationController)
+
+describe TestController, "for MultiSite routing" do
+  dataset :sites
+  
+  before(:all) do
+    ActionController::Routing::Routes.clear!
+    ActionController::Routing::Routes.draw do |map|
+      map.connect '/single', :controller => 'test', :action => "index", :conditions => { :site => 'My Site' }
+      map.connect '/multi', :controller =>  'test', :action => "index", :conditions => { :site => ['My Site', 'Your Site'] }
+    end
+  end
+
+  describe "with single site" do
+    it "should recognize routing" do
+      {:controller => 'test', :action => 'index'}.should recognize_request("http://mysite.domain.com/single")
+    end
+
+    it "should not recognize an undefined route" do
+      {:controller => 'test', :action => 'index'}.should_not recognize_request("http://yoursite.domain.com/single")
+    end
+  end
+
+  describe "with multiple sites" do
+    it "should recognize routing" do
+      {:controller => 'test', :action => "index"}.should recognize_request("http://mysite.domain.com/multi")
+      {:controller => 'test', :action => "index"}.should recognize_request("http://yoursite.domain.com/multi")
+    end
+
+    it "should not recognize an undefined route" do
+      {:controller => 'test', :action => "index"}.should_not recognize_request("http://digitalpulp.com/multi")
+    end
+  end
+
+end

data/spec/lib/multi_site/admin_ui_spec.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + "/../../spec_helper"
+
+describe "AdminUI extensions for multi_site" do
+  before :each do
+    @admin = Radiant::AdminUI.new
+    @admin.site = Radiant::AdminUI.load_default_site_regions
+  end
+
+  it "should be included into Radiant::AdminUI" do
+    Radiant::AdminUI.included_modules.should include(MultiSite::AdminUI)
+  end
+
+  it "should define a collection of Region Sets for sites" do
+    @admin.should respond_to('site')
+    @admin.should respond_to('sites')
+    @admin.send('site').should_not be_nil
+    @admin.send('site').should be_kind_of(OpenStruct)
+  end
+
+  describe "should define default regions" do
+    %w{new edit remove index}.each do |action|
+      
+      describe "for '#{action}'" do
+        before do
+          @site = @admin.site
+          @site.send(action).should_not be_nil
+        end
+              
+        it "as a RegionSet" do
+          @site.send(action).should be_kind_of(Radiant::AdminUI::RegionSet)
+        end
+      end
+    end
+  end
+end

data/spec/lib/multi_site/scoped_model_spec.rb

@@ -0,0 +1,182 @@
+require File.dirname(__FILE__) + "/../../spec_helper"
+
+describe 'extended AR::Base' do
+  it "should respond to is_site_scoped" do
+    ActiveRecord::Base.respond_to?(:is_site_scoped).should be_true
+  end
+end
+
+
+# I need to change this to use an arbitrary model. at the moment these tests fail unless scoped_admin is installed, which is no help
+
+
+# describe "scoped, unshareable model", :type => :model do
+#   dataset :sites
+#   dataset :users
+#   
+#   before do
+#     Page.stub!(:current_site).and_return(sites(:mysite))
+#     UserActionObserver.stub!(:current_user).and_return(users(:admin))
+#     Snippet.stub!(:site_id).and_return(site_id(:mysite))
+#     Snippet.send :is_site_scoped
+#   end
+#   
+#   it "should report itself site_scoped" do
+#     Snippet.is_site_scoped?.should be_true
+#   end
+# 
+#   it "should not report itself shareable" do
+#     Snippet.is_shareable?.should_not be_true
+#   end
+# 
+#   it "should have a site association" do
+#     Snippet.reflect_on_association(:site).should_not be_nil
+#   end
+# 
+#   it "should respond to current_site" do
+#     Snippet.respond_to?(:current_site).should be_true
+#   end
+# 
+#   it "should not respond to current_site=" do
+#     Snippet.respond_to?(:current_site=).should be_false
+#   end
+# 
+#   it "should return the correct current site" do
+#     Snippet.send(:current_site).should == sites(:mysite)
+#   end
+#   
+#   describe "when instantiated" do
+#     before do
+#       @in_my_site = Snippet.new(:name => 'test snippet in mysite')
+#     end
+#   
+#     it "should not yet have a site" do
+#       @in_my_site.site.should be_nil
+#     end
+# 
+#     it "should accept a site" do
+#       @in_my_site.site = sites(:mysite)
+#       @in_my_site.site.should == sites(:mysite)
+#     end
+#   end
+# 
+#   describe "when validated" do
+#     before do
+#       @in_my_site = Snippet.new(:name => 'test_snippet_in_mysite')
+#       @in_my_site.valid?
+#     end
+#     
+#     it "should have been given the current site" do
+#       @in_my_site.site.should_not be_nil
+#       @in_my_site.site.should == sites(:mysite)
+#     end
+#     
+#     describe "with site-scope" do
+#       before do
+#         @existing = Snippet.create!(:name => 'testy', :site_id => site_id(:mysite))
+#       end
+#       it "should be invalid if its name is already in use on this site" do
+#         snippet = Snippet.new(:name => 'testy')
+#         snippet.valid?.should_not be_true
+#         snippet.errors.should_not be_nil
+#         snippet.errors.on(:name).should_not be_nil
+#       end
+# 
+#       it "should be valid even though its name is already in use on another site" do
+#         snippet = Snippet.new(:name => 'testy', :site_id => site_id(:yoursite) )
+#         snippet.valid?.should be_true
+#       end
+#     end
+#   end 
+#   
+#   describe "on retrieval" do
+#     before do
+#       20.times { |i| @mine = Snippet.create!(:name => "snippet#{i}", :site_id => site_id(:mysite)) }
+#       20.times { |i| @yours = Snippet.create!(:name => "snippet#{i+20}", :site_id => site_id(:yoursite)) }
+#     end
+#     
+#     it "should find a snippet from the current site" do
+#       lambda {@snippet = Snippet.find(@mine.id)}.should_not raise_error(ActiveRecord::RecordNotFound)
+#       @snippet.should_not be_nil
+#       @snippet.site.should == sites(:mysite)
+#     end
+# 
+#     it "should find_by_name a snippet from the current site" do
+#       lambda {@snippet = Snippet.find_by_name('snippet10')}.should_not raise_error(ActiveRecord::RecordNotFound)
+#       @snippet.should_not be_nil
+#       @snippet.site.should == sites(:mysite)
+#     end
+# 
+#     it "should not find a snippet from another site" do
+#       lambda {@snippet = Snippet.find(@yours.id)}.should raise_error(ActiveRecord::RecordNotFound)
+#     end
+# 
+#     it "should not find_by_name a snippet from another site" do
+#       @snippet = Snippet.find_by_name('snippet30').should be_nil
+#     end
+# 
+#     it "should count only the snippets from this site" do
+#       Snippet.count(:all).should == 20
+#     end
+# 
+#   end
+# end
+# 
+# 
+# 
+# describe "scoped, shareable model", :type => :model do
+#   dataset :sites
+#   dataset :users
+# 
+#   before do
+#     User.stub!(:site_id).and_return(site_id(:mysite))
+#     User.stub!(:site_id=)
+#     User.send :is_site_scoped, :shareable => true
+#     Page.current_site = sites(:mysite)
+#   end
+# 
+#   describe "on instantiation with no site" do
+#     before do      
+#       @user = User.new(:name => 'test user', :login => 'test', :password => 'password', :email => 'test@spanner.org', :password_confirmation => 'password' )
+#       @otheruser = User.new(:name => 'other user', :site => sites(:yoursite), :login => 'other', :password => 'password', :email => 'other@spanner.org', :password_confirmation => 'password' )
+#     end
+#     
+#     it "should validate without a site" do
+#       @user.valid?.should be_true
+#       @user.site.should be_nil
+#     end
+# 
+#     it "should validate with a site" do
+#       @otheruser.valid?.should be_true
+#       @otheruser.site.should_not be_nil
+#     end
+#   end 
+# 
+#   describe "on retrieval" do
+#     before do      
+#       @user = User.create(:name => 'shared user', :login => 'shared', :password => 'password', :email => 'test@spanner.org', :password_confirmation => 'password' )
+#       @localuser = User.create(:name => 'local user', :site => sites(:mysite), :login => 'ocal', :password => 'password', :email => 'local@spanner.org', :password_confirmation => 'password' )
+#       @otheruser = User.create(:name => 'other user', :site => sites(:yoursite), :login => 'other', :password => 'password', :email => 'other@spanner.org', :password_confirmation => 'password' )
+#     end
+# 
+#     it "should find a user with no site" do
+#       lambda {User.find(@user.id)}.should_not raise_error(ActiveRecord::RecordNotFound)
+#     end
+#     
+#     it "should find a user from the current site" do
+#       lambda {User.find(@localuser.id)}.should_not raise_error(ActiveRecord::RecordNotFound)
+#     end
+# 
+#     it "should not find a user from another site" do
+#       lambda {User.find(@otheruser.id)}.should raise_error(ActiveRecord::RecordNotFound)
+#     end
+# 
+#     it "should count the users from this site or with no site" do
+#       # users_dataset creates 5 users with no site. we just made one shared and one local: total 7
+#       User.count(:all).should == 7
+#     end
+#   end
+#   
+#   
+#   
+#end

data/spec/matchers/route_matcher.rb

@@ -0,0 +1,38 @@
+module Spec
+  module Rails
+    module Matchers
+      
+      class Route
+        def initialize(url)
+          uri = URI.parse(url)
+          @request = ActionController::TestRequest.new
+          @request.env["HTTPS"] = uri.scheme == "https" ? "on" : nil
+          @request.host = uri.host
+          @request.request_uri = uri.path.empty? ? "/" : uri.path
+        end
+        
+        def matches?(options)
+          @options = options
+          begin
+            ActionController::Routing::Routes.recognize(@request) && @options == @request.symbolized_path_parameters
+          rescue # recognize raises an error
+            false
+          end
+        end
+        
+        def failure_message
+          "expected #{@request.request_uri} to be recognized as #{@options.inspect}"
+        end
+        
+        def negative_failure_message
+          "expected #{@request.request_uri} to not be recognized as #{@options.inspect}"
+        end
+      end
+      
+      def recognize_request(url)
+        Route.new(url)
+      end
+      
+    end
+  end
+end

data/spec/models/extended_page_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Page do
+  dataset :sites
+  
+  before do
+    @page = pages(:home)
+  end
+  
+  describe "#url" do
+    it "should alias default" do
+      @page.should respond_to(:url_with_sites)
+      @page.should respond_to(:url_without_sites)
+    end
+    
+    it "should override slug" do
+      @page.url.should eql('/')
+      @page.slug = "some-slug"
+      @page.url.should eql('/')
+    end
+  end
+
+  describe ".find_by_url" do
+    it "should default to the catchall site" do
+      Page.current_site = nil
+      Page.find_by_url("/").should == pages(:home)
+    end
+    
+    it "should find site-scoped pages" do
+      Page.current_site = sites(:mysite)
+      Page.find_by_url("/mypage").should == pages(:myotherpage)
+    end
+
+    it "should not find pages outside the site" do
+      Page.current_site = sites(:mysite)
+      Page.find_by_url("/yourotherpage").should be_nil
+    end
+  end
+  
+  describe "#destroy" do
+    it "should nullify homepage_id" do
+      sites(:mysite).homepage_id.should_not be_nil
+      pages(:home).destroy
+      sites(:mysite).reload.homepage_id.should be_nil
+    end
+  end
+
+end

data/spec/models/site_spec.rb

@@ -0,0 +1,83 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Site do
+  dataset :sites
+  
+  before do
+    @site = Site.new :name => "Test Site", :domain => "test", :homepage_id => 1, :base_domain => "test.host", :homepage_id => page_id(:home)
+  end
+  
+  it "should require a name" do
+    @site.name = nil
+    @site.should_not be_valid
+    @site.errors.on(:name).should_not be_empty
+  end
+  
+  it "should require a base domain" do
+    @site.base_domain = nil
+    @site.should_not be_valid
+    assert_not_nil @site.errors.on(:base_domain)
+  end
+  
+  it "should require unique domain" do
+    @site.domain = sites(:default).domain
+    @site.should_not be_valid
+    @site.errors.on(:domain).should_not be_empty
+  end
+  
+  it "should have an associated homepage" do
+    @site.should respond_to(:homepage)
+    @site.homepage.should eql(pages(:home))
+  end
+  
+  it "should create a homepage on create" do
+    @site.homepage_id = nil
+    @site.save.should eql(true)
+    @site.homepage.should_not be_nil
+    @site.homepage.should be_valid
+    @site.homepage.parts.each { |part| part.should be_valid }
+    @site.homepage.should_not be_new_record
+  end
+
+  it "should respect default page status" do
+    Radiant::Config['defaults.page.status'] = :published
+    site = Site.new :name => "Test Site", :domain => "test", :base_domain => "test.host"
+    site.save
+    site.homepage.should be_published
+  end
+
+  it "should respect default page parts" do
+    Radiant::Config['defaults.page.parts'] = 'body,footnotes,other'
+    site = Site.new :name => "Test Site", :domain => "test", :base_domain => "test.host"
+    site.save
+    site.homepage.parts.size.should == 3
+    %w(body footnotes other).each do |part|
+      site.homepage.part(part).should be_kind_of(PagePart)
+    end
+  end
+  
+  it "should find site for hostname" do
+    sites(:mysite).should eql(Site.find_for_host("mysite.domain.com"))
+    sites(:yoursite).should eql(Site.find_for_host("yoursite.com"))
+    sites(:yoursite).should eql(Site.find_for_host("yoursite.unknown.com"))
+    sites(:default).should eql(Site.find_for_host("unknown.com"))
+  end
+  
+  it "should generate site url from path" do
+    sites(:mysite).url.should eql("http://mysite.domain.com/")
+    sites(:mysite).url("/about").should eql("http://mysite.domain.com/about")
+  end
+  
+  it "should generate dev site url from path" do
+    sites(:mysite).dev_url.should eql("http://dev.mysite.domain.com/")
+    sites(:mysite).dev_url("/about").should eql("http://dev.mysite.domain.com/about")
+  end
+  
+  describe "#save" do
+    it "should reload routes" do
+      ActionController::Routing::Routes.should_receive(:reload)
+      @site.save
+    end
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format progress
+--format html:spec/spec_report.html
+--loadby
+mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require ENV["RADIANT_ENV_FILE"]
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../../")}/config/environment"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../")}/config/environment"
+  end
+end
+require "#{RADIANT_ROOT}/spec/spec_helper"
+
+Dataset::Resolver.default << (File.dirname(__FILE__) + "/datasets")
+
+if File.directory?(File.dirname(__FILE__) + "/matchers")
+  Dir[File.dirname(__FILE__) + "/matchers/*.rb"].each {|file| require file }
+end
+
+Spec::Runner.configure do |config|
+  # config.use_transactional_fixtures = true
+  # config.use_instantiated_fixtures  = false
+  # config.fixture_path = RAILS_ROOT + '/spec/fixtures'
+
+  # You can declare fixtures for each behaviour like this:
+  #   describe "...." do
+  #     fixtures :table_a, :table_b
+  #
+  # Alternatively, if you prefer to declare them only once, you can
+  # do so here, like so ...
+  #
+  #   config.global_fixtures = :table_a, :table_b
+  #
+  # If you declare global fixtures, be aware that they will be declared
+  # for all of your examples, even those that don't use them.
+end

data/trusty-multi-site-extension.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "trusty-multi-site-extension"
+
+Gem::Specification.new do |s|
+  s.name        = "trusty-multi-site-extension"
+  s.version = "1.0.0"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Eric Sipple"]
+  s.date = %q{2014-10-07}
+  s.description = %q{Extends Trusty CMS Layouts to support multiple sites, defined by domain}
+  s.email = %q{sipple@trustarts.org}
+  s.homepage = %q{https://github.com/pgharts/trusty-multi-site-extension}
+  s.summary = %q{Extends Trusty CMS Layouts to support multiple sites, defined by domain}
+
+  ignores = if File.exist?('.gitignore')
+              File.read('.gitignore').split("\n").inject([]) {|a,p| a + Dir[p] }
+            else
+              []
+            end
+  s.files         = Dir['**/*'] - ignores
+  s.test_files    = Dir['test/**/*','spec/**/*','features/**/*'] - ignores
+  # s.executables   = Dir['bin/*'] - ignores
+  s.require_paths = ["lib"]
+  s.add_dependency "acts_as_list", "0.4.0"
+  s.add_dependency "trusty-snippets-extension", "~> 1.0.0"
+  s.add_dependency "trusty-cms",   "~> 1.0.1"
+end