apartment 1.0.2 → 1.1.0

data/lib/apartment/adapters/mysql2_adapter.rb

@@ -21,17 +21,8 @@ module Apartment
 
     protected
 
-      #   Connect to new tenant
-      #   Abstract adapter will catch generic ActiveRecord error
-      #   Catch specific adapter errors here
-      #
-      #   @param {String} tenant Tenant name
-      #
-      def connect_to_new(tenant = nil)
-        super
-      rescue Mysql2::Error
-        Apartment::Tenant.reset
-        raise TenantNotFound, "Cannot find tenant #{environmentify(tenant)}"
+      def rescue_from
+        Mysql2::Error
       end
     end
 
@@ -49,12 +40,6 @@ module Apartment
         Apartment.connection.execute "use `#{default_tenant}`"
       end
 
-      #   Set the table_name to always use the default tenant for excluded models
-      #
-      def process_excluded_models
-        Apartment.excluded_models.each{ |model| process_excluded_model(model) }
-      end
-
     protected
 
       #   Connect to new tenant
@@ -64,9 +49,9 @@ module Apartment
 
         Apartment.connection.execute "use `#{environmentify(tenant)}`"
 
-      rescue ActiveRecord::StatementInvalid
+      rescue ActiveRecord::StatementInvalid => exception
         Apartment::Tenant.reset
-        raise TenantNotFound, "Cannot find tenant #{environmentify(tenant)}"
+        raise_connect_error!(tenant, exception)
       end
 
       def process_excluded_model(model)
@@ -77,6 +62,10 @@ module Apartment
           klass.table_name = "#{default_tenant}.#{table_name}"
         end
       end
+
+      def reset_on_connection_exception?
+        true
+      end
     end
   end
 end

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -15,14 +15,6 @@ module Apartment
     # Default adapter when not using Postgresql Schemas
     class PostgresqlAdapter < AbstractAdapter
 
-      def drop(tenant)
-        # Apartment.connection.drop_database note that drop_database will not throw an exception, so manually execute
-        Apartment.connection.execute(%{DROP DATABASE "#{tenant}"})
-
-      rescue *rescuable_exceptions
-        raise TenantNotFound, "The tenant #{tenant} cannot be found"
-      end
-
     private
 
       def rescue_from
@@ -39,31 +31,6 @@ module Apartment
         reset
       end
 
-      #   Drop the tenant
-      #
-      #   @param {String} tenant Database (schema) to drop
-      #
-      def drop(tenant)
-        Apartment.connection.execute(%{DROP SCHEMA "#{tenant}" CASCADE})
-
-      rescue *rescuable_exceptions
-        raise TenantNotFound, "The schema #{tenant.inspect} cannot be found."
-      end
-
-      #   Reset search path to default search_path
-      #   Set the table_name to always use the default namespace for excluded models
-      #
-      def process_excluded_models
-        Apartment.excluded_models.each do |excluded_model|
-          excluded_model.constantize.tap do |klass|
-            # Ensure that if a schema *was* set, we override
-            table_name = klass.table_name.split('.', 2).last
-
-            klass.table_name = "#{default_tenant}.#{table_name}"
-          end
-        end
-      end
-
       #   Reset schema search path to the default schema_search_path
       #
       #   @return {String} default schema search path
@@ -79,6 +46,19 @@ module Apartment
 
     protected
 
+      def process_excluded_model(excluded_model)
+        excluded_model.constantize.tap do |klass|
+          # Ensure that if a schema *was* set, we override
+          table_name = klass.table_name.split('.', 2).last
+
+          klass.table_name = "#{default_tenant}.#{table_name}"
+        end
+      end
+
+      def drop_command(conn, tenant)
+        conn.execute(%{DROP SCHEMA "#{tenant}" CASCADE})
+      end
+
       #   Set schema search path to new schema
       #
       def connect_to_new(tenant = nil)
@@ -92,17 +72,12 @@ module Apartment
         raise TenantNotFound, "One of the following schema(s) is invalid: \"#{tenant}\" #{full_search_path}"
       end
 
-      #   Create the new schema
-      #
-      def create_tenant(tenant)
-        Apartment.connection.execute(%{CREATE SCHEMA "#{tenant}"})
+    private
 
-      rescue *rescuable_exceptions
-        raise TenantExists, "The schema #{tenant} already exists."
+      def create_tenant_command(conn, tenant)
+        conn.execute(%{CREATE SCHEMA "#{tenant}"})
       end
 
-    private
-
       #   Generate the final search path to set including persistent_schemas
       #
       def full_search_path

data/lib/apartment/adapters/sqlite3_adapter.rb

@@ -39,14 +39,17 @@ module Apartment
         raise TenantExists,
           "The tenant #{environmentify(tenant)} already exists." if File.exists?(database_file(tenant))
 
-        f = File.new(database_file(tenant), File::CREAT)
-        f.close
+        begin
+          f = File.new(database_file(tenant), File::CREAT)
+        ensure
+          f.close
+        end
       end
 
     private
 
       def database_file(tenant)
-        "#{@default_dir}/#{tenant}.sqlite3"
+        "#{@default_dir}/#{environmentify(tenant)}.sqlite3"
       end
     end
   end

data/lib/apartment/elevators/first_subdomain.rb

@@ -10,7 +10,7 @@ module Apartment
     class FirstSubdomain < Subdomain
 
       def parse_tenant_name(request)
-        super.split('.')[0]
+        super.split('.')[0] unless super.nil?
       end
     end
   end

data/lib/apartment/elevators/generic.rb

@@ -18,9 +18,11 @@ module Apartment
 
         database = @processor.call(request)
 
-        Apartment::Tenant.switch! database if database
-
-        @app.call(env)
+        if database
+          Apartment::Tenant.switch(database) { @app.call(env) }
+        else
+          @app.call(env)
+        end
       end
 
       def parse_database_name(request)

data/lib/apartment/version.rb

@@ -1,3 +1,3 @@
 module Apartment
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

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

@@ -5,6 +5,7 @@
 # require 'apartment/elevators/generic'
 # require 'apartment/elevators/domain'
 require 'apartment/elevators/subdomain'
+# require 'apartment/elevators/first_subdomain'
 
 #
 # Apartment Configuration
@@ -18,10 +19,33 @@ Apartment.configure do |config|
 
   # In order to migrate all of your Tenants you need to provide a list of Tenant names to Apartment.
   # You can make this dynamic by providing a Proc object to be called on migrations.
-  # This object should yield an array of strings representing each Tenant name.
+  # This object should yield either:
+  # - an array of strings representing each Tenant name.
+  # - a hash which keys are tenant names, and values custom db config (must contain all key/values required in database.yml)
   #
   # config.tenant_names = lambda{ Customer.pluck(:tenant_name) }
   # config.tenant_names = ['tenant1', 'tenant2']
+  # config.tenant_names = {
+  #   'tenant1' => {
+  #     adapter: 'postgresql',
+  #     host: 'some_server',
+  #     port: 5555,
+  #     database: 'postgres' # this is not the name of the tenant's db
+  #                          # but the name of the database to connect to before creating the tenant's db
+  #                          # mandatory in postgresql
+  #   },
+  #   'tenant2' => {
+  #     adapter:  'postgresql',
+  #     database: 'postgres' # this is not the name of the tenant's db
+  #                          # but the name of the database to connect to before creating the tenant's db
+  #                          # mandatory in postgresql
+  #   }
+  # }
+  # config.tenant_names = lambda do
+  #   Tenant.all.each_with_object({}) do |tenant, hash|
+  #     hash[tenant.name] = tenant.db_configuration
+  #   end
+  # end
   #
   config.tenant_names = lambda { ToDo_Tenant_Or_User_Model.pluck :database }
 
@@ -65,3 +89,4 @@ end
 
 # 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

@@ -17,7 +17,6 @@ apartment_namespace = namespace :apartment do
   desc "Migrate all tenants"
   task :migrate do
     warn_if_tenants_empty
-
     tenants.each do |tenant|
       begin
         puts("Migrating #{tenant} tenant")

data/spec/adapters/jdbc_mysql_adapter_spec.rb

@@ -1,7 +1,7 @@
 if defined?(JRUBY_VERSION)
 
   require 'spec_helper'
-  require 'lib/apartment/adapters/jdbc_mysql_adapter'
+  require 'apartment/adapters/jdbc_mysql_adapter'
 
   describe Apartment::Adapters::JDBCMysqlAdapter, database: :mysql do
 

data/spec/adapters/jdbc_postgresql_adapter_spec.rb

@@ -1,7 +1,7 @@
 if defined?(JRUBY_VERSION)
 
   require 'spec_helper'
-  require 'lib/apartment/adapters/jdbc_postgresql_adapter'
+  require 'apartment/adapters/jdbc_postgresql_adapter'
 
   describe Apartment::Adapters::JDBCPostgresqlAdapter, database: :postgresql do
 

data/spec/adapters/mysql2_adapter_spec.rb

@@ -35,7 +35,7 @@ describe Apartment::Adapters::Mysql2Adapter, database: :mysql do
         it "should process model exclusions" do
           Apartment::Tenant.init
 
-          Company.table_name.should == "#{default_tenant}.companies"
+          expect(Company.table_name).to eq("#{default_tenant}.companies")
         end
       end
     end
@@ -44,6 +44,7 @@ describe Apartment::Adapters::Mysql2Adapter, database: :mysql do
       before { Apartment.use_schemas = false }
 
       it_should_behave_like "a generic apartment adapter"
+      it_should_behave_like "a generic apartment adapter able to handle custom configuration"
       it_should_behave_like "a connection based apartment adapter"
     end
   end

data/spec/adapters/postgresql_adapter_spec.rb

@@ -54,6 +54,7 @@ describe Apartment::Adapters::PostgresqlAdapter, database: :postgresql do
       let(:default_tenant) { subject.switch { ActiveRecord::Base.connection.current_database } }
 
       it_should_behave_like "a generic apartment adapter"
+      it_should_behave_like "a generic apartment adapter able to handle custom configuration"
       it_should_behave_like "a connection based apartment adapter"
     end
   end

data/spec/adapters/sqlite3_adapter_spec.rb

@@ -23,5 +23,61 @@ describe Apartment::Adapters::Sqlite3Adapter, database: :sqlite do
         File.delete(Apartment::Test.config['connections']['sqlite']['database'])
       end
     end
+
+    context "with prepend and append" do
+      let(:default_dir) { File.expand_path(File.dirname(config[:database])) }
+      describe "#prepend" do
+        let (:db_name) { "db_with_prefix" }
+        before do
+          Apartment.configure do |config|
+            config.prepend_environment = true
+            config.append_environment = false
+          end
+        end
+
+        after { subject.drop db_name rescue nil }
+
+        it "should create a new database" do
+          subject.create db_name
+
+          expect(File.exists?("#{default_dir}/#{Rails.env}_#{db_name}.sqlite3")).to eq true
+        end
+      end
+
+      describe "#neither" do
+        let (:db_name) { "db_without_prefix_suffix" }
+        before do
+          Apartment.configure { |config| config.prepend_environment = config.append_environment = false }
+        end
+
+        after { subject.drop db_name rescue nil }
+
+        it "should create a new database" do
+          subject.create db_name
+
+          expect(File.exists?("#{default_dir}/#{db_name}.sqlite3")).to eq true
+        end
+      end
+
+      describe "#append" do
+        let (:db_name) { "db_with_suffix" }
+        before do
+          Apartment.configure do |config|
+            config.prepend_environment = false
+            config.append_environment = true
+          end
+        end
+
+        after { subject.drop db_name rescue nil }
+
+        it "should create a new database" do
+          subject.create db_name
+
+          expect(File.exists?("#{default_dir}/#{db_name}_#{Rails.env}.sqlite3")).to eq true
+        end
+      end
+
+    end
+
   end
 end

data/spec/apartment_spec.rb

@@ -2,11 +2,11 @@ require 'spec_helper'
 
 describe Apartment do
   it "should be valid" do
-    Apartment.should be_a(Module)
+    expect(Apartment).to be_a(Module)
   end
 
   it "should be a valid app" do
-    ::Rails.application.should be_a(Dummy::Application)
+    expect(::Rails.application).to be_a(Dummy::Application)
   end
 
   it "should deprecate Apartment::Database in favor of Apartment::Tenant" do

data/spec/examples/connection_adapter_examples.rb

@@ -12,7 +12,7 @@ shared_examples_for "a connection based apartment adapter" do
       end
       Apartment::Tenant.init
 
-      Company.connection.object_id.should_not == ActiveRecord::Base.connection.object_id
+      expect(Company.connection.object_id).not_to eq(ActiveRecord::Base.connection.object_id)
     end
   end
 

data/spec/examples/generic_adapter_custom_configuration_example.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+shared_examples_for "a generic apartment adapter able to handle custom configuration" do
+
+  let(:custom_tenant_name) { 'test_tenantwwww' }
+  let(:db) { |example| example.metadata[:database]}
+  let(:custom_tenant_names) do
+    {
+      custom_tenant_name => get_custom_db_conf
+    }
+  end
+
+  before do
+    Apartment.tenant_names = custom_tenant_names
+  end
+
+  context "database key taken from specific config" do
+
+    let(:expected_args) { get_custom_db_conf }
+
+    describe "#create" do
+      it "should establish_connection with the separate connection with expected args" do
+        expect(Apartment::Adapters::AbstractAdapter::SeparateDbConnectionHandler).to receive(:establish_connection).with(expected_args).and_call_original
+
+        # because we dont have another server to connect to it errors
+        # what matters is establish_connection receives proper args
+        expect { subject.create(custom_tenant_name) }.to raise_error(Apartment::TenantExists)
+      end
+    end
+
+    describe "#drop" do
+      it "should establish_connection with the separate connection with expected args" do
+        expect(Apartment::Adapters::AbstractAdapter::SeparateDbConnectionHandler).to receive(:establish_connection).with(expected_args).and_call_original
+
+        # because we dont have another server to connect to it errors
+        # what matters is establish_connection receives proper args
+        expect { subject.drop(custom_tenant_name) }.to raise_error(Apartment::TenantNotFound)
+      end
+    end
+  end
+
+  context "database key from tenant name" do
+
+    let(:expected_args) {
+      get_custom_db_conf.tap {|args| args.delete(:database) }
+    }
+
+    describe "#switch!" do
+
+      it "should connect to new db" do
+        expect(Apartment).to receive(:establish_connection) do |args|
+          db_name = args.delete(:database)
+
+          expect(args).to eq expected_args
+          expect(db_name).to match custom_tenant_name
+
+          # we only need to check args, then we short circuit
+          # in order to avoid the mess due to the `establish_connection` override
+          raise ActiveRecord::ActiveRecordError
+        end
+
+        expect { subject.switch!(custom_tenant_name) }.to raise_error(Apartment::TenantNotFound)
+      end
+    end
+  end
+
+  def specific_connection
+    {
+      postgresql: {
+        adapter:  'postgresql',
+        database: 'override_database',
+        password: 'override_password',
+        username: 'overridepostgres'
+      },
+      mysql: {
+        adapter:  'mysql2',
+        database: 'override_database',
+        username: 'root'
+      },
+      sqlite: {
+        adapter:  'sqlite3',
+        database: 'override_database'
+      }
+    }
+  end
+
+  def get_custom_db_conf
+    specific_connection[db.to_sym].with_indifferent_access
+  end
+end