apartment 0.14.3 → 0.14.4

data/HISTORY.md

@@ -1,3 +1,8 @@
+# 0.14.4
+  * March 8, 2012
+
+  - Delayed::Job Hooks now return to the previous database, rather than resetting
+
 # 0.14.3
   * Feb 21, 2012
 

data/README.md

@@ -14,7 +14,7 @@ Add the following to your Gemfile:
 
     gem 'apartment'
 
-That's all you need to set up the Apartment libraries. If you want to switch databases 
+That's all you need to set up the Apartment libraries. If you want to switch databases
 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:
@@ -31,11 +31,11 @@ you need to create a new database, you can run the following command:
 
     Apartment::Database.create('database_name')
 
-Apartment will create a new database in the following format: "_environment_\_database_name". 
+Apartment will create a new database in the following format: "_environment_\_database_name".
 In the case of a sqlite database, this will be created in your 'db/migrate' folder. With
 other databases, the database will be created as a new DB within the system.
 
-When you create a new database, all migrations will be run against that database, so it will be 
+When you create a new database, all migrations will be run against that database, so it will be
 up to date when create returns.
 
 #### Notes on PostgreSQL
@@ -53,8 +53,8 @@ To switch databases using Apartment, use the following command:
 
     Apartment::Database.switch('database_name')
 
-When switch is called, all requests coming to ActiveRecord will be routed to the database 
-you specify (with the exception of excluded models, see below). To return to the 'root' 
+When switch is called, all requests coming to ActiveRecord will be routed to the database
+you specify (with the exception of excluded models, see below). To return to the 'root'
 database, call switch with no arguments.
 
 ### Switching Databases per request
@@ -67,32 +67,32 @@ to a database schema of the same name. It can be used like so:
     # application.rb
     module My Application
       class Application < Rails::Application
-      
+
         config.middleware.use 'Apartment::Elevators::Subdomain'
       end
     end
-    
+
 ## Config
 
 The following config options should be set up in a Rails initializer such as:
 
     config/initializers/apartment.rb
-    
+
 To set config options, add this to your initializer:
 
     Apartment.configure do |config|
       # set your options (described below) here
     end
-    
+
 ### Excluding models
 
 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
 
 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
 
 By default, when not using postgresql schemas, Apartment will prepend the environment to the database name
@@ -109,19 +109,31 @@ This object should yield an array of string representing each database name.  Ex
 
     # Dynamically get database names to migrate
     config.database_names = lambda{ Customer.select(:database_name).map(&:database_name) }
-    
+
     # Use a static list of database names for migrate
     config.database_names = ['db1', 'db2']
-      
+
 You can then migration your databases using the rake task:
-    
+
     rake apartment:migrate
-    
+
 This basically invokes `Apartment::Database.migrate(#{db_name})` for each database name supplied
 from `Apartment.database_names`
 
 ### Delayed::Job
 
+If using Rails ~> 3.2, you *must* use `delayed_job ~> 3.0`.  It has better Rails 3 support plus has some major changes that affect the serialization of models.
+I haven't been able to get `psych` working whatsoever as the YAML parser, so to get things to work properly, you must explicitly set the parser to `syck` *before* requiring `delayed_job`
+This can be done in the `boot.rb` of your rails config *just above* where Bundler requires the gems from the Gemfile.  It will look something like:
+
+    require 'rubygems'
+    require 'yaml'
+    YAML::ENGINE.yamler = 'syck'
+
+    # Set up gems listed in the Gemfile.
+    gemfile = File.expand_path('../../Gemfile', __FILE__)
+    ...
+
 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 the `database` attribute (provided by Apartment::Delayed::Requirements) 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
@@ -129,12 +141,12 @@ In order to make ActiveRecord models play nice with DJ and Apartment, include `A
     end
 
     class SomeDJ
-  
+
       def initialize(model)
         @model = model
         @model.database = Apartment::Database.current_database
       end
-  
+
       def perform
         # do some stuff
       end

data/apartment.gemspec

@@ -27,5 +27,6 @@ Gem::Specification.new do |s|
   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', '~> 2.1.4'
+  s.add_development_dependency 'delayed_job', '~> 3.0.1'
+  s.add_development_dependency 'delayed_job_active_record'
 end

data/lib/apartment/delayed_job/active_record.rb

@@ -8,8 +8,8 @@ module ActiveRecord
       Apartment::Database.process(val['database']) do
         klass.find(val['attributes']['id'])
       end
-    rescue ActiveRecord::RecordNotFound
-      raise Delayed::DeserializationError
+    rescue ActiveRecord::RecordNotFound => e
+      raise Delayed::DeserializationError,  e.message
     end
 
     # Rails > 3.0 now uses encode_with to determine what to encode with yaml

data/lib/apartment/delayed_job/hooks.rb

@@ -12,11 +12,12 @@ module Apartment
         attr_accessor :database
 
         def before(job)
+          @_current_database = Apartment::Database.current_database
           Apartment::Database.switch(job.payload_object.database) if job.payload_object.database
         end
 
         def after
-          Apartment::Database.reset
+          Apartment::Database.switch(@_current_database)
         end
 
       end

data/lib/apartment/version.rb

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

data/spec/adapters/postgresql_adapter_spec.rb

@@ -2,66 +2,66 @@ require 'spec_helper'
 require 'apartment/adapters/postgresql_adapter'   # specific adapters get dynamically loaded based on adapter name, so we must manually require here
 
 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
-  
+
   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(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
@@ -77,31 +77,31 @@ describe Apartment::Adapters::PostgresqlAdapter do
         }.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)
-        
+
         expect {
           subject.process(schema){ subject.drop(schema2) }
         }.to_not raise_error(Apartment::SchemaNotFound)
       end
     end
-    
+
     describe "#reset" do
       it "should reset connection" do
         subject.switch(schema)
@@ -109,28 +109,28 @@ describe Apartment::Adapters::PostgresqlAdapter do
         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 reset connection if database is nil" do
         subject.switch
         ActiveRecord::Base.connection.schema_search_path.should == @schema_search_path
       end
     end
-    
+
     describe "#current_database" do
       it "should return the current schema name" do
         subject.switch(schema)
         subject.current_database.should == schema
       end
     end
-    
+
   end
-  
+
   context "using databases" do
     # TODO
   end

data/spec/dummy/app/models/user.rb

@@ -1,3 +1,5 @@
 class User < ActiveRecord::Base
+  include Apartment::Delayed::Job::Hooks
+  def perform; end
   # Dummy models
 end

data/spec/dummy/config/boot.rb

@@ -1,4 +1,8 @@
 require 'rubygems'
+
+require 'yaml'
+YAML::ENGINE.yamler = 'syck'
+
 gemfile = File.expand_path('../../../../Gemfile', __FILE__)
 
 if File.exist?(gemfile)

data/spec/integration/delayed_job_integration_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 require 'delayed_job'
-Delayed::Worker.guess_backend
+require 'delayed_job_active_record'
 
 describe Apartment::Delayed do
 
@@ -72,4 +72,17 @@ describe Apartment::Delayed do
     end
   end
 
+  describe Apartment::Delayed::Job::Hooks do
+
+    let(:worker){ Delayed::Worker.new }
+    let(:job){ Delayed::Job.enqueue User.new }
+
+    it "should switch to previous db" do
+      Apartment::Database.switch database
+      worker.run(job)
+
+      Apartment::Database.current_database.should == database
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apartment
 version: !ruby/object:Gem::Version
-  version: 0.14.3
+  version: 0.14.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-21 00:00:00.000000000 Z
+date: 2012-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2152184980 !ruby/object:Gem::Requirement
+  requirement: &2156199960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 3.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *2152184980
+  version_requirements: *2156199960
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152183300 !ruby/object:Gem::Requirement
+  requirement: &2156198740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *2152183300
+  version_requirements: *2156198740
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2152182600 !ruby/object:Gem::Requirement
+  requirement: &2156197960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152182600
+  version_requirements: *2156197960
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152181680 !ruby/object:Gem::Requirement
+  requirement: &2156197060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *2152181680
+  version_requirements: *2156197060
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &2152177640 !ruby/object:Gem::Requirement
+  requirement: &2156196160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +66,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *2152177640
+  version_requirements: *2156196160
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &2152176580 !ruby/object:Gem::Requirement
+  requirement: &2156195360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -77,10 +77,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2152176580
+  version_requirements: *2156195360
 - !ruby/object:Gem::Dependency
   name: pg
-  requirement: &2152175640 !ruby/object:Gem::Requirement
+  requirement: &2156194560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,10 +88,10 @@ dependencies:
         version: 0.11.0
   type: :development
   prerelease: false
-  version_requirements: *2152175640
+  version_requirements: *2156194560
 - !ruby/object:Gem::Dependency
   name: mysql2
-  requirement: &2152162340 !ruby/object:Gem::Requirement
+  requirement: &2156176740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -99,10 +99,10 @@ dependencies:
         version: 0.3.7
   type: :development
   prerelease: false
-  version_requirements: *2152162340
+  version_requirements: *2156176740
 - !ruby/object:Gem::Dependency
   name: silent-postgres
-  requirement: &2152160960 !ruby/object:Gem::Requirement
+  requirement: &2156175840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -110,18 +110,29 @@ dependencies:
         version: 0.1.1
   type: :development
   prerelease: false
-  version_requirements: *2152160960
+  version_requirements: *2156175840
 - !ruby/object:Gem::Dependency
   name: delayed_job
-  requirement: &2152159540 !ruby/object:Gem::Requirement
+  requirement: &2156174740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: 3.0.1
   type: :development
   prerelease: false
-  version_requirements: *2152159540
+  version_requirements: *2156174740
+- !ruby/object:Gem::Dependency
+  name: delayed_job_active_record
+  requirement: &2156173700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156173700
 description: Apartment allows Rails applications to deal with database multitenancy
 email:
 - ryan@ryanbrunner.com
@@ -221,7 +232,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3522357192769439782
+      hash: -3479851057211563611
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -230,7 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3522357192769439782
+      hash: -3479851057211563611
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10