apartment 0.23.2 → 0.24.0

data/lib/apartment/adapters/mysql2_adapter.rb

@@ -15,37 +15,37 @@ module Apartment
 
     protected
 
-      #   Connect to new database
+      #   Connect to new tenant
       #   Abstract adapter will catch generic ActiveRecord error
       #   Catch specific adapter errors here
       #
-      #   @param {String} database Database name
+      #   @param {String} tenant Tenant name
       #
-      def connect_to_new(database = nil)
+      def connect_to_new(tenant = nil)
         super
       rescue Mysql2::Error
         Apartment::Database.reset
-        raise DatabaseNotFound, "Cannot find database #{environmentify(database)}"
+        raise DatabaseNotFound, "Cannot find tenant #{environmentify(tenant)}"
       end
     end
 
     class Mysql2SchemaAdapter < AbstractAdapter
-      attr_reader :default_database
+      attr_reader :default_tenant
 
       def initialize(config)
         super
 
-        @default_database = config[:database]
+        @default_tenant = config[:database]
         reset
       end
 
-      #   Reset current_database to the default_database
+      #   Reset current_tenant to the default_tenant
       #
       def reset
-        Apartment.connection.execute "use #{default_database}"
+        Apartment.connection.execute "use #{default_tenant}"
       end
 
-      #   Set the table_name to always use the default database for excluded models
+      #   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) }
@@ -53,16 +53,16 @@ module Apartment
 
     protected
 
-      #   Set schema current_database to new db
+      #   Set schema current_tenant to new db
       #
-      def connect_to_new(database)
-        return reset if database.nil?
+      def connect_to_new(tenant)
+        return reset if tenant.nil?
 
-        Apartment.connection.execute "use #{environmentify(database)}"
+        Apartment.connection.execute "use #{environmentify(tenant)}"
 
       rescue ActiveRecord::StatementInvalid
         Apartment::Database.reset
-        raise DatabaseNotFound, "Cannot find database #{environmentify(database)}"
+        raise DatabaseNotFound, "Cannot find tenant #{environmentify(tenant)}"
       end
 
       def process_excluded_model(model)
@@ -74,7 +74,7 @@ module Apartment
           # Ensure that if a schema *was* set, we override
           table_name = klass.table_name.split('.', 2).last
 
-          klass.table_name = "#{default_database}.#{table_name}"
+          klass.table_name = "#{default_tenant}.#{table_name}"
         end
       end
     end

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -14,6 +14,14 @@ 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 DatabaseNotFound, "The tenant #{tenant} cannot be found"
+      end
+
     private
 
       def rescue_from
@@ -30,15 +38,15 @@ module Apartment
         reset
       end
 
-      #   Drop the database schema
+      #   Drop the tenant
       #
-      #   @param {String} database Database (schema) to drop
+      #   @param {String} tenant Database (schema) to drop
       #
-      def drop(database)
-        Apartment.connection.execute(%{DROP SCHEMA "#{database}" CASCADE})
+      def drop(tenant)
+        Apartment.connection.execute(%{DROP SCHEMA "#{tenant}" CASCADE})
 
       rescue *rescuable_exceptions
-        raise SchemaNotFound, "The schema #{database.inspect} cannot be found."
+        raise SchemaNotFound, "The schema #{tenant.inspect} cannot be found."
       end
 
       #   Reset search path to default search_path
@@ -64,36 +72,36 @@ module Apartment
       #   @return {String} default schema search path
       #
       def reset
-        @current_database = Apartment.default_schema
+        @current_tenant = Apartment.default_schema
         Apartment.connection.schema_search_path = full_search_path
       end
 
-      def current_database
-        @current_database || Apartment.default_schema
+      def current_tenant
+        @current_tenant || Apartment.default_schema
       end
 
     protected
 
       #   Set schema search path to new schema
       #
-      def connect_to_new(database = nil)
-        return reset if database.nil?
-        raise ActiveRecord::StatementInvalid.new("Could not find schema #{database}") unless Apartment.connection.schema_exists? database
+      def connect_to_new(tenant = nil)
+        return reset if tenant.nil?
+        raise ActiveRecord::StatementInvalid.new("Could not find schema #{tenant}") unless Apartment.connection.schema_exists? tenant
 
-        @current_database = database.to_s
+        @current_tenant = tenant.to_s
         Apartment.connection.schema_search_path = full_search_path
 
       rescue *rescuable_exceptions
-        raise SchemaNotFound, "One of the following schema(s) is invalid: #{database}, #{full_search_path}"
+        raise SchemaNotFound, "One of the following schema(s) is invalid: #{tenant}, #{full_search_path}"
       end
 
       #   Create the new schema
       #
-      def create_tenant(database)
-        Apartment.connection.execute(%{CREATE SCHEMA "#{database}"})
+      def create_tenant(tenant)
+        Apartment.connection.execute(%{CREATE SCHEMA "#{tenant}"})
 
       rescue *rescuable_exceptions
-        raise SchemaExists, "The schema #{database} already exists."
+        raise SchemaExists, "The schema #{tenant} already exists."
       end
 
     private
@@ -103,9 +111,9 @@ module Apartment
       def full_search_path
         persistent_schemas.map(&:inspect).join(", ")
       end
-      
+
       def persistent_schemas
-        [@current_database, Apartment.persistent_schemas].flatten
+        [@current_tenant, Apartment.persistent_schemas].flatten
       end
     end
   end

data/lib/apartment/adapters/sqlite3_adapter.rb

@@ -15,38 +15,38 @@ module Apartment
         super
       end
 
-      def drop(database)
+      def drop(tenant)
         raise DatabaseNotFound,
-          "The database #{environmentify(database)} cannot be found." unless File.exists?(database_file(database))
+          "The tenant #{environmentify(tenant)} cannot be found." unless File.exists?(database_file(tenant))
 
-        File.delete(database_file(database))
+        File.delete(database_file(tenant))
       end
 
-      def current_database
+      def current_tenant
         File.basename(Apartment.connection.instance_variable_get(:@config)[:database], '.sqlite3')
       end
 
     protected
 
-      def connect_to_new(database)
+      def connect_to_new(tenant)
         raise DatabaseNotFound,
-          "The database #{environmentify(database)} cannot be found." unless File.exists?(database_file(database))
+          "The tenant #{environmentify(tenant)} cannot be found." unless File.exists?(database_file(tenant))
 
-        super database_file(database)
+        super database_file(tenant)
       end
 
-      def create_tenant(database)
+      def create_tenant(tenant)
         raise DatabaseExists,
-          "The database #{environmentify(database)} already exists." if File.exists?(database_file(database))
+          "The tenant #{environmentify(tenant)} already exists." if File.exists?(database_file(tenant))
 
-        f = File.new(database_file(database), File::CREAT)
+        f = File.new(database_file(tenant), File::CREAT)
         f.close
       end
 
-      private
+    private
 
-      def database_file(database)
-        "#{@default_dir}/#{database}.sqlite3"
+      def database_file(tenant)
+        "#{@default_dir}/#{tenant}.sqlite3"
       end
     end
   end

data/lib/apartment/database.rb

@@ -8,7 +8,7 @@ module Apartment
     extend self
     extend Forwardable
 
-    def_delegators :adapter, :create, :current_database, :current, :drop, :process, :process_excluded_models, :reset, :seed, :switch
+    def_delegators :adapter, :create, :current_tenant, :current, :current_database, :drop, :process, :process_excluded_models, :reset, :seed, :switch
 
     attr_writer :config
 
@@ -63,4 +63,4 @@ module Apartment
       @config ||= Rails.configuration.database_configuration[Rails.env].symbolize_keys
     end
   end
-end
+end

data/lib/apartment/elevators/host_hash.rb

@@ -2,8 +2,8 @@ require 'apartment/elevators/generic'
 
 module Apartment
   module Elevators
-    #   Provides a rack based db switching solution based on hosts
-    #   Uses a hash to find the corresponding database name for the host
+    #   Provides a rack based tenant switching solution based on hosts
+    #   Uses a hash to find the corresponding tenant name for the host
     #
     class HostHash < Generic
       def initialize(app, hash = {}, processor = nil)
@@ -13,7 +13,7 @@ module Apartment
 
       def parse_tenant_name(request)
         raise DatabaseNotFound,
-          "Cannot find database for host #{request.host}" unless @hash.has_key?(request.host)
+          "Cannot find tenant for host #{request.host}" unless @hash.has_key?(request.host)
 
         @hash[request.host]
       end

data/lib/apartment/elevators/subdomain.rb

@@ -37,11 +37,10 @@ module Apartment
         subdomains(host).first
       end
 
-      #   Assuming tld_length of 1, might need to make this configurable in Apartment in the future for things like .co.uk
-      def subdomains(host, tld_length = 1)
+      def subdomains(host)
         return [] unless named_host?(host)
 
-        host.split('.')[0..-(tld_length + 2)]
+        host.split('.')[0..-(Apartment.tld_length + 2)]
       end
 
       def named_host?(host)

data/lib/apartment/migrator.rb

@@ -10,7 +10,7 @@ module Apartment
       Database.process(database) do
         version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
 
-        ActiveRecord::Migrator.migrate(ActiveRecord::Migrator.migrations_path, version) do |migration|
+        ActiveRecord::Migrator.migrate(ActiveRecord::Migrator.migrations_paths, version) do |migration|
           ENV["SCOPE"].blank? || (ENV["SCOPE"] == migration.scope)
         end
       end
@@ -19,14 +19,14 @@ module Apartment
     # Migrate up/down to a specific version
     def run(direction, database, version)
       Database.process(database) do
-        ActiveRecord::Migrator.run(direction, ActiveRecord::Migrator.migrations_path, version)
+        ActiveRecord::Migrator.run(direction, ActiveRecord::Migrator.migrations_paths, version)
       end
     end
 
     # rollback latest migration `step` number of times
     def rollback(database, step = 1)
       Database.process(database) do
-        ActiveRecord::Migrator.rollback(ActiveRecord::Migrator.migrations_path, step)
+        ActiveRecord::Migrator.rollback(ActiveRecord::Migrator.migrations_paths, step)
       end
     end
   end

data/lib/apartment/railtie.rb

@@ -13,10 +13,11 @@ module Apartment
       Apartment.configure do |config|
         config.excluded_models = []
         config.use_schemas = true
-        config.database_names = []
+        config.tenant_names = []
         config.seed_after_create = false
         config.prepend_environment = false
         config.append_environment = false
+        config.tld_length = 1
       end
 
       ActiveRecord::Migrator.migrations_paths = Rails.application.paths['db/migrate'].to_a

data/lib/apartment/tasks/enhancements.rb

@@ -0,0 +1,26 @@
+# Require this file to append Apartment rake tasks to ActiveRecord db rake tasks
+# Enabled by default in the initializer
+
+Rake::Task["db:migrate"].enhance do
+  Rake::Task["apartment:migrate"].invoke
+end
+
+Rake::Task["db:rollback"].enhance do
+  Rake::Task["apartment:rollback"].invoke
+end
+
+Rake::Task["db:migrate:up"].enhance do
+  Rake::Task["apartment:migrate:up"].invoke
+end
+
+Rake::Task["db:migrate:down"].enhance do
+  Rake::Task["apartment:migrate:down"].invoke
+end
+
+Rake::Task["db:migrate:redo"].enhance do
+  Rake::Task["apartment:migrate:redo"].invoke
+end
+
+Rake::Task["db:seed"].enhance do
+  Rake::Task["apartment:seed"].invoke
+end

data/lib/apartment/version.rb

@@ -1,3 +1,3 @@
 module Apartment
-  VERSION = "0.23.2"
+  VERSION = "0.24.0"
 end

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

@@ -9,13 +9,15 @@ require 'apartment/elevators/subdomain'
 #
 Apartment.configure do |config|
 
-  # these models will not be multi-tenanted,
+  # These models will not be multi-tenanted,
   # but remain in the global (public) namespace
-  # Note that ActiveRecord::SessionStore::Session is just an example
-  # you may not even use the AR Session Store, in which case you'd remove that line
-  config.excluded_models = %w{
-    ActiveRecord::SessionStore::Session
-  }
+  #
+  # An example might be a Customer or Tenant model that stores each tenant information
+  # ex:
+  #
+  # config.excluded_models = %w{Tenant}
+  #
+  config.excluded_models = %w{}
 
   # use postgres schemas?
   config.use_schemas = true
@@ -28,8 +30,7 @@ Apartment.configure do |config|
   # config.append_environment = true
 
   # supply list of database names for migrations to run on
-  config.database_names = lambda{ ToDo_Tenant_Or_User_Model.pluck :database }
-
+  config.tenant_names = lambda{ ToDo_Tenant_Or_User_Model.pluck :database }
 end
 
 ##
@@ -42,3 +43,7 @@ end
 # Rails.application.config.middleware.use 'Apartment::Elevators::Domain'
 
 Rails.application.config.middleware.use 'Apartment::Elevators::Subdomain'
+
+##
+# Rake enhancements so that db:migrate etc... also runs migrations on all tenants
+require 'apartment/tasks/enhancements'

data/lib/tasks/apartment.rake

@@ -2,38 +2,36 @@ require 'apartment/migrator'
 
 apartment_namespace = namespace :apartment do
 
-  desc "Create all multi-tenant databases"
-  task :create => 'db:migrate' do
-    database_names.each do |db|
+  desc "Create all tenants"
+  task create: 'db:migrate' do
+    tenants.each do |tenant|
       begin
-        puts("Creating #{db} database")
-        quietly { Apartment::Database.create(db) }
+        puts("Creating #{tenant} tenant")
+        quietly { Apartment::Database.create(tenant) }
       rescue Apartment::TenantExists => e
         puts e.message
       end
     end
   end
 
-  desc "Migrate all multi-tenant databases"
-  task :migrate => 'db:migrate' do
-
-    database_names.each do |db|
+  desc "Migrate all tenants"
+  task :migrate do
+    tenants.each do |tenant|
       begin
-        puts("Migrating #{db} database")
-        Apartment::Migrator.migrate db
+        puts("Migrating #{tenant} tenant")
+        Apartment::Migrator.migrate tenant
       rescue Apartment::TenantNotFound => e
         puts e.message
       end
     end
   end
 
-  desc "Seed all multi-tenant databases"
-  task :seed => 'db:seed' do
-
-    database_names.each do |db|
+  desc "Seed all tenants"
+  task :seed do
+    tenants.each do |tenant|
       begin
-        puts("Seeding #{db} database")
-        Apartment::Database.process(db) do
+        puts("Seeding #{tenant} tenant")
+        Apartment::Database.process(tenant) do
           Apartment::Database.seed
         end
       rescue Apartment::TenantNotFound => e
@@ -42,14 +40,14 @@ apartment_namespace = namespace :apartment do
     end
   end
 
-  desc "Rolls the schema back to the previous version (specify steps w/ STEP=n) across all multi-tenant dbs."
-  task :rollback => 'db:rollback' do
+  desc "Rolls the migration back to the previous version (specify steps w/ STEP=n) across all tenants."
+  task :rollback do
     step = ENV['STEP'] ? ENV['STEP'].to_i : 1
 
-    database_names.each do |db|
+    tenants.each do |tenant|
       begin
-        puts("Rolling back #{db} database")
-        Apartment::Migrator.rollback db, step
+        puts("Rolling back #{tenant} tenant")
+        Apartment::Migrator.rollback tenant, step
       rescue Apartment::TenantNotFound => e
         puts e.message
       end
@@ -57,39 +55,38 @@ apartment_namespace = namespace :apartment do
   end
 
   namespace :migrate do
-
-    desc 'Runs the "up" for a given migration VERSION across all multi-tenant dbs.'
-    task :up => 'db:migrate:up' do
+    desc 'Runs the "up" for a given migration VERSION across all tenants.'
+    task :up do
       version = ENV['VERSION'] ? ENV['VERSION'].to_i : nil
       raise 'VERSION is required' unless version
 
-      database_names.each do |db|
+      tenants.each do |tenant|
         begin
-          puts("Migrating #{db} database up")
-          Apartment::Migrator.run :up, db, version
+          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 multi-tenant dbs.'
-    task :down => 'db:migrate:down' do
+    desc 'Runs the "down" for a given migration VERSION across all tenants.'
+    task :down do
       version = ENV['VERSION'] ? ENV['VERSION'].to_i : nil
       raise 'VERSION is required' unless version
 
-      database_names.each do |db|
+      tenants.each do |tenant|
         begin
-          puts("Migrating #{db} database down")
-          Apartment::Migrator.run :down, db, version
+          puts("Migrating #{tenant} tenant down")
+          Apartment::Migrator.run :down, tenant, version
         rescue Apartment::TenantNotFound => e
           puts e.message
         end
       end
     end
 
-    desc  'Rollbacks the database one migration and re migrate up (options: STEP=x, VERSION=x).'
-    task :redo => 'db:migrate:redo' do
+    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
@@ -98,10 +95,9 @@ apartment_namespace = namespace :apartment do
         apartment_namespace['migrate'].invoke
       end
     end
-
   end
 
-  def database_names
-    ENV['DB'] ? ENV['DB'].split(',').map { |s| s.strip } : Apartment.database_names
+  def tenants
+    ENV['DB'] ? ENV['DB'].split(',').map { |s| s.strip } : Apartment.tenant_names
   end
 end