apartment 0.10.3 → 0.11.0

data/HISTORY.md

@@ -1,3 +1,8 @@
+# 0.11.0
+  * Sep 20, 2011
+  
+  - Excluded models no longer use a different connection when using postgresql schemas.  Instead their table_name is prefixed with `public.`
+
 # 0.10.3
   * Sep 20, 2011
   

data/lib/apartment.rb

@@ -1,4 +1,4 @@
-require 'apartment/railtie'
+require 'apartment/railtie' if defined?(Rails)
 
 module Apartment
   
@@ -65,11 +65,3 @@ module Apartment
   class DJSerializationError < ApartmentError; end
   
 end
-
-Apartment.configure do |config|
-  config.excluded_models = []
-  config.use_postgres_schemas = true
-  config.database_names = []
-  config.seed_after_create = false
-  config.prepend_environment = true
-end

data/lib/apartment/adapters/abstract_adapter.rb

@@ -15,20 +15,10 @@ module Apartment
         @defaults = defaults
       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)
-		    yield if block_given?
-		  ensure
-  		  switch(current_db)
-	    end
-      
       #   Create new postgres schema
       # 
       #   @param {String} database Database name
+      # 
   		def create(database)
         ActiveRecord::Base.connection.execute("CREATE DATABASE #{environmentify(sanitize(database))}")
 
@@ -40,12 +30,45 @@ module Apartment
   			end
   		end
     
+      #   Get the current database name
+      #   
+      #   @return {String} current database name
+      # 
+      def current_database
+        ActiveRecord::Base.connection.current_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)
+		    yield if block_given?
+		  ensure
+  		  switch(current_db)
+	    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|
+  				excluded_model.establish_connection @config
+  			end
+      end
+      
       #   Reset the base connection
+      # 
       def reset
         ActiveRecord::Base.establish_connection @config
       end
       
-      # Switch to new connection (or schema if appopriate)
+      #   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?
@@ -53,8 +76,12 @@ 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)
-        # prepend the environment if configured and the environment isn't already there
         return "#{Rails.env}_#{database}" if Apartment.prepend_environment && !database.include?(Rails.env)
         
         database
@@ -65,11 +92,6 @@ module Apartment
       end
 	    alias_method :seed, :seed_data
       
-      # Return the current database name
-      def current_database
-        ActiveRecord::Base.connection.current_database
-      end
-      
     protected
     
       def connect_to_new(database)
@@ -87,11 +109,6 @@ module Apartment
 			  end
   		end
       
-      # Remove all non-alphanumeric characters
-	    def sanitize(database)
-	      database.gsub(/[\W]/,'')
-      end
-      
       def load_or_abort(file)
         if File.exists?(file)
           # Don't log the output of loading files (such as schema or seeds)
@@ -103,6 +120,13 @@ module Apartment
         end
       end
       
+      
+      
+      # Remove all non-alphanumeric characters
+	    def sanitize(database)
+	      database.gsub(/[\W]/,'')
+      end
+      
     end
   end
 end

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -43,7 +43,28 @@ module Apartment
       def current_database
         ActiveRecord::Base.connection.schema_search_path
       end
+      
+      #   Set the table_name to always use the public namespace for excluded models
+      # 
+      def process_excluded_models
+		    
+  	    Apartment.excluded_models.each do |excluded_model|
+  	      # some models (such as delayed_job) seem to load and cache their column names before this, 
+          # so would never get the public prefix, so reset first
+  	      excluded_model.reset_column_information
+
+          # Ensure that if a schema *was* set, we override
+  	      table_name = excluded_model.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
+  				excluded_model.table_name = "public.#{table_name}"
+  			end
+      end
   	  
+      #   Reset schema search path to the default schema_search_path
+      # 
+      #   @return {String} default schema search path
+      # 
 			def reset
     		ActiveRecord::Base.connection.schema_search_path = @defaults[:schema_search_path]
   	  end

data/lib/apartment/database.rb

@@ -6,12 +6,12 @@ module Apartment
 	  class << self
 
       # pass these methods to our adapter
-      delegate :create, :switch, :reset, :process, :seed, :current_database, :to => :adapter
+      delegate :create, :current_database, :process, :process_excluded_models, :reset, :seed, :switch, :to => :adapter
 
       # Call init to establish a connection to the public schema on all excluded models
       # This must be done before creating any new schemas or switching
   	  def init
-  	    connect_exclusions
+        process_excluded_models
       end
       
       def adapter
@@ -39,14 +39,6 @@ module Apartment
       
 		private
 		
-		  def connect_exclusions
-		    # Establish a connection for each specific excluded model
-        # Thus 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
-  			end
-      end
-    
       def config
         @config ||= Rails.configuration.database_configuration[Rails.env].symbolize_keys
       end

data/lib/apartment/delayed_job/enqueue.rb

@@ -5,10 +5,10 @@ module Apartment
   module Delayed
     module Job
       
-      # Will enqueue a job ensuring that it happens within the public schema
-      # This is a work-around due to the fact that DJ for some reason always
-      # queues its jobs in the current_schema, rather than the public schema
-      # as it is supposed to
+      # Will enqueue a job ensuring that it happens within the main 'public' database
+      # 
+      # Note that this should not longer be required for versions >= 0.11.0 when using postgresql schemas
+      # 
       def self.enqueue(payload_object, options = {})
         Apartment::Database.process do
           ::Delayed::Job.enqueue(payload_object, options)

data/lib/apartment/railtie.rb

@@ -2,6 +2,22 @@ require 'rails'
 
 module Apartment
 	class Railtie < Rails::Railtie
+	  
+    # Ensure that active_record is loaded, then run default config
+	  initializer 'apartment.configure' do
+      # ActiveSupport.on_load(:active_record) do
+	    
+  	    Apartment.configure do |config|
+          config.excluded_models = []
+          config.use_postgres_schemas = true
+          config.database_names = []
+          config.seed_after_create = false
+          config.prepend_environment = true
+        end
+        
+      # end
+    end
+	  
 		rake_tasks do
 			load 'tasks/apartment.rake'
 		end

data/lib/apartment/version.rb

@@ -1,3 +1,3 @@
 module Apartment
-  VERSION = "0.10.3"
+  VERSION = "0.11.0"
 end

data/spec/integration/database_integration_spec.rb

@@ -25,11 +25,11 @@ describe Apartment::Database do
     describe "#init" do
       
       it "should process model exclusions" do
-        Company.should_receive(:establish_connection).with( config )
-        
         Apartment.configure do |config|
           config.excluded_models = [Company]
         end
+        
+        Company.table_name.should == "public.companies"
       end
       
     end
@@ -164,7 +164,7 @@ describe Apartment::Database do
           
           it "should ignore excluded models" do
             Apartment::Database.switch database
-            Company.connection.schema_search_path.should == @schema_search_path
+            Company.table_name.should include('public')
           end
           
           it "should create excluded models in public schema" do

metadata

@@ -2,7 +2,7 @@
 name: apartment
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.10.3
+  version: 0.11.0
 platform: ruby
 authors: 
 - Ryan Brunner
@@ -223,7 +223,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2467393586415245119
+      hash: -1056095168951008340
       segments: 
       - 0
       version: "0"
@@ -232,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2467393586415245119
+      hash: -1056095168951008340
       segments: 
       - 0
       version: "0"