apartment 0.26.1 → 1.0.0

data/lib/apartment/adapters/mysql2_adapter.rb

@@ -13,6 +13,12 @@ module Apartment
   module Adapters
     class Mysql2Adapter < AbstractAdapter
 
+      def initialize(config)
+        super
+
+        @default_tenant = config[:database]
+      end
+
     protected
 
       #   Connect to new tenant
@@ -25,13 +31,11 @@ module Apartment
         super
       rescue Mysql2::Error
         Apartment::Tenant.reset
-        raise DatabaseNotFound, "Cannot find tenant #{environmentify(tenant)}"
+        raise TenantNotFound, "Cannot find tenant #{environmentify(tenant)}"
       end
     end
 
     class Mysql2SchemaAdapter < AbstractAdapter
-      attr_reader :default_tenant
-
       def initialize(config)
         super
 
@@ -39,7 +43,7 @@ module Apartment
         reset
       end
 
-      #   Reset current_tenant to the default_tenant
+      #   Reset current tenant to the default_tenant
       #
       def reset
         Apartment.connection.execute "use #{default_tenant}"
@@ -53,7 +57,7 @@ module Apartment
 
     protected
 
-      #   Set schema current_tenant to new db
+      #   Connect to new tenant
       #
       def connect_to_new(tenant)
         return reset if tenant.nil?
@@ -62,7 +66,7 @@ module Apartment
 
       rescue ActiveRecord::StatementInvalid
         Apartment::Tenant.reset
-        raise DatabaseNotFound, "Cannot find tenant #{environmentify(tenant)}"
+        raise TenantNotFound, "Cannot find tenant #{environmentify(tenant)}"
       end
 
       def process_excluded_model(model)

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -20,7 +20,7 @@ module Apartment
         Apartment.connection.execute(%{DROP DATABASE "#{tenant}"})
 
       rescue *rescuable_exceptions
-        raise DatabaseNotFound, "The tenant #{tenant} cannot be found"
+        raise TenantNotFound, "The tenant #{tenant} cannot be found"
       end
 
     private
@@ -47,7 +47,7 @@ module Apartment
         Apartment.connection.execute(%{DROP SCHEMA "#{tenant}" CASCADE})
 
       rescue *rescuable_exceptions
-        raise SchemaNotFound, "The schema #{tenant.inspect} cannot be found."
+        raise TenantNotFound, "The schema #{tenant.inspect} cannot be found."
       end
 
       #   Reset search path to default search_path
@@ -59,7 +59,7 @@ module Apartment
             # Ensure that if a schema *was* set, we override
             table_name = klass.table_name.split('.', 2).last
 
-            klass.table_name = "#{Apartment.default_schema}.#{table_name}"
+            klass.table_name = "#{default_tenant}.#{table_name}"
           end
         end
       end
@@ -69,12 +69,12 @@ module Apartment
       #   @return {String} default schema search path
       #
       def reset
-        @current_tenant = Apartment.default_schema
+        @current = default_tenant
         Apartment.connection.schema_search_path = full_search_path
       end
 
-      def current_tenant
-        @current_tenant || Apartment.default_schema
+      def current
+        @current || default_tenant
       end
 
     protected
@@ -85,11 +85,11 @@ module Apartment
         return reset if tenant.nil?
         raise ActiveRecord::StatementInvalid.new("Could not find schema #{tenant}") unless Apartment.connection.schema_exists? tenant
 
-        @current_tenant = tenant.to_s
+        @current = tenant.to_s
         Apartment.connection.schema_search_path = full_search_path
 
       rescue *rescuable_exceptions
-        raise SchemaNotFound, "One of the following schema(s) is invalid: #{tenant}, #{full_search_path}"
+        raise TenantNotFound, "One of the following schema(s) is invalid: \"#{tenant}\" #{full_search_path}"
       end
 
       #   Create the new schema
@@ -98,7 +98,7 @@ module Apartment
         Apartment.connection.execute(%{CREATE SCHEMA "#{tenant}"})
 
       rescue *rescuable_exceptions
-        raise SchemaExists, "The schema #{tenant} already exists."
+        raise TenantExists, "The schema #{tenant} already exists."
       end
 
     private
@@ -110,7 +110,7 @@ module Apartment
       end
 
       def persistent_schemas
-        [@current_tenant, Apartment.persistent_schemas].flatten
+        [@current, Apartment.persistent_schemas].flatten
       end
     end
 
@@ -155,9 +155,9 @@ module Apartment
         #   .map! {|t| "-T #{t}"}
         #   .join(' ')
 
-        # `pg_dump -s -x -O -n #{default_schema} #{excluded_tables} #{dbname}`
+        # `pg_dump -s -x -O -n #{default_tenant} #{excluded_tables} #{dbname}`
 
-        `pg_dump -s -x -O -n #{default_schema} #{dbname}`
+        `pg_dump -s -x -O -n #{default_tenant} #{dbname}`
       end
 
       #   Dump data from schema_migrations table
@@ -165,7 +165,7 @@ module Apartment
       #   @return {String} raw SQL contaning inserts with data from schema_migrations
       #
       def pg_dump_schema_migrations_data
-        `pg_dump -a --inserts -t schema_migrations -n #{default_schema} #{dbname}`
+        `pg_dump -a --inserts -t schema_migrations -n #{default_tenant} #{dbname}`
       end
 
       #   Remove "SET search_path ..." line from SQL dump and prepend search_path set to current tenant
@@ -173,7 +173,7 @@ module Apartment
       #   @return {String} patched raw SQL dump
       #
       def patch_search_path(sql)
-        search_path = "SET search_path = \"#{current}\", #{default_schema};"
+        search_path = "SET search_path = \"#{current}\", #{default_tenant};"
 
         sql
           .split("\n")
@@ -199,13 +199,7 @@ module Apartment
       # Convenience method for current database name
       #
       def dbname
-        ActiveRecord::Base.connection_config[:database]
-      end
-
-      # Convenience method for the default schema
-      #
-      def default_schema
-        Apartment.default_schema
+        Apartment.connection_config[:database]
       end
     end
   end

data/lib/apartment/adapters/sqlite3_adapter.rb

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

data/lib/apartment/deprecation.rb

@@ -0,0 +1,13 @@
+module Apartment
+  module Deprecation
+
+    def self.warn(message)
+      begin
+        ActiveSupport::Deprecation.warn message
+      rescue
+        warn message
+      end
+    end
+
+  end
+end

data/lib/apartment/elevators/generic.rb

@@ -1,5 +1,6 @@
 require 'rack/request'
 require 'apartment/tenant'
+require 'apartment/deprecation'
 
 module Apartment
   module Elevators
@@ -17,7 +18,7 @@ module Apartment
 
         database = @processor.call(request)
 
-        Apartment::Tenant.switch database if database
+        Apartment::Tenant.switch! database if database
 
         @app.call(env)
       end
@@ -41,7 +42,7 @@ module Apartment
       end
 
       def deprecation_warning
-        warn "[DEPRECATED::Apartment] Use #parse_tenant_name instead of #parse_database_name -> #{self.class.name}"
+        Apartment::Deprecation.warn "[DEPRECATED::Apartment] Use #parse_tenant_name instead of #parse_database_name -> #{self.class.name}"
       end
     end
   end

data/lib/apartment/elevators/host_hash.rb

@@ -12,7 +12,7 @@ module Apartment
       end
 
       def parse_tenant_name(request)
-        raise DatabaseNotFound,
+        raise TenantNotFound,
           "Cannot find tenant for host #{request.host}" unless @hash.has_key?(request.host)
 
         @hash[request.host]

data/lib/apartment/migrator.rb

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

data/lib/apartment/tasks/enhancements.rb

@@ -1,26 +1,36 @@
 # 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
+module Apartment
+  class RakeTaskEnhancer
+    
+    TASKS = %w(db:migrate db:rollback db:migrate:up db:migrate:down db:migrate:redo db:seed)
+    
+    # This is a bit convoluted, but helps solve problems when using Apartment within an engine
+    # See spec/integration/use_within_an_engine.rb
+    
+    class << self
+      def enhance!
+        TASKS.each do |name|
+          task = Rake::Task[name]
+          task.enhance do
+            if should_enhance?
+              enhance_task(task)
+            end
+          end
+        end
+      end
+    
+      def should_enhance?
+        Apartment.db_migrate_tenants
+      end
+    
+      def enhance_task(task)
+        Rake::Task[task.name.sub(/db:/, 'apartment:')].invoke
+      end
+    end
+    
+  end
 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
+Apartment::RakeTaskEnhancer.enhance!

data/lib/apartment/tenant.rb

@@ -1,4 +1,5 @@
 require 'forwardable'
+require 'apartment/deprecation'
 
 module Apartment
   #   The main entry point to Apartment functions
@@ -8,7 +9,7 @@ module Apartment
     extend self
     extend Forwardable
 
-    def_delegators :adapter, :create, :current_tenant, :current, :current_database, :drop, :process, :process_excluded_models, :reset, :seed, :switch
+    def_delegators :adapter, :create, :current_tenant, :current, :current_database, :default_tenant, :drop, :switch, :process_excluded_models, :reset, :seed, :switch!
 
     attr_writer :config
 
@@ -60,14 +61,16 @@ module Apartment
     #   Fetch the rails database configuration
     #
     def config
-      @config ||= (ActiveRecord::Base.configurations[Rails.env] ||
-                    Rails.application.config.database_configuration[Rails.env]).symbolize_keys
+      @config ||= Apartment.connection_config
     end
   end
 
   def self.const_missing(const_name)
-    super unless const_name == :Database
-    warn "`Apartment::Database` has been deprecated. Use `Apartment::Tenant` instead."
-    Tenant
+    if const_name == :Database
+      Apartment::Deprecation.warn "`Apartment::Database` has been deprecated. Use `Apartment::Tenant` instead."
+      Tenant
+    else
+      super
+    end
   end
-end
+end

data/lib/apartment/version.rb

@@ -1,3 +1,3 @@
 module Apartment
-  VERSION = "0.26.1"
+  VERSION = "1.0.0"
 end

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

@@ -1,4 +1,6 @@
-# Require whichever elevator you're using below here...
+# You can have Apartment route to the appropriate Tenant by adding some Rack middleware.
+# Apartment can support many different "Elevators" that can take care of this routing to your data.
+# Require whichever Elevator you're using below or none if you have a custom one.
 #
 # require 'apartment/elevators/generic'
 # require 'apartment/elevators/domain'
@@ -9,40 +11,57 @@ require 'apartment/elevators/subdomain'
 #
 Apartment.configure do |config|
 
-  # These models will not be multi-tenanted,
-  # but remain in the global (public) namespace
+  # Add any models that you do not want to be multi-tenanted, but remain in the global (public) namespace.
+  # A typical example would be a Customer or Tenant model that stores each Tenant's information.
   #
-  # An example might be a Customer or Tenant model that stores each tenant information
-  # ex:
+  # config.excluded_models = %w{ Tenant }
+
+  # 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.
   #
-  # config.excluded_models = %w{Tenant}
+  # config.tenant_names = lambda{ Customer.pluck(:tenant_name) }
+  # config.tenant_names = ['tenant1', 'tenant2']
   #
-  config.excluded_models = %w{}
+  config.tenant_names = lambda { ToDo_Tenant_Or_User_Model.pluck :database }
 
-  # use postgres schemas?
-  config.use_schemas = true
+  #
+  # ==> PostgreSQL only options
 
-  # use raw SQL dumps for creating postgres schemas? (only appies with use_schemas set to true)
-  #config.use_sql = true
+  # Specifies whether to use PostgreSQL schemas or create a new database per Tenant.
+  # The default behaviour is true.
+  #
+  # config.use_schemas = true
+
+  # 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
+  # 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)
+  #
+  # config.use_sql = false
 
-  # configure persistent schemas (E.g. hstore )
+  # There are cases where you might want some schemas to always be in your search_path
+  # e.g when using a PostgreSQL extension like hstore.
+  # Any schemas added here will be available along with your selected Tenant.
+  #
   # config.persistent_schemas = %w{ hstore }
 
-  # add the Rails environment to database names?
-  # config.prepend_environment = true
-  # config.append_environment = true
+  # <== PostgreSQL only options
+  #
 
-  # supply list of database names for migrations to run on
-  config.tenant_names = lambda{ ToDo_Tenant_Or_User_Model.pluck :database }
+  # By default, and only when not using PostgreSQL schemas, Apartment will prepend the environment
+  # to the tenant name to ensure there is no conflict between your environments.
+  # This is mainly for the benefit of your development and test environments.
+  # Uncomment the line below if you want to disable this behaviour in production.
+  #
+  # config.prepend_environment = !Rails.env.production?
 end
 
-##
-# Elevator Configuration
-
+# 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|
-#   # TODO: supply generic implementation
+#   request.host.split('.').first
 # }
 
 # Rails.application.config.middleware.use 'Apartment::Elevators::Domain'
-
 Rails.application.config.middleware.use 'Apartment::Elevators::Subdomain'