dr-apartment 0.14.1

data/lib/apartment/adapters/abstract_adapter.rb

@@ -0,0 +1,176 @@
+require 'active_record'
+
+module Apartment
+  
+  module Adapters
+  
+    class AbstractAdapter
+      
+      #   @constructor
+      #   @param {Hash} config Database config
+      #   @param {Hash} defaults Some default options
+      # 
+      def initialize(config, defaults = {})
+        @config = config
+        @defaults = defaults
+      end
+      
+      #   Create a new database, import schema, seed if appropriate
+      # 
+      #   @param {String} database Database name
+      # 
+      def create(database)
+        create_database(database)
+
+        process(database) do
+          import_database_schema
+
+          # Seed data if appropriate
+          seed_data if Apartment.seed_after_create
+          
+          yield if block_given?
+        end
+      end
+      
+      #   Get the current database name
+      #   
+      #   @return {String} current database name
+      # 
+      def current_database
+        ActiveRecord::Base.connection.current_database
+      end
+      
+      #   Drop the database
+      # 
+      #   @param {String} database Database name
+      # 
+      def drop(database)
+        # ActiveRecord::Base.connection.drop_database   note that drop_database will not throw an exception, so manually execute
+        ActiveRecord::Base.connection.execute("DROP DATABASE #{environmentify(database)}" )
+        
+      rescue ActiveRecord::StatementInvalid => e
+        raise DatabaseNotFound, "The database #{environmentify(database)} cannot be found"
+      end
+      
+      #   Prepend the environment if configured and the environment isn't already there
+      # 
+      #   @param {String} database Database name
+      #   @return {String} database name with Rails environment *optionally* prepended
+      # 
+      def environmentify(database)
+        Apartment.prepend_environment && !database.include?(Rails.env) ? "#{Rails.env}_#{database}" : database
+      end
+
+      #   Connect to db, do your biz, switch back to previous db
+      # 
+      #   @param {String?} database Database or schema to connect to
+      # 
+      def process(database = nil)
+        current_db = current_database
+        switch(database)
+        yield if block_given?
+
+      ensure
+        switch(current_db) rescue reset
+      end
+
+      #   Establish a new connection for each specific excluded model
+      # 
+      def process_excluded_models
+        # All other models will shared a connection (at ActiveRecord::Base) and we can modify at will
+        Apartment.excluded_models.each do |excluded_model|
+          # Note that due to rails reloading, we now take string references to classes rather than
+          # actual object references.  This way when we contantize, we always get the proper class reference
+          if excluded_model.is_a? Class
+            warn "[Deprecation Warning] Passing class references to excluded models is now deprecated, please use a string instead"
+            excluded_model = excluded_model.name
+          end
+          
+          excluded_model.constantize.establish_connection @config
+        end
+      end
+      
+      #   Reset the database connection to the default
+      # 
+      def reset
+        ActiveRecord::Base.establish_connection @config
+      end
+      
+      #   Switch to new connection (or schema if appopriate)
+      # 
+      #   @param {String} database Database name
+      # 
+      def switch(database = nil)
+        # Just connect to default db and return
+        return reset if database.nil?
+
+        connect_to_new(database)
+      end
+
+      #   Load the rails seed file into the db
+      #   
+      def seed_data
+        silence_stream(STDOUT){ load_or_abort("#{Rails.root}/db/seeds.rb") } # Don't log the output of seeding the db
+      end
+      alias_method :seed, :seed_data
+      
+    protected
+    
+      #   Create the database
+      # 
+      #   @param {String} database Database name
+      # 
+      def create_database(database)
+        ActiveRecord::Base.connection.create_database( environmentify(database) )
+
+      rescue ActiveRecord::StatementInvalid => e
+        raise DatabaseExists, "The database #{environmentify(database)} already exists."
+      end
+  
+      #   Connect to new database
+      # 
+      #   @param {String} database Database name
+      # 
+      def connect_to_new(database)
+        ActiveRecord::Base.establish_connection multi_tenantify(database)
+        ActiveRecord::Base.connection.active?   # call active? to manually check if this connection is valid
+
+      rescue ActiveRecord::StatementInvalid => e
+        raise DatabaseNotFound, "The database #{environmentify(database)} cannot be found."
+      end
+      
+      #   Import the database schema
+      # 
+      def import_database_schema
+        ActiveRecord::Schema.verbose = false    # do not log schema load output.
+        load_or_abort("#{Rails.root}/db/schema.rb")
+      end
+      
+      #   Return a new config that is multi-tenanted
+      # 
+      def multi_tenantify(database)
+        @config.clone.tap do |config|
+          config[:database] = environmentify(database)
+        end
+      end
+      
+      #   Load a file or abort if it doesn't exists
+      # 
+      def load_or_abort(file)
+        if File.exists?(file)
+          load(file)
+        else
+          abort %{#{file} doesn't exist yet}
+        end
+      end
+      
+      #   Remove all non-alphanumeric characters
+      # 
+      def sanitize(database)
+        warn "[Deprecation Warning] Sanitize is no longer used, client should ensure proper database names"
+        database.gsub(/[\W]/,'')
+      end
+      
+    end
+  end
+end

data/lib/apartment/adapters/jdbcpostgresql_adapter.rb

@@ -0,0 +1,115 @@
+module Apartment
+
+  module Database
+
+    def self.jdbcpostgresql_adapter(config)
+      Apartment.use_postgres_schemas ?        
+        Adapters::PostgresqlSchemaAdapter.new(config, :schema_search_path => ActiveRecord::Base.connection.schema_search_path) :
+        Adapters::PostgresqlAdapter.new(config)
+    end
+
+  end
+
+  module Adapters
+
+    # Default adapter when not using Postgresql Schemas
+    class PostgresqlAdapter < AbstractAdapter
+
+    protected
+
+      #   Connect to new database
+      #   Abstract adapter will catch generic ActiveRecord error
+      #   Catch specific adapter errors here
+      #
+      #   @param {String} database Database name
+      #
+      def connect_to_new(database)
+        super
+      rescue PGError
+        raise DatabaseNotFound, "Cannot find database #{environmentify(database)}"
+      end
+
+    end
+
+    # Separate Adapter for Postgresql when using schemas
+    class PostgresqlSchemaAdapter < AbstractAdapter
+      puts ActiveRecord::Base.connection.class
+
+      #   Get the current schema search path
+      #
+      #   @return {String} current schema search path
+      #
+      def current_database
+        ActiveRecord::Base.connection.schema_search_path
+      end
+
+      #   Drop the database schema
+      #
+      #   @param {String} database Database (schema) to drop
+      #
+      def drop(database)
+        ActiveRecord::Base.connection.execute("DROP SCHEMA #{database} CASCADE")
+
+      rescue ActiveRecord::StatementInvalid
+        raise SchemaNotFound, "The schema #{database.inspect} cannot be found."
+      end
+
+      #   Reset search path to default search_path
+      #   Set the table_name to always use the public namespace for excluded models
+      #
+      def process_excluded_models
+        Apartment.excluded_models.each do |excluded_model|
+          # Note that due to rails reloading, we now take string references to classes rather than
+          # actual object references.  This way when we contantize, we always get the proper class reference
+          if excluded_model.is_a? Class
+            warn "[Deprecation Warning] Passing class references to excluded models is now deprecated, please use a string instead"
+            excluded_model = excluded_model.name
+          end
+
+          excluded_model.constantize.tap do |klass|
+            # some models (such as delayed_job) seem to load and cache their column names before this,
+            # so would never get the public prefix, so reset first
+            klass.reset_column_information
+
+            # Ensure that if a schema *was* set, we override
+            table_name = klass.table_name.split('.', 2).last
+
+            # Not sure why, but Delayed::Job somehow ignores table_name_prefix...  so we'll just manually set table name instead
+            klass.table_name = "public.#{table_name}"
+          end
+        end
+      end
+
+      #   Reset schema search path to the default schema_search_path
+      #
+      #   @return {String} default schema search path
+      #
+      def reset
+        ActiveRecord::Base.connection.schema_search_path = @defaults[:schema_search_path]
+      end
+
+    protected
+
+      #   Set schema search path to new schema
+      #
+      def connect_to_new(database = nil)
+        return reset if database.nil?
+        ActiveRecord::Base.connection.schema_search_path = database
+
+      rescue ActiveRecord::StatementInvalid
+        raise SchemaNotFound, "The schema #{database.inspect} cannot be found."
+      end
+
+      #   Create the new schema
+      #
+      def create_database(database)
+        ActiveRecord::Base.connection.execute("CREATE SCHEMA #{database}")
+
+      rescue ActiveRecord::StatementInvalid
+        raise SchemaExists, "The schema #{database} already exists."
+      end
+
+    end
+
+  end
+end

data/lib/apartment/adapters/mysql_adapter.rb

@@ -0,0 +1,18 @@
+module Apartment
+
+  module Database
+    
+    def self.mysql_adapter(config)
+      Adapters::MysqlAdapter.new config
+    end
+  end
+  
+  module Adapters
+  
+    class MysqlAdapter < AbstractAdapter
+      
+    end
+    
+  end
+  
+end

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -0,0 +1,114 @@
+module Apartment
+
+  module Database
+
+    def self.postgresql_adapter(config)
+      Apartment.use_postgres_schemas ?
+        Adapters::PostgresqlSchemaAdapter.new(config, :schema_search_path => ActiveRecord::Base.connection.schema_search_path) :
+        Adapters::PostgresqlAdapter.new(config)
+    end
+
+  end
+
+  module Adapters
+
+    # Default adapter when not using Postgresql Schemas
+    class PostgresqlAdapter < AbstractAdapter
+
+    protected
+
+      #   Connect to new database
+      #   Abstract adapter will catch generic ActiveRecord error
+      #   Catch specific adapter errors here
+      #
+      #   @param {String} database Database name
+      #
+      def connect_to_new(database)
+        super
+      rescue PGError
+        raise DatabaseNotFound, "Cannot find database #{environmentify(database)}"
+      end
+
+    end
+
+    # Separate Adapter for Postgresql when using schemas
+    class PostgresqlSchemaAdapter < AbstractAdapter
+
+      #   Get the current schema search path
+      #
+      #   @return {String} current schema search path
+      #
+      def current_database
+        ActiveRecord::Base.connection.schema_search_path
+      end
+
+      #   Drop the database schema
+      #
+      #   @param {String} database Database (schema) to drop
+      #
+      def drop(database)
+        ActiveRecord::Base.connection.execute("DROP SCHEMA #{database} CASCADE")
+
+      rescue ActiveRecord::StatementInvalid
+        raise SchemaNotFound, "The schema #{database.inspect} cannot be found."
+      end
+
+      #   Reset search path to default search_path
+      #   Set the table_name to always use the public namespace for excluded models
+      #
+      def process_excluded_models
+        Apartment.excluded_models.each do |excluded_model|
+          # Note that due to rails reloading, we now take string references to classes rather than
+          # actual object references.  This way when we contantize, we always get the proper class reference
+          if excluded_model.is_a? Class
+            warn "[Deprecation Warning] Passing class references to excluded models is now deprecated, please use a string instead"
+            excluded_model = excluded_model.name
+          end
+
+          excluded_model.constantize.tap do |klass|
+            # some models (such as delayed_job) seem to load and cache their column names before this,
+            # so would never get the public prefix, so reset first
+            klass.reset_column_information
+
+            # Ensure that if a schema *was* set, we override
+            table_name = klass.table_name.split('.', 2).last
+
+            # Not sure why, but Delayed::Job somehow ignores table_name_prefix...  so we'll just manually set table name instead
+            klass.table_name = "public.#{table_name}"
+          end
+        end
+      end
+
+      #   Reset schema search path to the default schema_search_path
+      #
+      #   @return {String} default schema search path
+      #
+      def reset
+        ActiveRecord::Base.connection.schema_search_path = @defaults[:schema_search_path]
+      end
+
+    protected
+
+      #   Set schema search path to new schema
+      #
+      def connect_to_new(database = nil)
+        return reset if database.nil?
+        ActiveRecord::Base.connection.schema_search_path = database
+
+      rescue ActiveRecord::StatementInvalid
+        raise SchemaNotFound, "The schema #{database.inspect} cannot be found."
+      end
+
+      #   Create the new schema
+      #
+      def create_database(database)
+        ActiveRecord::Base.connection.execute("CREATE SCHEMA #{database}")
+
+      rescue ActiveRecord::StatementInvalid
+        raise SchemaExists, "The schema #{database} already exists."
+      end
+
+    end
+
+  end
+end

data/lib/apartment/console.rb

@@ -0,0 +1,12 @@
+# A workaraound to get `reload!` to also call Apartment::Database.init
+# This is unfortunate, but I haven't figured out how to hook into the reload process *after* files are reloaded
+
+# reloads the environment
+def reload!(print=true)
+  puts "Reloading..." if print
+  # This triggers the to_prepare callbacks
+  ActionDispatch::Callbacks.new(Proc.new {}).call({})
+  # Manually init Apartment again once classes are reloaded
+  Apartment::Database.init
+  true
+end

data/lib/apartment/database.rb

@@ -0,0 +1,57 @@
+require 'active_support/core_ext/module/delegation'
+
+module Apartment
+  
+  #   The main entry point to Apartment functions
+  module Database
+    
+    extend self
+
+    delegate :create, :current_database, :drop, :process, :process_excluded_models, :reset, :seed, :switch, :to => :adapter
+
+    #   Initialize Apartment config options such as excluded_models
+    # 
+    def init
+      process_excluded_models
+    end
+    
+    #   Fetch the proper multi-tenant adapter based on Rails config
+    # 
+    #   @return {subclass of Apartment::AbstractAdapter}
+    # 
+    def adapter
+      @adapter ||= begin
+        adapter_method = "#{config[:adapter]}_adapter"
+
+        begin
+          require "apartment/adapters/#{adapter_method}"
+        rescue LoadError => e
+          raise "The adapter `#{config[:adapter]}` is not yet supported"
+        end
+
+        unless respond_to?(adapter_method)
+          raise AdapterNotFound, "database configuration specifies nonexistent #{config[:adapter]} adapter"
+        end
+      
+        send(adapter_method, config)
+      end
+    end
+    
+    #   Reset config and adapter so they are regenerated
+    # 
+    def reload!
+      @adapter = nil
+      @config = nil
+    end
+    
+  private
+  
+    #   Fetch the rails database configuration
+    # 
+    def config
+      @config ||= Rails.configuration.database_configuration[Rails.env].symbolize_keys
+    end
+    
+  end
+  
+end