apartment 0.1.3 → 0.5.0

data/lib/apartment/adapters/mysql_adapter.rb

@@ -0,0 +1,11 @@
+module Apartment
+  
+  module Adapters
+  
+    class MysqlAdapter < AbstractAdapter
+      
+    end
+    
+  end
+  
+end

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -0,0 +1,55 @@
+module Apartment
+  
+  module Database
+    
+    def self.postgresql_adapter(config)
+      Adapters::PostgresqlAdapter.new config, :schema_search_path => ActiveRecord::Base.connection.schema_search_path
+    end
+  end
+  
+  module Adapters
+    
+    class PostgresqlAdapter < AbstractAdapter
+      
+      # Set schema path or connect to new db
+	    def connect_to_new(database)	      
+    		return ActiveRecord::Base.connection.schema_search_path = database if using_schemas?
+
+			  super
+      rescue ActiveRecord::StatementInvalid => e
+        raise SchemaNotFound, e
+			end
+			
+			def create(database)
+			  reset
+			  # Postgres will (optionally) use 'schemas' instead of actual dbs, create a new schema while connected to main (global) db
+        create_schema(database) if using_schemas?
+        super(database)
+      end
+			
+			def reset
+			  if using_schemas?
+    		  ActiveRecord::Base.connection.schema_search_path = @defaults[:schema_search_path]
+  		  else
+  		    super
+		    end
+  	  end
+      
+      protected
+      
+        def create_schema(database)
+    		  reset
+    		  
+    		  ActiveRecord::Base.connection.execute("CREATE SCHEMA #{sanitize(database)}")
+    		rescue Exception => e
+    		  raise SchemaExists, e
+    	  end
+
+        def using_schemas?
+          Apartment.use_postgres_schemas
+        end
+			
+    end
+    
+  end
+end

data/lib/apartment/database.rb

@@ -1,80 +1,64 @@
+require 'active_support/core_ext/string/inflections'    # for `constantize`
 
 module Apartment
-	class Database
-		def self.switch(database)
-			
-			config = get_default_database
-			
-			if database.nil?
-				ActiveRecord::Base.establish_connection(config)
-				return
-			end
+	module Database
+	  
+	  MULTI_TENANT_METHODS = [:create, :switch, :reset, :connect_and_reset]
+	  
+	  class << self
 
-			switched_config = multi_tenantify(config, database)
-			
-			puts switched_config.to_yaml
-			
-			ActiveRecord::Base.establish_connection(switched_config)
-			
-			puts Apartment::Config.excluded_models
-			
-			Apartment::Config.excluded_models.each do |m|
-				klass = Kernel
-				m.split("::").each do |i|
-					klass = klass.const_get(i)
-				end
-				
-				raise "Excluded class #{klass} could not be found." if klass.nil?
-				
-				puts "Excluding class #{m}"
-				
-				klass.establish_connection(config)
-			end	
-		end
-		
-		def self.create(database)
-			config = get_default_database
-			
-			switched_config = multi_tenantify(config, database)
-			
-			ActiveRecord::Base.establish_connection(switched_config)
-			
-			if config["adapter"] == "postgresql"
-				ActiveRecord::Base.connection.execute('create table schema_migrations(version varchar(255))')
-			end
-			
-			migrate(database)
-		end
-		
-		def self.migrate(database)
-			
-			config = get_default_database
-			switched_config = multi_tenantify(config, database)
-			
-			ActiveRecord::Base.establish_connection(switched_config)
-			
-			
-			ActiveRecord::Migrator.migrate(File.join(Rails.root, 'db', 'migrate'))
-			
-			ActiveRecord::Base.establish_connection(config)
-		end
-		
-			protected
-				def self.get_default_database
-					Rails.configuration.database_configuration[Rails.env]
-				end
-				
-				def self.multi_tenantify(configuration, database)
-					new_config = configuration.clone
-					
-					if new_config['adapter'] == "postgresql"  
-						new_config['schema_search_path'] = database
-					else
-						new_config['database'] = new_config['database'].gsub(Rails.env.to_s, "#{database}_#{Rails.env}")
-					end
-					
-					new_config
-				end
+      # Call init to establish a connection to the public schema on all excluded models
+      # This must be done before creating any new schemas or switching
+  	  def init
+  	    connect_exclusions
+      end
+      
+      MULTI_TENANT_METHODS.each do |method|
+        class_eval <<-RUBY
+          def #{method}(*args, &block)
+            adapter.send(:#{method}, *args, &block)
+          end
+        RUBY
+      end
+      
+      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
+	    
+	    def reload!
+	      @adapter = nil
+	      @config = nil
+      end
+      
+  		private
+  		
+  		  def connect_exclusions
+  		    # Establish a connection for each specific excluded model
+          # Thus all other models will shared a connection (at ActiveRecord::Base) and we can modify at will
+    	    Apartment.excluded_models.each do |excluded_model|
+    				excluded_model.establish_connection config
+    			end
+        end
+      
+        def config
+          @config ||= Rails.configuration.database_configuration[Rails.env].symbolize_keys
+        end
+    end
+	    					
 	end
 	
 end

data/lib/apartment/elevators/subdomain.rb

@@ -0,0 +1,27 @@
+module Apartment
+  module Elevators
+    # Provides a rack based db switching solution based on subdomains
+    # Assumes that database name should match subdomain
+    class Subdomain
+      
+      def initialize(app)
+        @app = app
+      end
+      
+      def call(env)
+        request = ActionDispatch::Request.new(env)
+        
+        database = subdomain(request)
+        
+        Apartment::Database.switch database if database
+        
+        @app.call(env)
+      end
+      
+      def subdomain(request)
+        request.subdomain.present? && request.subdomain || nil
+      end
+      
+    end
+  end
+end

data/lib/apartment/migrator.rb

@@ -0,0 +1,23 @@
+module Apartment
+  
+  module Migrator
+    
+    extend self
+  
+    # Migrate to latest
+		def migrate(database)
+			Database.connect_and_reset(database){ ActiveRecord::Migrator.migrate(ActiveRecord::Migrator.migrations_path) }
+		end
+	
+    # Migrate up/down to a specific version
+		def run(direction, database, version)
+		  Database.connect_and_reset(database){ ActiveRecord::Migrator.run(direction, ActiveRecord::Migrator.migrations_path, version) }
+	  end
+  
+    # rollback latest migration `step` number of times
+		def rollback(database, step = 1)
+		  Database.connect_and_reset(database){ ActiveRecord::Migrator.rollback(ActiveRecord::Migrator.migrations_path, step) }
+	  end
+  end
+	  
+end

data/lib/apartment/railtie.rb

@@ -1,10 +1,9 @@
-require 'apartment'
 require 'rails'
 
 module Apartment
 	class Railtie < Rails::Railtie
 		rake_tasks do
-			load 'tasks/multi_tenant_migrate.rake'
+			load 'tasks/apartment.rake'
 		end
 	end
 end

data/lib/apartment/version.rb

@@ -0,0 +1,3 @@
+module Apartment
+  VERSION = "0.5.0"
+end

data/lib/tasks/apartment.rake

@@ -0,0 +1,36 @@
+namespace :apartment do
+  
+	desc "Migrate all multi-tenant databases"
+	task :migrate => :environment do
+		ActiveRecord::Migrator.migrate(ActiveRecord::Migrator.migrations_path)
+
+		Apartment.database_names.each{ |db| Apartment::Migrator.migrate db }
+	end
+	
+	desc "Rolls the schema back to the previous version (specify steps w/ STEP=n) across all multi-tenant dbs."
+  task :rollback => :environment do
+    step = ENV['STEP'] ? ENV['STEP'].to_i : 1
+    Apartment.database_names.each{ |db| Apartment::Migrator.rollback db, step }
+  end
+	
+	namespace :migrate do
+	  
+	  desc 'Runs the "up" for a given migration VERSION across all multi-tenant dbs.'
+	  task :up => :environment do
+	    version = ENV['VERSION'] ? ENV['VERSION'].to_i : nil
+      raise 'VERSION is required' unless version
+      
+      Apartment.database_names.each{ |db| Apartment::Migrator.run :up, db, version }
+    end
+	  
+	  desc 'Runs the "down" for a given migration VERSION across all multi-tenant dbs.'
+	  task :down => :environment do
+	    version = ENV['VERSION'] ? ENV['VERSION'].to_i : nil
+      raise 'VERSION is required' unless version
+      
+      Apartment.database_names.each{ |db| Apartment::Migrator.run :down, db, version }
+    end
+    
+  end
+  
+end

data/spec/apartment_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Apartment do
+  it "should be valid" do
+    Apartment.should be_a(Module)
+  end
+end

data/spec/config/database.yml

@@ -0,0 +1,10 @@
+connections:
+  postgresql:
+    adapter: postgresql
+    database: apartment_postgresql_test
+    username: root
+    password:       
+    
+  mysql:
+    adapater: mysql
+    database: apartment_mysql_test

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,6 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+  
+  def index
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/company.rb

@@ -0,0 +1,3 @@
+class Company < ActiveRecord::Base
+  # Dummy models
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  # Dummy models
+end

data/spec/dummy/app/views/application/index.html.erb

@@ -0,0 +1 @@
+<h1>Index!!</h1>

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/dummy/config/application.rb

@@ -0,0 +1,47 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+require "apartment"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    config.middleware.use 'Apartment::Elevators::Subdomain'
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)