apartment 0.24.3 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 668ec9701ea4dbebdbae90b20283859a923e2e97
-  data.tar.gz: 8f780f38eb0637204825f184a281118ea538cd25
+  metadata.gz: 7511a4af17aae3dc546bb1c76342c5b8301829c6
+  data.tar.gz: 819a8d11d7cf74fea4d67d9d7c364c92f6bf8aeb
 SHA512:
-  metadata.gz: 1688f67d237510833030cde62b3e31a55b4c20dbcff96d74dcab1df3db19740722c40968beeabb392d141b77736d7ea96e76d5a0c9552ed5e644061dc3346483
-  data.tar.gz: 31943cd1bc2650b5a7255ecfcceacdeb883878483476288ebc3e8318e3e911f9eece112e304634a7b3bcb98a779a42206308172d2493ef6c9b5e724615166cdd
+  metadata.gz: 67dbe1ad054395e0466e785b9c3d81d17b7ff97147a2e04f76b1af951a806045bd774e6a9cf4c372860389d9b63919cb22d742c6165b1d25bbe60505a1b41d9d
+  data.tar.gz: 4fd680bc07c8e12f5a88fc143a1a26c09c289b6ae9c3a96296b5d3b48137cfd680132a6aa2b1ac28e3316d9350dae1fe43c9c718b49088cdf1ff18366dfafee6

data/.travis.yml

@@ -5,8 +5,9 @@ rvm:
   - 2.1.0
   - jruby-19mode
 gemfile:
-  - gemfiles/rails3.2.gemfile
-  - gemfiles/rails4.0.gemfile
+  - gemfiles/rails_3_2.gemfile
+  - gemfiles/rails_4_0.gemfile
+  - gemfiles/rails_4_1.gemfile
 bundler_args: --without local --verbose
 before_install:
   - gem install bundler -v '> 1.5.0'

data/Appraisals

@@ -1,7 +1,11 @@
-appraise "rails3.2" do
+appraise "rails-3-2" do
   gem "rails", "~> 3.2"
 end
 
-appraise "rails4.0" do
+appraise "rails-4-0" do
   gem "rails", "~> 4.0"
-end
+end
+
+appraise "rails-4-1" do
+  gem "rails", "~> 4.1"
+end

data/HISTORY.md

@@ -1,3 +1,11 @@
+# 0.25.0
+  * July 3, 2014
+
+  - [BREAKING CHANGE] - `Apartment::Database` is not deprecated in favour of
+    `Apartment::Tenant`
+  - ActiveRecord (and Rails) 4.1 now supported
+  - A new sql based adapter that dumps the schema using sql
+
 # 0.24.3
   * March 5, 2014
 

data/README.md

@@ -43,7 +43,7 @@ Before you can switch to a new apartment tenant, you will need to create it. Whe
 you need to create a new tenant, you can run the following command:
 
 ```ruby
-Apartment::Database.create('tenant_name')
+Apartment::Tenant.create('tenant_name')
 ```
 
 If you're using the [prepend environment](https://github.com/influitive/apartment#handling-environments) config option or you AREN'T using Postgresql Schemas, this will create a tenant in the following format: "#{environment}\_tenant_name".
@@ -67,7 +67,7 @@ One can optionally use the full database creation instead if they want, though t
 To switch tenants using Apartment, use the following command:
 
 ```ruby
-Apartment::Database.switch('tenant_name')
+Apartment::Tenant.switch('tenant_name')
 ```
 
 When switch is called, all requests coming to ActiveRecord will be routed to the tenant
@@ -179,58 +179,101 @@ Rails will always access the 'public' tenant when accessing these models,  but n
 
 ### Postgresql Schemas
 
-**Providing a Different default_schema**
+## Providing a Different default_schema
 By default, ActiveRecord will use `"$user", public` as the default `schema_search_path`. This can be modified if you wish to use a different default schema be setting:
 
 ```ruby
 config.default_schema = "some_other_schema"
 ```
 
-With that set, all excluded models will use this schema as the table name prefix instead of `public` and `reset` on `Apartment::Database` will return to this schema also
+With that set, all excluded models will use this schema as the table name prefix instead of `public` and `reset` on `Apartment::Tenant` will return to this schema also
 
-**Persistent Schemas**
+## Persistent Schemas
 Apartment will normally just switch the `schema_search_path` whole hog to the one passed in.  This can lead to problems if you want other schemas to always be searched as well.  Enter `persistent_schemas`.  You can configure a list of other schemas that will always remain in the search path, while the default gets swapped out:
 
 ```ruby
 config.persistent_schemas = ['some', 'other', 'schemas']
 ```
 
-This has numerous useful applications.  [Hstore](http://www.postgresql.org/docs/9.1/static/hstore.html), for instance, is a popular storage engine for Postgresql.  In order to use Hstore, you have to install it to a specific schema and have that always in the `schema_search_path`.  This could be achieved like so:
+### Installing Extensions into Persistent Schemas
+Persistent Schemas have numerous useful applications.  [Hstore](http://www.postgresql.org/docs/9.1/static/hstore.html), for instance, is a popular storage engine for Postgresql.  In order to use extensions such as Hstore, you have to install it to a specific schema and have that always in the `schema_search_path`.  
+
+When using extensions, keep in mind:
+* Extensions can only be installed into one schema per database, so we will want to install it into a schema that is always available in the `schema_search_path`
+* The schema and extension need to be created in the database *before* they are referenced in migrations, database.yml or apartment. 
+* There does not seem to be a way to create the schema and extension using standard rails migrations. 
+* Rails db:test:prepare deletes and recreates the database, so it needs to be easy for the extension schema to be recreated here.
+
+#### 1. Ensure the extensions schema is created when the database is created
 
 ```ruby
-# NOTE do not do this in a migration, must be done
-# manually before you configure apartment with hstore
-# In a rake task, or on the console...
-ActiveRecord::Base.connection.execute("CREATE SCHEMA hstore; CREATE EXTENSION HSTORE SCHEMA hstore")
+# lib/tasks/db_enhancements.rake
+
+####### Important information ####################
+# This file is used to setup a shared extensions #
+# within a dedicated schema. This gives us the   #
+# advantage of only needing to enable extensions #
+# in one place.                                  #
+#                                                #
+# This task should be run AFTER db:create but    #
+# BEFORE db:migrate.                             #
+##################################################
+
+
+namespace :db do
+  desc 'Also create shared_extensions Schema'
+  task :extensions => :environment  do
+    # Create Schema
+    ActiveRecord::Base.connection.execute 'CREATE SCHEMA IF NOT EXISTS shared_extensions;'
+    # Enable Hstore
+    ActiveRecord::Base.connection.execute 'CREATE EXTENSION IF NOT EXISTS HSTORE SCHEMA shared_extensions;'
+    # Enable UUID-OSSP
+    ActiveRecord::Base.connection.execute 'CREATE EXTENSION IF NOT EXISTS "uuid-ossp" SCHEMA shared_extensions;'
+  end
+end
 
-# configure Apartment to maintain the `hstore` schema in the `schema_search_path`
-config.persistent_schemas = ['hstore']
-```
+Rake::Task["db:create"].enhance do
+  Rake::Task["db:extensions"].invoke
+end
 
-There are a few caveats to be aware of when using `hstore`.  First off, the hstore schema and extension creation need to be done manually *before* you reference it in any way in your migrations, database.yml or apartment.  This is an unfortunate manual step, but I haven't found a way around it.  You can achieve this from the command line using something like:
+Rake::Task["db:test:purge"].enhance do
+  Rake::Task["db:extensions"].invoke
+end
+```
 
-    rails r 'ActiveRecord::Base.connection.execute("CREATE SCHEMA hstore; CREATE EXTENSION HSTORE SCHEMA hstore")'
+#### 2. Ensure the schema is in Rails' default connection
 
-Next, your `database.yml` file must mimic what you've set for your default and persistent schemas in Apartment.  When you run migrataions with Rails, it won't know about the hstore schema because Apartment isn't injected into the default connection, it's done on a per-request basis, therefore Rails doesn't know about `hstore` during migrations.  To do so, add the following to your `database.yml` for all environments
+Next, your `database.yml` file must mimic what you've set for your default and persistent schemas in Apartment.  When you run migrataions with Rails, it won't know about the extensions schema because Apartment isn't injected into the default connection, it's done on a per-request basis, therefore Rails doesn't know about `hstore` or `uuid-ossp` during migrations.  To do so, add the following to your `database.yml` for all environments
 
 ```yaml
 # database.yml
 ...
 adapter: postgresql
-schema_search_path: "public,hstore"
+schema_search_path: "public,shared_extensions"
 ...
 ```
 
-This would be for a config with `default_schema` set to `public` and `persistent_schemas` set to `['hstore']`
+This would be for a config with `default_schema` set to `public` and `persistent_schemas` set to `['shared_extensions']`. **Note**: This only works on Heroku with [Rails 4.1+](https://devcenter.heroku.com/changelog-items/427). For older Rails versions Heroku regenerates a completely different `database.yml` for each deploy and your predefined `schema_search_path` will be deleted. ActiveRecord's `schema_search_path` will be the default `\"$user\",public`.
+
+#### 3. Ensure the schema is in the apartment config
+```ruby
+# config/initializers/apartment.rb
+...
+config.persistent_schemas = ['shared_extensions']
+...
+```
 
+#### Alternative: Creating schema by default
 Another way that we've successfully configured hstore for our applications is to add it into the
 postgresql template1 database so that every tenant that gets created has it by default.
 
+One caveat with this approach is that it can interfere with other projects in development using the same extensions and template, but not using apartment with this approach.
+
 You can do so using a command like so
 
 ```bash
-psql -U postgres -d template1 -c "CREATE SCHEMA hstore AUTHORIZATION some_username;"
-psql -U postgres -d template1 -c "CREATE EXTENSION IF NOT EXISTS hstore SCHEMA hstore;"
+psql -U postgres -d template1 -c "CREATE SCHEMA shared_extensions AUTHORIZATION some_username;"
+psql -U postgres -d template1 -c "CREATE EXTENSION IF NOT EXISTS hstore SCHEMA shared_extensions;"
 ```
 
 The *ideal* setup would actually be to install `hstore` into the `public` schema and leave the public
@@ -238,6 +281,18 @@ schema in the `search_path` at all times. We won't be able to do this though unt
 also contain the tenanted tables, which is an open issue with no real milestone to be completed.
 Happy to accept PR's on the matter.
 
+#### Alternative: Creating new schemas by using raw SQL dumps
+Apartment can be forced to use raw SQL dumps insted of `schema.rb` for creating new schemas. Use this when you are using some extra features in postgres that can't be respresented in `schema.rb`, like materialized views etc.
+
+This only applies while using postgres adapter and `config.use_schemas` is set to `true`.
+(Note: this option doesn't use `db/structure.sql`, it creates SQL dump by executing `pg_dump`)
+
+Enable this option with:
+```ruby
+config.use_sql = true
+```
+
+
 ### Managing Migrations
 
 In order to migrate all of your tenants (or posgresql schemas) you need to provide a list
@@ -258,7 +313,7 @@ You can then migrate your tenants using the normal rake task:
 rake db:migrate
 ```
 
-This just invokes `Apartment::Database.migrate(#{tenant_name})` for each tenant name supplied
+This just invokes `Apartment::Tenant.migrate(#{tenant_name})` for each tenant name supplied
 from `Apartment.tenant_names`
 
 Note that you can disable the default migrating of all tenants with `db:migrate` by setting

data/TODO.md

@@ -19,9 +19,9 @@
 
     This should ensure that going forward nothing breaks, and we should *ideally* be able to randomize the test order
 
-2.  `Apartment::Database` is the wrong abstraction. When dealing with a multi-tenanted system, users shouldn't thing about 'Databases', they should
+2.  <del>`Apartment::Database` is the wrong abstraction. When dealing with a multi-tenanted system, users shouldn't thing about 'Databases', they should
     think about Tenants. I proprose that we deprecate the `Apartment::Database` constant in favour of `Apartment::Tenant` for a nicer abstraction. See
-    http://myronmars.to/n/dev-blog/2011/09/deprecating-constants-and-classes-in-ruby for ideas on how to achieve this.
+    http://myronmars.to/n/dev-blog/2011/09/deprecating-constants-and-classes-in-ruby for ideas on how to achieve this.</del>
 
 4.  Apartment::Database.process should be deprecated in favour of just passing a block to `switch`
 5.  Apartment::Database.switch should be renamed to switch! to indicate that using it on its own has side effects

data/apartment.gemspec

@@ -18,7 +18,23 @@ Gem::Specification.new do |s|
   s.homepage = %q{https://github.com/influitive/apartment}
   s.licenses = ["MIT"]
 
-  s.add_dependency 'activerecord',    '>= 3.1.2'   # must be >= 3.1.2 due to bug in prepared_statements
+  s.post_install_message = <<-MSG
+  ********************************
+
+  Apartment Deprecation Warning
+
+  `Apartment::Database` has been deprecated in favour of `Apartment::Tenant`.
+  Please update your application to use the new constant as it is a more
+  appropriate abstraction.
+
+  To further this, DatabaseNotFound, SchemaNotFound, DatabaseExists and
+  SchemaExists exceptions will all be removed, you should instead use
+  TenantNotFound and TenantExists to catch any exceptions.
+
+  ********************************
+  MSG
+
+  s.add_dependency 'activerecord',    '>= 3.1.2', '< 4.2'   # must be >= 3.1.2 due to bug in prepared_statements
   s.add_dependency 'rack',            '>= 1.3.6'
 
   s.add_development_dependency 'appraisal'

data/gemfiles/{rails3.2.gemfile → rails_3_2.gemfile}

@@ -4,4 +4,8 @@ source "http://rubygems.org"
 
 gem "rails", "~> 3.2"
 
-gemspec :path=>"../"
+group :local do
+  gem "pry"
+end
+
+gemspec :path => "../"

data/gemfiles/{rails4.0.gemfile → rails_4_0.gemfile}

@@ -4,4 +4,8 @@ source "http://rubygems.org"
 
 gem "rails", "~> 4.0"
 
-gemspec :path=>"../"
+group :local do
+  gem "pry"
+end
+
+gemspec :path => "../"

data/gemfiles/rails_4_1.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 4.1"
+
+group :local do
+  gem "pry"
+end
+
+gemspec :path => "../"

data/lib/apartment.rb

@@ -2,7 +2,7 @@ require 'apartment/railtie' if defined?(Rails)
 require 'active_support/core_ext/object/blank'
 require 'forwardable'
 require 'active_record'
-require 'apartment/database'
+require 'apartment/tenant'
 
 module Apartment
 
@@ -10,7 +10,7 @@ module Apartment
 
     extend Forwardable
 
-    ACCESSOR_METHODS  = [:use_schemas, :seed_after_create, :prepend_environment, :append_environment]
+    ACCESSOR_METHODS  = [:use_schemas, :use_sql, :seed_after_create, :prepend_environment, :append_environment]
     WRITER_METHODS    = [:tenant_names, :database_schema_file, :excluded_models, :default_schema, :persistent_schemas, :connection_class, :tld_length, :db_migrate_tenants]
 
     attr_accessor(*ACCESSOR_METHODS)

data/lib/apartment/adapters/abstract_adapter.rb

@@ -182,7 +182,7 @@ module Apartment
       #   Exceptions to rescue from on db operations
       #
       def rescuable_exceptions
-        [ActiveRecord::StatementInvalid] + [rescue_from].flatten
+        [ActiveRecord::ActiveRecordError] + [rescue_from].flatten
       end
 
       #   Extra exceptions to rescue from

data/lib/apartment/adapters/jdbc_mysql_adapter.rb

@@ -2,7 +2,7 @@ require "apartment/adapters/abstract_jdbc_adapter"
 
 module Apartment
 
-  module Database
+  module Tenant
     def self.jdbc_mysql_adapter(config)
       Adapters::JDBCMysqlAdapter.new config
     end
@@ -22,7 +22,7 @@ module Apartment
       def connect_to_new(database)
         super
       rescue DatabaseNotFound
-        Apartment::Database.reset
+        Apartment::Tenant.reset
         raise DatabaseNotFound, "Cannot find database #{environmentify(database)}"
       end
     end

data/lib/apartment/adapters/jdbc_postgresql_adapter.rb

@@ -1,7 +1,7 @@
 require 'apartment/adapters/postgresql_adapter'
 
 module Apartment
-  module Database
+  module Tenant
 
     def self.jdbc_postgresql_adapter(config)
       Apartment.use_schemas ?

data/lib/apartment/adapters/mysql2_adapter.rb

@@ -1,7 +1,7 @@
 require 'apartment/adapters/abstract_adapter'
 
 module Apartment
-  module Database
+  module Tenant
 
     def self.mysql2_adapter(config)
       Apartment.use_schemas ?
@@ -24,7 +24,7 @@ module Apartment
       def connect_to_new(tenant = nil)
         super
       rescue Mysql2::Error
-        Apartment::Database.reset
+        Apartment::Tenant.reset
         raise DatabaseNotFound, "Cannot find tenant #{environmentify(tenant)}"
       end
     end
@@ -61,16 +61,12 @@ module Apartment
         Apartment.connection.execute "use #{environmentify(tenant)}"
 
       rescue ActiveRecord::StatementInvalid
-        Apartment::Database.reset
+        Apartment::Tenant.reset
         raise DatabaseNotFound, "Cannot find tenant #{environmentify(tenant)}"
       end
 
       def process_excluded_model(model)
         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 default 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
 

data/lib/apartment/adapters/postgis_adapter.rb

@@ -3,12 +3,10 @@
 require "apartment/adapters/postgresql_adapter"
 
 module Apartment
-  module Database
+  module Tenant
 
     def self.postgis_adapter(config)
-      Apartment.use_schemas ?
-        Adapters::PostgresqlSchemaAdapter.new(config) :
-        Adapters::PostgresqlAdapter.new(config)
+      postgresql_adapter(config)
     end
   end
 end

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -1,12 +1,13 @@
 require 'apartment/adapters/abstract_adapter'
 
 module Apartment
-  module Database
+  module Tenant
 
     def self.postgresql_adapter(config)
-      Apartment.use_schemas ?
-        Adapters::PostgresqlSchemaAdapter.new(config) :
-        Adapters::PostgresqlAdapter.new(config)
+      adapter = Adapters::PostgresqlAdapter
+      adapter = Adapters::PostgresqlSchemaAdapter if Apartment.use_schemas
+      adapter = Adapters::PostgresqlSchemaFromSqlAdapter if Apartment.use_sql && Apartment.use_schemas
+      adapter.new(config)
     end
   end
 
@@ -55,10 +56,6 @@ module Apartment
       def process_excluded_models
         Apartment.excluded_models.each do |excluded_model|
           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 default 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
 
@@ -116,5 +113,93 @@ module Apartment
         [@current_tenant, Apartment.persistent_schemas].flatten
       end
     end
+
+    # Another Adapter for Postgresql when using schemas and SQL
+    class PostgresqlSchemaFromSqlAdapter < PostgresqlSchemaAdapter
+
+      PSQL_DUMP_BLACKLISTED_STATEMENTS= [
+        /SET search_path/i,   # overridden later
+        /SET lock_timeout/i   # new in postgresql 9.3
+      ]
+
+      def import_database_schema
+        clone_pg_schema
+        copy_schema_migrations
+      end
+
+    private
+
+      # Clone default schema into new schema named after current tenant
+      #
+      def clone_pg_schema
+        pg_schema_sql = patch_search_path(pg_dump_schema)
+        Apartment.connection.execute(pg_schema_sql)
+      end
+
+      # Copy data from schema_migrations into new schema
+      #
+      def copy_schema_migrations
+        pg_migrations_data = patch_search_path(pg_dump_schema_migrations_data)
+        Apartment.connection.execute(pg_migrations_data)
+      end
+
+      #   Dump postgres default schema
+      #
+      #   @return {String} raw SQL contaning only postgres schema dump
+      #
+      def pg_dump_schema
+        dbname = ActiveRecord::Base.connection_config[:database]
+        default_schema = Apartment.default_schema
+
+        # Skip excluded tables? :/
+        # excluded_tables =
+        #   collect_table_names(Apartment.excluded_models)
+        #   .map! {|t| "-T #{t}"}
+        #   .join(' ')
+
+        # `pg_dump -s -x -O -n #{default_schema} #{excluded_tables} #{dbname}`
+
+        `pg_dump -s -x -O -n #{default_schema} #{dbname}`
+      end
+
+      #   Dump data from schema_migrations table
+      #
+      #   @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 #{Apartment.default_schema} bithub_development`
+      end
+
+      #   Remove "SET search_path ..." line from SQL dump and prepend search_path set to current tenant
+      #
+      #   @return {String} patched raw SQL dump
+      #
+      def patch_search_path(sql)
+        search_path = "SET search_path = #{self.current_tenant}, #{Apartment.default_schema};"
+
+        sql
+          .split("\n")
+          .select {|line| check_input_against_regexps(line, PSQL_DUMP_BLACKLISTED_STATEMENTS).empty?}
+          .prepend(search_path)
+          .join("\n")
+      end
+
+      #   Checks if any of regexps matches against input
+      #
+      def check_input_against_regexps(input, regexps)
+        regexps.select {|c| input.match c}
+      end
+
+      #   Collect table names from AR Models
+      #
+      def collect_table_names(models)
+        models.map do |m|
+          m.constantize.table_name
+        end
+      end
+
+    end
+
+
   end
 end

data/lib/apartment/adapters/sqlite3_adapter.rb

@@ -1,7 +1,7 @@
 require 'apartment/adapters/abstract_adapter'
 
 module Apartment
-  module Database
+  module Tenant
     def self.sqlite3_adapter(config)
       Adapters::Sqlite3Adapter.new(config)
     end

data/lib/apartment/console.rb

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

data/lib/apartment/elevators/generic.rb

@@ -1,5 +1,5 @@
 require 'rack/request'
-require 'apartment/database'
+require 'apartment/tenant'
 
 module Apartment
   module Elevators
@@ -17,7 +17,7 @@ module Apartment
 
         database = @processor.call(request)
 
-        Apartment::Database.switch database if database
+        Apartment::Tenant.switch database if database
 
         @app.call(env)
       end

data/lib/apartment/migrator.rb

@@ -1,4 +1,4 @@
-require 'apartment/database'
+require 'apartment/tenant'
 
 module Apartment
   module Migrator

data/lib/apartment/railtie.rb

@@ -1,5 +1,5 @@
 require 'rails'
-require 'apartment/database'
+require 'apartment/tenant'
 require 'apartment/reloader'
 
 module Apartment
@@ -28,7 +28,7 @@ module Apartment
     #   See the middleware/console declarations below to help with this. Hope to fix that soon.
     #
     config.to_prepare do
-      Apartment::Database.init
+      Apartment::Tenant.init
     end
 
     #
@@ -50,7 +50,7 @@ module Apartment
         app.config.middleware.use "Apartment::Reloader"
       end
 
-      # Overrides reload! to also call Apartment::Database.init as well so that the reloaded classes have the proper table_names
+      # Overrides reload! to also call Apartment::Tenant.init as well so that the reloaded classes have the proper table_names
       console do
         require 'apartment/console'
       end

data/lib/apartment/{database.rb → tenant.rb}

@@ -3,7 +3,7 @@ require 'forwardable'
 module Apartment
   #   The main entry point to Apartment functions
   #
-  module Database
+  module Tenant
 
     extend self
     extend Forwardable
@@ -60,7 +60,14 @@ module Apartment
     #   Fetch the rails database configuration
     #
     def config
-      @config ||= Rails.configuration.database_configuration[Rails.env].symbolize_keys
+      @config ||= (ActiveRecord::Base.configurations[Rails.env] ||
+                    Rails.application.config.database_configuration[Rails.env]).symbolize_keys
     end
   end
-end
+
+  def self.const_missing(const_name)
+    super unless const_name == :Database
+    warn "`Apartment::Database` has been deprecated. Use `Apartment::Tenant` instead."
+    Tenant
+  end
+end

data/lib/apartment/version.rb

@@ -1,3 +1,3 @@
 module Apartment
-  VERSION = "0.24.3"
+  VERSION = "0.25.0"
 end

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

@@ -22,6 +22,9 @@ Apartment.configure do |config|
   # use postgres schemas?
   config.use_schemas = true
 
+  # use raw SQL dumps for creating postgres schemas? (only appies with use_schemas set to true)
+  #config.use_sql = true
+
   # configure persistent schemas (E.g. hstore )
   # config.persistent_schemas = %w{ hstore }
 

data/lib/tasks/apartment.rake

@@ -7,7 +7,7 @@ apartment_namespace = namespace :apartment do
     tenants.each do |tenant|
       begin
         puts("Creating #{tenant} tenant")
-        quietly { Apartment::Database.create(tenant) }
+        quietly { Apartment::Tenant.create(tenant) }
       rescue Apartment::TenantExists => e
         puts e.message
       end
@@ -35,8 +35,8 @@ apartment_namespace = namespace :apartment do
     tenants.each do |tenant|
       begin
         puts("Seeding #{tenant} tenant")
-        Apartment::Database.process(tenant) do
-          Apartment::Database.seed
+        Apartment::Tenant.process(tenant) do
+          Apartment::Tenant.seed
         end
       rescue Apartment::TenantNotFound => e
         puts e.message

data/spec/adapters/jdbc_mysql_adapter_spec.rb

@@ -5,7 +5,7 @@ if defined?(JRUBY_VERSION)
 
   describe Apartment::Adapters::JDBCMysqlAdapter, database: :mysql do
 
-    subject { Apartment::Database.jdbc_mysql_adapter config.symbolize_keys }
+    subject { Apartment::Tenant.jdbc_mysql_adapter config.symbolize_keys }
 
     def tenant_names
       ActiveRecord::Base.connection.execute("SELECT schema_name FROM information_schema.schemata").collect { |row| row['schema_name'] }

data/spec/adapters/jdbc_postgresql_adapter_spec.rb

@@ -5,7 +5,7 @@ if defined?(JRUBY_VERSION)
 
   describe Apartment::Adapters::JDBCPostgresqlAdapter, database: :postgresql do
 
-    subject { Apartment::Database.jdbc_postgresql_adapter config.symbolize_keys }
+    subject { Apartment::Tenant.jdbc_postgresql_adapter config.symbolize_keys }
 
     context "using schemas" do
 

data/spec/adapters/mysql2_adapter_spec.rb

@@ -4,7 +4,7 @@ require 'apartment/adapters/mysql2_adapter'
 describe Apartment::Adapters::Mysql2Adapter, database: :mysql do
   unless defined?(JRUBY_VERSION)
 
-    subject(:adapter){ Apartment::Database.mysql2_adapter config }
+    subject(:adapter){ Apartment::Tenant.mysql2_adapter config }
 
     def tenant_names
       ActiveRecord::Base.connection.execute("SELECT schema_name FROM information_schema.schemata").collect { |row| row[0] }
@@ -31,7 +31,7 @@ describe Apartment::Adapters::Mysql2Adapter, database: :mysql do
         end
 
         it "should process model exclusions" do
-          Apartment::Database.init
+          Apartment::Tenant.init
 
           Company.table_name.should == "#{default_tenant}.companies"
         end

data/spec/adapters/postgresql_adapter_spec.rb

@@ -4,9 +4,9 @@ require 'apartment/adapters/postgresql_adapter'
 describe Apartment::Adapters::PostgresqlAdapter, database: :postgresql do
   unless defined?(JRUBY_VERSION)
 
-    subject{ Apartment::Database.postgresql_adapter config }
+    subject{ Apartment::Tenant.postgresql_adapter config }
 
-    context "using schemas" do
+    context "using schemas with schema.rb" do
 
       before{ Apartment.use_schemas = true }
 
@@ -21,6 +21,21 @@ describe Apartment::Adapters::PostgresqlAdapter, database: :postgresql do
       it_should_behave_like "a schema based apartment adapter"
     end
 
+    context "using schemas with SQL dump" do
+
+      before{ Apartment.use_schemas = true; Apartment.use_sql = true }
+
+      # Not sure why, but somehow using let(:tenant_names) memoizes for the whole example group, not just each test
+      def tenant_names
+        ActiveRecord::Base.connection.execute("SELECT nspname FROM pg_namespace;").collect { |row| row['nspname'] }
+      end
+
+      let(:default_tenant) { subject.process { ActiveRecord::Base.connection.schema_search_path.gsub('"', '') } }
+
+      it_should_behave_like "a generic apartment adapter"
+      it_should_behave_like "a schema based apartment adapter"
+    end
+
     context "using connections" do
 
       before{ Apartment.use_schemas = false }

data/spec/adapters/sqlite3_adapter_spec.rb

@@ -4,7 +4,7 @@ require 'apartment/adapters/sqlite3_adapter'
 describe Apartment::Adapters::Sqlite3Adapter, database: :sqlite do
   unless defined?(JRUBY_VERSION)
 
-    subject{ Apartment::Database.sqlite3_adapter config }
+    subject{ Apartment::Tenant.sqlite3_adapter config }
 
     context "using connections" do
       def tenant_names

data/spec/apartment_spec.rb

@@ -8,4 +8,8 @@ describe Apartment do
   it "should be a valid app" do
     ::Rails.application.should be_a(Dummy::Application)
   end
+
+  it "should deprecate Apartment::Database in favor of Apartment::Tenant" do
+    expect(Apartment::Database).to eq(Apartment::Tenant)
+  end
 end

data/spec/database_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Apartment::Database do
+describe Apartment::Tenant do
   context "using mysql", database: :mysql do
 
     before do
@@ -77,7 +77,7 @@ describe Apartment::Database do
         subject.stub(:config).and_return config.merge(:adapter => 'unknown')
 
         expect {
-          Apartment::Database.adapter
+          Apartment::Tenant.adapter
         }.to raise_error
       end
 

data/spec/examples/connection_adapter_examples.rb

@@ -10,7 +10,7 @@ shared_examples_for "a connection based apartment adapter" do
       Apartment.configure do |config|
         config.excluded_models = ["Company"]
       end
-      Apartment::Database.init
+      Apartment::Tenant.init
 
       Company.connection.object_id.should_not == ActiveRecord::Base.connection.object_id
     end

data/spec/examples/schema_adapter_examples.rb

@@ -16,7 +16,7 @@ shared_examples_for "a schema based apartment adapter" do
     end
 
     it "should process model exclusions" do
-      Apartment::Database.init
+      Apartment::Tenant.init
 
       Company.table_name.should == "public.companies"
     end
@@ -24,13 +24,13 @@ shared_examples_for "a schema based apartment adapter" do
     context "with a default_schema", :default_schema => true do
 
       it "should set the proper table_name on excluded_models" do
-        Apartment::Database.init
+        Apartment::Tenant.init
 
         Company.table_name.should == "#{default_schema}.companies"
       end
 
       it 'sets the search_path correctly' do
-        Apartment::Database.init
+        Apartment::Tenant.init
 
         User.connection.schema_search_path.should =~ %r|#{default_schema}|
       end
@@ -38,7 +38,7 @@ shared_examples_for "a schema based apartment adapter" do
 
     context "persistent_schemas", :persistent_schemas => true do
       it "sets the persistent schemas in the schema_search_path" do
-        Apartment::Database.init
+        Apartment::Tenant.init
         connection.schema_search_path.should end_with persistent_schemas.map { |schema| %{"#{schema}"} }.join(', ')
       end
     end

data/spec/integration/apartment_rake_integration_spec.rb

@@ -21,7 +21,7 @@ describe "apartment rake tasks", database: :postgresql do
       config.excluded_models = ["Company"]
       config.tenant_names = lambda{ Company.pluck(:database) }
     end
-    Apartment::Database.reload!(config)
+    Apartment::Tenant.reload!(config)
 
     # fix up table name of shared/excluded models
     Company.table_name = 'public.companies'
@@ -37,13 +37,13 @@ describe "apartment rake tasks", database: :postgresql do
 
     before do
       db_names.collect do |db_name|
-        Apartment::Database.create(db_name)
+        Apartment::Tenant.create(db_name)
         Company.create :database => db_name
       end
     end
 
     after do
-      db_names.each{ |db| Apartment::Database.drop(db) }
+      db_names.each{ |db| Apartment::Tenant.drop(db) }
       Company.delete_all
     end
 
@@ -65,7 +65,7 @@ describe "apartment rake tasks", database: :postgresql do
 
     describe "apartment:seed" do
       it "should seed all databases" do
-        Apartment::Database.should_receive(:seed).exactly(company_count).times
+        Apartment::Tenant.should_receive(:seed).exactly(company_count).times
 
         @rake['apartment:seed'].invoke
       end

data/spec/integration/query_caching_spec.rb

@@ -10,32 +10,32 @@ describe 'query caching' do
       config.use_schemas = true
     end
 
-    Apartment::Database.reload!(config)
+    Apartment::Tenant.reload!(config)
 
     db_names.each do |db_name|
-      Apartment::Database.create(db_name)
+      Apartment::Tenant.create(db_name)
       Company.create database: db_name
     end
   end
 
   after do
-    db_names.each{ |db| Apartment::Database.drop(db) }
-    Apartment::Database.reset
+    db_names.each{ |db| Apartment::Tenant.drop(db) }
+    Apartment::Tenant.reset
     Company.delete_all
   end
 
   it 'clears the ActiveRecord::QueryCache after switching databases' do
     db_names.each do |db_name|
-      Apartment::Database.switch db_name
+      Apartment::Tenant.switch db_name
       User.create! name: db_name
     end
 
     ActiveRecord::Base.connection.enable_query_cache!
 
-    Apartment::Database.switch db_names.first
+    Apartment::Tenant.switch db_names.first
     User.find_by_name(db_names.first).name.should == db_names.first
 
-    Apartment::Database.switch db_names.last
+    Apartment::Tenant.switch db_names.last
     User.find_by_name(db_names.first).should be_nil
   end
 end

data/spec/support/contexts.rb

@@ -20,7 +20,7 @@ shared_context "elevators", elevator: true do
   let(:company1)  { mock_model(Company, database: db1).as_null_object }
   let(:company2)  { mock_model(Company, database: db2).as_null_object }
 
-  let(:api)       { Apartment::Database }
+  let(:api)       { Apartment::Tenant }
 
   before do
     Apartment.reset # reset all config

data/spec/support/setup.rb

@@ -15,7 +15,7 @@ module Apartment
           # Otherwise these actually get run after test defined hooks
           around(:each) do |example|
             # before
-            Apartment::Database.reload!(config)
+            Apartment::Tenant.reload!(config)
             ActiveRecord::Base.establish_connection config
 
             example.run
@@ -33,7 +33,7 @@ module Apartment
             end
 
             Apartment.reset
-            Apartment::Database.reload!
+            Apartment::Tenant.reload!
           end
         end
       end

data/spec/unit/elevators/domain_spec.rb

@@ -24,7 +24,7 @@ describe Apartment::Elevators::Domain do
 
   describe "#call" do
     it "switches to the proper tenant" do
-      Apartment::Database.should_receive(:switch).with('example')
+      Apartment::Tenant.should_receive(:switch).with('example')
 
       elevator.call('HTTP_HOST' => 'www.example.com')
     end

data/spec/unit/elevators/generic_spec.rb

@@ -15,7 +15,7 @@ describe Apartment::Elevators::Generic do
     it "calls the processor if given" do
       elevator = described_class.new(Proc.new{}, Proc.new{'tenant1'})
 
-      Apartment::Database.should_receive(:switch).with('tenant1')
+      Apartment::Tenant.should_receive(:switch).with('tenant1')
 
       elevator.call('HTTP_HOST' => 'foo.bar.com')
     end
@@ -29,7 +29,7 @@ describe Apartment::Elevators::Generic do
     it "switches to the parsed db_name" do
       elevator = MyElevator.new(Proc.new{})
 
-      Apartment::Database.should_receive(:switch).with('tenant2')
+      Apartment::Tenant.should_receive(:switch).with('tenant2')
 
       elevator.call('HTTP_HOST' => 'foo.bar.com')
     end

data/spec/unit/elevators/host_hash_spec.rb

@@ -24,7 +24,7 @@ describe Apartment::Elevators::HostHash do
 
   describe "#call" do
     it "switches to the proper tenant" do
-      Apartment::Database.should_receive(:switch).with('example_tenant')
+      Apartment::Tenant.should_receive(:switch).with('example_tenant')
 
       elevator.call('HTTP_HOST' => 'example.com')
     end

data/spec/unit/elevators/subdomain_spec.rb

@@ -39,14 +39,14 @@ describe Apartment::Elevators::Subdomain do
 
   describe "#call" do
     it "switches to the proper tenant" do
-      Apartment::Database.should_receive(:switch).with('tenant1')
+      Apartment::Tenant.should_receive(:switch).with('tenant1')
       elevator.call('HTTP_HOST' => 'tenant1.example.com')
     end
 
     it "ignores excluded subdomains" do
       described_class.excluded_subdomains = %w{foo}
 
-      Apartment::Database.should_not_receive(:switch)
+      Apartment::Tenant.should_not_receive(:switch)
 
       elevator.call('HTTP_HOST' => 'foo.bar.com')
 

data/spec/unit/migrator_spec.rb

@@ -6,11 +6,11 @@ describe Apartment::Migrator do
   let(:tenant){ Apartment::Test.next_db }
 
   # Don't need a real switch here, just testing behaviour
-  before { Apartment::Database.adapter.stub(:connect_to_new) }
+  before { Apartment::Tenant.adapter.stub(:connect_to_new) }
 
   describe "::migrate" do
     it "processes and migrates" do
-      expect(Apartment::Database).to receive(:process).with(tenant).and_call_original
+      expect(Apartment::Tenant).to receive(:process).with(tenant).and_call_original
       expect(ActiveRecord::Migrator).to receive(:migrate)
 
       Apartment::Migrator.migrate(tenant)
@@ -19,7 +19,7 @@ describe Apartment::Migrator do
 
   describe "::run" do
     it "processes and runs" do
-      expect(Apartment::Database).to receive(:process).with(tenant).and_call_original
+      expect(Apartment::Tenant).to receive(:process).with(tenant).and_call_original
       expect(ActiveRecord::Migrator).to receive(:run).with(:up, anything, 1234)
 
       Apartment::Migrator.run(:up, tenant, 1234)
@@ -28,7 +28,7 @@ describe Apartment::Migrator do
 
   describe "::rollback" do
     it "processes and rolls back" do
-      expect(Apartment::Database).to receive(:process).with(tenant).and_call_original
+      expect(Apartment::Tenant).to receive(:process).with(tenant).and_call_original
       expect(ActiveRecord::Migrator).to receive(:rollback).with(anything, 2)
 
       Apartment::Migrator.rollback(tenant, 2)

data/spec/unit/reloader_spec.rb

@@ -9,7 +9,7 @@ describe Apartment::Reloader do
         config.excluded_models = ["Company"]
         config.use_schemas = true
       end
-      Apartment::Database.reload!(config)
+      Apartment::Tenant.reload!(config)
       Company.reset_table_name  # ensure we're clean
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apartment
 version: !ruby/object:Gem::Version
-  version: 0.24.3
+  version: 0.25.0
 platform: ruby
 authors:
 - Ryan Brunner
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-05 00:00:00.000000000 Z
+date: 2014-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -18,6 +18,9 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 3.1.2
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -25,6 +28,9 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 3.1.2
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -174,8 +180,9 @@ files:
 - Rakefile
 - TODO.md
 - apartment.gemspec
-- gemfiles/rails3.2.gemfile
-- gemfiles/rails4.0.gemfile
+- gemfiles/rails_3_2.gemfile
+- gemfiles/rails_4_0.gemfile
+- gemfiles/rails_4_1.gemfile
 - lib/apartment.rb
 - lib/apartment/adapters/abstract_adapter.rb
 - lib/apartment/adapters/abstract_jdbc_adapter.rb
@@ -186,7 +193,6 @@ files:
 - lib/apartment/adapters/postgresql_adapter.rb
 - lib/apartment/adapters/sqlite3_adapter.rb
 - lib/apartment/console.rb
-- lib/apartment/database.rb
 - lib/apartment/elevators/domain.rb
 - lib/apartment/elevators/first_subdomain.rb
 - lib/apartment/elevators/generic.rb
@@ -196,6 +202,7 @@ files:
 - lib/apartment/railtie.rb
 - lib/apartment/reloader.rb
 - lib/apartment/tasks/enhancements.rb
+- lib/apartment/tenant.rb
 - lib/apartment/version.rb
 - lib/generators/apartment/install/USAGE
 - lib/generators/apartment/install/install_generator.rb
@@ -271,7 +278,20 @@ homepage: https://github.com/influitive/apartment
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |2
+    ********************************
+
+    Apartment Deprecation Warning
+
+    `Apartment::Database` has been deprecated in favour of `Apartment::Tenant`.
+    Please update your application to use the new constant as it is a more
+    appropriate abstraction.
+
+    To further this, DatabaseNotFound, SchemaNotFound, DatabaseExists and
+    SchemaExists exceptions will all be removed, you should instead use
+    TenantNotFound and TenantExists to catch any exceptions.
+
+    ********************************
 rdoc_options: []
 require_paths:
 - lib