apartment 0.15.0 → 0.16.0

data/lib/apartment/elevators/generic.rb

@@ -0,0 +1,27 @@
+module Apartment
+  module Elevators
+    #   Provides a rack based db switching solution based on request
+    #
+    class Generic
+
+      def initialize(app, processor = nil)
+        @app = app
+        @processor = processor || method(:parse_database_name)
+      end
+
+      def call(env)
+        request = ActionDispatch::Request.new(env)
+
+        database = @processor.call(request)
+
+        Apartment::Database.switch database if database
+
+        @app.call(env)
+      end
+
+      def parse_database_name(request)
+        raise "Override"
+      end
+    end
+  end
+end

data/lib/apartment/elevators/subdomain.rb

@@ -1,27 +1,13 @@
 module Apartment
   module Elevators
-    # Provides a rack based db switching solution based on subdomains
-    # Assumes that database name should match subdomain
-    class Subdomain
+    #   Provides a rack based db switching solution based on subdomains
+    #   Assumes that database name should match subdomain
+    #
+    class Subdomain < Generic
 
-      def initialize(app)
-        @app = app
-      end
-
-      def call(env)
-        request = ActionDispatch::Request.new(env)
-
-        database = subdomain(request)
-
-        Apartment::Database.switch database if database
-
-        @app.call(env)
-      end
-
-      def subdomain(request)
+      def parse_database_name(request)
         request.subdomain.present? && request.subdomain || nil
       end
-
     end
   end
 end

data/lib/apartment/version.rb

@@ -1,3 +1,3 @@
 module Apartment
-  VERSION = "0.15.0"
+  VERSION = "0.16.0"
 end

data/spec/adapters/{mysql_adapter_spec.rb → mysql2_adapter_spec.rb}

@@ -1,17 +1,17 @@
 require 'spec_helper'
-require 'apartment/adapters/mysql_adapter'
+require 'apartment/adapters/mysql2_adapter'
+
+describe Apartment::Adapters::Mysql2Adapter do
 
-describe Apartment::Adapters::MysqlAdapter do
-  
   let(:config){ Apartment::Test.config['connections']['mysql'] }
   subject{ Apartment::Database.mysql2_adapter config.symbolize_keys }
-  
+
   def database_names
     ActiveRecord::Base.connection.execute("SELECT schema_name FROM information_schema.schemata").collect{|row| row[0]}
   end
-  
+
   let(:default_database){ subject.process{ ActiveRecord::Base.connection.current_database } }
-  
+
   it_should_behave_like "a generic apartment adapter"
   it_should_behave_like "a db based apartment adapter"
-end
+end

data/spec/adapters/postgresql_adapter_spec.rb

@@ -14,22 +14,22 @@ describe Apartment::Adapters::PostgresqlAdapter do
     def database_names
       ActiveRecord::Base.connection.execute("SELECT nspname FROM pg_namespace;").collect{|row| row['nspname']}
     end
-    
+
     let(:default_database){ subject.process{ ActiveRecord::Base.connection.schema_search_path } }
 
     it_should_behave_like "a generic apartment adapter"
     it_should_behave_like "a schema based apartment adapter"
   end
-  
+
   context "using databases" do
 
-    before{ Apartment.use_postgres_schemas = false }  
+    before{ Apartment.use_postgres_schemas = false }
 
     # Not sure why, but somehow using let(:database_names) memoizes for the whole example group, not just each test
     def database_names
       connection.execute("select datname from pg_database;").collect{|row| row['datname']}
     end
-    
+
     let(:default_database){ subject.process{ ActiveRecord::Base.connection.current_database } }
 
     it_should_behave_like "a generic apartment adapter"

data/spec/config/database.yml

@@ -3,7 +3,8 @@ connections:
     adapter: postgresql
     database: apartment_postgresql_test
     min_messages: WARNING
-    username: root
+    username: postgres
+    schema_search_path: public
     password:
 
   mysql:

data/spec/database_spec.rb

@@ -1,44 +1,67 @@
 require 'spec_helper'
 
 describe Apartment::Database do
-  
+  context "using mysql" do
+    # See apartment.yml file in dummy app config
+
+    let(:config){ Apartment::Test.config['connections']['mysql'].symbolize_keys }
+
+    before do
+      ActiveRecord::Base.establish_connection config
+      Apartment::Test.load_schema   # load the Rails schema in the public db schema
+      subject.stub(:config).and_return config   # Use postgresql database config for this test
+    end
+
+    describe "#adapter" do
+      before do
+        subject.reload!
+      end
+
+      it "should load mysql adapter" do
+        subject.adapter
+        Apartment::Adapters::Mysql2Adapter.should be_a(Class)
+      end
+
+    end
+  end
+
   context "using postgresql" do
-    
+
     # See apartment.yml file in dummy app config
-    
+
     let(:config){ Apartment::Test.config['connections']['postgresql'].symbolize_keys }
     let(:database){ Apartment::Test.next_db }
     let(:database2){ Apartment::Test.next_db }
-    
+
     before do
       Apartment.use_postgres_schemas = true
       ActiveRecord::Base.establish_connection config
       Apartment::Test.load_schema   # load the Rails schema in the public db schema
       subject.stub(:config).and_return config   # Use postgresql database config for this test
     end
-    
+
     describe "#adapter" do
       before do
         subject.reload!
       end
-      
+
       it "should load postgresql adapter" do
         subject.adapter
         Apartment::Adapters::PostgresqlAdapter.should be_a(Class)
       end
-      
+
       it "should raise exception with invalid adapter specified" do
         subject.stub(:config).and_return config.merge(:adapter => 'unkown')
-        
+
         expect {
           Apartment::Database.adapter
         }.to raise_error
       end
-      
+
     end
-    
+
     context "with schemas" do
-      
+
       before do
         Apartment.configure do |config|
           config.excluded_models = []
@@ -47,25 +70,25 @@ describe Apartment::Database do
         end
         subject.create database
       end
-      
+
       after{ subject.drop database }
-      
+
       describe "#create" do
         it "should seed data" do
           subject.switch database
           User.count.should be > 0
         end
       end
-    
+
       describe "#switch" do
-        
+
         let(:x){ rand(3) }
-        
+
         context "creating models" do
-          
+
           before{ subject.create database2 }
           after{ subject.drop database2 }
-          
+
           it "should create a model instance in the current schema" do
             subject.switch database2
             db2_count = User.count + x.times{ User.create }
@@ -80,20 +103,20 @@ describe Apartment::Database do
             User.count.should == db_count
           end
         end
-        
+
         context "with excluded models" do
-          
+
           before do
             Apartment.configure do |config|
               config.excluded_models = ["Company"]
             end
             subject.init
           end
-          
+
           it "should create excluded models in public schema" do
             subject.reset # ensure we're on public schema
             count = Company.count + x.times{ Company.create }
-            
+
             subject.switch database
             x.times{ Company.create }
             Company.count.should == count + x
@@ -101,10 +124,10 @@ describe Apartment::Database do
             Company.count.should == count + x
           end
         end
-        
+
       end
-            
+
     end
-    
+
   end
-end
+end

data/spec/dummy/config/application.rb

@@ -16,6 +16,9 @@ module Dummy
     # -- all .rb files in that directory are automatically loaded.
 
     config.middleware.use 'Apartment::Elevators::Subdomain'
+    config.middleware.use 'Apartment::Elevators::Domain'
+    # Our test for this middleware is using a query_string couldn't think of a better way to differentiate it from the other middleware
+    config.middleware.use 'Apartment::Elevators::Generic', Proc.new { |request| request.query_string.split('=').last if request.query_string.present? }
 
     # Custom directories with classes and modules you want to be autoloadable.
     config.autoload_paths += %W(#{config.root}/lib)

data/spec/examples/db_adapter_examples.rb

@@ -2,30 +2,30 @@ require 'spec_helper'
 
 shared_examples_for "a db based apartment adapter" do
   include Apartment::Spec::AdapterRequirements
-  
+
   let(:default_database){ subject.process{ ActiveRecord::Base.connection.current_database } }
-  
+
   describe "#init" do
-    
+
     it "should process model exclusions" do
       Apartment.configure do |config|
         config.excluded_models = ["Company"]
       end
-      
+
       Apartment::Database.init
-      
+
       Company.connection.object_id.should_not == ActiveRecord::Base.connection.object_id
     end
   end
-  
+
   describe "#drop" do
     it "should raise an error for unknown database" do
       expect {
         subject.drop 'unknown_database'
       }.to raise_error(Apartment::DatabaseNotFound)
     end
-  end  
-  
+  end
+
   describe "#switch" do
     it "should raise an error if database is invalid" do
       expect {

data/spec/examples/elevator_examples.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+shared_examples_for "an apartment elevator" do
+
+  context "single request" do
+    it "should switch the db" do
+      ActiveRecord::Base.connection.schema_search_path.should_not == database1
+
+      visit(domain1)
+      ActiveRecord::Base.connection.schema_search_path.should == database1
+    end
+  end
+
+  context "simultaneous requests" do
+
+    let!(:c1_user_count) { api.process(database1){ (2 + rand(2)).times{ User.create } } }
+    let!(:c2_user_count) { api.process(database2){ (c1_user_count + 2).times{ User.create } } }
+
+    it "should fetch the correct user count for each session based on the elevator processor" do
+      visit(domain1)
+
+      in_new_session do |session|
+        session.visit(domain2)
+        User.count.should == c2_user_count
+      end
+
+      visit(domain1)
+      User.count.should == c1_user_count
+    end
+  end
+end

data/spec/examples/generic_adapter_examples.rb

@@ -2,9 +2,9 @@ require 'spec_helper'
 
 shared_examples_for "a generic apartment adapter" do
   include Apartment::Spec::AdapterRequirements
-  
+
   before{ Apartment.prepend_environment = false }
-  
+
   #
   #   Creates happen already in our before_filter
   #
@@ -20,7 +20,7 @@ shared_examples_for "a generic apartment adapter" do
         connection.tables.should include('companies')
       end
     end
-    
+
     it "should yield to block if passed and reset" do
       subject.drop(db2) # so we don't get errors on creation
 
@@ -31,20 +31,20 @@ shared_examples_for "a generic apartment adapter" do
         subject.current_database.should == db2
         User.create
       end
-      
+
       subject.current_database.should_not == db2
 
       subject.process(db2){ User.count.should == @count + 1 }
-    end    
+    end
   end
-  
+
   describe "#drop" do
     it "should remove the db" do
       subject.drop db1
       database_names.should_not include(db1)
-    end    
+    end
   end
-  
+
   describe "#process" do
     it "should connect" do
       subject.process(db1) do
@@ -67,7 +67,7 @@ shared_examples_for "a generic apartment adapter" do
       }.to_not raise_error
     end
   end
-  
+
   describe "#reset" do
     it "should reset connection" do
       subject.switch(db1)
@@ -85,7 +85,7 @@ shared_examples_for "a generic apartment adapter" do
     it "should reset connection if database is nil" do
       subject.switch
       subject.current_database.should == default_database
-    end    
+    end
   end
 
   describe "#current_database" do

data/spec/examples/schema_adapter_examples.rb

@@ -2,22 +2,33 @@ require 'spec_helper'
 
 shared_examples_for "a schema based apartment adapter" do
   include Apartment::Spec::AdapterRequirements
-  
+
   let(:schema1){ db1 }
   let(:schema2){ db2 }
   let(:public_schema){ default_database }
 
   describe "#init" do
-    
-    it "should process model exclusions" do
+
+    before do
       Apartment.configure do |config|
         config.excluded_models = ["Company"]
       end
-      
+    end
+
+    it "should process model exclusions" do
       Apartment::Database.init
-      
+
       Company.table_name.should == "public.companies"
     end
+
+    context "with a default_schema", :default_schema => true do
+
+      it "should set the proper table_name on excluded_models" do
+        Apartment::Database.init
+
+        Company.table_name.should == "#{default_schema}.companies"
+      end
+    end
   end
 
   #
@@ -29,7 +40,7 @@ shared_examples_for "a schema based apartment adapter" do
       connection.schema_search_path = schema1
       connection.tables.should include('companies')
     end
-    
+
     it "should yield to block if passed and reset" do
       subject.drop(schema2) # so we don't get errors on creation
 
@@ -37,52 +48,61 @@ shared_examples_for "a schema based apartment adapter" do
 
       subject.create(schema2) do
         @count = User.count
-        connection.schema_search_path.should == schema2
+        connection.schema_search_path.should start_with schema2
         User.create
       end
-      
-      connection.schema_search_path.should_not == schema2
+
+      connection.schema_search_path.should_not start_with schema2
 
       subject.process(schema2){ User.count.should == @count + 1 }
     end
-    
-    it "should allow numeric database names" do
-      expect {
-        subject.create(1234)
-      }.to_not raise_error
-      database_names.should include("1234")
-      # cleanup
-      subject.drop(1234)
+
+    context "numeric database names" do
+      let(:db){ 1234 }
+      it "should allow them" do
+        expect {
+          subject.create(db)
+        }.to_not raise_error
+        database_names.should include(db.to_s)
+      end
+
+      after{ subject.drop(db) }
     end
-    
+
   end
-  
+
   describe "#drop" do
     it "should raise an error for unknown database" do
       expect {
         subject.drop "unknown_database"
       }.to raise_error(Apartment::SchemaNotFound)
     end
-    
-    it "should be able to drop numeric dbs" do
-      subject.create(1234)
-      expect {
-        subject.drop(1234)
-      }.to_not raise_error
-      database_names.should_not include("1234")
+
+    context "numeric database names" do
+      let(:db){ 1234 }
+
+      it "should be able to drop them" do
+        subject.create(db)
+        expect {
+          subject.drop(db)
+        }.to_not raise_error
+        database_names.should_not include(db.to_s)
+      end
+
+      after { subject.drop(db) rescue nil }
     end
   end
 
   describe "#process" do
     it "should connect" do
       subject.process(schema1) do
-        connection.schema_search_path.should == schema1
+        connection.schema_search_path.should start_with schema1
       end
     end
 
     it "should reset" do
       subject.process(schema1)
-      connection.schema_search_path.should == public_schema
+      connection.schema_search_path.should start_with public_schema
     end
   end
 
@@ -90,33 +110,93 @@ shared_examples_for "a schema based apartment adapter" do
     it "should reset connection" do
       subject.switch(schema1)
       subject.reset
-      connection.schema_search_path.should == public_schema
+      connection.schema_search_path.should start_with public_schema
+    end
+
+    context "with default_schema", :default_schema => true do
+      it "should reset to the default schema" do
+        subject.switch(schema1)
+        subject.reset
+        connection.schema_search_path.should start_with default_schema
+      end
+    end
+
+    context "persistent_schemas", :persistent_schemas => true do
+      before do
+        subject.switch(schema1)
+        subject.reset
+      end
+
+      it "maintains the persistent schemas in the schema_search_path" do
+        connection.schema_search_path.should end_with persistent_schemas.join(', ')
+      end
+
+      context "with default_schema", :default_schema => true do
+        it "prioritizes the switched schema to front of schema_search_path" do
+          subject.reset # need to re-call this as the default_schema wasn't set at the time that the above reset ran
+          connection.schema_search_path.should start_with default_schema
+        end
+      end
     end
   end
 
   describe "#switch" do
     it "should connect to new schema" do
       subject.switch(schema1)
-      connection.schema_search_path.should == schema1
+      connection.schema_search_path.should start_with schema1
     end
 
     it "should reset connection if database is nil" do
       subject.switch
       connection.schema_search_path.should == public_schema
     end
-    
+
     it "should raise an error if schema is invalid" do
       expect {
         subject.switch 'unknown_schema'
       }.to raise_error(Apartment::SchemaNotFound)
     end
-    
-    it "should connect to numeric dbs" do
-      subject.create(1234)
-      expect {
-        subject.switch(1234)
-      }.to_not raise_error
-      subject.drop(1234)
+
+    context "numeric databases" do
+      let(:db){ 1234 }
+
+      it "should connect to them" do
+        subject.create(db)
+        expect {
+          subject.switch(db)
+        }.to_not raise_error
+
+        connection.schema_search_path.should start_with db.to_s
+      end
+
+      after{ subject.drop(db) }
+    end
+
+    describe "with default_schema specified", :default_schema => true do
+      before do
+        subject.switch(schema1)
+      end
+
+      it "should switch out the default schema rather than public" do
+        connection.schema_search_path.should_not include default_schema
+      end
+
+      it "should still switch to the switched schema" do
+        connection.schema_search_path.should start_with schema1
+      end
+    end
+
+    context "persistent_schemas", :persistent_schemas => true do
+
+      before{ subject.switch(schema1) }
+
+      it "maintains the persistent schemas in the schema_search_path" do
+        connection.schema_search_path.should end_with persistent_schemas.join(', ')
+      end
+
+      it "prioritizes the switched schema to front of schema_search_path" do
+        connection.schema_search_path.should start_with schema1
+      end
     end
   end
 
@@ -125,6 +205,13 @@ shared_examples_for "a schema based apartment adapter" do
       subject.switch(schema1)
       subject.current_database.should == schema1
     end
+
+    context "persistent_schemas", :persistent_schemas => true do
+      it "should exlude persistent_schemas" do
+        subject.switch(schema1)
+        subject.current_database.should == schema1
+      end
+    end
   end
 
 end