apartment 0.23.0 → 0.23.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7048e41db332f308d96362525ecd55389c7b6ad2
-  data.tar.gz: c303cac42eca0c9d5a22263fb8d2b3abb239b07e
+  metadata.gz: 7a231a3932b1b2bd5718861c0f70201d7502d4dd
+  data.tar.gz: 45ebf27d557562aaf6944b471fb5ea679f4b0d84
 SHA512:
-  metadata.gz: ab730aab830bf546295ecd75dabc017dd1fe01a55bbf82b625ff0f9e70cd7a58034417afe25344c7c36ff9f9e1f75eec7a73a4d07432fc1f6acc4e03291548ab
-  data.tar.gz: 0d7041eaea15f04e43ab772adfbbebb51f35451215a619882162d337d9bb25bbffbf3c9bbfb0e73ece50935681a45adc8d1ecb55e9d1ceeae38823a2dbd73134
+  metadata.gz: d2b3e6efe7075333081133c60f96150ccb0227422545f669de98a8bf5db82bd971fa48a474448b3152238282c1201ec502bad5f16419fdbd4da985fa4aa30081
+  data.tar.gz: b6d1f23c13731c723c566af5f9e77ef4116d75b031b689f8333ee2773cf56c36806b8a7d023e2302372d9eba01c3e04bd23383edd662e0ae18e9b7958cd875f1

data/.gitignore

@@ -1,6 +1,7 @@
 *.gem
 .bundle
 *.lock
+gemfiles/*.lock
 pkg/*
 *.log
 .idea

data/.travis.yml

@@ -2,8 +2,14 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - jruby-19mode-1.7.4
+  - 2.1.0
+  - jruby-19mode
 gemfile:
   - gemfiles/rails3.2.gemfile
   - gemfiles/rails4.0.gemfile
-bundler_args: --without local --verbose
+bundler_args: --without local --verbose
+before_install:
+  - gem install bundler -v '> 1.5.0'
+env:
+  RUBY_GC_MALLOC_LIMIT: 90000000
+  RUBY_FREE_MIN: 200000

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/apartment/(.+)\.rb$})     { |m| "spec/unit/#{m[1]}_spec.rb" }
+  watch(%r{^lib/apartment/(.+)\.rb$})     { |m| "spec/integration/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # # Rails example
+  # watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  # watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  # watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  # watch('config/routes.rb')                           { "spec/routing" }
+  # watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # # Capybara features specs
+  # watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # # Turnip features and steps
+  # watch(%r{^spec/acceptance/(.+)\.feature$})
+  # watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end

data/HISTORY.md

@@ -1,3 +1,8 @@
+# 0.23.1
+  * January 8, 2014
+
+  - Schema adapters now initialize with default and persistent schemas
+
 # 0.23.0
   * August 21, 2013
 

data/README.md

@@ -19,6 +19,15 @@ Add the following to your Gemfile:
 gem 'apartment'
 ```
 
+Then generate your `Apartment` config file using
+
+```ruby
+bundle exec rails generate apartment:install
+```
+
+This will create a `config/initializers/apartment.rb` initializer file.
+Configure as needed using the docs below.
+
 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.
 
@@ -70,6 +79,17 @@ database, call switch with no arguments.
 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.
 
+The initializer above will generate the appropriate code for the Subdomain elevator
+by default. You can see this in `config/initializers/apartment.rb` after running
+that generator. If you're *not* using the generator, you can specify your
+elevator below. Note that in this case you will **need** to require the elevator
+manually in your `application.rb` like so
+
+```ruby
+# config/application.rb
+require 'apartment/elevators/subdomain' # or 'domain' or 'generic'
+```
+
 **Switch on subdomain**
 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:
 

data/apartment.gemspec

@@ -23,8 +23,8 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'appraisal'
   s.add_development_dependency 'rake',         '~> 0.9'
-  s.add_development_dependency 'rspec',        '~> 2.11'
-  s.add_development_dependency 'rspec-rails',  '~> 2.11'
+  s.add_development_dependency 'rspec-rails',  '~> 2.14'
+  s.add_development_dependency 'guard-rspec',  '~> 4.2'
   s.add_development_dependency 'capybara',     '~> 1.0.0'
 
   if defined?(JRUBY_VERSION)
@@ -39,4 +39,4 @@ Gem::Specification.new do |s|
     s.add_development_dependency 'pg',     '>= 0.11.0'
     s.add_development_dependency 'sqlite3'
   end
-end
+end

data/lib/apartment.rb

@@ -68,23 +68,26 @@ module Apartment
   end
 
   # Exceptions
-  class ApartmentError < StandardError; end
+  ApartmentError = Class.new(StandardError)
 
   # Raised when apartment cannot find the adapter specified in <tt>config/database.yml</tt>
-  class AdapterNotFound < ApartmentError; end
+  AdapterNotFound = Class.new(ApartmentError)
 
-  # Raised when database cannot find the specified database
-  class DatabaseNotFound < ApartmentError; end
+  # Tenant specified is unknown
+  TenantNotFound = Class.new(ApartmentError)
 
-  # Raised when trying to create a database that already exists
-  class DatabaseExists < ApartmentError; end
+  # Raised when database cannot find the specified database
+  DatabaseNotFound = Class.new(TenantNotFound)
 
   # Raised when database cannot find the specified schema
-  class SchemaNotFound < ApartmentError; end
+  SchemaNotFound = Class.new(TenantNotFound)
 
-  # Raised when trying to create a schema that already exists
-  class SchemaExists < ApartmentError; end
+  # The Tenant attempting to be created already exists
+  TenantExists = Class.new(ApartmentError)
 
-  # Raised when an ActiveRecord object does not have the required database field on it
-  class DJSerializationError < ApartmentError; end
+  # Raised when trying to create a database that already exists
+  DatabaseExists = Class.new(TenantExists)
+
+  # Raised when trying to create a schema that already exists
+  SchemaExists = Class.new(TenantExists)
 end

data/lib/apartment/adapters/abstract_adapter.rb

@@ -14,7 +14,7 @@ module Apartment
       #   @param {String} database Database name
       #
       def create(database)
-        create_database(database)
+        create_tenant(database)
 
         process(database) do
           import_database_schema
@@ -106,7 +106,7 @@ module Apartment
       #
       #   @param {String} database Database name
       #
-      def create_database(database)
+      def create_tenant(database)
         Apartment.connection.create_database( environmentify(database) )
 
       rescue *rescuable_exceptions
@@ -183,4 +183,4 @@ module Apartment
       end
     end
   end
-end
+end

data/lib/apartment/adapters/jdbc_postgresql_adapter.rb

@@ -5,8 +5,8 @@ module Apartment
 
     def self.jdbc_postgresql_adapter(config)
       Apartment.use_schemas ?
-          Adapters::JDBCPostgresqlSchemaAdapter.new(config) :
-          Adapters::JDBCPostgresqlAdapter.new(config)
+        Adapters::JDBCPostgresqlSchemaAdapter.new(config) :
+        Adapters::JDBCPostgresqlAdapter.new(config)
     end
   end
 
@@ -17,7 +17,7 @@ module Apartment
 
     protected
 
-      def create_database(database)
+      def create_tenant(database)
         # There is a bug in activerecord-jdbcpostgresql-adapter (1.2.5) that will cause
         # an exception if no options are passed into the create_database call.
         Apartment.connection.create_database(environmentify(database), { :thisisahack => '' })
@@ -64,4 +64,4 @@ module Apartment
       end
     end
   end
-end
+end

data/lib/apartment/adapters/mysql2_adapter.rb

@@ -33,9 +33,10 @@ module Apartment
       attr_reader :default_database
 
       def initialize(config)
-        @default_database = config[:database]
-
         super
+
+        @default_database = config[:database]
+        reset
       end
 
       #   Reset current_database to the default_database

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -24,6 +24,12 @@ module Apartment
     # Separate Adapter for Postgresql when using schemas
     class PostgresqlSchemaAdapter < AbstractAdapter
 
+      def initialize(config)
+        super
+
+        reset
+      end
+
       #   Drop the database schema
       #
       #   @param {String} database Database (schema) to drop
@@ -83,7 +89,7 @@ module Apartment
 
       #   Create the new schema
       #
-      def create_database(database)
+      def create_tenant(database)
         Apartment.connection.execute(%{CREATE SCHEMA "#{database}"})
 
       rescue *rescuable_exceptions
@@ -95,8 +101,11 @@ module Apartment
       #   Generate the final search path to set including persistent_schemas
       #
       def full_search_path
-        persistent_schemas = Apartment.persistent_schemas.map { |schema| %{"#{schema}"} }.join(', ')
-        %{"#{@current_database.to_s}"} + (persistent_schemas.empty? ? "" : ", #{persistent_schemas}")
+        persistent_schemas.map(&:inspect).join(", ")
+      end
+      
+      def persistent_schemas
+        [@current_database, Apartment.persistent_schemas].flatten
       end
     end
   end

data/lib/apartment/adapters/sqlite3_adapter.rb

@@ -26,7 +26,7 @@ module Apartment
         File.basename(Apartment.connection.instance_variable_get(:@config)[:database], '.sqlite3')
       end
 
-      protected
+    protected
 
       def connect_to_new(database)
         raise DatabaseNotFound,
@@ -35,7 +35,7 @@ module Apartment
         super database_file(database)
       end
 
-      def create_database(database)
+      def create_tenant(database)
         raise DatabaseExists,
           "The database #{environmentify(database)} already exists." if File.exists?(database_file(database))
 

data/lib/apartment/elevators/domain.rb

@@ -2,15 +2,15 @@ require 'apartment/elevators/generic'
 
 module Apartment
   module Elevators
-    #   Provides a rack based db switching solution based on domain
-    #   Assumes that database name should match domain
+    #   Provides a rack based tenant switching solution based on domain
+    #   Assumes that tenant name should match domain
     #   Parses request host for second level domain
     #   eg. example.com       => example
     #       www.example.bc.ca => example
     #
     class Domain < Generic
 
-      def parse_database_name(request)
+      def parse_tenant_name(request)
         return nil if request.host.blank?
 
         request.host.match(/(www\.)?(?<sld>[^.]*)/)["sld"]

data/lib/apartment/elevators/first_subdomain.rb

@@ -2,14 +2,14 @@ require 'apartment/elevators/subdomain'
 
 module Apartment
   module Elevators
-    # Provides a rack based db switching solution based on the first subdomain
+    # Provides a rack based tenant switching solution based on the first subdomain
     # of a given domain name.
     # eg:
     #     - example1.domain.com               => example1
     #     - example2.something.domain.com     => example2
     class FirstSubdomain < Subdomain
 
-      def parse_database_name(request)
+      def parse_tenant_name(request)
         super.split('.')[0]
       end
     end

data/lib/apartment/elevators/generic.rb

@@ -3,13 +3,13 @@ require 'apartment/database'
 
 module Apartment
   module Elevators
-    #   Provides a rack based db switching solution based on request
+    #   Provides a rack based tenant switching solution based on request
     #
     class Generic
 
       def initialize(app, processor = nil)
         @app = app
-        @processor = processor || method(:parse_database_name)
+        @processor = processor || method(:parse_tenant_name)
       end
 
       def call(env)
@@ -23,6 +23,11 @@ module Apartment
       end
 
       def parse_database_name(request)
+        warn "[DEPRECATED] - Use #parse_tenant_name"
+        parse_tenant_name(request)
+      end
+
+      def parse_tenant_name(request)
         raise "Override"
       end
     end

data/lib/apartment/elevators/host_hash.rb

@@ -11,7 +11,7 @@ module Apartment
         @hash = hash
       end
 
-      def parse_database_name(request)
+      def parse_tenant_name(request)
         raise DatabaseNotFound,
           "Cannot find database for host #{request.host}" unless @hash.has_key?(request.host)
 

data/lib/apartment/elevators/subdomain.rb

@@ -2,33 +2,33 @@ require 'apartment/elevators/generic'
 
 module Apartment
   module Elevators
-    #   Provides a rack based db switching solution based on subdomains
-    #   Assumes that database name should match subdomain
+    #   Provides a rack based tenant switching solution based on subdomains
+    #   Assumes that tenant name should match subdomain
     #
     class Subdomain < Generic
       def self.excluded_subdomains
-        @@excluded_subdomains ||= []
+        @excluded_subdomains ||= []
       end
 
       def self.excluded_subdomains=(arg)
-        @@excluded_subdomains = arg
+        @excluded_subdomains = arg
       end
 
-      def parse_database_name(request)
+      def parse_tenant_name(request)
         request_subdomain = subdomain(request.host)
 
-        # If the domain acquired is set to be exlcluded, set the database to whatever is currently
+        # If the domain acquired is set to be excluded, set the tenant to whatever is currently
         # next in line in the schema search path.
-        database = if self.class.excluded_subdomains.include?(request_subdomain)
+        tenant = if self.class.excluded_subdomains.include?(request_subdomain)
           nil
         else
           request_subdomain
         end
 
-        database.present? && database || nil
+        tenant.presence
       end
 
-    private
+    protected
 
       # *Almost* a direct ripoff of ActionDispatch::Request subdomain methods
 

data/lib/apartment/migrator.rb

@@ -8,7 +8,9 @@ module Apartment
     # Migrate to latest
     def migrate(database)
       Database.process(database) do
-        ActiveRecord::Migrator.migrate(ActiveRecord::Migrator.migrations_path, ENV["VERSION"] ? ENV["VERSION"].to_i : nil) do |migration|
+        version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
+
+        ActiveRecord::Migrator.migrate(ActiveRecord::Migrator.migrations_path, version) do |migration|
           ENV["SCOPE"].blank? || (ENV["SCOPE"] == migration.scope)
         end
       end
@@ -16,13 +18,16 @@ module Apartment
 
     # Migrate up/down to a specific version
     def run(direction, database, version)
-      Database.process(database){ ActiveRecord::Migrator.run(direction, ActiveRecord::Migrator.migrations_path, version) }
+      Database.process(database) do
+        ActiveRecord::Migrator.run(direction, ActiveRecord::Migrator.migrations_path, version)
+      end
     end
 
     # rollback latest migration `step` number of times
     def rollback(database, step = 1)
-      Database.process(database){ ActiveRecord::Migrator.rollback(ActiveRecord::Migrator.migrations_path, step) }
+      Database.process(database) do
+        ActiveRecord::Migrator.rollback(ActiveRecord::Migrator.migrations_path, step)
+      end
     end
   end
-
 end

data/lib/apartment/version.rb

@@ -1,3 +1,3 @@
 module Apartment
-  VERSION = "0.23.0"
+  VERSION = "0.23.1"
 end

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

@@ -1,3 +1,9 @@
+# Require whichever elevator you're using below here...
+#
+# require 'apartment/elevators/generic'
+# require 'apartment/elevators/domain'
+require 'apartment/elevators/subdomain'
+
 #
 # Apartment Configuration
 #
@@ -5,6 +11,8 @@ Apartment.configure do |config|
 
   # these models will not be multi-tenanted,
   # but remain in the global (public) namespace
+  # Note that ActiveRecord::SessionStore::Session is just an example
+  # you may not even use the AR Session Store, in which case you'd remove that line
   config.excluded_models = %w{
     ActiveRecord::SessionStore::Session
   }

data/lib/tasks/apartment.rake

@@ -8,7 +8,7 @@ apartment_namespace = namespace :apartment do
       begin
         puts("Creating #{db} database")
         quietly { Apartment::Database.create(db) }
-      rescue Apartment::DatabaseExists, Apartment::SchemaExists => e
+      rescue Apartment::TenantExists => e
         puts e.message
       end
     end
@@ -21,7 +21,7 @@ apartment_namespace = namespace :apartment do
       begin
         puts("Migrating #{db} database")
         Apartment::Migrator.migrate db
-      rescue Apartment::DatabaseNotFound, Apartment::SchemaNotFound => e
+      rescue Apartment::TenantNotFound => e
         puts e.message
       end
     end
@@ -36,7 +36,7 @@ apartment_namespace = namespace :apartment do
         Apartment::Database.process(db) do
           Apartment::Database.seed
         end
-      rescue Apartment::DatabaseNotFound, Apartment::SchemaNotFound => e
+      rescue Apartment::TenantNotFound => e
         puts e.message
       end
     end
@@ -50,7 +50,7 @@ apartment_namespace = namespace :apartment do
       begin
         puts("Rolling back #{db} database")
         Apartment::Migrator.rollback db, step
-      rescue Apartment::DatabaseNotFound, Apartment::SchemaNotFound => e
+      rescue Apartment::TenantNotFound => e
         puts e.message
       end
     end
@@ -67,7 +67,7 @@ apartment_namespace = namespace :apartment do
         begin
           puts("Migrating #{db} database up")
           Apartment::Migrator.run :up, db, version
-        rescue Apartment::DatabaseNotFound, Apartment::SchemaNotFound => e
+        rescue Apartment::TenantNotFound => e
           puts e.message
         end
       end
@@ -82,7 +82,7 @@ apartment_namespace = namespace :apartment do
         begin
           puts("Migrating #{db} database down")
           Apartment::Migrator.run :down, db, version
-        rescue Apartment::DatabaseNotFound, Apartment::SchemaNotFound => e
+        rescue Apartment::TenantNotFound => e
           puts e.message
         end
       end

data/spec/dummy/config/application.rb

@@ -18,9 +18,6 @@ module Dummy
     require 'apartment/elevators/domain'
 
     config.middleware.use 'Apartment::Elevators::Subdomain'
-    config.middleware.use 'Apartment::Elevators::Domain'
-    # Our test for this middleware is using a query_string couldn't think of a better way to differentiate it from the other middleware
-    config.middleware.use 'Apartment::Elevators::Generic', Proc.new { |request| request.query_string.split('=').last if request.query_string.present? }
 
     # Custom directories with classes and modules you want to be autoloadable.
     config.autoload_paths += %W(#{config.root}/lib)

data/spec/examples/schema_adapter_examples.rb

@@ -28,6 +28,19 @@ shared_examples_for "a schema based apartment adapter" do
 
         Company.table_name.should == "#{default_schema}.companies"
       end
+
+      it 'sets the search_path correctly' do
+        Apartment::Database.init
+
+        User.connection.schema_search_path.should =~ %r|#{default_schema}|
+      end
+    end
+
+    context "persistent_schemas", :persistent_schemas => true do
+      it "sets the persistent schemas in the schema_search_path" do
+        Apartment::Database.init
+        connection.schema_search_path.should end_with persistent_schemas.map { |schema| %{"#{schema}"} }.join(', ')
+      end
     end
   end
 

data/spec/unit/{middleware/domain_elevator_spec.rb → elevators/domain_spec.rb}

@@ -3,23 +3,30 @@ require 'apartment/elevators/domain'
 
 describe Apartment::Elevators::Domain do
 
-  describe "#parse_database_name" do
+  subject(:elevator){ described_class.new(Proc.new{}) }
+
+  describe "#parse_tenant_name" do
     it "parses the host for a domain name" do
       request = ActionDispatch::Request.new('HTTP_HOST' => 'example.com')
-      elevator = Apartment::Elevators::Domain.new(nil)
-      elevator.parse_database_name(request).should == 'example'
+      elevator.parse_tenant_name(request).should == 'example'
     end
 
     it "ignores a www prefix and domain suffix" do
       request = ActionDispatch::Request.new('HTTP_HOST' => 'www.example.bc.ca')
-      elevator = Apartment::Elevators::Domain.new(nil)
-      elevator.parse_database_name(request).should == 'example'
+      elevator.parse_tenant_name(request).should == 'example'
     end
 
     it "returns nil if there is no host" do
       request = ActionDispatch::Request.new('HTTP_HOST' => '')
-      elevator = Apartment::Elevators::Domain.new(nil)
-      elevator.parse_database_name(request).should be_nil
+      elevator.parse_tenant_name(request).should be_nil
+    end
+  end
+
+  describe "#call" do
+    it "switches to the proper tenant" do
+      Apartment::Database.should_receive(:switch).with('example')
+
+      elevator.call('HTTP_HOST' => 'www.example.com')
     end
   end
 end

data/spec/unit/{middleware/first_subdomain_elevator_spec.rb → elevators/first_subdomain_spec.rb}

@@ -3,7 +3,7 @@ require 'apartment/elevators/first_subdomain'
 
 describe Apartment::Elevators::FirstSubdomain do
   describe "subdomain" do
-    subject { described_class.new("test").parse_database_name(request) }
+    subject { described_class.new("test").parse_tenant_name(request) }
     let(:request) { double(:request, :host => "#{subdomain}.example.com") }
 
     context "one subdomain" do

data/spec/unit/elevators/generic_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+require 'apartment/elevators/generic'
+
+describe Apartment::Elevators::Generic do
+
+  class MyElevator < described_class
+    def parse_tenant_name(*)
+      'tenant2'
+    end
+  end
+
+  subject(:elevator){ described_class.new(Proc.new{}) }
+
+  describe "#call" do
+    it "calls the processor if given" do
+      elevator = described_class.new(Proc.new{}, Proc.new{'tenant1'})
+
+      Apartment::Database.should_receive(:switch).with('tenant1')
+
+      elevator.call('HTTP_HOST' => 'foo.bar.com')
+    end
+
+    it "raises if parse_tenant_name not implemented" do
+      expect {
+        elevator.call('HTTP_HOST' => 'foo.bar.com')
+      }.to raise_error(RuntimeError)
+    end
+
+    it "switches to the parsed db_name" do
+      elevator = MyElevator.new(Proc.new{})
+
+      Apartment::Database.should_receive(:switch).with('tenant2')
+
+      elevator.call('HTTP_HOST' => 'foo.bar.com')
+    end
+  end
+end

data/spec/unit/elevators/host_hash_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'apartment/elevators/host_hash'
+
+describe Apartment::Elevators::HostHash do
+
+  subject(:elevator){ Apartment::Elevators::HostHash.new(Proc.new{}, 'example.com' => 'example_tenant') }
+
+  describe "#parse_tenant_name" do
+    it "parses the host for a domain name" do
+      request = ActionDispatch::Request.new('HTTP_HOST' => 'example.com')
+      elevator.parse_tenant_name(request).should == 'example_tenant'
+    end
+
+    it "raises DatabaseNotFound exception if there is no host" do
+      request = ActionDispatch::Request.new('HTTP_HOST' => '')
+      expect { elevator.parse_tenant_name(request) }.to raise_error(Apartment::DatabaseNotFound)
+    end
+
+    it "raises DatabaseNotFound exception if there is no database associated to current host" do
+      request = ActionDispatch::Request.new('HTTP_HOST' => 'example2.com')
+      expect { elevator.parse_tenant_name(request) }.to raise_error(Apartment::DatabaseNotFound)
+    end
+  end
+
+  describe "#call" do
+    it "switches to the proper tenant" do
+      Apartment::Database.should_receive(:switch).with('example_tenant')
+
+      elevator.call('HTTP_HOST' => 'example.com')
+    end
+  end
+end

data/spec/unit/elevators/subdomain_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'apartment/elevators/subdomain'
+
+describe Apartment::Elevators::Subdomain do
+
+  subject(:elevator){ described_class.new(Proc.new{}) }
+
+  describe "#parse_tenant_name" do
+    it "should parse subdomain" do
+      request = ActionDispatch::Request.new('HTTP_HOST' => 'foo.bar.com')
+      elevator.parse_tenant_name(request).should == 'foo'
+    end
+
+    it "should return nil when no subdomain" do
+      request = ActionDispatch::Request.new('HTTP_HOST' => 'bar.com')
+      elevator.parse_tenant_name(request).should be_nil
+    end
+  end
+
+  describe "#call" do
+    it "switches to the proper tenant" do
+      Apartment::Database.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)
+
+      elevator.call('HTTP_HOST' => 'foo.bar.com')
+
+      described_class.excluded_subdomains = nil
+    end
+  end
+end

data/spec/unit/migrator_spec.rb

@@ -1,90 +1,37 @@
 require 'spec_helper'
 require 'apartment/migrator'
 
-describe Apartment::Migrator, database: :postgresql do
+describe Apartment::Migrator do
 
-  let(:schema_name){ Apartment::Test.next_db }
-  let(:version){ 20110613152810 }     # note this is brittle!  I've literally just taken the version of the one migration I made...  don't change this version
+  let(:tenant){ Apartment::Test.next_db }
 
-  before do
-    ActiveRecord::Base.establish_connection config
-    Apartment::Database.stub(:config).and_return config   # Use postgresql config for this test
-    @original_schema = ActiveRecord::Base.connection.schema_search_path
-    # Necessary because the JDBC adapter returns $user in the search path
-    @original_schema.gsub!(/"\$user",/, '') if defined?(JRUBY_VERSION)
+  # Don't need a real switch here, just testing behaviour
+  before { Apartment::Database.adapter.stub(:connect_to_new) }
 
-    Apartment.configure do |config|
-      config.use_schemas = true
-      config.excluded_models = []
-      config.database_names = [schema_name]
-    end
-
-    Apartment::Database.create schema_name    # create the schema
-    migrations_path = Rails.root + ActiveRecord::Migrator.migrations_path     # tell AR where the real migrations are
-    ActiveRecord::Migrator.stub(:migrations_path).and_return(migrations_path)
-  end
+  describe "::migrate" do
+    it "processes and migrates" do
+      expect(Apartment::Database).to receive(:process).with(tenant).and_call_original
+      expect(ActiveRecord::Migrator).to receive(:migrate)
 
-  after do
-    Apartment::Test.drop_schema(schema_name)
+      Apartment::Migrator.migrate(tenant)
+    end
   end
 
-  # reset db
-  after(:all){ Apartment::Test.load_schema }
-
-  context "postgresql" do
-    context "using schemas" do
-
-      describe "#migrate" do
-        it "should connect to new db, then reset when done" do
-          ActiveRecord::Base.connection.should_receive(:schema_search_path=).with(%{"#{schema_name}"}).once
-          ActiveRecord::Base.connection.should_receive(:schema_search_path=).with(%{"#{@original_schema}"}).once
-          Apartment::Migrator.migrate(schema_name)
-        end
-
-        it "should migrate db" do
-          ActiveRecord::Migrator.should_receive(:migrate)
-          Apartment::Migrator.migrate(schema_name)
-        end
-      end
+  describe "::run" do
+    it "processes and runs" do
+      expect(Apartment::Database).to receive(:process).with(tenant).and_call_original
+      expect(ActiveRecord::Migrator).to receive(:run).with(:up, anything, 1234)
 
-      describe "#run" do
-        context "up" do
-
-          it "should connect to new db, then reset when done" do
-            ActiveRecord::Base.connection.should_receive(:schema_search_path=).with(%{"#{schema_name}"}).once
-            ActiveRecord::Base.connection.should_receive(:schema_search_path=).with(%{"#{@original_schema}"}).once
-            Apartment::Migrator.run(:up, schema_name, version)
-          end
-
-          it "should migrate to a version" do
-            ActiveRecord::Migrator.should_receive(:run).with(:up, anything, version)
-            Apartment::Migrator.run(:up, schema_name, version)
-          end
-        end
-
-        describe "down" do
-
-          it "should connect to new db, then reset when done" do
-            ActiveRecord::Base.connection.should_receive(:schema_search_path=).with(%{"#{schema_name}"}).once
-            ActiveRecord::Base.connection.should_receive(:schema_search_path=).with(%{"#{@original_schema}"}).once
-            Apartment::Migrator.run(:down, schema_name, version)
-          end
-
-          it "should migrate to a version" do
-            ActiveRecord::Migrator.should_receive(:run).with(:down, anything, version)
-            Apartment::Migrator.run(:down, schema_name, version)
-          end
-        end
-      end
+      Apartment::Migrator.run(:up, tenant, 1234)
+    end
+  end
 
-      describe "#rollback" do
-        let(:steps){ 3 }
+  describe "::rollback" do
+    it "processes and rolls back" do
+      expect(Apartment::Database).to receive(:process).with(tenant).and_call_original
+      expect(ActiveRecord::Migrator).to receive(:rollback).with(anything, 2)
 
-        it "should rollback the db" do
-          ActiveRecord::Migrator.should_receive(:rollback).with(anything, steps)
-          Apartment::Migrator.rollback(schema_name, steps)
-        end
-      end
+      Apartment::Migrator.rollback(tenant, 2)
     end
   end
-end
+end

data/spec/unit/reloader_spec.rb

@@ -13,7 +13,7 @@ describe Apartment::Reloader do
       Company.reset_table_name  # ensure we're clean
     end
 
-    subject{ Apartment::Reloader.new(mock("Rack::Application", :call => nil)) }
+    subject{ Apartment::Reloader.new(double("Rack::Application", :call => nil)) }
 
     it "should initialize apartment when called" do
       Company.table_name.should_not include('public.')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apartment
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.23.1
 platform: ruby
 authors:
 - Ryan Brunner
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-15 00:00:00.000000000 Z
+date: 2014-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -68,33 +68,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -168,16 +168,14 @@ files:
 - .travis.yml
 - Appraisals
 - Gemfile
+- Guardfile
 - HISTORY.md
 - README.md
 - Rakefile
 - TODO.md
 - apartment.gemspec
-- circle.yml
 - gemfiles/rails3.2.gemfile
-- gemfiles/rails3.2.gemfile.lock
 - gemfiles/rails4.0.gemfile
-- gemfiles/rails4.0.gemfile.lock
 - lib/apartment.rb
 - lib/apartment/adapters/abstract_adapter.rb
 - lib/apartment/adapters/abstract_jdbc_adapter.rb
@@ -245,13 +243,9 @@ files:
 - spec/dummy/public/stylesheets/.gitkeep
 - spec/dummy/script/rails
 - spec/examples/connection_adapter_examples.rb
-- spec/examples/elevator_examples.rb
 - spec/examples/generic_adapter_examples.rb
 - spec/examples/schema_adapter_examples.rb
 - spec/integration/apartment_rake_integration_spec.rb
-- spec/integration/middleware/domain_elevator_spec.rb
-- spec/integration/middleware/generic_elevator_spec.rb
-- spec/integration/middleware/subdomain_elevator_spec.rb
 - spec/integration/query_caching_spec.rb
 - spec/schemas/v1.rb
 - spec/schemas/v2.rb
@@ -265,10 +259,11 @@ files:
 - spec/support/setup.rb
 - spec/tasks/apartment_rake_spec.rb
 - spec/unit/config_spec.rb
-- spec/unit/middleware/domain_elevator_spec.rb
-- spec/unit/middleware/first_subdomain_elevator_spec.rb
-- spec/unit/middleware/host_hash_elevator_spec.rb
-- spec/unit/middleware/subdomain_elevator_spec.rb
+- spec/unit/elevators/domain_spec.rb
+- spec/unit/elevators/first_subdomain_spec.rb
+- spec/unit/elevators/generic_spec.rb
+- spec/unit/elevators/host_hash_spec.rb
+- spec/unit/elevators/subdomain_spec.rb
 - spec/unit/migrator_spec.rb
 - spec/unit/reloader_spec.rb
 homepage: https://github.com/influitive/apartment
@@ -291,7 +286,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: A Ruby gem for managing database multitenancy
@@ -339,13 +334,9 @@ test_files:
 - spec/dummy/public/stylesheets/.gitkeep
 - spec/dummy/script/rails
 - spec/examples/connection_adapter_examples.rb
-- spec/examples/elevator_examples.rb
 - spec/examples/generic_adapter_examples.rb
 - spec/examples/schema_adapter_examples.rb
 - spec/integration/apartment_rake_integration_spec.rb
-- spec/integration/middleware/domain_elevator_spec.rb
-- spec/integration/middleware/generic_elevator_spec.rb
-- spec/integration/middleware/subdomain_elevator_spec.rb
 - spec/integration/query_caching_spec.rb
 - spec/schemas/v1.rb
 - spec/schemas/v2.rb
@@ -359,9 +350,10 @@ test_files:
 - spec/support/setup.rb
 - spec/tasks/apartment_rake_spec.rb
 - spec/unit/config_spec.rb
-- spec/unit/middleware/domain_elevator_spec.rb
-- spec/unit/middleware/first_subdomain_elevator_spec.rb
-- spec/unit/middleware/host_hash_elevator_spec.rb
-- spec/unit/middleware/subdomain_elevator_spec.rb
+- spec/unit/elevators/domain_spec.rb
+- spec/unit/elevators/first_subdomain_spec.rb
+- spec/unit/elevators/generic_spec.rb
+- spec/unit/elevators/host_hash_spec.rb
+- spec/unit/elevators/subdomain_spec.rb
 - spec/unit/migrator_spec.rb
 - spec/unit/reloader_spec.rb

data/circle.yml

@@ -1,9 +0,0 @@
-machine:
-  ruby:
-    version: 1.9.3-p194
-
-test:
-  override:
-    - bundle exec rake spec:
-        environment:
-          RAILS_ENV: test

data/spec/examples/elevator_examples.rb

@@ -1,31 +0,0 @@
-require 'spec_helper'
-
-shared_examples_for "an apartment elevator" do
-
-  context "single request" do
-    it "should switch the db" do
-      ActiveRecord::Base.connection.schema_search_path.should_not == %{"#{db1}"}
-
-      visit(domain1)
-      ActiveRecord::Base.connection.schema_search_path.should == %{"#{db1}"}
-    end
-  end
-
-  context "simultaneous requests" do
-
-    let!(:c1_user_count) { api.process(db1){ (2 + rand(2)).times{ User.create } } }
-    let!(:c2_user_count) { api.process(db2){ (c1_user_count + 2).times{ User.create } } }
-
-    it "should fetch the correct user count for each session based on the elevator processor" do
-      visit(domain1)
-
-      in_new_session do |session|
-        session.visit(domain2)
-        User.count.should == c2_user_count
-      end
-
-      visit(domain1)
-      User.count.should == c1_user_count
-    end
-  end
-end

data/spec/integration/middleware/domain_elevator_spec.rb

@@ -1,10 +0,0 @@
-require 'spec_helper'
-require 'apartment/elevators/domain'
-
-describe Apartment::Elevators::Domain, elevator: true do
-
-  let(:domain1)   { "http://#{db1}.com" }
-  let(:domain2)   { "http://#{db2}.com" }
-
-  it_should_behave_like "an apartment elevator"
-end

data/spec/integration/middleware/generic_elevator_spec.rb

@@ -1,11 +0,0 @@
-require 'spec_helper'
-require 'apartment/elevators/generic'
-
-describe Apartment::Elevators::Generic, elevator: true do
-
-  # NOTE, see spec/dummy/config/application.rb to see the Proc that defines the behaviour here
-  let(:domain1)   { "http://#{db1}.com?db=#{db1}" }
-  let(:domain2)   { "http://#{db2}.com?db=#{db2}" }
-
-  it_should_behave_like "an apartment elevator"
-end

data/spec/integration/middleware/subdomain_elevator_spec.rb

@@ -1,35 +0,0 @@
-require 'spec_helper'
-require 'apartment/elevators/generic'
-
-describe Apartment::Elevators::Subdomain, elevator: true do
-
-  let(:domain1)   { "http://#{db1}.example.com" }
-  let(:domain2)   { "http://#{db2}.example.com" }
-
-  it_should_behave_like "an apartment elevator"
-
-  context "With Subdomain Excluded" do
-    let(:domain_with_excluded_subdomain) { "http://www.example.com" }
-
-    before do
-      Apartment::Elevators::Subdomain.excluded_subdomains = %w(www)
-      # FIXME:
-      # This is used because the dummy app includes all three middlewares. The domain middleware specifically
-      # tries to lookup the example schema and tries to switch to it. I don't know how to go around this.
-      Apartment::Database.create("example")
-    end
-
-    it_should_behave_like "an apartment elevator"
-
-    it "shouldnt switch the schema if the subdomain is excluded" do
-      ActiveRecord::Base.connection.schema_search_path.scan(/\w+/).should_not include("www")
-      visit(domain_with_excluded_subdomain)
-      ActiveRecord::Base.connection.schema_search_path.scan(/\w+/).should_not include("www")
-    end
-
-    after do
-      Apartment::Elevators::Subdomain.excluded_subdomains = []
-      Apartment::Database.drop("example")
-    end
-  end
-end

data/spec/unit/middleware/host_hash_elevator_spec.rb

@@ -1,25 +0,0 @@
-require 'spec_helper'
-require 'apartment/elevators/host_hash'
-
-describe Apartment::Elevators::HostHash do
-
-  describe "#parse_database_name" do
-    it "parses the host for a domain name" do
-      request = ActionDispatch::Request.new('HTTP_HOST' => 'example.com')
-      elevator = Apartment::Elevators::HostHash.new(nil, 'example.com' => 'example_database')
-      elevator.parse_database_name(request).should == 'example_database'
-    end
-
-    it "raises DatabaseNotFound exception if there is no host" do
-      request = ActionDispatch::Request.new('HTTP_HOST' => '')
-      elevator = Apartment::Elevators::HostHash.new(nil, 'example.com' => 'example_database')
-      expect { elevator.parse_database_name(request) }.to raise_error(Apartment::DatabaseNotFound)
-    end
-
-    it "raises DatabaseNotFound exception if there is no database associated to current host" do
-      request = ActionDispatch::Request.new('HTTP_HOST' => 'example2.com')
-      elevator = Apartment::Elevators::HostHash.new(nil, 'example.com' => 'example_database')
-      expect { elevator.parse_database_name(request) }.to raise_error(Apartment::DatabaseNotFound)
-    end
-  end
-end

data/spec/unit/middleware/subdomain_elevator_spec.rb

@@ -1,19 +0,0 @@
-require 'spec_helper'
-require 'apartment/elevators/subdomain'
-
-describe Apartment::Elevators::Subdomain do
-
-  describe "#parse_database_name" do
-    it "should parse subdomain" do
-      request = ActionDispatch::Request.new('HTTP_HOST' => 'foo.bar.com')
-      elevator = Apartment::Elevators::Subdomain.new(nil)
-      elevator.parse_database_name(request).should == 'foo'
-    end
-
-    it "should return nil when no subdomain" do
-      request = ActionDispatch::Request.new('HTTP_HOST' => 'bar.com')
-      elevator = Apartment::Elevators::Subdomain.new(nil)
-      elevator.parse_database_name(request).should be_nil
-    end
-  end
-end