ros-apartment 2.3.0.alpha1

data/lib/tasks/apartment.rake

@@ -0,0 +1,145 @@
+require 'apartment/migrator'
+require 'parallel'
+
+apartment_namespace = namespace :apartment do
+
+  desc "Create all tenants"
+  task :create do
+    tenants.each do |tenant|
+      begin
+        puts("Creating #{tenant} tenant")
+        Apartment::Tenant.create(tenant)
+      rescue Apartment::TenantExists => e
+        puts e.message
+      end
+    end
+  end
+
+  desc "Drop all tenants"
+  task :drop do
+    tenants.each do |tenant|
+      begin
+        puts("Dropping #{tenant} tenant")
+        Apartment::Tenant.drop(tenant)
+      rescue Apartment::TenantNotFound => e
+        puts e.message
+      end
+    end
+  end
+
+  desc "Migrate all tenants"
+  task :migrate do
+    warn_if_tenants_empty
+    each_tenant do |tenant|
+      begin
+        puts("Migrating #{tenant} tenant")
+        Apartment::Migrator.migrate tenant
+      rescue Apartment::TenantNotFound => e
+        puts e.message
+      end
+    end
+  end
+
+  desc "Seed all tenants"
+  task :seed do
+    warn_if_tenants_empty
+
+    each_tenant do |tenant|
+      begin
+        puts("Seeding #{tenant} tenant")
+        Apartment::Tenant.switch(tenant) do
+          Apartment::Tenant.seed
+        end
+      rescue Apartment::TenantNotFound => e
+        puts e.message
+      end
+    end
+  end
+
+  desc "Rolls the migration back to the previous version (specify steps w/ STEP=n) across all tenants."
+  task :rollback do
+    warn_if_tenants_empty
+
+    step = ENV['STEP'] ? ENV['STEP'].to_i : 1
+
+    each_tenant do |tenant|
+      begin
+        puts("Rolling back #{tenant} tenant")
+        Apartment::Migrator.rollback tenant, step
+      rescue Apartment::TenantNotFound => e
+        puts e.message
+      end
+    end
+  end
+
+  namespace :migrate do
+    desc 'Runs the "up" for a given migration VERSION across all tenants.'
+    task :up do
+      warn_if_tenants_empty
+
+      version = ENV['VERSION'] ? ENV['VERSION'].to_i : nil
+      raise 'VERSION is required' unless version
+
+      each_tenant do |tenant|
+        begin
+          puts("Migrating #{tenant} tenant up")
+          Apartment::Migrator.run :up, tenant, version
+        rescue Apartment::TenantNotFound => e
+          puts e.message
+        end
+      end
+    end
+
+    desc 'Runs the "down" for a given migration VERSION across all tenants.'
+    task :down do
+      warn_if_tenants_empty
+
+      version = ENV['VERSION'] ? ENV['VERSION'].to_i : nil
+      raise 'VERSION is required' unless version
+
+      each_tenant do |tenant|
+        begin
+          puts("Migrating #{tenant} tenant down")
+          Apartment::Migrator.run :down, tenant, version
+        rescue Apartment::TenantNotFound => e
+          puts e.message
+        end
+      end
+    end
+
+    desc  'Rolls back the tenant one migration and re migrate up (options: STEP=x, VERSION=x).'
+    task :redo do
+      if ENV['VERSION']
+        apartment_namespace['migrate:down'].invoke
+        apartment_namespace['migrate:up'].invoke
+      else
+        apartment_namespace['rollback'].invoke
+        apartment_namespace['migrate'].invoke
+      end
+    end
+  end
+
+  def each_tenant(&block)
+    Parallel.each(tenants, in_threads: Apartment.parallel_migration_threads) do |tenant|
+      block.call(tenant)
+    end
+  end
+
+  def tenants
+    ENV['DB'] ? ENV['DB'].split(',').map { |s| s.strip } : Apartment.tenant_names || []
+  end
+
+  def warn_if_tenants_empty
+    if tenants.empty? && ENV['IGNORE_EMPTY_TENANTS'] != "true"
+      puts <<-WARNING
+        [WARNING] - The list of tenants to migrate appears to be empty. This could mean a few things:
+
+          1. You may not have created any, in which case you can ignore this message
+          2. You've run `apartment:migrate` directly without loading the Rails environment
+            * `apartment:migrate` is now deprecated. Tenants will automatically be migrated with `db:migrate`
+
+        Note that your tenants currently haven't been migrated. You'll need to run `db:migrate` to rectify this.
+      WARNING
+    end
+  end
+end

data/spec/adapters/jdbc_mysql_adapter_spec.rb

@@ -0,0 +1,19 @@
+if defined?(JRUBY_VERSION)
+
+  require 'spec_helper'
+  require 'apartment/adapters/jdbc_mysql_adapter'
+
+  describe Apartment::Adapters::JDBCMysqlAdapter, database: :mysql do
+
+    subject { Apartment::Tenant.jdbc_mysql_adapter config.symbolize_keys }
+
+    def tenant_names
+      ActiveRecord::Base.connection.execute("SELECT schema_name FROM information_schema.schemata").collect { |row| row['schema_name'] }
+    end
+
+    let(:default_tenant) { subject.switch { ActiveRecord::Base.connection.current_database } }
+
+    it_should_behave_like "a generic apartment adapter"
+    it_should_behave_like "a connection based apartment adapter"
+  end
+end

data/spec/adapters/jdbc_postgresql_adapter_spec.rb

@@ -0,0 +1,41 @@
+if defined?(JRUBY_VERSION)
+
+  require 'spec_helper'
+  require 'apartment/adapters/jdbc_postgresql_adapter'
+
+  describe Apartment::Adapters::JDBCPostgresqlAdapter, database: :postgresql do
+
+    subject { Apartment::Tenant.jdbc_postgresql_adapter config.symbolize_keys }
+
+    context "using schemas" do
+
+      before { Apartment.use_schemas = true }
+
+      # Not sure why, but somehow using let(:tenant_names) memoizes for the whole example group, not just each test
+      def tenant_names
+        ActiveRecord::Base.connection.execute("SELECT nspname FROM pg_namespace;").collect { |row| row['nspname'] }
+      end
+
+      let(:default_tenant) { subject.switch { ActiveRecord::Base.connection.schema_search_path.gsub('"', '') } }
+
+      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_schemas = false }
+
+      # Not sure why, but somehow using let(:tenant_names) memoizes for the whole example group, not just each test
+      def tenant_names
+        connection.execute("select datname from pg_database;").collect { |row| row['datname'] }
+      end
+
+      let(:default_tenant) { subject.switch { ActiveRecord::Base.connection.current_database } }
+
+      it_should_behave_like "a generic apartment adapter"
+      it_should_behave_like "a connection based apartment adapter"
+
+    end
+  end
+end

data/spec/adapters/mysql2_adapter_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+require 'apartment/adapters/mysql2_adapter'
+
+describe Apartment::Adapters::Mysql2Adapter, database: :mysql do
+  unless defined?(JRUBY_VERSION)
+
+    subject(:adapter){ Apartment::Tenant.mysql2_adapter config }
+
+    def tenant_names
+      ActiveRecord::Base.connection.execute("SELECT schema_name FROM information_schema.schemata").collect { |row| row[0] }
+    end
+
+    let(:default_tenant) { subject.switch { ActiveRecord::Base.connection.current_database } }
+
+    context "using - the equivalent of - schemas" do
+      before { Apartment.use_schemas = true }
+
+      it_should_behave_like "a generic apartment adapter"
+
+      describe "#default_tenant" do
+        it "is set to the original db from config" do
+          expect(subject.default_tenant).to eq(config[:database])
+        end
+      end
+
+      describe "#init" do
+        include Apartment::Spec::AdapterRequirements
+
+        before do
+          Apartment.configure do |config|
+            config.excluded_models = ["Company"]
+          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
+
+          expect(Company.table_name).to eq("#{default_tenant}.companies")
+        end
+      end
+    end
+
+    context "using connections" 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
+end

data/spec/adapters/postgresql_adapter_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require 'apartment/adapters/postgresql_adapter'
+
+describe Apartment::Adapters::PostgresqlAdapter, database: :postgresql do
+  unless defined?(JRUBY_VERSION)
+
+    subject{ Apartment::Tenant.postgresql_adapter config }
+
+    context "using schemas with schema.rb" do
+
+      before{ Apartment.use_schemas = true }
+
+      # Not sure why, but somehow using let(:tenant_names) memoizes for the whole example group, not just each test
+      def tenant_names
+        ActiveRecord::Base.connection.execute("SELECT nspname FROM pg_namespace;").collect { |row| row['nspname'] }
+      end
+
+      let(:default_tenant) { subject.switch { ActiveRecord::Base.connection.schema_search_path.gsub('"', '') } }
+
+      it_should_behave_like "a generic apartment adapter"
+      it_should_behave_like "a schema based apartment adapter"
+    end
+
+    context "using schemas with SQL dump" do
+
+      before{ Apartment.use_schemas = true; Apartment.use_sql = true }
+
+      # Not sure why, but somehow using let(:tenant_names) memoizes for the whole example group, not just each test
+      def tenant_names
+        ActiveRecord::Base.connection.execute("SELECT nspname FROM pg_namespace;").collect { |row| row['nspname'] }
+      end
+
+      let(:default_tenant) { subject.switch { ActiveRecord::Base.connection.schema_search_path.gsub('"', '') } }
+
+      it_should_behave_like "a generic apartment adapter"
+      it_should_behave_like "a schema based apartment adapter"
+
+      it 'allows for dashes in the schema name' do
+        expect { Apartment::Tenant.create('has-dashes') }.to_not raise_error
+      end
+
+      after { Apartment::Tenant.drop('has-dashes') if Apartment.connection.schema_exists? 'has-dashes' }
+    end
+
+    context "using connections" do
+
+      before{ Apartment.use_schemas = false }
+
+      # Not sure why, but somehow using let(:tenant_names) memoizes for the whole example group, not just each test
+      def tenant_names
+        connection.execute("select datname from pg_database;").collect { |row| row['datname'] }
+      end
+
+      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
+end

data/spec/adapters/sqlite3_adapter_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+require 'apartment/adapters/sqlite3_adapter'
+
+describe Apartment::Adapters::Sqlite3Adapter, database: :sqlite do
+  unless defined?(JRUBY_VERSION)
+
+    subject{ Apartment::Tenant.sqlite3_adapter config }
+
+    context "using connections" do
+      def tenant_names
+        db_dir = File.expand_path("../../dummy/db", __FILE__)
+        Dir.glob("#{db_dir}/*.sqlite3").map { |file| File.basename(file, '.sqlite3') }
+      end
+
+      let(:default_tenant) do
+        subject.switch { File.basename(Apartment::Test.config['connections']['sqlite']['database'], '.sqlite3') }
+      end
+
+      it_should_behave_like "a generic apartment adapter"
+      it_should_behave_like "a connection based apartment adapter"
+
+      after(:all) 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

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Apartment do
+  it "should be valid" do
+    expect(Apartment).to be_a(Module)
+  end
+
+  it "should be a valid app" do
+    expect(::Rails.application).to be_a(Dummy::Application)
+  end
+end

data/spec/config/database.yml.sample

@@ -0,0 +1,49 @@
+<% if defined?(JRUBY_VERSION) %>
+connections:
+  postgresql:
+    adapter: postgresql
+    database: apartment_postgresql_test
+    username: postgres
+    min_messages: WARNING
+    driver: org.postgresql.Driver
+    url: jdbc:postgresql://localhost:5432/apartment_postgresql_test
+    timeout: 5000
+    pool: 5
+    host: localhost
+    port: 5432
+
+  mysql:
+    adapter: mysql
+    database: apartment_mysql_test
+    username: root
+    min_messages: WARNING
+    driver: com.mysql.jdbc.Driver
+    url: jdbc:mysql://localhost:3306/apartment_mysql_test
+    timeout: 5000
+    pool: 5
+    host: 127.0.0.1
+    port: 3306
+<% else %>
+connections:
+  postgresql:
+    adapter: postgresql
+    database: apartment_postgresql_test
+    min_messages: WARNING
+    username: postgres
+    schema_search_path: public
+    password:
+    host: localhost
+    port: 5432
+
+  mysql:
+    adapter: mysql2
+    database: apartment_mysql_test
+    username: root
+    password:
+    host: 127.0.0.1
+    port: 3306
+
+  sqlite:
+    adapter: sqlite3
+    database: <%= File.expand_path('../spec/dummy/db', __FILE__) %>/default.sqlite3
+<% end %>