apartment 0.14.4 → 0.15.0

data/HISTORY.md

@@ -1,3 +1,8 @@
+# 0.15.0
+  * March 18, 2012
+
+  - Remove Rails dependency, Apartment can now be used with any Rack based framework using ActiveRecord
+
 # 0.14.4
   * March 8, 2012
 

data/README.md

@@ -1,5 +1,5 @@
 # Apartment
-*Multitenancy for Rails 3*
+*Multitenancy for Rails 3 and ActiveRecord*
 
 Apartment provides tools to help you deal with multiple databases in your Rails
 application. If you need to have certain data sequestered based on account or company,
@@ -19,7 +19,6 @@ on a per-user basis, look under "Usage - Switching databases per request", below
 
 > NOTE: If using [postgresl schemas](http://www.postgresql.org/docs/9.0/static/ddl-schemas.html) you must use:
 >
-> * for Rails 3.0.x: _Rails ~> 3.0.10_, it contains a [patch](https://github.com/rails/rails/pull/1607) that has better postgresql schema support
 > * for Rails 3.1.x: _Rails ~> 3.1.2_, it contains a [patch](https://github.com/rails/rails/pull/3232) that makes prepared statements work with multiple schemas
 
 ## Usage
@@ -157,8 +156,4 @@ In order to make ActiveRecord models play nice with DJ and Apartment, include `A
 * The Local setup for development assumes that a root user with no password exists for both mysql and postgresl
 * Rake tasks (see the Rakefile) will help you setup your dbs necessary to run tests
 * Please issue pull requests to the `development` branch.  All development happens here, master is used for releases
-* Ensure that your code is accompanied with tests.  No code will be merged without tests
-
-## TODO
-
-* Shared examples for testing to ensure consistency across all adapters
+* Ensure that your code is accompanied with tests.  No code will be merged without tests

data/apartment.gemspec

@@ -17,16 +17,18 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
-
-  s.add_dependency 'rails', '>= 3.1.2'
+  
+  s.add_dependency 'activerecord',    '>= 3.1.2'   # must be >= 3.1.2 due to bug in prepared_statements
+  s.add_dependency 'rack',            '~> 1.4.0'
+  
+  s.add_development_dependency 'rails', '>= 3.1.2'
   s.add_development_dependency 'rake', '~> 0.9.2'
   s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'rspec', '~> 2.8.0'
-  s.add_development_dependency 'rspec-rails', '~> 2.8.0'
-  s.add_development_dependency 'capybara', '1.0.0'
-  s.add_development_dependency 'pg', '~> 0.11.0'
-  s.add_development_dependency 'mysql2', '~> 0.3.7'
-  s.add_development_dependency "silent-postgres", "~> 0.1.1"
-  s.add_development_dependency 'delayed_job', '~> 3.0.1'
+  s.add_development_dependency 'rspec-rails', '~> 2.8.1'
+  s.add_development_dependency 'capybara', '~> 1.0.0'
+  s.add_development_dependency 'pg', '>= 0.11.0'
+  s.add_development_dependency 'mysql2', '~> 0.3.10'
+  s.add_development_dependency 'delayed_job', '~> 3.0'
   s.add_development_dependency 'delayed_job_active_record'
 end

data/lib/apartment.rb

@@ -16,7 +16,7 @@ module Apartment
       @database_names.respond_to?(:call) ? @database_names.call : @database_names
     end
 
-    # Default to none
+    # Default to empty array
     def excluded_models
       @excluded_models || []
     end

data/lib/apartment/adapters/abstract_adapter.rb

@@ -1,24 +1,24 @@
 require 'active_record'
 
 module Apartment
-  
+
   module Adapters
-  
+
     class AbstractAdapter
-      
+
       #   @constructor
       #   @param {Hash} config Database config
       #   @param {Hash} defaults Some default options
-      # 
+      #
       def initialize(config, defaults = {})
         @config = config
         @defaults = defaults
       end
-      
+
       #   Create a new database, import schema, seed if appropriate
-      # 
+      #
       #   @param {String} database Database name
-      # 
+      #
       def create(database)
         create_database(database)
 
@@ -27,44 +27,35 @@ module Apartment
 
           # Seed data if appropriate
           seed_data if Apartment.seed_after_create
-          
+
           yield if block_given?
         end
       end
-      
+
       #   Get the current database name
-      #   
+      #
       #   @return {String} current database name
-      # 
+      #
       def current_database
         ActiveRecord::Base.connection.current_database
       end
-      
+
       #   Drop the database
-      # 
+      #
       #   @param {String} database Database name
-      # 
+      #
       def drop(database)
         # ActiveRecord::Base.connection.drop_database   note that drop_database will not throw an exception, so manually execute
         ActiveRecord::Base.connection.execute("DROP DATABASE #{environmentify(database)}" )
-        
-      rescue ActiveRecord::StatementInvalid => e
+
+      rescue ActiveRecord::StatementInvalid
         raise DatabaseNotFound, "The database #{environmentify(database)} cannot be found"
       end
-      
-      #   Prepend the environment if configured and the environment isn't already there
-      # 
-      #   @param {String} database Database name
-      #   @return {String} database name with Rails environment *optionally* prepended
-      # 
-      def environmentify(database)
-        Apartment.prepend_environment && !database.include?(Rails.env) ? "#{Rails.env}_#{database}" : database
-      end
 
       #   Connect to db, do your biz, switch back to previous db
-      # 
+      #
       #   @param {String?} database Database or schema to connect to
-      # 
+      #
       def process(database = nil)
         current_db = current_database
         switch(database)
@@ -75,7 +66,7 @@ module Apartment
       end
 
       #   Establish a new connection for each specific excluded model
-      # 
+      #
       def process_excluded_models
         # All other models will shared a connection (at ActiveRecord::Base) and we can modify at will
         Apartment.excluded_models.each do |excluded_model|
@@ -85,21 +76,21 @@ module Apartment
             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
-      
+
       #   Reset the database connection to the default
-      # 
+      #
       def reset
         ActiveRecord::Base.establish_connection @config
       end
-      
+
       #   Switch to new connection (or schema if appopriate)
-      # 
+      #
       #   @param {String} database Database name
-      # 
+      #
       def switch(database = nil)
         # Just connect to default db and return
         return reset if database.nil?
@@ -108,54 +99,63 @@ module Apartment
       end
 
       #   Load the rails seed file into the db
-      #   
+      #
       def seed_data
         silence_stream(STDOUT){ load_or_abort("#{Rails.root}/db/seeds.rb") } # Don't log the output of seeding the db
       end
       alias_method :seed, :seed_data
-      
+
     protected
-    
+
       #   Create the database
-      # 
+      #
       #   @param {String} database Database name
-      # 
+      #
       def create_database(database)
         ActiveRecord::Base.connection.create_database( environmentify(database) )
 
-      rescue ActiveRecord::StatementInvalid => e
+      rescue ActiveRecord::StatementInvalid
         raise DatabaseExists, "The database #{environmentify(database)} already exists."
       end
-  
+
       #   Connect to new database
-      # 
+      #
       #   @param {String} database Database name
-      # 
+      #
       def connect_to_new(database)
         ActiveRecord::Base.establish_connection multi_tenantify(database)
         ActiveRecord::Base.connection.active?   # call active? to manually check if this connection is valid
 
-      rescue ActiveRecord::StatementInvalid => e
+      rescue ActiveRecord::StatementInvalid
         raise DatabaseNotFound, "The database #{environmentify(database)} cannot be found."
       end
-      
+
+      #   Prepend the environment if configured and the environment isn't already there
+      #
+      #   @param {String} database Database name
+      #   @return {String} database name with Rails environment *optionally* prepended
+      #
+      def environmentify(database)
+        Apartment.prepend_environment && !database.include?(Rails.env) ? "#{Rails.env}_#{database}" : database
+      end
+
       #   Import the database schema
-      # 
+      #
       def import_database_schema
         ActiveRecord::Schema.verbose = false    # do not log schema load output.
         load_or_abort("#{Rails.root}/db/schema.rb")
       end
-      
+
       #   Return a new config that is multi-tenanted
-      # 
+      #
       def multi_tenantify(database)
         @config.clone.tap do |config|
           config[:database] = environmentify(database)
         end
       end
-      
+
       #   Load a file or abort if it doesn't exists
-      # 
+      #
       def load_or_abort(file)
         if File.exists?(file)
           load(file)
@@ -163,14 +163,7 @@ module Apartment
           abort %{#{file} doesn't exist yet}
         end
       end
-      
-      #   Remove all non-alphanumeric characters
-      # 
-      def sanitize(database)
-        warn "[Deprecation Warning] Sanitize is no longer used, client should ensure proper database names"
-        database.gsub(/[\W]/,'')
-      end
-      
+
     end
   end
 end

data/lib/apartment/adapters/mysql_adapter.rb

@@ -2,7 +2,7 @@ module Apartment
 
   module Database
     
-    def self.mysql_adapter(config)
+    def self.mysql2_adapter(config)
       Adapters::MysqlAdapter.new config
     end
   end
@@ -11,8 +11,19 @@ module Apartment
   
     class MysqlAdapter < AbstractAdapter
       
+    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
+      rescue Mysql2::Error
+        raise DatabaseNotFound, "Cannot find database #{environmentify(database)}"
+      end
     end
-    
   end
-  
 end

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -7,7 +7,6 @@ module Apartment
         Adapters::PostgresqlSchemaAdapter.new(config, :schema_search_path => ActiveRecord::Base.connection.schema_search_path) :
         Adapters::PostgresqlAdapter.new(config)
     end
-
   end
 
   module Adapters
@@ -47,7 +46,7 @@ module Apartment
       #   @param {String} database Database (schema) to drop
       #
       def drop(database)
-        ActiveRecord::Base.connection.execute("DROP SCHEMA #{database} CASCADE")
+        ActiveRecord::Base.connection.execute("DROP SCHEMA \"#{database}\" CASCADE")
 
       rescue ActiveRecord::StatementInvalid
         raise SchemaNotFound, "The schema #{database.inspect} cannot be found."
@@ -102,13 +101,12 @@ module Apartment
       #   Create the new schema
       #
       def create_database(database)
-        ActiveRecord::Base.connection.execute("CREATE SCHEMA #{database}")
+        ActiveRecord::Base.connection.execute("CREATE SCHEMA \"#{database}\"")
 
       rescue ActiveRecord::StatementInvalid
         raise SchemaExists, "The schema #{database} already exists."
       end
 
     end
-
   end
 end

data/lib/apartment/railtie.rb

@@ -13,7 +13,7 @@ module Apartment
         config.use_postgres_schemas = true
         config.database_names = []
         config.seed_after_create = false
-        config.prepend_environment = true
+        config.prepend_environment = false
       end
     end
 

data/lib/apartment/version.rb

@@ -1,3 +1,3 @@
 module Apartment
-  VERSION = "0.14.4"
+  VERSION = "0.15.0"
 end

data/spec/adapters/mysql_adapter_spec.rb

@@ -1,36 +1,17 @@
 require 'spec_helper'
-require 'apartment/adapters/mysql_adapter'   # specific adapters get dynamically loaded based on adapter name, so we must manually require here
+require 'apartment/adapters/mysql_adapter'
 
 describe Apartment::Adapters::MysqlAdapter do
   
-  before do
-    ActiveRecord::Base.establish_connection Apartment::Test.config['connections']['mysql']
-    @mysql = Apartment::Database.mysql_adapter Apartment::Test.config['connections']['mysql'].symbolize_keys
-  end
-  
-  after do
-    ActiveRecord::Base.clear_all_connections!
-  end
+  let(:config){ Apartment::Test.config['connections']['mysql'] }
+  subject{ Apartment::Database.mysql2_adapter config.symbolize_keys }
   
-  context "using databases" do
-    
-    let(:database1){ 'first_database' }
-    
-    before do
-      @mysql.create(database1)
-    end
-  
-    after do
-      ActiveRecord::Base.connection.drop_database(@mysql.environmentify(database1))
-    end
-
-    describe "#create" do
-      it "should create the new database" do
-        ActiveRecord::Base.connection.execute("SELECT schema_name FROM information_schema.schemata").collect{|row| row[0]}.should include(@mysql.environmentify(database1))
-      end
-    end
-
+  def database_names
+    ActiveRecord::Base.connection.execute("SELECT schema_name FROM information_schema.schemata").collect{|row| row[0]}
   end
   
+  let(:default_database){ subject.process{ ActiveRecord::Base.connection.current_database } }
   
+  it_should_behave_like "a generic apartment adapter"
+  it_should_behave_like "a db based apartment adapter"
 end

data/spec/adapters/postgresql_adapter_spec.rb

@@ -1,137 +1,38 @@
 require 'spec_helper'
-require 'apartment/adapters/postgresql_adapter'   # specific adapters get dynamically loaded based on adapter name, so we must manually require here
+require 'apartment/adapters/postgresql_adapter'
 
 describe Apartment::Adapters::PostgresqlAdapter do
 
-  before do
-    ActiveRecord::Base.establish_connection Apartment::Test.config['connections']['postgresql']
-    @schema_search_path = ActiveRecord::Base.connection.schema_search_path
-  end
-
-  after do
-    ActiveRecord::Base.clear_all_connections!
-  end
+  let(:config){ Apartment::Test.config['connections']['postgresql'] }
+  subject{ Apartment::Database.postgresql_adapter config.symbolize_keys }
 
   context "using schemas" do
 
-    let(:schema){ 'first_db_schema' }
-    let(:schema2){ 'another_db_schema' }
-    let(:database_names){ ActiveRecord::Base.connection.execute("SELECT nspname FROM pg_namespace;").collect{|row| row['nspname']} }
-
-    subject{ Apartment::Database.postgresql_adapter Apartment::Test.config['connections']['postgresql'].symbolize_keys }
-
-    before do
-      Apartment.use_postgres_schemas = true
-      subject.create(schema)
-      subject.create(schema2)
-    end
-
-    after do
-      # sometimes we manually drop these schemas in testing, dont' care if we can't drop hence rescue
-      subject.drop(schema) rescue true
-      subject.drop(schema2) rescue true
-    end
-
-    describe "#create" do
-
-      it "should create the new schema" do
-        database_names.should include(schema)
-      end
-
-      it "should load schema.rb to new schema" do
-        ActiveRecord::Base.connection.schema_search_path = schema
-        ActiveRecord::Base.connection.tables.should include('companies')
-      end
-
-      it "should reset connection when finished" do
-        ActiveRecord::Base.connection.schema_search_path.should_not == schema
-      end
-
-      it "should yield to block if passed" do
-        subject.drop(schema2) # so we don't get errors on creation
-
-        @count = 0  # set our variable so its visible in and outside of blocks
-
-        subject.create(schema2) do
-          @count = User.count
-          ActiveRecord::Base.connection.schema_search_path.should == schema2
-          User.create
-        end
-
-        subject.process(schema2){ User.count.should == @count + 1 }
-      end
-    end
-
-    describe "#drop" do
-
-      it "should delete the database" do
-        subject.switch schema    # can't drop db we're currently connected to, ensure these are different
-        subject.drop schema2
-
-        database_names.should_not include(schema2)
-      end
-
-      it "should raise an error for unkown database" do
-        expect {
-          subject.drop "unknown_database"
-        }.to raise_error(Apartment::SchemaNotFound)
-      end
-    end
-
-
-    describe "#process" do
-      it "should connect" do
-        subject.process(schema) do
-          ActiveRecord::Base.connection.schema_search_path.should == schema
-        end
-      end
-
-      it "should reset" do
-        subject.process(schema)
-        ActiveRecord::Base.connection.schema_search_path.should == @schema_search_path
-      end
-
-      # We're often finding when using Apartment in tests, the `current_database` (ie the previously attached to schema)
-      # gets dropped, but process will try to return to that schema in a test.  We should just reset if it doesnt exist
-      it "should not throw exception if current_database (schema) is no longer accessible" do
-        subject.switch(schema2)
+    before{ Apartment.use_postgres_schemas = true }
 
-        expect {
-          subject.process(schema){ subject.drop(schema2) }
-        }.to_not raise_error(Apartment::SchemaNotFound)
-      end
+    # Not sure why, but somehow using let(:database_names) memoizes for the whole example group, not just each test
+    def database_names
+      ActiveRecord::Base.connection.execute("SELECT nspname FROM pg_namespace;").collect{|row| row['nspname']}
     end
+    
+    let(:default_database){ subject.process{ ActiveRecord::Base.connection.schema_search_path } }
 
-    describe "#reset" do
-      it "should reset connection" do
-        subject.switch(schema)
-        subject.reset
-        ActiveRecord::Base.connection.schema_search_path.should == @schema_search_path
-      end
-    end
-
-    describe "#switch" do
-      it "should connect to new schema" do
-        subject.switch(schema)
-        ActiveRecord::Base.connection.schema_search_path.should == schema
-      end
+    it_should_behave_like "a generic apartment adapter"
+    it_should_behave_like "a schema based apartment adapter"
+  end
+  
+  context "using databases" do
 
-      it "should reset connection if database is nil" do
-        subject.switch
-        ActiveRecord::Base.connection.schema_search_path.should == @schema_search_path
-      end
-    end
+    before{ Apartment.use_postgres_schemas = false }  
 
-    describe "#current_database" do
-      it "should return the current schema name" do
-        subject.switch(schema)
-        subject.current_database.should == schema
-      end
+    # Not sure why, but somehow using let(:database_names) memoizes for the whole example group, not just each test
+    def database_names
+      connection.execute("select datname from pg_database;").collect{|row| row['datname']}
     end
+    
+    let(:default_database){ subject.process{ ActiveRecord::Base.connection.current_database } }
 
-  end
-
-  context "using databases" do
-    # TODO
+    it_should_behave_like "a generic apartment adapter"
+    it_should_behave_like "a db based apartment adapter"
   end
 end