acts_as_tenant 0.3.8 → 0.3.9

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZmFmMDEwY2Y3YTYwOGY4MzRmYTRmYTQ3ZDYwNTFlMTE5YTRmN2U5Mg==
+    ZTU3MTcwNGYyNzk1NDk3OWMyNmQxYWJjNDdkNjI5NDVjZjc4MjA0MQ==
   data.tar.gz: !binary |-
-    YjNmNmNhNDBiNjE3NjQxNTI2MjM0NTNkZWFhZTRjYTBhMjBkZjhlMw==
+    NTUxMDJkZmI1NmE3MGY3NzliMzI5N2ZiOGY4MTA1ZGQyZDlkNDRlYg==
 SHA512:
   metadata.gz: !binary |-
-    NWZhZGE3MDA5OTczZDNmNmY1MDllZDIwYjgwYWMwNGUyMjQ3ZTdmNWRkNTgz
-    Y2Q3YTU1YTVkNGJjYzI4YjBlMGQwMWNhN2Q4OWU4YTBhZTkyMzYxZjgyOTMw
-    ZGY3ODFjMzVjNmUyZTBmNjE0MjA5YzMwZTllODc4ZGUyMjdjMTE=
+    ZDFkMWRmYjRhNTdmZmYxNDFmOWE4YjYxNTVhMTU0ZDYxNjE3OTk2Yjk0Yzdh
+    OWRlZGFmODNlN2E1NWJlNmRmNmVkYTEzOWVlOGViODBlNzY5YmYxY2QzMDZl
+    NTgwMjU5MjU3MGFkN2Q5MzBkY2MwMzljMDhiNTViZTI1ZmY3OTk=
   data.tar.gz: !binary |-
-    YTgzOTVhMzZiMzFhZjQ1MjNjMmUzZWNlZjRlOWFkYTY1YzhmNWRhMzViMzI2
-    ZTI1OTZiODRiMTY2NjY2NjBjYTRhYTNlNjljMmU2MDllNDU3Mzg5OTYyZTZm
-    MWRjYWM2ZDY3YmRiOGQ2YzYyNjA2MGE5MGI1YzhiMjk1NzliZjI=
+    ODI0OTM1YzE1NGM1N2QwNzBiNzZlMzI1MTM1YjhkZDU0Nzc2OGU4Y2FkMTdi
+    YTZmYjU3YjJiZjdkOGI5NWFmNDI4ZGNhMjk4NTZmM2VkYTYzZDg1MTc3NDQx
+    NmYxZmM4YmM2ODg5MjhmYjgzNDEwZTk0ZTVmODZkMGM1YWVlMjQ=

data/CHANGELOG.md

@@ -1,6 +1,12 @@
+0.3.9
+-----
+* Added ability to configure a default tenant for testing purposes. (thx iangreenleaf)
+* AaT will now accept a string for a tenant_id (thx calebthompson)
+* Improvements to readme (thx stgeneral)
+
 0.3.8
 -----
-* Added Mongoid compatibility [thx iangreenlead]
+* Added Mongoid compatibility [thx iangreenleaf]
 
 0.3.7
 -----

data/README.md

@@ -18,11 +18,13 @@ In addition, acts_as_tenant:
 
 Installation
 ------------
-acts_as_tenant will only work on Rails 3.1 and up. This is due to changes made to the handling of default_scope, an essential pillar of the gem.
+acts_as_tenant will only work on Rails 3.1 and up. This is due to changes made to the handling of `default_scope`, an essential pillar of the gem.
 
 To use it, add it to your Gemfile:
 
-    gem 'acts_as_tenant'
+```ruby
+gem 'acts_as_tenant'
+```
 
 Getting started
 ===============
@@ -33,98 +35,118 @@ There are two steps in adding multi-tenancy to your app with acts_as_tenant:
 
 Setting the current tenant
 --------------------------
-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.
+There are three ways to set the current tenant:
 
-**Use the subdomain to lookup 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.
 
-    class ApplicationController < ActionController::Base
-      set_current_tenant_by_subdomain(:account, :subdomain)
-    end
+### Use the subdomain to lookup the current tenant ###
+
+```ruby
+class ApplicationController < ActionController::Base
+  set_current_tenant_by_subdomain(:account, :subdomain)
+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.
 
-Alternatively, you could locate the tenant using the method set_current_tenant_by_subdomain_or_domain( :account, :subdomain,  :domain ) which will try to match a record first by subdomain. in case it fails, by domain.
+Alternatively, you could locate the tenant using the method `set_current_tenant_by_subdomain_or_domain( :account, :subdomain,  :domain )` which will try to match a record first by subdomain. in case it fails, by domain.
 
-**Setting the current tenant in a controller, manually**
+### Setting the current tenant in a controller, manually ###
 
-    class ApplicationController < ActionController::Base
-      set_current_tenant_through_filter
-      before_filter :your_method_that_finds_the_current_tenant
+```ruby
+class ApplicationController < ActionController::Base
+  set_current_tenant_through_filter
+  before_filter :your_method_that_finds_the_current_tenant
+
+  def your_method_that_finds_the_current_tenant
+    current_account = Account.find_it
+    set_current_tenant(current_account)
+  end
+end
+```
 
-      def your_method_that_finds_the_current_tenant
-        current_account = Account.find_it
-        set_current_tenant(current_account)
-      end
-    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.
+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.
 
 
-**Setting the current tenant for a block**
+### Setting the current tenant for a block ###
 
-    ActsAsTenant.with_tenant(current_account) do
-      # Current tenant is set for all code in this block
-    end
+```ruby
+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.
+**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.
 
-**Require tenant to be set always**
+### Require tenant to be set always ###
 
 If you want to require the tenant to be set at all times, you can configure acts_as_tenant to raise an error when a query is made without a tenant available. See below under configuarion options.
 
 Scoping your models
 -------------------
-    class Addaccounttousers < ActiveRecord::Migration
-      def up
-        add_column :users, :account_id, :integer
-      end
-    end
 
-    class User < ActiveRecord::Base
-      acts_as_tenant(:account)
-    end
+```ruby
+class AddAccountToUsers < ActiveRecord::Migration
+  def up
+    add_column :users, :account_id, :integer
+    add_index  :users, :account_id
+  end
+end
 
-acts_as_tenant requires each scoped model to have a column in its schema linking it to a tenant. Adding acts_as_tenant to your model declaration will scope that model to the current tenant **BUT ONLY if a current tenant has been set**.
+class User < ActiveRecord::Base
+  acts_as_tenant(:account)
+end
+```
+
+`acts_as_tenant` requires each scoped model to have a column in its schema linking it to a tenant. Adding `acts_as_tenant` to your model declaration will scope that model to the current tenant **BUT ONLY if a current tenant has been set**.
 
 Some examples to illustrate this behavior:
 
-    # This manually sets the current tenant for testing purposes. In your app this is handled by the gem.
-    ActsAsTenant.current_tenant = Account.find(3)
+```ruby
+# This manually sets the current tenant for testing purposes. In your app this is handled by the gem.
+ActsAsTenant.current_tenant = Account.find(3)
 
-    # All searches are scoped by the tenant, the following searches will only return objects
-    # where account_id == 3
-    Project.all =>  # all projects with account_id => 3
-    Project.tasks.all #  => all tasks with account_id => 3
+# All searches are scoped by the tenant, the following searches will only return objects
+# where account_id == 3
+Project.all =>  # all projects with account_id => 3
+Project.tasks.all #  => all tasks with account_id => 3
 
-    # New objects are scoped to the current tenant
-    @project = Project.new(:name => 'big project')    # => <#Project id: nil, name: 'big project', :account_id: 3>
+# New objects are scoped to the current tenant
+@project = Project.new(:name => 'big project')    # => <#Project id: nil, name: 'big project', :account_id: 3>
 
-    # It will not allow the creation of objects outside the current_tenant scope
-    @project.account_id = 2
-    @project.save                                     # => false
+# It will not allow the creation of objects outside the current_tenant scope
+@project.account_id = 2
+@project.save                                     # => false
 
-    # It will not allow association with objects outside the current tenant scope
-    # Assuming the Project with ID: 2 does not belong to Account with ID: 3
-    @task = Task.new  # => <#Task id: nil, name: nil, project_id: nil, :account_id: 3>
+# It will not allow association with objects outside the current tenant scope
+# Assuming the Project with ID: 2 does not belong to Account with ID: 3
+@task = Task.new  # => <#Task id: nil, name: nil, project_id: nil, :account_id: 3>
+```
 
-Acts_as_tenant uses Rails' default_scope method to scope models. Rails 3.1 changed the way default_scope works in a good way. A user defined default_scope should integrate seamlessly with the one added by acts_as_tenant.
+Acts_as_tenant uses Rails' `default_scope` method to scope models. Rails 3.1 changed the way `default_scope` works in a good way. A user defined `default_scope` should integrate seamlessly with the one added by `acts_as_tenant`.
 
-**Validating attribute uniqueness**
+### Validating attribute uniqueness ###
 
 If you need to validate for uniqueness, chances are that you want to scope this validation to a tenant. You can do so by using:
 
-    validates_uniqueness_to_tenant :name, :email
+```ruby
+validates_uniqueness_to_tenant :name, :email
+```
 
 All options available to Rails' own `validates_uniqueness_of` are also available to this method.
 
-**Custom foreign_key**
+### Custom foreign_key ###
 
 You can explicitely specifiy a foreign_key for AaT to use should the key differ from the default:
 
-    acts_as_tenant(:account, :foreign_key => 'accountID) # by default AaT expects account_id
+```ruby
+acts_as_tenant(:account, :foreign_key => 'accountID) # by default AaT expects account_id
+```
 
 Configuration options
 ---------------------
@@ -149,9 +171,23 @@ Add the following code to your `config/initializer/acts_as_tenant.rb`:
 require 'acts_as_tenant/sidekiq'
 ```
 
-Note on testing
+Testing
 ---------------
-Whenever you set the `current_tenant` in your tests, either through integration tests or directly by calling `ActsAsTenant.current_tenant = some_tenant`, make sure to clean up the tenant after each test by calling `ActsAsTenant.current_tenant = nil`.
+
+If you set the `current_tenant` in your tests, make sure to clean up the tenant after each test by calling `ActsAsTenant.current_tenant = nil`. If you are manually setting the `current_tenant` in integration tests, please be aware that the value will not survive across multiple requests, even if they take place within the same test.
+
+If you'd like to set a default tenant that will survive across multiple requests, assign a value to `default_tenant`. You might use a before hook like this:
+
+```ruby
+# Make the default tenant globally available to the tests
+$default_account = Account.create!
+# Specify this account as the current tenant unless overridden
+ActsAsTenant.default_tenant = $default_account
+# Stub out the method setting a tenant in a controller hook
+allow_any_instance_of(ApplicationController).to receive(:set_current_tenant)
+```
+
+This can later be overridden by using any of the standard methods for specifying a different tenant. If you don't want this setting to apply to all of your tests, remember to clear it when you're finished by setting `ActsAsTenant.default_tenant = nil`.
 
 To Do
 -----

data/lib/acts_as_tenant/controller_extensions.rb

@@ -1,26 +1,26 @@
 module ActsAsTenant
   module ControllerExtensions
-    
+
     # this method allows setting the current_tenant by reading the subdomain and looking
-    # it up in the tenant-model passed to the method. The method will look for the subdomain 
+    # it up in the tenant-model passed to the method. The method will look for the subdomain
     # in a column referenced by the second argument.
     def set_current_tenant_by_subdomain(tenant = :account, column = :subdomain )
       self.class_eval do
         cattr_accessor :tenant_class, :tenant_column
       end
-      
+
       self.tenant_class = tenant.to_s.camelcase.constantize
       self.tenant_column = column.to_sym
-      
+
       self.class_eval do
         before_filter :find_tenant_by_subdomain
         helper_method :current_tenant
-        
+
         private
           def find_tenant_by_subdomain
             ActsAsTenant.current_tenant = tenant_class.where(tenant_column => request.subdomains.last).first
           end
-          
+
           def current_tenant
             ActsAsTenant.current_tenant
           end
@@ -28,48 +28,48 @@ module ActsAsTenant
     end
 
     # 01/27/2014 Christian Yerena / @preth00nker
-    # this method adds the possibility of use the domain as a possible second argument to find 
-    # the current_tenant. 
+    # this method adds the possibility of use the domain as a possible second argument to find
+    # the current_tenant.
     def set_current_tenant_by_subdomain_or_domain(tenant = :account, primary_column = :subdomain, second_column = :domain )
       self.class_eval do
         cattr_accessor :tenant_class, :tenant_primary_column, :tenant_second_column
       end
-      
+
       self.tenant_class = tenant.to_s.camelcase.constantize
       self.tenant_primary_column = primary_column.to_sym
       self.tenant_second_column = second_column.to_sym
-      
+
       self.class_eval do
         before_filter :find_tenant_by_subdomain_or_domain
         helper_method :current_tenant
-        
+
         private
           def find_tenant_by_subdomain_or_domain
             ActsAsTenant.current_tenant = tenant_class.where(tenant_primary_column => request.subdomains.last).first || tenant_class.where(tenant_second_column => request.domain).first
           end
-          
+
           def current_tenant
             ActsAsTenant.current_tenant
           end
       end
     end
 
-    
+
     # This method sets up a method that allows manual setting of the current_tenant. This method should
     # be used in a before_filter. In addition, a helper is setup that returns the current_tenant
     def set_current_tenant_through_filter
       self.class_eval do
         helper_method :current_tenant
+
+        private
+          def set_current_tenant(current_tenant_object)
+            ActsAsTenant.current_tenant = current_tenant_object
+          end
         
-        def set_current_tenant(current_tenant_object)
-          ActsAsTenant.current_tenant = current_tenant_object
-        end
-        
-        private 
           def current_tenant
             ActsAsTenant.current_tenant
           end
       end
     end
   end
-end
+end

data/lib/acts_as_tenant/model_extensions.rb

@@ -18,7 +18,11 @@ module ActsAsTenant
   end
 
   def self.current_tenant
-    RequestStore.store[:current_tenant]
+    RequestStore.store[:current_tenant] || self.default_tenant
+  end
+
+  class << self
+    attr_accessor :default_tenant
   end
 
   def self.with_tenant(tenant, &block)
@@ -94,13 +98,15 @@ module ActsAsTenant
         # - Add a helper method to verify if a model has been scoped by AaT
         to_include = Module.new do
           define_method "#{fkey}=" do |integer|
-            raise ActsAsTenant::Errors::TenantIsImmutable unless new_record? || send(fkey).nil? || send(fkey) == integer
             write_attribute("#{fkey}", integer)
+            raise ActsAsTenant::Errors::TenantIsImmutable if send("#{fkey}_changed?") && persisted? && !send("#{fkey}_was").nil?
+            integer
           end
 
           define_method "#{ActsAsTenant.tenant_klass.to_s}=" do |model|
-            raise ActsAsTenant::Errors::TenantIsImmutable unless new_record? || send(fkey).nil? || send(fkey) == integer
             super(model)
+            raise ActsAsTenant::Errors::TenantIsImmutable if send("#{fkey}_changed?") && persisted? && !send("#{fkey}_was").nil?
+            model
           end
 
           define_method "#{ActsAsTenant.tenant_klass.to_s}" do

data/lib/acts_as_tenant/version.rb

@@ -1,3 +1,3 @@
 module ActsAsTenant
-  VERSION = "0.3.8"
+  VERSION = "0.3.9"
 end

data/spec/active_record_helper.rb

@@ -1,5 +1,6 @@
 require 'rails/all'
 require 'database_cleaner'
+require 'yaml'
 
 dbconfig = YAML::load(IO.read(File.join(File.dirname(__FILE__), 'database.yml')))
 ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "debug.log"))

data/spec/acts_as_tenant/model_extensions_spec.rb

@@ -27,6 +27,24 @@ describe ActsAsTenant do
     it { expect {@project.account_id = @account.id + 1}.to raise_error }
   end
 
+  describe 'setting tenant_id to the same value should not error' do
+    before do
+      @account = Account.create!(:name => 'foo')
+      @project = @account.projects.create!(:name => 'bar')
+    end
+
+    it { expect {@project.account_id = @account.id}.not_to raise_error }
+  end
+
+  describe 'setting tenant_id to a string with same to_i value should not error' do
+    before do
+      @account = Account.create!(:name => 'foo')
+      @project = @account.projects.create!(:name => 'bar')
+    end
+
+    it { expect {@project.account_id = @account.id.to_s}.not_to raise_error }
+  end
+
   describe 'tenant_id should be mutable, if not already set' do
     before do
       @account = Account.create!(:name => 'foo')
@@ -291,4 +309,48 @@ describe ActsAsTenant do
       end
     end
   end
+
+  describe "ActsAsTenant.default_tenant=" do
+    before(:each) do
+      @account = Account.create!
+    end
+
+    after(:each) do
+      ActsAsTenant.default_tenant = nil
+    end
+
+    it "provides current_tenant" do
+      ActsAsTenant.default_tenant = @account
+      expect(ActsAsTenant.current_tenant).to eq(@account)
+    end
+
+    it "can be overridden by assignment" do
+      ActsAsTenant.default_tenant = @account
+      @account2 = Account.create!
+      ActsAsTenant.current_tenant = @account2
+      expect(ActsAsTenant.current_tenant).not_to eq(@account)
+    end
+
+    it "can be overridden by with_tenant" do
+      ActsAsTenant.default_tenant = @account
+      @account2 = Account.create!
+      ActsAsTenant.with_tenant @account2 do
+        expect(ActsAsTenant.current_tenant).to eq(@account2)
+      end
+      expect(ActsAsTenant.current_tenant).to eq(@account)
+    end
+
+    it "doesn't override existing current_tenant" do
+      @account2 = Account.create!
+      ActsAsTenant.current_tenant = @account2
+      ActsAsTenant.default_tenant = @account
+      expect(ActsAsTenant.current_tenant).to eq(@account2)
+    end
+
+    it "survives request resets" do
+      ActsAsTenant.default_tenant = @account
+      RequestStore.clear!
+      expect(ActsAsTenant.current_tenant).to eq(@account)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_tenant
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.3.9
 platform: ruby
 authors:
 - Erwin Matthijssen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-10 00:00:00.000000000 Z
+date: 2015-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store