dr-apartment 0.14.1

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 --create ruby-1.9.2-p180@apartment

data/Gemfile

@@ -0,0 +1,22 @@
+source "http://rubygems.org"
+
+gem 'rails', '~> 3.1.2'
+gem 'rake', '~> 0.8.7'
+gem 'rspec', '~> 2.6.0'
+gem 'rspec-rails', '~> 2.6.1'
+gem 'capybara', '1.0.0'
+gem 'delayed_job', '~> 2.1.4'
+
+platforms :jruby do
+  gem 'activerecord-jdbcpostgresql-adapter', :git => 'git://github.com/dryade/activerecord-jdbc-adapter.git'  
+  gem 'activerecord-jdbcsqlite3-adapter'
+  gem 'activerecord-jdbcmysql-adapter'
+  gem 'jruby-openssl'
+end
+
+platforms :ruby do
+  gem 'pg', '~> 0.11.0' 
+  gem "silent-postgres", "~> 0.1.1"
+  gem 'mysql2', '~> 0.3.7'
+  gem 'sqlite3'
+end

data/HISTORY.md

@@ -0,0 +1,133 @@
+# 0.14.1
+  * Dec 13, 2011
+
+  - Fix ActionDispatch::Callbacks deprecation warnings
+
+# 0.14.0
+  * Dec 13, 2011
+
+  - Rails 3.1 Support
+
+# 0.13.1
+  * Nov 8, 2011
+
+  - Reset prepared statement cache for rails 3.1.1 before switching dbs when using postgresql schemas
+    - Only necessary until the next release which will be more schema aware
+
+# 0.13.0
+  * Oct 25, 2011
+
+  - `process` will now rescue with reset if the previous schema/db is no longer available
+  - `create` now takes an optional block which allows you to process within the newly created db
+  - Fixed Rails version >= 3.0.10 and < 3.1 because there have been significant testing problems with 3.1, next version will hopefully fix this
+
+# 0.12.0
+  * Oct 4, 2011
+
+  - Added a `drop` method for removing databases/schemas
+  - Refactored abstract adapter to further remove duplication in concrete implementations
+  - Excluded models now take string references so they are properly reloaded in development
+  - Better silencing of `schema.rb` loading using `verbose` flag
+
+# 0.11.1
+  * Sep 22, 2011
+
+  - Better use of Railties for initializing apartment
+  - The following changes were necessary as I haven't figured out how to properly hook into Rails reloading
+    - Added reloader middleware in development to init Apartment on each request
+    - Override `reload!` in console to also init Apartment
+
+# 0.11.0
+  * Sep 20, 2011
+
+  - Excluded models no longer use a different connection when using postgresql schemas.  Instead their table_name is prefixed with `public.`
+
+# 0.10.3
+  * Sep 20, 2011
+
+  - Fix improper raising of exceptions on create and reset
+
+# 0.10.2
+  * Sep 15, 2011
+
+  - Remove all the annoying logging for loading db schema and seeding on create
+
+# 0.10.1
+  * Aug 11, 2011
+
+  - Fixed bug in DJ where new objects (that hadn't been pulled from the db) didn't have the proper database assigned
+
+# 0.10.0
+  * July 29, 2011
+
+  - Added better support for Delayed Job
+  - New config option that enables Delayed Job wrappers
+  - Note that DJ support uses a work-around in order to get queues stored in the public schema, not sure why it doesn't work out of the box, will look into it, until then, see documentation on queue'ng jobs
+
+# 0.9.2
+  * July 4, 2011
+
+  - Migrations now run associated rails migration fully, fixes schema.rb not being reloaded after migrations
+
+# 0.9.1
+  * June 24, 2011
+
+  - Hooks now take the payload object as an argument to fetch the proper db for DJ hooks
+
+# 0.9.0
+  * June 23, 2011
+
+  - Added module to provide delayed job hooks
+
+# 0.8.0
+  * June 23, 2011
+
+  - Added #current_database which will return the current database (or schema) name
+
+# 0.7.0
+  * June 22, 2011
+
+  - Added apartment:seed rake task for seeding all dbs
+
+# 0.6.0
+  * June 21, 2011
+
+  - Added #process to connect to new db, perform operations, then ensure a reset
+
+# 0.5.1
+  * June 21, 2011
+
+  - Fixed db migrate up/down/rollback
+  - added db:redo
+
+# 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.md

@@ -0,0 +1,152 @@
+# Apartment
+*Multitenancy for Rails 3*
+
+Apartment provides tools to help you deal with multiple databases in your Rails
+application. If you need to have certain data sequestered based on account or company,
+but still allow some data to exist in a common database, Apartment can help.
+
+
+## Installation
+
+### Rails 3
+
+Add the following to your Gemfile:
+
+    gem 'apartment'
+
+That's all you need to set up the Apartment libraries. If you want to switch databases 
+on a per-user basis, look under "Usage - Switching databases per request", below.
+
+> NOTE: If using [postgresl schemas](http://www.postgresql.org/docs/9.0/static/ddl-schemas.html) you must use:
+>
+> * for Rails 3.0.x: _Rails ~> 3.0.10_, it contains a [patch](https://github.com/rails/rails/pull/1607) that has better postgresql schema support
+> * for Rails 3.1.x: _Rails ~> 3.1.2_, it contains a [patch](https://github.com/rails/rails/pull/3232) that makes prepared statements work with multiple schemas
+
+## Usage
+
+### Creating new Databases
+
+Before you can switch to a new apartment database, you will need to create it. Whenever
+you need to create a new database, you can run the following command:
+
+    Apartment::Database.create('database_name')
+
+Apartment will create a new database in the following format: "_environment_\_database_name". 
+In the case of a sqlite database, this will be created in your 'db/migrate' folder. With
+other databases, the database will be created as a new DB within the system.
+
+When you create a new database, all migrations will be run against that database, so it will be 
+up to date when create returns.
+
+#### Notes on PostgreSQL
+
+PostgreSQL works slightly differently than other databases when creating a new DB. If you
+are using PostgreSQL, Apartment by default will set up a new **schema** and migrate into there. This
+provides better performance, and allows Apartment to work on systems like Heroku, which
+would not allow a full new database to be created.
+
+One can optionally use the full database creation instead if they want, though this is not recommended
+
+### Switching Databases
+
+To switch databases using Apartment, use the following command:
+
+    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' 
+database, call switch with no arguments.
+
+### Switching Databases per request
+
+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
+    
+## Config
+
+The following config options should be set up in a Rails initializer such as:
+
+    config/initializers/apartment.rb
+    
+To set config options, add this to your initializer:
+
+    Apartment.configure do |config|
+      # set your options (described below) here
+    end
+    
+### Excluding models
+
+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:
+    
+    config.excluded_models = ["User", "Company"]        # these models will not be multi-tenanted, but remain in the global (public) namespace
+
+Note that a string representation of the model name is now the standard so that models are properly constantized when reloaded in development
+    
+### Handling Environments
+
+By default, when not using postgresql schemas, Apartment will prepend the environment to the database name
+to ensure there is no conflict between your environments.  This is mainly for the benefit of your development
+and test environments.  If you wish to turn this option off in production, you could do something like:
+
+    config.prepend_environment = !Rails.env.production?
+
+### Managing Migrations
+
+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
+    config.database_names = lambda{ Customer.select(:database_name).map(&:database_name) }
+    
+    # Use a static list of database names for migrate
+    config.database_names = ['db1', 'db2']
+      
+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`
+
+### Delayed::Job
+
+In order to make ActiveRecord models play nice with DJ and Apartment, include `Apartment::Delayed::Requirements` in any model that is being serialized by DJ.  Also ensure that the `database` attribute (provided by Apartment::Delayed::Requirements) is set on this model *before* it is serialized, to ensure that when it is fetched again, it is done so in the proper Apartment db context.  For example:
+
+    class SomeModel < ActiveRecord::Base
+      include Apartment::Delayed::Requirements
+    end
+
+    class SomeDJ
+  
+      def initialize(model)
+        @model = model
+        @model.database = Apartment::Database.current_database
+      end
+  
+      def perform
+        # do some stuff
+      end
+    end
+
+## Development
+
+* The Local setup for development assumes that a root user with no password exists for both mysql and postgresl
+* Rake tasks (see the Rakefile) will help you setup your dbs necessary to run tests
+* Please issue pull requests to the `development` branch.  All development happens here, master is used for releases
+* Ensure that your code is accompanied with tests.  No code will be merged without tests
+
+## TODO
+
+* Shared examples for testing to ensure consistency across all adapters

data/Rakefile

@@ -0,0 +1,79 @@
+require 'bundler' rescue 'You must `gem install bundler` and `bundle install` to run rake tasks'
+Bundler.setup
+Bundler::GemHelper.install_tasks
+
+require "rspec"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec => "db:test:prepare") do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+namespace :spec do
+  
+  [:tasks, :unit, :adapters, :integration].each do |type|
+    RSpec::Core::RakeTask.new(type => :spec) do |spec|
+      spec.pattern = "spec/#{type}/**/*_spec.rb"
+    end
+  end
+  
+end
+
+task :default => :spec
+
+namespace :db do
+  namespace :test do
+    task :prepare => %w{postgres:drop_db postgres:build_db mysql:drop_db mysql:build_db}
+  end
+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 #{pg_config['database']} } rescue "test db already exists"
+    ActiveRecord::Base.establish_connection pg_config
+    ActiveRecord::Migrator.migrate('spec/dummy/db/migrate')
+  end
+  
+  desc "drop the PostgreSQL test database"
+  task :drop_db do
+    puts "dropping database #{pg_config['database']}"
+    %x{ dropdb #{pg_config['database']} }
+  end
+    
+end
+
+namespace :mysql do
+  require 'active_record'
+  require "#{File.join(File.dirname(__FILE__), 'spec', 'support', 'config')}"
+  
+  desc 'Build the MySQL test databases'
+  task :build_db do
+    %x{ mysqladmin -u root create #{my_config['database']} } rescue "test db already exists"
+    ActiveRecord::Base.establish_connection my_config
+    ActiveRecord::Migrator.migrate('spec/dummy/db/migrate')
+  end
+  
+  desc "drop the MySQL test database"
+  task :drop_db do
+    puts "dropping database #{my_config['database']}"
+    %x{ mysqladmin -u root drop #{my_config['database']} --force}
+  end
+    
+end
+
+# TODO clean this up
+def config
+  Apartment::Test.config['connections']
+end
+
+def pg_config
+  config['postgresql']
+end
+
+def my_config
+  config['mysql']
+end

data/apartment.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$: << File.expand_path("../lib", __FILE__)
+require "apartment/version"
+
+Gem::Specification.new do |s|
+  s.name = %q{dr-apartment}
+  s.version = Apartment::VERSION
+
+  s.authors = ["Ryan Brunner", "Brad Robertson"]
+  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/bradrobertson/apartment}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  
+  # s.add_dependency 'rails', '~> 3.1.2'
+  # s.add_development_dependency 'rake', '~> 0.8.7'
+  # 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 'mysql2', '~> 0.3.7'
+  # s.add_development_dependency "silent-postgres", "~> 0.1.1"
+  # s.add_development_dependency 'delayed_job', '~> 2.1.4'
+  # s.add_development_dependency 'activerecord-jdbcpostgresql-adapter', '~> 1.2.1'
+end

data/lib/apartment.rb

@@ -0,0 +1,69 @@
+require 'apartment/railtie' if defined?(Rails)
+
+module Apartment
+  
+  class << self
+    attr_accessor :use_postgres_schemas, :seed_after_create, :prepend_environment
+    attr_writer :database_names, :excluded_models
+    
+    # configure apartment with available options
+    def configure
+      yield self if block_given?
+    end
+    
+    # Be careful not to use `return` here so both Proc and lambda can be used without breaking
+    def database_names
+      @database_names.respond_to?(:call) ? @database_names.call : @database_names
+    end
+    
+    # Default to none
+    def excluded_models
+      @excluded_models || []
+    end
+    
+  end
+  
+  autoload :Database, 'apartment/database'
+  autoload :Migrator, 'apartment/migrator'
+  autoload :Reloader, 'apartment/reloader'
+  
+  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
+  
+  module Delayed
+    
+    autoload :Requirements, 'apartment/delayed_job/requirements'
+    
+    module Job
+      autoload :Hooks, 'apartment/delayed_job/hooks'
+    end
+  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 database
+  class DatabaseNotFound < ApartmentError; end
+  
+  # Raised when trying to create a database that already exists
+  class DatabaseExists < 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
+  
+  # Raised when an ActiveRecord object does not have the required database field on it
+  class DJSerializationError < ApartmentError; end
+  
+end