apartment 0.21.0 → 0.21.1

data/.gitignore

@@ -9,3 +9,4 @@ spec/config/database.yml
 spec/dummy/config/database.yml
 cookbooks
 tmp
+spec/dummy/db/*.sqlite3

data/.travis.yml

@@ -2,5 +2,6 @@ language: ruby
 rvm:
   - 1.9.2
   - 1.9.3
+  - 2.0.0
   - jruby-19mode
 bundler_args: --without local --verbose

data/Gemfile

@@ -13,6 +13,7 @@ gem 'delayed_job_active_record'
 platform :ruby do
   gem 'mysql2', '~> 0.3.10'
   gem 'pg',     '>= 0.11.0'
+  gem 'sqlite3'
 end
 
 platform :jruby do
@@ -26,4 +27,4 @@ end
 
 group :local do
   gem 'pry'
-end
+end

data/HISTORY.md

@@ -1,3 +1,9 @@
+# 0.21.1
+  * May 31, 2013
+
+  - Clearing the AR::QueryCache after switching databases.
+    - Fixes issue with stale model being loaded for schema adapters
+
 # 0.21.0
   * April 24, 2013
 

data/README.md

@@ -1,5 +1,5 @@
 # Apartment
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/influitive/apartment)
+[![Code Climate](https://codeclimate.com/github/influitive/apartment.png)](https://codeclimate.com/github/influitive/apartment)
 [![Build Status](https://secure.travis-ci.org/influitive/apartment.png?branch=development)](http://travis-ci.org/influitive/apartment)
 
 *Multitenancy for Rails 3 and ActiveRecord*

data/lib/apartment/adapters/abstract_adapter.rb

@@ -1,9 +1,7 @@
 require 'active_record'
 
 module Apartment
-
   module Adapters
-
     class AbstractAdapter
 
       #   @constructor
@@ -52,7 +50,7 @@ module Apartment
         # Apartment.connection.drop_database   note that drop_database will not throw an exception, so manually execute
         Apartment.connection.execute("DROP DATABASE #{environmentify(database)}" )
 
-      rescue ActiveRecord::StatementInvalid
+      rescue *rescuable_exceptions
         raise DatabaseNotFound, "The database #{environmentify(database)} cannot be found"
       end
 
@@ -74,13 +72,6 @@ module Apartment
       def process_excluded_models
         # All other models will shared a connection (at Apartment.connection_class) and we can modify at will
         Apartment.excluded_models.each do |excluded_model|
-          # Note that due to rails reloading, we now take string references to classes rather than
-          # actual object references.  This way when we contantize, we always get the proper class reference
-          if excluded_model.is_a? Class
-            warn "[Deprecation Warning] Passing class references to excluded models is now deprecated, please use a string instead"
-            excluded_model = excluded_model.name
-          end
-
           excluded_model.constantize.establish_connection @config
         end
       end
@@ -99,7 +90,9 @@ module Apartment
         # Just connect to default db and return
         return reset if database.nil?
 
-        connect_to_new(database)
+        connect_to_new(database).tap do
+          ActiveRecord::Base.connection.clear_query_cache
+        end
       end
 
       #   Load the rails seed file into the db
@@ -118,7 +111,7 @@ module Apartment
       def create_database(database)
         Apartment.connection.create_database( environmentify(database) )
 
-      rescue ActiveRecord::StatementInvalid
+      rescue *rescuable_exceptions
         raise DatabaseExists, "The database #{environmentify(database)} already exists."
       end
 
@@ -130,7 +123,7 @@ module Apartment
         Apartment.establish_connection multi_tenantify(database)
         Apartment.connection.active?   # call active? to manually check if this connection is valid
 
-      rescue ActiveRecord::StatementInvalid
+      rescue *rescuable_exceptions
         raise DatabaseNotFound, "The database #{environmentify(database)} cannot be found."
       end
 
@@ -179,6 +172,17 @@ module Apartment
         end
       end
 
+      #   Exceptions to rescue from on db operations
+      #
+      def rescuable_exceptions
+        [ActiveRecord::StatementInvalid] + [rescue_from].flatten
+      end
+
+      #   Extra exceptions to rescue from
+      #
+      def rescue_from
+        []
+      end
     end
   end
-end
+end

data/lib/apartment/adapters/abstract_jdbc_adapter.rb

@@ -1,43 +1,8 @@
 module Apartment
-
   module Adapters
-
     class AbstractJDBCAdapter < AbstractAdapter
 
-      #   Drop the database
-      #
-      #   @param {String} database Database name
-      #
-      def drop(database)
-        super(database)
-
-      rescue ActiveRecord::StatementInvalid, ActiveRecord::JDBCError
-        raise DatabaseNotFound, "The database #{environmentify(database)} cannot be found"
-      end
-
-      protected
-
-      #   Create the database
-      #
-      #   @param {String} database Database name
-      #
-      def create_database(database)
-        super(database)
-
-      rescue ActiveRecord::StatementInvalid, ActiveRecord::JDBCError
-        raise DatabaseExists, "The database #{environmentify(database)} already exists."
-      end
-
-      #   Connect to new database
-      #
-      #   @param {String} database Database name
-      #
-      def connect_to_new(database)
-        super(database)
-
-      rescue ActiveRecord::StatementInvalid, ActiveRecord::JDBCError
-        raise DatabaseNotFound, "The database #{environmentify(database)} cannot be found."
-      end
+    protected
 
       #   Return a new config that is multi-tenanted
       #
@@ -46,6 +11,11 @@ module Apartment
           config[:url] = "#{config[:url].gsub(/(\S+)\/.+$/, '\1')}/#{environmentify(database)}"
         end
       end
+    private
+
+      def rescue_from
+        ActiveRecord::JDBCError
+      end
     end
   end
-end
+end

data/lib/apartment/adapters/jdbc_postgresql_adapter.rb

@@ -1,5 +1,6 @@
-module Apartment
+require 'apartment/adapters/postgresql_adapter'
 
+module Apartment
   module Database
 
     def self.jdbc_postgresql_adapter(config)
@@ -12,91 +13,42 @@ module Apartment
   module Adapters
 
     # Default adapter when not using Postgresql Schemas
-    class JDBCPostgresqlAdapter < AbstractJDBCAdapter
+    class JDBCPostgresqlAdapter < PostgresqlAdapter
 
-      protected
-
-      #   Connect to new database
-      #   Abstract adapter will catch generic ActiveRecord error
-      #   Catch specific adapter errors here
-      #
-      #   @param {String} database Database name
-      #
-      def connect_to_new(database)
-        super(database)
-      rescue ActiveRecord::StatementInvalid, ActiveRecord::JDBCError
-        raise DatabaseNotFound, "Cannot find database #{environmentify(database)}"
-      end
+    protected
 
       def create_database(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 => '' })
 
-      rescue ActiveRecord::StatementInvalid, ActiveRecord::JDBCError
+      rescue *rescuable_exceptions
         raise DatabaseExists, "The database #{environmentify(database)} already exists."
       end
-    end
-
-    # Separate Adapter for Postgresql when using schemas
-    class JDBCPostgresqlSchemaAdapter < AbstractJDBCAdapter
-
-      #   Drop the database schema
-      #
-      #   @param {String} database Database (schema) to drop
-      #
-      def drop(database)
-        Apartment.connection.execute(%{DROP SCHEMA "#{database}" CASCADE})
-
-      rescue ActiveRecord::StatementInvalid, ActiveRecord::JDBCError
-        raise SchemaNotFound, "The schema #{database.inspect} cannot be found."
-      end
 
-      #   Reset search path to default search_path
-      #   Set the table_name to always use the default namespace for excluded models
+      #   Return a new config that is multi-tenanted
       #
-      def process_excluded_models
-        Apartment.excluded_models.each do |excluded_model|
-          # Note that due to rails reloading, we now take string references to classes rather than
-          # actual object references.  This way when we contantize, we always get the proper class reference
-          if excluded_model.is_a? Class
-            warn "[Deprecation Warning] Passing class references to excluded models is now deprecated, please use a string instead"
-            excluded_model = excluded_model.name
-          end
-
-          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
-
-            # Not sure why, but Delayed::Job somehow ignores table_name_prefix...  so we'll just manually set table name instead
-            klass.table_name = "#{Apartment.default_schema}.#{table_name}"
-          end
+      def multi_tenantify(database)
+        @config.clone.tap do |config|
+          config[:url] = "#{config[:url].gsub(/(\S+)\/.+$/, '\1')}/#{environmentify(database)}"
         end
       end
 
-      #   Reset schema search path to the default schema_search_path
-      #
-      #   @return {String} default schema search path
-      #
-      def reset
-        @current_database = Apartment.default_schema
-        Apartment.connection.schema_search_path = full_search_path
-      end
+    private
 
-      def current_database
-        @current_database || Apartment.default_schema
+      def rescue_from
+        ActiveRecord::JDBCError
       end
+    end
 
-      protected
+    # Separate Adapter for Postgresql when using schemas
+    class JDBCPostgresqlSchemaAdapter < PostgresqlSchemaAdapter
 
       #   Set schema search path to new schema
       #
       def connect_to_new(database = nil)
         return reset if database.nil?
+        raise ActiveRecord::StatementInvalid.new unless Apartment.connection.all_schemas.include? database.to_s
 
         @current_database = database.to_s
         Apartment.connection.schema_search_path = full_search_path
@@ -105,22 +57,10 @@ module Apartment
         raise SchemaNotFound, "One of the following schema(s) is invalid: #{full_search_path}"
       end
 
-      #   Create the new schema
-      #
-      def create_database(database)
-        Apartment.connection.execute(%{CREATE SCHEMA "#{database}"})
+    private
 
-      rescue ActiveRecord::StatementInvalid, ActiveRecord::JDBCError
-        raise SchemaExists, "The schema #{database} already exists."
-      end
-
-      private
-
-      #   Generate the final search path to set including persistent_schemas
-      #
-      def full_search_path
-        persistent_schemas = Apartment.persistent_schemas.join(', ')
-        @current_database.to_s + (persistent_schemas.empty? ? "" : ", #{persistent_schemas}")
+      def rescue_from
+        ActiveRecord::JDBCError
       end
     end
   end

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -14,20 +14,11 @@ module Apartment
     # Default adapter when not using Postgresql Schemas
     class PostgresqlAdapter < AbstractAdapter
 
-    protected
+    private
 
-      #   Connect to new database
-      #   Abstract adapter will catch generic ActiveRecord error
-      #   Catch specific adapter errors here
-      #
-      #   @param {String} database Database name
-      #
-      def connect_to_new(database)
-        super
-      rescue PGError
-        raise DatabaseNotFound, "Cannot find database #{environmentify(database)}"
+      def rescue_from
+        PGError
       end
-
     end
 
     # Separate Adapter for Postgresql when using schemas
@@ -40,7 +31,7 @@ module Apartment
       def drop(database)
         Apartment.connection.execute(%{DROP SCHEMA "#{database}" CASCADE})
 
-      rescue ActiveRecord::StatementInvalid
+      rescue *rescuable_exceptions
         raise SchemaNotFound, "The schema #{database.inspect} cannot be found."
       end
 
@@ -49,13 +40,6 @@ module Apartment
       #
       def process_excluded_models
         Apartment.excluded_models.each do |excluded_model|
-          # Note that due to rails reloading, we now take string references to classes rather than
-          # actual object references.  This way when we contantize, we always get the proper class reference
-          if excluded_model.is_a? Class
-            warn "[Deprecation Warning] Passing class references to excluded models is now deprecated, please use a string instead"
-            excluded_model = excluded_model.name
-          end
-
           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
@@ -89,11 +73,12 @@ module Apartment
       #
       def connect_to_new(database = nil)
         return reset if database.nil?
+        raise ActiveRecord::StatementInvalid.new unless Apartment.connection.schema_exists? database
 
         @current_database = database.to_s
         Apartment.connection.schema_search_path = full_search_path
 
-      rescue ActiveRecord::StatementInvalid
+      rescue *rescuable_exceptions
         raise SchemaNotFound, "One of the following schema(s) is invalid: #{full_search_path}"
       end
 
@@ -102,7 +87,7 @@ module Apartment
       def create_database(database)
         Apartment.connection.execute(%{CREATE SCHEMA "#{database}"})
 
-      rescue ActiveRecord::StatementInvalid
+      rescue *rescuable_exceptions
         raise SchemaExists, "The schema #{database} already exists."
       end
 
@@ -116,4 +101,4 @@ module Apartment
       end
     end
   end
-end
+end

data/lib/apartment/adapters/sqlite3_adapter.rb

@@ -0,0 +1,51 @@
+module Apartment
+  module Database
+    def self.sqlite3_adapter(config)
+      Adapters::Sqlite3Adapter.new(config)
+    end
+  end
+
+  module Adapters
+    class Sqlite3Adapter < AbstractAdapter
+      def initialize(config)
+        @default_dir = File.expand_path(File.dirname(config[:database]))
+
+        super
+      end
+
+      def drop(database)
+        raise DatabaseNotFound,
+          "The database #{environmentify(database)} cannot be found." unless File.exists?(database_file(database))
+
+        File.delete(database_file(database))
+      end
+
+      def current_database
+        File.basename(Apartment.connection.instance_variable_get(:@config)[:database], '.sqlite3')
+      end
+
+      protected
+
+      def connect_to_new(database)
+        raise DatabaseNotFound,
+          "The database #{environmentify(database)} cannot be found." unless File.exists?(database_file(database))
+
+        super database_file(database)
+      end
+
+      def create_database(database)
+        raise DatabaseExists,
+          "The database #{environmentify(database)} already exists." if File.exists?(database_file(database))
+
+        f = File.new(database_file(database), File::CREAT)
+        f.close
+      end
+
+      private
+
+      def database_file(database)
+        "#{@default_dir}/#{database}.sqlite3"
+      end
+    end
+  end
+end

data/lib/apartment/elevators/first_subdomain.rb

@@ -1,14 +1,15 @@
 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 db 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)
-        subdomain = super(request)
-        subdomain && subdomain.match(/(\w+)(\.\w+)?/)[1]
+        super.split('.')[0]
       end
-
     end
   end
 end

data/lib/apartment/version.rb

@@ -1,3 +1,3 @@
 module Apartment
-  VERSION = "0.21.0"
+  VERSION = "0.21.1"
 end

data/spec/adapters/sqlite3_adapter_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'apartment/adapters/sqlite3_adapter'
+
+describe Apartment::Adapters::Sqlite3Adapter do
+  unless defined?(JRUBY_VERSION)
+
+    let(:config){ Apartment::Test.config['connections']['sqlite'].symbolize_keys }
+    subject{ Apartment::Database.sqlite3_adapter config }
+
+    context "using connections" do
+      def database_names
+        db_dir = File.expand_path("../../dummy/db", __FILE__)
+        Dir.glob("#{db_dir}/*.sqlite3").map { |file| File.basename(file, '.sqlite3') }
+      end
+
+      let(:default_database) do
+        subject.process { File.basename(Apartment::Test.config['connections']['sqlite']['database'], '.sqlite3') }
+      end
+
+      it_should_behave_like "a generic apartment adapter"
+      it_should_behave_like "a connection based apartment adapter"
+
+      after(:all) do
+        File.delete(Apartment::Test.config['connections']['sqlite']['database'])
+      end
+    end
+  end
+end

data/spec/config/database.yml.sample

@@ -34,4 +34,8 @@ connections:
     database: apartment_mysql_test
     username: root
     password:
-<% end %>
+
+  sqlite:
+    adapter: sqlite3
+    database: <%= File.expand_path('../spec/dummy/db', __FILE__) %>/default.sqlite3
+<% end %>

data/spec/integration/delayed_job_integration_spec.rb

@@ -43,18 +43,28 @@ describe Apartment::Delayed do
         user.database.should == database
       end
 
-      it "should not overwrite any previous after_initialize declarations" do
-        User.class_eval do
-          after_find :set_name
+      context 'when there are defined callbacks' do
+        before do
+          User.class_eval do
+            after_find :set_name
+
+            def set_name
+              self.name = "Some Name"
+            end
+          end
+        end
 
-          def set_name
-            self.name = "Some Name"
+        after do
+          User.class_eval do
+            reset_callbacks :find
           end
         end
 
-        user = User.first
-        user.database.should == database
-        user.name.should == "Some Name"
+        it "should not overwrite any previous after_initialize declarations" do
+          user = User.first
+          user.database.should == database
+          user.name.should == "Some Name"
+        end
       end
 
       it "should set the db on a new record before it saves" do

data/spec/integration/query_caching_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe 'query caching' do
+  before do
+    Apartment.configure do |config|
+      config.excluded_models = ["Company"]
+      config.database_names = lambda{ Company.scoped.collect(&:database) }
+    end
+
+    db_names.each do |db_name|
+      Apartment::Database.create(db_name)
+      Company.create :database => db_name
+    end
+  end
+
+  after do
+    db_names.each{ |db| Apartment::Database.drop(db) }
+    Company.delete_all
+  end
+
+  let(:db_names) { 2.times.map{ Apartment::Test.next_db } }
+
+  it 'clears the ActiveRecord::QueryCache after switching databases' do
+    db_names.each do |db_name|
+      Apartment::Database.switch db_name
+      User.create! name: db_name
+    end
+
+    ActiveRecord::Base.connection.enable_query_cache!
+
+    Apartment::Database.switch db_names.first
+    User.find_by_name(db_names.first).name.should == db_names.first
+
+    Apartment::Database.switch db_names.last
+    User.find_by_name(db_names.first).should be_nil
+  end
+end

metadata

@@ -1,50 +1,51 @@
 --- !ruby/object:Gem::Specification
 name: apartment
 version: !ruby/object:Gem::Version
-  prerelease:
-  version: 0.21.0
+  version: 0.21.1
+  prerelease: 
 platform: ruby
 authors:
 - Ryan Brunner
 - Brad Robertson
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-25 00:00:00.000000000 Z
+date: 2013-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.1.2
-    none: false
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
   name: rack
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.3.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.3.6
-    none: false
-  prerelease: false
-  type: :runtime
-description: Apartment allows Rack applications to deal with database multitenancy through ActiveRecord
+description: Apartment allows Rack applications to deal with database multitenancy
+  through ActiveRecord
 email:
 - ryan@influitive.com
 - brad@influitive.com
@@ -52,12 +53,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".pryrc"
-- ".rspec"
-- ".rvmrc"
-- ".travis.yml"
-- ".vagrant"
+- .gitignore
+- .pryrc
+- .rspec
+- .rvmrc
+- .travis.yml
+- .vagrant
 - Cheffile
 - Cheffile.lock
 - Gemfile
@@ -75,6 +76,7 @@ files:
 - lib/apartment/adapters/mysql2_adapter.rb
 - lib/apartment/adapters/postgis_adapter.rb
 - lib/apartment/adapters/postgresql_adapter.rb
+- lib/apartment/adapters/sqlite3_adapter.rb
 - lib/apartment/console.rb
 - lib/apartment/database.rb
 - lib/apartment/delayed_job/enqueue.rb
@@ -100,6 +102,7 @@ files:
 - spec/adapters/jdbc_postgresql_adapter_spec.rb
 - spec/adapters/mysql2_adapter_spec.rb
 - spec/adapters/postgresql_adapter_spec.rb
+- spec/adapters/sqlite3_adapter_spec.rb
 - spec/apartment_spec.rb
 - spec/config/database.yml.sample
 - spec/database_spec.rb
@@ -148,6 +151,7 @@ files:
 - spec/integration/middleware/first_subdomain_elevator_spec.rb
 - spec/integration/middleware/generic_elevator_spec.rb
 - spec/integration/middleware/subdomain_elevator_spec.rb
+- spec/integration/query_caching_spec.rb
 - spec/spec_helper.rb
 - spec/support/apartment_helpers.rb
 - spec/support/capybara_sessions.rb
@@ -163,34 +167,32 @@ files:
 homepage: https://github.com/influitive/apartment
 licenses:
 - MIT
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
+      version: '0'
       segments:
       - 0
-      hash: 2
-      version: !binary |-
-        MA==
-  none: false
+      hash: 2789245529283699970
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
+      version: '0'
       segments:
       - 0
-      hash: 2
-      version: !binary |-
-        MA==
-  none: false
+      hash: 2789245529283699970
 requirements: []
-rubyforge_project:
-rubygems_version: 1.8.24
-signing_key:
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
 specification_version: 3
 summary: A Ruby gem for managing database multitenancy
 test_files:
@@ -198,6 +200,7 @@ test_files:
 - spec/adapters/jdbc_postgresql_adapter_spec.rb
 - spec/adapters/mysql2_adapter_spec.rb
 - spec/adapters/postgresql_adapter_spec.rb
+- spec/adapters/sqlite3_adapter_spec.rb
 - spec/apartment_spec.rb
 - spec/config/database.yml.sample
 - spec/database_spec.rb
@@ -246,6 +249,7 @@ test_files:
 - spec/integration/middleware/first_subdomain_elevator_spec.rb
 - spec/integration/middleware/generic_elevator_spec.rb
 - spec/integration/middleware/subdomain_elevator_spec.rb
+- spec/integration/query_caching_spec.rb
 - spec/spec_helper.rb
 - spec/support/apartment_helpers.rb
 - spec/support/capybara_sessions.rb