acts_as_tenant 0.2.7 → 0.2.8

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+0.2.8
+-----
+* Added dependencies to gemspec (thx aaronrenner)
+* Added the `ActsAsTenant.with_tenant` block method (see readme) (thx aaronrenner)
+* Acts_as_Tenant is now thread safe (thx davide)
+
 0.2.7
 -----
 * Changed the interface for passing in the current_tenant manually in the controller. `set_current_tenant_to` has been deprecated and replaced by `set_current_tenant_through_filter` declaration and the `set_current_tenant` method. See readme for details.

data/README.md

@@ -31,7 +31,8 @@ There are two steps in adding multi-tenancy to your app with acts_as_tenant:
 
 Setting the current tenant
 --------------------------
-There are two ways to set the current tenant: (1) by using the subdomain to lookup the current tenant and (2) by passing in the current tenant yourself.
+There are three ways to set the current tenant: (1) by using the subdomain to lookup the current tenant, (2) by setting  the current tenant in the controller, and
+(3) by setting the current tenant for a block.
 
 **Use the subdomain to lookup the current tenant**
 
@@ -40,7 +41,7 @@ There are two ways to set the current tenant: (1) by using the subdomain to look
     end
 This tells acts_as_tenant to use the current subdomain to identify the current tenant. In addition, it tells acts_as_tenant that tenants are represented by the Account model and this model has a column named 'subdomain' which can be used to lookup the Account using the actual subdomain. If ommitted, the parameters will default to the values used above.
 
-**OR Pass in the current tenant yourself**
+**Setting the current tenant in a controller, manually**
 
     class ApplicationController < ActionController::Base
       set_current_tenant_through_filter
@@ -53,7 +54,17 @@ This tells acts_as_tenant to use the current subdomain to identify the current t
     end
 Setting the current_tenant yourself, requires you to declare `set_current_tenant_through_filter` at the top of your application_controller to tell acts_as_tenant that you are going to use a before_filter to setup the current tenant. Next you should actually setup that before_filter to fetch the current tenant and pass it to `acts_as_tenant` by using `set_current_tenant(current_tenant)` in the before_filter.
 
-**note:** If the current tenant is not set by either of these methods, Acts_as_tenant will be unable to apply the proper scope to your models. So make sure you use one of the two methods to tell acts_as_tenant about the current tenant.
+
+**Setting the current tenant for a block**
+
+    ActsAsTenant.with_tenant(current_account) do
+      # Current tenant is set for all code in this block
+    end
+
+This approach is useful when running background processes for a specified tenant. For example, by putting this in your worker's run method,
+any code in this block will be scoped to the current tenant. All methods that set the current tenant are thread safe.
+
+**note:** If the current tenant is not set by one of these methods, Acts_as_tenant will be unable to apply the proper scope to your models. So make sure you use one of the two methods to tell acts_as_tenant about the current tenant.
   
 Scoping your models
 -------------------

data/acts_as_tenant.gemspec

@@ -17,4 +17,10 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+  
+  s.add_dependency('rails','>= 3.1')
+
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('database_cleaner')
+  s.add_development_dependency('sqlite3')
 end

data/lib/acts_as_tenant/model_extensions.rb

@@ -5,7 +5,30 @@ module ActsAsTenant
   
   class << self
     cattr_accessor :tenant_class
-    attr_accessor :current_tenant
+
+    # This will also work whithin Fibers:
+    # http://devblog.avdi.org/2012/02/02/ruby-thread-locals-are-also-fiber-local/
+    def current_tenant=(tenant)
+      Thread.current[:current_tenant] = tenant
+    end
+
+    def current_tenant
+      Thread.current[:current_tenant]
+    end
+
+    # Sets the current_tenant within the given block
+    def with_tenant(tenant, &block)
+      if block.nil?
+        raise ArgumentError, "block required"
+      end
+
+      old_tenant = self.current_tenant
+      self.current_tenant = tenant
+
+      block.call
+
+      self.current_tenant= old_tenant
+    end
   end
   
   module ModelExtensions

data/lib/acts_as_tenant/version.rb

@@ -1,3 +1,3 @@
 module ActsAsTenant
-  VERSION = "0.2.7"
+  VERSION = "0.2.8"
 end

data/spec/model_extensions_spec.rb

@@ -220,4 +220,31 @@ describe ActsAsTenant do
       ActsAsTenant.current_tenant = @account
       Task.create(:name => 'bar').valid?.should == true
   end
+
+  describe "::with_tenant" do
+    it "should set current_tenant to the specified tenant inside the block" do
+      @account = Account.create!(:name => 'baz')
+
+      ActsAsTenant.with_tenant(@account) do
+        ActsAsTenant.current_tenant.should eq(@account)
+      end
+    end
+
+
+    it "should return current_tenant to the previous tenant once exiting the block" do
+      @account1 = Account.create!(:name => 'foo')
+      @account2 = Account.create!(:name => 'bar')
+      
+      ActsAsTenant.current_tenant = @account1
+      ActsAsTenant.with_tenant @account2 do
+
+      end
+
+      ActsAsTenant.current_tenant.should eq(@account1)
+    end
+
+    it "should raise an error when no block is provided" do
+      expect { ActsAsTenant.with_tenant(nil) }.to raise_error(ArgumentError, /block required/)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_tenant
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,52 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-24 00:00:00.000000000Z
-dependencies: []
+date: 2012-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70247831625340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70247831625340
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70247831624140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70247831624140
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: &70247831623580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70247831623580
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70247831622820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70247831622820
 description: Integrates multi-tenancy into a Rails application in a convenient and
   out-of-your way manner
 email: