apartment 0.11.1 → 0.12.0

data/HISTORY.md

@@ -1,3 +1,11 @@
+# 0.12.0
+  * Oct 4, 2001
+  
+  - Added a `drop` method for removing databases/schemas
+  - Refactored abstract adapter to further remove duplication in concrete implementations
+  - Excluded models now take string references so they are properly reloaded in development
+  - Better silencing of `schema.rb` loading using `verbose` flag
+
 # 0.11.1
   * Sep 22, 2011
   

data/README.md

@@ -86,7 +86,9 @@ To set config options, add this to your initializer:
 If you have some models that should always access the 'root' database, you can specify this by configuring
 Apartment using `Apartment.configure`.  This will yield a config object for you.  You can set excluded models like so:
     
-    config.excluded_models = [User, Company]        # these models will not be multi-tenanted, but remain in the global (public) namespace
+    config.excluded_models = ["User", "Company"]        # these models will not be multi-tenanted, but remain in the global (public) namespace
+
+Note that a string representation of the model name is now the standard so that models are properly constantized when reloaded in development
     
 ### Handling Environments
 

data/lib/apartment.rb

@@ -55,6 +55,12 @@ module Apartment
   # Raised when apartment cannot find the adapter specified in <tt>config/database.yml</tt>
   class AdapterNotFound < ApartmentError; end
   
+  # Raised when database cannot find the specified database
+  class DatabaseNotFound < ApartmentError; end
+  
+  # Raised when trying to create a database that already exists
+  class DatabaseExists < ApartmentError; end
+  
   # Raised when database cannot find the specified schema
   class SchemaNotFound < ApartmentError; end
   

data/lib/apartment/adapters/abstract_adapter.rb

@@ -15,12 +15,12 @@ module Apartment
         @defaults = defaults
       end
       
-      #   Create new postgres schema
+      #   Create a new database, import schema, seed if appropriate
       # 
       #   @param {String} database Database name
       # 
   		def create(database)
-        ActiveRecord::Base.connection.execute("CREATE DATABASE #{environmentify(sanitize(database))}")
+  		  create_database(database)
 
   			process(database) do
     			import_database_schema
@@ -29,7 +29,7 @@ module Apartment
           seed_data if Apartment.seed_after_create
   			end
   		end
-    
+      
       #   Get the current database name
       #   
       #   @return {String} current database name
@@ -38,6 +38,27 @@ module Apartment
         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
+  		  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
@@ -56,11 +77,18 @@ module Apartment
       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|
-  				excluded_model.establish_connection @config
+  	      # 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
       
-      #   Reset the base connection
+      #   Reset the database connection to the default
       # 
       def reset
         ActiveRecord::Base.establish_connection @config
@@ -77,56 +105,67 @@ module Apartment
         connect_to_new(database)
   		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)
-        return "#{Rails.env}_#{database}" if Apartment.prepend_environment && !database.include?(Rails.env)
-        
-        database
-  		end
-  		
       #   Load the rails seed file into the db
       #   
   		def seed_data
-	      load_or_abort("#{Rails.root}/db/seeds.rb")
+  		  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
+        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)
-		  end
+        ActiveRecord::Base.connection.active?   # call active? to manually check if this connection is valid
+
+      rescue ActiveRecord::StatementInvalid => e
+        raise DatabaseNotFound, "The database #{environmentify(database)} cannot be found."
+  	  end
       
+      #   Import the database schema
+      # 
 	    def import_database_schema
+	      ActiveRecord::Schema.verbose = false    # do not log schema load output.  Note that this is slightly duplicated below with silenct_stream, except that this also works with Spork
 	      load_or_abort("#{Rails.root}/db/schema.rb")
 	    end
 	    
-	    # Return a new config that is multi-tenanted
+	    #   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)
-          # Don't log the output of loading files (such as schema or seeds)
-          silence_stream(STDOUT) do
-            load(file)
-          end
+          load(file)
         else
           abort %{#{file} doesn't exist yet}
         end
       end
       
-      
-      
-      # Remove all non-alphanumeric characters
+      #   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
       

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -14,37 +14,26 @@ module Apartment
     
     # Default adapter when not using Postgresql Schemas
     class PostgresqlAdapter < 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 PGError => e
+        raise DatabaseNotFound, "Cannot find database #{environmentify(database)}"
+		  end
+		  
     end
     
     # Separate Adapter for Postgresql when using schemas
     class PostgresqlSchemaAdapter < AbstractAdapter
       
-      #   Set schema path or connect to new db
-      # 
-	    def connect_to_new(database = nil)
-	      return reset if database.nil?
-    		ActiveRecord::Base.connection.schema_search_path = database
-    		
-      rescue ActiveRecord::StatementInvalid => e
-        raise SchemaNotFound, "The Schema #{database.inspect} cannot be found."
-			end
-			
-      #   Create a db schema
-      # 
-			def create(database)
-  		  ActiveRecord::Base.connection.execute("CREATE SCHEMA #{database}")
-
-  		  process(database) do
-    			import_database_schema
-
-          # Seed data if appropriate
-          seed_data if Apartment.seed_after_create
-  			end
-  			
-  		rescue ActiveRecord::StatementInvalid => e
-  		  raise SchemaExists, "The schema #{database} already exists."
-      end
-			
       #   Get the current schema search path
       # 
       #   @return {String} current schema search path
@@ -53,10 +42,21 @@ module Apartment
         ActiveRecord::Base.connection.schema_search_path
       end
       
+      #   Drop the database schema
+      # 
+      #   @param {String} database Database (schema) to drop
+      # 
+      def drop(database)
+        ActiveRecord::Base.connection.execute("DROP SCHEMA #{database} CASCADE")
+        
+      rescue ActiveRecord::StatementInvalid => e
+        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 public namespace for excluded models
       # 
       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
@@ -87,6 +87,27 @@ module Apartment
     		ActiveRecord::Base.connection.schema_search_path = @defaults[:schema_search_path]
   	  end
   	  
+  	protected
+  	
+  	  #   Set schema search path to new schema
+      # 
+	    def connect_to_new(database = nil)
+	      return reset if database.nil?
+    		ActiveRecord::Base.connection.schema_search_path = database
+    		
+      rescue ActiveRecord::StatementInvalid => e
+        raise SchemaNotFound, "The schema #{database.inspect} cannot be found."
+			end
+  	  
+      #   Create the new schema
+      # 
+  	  def create_database(database)
+  	    ActiveRecord::Base.connection.execute("CREATE SCHEMA #{database}")
+  	    
+  	  rescue ActiveRecord::StatementInvalid => e
+  		  raise SchemaExists, "The schema #{database} already exists."
+      end
+      
     end
     
   end

data/lib/apartment/railtie.rb

@@ -17,7 +17,7 @@ module Apartment
     
     #   Hook into ActionDispatch::Reloader to ensure Apartment is properly initialized
     #   Note that this doens't entirely work as expected in Development, because this is called before classes are reloaded
-    #   See the above middleware declaration to help with this.  Hope to fix that soon.
+    #   See the above middleware/console declarations below to help with this.  Hope to fix that soon.
     config.to_prepare do
       Apartment::Database.init
     end
@@ -30,7 +30,7 @@ module Apartment
     # Note this is technically valid for any environment where cache_classes is false, for us, it's just development
     if Rails.env.development?
       
-      # Apartment::Reloader is middleware to initialize things properly on each requestion dev
+      # Apartment::Reloader is middleware to initialize things properly on each request to dev
   		initializer 'apartment.init' do |app|
         app.config.middleware.use "Apartment::Reloader"
       end

data/lib/apartment/version.rb

@@ -1,3 +1,3 @@
 module Apartment
-  VERSION = "0.11.1"
+  VERSION = "0.12.0"
 end

data/spec/adapters/postgresql_adapter_spec.rb

@@ -15,6 +15,8 @@ describe Apartment::Adapters::PostgresqlAdapter do
   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 }
   
@@ -30,7 +32,7 @@ describe Apartment::Adapters::PostgresqlAdapter do
     describe "#create" do
       
       it "should create the new schema" do
-        ActiveRecord::Base.connection.execute("SELECT nspname FROM pg_namespace;").collect{|row| row['nspname']}.should include(schema)
+        database_names.should include(schema)
       end
     
       it "should load schema.rb to new schema" do
@@ -43,6 +45,24 @@ describe Apartment::Adapters::PostgresqlAdapter do
       end
     end
     
+    describe "#drop" do
+
+      it "should delete the database" do
+        subject.create schema2
+        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

data/spec/support/apartment_helpers.rb

@@ -9,7 +9,7 @@ module Apartment
     end
     
     def drop_schema(schema)
-      ActiveRecord::Base.silence{ ActiveRecord::Base.connection.execute("DROP SCHEMA IF EXISTS #{schema} CASCADE") }
+      ActiveRecord::Base.silence{ ActiveRecord::Base.connection.execute("DROP SCHEMA IF EXISTS #{schema} CASCADE") } rescue true
     end
     
     def create_schema(schema)

metadata

@@ -2,7 +2,7 @@
 name: apartment
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors: 
 - Ryan Brunner
@@ -226,7 +226,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3705726283453355884
+      hash: 1213020352034196308
       segments: 
       - 0
       version: "0"
@@ -235,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3705726283453355884
+      hash: 1213020352034196308
       segments: 
       - 0
       version: "0"