apartment 0.11.0 → 0.11.1

data/HISTORY.md

@@ -1,3 +1,11 @@
+# 0.11.1
+  * Sep 22, 2011
+  
+  - Better use of Railties for initializing apartment
+  - The following changes were necessary as I haven't figured out how to properly hook into Rails reloading
+    - Added reloader middleware in development to init Apartment on each request
+    - Override `reload!` in console to also init Apartment
+
 # 0.11.0
   * Sep 20, 2011
   

data/lib/apartment.rb

@@ -9,7 +9,6 @@ module Apartment
     # configure apartment with available options
     def configure
       yield self if block_given?
-      Database.init
     end
     
     # Be careful not to use `return` here so both Proc and lambda can be used without breaking
@@ -30,6 +29,7 @@ module Apartment
   
   autoload :Database, 'apartment/database'
   autoload :Migrator, 'apartment/migrator'
+  autoload :Reloader, 'apartment/reloader'
   
   module Adapters
     autoload :AbstractAdapter, 'apartment/adapters/abstract_adapter'

data/lib/apartment/adapters/abstract_adapter.rb

@@ -46,6 +46,7 @@ module Apartment
         current_db = current_database
 		    switch(database)
 		    yield if block_given?
+		    
 		  ensure
   		  switch(current_db)
 	    end
@@ -87,6 +88,8 @@ module Apartment
         database
   		end
   		
+      #   Load the rails seed file into the db
+      #   
   		def seed_data
 	      load_or_abort("#{Rails.root}/db/seeds.rb")
       end

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -7,6 +7,7 @@ module Apartment
         Adapters::PostgresqlSchemaAdapter.new(config, :schema_search_path => ActiveRecord::Base.connection.schema_search_path) :
         Adapters::PostgresqlAdapter.new(config)
     end
+    
   end
   
   module Adapters
@@ -18,15 +19,18 @@ module Apartment
     # Separate Adapter for Postgresql when using schemas
     class PostgresqlSchemaAdapter < AbstractAdapter
       
-      # Set schema path or connect to new db
-      # TODO sanitize method doesn't work with schemas as the default schema uses "$user", stripping out the quotes makes it fail
+      #   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}")
 
@@ -36,10 +40,15 @@ module Apartment
           # 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
+      # 
       def current_database
         ActiveRecord::Base.connection.schema_search_path
       end
@@ -47,17 +56,26 @@ module Apartment
       #   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
+          # 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 public prefix, so reset first
+    	      klass.reset_column_information
 
-          # Ensure that if a schema *was* set, we override
-  	      table_name = excluded_model.table_name.split('.', 2).last
+            # 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
-  				excluded_model.table_name = "public.#{table_name}"
+            # Not sure why, but Delayed::Job somehow ignores table_name_prefix...  so we'll just manually set table name instead
+    				klass.table_name = "public.#{table_name}"
+  				end
   			end
       end
   	  

data/lib/apartment/console.rb

@@ -0,0 +1,12 @@
+# A workaraound to get `reload!` to also call Apartment::Database.init
+# This is unfortunate, but I haven't figured out how to hook into the reload process *after* files are reloaded
+
+# reloads the environment
+def reload!(print=true)
+  puts "Reloading..." if print
+  # This triggers the to_prepare callbacks
+  ActionDispatch::Callbacks.new(Proc.new {}, false).call({})
+  # Manually init Apartment again once classes are reloaded
+  Apartment::Database.init
+  true
+end

data/lib/apartment/database.rb

@@ -1,49 +1,57 @@
 require 'active_support/core_ext/module/delegation'
 
 module Apartment
+  
+  #   The main entry point to Apartment functions
 	module Database
 	  
-	  class << self
+	  extend self
 
-      # pass these methods to our adapter
-      delegate :create, :current_database, :process, :process_excluded_models, :reset, :seed, :switch, :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
-        process_excluded_models
-      end
-      
-      def adapter
-		    @adapter ||= begin
-  		    adapter_method = "#{config[:adapter]}_adapter"
-		    
-  		    begin
-            require "apartment/adapters/#{adapter_method}"
-          rescue LoadError => e
-            raise "The adapter `#{config[:adapter]}` is not yet supported"
-          end
+    #   Initialize Apartment config options such as excluded_models
+    # 
+	  def init
+      process_excluded_models
+    end
+    
+    #   Fetch the proper multi-tenant adapter based on Rails config
+    # 
+    #   @return {subclass of Apartment::AbstractAdapter}
+    # 
+    def adapter
+	    @adapter ||= begin
+		    adapter_method = "#{config[:adapter]}_adapter"
+	    
+		    begin
+          require "apartment/adapters/#{adapter_method}"
+        rescue LoadError => e
+          raise "The adapter `#{config[:adapter]}` is not yet supported"
+        end
 
-          unless respond_to?(adapter_method)
-            raise AdapterNotFound, "database configuration specifies nonexistent #{config[:adapter]} adapter"
-          end
-        
-          send(adapter_method, config)
+        unless respond_to?(adapter_method)
+          raise AdapterNotFound, "database configuration specifies nonexistent #{config[:adapter]} adapter"
         end
-	    end
-	    
-	    def reload!
-	      @adapter = nil
-	      @config = nil
-      end
       
-		private
-		
-      def config
-        @config ||= Rails.configuration.database_configuration[Rails.env].symbolize_keys
+        send(adapter_method, config)
       end
     end
-	    					
-	end
+    
+    #   Reset config and adapter so they are regenerated
+    # 
+    def reload!
+      @adapter = nil
+      @config = nil
+    end
+    
+	private
+	
+    #   Fetch the rails database configuration
+    # 
+    def config
+      @config ||= Rails.configuration.database_configuration[Rails.env].symbolize_keys
+    end
+    
+  end
 	
 end

data/lib/apartment/railtie.rb

@@ -3,23 +3,44 @@ 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
+    # Set up our default config options
+    # Do this before the app initializers run so we don't override custom settings
+	  config.before_initialize 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
+    
+    #   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.
+    config.to_prepare do
+      Apartment::Database.init
     end
 	  
 		rake_tasks do
 			load 'tasks/apartment.rake'
 		end
+		
+    # The following initializers are a workaround to the fact that I can't properly hook into the rails reloader
+    # 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
+  		initializer 'apartment.init' do |app|
+        app.config.middleware.use "Apartment::Reloader"
+      end
+    
+      # Overrides reload! to also call Apartment::Database.init as well so that the reloaded classes have the proper table_names
+      console do
+        require 'apartment/console'
+      end
+      
+    end
+    
 	end
 end

data/lib/apartment/reloader.rb

@@ -0,0 +1,23 @@
+module Apartment
+  
+  class Reloader
+    
+    #   Middleware used in development to init Apartment for each request
+    #   Necessary due to code reload (annoying).  I couldn't figure out how to properly hook into
+    #   the Rails reload process *after* files are reloaded, so I've used this in the meantime.
+    # 
+    #   Note that this has one MAJOR caveat.  Doing  `reload!` in the console in development WILL NOT run init again
+    #   Thus, excluded models will not be processed again and will be queried from the current_schema rather than public.  
+    #   I hope to fix this soon
+	  def initialize(app)
+	    @app = app
+    end
+    
+    def call(env)
+      Database.init
+      @app.call(env)
+    end
+	  
+  end
+  
+end

data/lib/apartment/version.rb

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

data/spec/integration/database_integration_spec.rb

@@ -29,6 +29,8 @@ describe Apartment::Database do
           config.excluded_models = [Company]
         end
         
+        Apartment::Database.init
+        
         Company.table_name.should == "public.companies"
       end
       
@@ -158,8 +160,11 @@ describe Apartment::Database do
         
         context "with excluded models" do
           
-          Apartment.configure do |config|
-            config.excluded_models = [Company]
+          before do
+            Apartment.configure do |config|
+              config.excluded_models = [Company]
+            end
+            Apartment::Database.init
           end
           
           it "should ignore excluded models" do

data/spec/spec_helper.rb

@@ -23,8 +23,8 @@ RSpec.configure do |config|
   config.include RSpec::Integration::CapybaraSessions, :type => :request
   
   config.before(:all) do
-    # Ensure that each test starts with a clean connect
-    # Necessary as some tests will leak things like current_schema into the next
+    # Ensure that each test starts with a clean connection
+    # Necessary as some tests will leak things like current_schema into the next test
     ActiveRecord::Base.clear_all_connections!
   end
   

data/spec/support/apartment_helpers.rb

@@ -4,7 +4,6 @@ module Apartment
     extend self
     
     def reset
-      Apartment::Database.instance_variable_set :@initialized, nil
       Apartment.excluded_models = nil
       Apartment.use_postgres_schemas = nil
     end
@@ -29,11 +28,5 @@ module Apartment
       ActiveRecord::Migrator.rollback(Rails.root + ActiveRecord::Migrator.migrations_path)
     end
     
-    private
-    
-    def sanitize(database)
-      database.gsub(/[\W]/,'')
-    end
-    
   end
 end

data/spec/unit/config_spec.rb

@@ -17,11 +17,6 @@ describe Apartment do
       end
     end
     
-    it "should initialize Database" do
-      Apartment::Database.should_receive(:init).once
-      Apartment.configure
-    end 
-    
     it "should set excluded models" do
       Apartment.configure do |config|
         config.excluded_models = excluded_models
@@ -44,7 +39,6 @@ describe Apartment do
       end
       Apartment.seed_after_create.should be_true
     end
-      
     
     context "databases" do
       it "should return object if it doesnt respond_to call" do

data/spec/unit/reloader_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Apartment::Reloader do
+  
+  context "using postgresql schemas" do
+    
+    before do
+      Apartment.excluded_models = ["Company"]
+      Company.reset_table_name  # ensure we're clean
+    end
+    
+    subject{ Apartment::Reloader.new(mock("Rack::Application", :call => nil)) }
+    
+    it "should initialize apartment when called" do
+      Company.table_name.should_not include('public.')
+      subject.call(mock('env'))
+      Company.table_name.should include('public.')
+    end
+  end
+  
+  
+end

metadata

@@ -2,7 +2,7 @@
 name: apartment
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.11.0
+  version: 0.11.1
 platform: ruby
 authors: 
 - Ryan Brunner
@@ -147,6 +147,7 @@ files:
 - lib/apartment/adapters/abstract_adapter.rb
 - lib/apartment/adapters/mysql_adapter.rb
 - lib/apartment/adapters/postgresql_adapter.rb
+- lib/apartment/console.rb
 - lib/apartment/database.rb
 - lib/apartment/delayed_job/active_record.rb
 - lib/apartment/delayed_job/enqueue.rb
@@ -155,6 +156,7 @@ files:
 - lib/apartment/elevators/subdomain.rb
 - lib/apartment/migrator.rb
 - lib/apartment/railtie.rb
+- lib/apartment/reloader.rb
 - lib/apartment/version.rb
 - lib/tasks/apartment.rake
 - spec/adapters/mysql_adapter_spec.rb
@@ -209,6 +211,7 @@ files:
 - spec/unit/config_spec.rb
 - spec/unit/middleware/subdomain_elevator_spec.rb
 - spec/unit/migrator_spec.rb
+- spec/unit/reloader_spec.rb
 has_rdoc: true
 homepage: http://github.com/bradrobertson/apartment
 licenses: 
@@ -223,7 +226,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1056095168951008340
+      hash: 3705726283453355884
       segments: 
       - 0
       version: "0"
@@ -232,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1056095168951008340
+      hash: 3705726283453355884
       segments: 
       - 0
       version: "0"