apartment 0.1.3 → 0.5.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.log
+

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2@apartment

data/Gemfile

@@ -1,15 +1,8 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
 
-gem "activesupport", ">= 2.3.5"
+# Uses patched version of postgresql adapter to enable apartment usage.  
+# Current postgresql adapter in rails doesn't properly support the use of postgresql schemas
+# Pull request sent => https://github.com/rails/rails/pull/1604
+gem 'rails', '3.0.8', :git => 'git://github.com/bradrobertson/rails', :branch => '3-0-stable'
 
-
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "shoulda", ">= 0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.1"
-  gem "rcov", ">= 0"
-end
+gemspec

data/HISTORY.md

@@ -0,0 +1,31 @@
+# 0.5.0
+  * June 20, 2011
+  
+  - Added the concept of an "Elevator", a rack based strategy for db switching
+  - Added the Subdomain Elevator middleware to enabled db switching based on subdomain
+
+# 0.4.0
+  * June 14, 2011
+  
+  - Added `configure` method on Apartment instead of using yml file, allows for dynamic setting of db names to migrate for rake task
+  - Added `seed_after_create` config option to import seed data to new db on create
+  
+# 0.3.0
+  * June 10, 2011
+  
+  - Added full support for database migration
+  - Added in method to establish new connection for excluded models on startup rather than on each switch
+    
+# 0.2.0
+  * June 6, 2011 *
+  
+  - Refactor to use more rails/active_support functionality
+  - Refactor config to lazily load apartment.yml if exists
+  - Remove OStruct and just use hashes for fetching methods
+  - Added schema load on create instead of migrating from scratch
+
+# 0.1.3
+  * March 30, 2011 *
+
+  - Original pass from Ryan
+

data/{README.markdown → README.md}

@@ -51,7 +51,7 @@ would not allow a full new database to be created.
 
 To switch databases using Apartment, use the following command:
 
-     Apartment::Database.switch('database_name')
+    Apartment::Database.switch('database_name')
 
 When switch is called, all requests coming to ActiveRecord will be routed to the database 
 you specify (with the exception of excluded models, see below). To return to the 'root' 
@@ -59,32 +59,50 @@ database, call switch with no arguments.
 
 ### Switching Databases per request
 
-You can have Apartment route to the appropriate database per request by adding a warden task
-in application.rb. For instance, if you want to route to a particular database depending on
-user, and you have a database attribute on your user model, you could do the following:
-
-     Warden::Manager.on_request do |proxy|
-        if session[:user_id]
-          u = User.find(session[:user_id])
-          Apartment::Database.switch(u.database)
-        end
-     end
-
+You can have Apartment route to the appropriate database by adding some Rack middleware.
+Apartment can support many different "Elevators" that can take care of this routing to your data.
+In house, we use the subdomain elevator, which analyzes the subdomain of the request and switches
+to a database schema of the same name. It can be used like so:
+
+    # application.rb
+    module My Application
+      class Application < Rails::Application
+      
+        config.middleware.use 'Apartment::Elevators::Subdomain'
+      end
+    end
+    
 ### Excluding models
 
-If you have some models that should always access the 'root' database, you can specify this in 
-a configuration file. Apartment will look for a config file called 'apartment.yml' in the /config
-directory of your Rails application. To exclude certain models, do the following:
+If you have some models that should always access the 'root' database, you can specify this by configuring
+Apartment using `Apartment.configure`.  This will yield a config object for you.  You can set excluded models like so:
 
-    excluded_models: [User, Company] 
+    Apartment.configure do |config|
+      config.excluded_models = [User, Company]        # these models will not be multi-tenanted, but remain in the global (public) namespace
+    end
 
 ### Managing Migrations
 
-Currently, you will need to migrate each database individually. I'll be working on code to 
-migrate all known databases soon. You can migrate any database up to the current version by
-calling:
-
-     Apartment::Database.migrate('database_name')
+In order to migrate all of your databases (or posgresql schemas) you need to provide a list
+of dbs to Apartment.  You can make this dynamic by providing a Proc object to be called on migrations.
+This object should yield an array of string representing each database name.  Example:
+
+    # Dynamically get database names to migrate
+    Apartment.configure do |config|
+      config.database_names = lambda{ Company.all.collect(&:database_name) }
+    end
+    
+    # Use a static list of database names for migrate
+    Apartment.configure do |config|
+      config.database_names = ['db1', 'db2']
+    end
+      
+You can then migration your databases using the rake task:
+    
+    rake apartment:migrate
+    
+This basically invokes `Apartment::Database.migrate(#{db_name})` for each database name supplied
+from `Apartment.database_names`
 
 ## TODO
 

data/Rakefile

@@ -1,54 +1,51 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
+require 'bundler' rescue 'You must `gem install bundler` and `bundle install` to run rake tasks'
+Bundler.setup
+Bundler::GemHelper.install_tasks
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "apartment"
-  gem.homepage = "http://github.com/ryanbrunner/apartment"
-  gem.license = "MIT"
-  gem.summary = %Q{A Ruby gem for managing multitenancy in Rails applications}
-  gem.description = %Q{Apartment allows Rails applications to deal with 
-		       multitenancy.}
-  gem.email = "ryan@ryanbrunner.com"
-  gem.authors = ["Ryan Brunner"]
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
-  #  gem.add_development_dependency 'rspec', '> 1.2.3'
-end
-Jeweler::RubygemsDotOrgTasks.new
+require "rspec"
+require "rspec/core/rake_task"
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
 end
 
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
+namespace :spec do
+  
+  [:tasks, :unit, :integration].each do |type|
+    RSpec::Core::RakeTask.new(type) do |spec|
+      spec.pattern = "spec/#{type}/**/*_spec.rb"
+    end
+  end
+  
+  namespace :unit do
+    RSpec::Core::RakeTask.new(:adapters) do |spec|
+      spec.pattern = "spec/unit/adapters/**/*_spec.rb"
+    end
+  end
 
-task :default => :test
+end
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+task :default => :spec
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "apartment #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+namespace :postgres do
+  require 'active_record'
+  require "#{File.join(File.dirname(__FILE__), 'spec', 'support', 'config')}"
+  
+  desc 'Build the PostgreSQL test databases'
+  task :build_db do
+    %x{ createdb -E UTF8 #{config['database']} } rescue "test db already exists"
+    ActiveRecord::Base.establish_connection config
+    load 'spec/dummy/db/schema.rb'
+  end
+  
+  desc "drop the PostgreSQL test database"
+  task :drop_db do
+    puts "dropping database #{config['database']}"
+    %x{ dropdb #{config['database']} }
+  end
+  
+  def config
+    Apartment::Test.config['connections']['postgresql']
+  end
+  
+end

data/apartment.gemspec

@@ -1,68 +1,29 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$: << File.expand_path("../lib", __FILE__)
+require "apartment/version"
 
 Gem::Specification.new do |s|
   s.name = %q{apartment}
-  s.version = "0.1.3"
+  s.version = Apartment::VERSION
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Ryan Brunner"]
-  s.date = %q{2011-03-04}
-  s.description = %q{Apartment allows Rails applications to deal with 
-		       multitenancy.}
-  s.email = %q{ryan@ryanbrunner.com}
-  s.extra_rdoc_files = [
-    "README.markdown"
-  ]
-  s.files = [
-    ".bundle/config",
-    ".project",
-    "Gemfile",
-    "Gemfile.lock",
-    "README.markdown",
-    "Rakefile",
-    "VERSION",
-    "apartment.gemspec",
-    "lib/apartment.rb",
-    "lib/apartment/associations/multi_tenant_association.rb",
-    "lib/apartment/config.rb",
-    "lib/apartment/config/default_config.yml",
-    "lib/apartment/database.rb",
-    "lib/apartment/railtie.rb",
-    "lib/tasks/multi_tenant_migrate.rake",
-    "pkg/apartment-0.1.3.gem"
-  ]
+  s.authors = ["Ryan Brunner", "Brad Robertson"]
+  s.date = %q{2011-04-18}
+  s.summary = %q{A Ruby gem for managing database multitenancy in Rails applications}
+  s.description = %q{Apartment allows Rails applications to deal with database multitenancy}
+  s.email = %w{ryan@ryanbrunner.com bradleyrobertson@gmail.com}
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  
   s.homepage = %q{http://github.com/ryanbrunner/apartment}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{A Ruby gem for managing multitenancy in Rails applications}
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.5"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-    else
-      s.add_dependency(%q<activesupport>, [">= 3.0.5"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<activesupport>, [">= 3.0.5"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-  end
+  
+  s.add_dependency 'rails', '~> 3.0.8'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'rspec', '~> 2.6.0'
+  s.add_development_dependency 'rspec-rails', '~> 2.6.1'
+  s.add_development_dependency 'capybara', '1.0.0'
+  s.add_development_dependency 'pg', '~> 0.11.0'
+  s.add_development_dependency "silent-postgres", "~> 0.0.8"
 end
-

data/lib/apartment.rb

@@ -1,11 +1,62 @@
+require 'apartment/railtie'
 
 module Apartment
-	require 'apartment/railtie'
-	require 'apartment/config'
-	require 'apartment/database'
-
-  def self.included(base)
-    base.extend Apartment::ClassMethods
+  
+  class << self
+    attr_accessor :use_postgres_schemas, :seed_after_create
+    attr_writer :database_names, :excluded_models
+    
+    # configure apartment with available options
+    def configure
+      yield self if block_given?
+      Database.init
+    end
+    
+    # Be careful not to use `return` here so both Proc and lambda can be used without breaking
+    def database_names
+      if @database_names.respond_to?(:call)
+        @database_names.call
+      else
+        @database_names
+      end
+    end
+    
+    # Default to none
+    def excluded_models
+      @excluded_models || []
+    end
+    
+  end
+  
+  autoload :Database, 'apartment/database'
+  autoload :Migrator, 'apartment/migrator'
+  
+  module Adapters
+    autoload :AbstractAdapter, 'apartment/adapters/abstract_adapter'
+    # Specific adapters will be loaded dynamically based on adapter in config
+  end
+  
+  module Elevators
+    autoload :Subdomain, 'apartment/elevators/subdomain'
   end
+  
+  # Exceptions
+  class ApartmentError < StandardError; end
+  
+  # Raised when apartment cannot find the adapter specified in <tt>config/database.yml</tt>
+  class AdapterNotFound < ApartmentError; end
+  
+  # Raised when database cannot find the specified schema
+  class SchemaNotFound < ApartmentError; end
+  
+  # Raised when trying to create a schema that already exists
+  class SchemaExists < ApartmentError; end
+  
 end
 
+Apartment.configure do |config|
+  config.excluded_models = []
+  config.use_postgres_schemas = true
+  config.database_names = []
+  config.seed_after_create = false
+end

data/lib/apartment/adapters/abstract_adapter.rb

@@ -0,0 +1,106 @@
+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
+      
+      #   Connect to db or schema, do stuff, reset
+      # 
+      #   @param {String} database Database or schema to connect to
+      def connect_and_reset(database)
+		    connect_to_new(database)
+		    yield if block_given?
+		  ensure
+  		  reset
+	    end
+      
+      #   Create new postgres schema
+      # 
+      #   @param {String} database Database name
+  		def create(database)
+        # TODO create_database unless using_schemas?
+
+  			connect_and_reset(database) do
+    			import_database_schema
+
+    			# Manually init schema migrations table (apparently there were issues with Postgres when this isn't done)
+    			ActiveRecord::Base.connection.initialize_schema_migrations_table
+    			
+          # Seed data if appropriate
+          seed_data if Apartment.seed_after_create
+  			end
+  		end
+    
+      #   Reset the base connection
+      def reset
+        ActiveRecord::Base.establish_connection @config
+      end
+      
+      # Switch to new connection (or schema if appopriate)
+      def switch(database = nil)
+        # Just connect to default db and return
+  			return reset if database.nil?
+
+        connect_to_new(database)
+  		end
+      
+      protected
+      
+        def create_schema
+          # noop
+        end
+      
+        def connect_to_new(database)
+          ActiveRecord::Base.establish_connection multi_tenantify(database)
+			  end
+        
+  	    def import_database_schema
+  	      load_or_abort("#{Rails.root}/db/schema.rb")
+  	    end
+  	    
+  	    def seed_data
+  	      load_or_abort("#{Rails.root}/db/seeds.rb")
+	      end
+  	    
+  	    # Return a new config that is multi-tenanted
+        def multi_tenantify(database)
+    			@config.clone.tap do |config|
+    			  config['database'].gsub!(Rails.env.to_s, "#{database}_#{Rails.env}")
+  			  end
+    		end
+        
+        # Remove all non-alphanumeric characters
+  	    def sanitize(database)
+  	      database.gsub(/[\W]/,'')
+        end
+        
+        # Whether or not to use postgresql schemas
+        def using_schemas?
+          false
+        end
+        
+        def load_or_abort(file)
+          if File.exists?(file)
+            load(file)
+          else
+            abort %{#{file} doesn't exist yet}
+          end
+        end
+      
+    end
+      
+      
+  
+  end
+end