apartment 0.9.2 → 0.10.0

data/HISTORY.md

@@ -1,3 +1,10 @@
+# 0.10.0
+  * July 29, 2001
+  
+  - Added better support for Delayed Job
+  - New config option that enables Delayed Job wrappers
+  - Note that DJ support uses a work-around in order to get queues stored in the public schema, not sure why it doesn't work out of the box, will look into it, until then, see documentation on queue'ng jobs
+  
 # 0.9.2
   * July 4, 2011
   

data/README.md

@@ -104,6 +104,30 @@ You can then migration your databases using the rake task:
 This basically invokes `Apartment::Database.migrate(#{db_name})` for each database name supplied
 from `Apartment.database_names`
 
+### Delayed::Job
+
+In Apartment's current state, it doesn't seem to queue jobs properly using DJ.  For whatever reason, DJ jobs are created in the current schema, even though the DJ 
+is part of the ignored models.  I have to look into this further, but until then use `Apartment::Delayed::Job.enqueue` to ensure that queues are placed in the public schema
+
+In order to make ActiveRecord models play nice with DJ and Apartment, include `Apartment::Delayed::Requirements` in any model that is being serialized by DJ.  Also ensure
+that a `database` attribute is set on this model *before* it is serialized, to ensure that when it is fetched again, it is done so in the proper Apartment db context.  For example:
+
+    class SomeModel < ActiveRecord::Base
+      include Apartment::Delayed::Requirements
+    end
+
+    class SomeDJ
+  
+      def initialize(model)
+        @model = model
+        @model.database = Apartment::Database.current_database
+      end
+  
+      def perform
+        # do some stuff
+      end
+    end
+
 ## TODO
 
 * Cross-database associations

data/apartment.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'capybara', '1.0.0'
   s.add_development_dependency 'pg', '~> 0.11.0'
   s.add_development_dependency "silent-postgres", "~> 0.0.8"
+  s.add_development_dependency 'delayed_job', '~> 2.1.4'
 end

data/lib/apartment.rb

@@ -41,6 +41,9 @@ module Apartment
   end
   
   module Delayed
+    
+    autoload :Requirements, 'apartment/delayed_job/requirements'
+    
     module Job
       autoload :Hooks, 'apartment/delayed_job/hooks'
     end
@@ -58,6 +61,9 @@ module Apartment
   # Raised when trying to create a schema that already exists
   class SchemaExists < ApartmentError; end
   
+  # Raised when an ActiveRecord object does not have the required database field on it
+  class DJSerializationError < ApartmentError; end
+  
 end
 
 Apartment.configure do |config|

data/lib/apartment/adapters/abstract_adapter.rb

@@ -15,14 +15,15 @@ module Apartment
         @defaults = defaults
       end
       
-      #   Connect to db or schema, do stuff, reset (equivalent to a switch... do stuff... reset)
+      #   Connect to db or schema, do stuff, switch back to previous db/schema (equivalent to a switch... do stuff... switch back)
       # 
-      #   @param {String} database Database or schema to connect to
-      def process(database)
-		    connect_to_new(database)
+      #   @param {String?} database Database or schema to connect to, will reset if no database passed in
+      def process(database = nil)
+        current_db = current_database
+		    switch(database)
 		    yield if block_given?
 		  ensure
-  		  reset
+  		  switch(current_db)
 	    end
       
       #   Create new postgres schema
@@ -65,48 +66,45 @@ module Apartment
         ActiveRecord::Base.connection.current_database
       end
       
-      protected
-      
-        def create_schema
-          # noop
-        end
+    protected
+    
+      def create_schema
+        # noop
+      end
+    
+      def connect_to_new(database)
+        ActiveRecord::Base.establish_connection multi_tenantify(database)
+		  end
       
-        def connect_to_new(database)
-          ActiveRecord::Base.establish_connection multi_tenantify(database)
+	    def import_database_schema
+	      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'].gsub!(Rails.env.to_s, "#{database}_#{Rails.env}")
 			  end
-        
-  	    def import_database_schema
-  	      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'].gsub!(Rails.env.to_s, "#{database}_#{Rails.env}")
-  			  end
-    		end
-        
-        # Remove all non-alphanumeric characters
-  	    def sanitize(database)
-  	      database.gsub(/[\W]/,'')
-        end
-        
-        # Whether or not to use postgresql schemas
-        def using_schemas?
-          false
-        end
-        
-        def load_or_abort(file)
-          if File.exists?(file)
-            load(file)
-          else
-            abort %{#{file} doesn't exist yet}
-          end
-        end
+  		end
       
-    end
+      # Remove all non-alphanumeric characters
+	    def sanitize(database)
+	      database.gsub(/[\W]/,'')
+      end
       
+      # Whether or not to use postgresql schemas
+      def using_schemas?
+        false
+      end
       
-  
+      def load_or_abort(file)
+        if File.exists?(file)
+          load(file)
+        else
+          abort %{#{file} doesn't exist yet}
+        end
+      end
+      
+    end
   end
 end

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -14,7 +14,8 @@ module Apartment
       # Set schema path or connect to new db
 	    def connect_to_new(database)	      
     		return ActiveRecord::Base.connection.schema_search_path = database if using_schemas?
-			  super
+
+			  super # if !using_schemas? (implicit)
       rescue ActiveRecord::StatementInvalid => e
         raise SchemaNotFound, e
 			end
@@ -28,27 +29,29 @@ module Apartment
 			
 			def reset
     		return ActiveRecord::Base.connection.schema_search_path = @defaults[:schema_search_path] if using_schemas?
-		    super
+
+		    super # if !using_schemas?
   	  end
   	  
   	  def current_database
   	    return ActiveRecord::Base.connection.schema_search_path if using_schemas?
-  	    super
+  	    
+  	    super # if !using_schemas?
 	    end
       
-      protected
-      
-        def create_schema(database)
-    		  reset
-    		  
-    		  ActiveRecord::Base.connection.execute("CREATE SCHEMA #{sanitize(database)}")
-    		rescue Exception => e
-    		  raise SchemaExists, e
-    	  end
+    protected
+    
+      def create_schema(database)
+  		  reset
+  		  
+  		  ActiveRecord::Base.connection.execute("CREATE SCHEMA #{sanitize(database)}")
+  		rescue Exception => e
+  		  raise SchemaExists, e
+  	  end
 
-        def using_schemas?
-          Apartment.use_postgres_schemas
-        end
+      def using_schemas?
+        Apartment.use_postgres_schemas
+      end
 			
     end
     

data/lib/apartment/delayed_job/active_record.rb

@@ -0,0 +1,20 @@
+module ActiveRecord
+  class Base
+    
+    # Overriding Delayed Job's monkey_patch of ActiveRecord so that it works with Apartment
+    yaml_as "tag:ruby.yaml.org,2002:ActiveRecord"
+    
+    def self.yaml_new(klass, tag, val)
+      Apartment::Database.process(val['database']) do
+        klass.find(val['attributes']['id'])
+      end
+    rescue ActiveRecord::RecordNotFound
+      raise Delayed::DeserializationError
+    end
+    
+    def to_yaml_properties
+      ['@attributes', '@database']    # add in database attribute for serialization
+    end
+    
+  end
+end

data/lib/apartment/delayed_job/enqueue.rb

@@ -0,0 +1,20 @@
+require 'delayed_job'
+require 'apartment/delayed_job/active_record'   # ensure that our AR hooks are loaded when queueing
+
+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
+      def self.enqueue(payload_object, options = {})
+        Apartment::Database.process do
+          ::Delayed::Job.enqueue(payload_object, options)
+        end
+      end
+      
+    end
+  end
+end

data/lib/apartment/delayed_job/hooks.rb

@@ -1,9 +1,11 @@
+require 'apartment/delayed_job/enqueue'
+
 module Apartment
   module Delayed
     module Job
       
       # Before and after hooks for performing Delayed Jobs within a particular apartment database
-      # Included these in your delayed jobs models and make sure provide a @database attr that will be serialized by DJ
+      # Include these in your delayed jobs models and make sure provide a @database attr that will be serialized by DJ
       module Hooks
         
         attr_accessor :database

data/lib/apartment/delayed_job/requirements.rb

@@ -0,0 +1,22 @@
+require 'apartment/delayed_job/enqueue'
+
+module Apartment
+  module Delayed
+    
+    # Mix this module into any model that gets serialized by DJ
+    module Requirements
+      attr_accessor :database
+      
+      def self.included(klass)
+        klass.after_find :set_database
+      end
+      
+    private
+    
+      def set_database
+        @database = Apartment::Database.current_database
+      end
+    
+    end
+  end
+end

data/lib/apartment/version.rb

@@ -1,3 +1,3 @@
 module Apartment
-  VERSION = "0.9.2"
+  VERSION = "0.10.0"
 end

data/spec/dummy/config/application.rb

@@ -18,7 +18,7 @@ module Dummy
     config.middleware.use 'Apartment::Elevators::Subdomain'
 
     # Custom directories with classes and modules you want to be autoloadable.
-    # config.autoload_paths += %W(#{config.root}/extras)
+    config.autoload_paths += %W(#{config.root}/lib)
 
     # Only load the plugins named here, in the order given (default is alphabetical).
     # :all can be used as a placeholder for all plugins not explicitly named.

data/spec/dummy/db/migrate/20110613152810_create_dummy_models.rb

@@ -10,6 +10,21 @@ class CreateDummyModels < ActiveRecord::Migration
       t.datetime :birthdate
       t.string :sex
      end
+     
+     create_table :delayed_jobs do |t|
+       t.integer  "priority",   :default => 0
+       t.integer  "attempts",   :default => 0
+       t.text     "handler"
+       t.text     "last_error"
+       t.datetime "run_at"
+       t.datetime "locked_at"
+       t.datetime "failed_at"
+       t.string   "locked_by"
+       t.datetime "created_at"
+       t.datetime "updated_at"
+     end
+
+     add_index "delayed_jobs", ["priority", "run_at"], :name => "delayed_jobs_priority"
     
   end
 

data/spec/dummy/db/schema.rb

@@ -17,6 +17,21 @@ ActiveRecord::Schema.define(:version => 20110613152810) do
     t.string  "database"
   end
 
+  create_table "delayed_jobs", :force => true do |t|
+    t.integer  "priority",   :default => 0
+    t.integer  "attempts",   :default => 0
+    t.text     "handler"
+    t.text     "last_error"
+    t.datetime "run_at"
+    t.datetime "locked_at"
+    t.datetime "failed_at"
+    t.string   "locked_by"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  add_index "delayed_jobs", ["priority", "run_at"], :name => "delayed_jobs_priority"
+
   create_table "users", :force => true do |t|
     t.string   "name"
     t.datetime "birthdate"

data/spec/dummy/lib/fake_dj_class.rb

@@ -0,0 +1,6 @@
+class FakeDjClass
+  
+  def perform
+  end
+  
+end

data/spec/integration/database_integration_spec.rb

@@ -8,9 +8,11 @@ describe Apartment::Database do
     
     let(:config){ Apartment::Test.config['connections']['postgresql'].symbolize_keys }
     let(:database){ "some_new_database" }
+    let(:database2){ "yet_another_database" }
     
     before do
       ActiveRecord::Base.establish_connection config
+      Apartment::Test.load_schema   # load the Rails schema in the public db schema
       Apartment::Database.stub(:config).and_return config   # Use postgresql database config for this test
       @schema_search_path = ActiveRecord::Base.connection.schema_search_path
     end
@@ -63,20 +65,43 @@ describe Apartment::Database do
       end
       
       after do
-        Apartment::Test.drop_schema(database)
+        Apartment::Test.drop_schema database
       end
       
       describe "#process" do
+        
+        before do
+          Apartment::Database.create database2
+        end
+        
+        after do
+          Apartment::Test.drop_schema database2
+        end
+        
         it "should connect to new schema" do
           Apartment::Database.process(database) do
-            ActiveRecord::Base.connection.schema_search_path.should == database
+            Apartment::Database.current_database.should == database
           end
         end
 
-        it "should reset to public schema" do
+        it "should reset connection to the previous db" do
+          Apartment::Database.switch(database2)
           Apartment::Database.process(database)
-          ActiveRecord::Base.connection.schema_search_path.should == @schema_search_path
+          Apartment::Database.current_database.should == database2
+        end
+        
+        it "should reset to previous schema if database is nil" do
+          Apartment::Database.switch(database)
+          Apartment::Database.process
+          Apartment::Database.current_database.should == database
+        end
+        
+        it "should set to public schema if database is nil" do
+          Apartment::Database.process do
+            Apartment::Database.current_database.should == @schema_search_path
+          end
         end
+        
       end
       
       describe "#create" do
@@ -92,25 +117,67 @@ describe Apartment::Database do
     
       describe "#switch" do
         
+        let(:x){ rand(3) }
+        
         it "should connect to new schema" do
           Apartment::Database.switch database
           ActiveRecord::Base.connection.schema_search_path.should == database
         end
         
-        it "should ignore excluded models" do
+        it "should fail with invalid schema" do
+          expect {
+            Apartment::Database.switch('some_nonexistent_schema')
+          }.to raise_error Apartment::SchemaNotFound
+        end
+        
+        context "creating models" do
+          
+          before do
+            Apartment::Database.create database2
+          end
+
+          after do
+            Apartment::Test.drop_schema database2
+          end
+          
+          it "should create a model instance in the current schema" do
+            Apartment::Database.switch database2
+            db2_count = User.count + x.times{ User.create }
+
+            Apartment::Database.switch database
+            db_count = User.count + x.times{ User.create }
+
+            Apartment::Database.switch database2
+            User.count.should == db2_count
+
+            Apartment::Database.switch database
+            User.count.should == db_count
+          end
+        end
+        
+        context "with excluded models" do
+          
           Apartment.configure do |config|
             config.excluded_models = [Company]
           end
           
-          Apartment::Database.switch database
-          Company.connection.schema_search_path.should == @schema_search_path
+          it "should ignore excluded models" do
+            Apartment::Database.switch database
+            Company.connection.schema_search_path.should == @schema_search_path
+          end
+          
+          it "should create excluded models in public schema" do
+            Apartment::Database.reset # ensure we're on public schema
+            count = Company.count + x.times{ Company.create }
+            
+            Apartment::Database.switch database
+            x.times{ Company.create }
+            Company.count.should == count + x
+            Apartment::Database.reset
+            Company.count.should == count + x
+          end
         end
         
-        it "should fail with invalid schema" do
-          expect {
-            Apartment::Database.switch('some_nonexistent_schema')
-          }.to raise_error Apartment::SchemaNotFound
-        end
       end
       
       describe "#current_database" do

data/spec/integration/delayed_job_integration_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+require 'delayed_job'
+Delayed::Worker.guess_backend
+
+describe Apartment::Delayed do
+  
+  # See apartment.yml file in dummy app config
+  
+  let(:config){ Apartment::Test.config['connections']['postgresql'].symbolize_keys }
+  let(:database){ "some_new_database" }
+  let(:database2){ "another_db" }
+  
+  before do
+    ActiveRecord::Base.establish_connection config
+    Apartment::Test.load_schema   # load the Rails schema in the public db schema
+    Apartment::Database.stub(:config).and_return config   # Use postgresql database config for this test
+    @schema_search_path = ActiveRecord::Base.connection.schema_search_path
+    
+    Apartment.configure do |config|
+      config.use_postgres_schemas = true
+    end
+    
+    Apartment::Database.create database
+    Apartment::Database.create database2
+  end
+  
+  after do
+    Apartment::Test.drop_schema database
+    Apartment::Test.drop_schema database2
+    Apartment::Test.reset
+  end
+  
+  describe Apartment::Delayed::Job do
+    context "#enqueue" do
+    
+      before do
+        Apartment::Database.reset
+      end
+    
+      it "should queue up jobs in the public schema" do
+        dj_count = Delayed::Job.count
+        Apartment::Database.switch database
+        Apartment::Delayed::Job.enqueue FakeDjClass.new
+        Apartment::Database.reset
+        
+        Delayed::Job.count.should == dj_count + 1
+      end
+    
+      it "should not queue jobs in the current schema" do
+        Apartment::Database.switch database
+        expect {
+          Apartment::Delayed::Job.enqueue FakeDjClass.new
+        }.to_not change(Delayed::Job, :count)        # because we will still be on the `database` schema, not public
+      end
+    end
+  end
+  
+  describe Apartment::Delayed::Requirements do
+    
+    before do
+      Apartment::Database.switch database
+      User.send(:include, Apartment::Delayed::Requirements)
+      User.create
+    end
+    
+    it "should initialize a database attribute on a class" do
+      user = User.first
+      user.database.should == database
+    end
+    
+    it "should not overwrite any previous after_initialize declarations" do      
+      User.class_eval do
+        after_find :set_name
+        
+        def set_name
+          self.name = "Some Name"
+        end
+      end
+      
+      user = User.first
+      user.database.should == database
+      user.name.should == "Some Name"
+    end
+    
+    context "serialization" do
+      it "should serialize the proper database attribute" do
+        user_yaml = User.first.to_yaml
+        Apartment::Database.switch database2
+        user = YAML.load user_yaml
+        user.database.should == database
+      end
+    end
+  end
+  
+end

data/spec/support/apartment_helpers.rb

@@ -14,6 +14,10 @@ module Apartment
       ActiveRecord::Base.connection.execute("CREATE SCHEMA #{schema}")
     end
     
+    def self.load_schema
+      load "#{Rails.root}/db/schema.rb"
+    end
+    
     def self.in_database(db)
       Apartment::Database.switch db
       yield if block_given?

metadata

@@ -2,7 +2,7 @@
 name: apartment
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.9.2
+  version: 0.10.0
 platform: ruby
 authors: 
 - Ryan Brunner
@@ -91,6 +91,17 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: delayed_job
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: *id008
 description: Apartment allows Rails applications to deal with database multitenancy
 email: 
 - ryan@ryanbrunner.com
@@ -115,7 +126,10 @@ files:
 - lib/apartment/adapters/mysql_adapter.rb
 - lib/apartment/adapters/postgresql_adapter.rb
 - lib/apartment/database.rb
+- lib/apartment/delayed_job/active_record.rb
+- lib/apartment/delayed_job/enqueue.rb
 - lib/apartment/delayed_job/hooks.rb
+- lib/apartment/delayed_job/requirements.rb
 - lib/apartment/elevators/subdomain.rb
 - lib/apartment/migrator.rb
 - lib/apartment/railtie.rb
@@ -149,6 +163,7 @@ files:
 - spec/dummy/db/schema.rb
 - spec/dummy/db/seeds.rb
 - spec/dummy/db/test.sqlite3
+- spec/dummy/lib/fake_dj_class.rb
 - spec/dummy/log/development.log
 - spec/dummy/log/production.log
 - spec/dummy/log/server.log
@@ -161,6 +176,7 @@ files:
 - spec/integration/adapters/postgresql_integration_spec.rb
 - spec/integration/apartment_rake_integration_spec.rb
 - spec/integration/database_integration_spec.rb
+- spec/integration/delayed_job_integration_spec.rb
 - spec/integration/middleware/subdomain_elevator_spec.rb
 - spec/integration/setup_spec.rb
 - spec/spec_helper.rb
@@ -186,7 +202,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1126220868121977386
+      hash: -3391988953711779455
       segments: 
       - 0
       version: "0"
@@ -195,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1126220868121977386
+      hash: -3391988953711779455
       segments: 
       - 0
       version: "0"