apartment 1.2.0 → 2.0.0

data/lib/apartment/version.rb

@@ -1,3 +1,3 @@
 module Apartment
-  VERSION = "1.2.0"
+  VERSION = "2.0.0"
 end

data/lib/generators/apartment/install/templates/apartment.rb

@@ -49,16 +49,21 @@ Apartment.configure do |config|
   #
   config.tenant_names = lambda { ToDo_Tenant_Or_User_Model.pluck :database }
 
+  # PostgreSQL:
+  #   Specifies whether to use PostgreSQL schemas or create a new database per Tenant.
+  #
+  # MySQL:
+  #   Specifies whether to switch databases by using `use` statement or re-establish connection.
   #
-  # ==> PostgreSQL only options
-
-  # Specifies whether to use PostgreSQL schemas or create a new database per Tenant.
   # The default behaviour is true.
   #
   # config.use_schemas = true
 
+  #
+  # ==> PostgreSQL only options
+
   # Apartment can be forced to use raw SQL dumps instead of schema.rb for creating new schemas.
-  # Use this when you are using some extra features in PostgreSQL that can't be respresented in
+  # Use this when you are using some extra features in PostgreSQL that can't be represented in
   # schema.rb, like materialized views etc. (only applies with use_schemas set to true).
   # (Note: this option doesn't use db/structure.sql, it creates SQL dump by executing pg_dump)
   #
@@ -83,10 +88,10 @@ end
 
 # Setup a custom Tenant switching middleware. The Proc should return the name of the Tenant that
 # you want to switch to.
-# Rails.application.config.middleware.use 'Apartment::Elevators::Generic', lambda { |request|
+# Rails.application.config.middleware.use Apartment::Elevators::Generic, lambda { |request|
 #   request.host.split('.').first
 # }
 
-# Rails.application.config.middleware.use 'Apartment::Elevators::Domain'
-Rails.application.config.middleware.use 'Apartment::Elevators::Subdomain'
-# Rails.application.config.middleware.use 'Apartment::Elevators::FirstSubdomain'
+# Rails.application.config.middleware.use Apartment::Elevators::Domain
+Rails.application.config.middleware.use Apartment::Elevators::Subdomain
+# Rails.application.config.middleware.use Apartment::Elevators::FirstSubdomain

data/lib/tasks/apartment.rake

@@ -3,11 +3,11 @@ require 'apartment/migrator'
 apartment_namespace = namespace :apartment do
 
   desc "Create all tenants"
-  task create: 'db:migrate' do
+  task :create do
     tenants.each do |tenant|
       begin
         puts("Creating #{tenant} tenant")
-        quietly { Apartment::Tenant.create(tenant) }
+        Apartment::Tenant.create(tenant)
       rescue Apartment::TenantExists => e
         puts e.message
       end

data/spec/adapters/mysql2_adapter_spec.rb

@@ -32,6 +32,14 @@ describe Apartment::Adapters::Mysql2Adapter, database: :mysql do
           end
         end
 
+        after do
+          # Apartment::Tenant.init creates per model connection.
+          # Remove the connection after testing not to unintentionally keep the connection across tests.
+          Apartment.excluded_models.each do |excluded_model|
+            excluded_model.constantize.remove_connection
+          end
+        end
+
         it "should process model exclusions" do
           Apartment::Tenant.init
 

data/spec/apartment_spec.rb

@@ -8,8 +8,4 @@ describe Apartment do
   it "should be a valid app" do
     expect(::Rails.application).to be_a(Dummy::Application)
   end
-
-  it "should deprecate Apartment::Database in favor of Apartment::Tenant" do
-    expect(Apartment::Database).to eq(Apartment::Tenant)
-  end
-end
+end

data/spec/dummy/config/application.rb

@@ -17,7 +17,7 @@ module Dummy
     require 'apartment/elevators/subdomain'
     require 'apartment/elevators/domain'
 
-    config.middleware.use 'Apartment::Elevators::Subdomain'
+    config.middleware.use Apartment::Elevators::Subdomain
 
     # Custom directories with classes and modules you want to be autoloadable.
     config.autoload_paths += %W(#{config.root}/lib)

data/spec/dummy/config/database.yml.sample

@@ -25,6 +25,7 @@ development:
 test:
   adapter: postgresql
   database: apartment_postgresql_test
+  username: postgres
   min_messages: WARNING
   pool: 5
   timeout: 5000
@@ -32,7 +33,8 @@ test:
 development:
   adapter: postgresql
   database: apartment_postgresql_development
+  username: postgres
   min_messages: WARNING
   pool: 5
   timeout: 5000
-<% end %>
+<% end %>

data/spec/dummy/db/migrate/20110613152810_create_dummy_models.rb

@@ -1,4 +1,5 @@
-class CreateDummyModels < ActiveRecord::Migration
+migration_class = (ActiveRecord::VERSION::MAJOR >= 5) ?  ActiveRecord::Migration[4.2] : ActiveRecord::Migration
+class CreateDummyModels < migration_class
   def self.up
     create_table :companies do |t|
       t.boolean :dummy

data/spec/dummy/db/migrate/20111202022214_create_table_books.rb

@@ -1,4 +1,5 @@
-class CreateTableBooks < ActiveRecord::Migration
+migration_class = (ActiveRecord::VERSION::MAJOR >= 5) ?  ActiveRecord::Migration[4.2] : ActiveRecord::Migration
+class CreateTableBooks < migration_class
   def up
     create_table :books do |t|
       t.string :name

data/spec/dummy_engine/config/initializers/apartment.rb

@@ -42,10 +42,10 @@ end
 ##
 # Elevator Configuration
 
-# Rails.application.config.middleware.use 'Apartment::Elevators::Generic', lambda { |request|
+# Rails.application.config.middleware.use Apartment::Elevators::Generic, lambda { |request|
 #   # TODO: supply generic implementation
 # }
 
-# Rails.application.config.middleware.use 'Apartment::Elevators::Domain'
+# Rails.application.config.middleware.use Apartment::Elevators::Domain
 
-Rails.application.config.middleware.use 'Apartment::Elevators::Subdomain'
+Rails.application.config.middleware.use Apartment::Elevators::Subdomain

data/spec/examples/connection_adapter_examples.rb

@@ -6,6 +6,14 @@ shared_examples_for "a connection based apartment adapter" do
   let(:default_tenant){ subject.switch{ ActiveRecord::Base.connection.current_database } }
 
   describe "#init" do
+    after do
+      # Apartment::Tenant.init creates per model connection.
+      # Remove the connection after testing not to unintentionally keep the connection across tests.
+      Apartment.excluded_models.each do |excluded_model|
+        excluded_model.constantize.remove_connection
+      end
+    end
+
     it "should process model exclusions" do
       Apartment.configure do |config|
         config.excluded_models = ["Company"]

data/spec/examples/generic_adapter_examples.rb

@@ -8,6 +8,25 @@ shared_examples_for "a generic apartment adapter" do
     Apartment.append_environment = false
   }
 
+  describe "#init" do
+    it "should not retain a connection after railtie" do
+      # this test should work on rails >= 4, the connection pool code is
+      # completely different for 3.2 so we'd have to have a messy conditional..
+      unless Rails::VERSION::MAJOR < 4
+        ActiveRecord::Base.connection_pool.disconnect!
+
+        Apartment::Railtie.config.to_prepare_blocks.map(&:call)
+
+        num_available_connections = Apartment.connection_class.connection_pool
+          .instance_variable_get(:@available)
+          .instance_variable_get(:@queue)
+          .size
+
+        expect(num_available_connections).to eq(1)
+      end
+    end
+  end
+
   #
   #   Creates happen already in our before_filter
   #
@@ -39,6 +58,22 @@ shared_examples_for "a generic apartment adapter" do
 
       subject.switch(db2){ expect(User.count).to eq(@count + 1) }
     end
+
+    it "should raise error when the schema.rb is missing unless Apartment.use_sql is set to true" do
+      next if Apartment.use_sql
+
+      subject.drop(db1)
+      begin
+        Dir.mktmpdir do |tmpdir|
+          Apartment.database_schema_file = "#{tmpdir}/schema.rb"
+          expect {
+            subject.create(db1)
+          }.to raise_error(Apartment::FileNotFound)
+        end
+      ensure
+        Apartment.remove_instance_variable(:@database_schema_file)
+      end
+    end
   end
 
   describe "#drop" do
@@ -83,23 +118,6 @@ shared_examples_for "a generic apartment adapter" do
         subject.switch(db1){ subject.drop(db2) }
       }.to_not raise_error
     end
-
-    it "warns if no block is given, but calls switch!" do
-      expect(Apartment::Deprecation).to receive(:warn)
-
-      subject.switch(db1)
-      expect(subject.current).to eq(db1)
-    end
-  end
-
-  describe "#process" do
-    it "is deprecated" do
-      expect(Apartment::Deprecation).to receive(:warn)
-
-      subject.process(db1) do
-        expect(subject.current).to eq(db1)
-      end
-    end
   end
 
   describe "#reset" do

data/spec/examples/schema_adapter_examples.rb

@@ -15,6 +15,14 @@ shared_examples_for "a schema based apartment adapter" do
       end
     end
 
+    after do
+      # Apartment::Tenant.init creates per model connection.
+      # Remove the connection after testing not to unintentionally keep the connection across tests.
+      Apartment.excluded_models.each do |excluded_model|
+        excluded_model.constantize.remove_connection
+      end
+    end
+
     it "should process model exclusions" do
       Apartment::Tenant.init
 

data/spec/integration/query_caching_spec.rb

@@ -1,41 +1,81 @@
 require 'spec_helper'
 
 describe 'query caching' do
-  let(:db_names) { [db1, db2] }
+  describe 'when use_schemas = true' do
+    let(:db_names) { [db1, db2] }
 
-  before do
-    Apartment.configure do |config|
-      config.excluded_models = ["Company"]
-      config.tenant_names = lambda{ Company.pluck(:database) }
-      config.use_schemas = true
+    before do
+      Apartment.configure do |config|
+        config.excluded_models = ["Company"]
+        config.tenant_names = lambda{ Company.pluck(:database) }
+        config.use_schemas = true
+      end
+
+      Apartment::Tenant.reload!(config)
+
+      db_names.each do |db_name|
+        Apartment::Tenant.create(db_name)
+        Company.create database: db_name
+      end
+    end
+
+    after do
+      db_names.each{ |db| Apartment::Tenant.drop(db) }
+      Apartment::Tenant.reset
+      Company.delete_all
+    end
+
+    it 'clears the ActiveRecord::QueryCache after switching databases' do
+      db_names.each do |db_name|
+        Apartment::Tenant.switch! db_name
+        User.create! name: db_name
+      end
+
+      ActiveRecord::Base.connection.enable_query_cache!
+
+      Apartment::Tenant.switch! db_names.first
+      expect(User.find_by_name(db_names.first).name).to eq(db_names.first)
+
+      Apartment::Tenant.switch! db_names.last
+      expect(User.find_by_name(db_names.first)).to be_nil
     end
+  end
 
-    Apartment::Tenant.reload!(config)
+  describe 'when use_schemas = false' do
+    let(:db_name) { db1 }
+
+    before do
+      Apartment.configure do |config|
+        config.excluded_models = ["Company"]
+        config.tenant_names = lambda{ Company.pluck(:database) }
+        config.use_schemas = false
+      end
+
+      Apartment::Tenant.reload!(config)
 
-    db_names.each do |db_name|
       Apartment::Tenant.create(db_name)
       Company.create database: db_name
     end
-  end
 
-  after do
-    db_names.each{ |db| Apartment::Tenant.drop(db) }
-    Apartment::Tenant.reset
-    Company.delete_all
-  end
+    after do
+      # Avoid cannot drop the currently open database. Maybe there is a better way to handle this.
+      Apartment::Tenant.switch! 'template1'
 
-  it 'clears the ActiveRecord::QueryCache after switching databases' do
-    db_names.each do |db_name|
-      Apartment::Tenant.switch! db_name
-      User.create! name: db_name
+      Apartment::Tenant.drop(db_name)
+      Apartment::Tenant.reset
+      Company.delete_all
     end
 
-    ActiveRecord::Base.connection.enable_query_cache!
+    it "configuration value is kept after switching databases" do
+      ActiveRecord::Base.connection.enable_query_cache!
 
-    Apartment::Tenant.switch! db_names.first
-    expect(User.find_by_name(db_names.first).name).to eq(db_names.first)
+      Apartment::Tenant.switch! db_name
+      expect(Apartment.connection.query_cache_enabled).to be true
+
+      ActiveRecord::Base.connection.disable_query_cache!
 
-    Apartment::Tenant.switch! db_names.last
-    expect(User.find_by_name(db_names.first)).to be_nil
+      Apartment::Tenant.switch! db_name
+      expect(Apartment.connection.query_cache_enabled).to be false
+    end
   end
 end

data/spec/spec_helper.rb

@@ -4,6 +4,18 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 ENV["RAILS_ENV"] = "test"
 
 require File.expand_path("../dummy/config/environment.rb", __FILE__)
+
+# Loading dummy applications affects table_name of each excluded models
+# defined in `spec/dummy/config/initializers/apartment.rb`.
+# To make them pristine, we need to execute below lines.
+Apartment.excluded_models.each do |model|
+  klass = model.constantize
+
+  Apartment.connection_class.remove_connection(klass)
+  klass.clear_all_connections!
+  klass.reset_table_name
+end
+
 require "rspec/rails"
 require 'capybara/rspec'
 require 'capybara/rails'

data/spec/tenant_spec.rb

@@ -59,8 +59,7 @@ describe Apartment::Tenant do
 
     describe "#adapter" do
       it "should load postgresql adapter" do
-        subject.adapter
-        expect(Apartment::Adapters::PostgresqlAdapter).to be_a(Class)
+        expect(subject.adapter).to be_a(Apartment::Adapters::PostgresqlSchemaAdapter)
       end
 
       it "raises exception with invalid adapter specified" do
@@ -68,7 +67,7 @@ describe Apartment::Tenant do
 
         expect {
           Apartment::Tenant.adapter
-        }.to raise_error
+        }.to raise_error(RuntimeError)
       end
 
       context "threadsafety" do
@@ -137,6 +136,14 @@ describe Apartment::Tenant do
             subject.init
           end
 
+          after do
+            # Apartment::Tenant.init creates per model connection.
+            # Remove the connection after testing not to unintentionally keep the connection across tests.
+            Apartment.excluded_models.each do |excluded_model|
+              excluded_model.constantize.remove_connection
+            end
+          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 }

data/spec/unit/config_spec.rb

@@ -50,13 +50,6 @@ describe Apartment do
       expect(Apartment.seed_after_create).to be true
     end
 
-    it "should set tld_length" do
-      Apartment.configure do |config|
-        config.tld_length = 2
-      end
-      expect(Apartment.tld_length).to eq(2)
-    end
-
     context "databases" do
       let(:users_conf_hash) { { port: 5444 } }
 

data/spec/unit/elevators/subdomain_spec.rb

@@ -6,7 +6,7 @@ describe Apartment::Elevators::Subdomain do
   subject(:elevator){ described_class.new(Proc.new{}) }
 
   describe "#parse_tenant_name" do
-    context "assuming tld_length of 1" do
+    context "assuming one tld" do
       it "should parse subdomain" do
         request = ActionDispatch::Request.new('HTTP_HOST' => 'foo.bar.com')
         expect(elevator.parse_tenant_name(request)).to eq('foo')
@@ -18,13 +18,7 @@ describe Apartment::Elevators::Subdomain do
       end
     end
 
-    context "assuming tld_length of 2" do
-      before do
-        Apartment.configure do |config|
-          config.tld_length = 2
-        end
-      end
-
+    context "assuming two tlds" do
       it "should parse subdomain in the third level domain" do
         request = ActionDispatch::Request.new('HTTP_HOST' => 'foo.bar.co.uk')
         expect(elevator.parse_tenant_name(request)).to eq("foo")
@@ -35,6 +29,32 @@ describe Apartment::Elevators::Subdomain do
         expect(elevator.parse_tenant_name(request)).to be_nil
       end
     end
+
+    context "assuming two subdomains" do
+      it "should parse two subdomains in the two level domain" do
+        request = ActionDispatch::Request.new('HTTP_HOST' => 'foo.xyz.bar.com')
+        expect(elevator.parse_tenant_name(request)).to eq("foo")
+      end
+
+      it "should parse two subdomains in the third level domain" do
+        request = ActionDispatch::Request.new('HTTP_HOST' => 'foo.xyz.bar.co.uk')
+        expect(elevator.parse_tenant_name(request)).to eq("foo")
+      end
+    end
+
+    context "assuming localhost" do
+      it "should return nil for localhost" do
+        request = ActionDispatch::Request.new('HTTP_HOST' => 'localhost')
+        expect(elevator.parse_tenant_name(request)).to be_nil
+      end
+    end
+
+    context "assuming ip address" do
+      it "should return nil for an ip address" do
+        request = ActionDispatch::Request.new('HTTP_HOST' => '127.0.0.1')
+        expect(elevator.parse_tenant_name(request)).to be_nil
+      end
+    end
   end
 
   describe "#call" do