acts_as_tenant 0.3.2 → 0.3.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTdlZmJkZjFiNWQ5YzUxNDM0OWJiOWEzYWMzZTIzZWM3ZmMzN2RmOA==
+    ZDM3YTQ2MDk4YjRjZGRkNDlkMjVlNjVhYmE4MDhlYTZlZDcxY2JlNQ==
   data.tar.gz: !binary |-
-    NTViNTg4MDVkYjIwYmY4Y2VlZWY0NGVkNmE2MzEzNjk2ODE5YjEwOA==
+    YjIxMTk0YzRmMDg1MmZhNTk2ZDRjMjZiODE4YTA5ZTA1MDgyMzc1OA==
 SHA512:
   metadata.gz: !binary |-
-    MzZlMWJmNzAyZGQ2NDUwYWFmYjIzN2Q3YjliZDhlMjA4NGVjNzcwMGE4Yzc1
-    MzRmOGZmNTE0Yzk3NTY3YTI5ZTU2ZTBhNDczYTlmZjU0Y2JjYWY1MDM5ODE5
-    NTNhODA2ZjczYzk4Y2VkZjg4MDhmYTNlMDc5Y2UzZjgyNzBmZDA=
+    ZjI5MTQzMDEzZTJhYjBiYWI1NjQyOTdhNjhkZTViZGRhZGVkYTVlMWE2MjFk
+    NzE2YzMzMmY1YTJhZGUwN2E3MzgzOWQ1M2EwZjFlZWZjMzQ4MTAwMjFmMWUx
+    NGIzYmVhYTAwNGRhZDUzZWQyMzkzMDIyOTJlM2YxZWY5OTM0OTg=
   data.tar.gz: !binary |-
-    MjM2NzliNjViYjlkNjQyNjdmODNiMWY2MGFkODQ1ZjJiODQ1YjRjMzJkOWM2
-    MGFjNjJkNWVhNDkxMTE1NGZmZGIwZDM2ODA0ZWE3MmM0ZDQxMGNmYTcwMTVh
-    YzM3OWU5ZjUyYTJmZmExYTEyMDFiY2YyZmIzZThhYzhlMGYxNzI=
+    NzY1MDRhMzUxYzgxNzRhYzAxZGYzOTk5OTJiMGUzMzU2ODUwMGMwNTM0MmJh
+    M2FhOWQxMmExNzYyMjM0NThiZDY4MDM0ZDVjOWIwMDI2NzFhMDQ4YzdhNmU1
+    ZjhiMzY1MGZkODJmY2E2MjlmNjAwNzkxMTdmNzlkMTljM2IxM2Y=

data/CHANGELOG.md

@@ -1,7 +1,12 @@
+0.3.3
+-----
+* Support user defined foreign keys on scoped models
+
 0.3.2
 -----
 * correctly support nested models with has_many :through (thx dexion)
 * Support 'www.subdomain.example.com' (thx wtfiwtz)
+* Support user defined foreign keys on scoped models
 * Support setting `tenant_id` on scoped models if the `tenant_id` is nil (thx Matt Wilson)
 
 0.3.1

data/README.md

@@ -21,14 +21,14 @@ 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.
 
 To use it, add it to your Gemfile:
-  
+
     gem 'acts_as_tenant'
-  
+
 Getting started
 ===============
 There are two steps in adding multi-tenancy to your app with acts_as_tenant:
 
-1. setting the current tenant and 
+1. setting the current tenant and
 2. scoping your models.
 
 Setting the current tenant
@@ -48,7 +48,7 @@ This tells acts_as_tenant to use the current subdomain to identify the current t
     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)
@@ -83,26 +83,26 @@ Scoping your models
     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)   
-    
-    # All searches are scoped by the tenant, the following searches will only return objects 
+    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
-     
+
     # 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 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>
@@ -117,6 +117,12 @@ If you need to validate for uniqueness, chances are that you want to scope this
 
 All options available to Rails' own `validates_uniqueness_of` are also available to this method.
 
+**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
+
 Configuration options
 ---------------------
 An initializer can be created to control (currently one) option in ActsAsTenant. Defaults
@@ -136,7 +142,7 @@ Whenever you set the `current_tenant` in your tests, either through integration
 
 To Do
 -----
-* Change the tests to Test::Unit so I can easily add some controller tests.
+* ...
 
 Bug reports & suggested improvements
 ------------------------------------
@@ -148,7 +154,7 @@ If you want to contribute, fork the project, code your improvements and make a p
 
 Author & Credits
 ----------------
-acts_as_tenant is written by Erwin Matthijssen.  
+acts_as_tenant is written by Erwin Matthijssen.
 Erwin is currently busy developing [Roll Call](http://www.rollcallapp.com/ "Roll Call App").
 
 This gem was inspired by Ryan Sonnek's [Multitenant](https://github.com/wireframe/multitenant) gem and its use of default_scope.

data/lib/acts_as_tenant/model_extensions.rb

@@ -1,18 +1,18 @@
 module ActsAsTenant
   @@tenant_klass = nil
-  
+
   def self.set_tenant_klass(klass)
     @@tenant_klass = klass
   end
-  
+
   def self.tenant_klass
     @@tenant_klass
   end
-  
+
   def self.fkey
     "#{@@tenant_klass.to_s}_id"
   end
-  
+
   def self.current_tenant=(tenant)
     RequestStore.store[:current_tenant] = tenant
   end
@@ -34,22 +34,30 @@ module ActsAsTenant
   ensure
     self.current_tenant = old_tenant
   end
-  
+
   module ModelExtensions
     def self.included(base)
       base.extend(ClassMethods)
     end
-  
+
     module ClassMethods
-      def acts_as_tenant(association = :account)
-        belongs_to association
-        ActsAsTenant.set_tenant_klass(association)
-        
+      def acts_as_tenant(tenant = :account, options = {})
+
+        ActsAsTenant.set_tenant_klass(tenant)
+
+        unless options[:foreign_key].nil?
+          fkey = options[:foreign_key]
+          belongs_to tenant, :foreign_key => fkey
+        else
+          fkey = ActsAsTenant.fkey
+          belongs_to tenant
+        end
+
         default_scope lambda {
           if ActsAsTenant.configuration.require_tenant && ActsAsTenant.current_tenant.nil?
             raise ActsAsTenant::Errors::NoTenantSet
           end
-          where("#{self.table_name}.#{ActsAsTenant.fkey} = ?", ActsAsTenant.current_tenant.id)  if ActsAsTenant.current_tenant
+          where("#{self.table_name}.#{fkey} = ?", ActsAsTenant.current_tenant.id)  if ActsAsTenant.current_tenant
         }
 
         # Add the following validations to the receiving model:
@@ -58,47 +66,54 @@ module ActsAsTenant
         #
         before_validation Proc.new {|m|
           if ActsAsTenant.current_tenant
-            m.send "#{association}_id=".to_sym, ActsAsTenant.current_tenant.id
+            m.send "#{fkey}=".to_sym, ActsAsTenant.current_tenant.id
           end
         }, :on => :create
-    
+
         reflect_on_all_associations.each do |a|
-          unless a == reflect_on_association(association) || a.macro != :belongs_to || a.options[:polymorphic] 
+          unless a == reflect_on_association(tenant) || a.macro != :belongs_to || a.options[:polymorphic]
             association_class =  a.options[:class_name].nil? ? a.name.to_s.classify.constantize : a.options[:class_name].constantize
             validates_each a.foreign_key.to_sym do |record, attr, value|
               record.errors.add attr, "association is invalid [ActsAsTenant]" unless value.nil? || association_class.where(:id => value).present?
             end
           end
         end
-        
+
         # Dynamically generate the following methods:
         # - Rewrite the accessors to make tenant immutable
+        # - Add an override to prevent unnecessary db hits
         # - Add a helper method to verify if a model has been scoped by AaT
         #
-        define_method "#{ActsAsTenant.fkey}=" do |integer|
-          raise ActsAsTenant::Errors::TenantIsImmutable unless new_record? || send(ActsAsTenant.fkey).nil?
-          write_attribute("#{ActsAsTenant.fkey}", integer)
+        define_method "#{fkey}=" do |integer|
+          raise ActsAsTenant::Errors::TenantIsImmutable unless new_record? || send(fkey).nil?
+          write_attribute("#{fkey}", integer)
         end
 
         define_method "#{ActsAsTenant.tenant_klass.to_s}=" do |model|
-          raise ActsAsTenant::Errors::TenantIsImmutable unless new_record? || send(ActsAsTenant.fkey).nil?
+          raise ActsAsTenant::Errors::TenantIsImmutable unless new_record? || send(fkey).nil?
           super(model)
         end
-        
+
+        define_method "#{ActsAsTenant.tenant_klass.to_s}" do
+          return ActsAsTenant.current_tenant if send(fkey) == ActsAsTenant.current_tenant.id
+          super()
+        end
+
         def scoped_by_tenant?
           true
         end
       end
-      
+
       def validates_uniqueness_to_tenant(fields, args ={})
         raise ActsAsTenant::Errors::ModelNotScopedByTenant unless respond_to?(:scoped_by_tenant?)
-        tenant_id = lambda { "#{ActsAsTenant.fkey}"}.call
+        fkey = reflect_on_association(ActsAsTenant.tenant_klass).foreign_key
+        #tenant_id = lambda { "#{ActsAsTenant.fkey}"}.call
         if args[:scope]
-          args[:scope] = Array(args[:scope]) << tenant_id
+          args[:scope] = Array(args[:scope]) << fkey
         else
-          args[:scope] = tenant_id
+          args[:scope] = fkey
         end
-        
+
         validates_uniqueness_of(fields, args)
       end
     end

data/lib/acts_as_tenant/version.rb

@@ -1,3 +1,3 @@
 module ActsAsTenant
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

data/spec/acts_as_tenant/model_extensions_spec.rb

@@ -29,17 +29,28 @@ ActiveRecord::Schema.define(:version => 1) do
     t.column :name, :string
   end
 
-  create_table :cities, :force => true do |t|
+  create_table :unscoped_models, :force => true do |t|
     t.column :name, :string
   end
 
-  create_table :sub_tasks, :force => true do |t|
+  create_table :aliased_tasks, :force => true do |t|
     t.column :name, :string
-    t.column :attribute2, :string
-    t.column :something_else, :integer
+    t.column :project_alias_id, :integer
     t.column :account_id, :integer
   end
 
+  create_table :unique_tasks, :force => true do |t|
+    t.column :name, :string
+    t.column :user_defined_scope, :string
+    t.column :project_id, :integer
+    t.column :account_id, :integer
+  end
+
+  create_table :custom_foreign_key_tasks, :force => true do |t|
+    t.column :name, :string
+    t.column :accountID, :integer
+  end
+
 end
 
 # Setup the models
@@ -68,20 +79,31 @@ class Task < ActiveRecord::Base
   validates_uniqueness_of :name
 end
 
-class City < ActiveRecord::Base
+class UnscopedModel < ActiveRecord::Base
   validates_uniqueness_of :name
 end
 
-class SubTask < ActiveRecord::Base
-  acts_as_tenant :account
-  belongs_to :something_else, :class_name => "Project"
-  validates_uniqueness_to_tenant :name, scope: :attribute2
+class AliasedTask < ActiveRecord::Base
+  acts_as_tenant(:account)
+  belongs_to :project_alias, :class_name => "Project"
+end
+
+class UniqueTask < ActiveRecord::Base
+  acts_as_tenant(:account)
+  belongs_to :project
+  validates_uniqueness_to_tenant :name, scope: :user_defined_scope
+end
+
+class CustomForeignKeyTask < ActiveRecord::Base
+  acts_as_tenant(:account, :foreign_key => "accountID")
+  validates_uniqueness_to_tenant :name
 end
 
 # Start testing!
 describe ActsAsTenant do
   after { ActsAsTenant.current_tenant = nil }
 
+  # Setting and getting
   describe 'Setting the current tenant' do
     before { ActsAsTenant.current_tenant = :foo }
     it { ActsAsTenant.current_tenant == :foo }
@@ -91,6 +113,36 @@ describe ActsAsTenant do
     it {Project.respond_to?(:scoped_by_tenant?).should == true}
   end
 
+  describe 'tenant_id should be immutable, if already set' do
+    before do
+      @account = Account.create!(:name => 'foo')
+      @project = @account.projects.create!(:name => 'bar')
+    end
+
+    it { lambda {@project.account_id = @account.id + 1}.should raise_error }
+  end
+
+  describe 'tenant_id should be mutable, if not already set' do
+    before do
+      @account = Account.create!(:name => 'foo')
+      @project = Project.create!(:name => 'bar')
+    end
+
+    it { @project.account_id.should be_nil }
+    it { lambda { @project.account = @account }.should_not raise_error }
+  end
+
+  describe 'Handles custom foreign_key on tenant model' do
+    before do
+      @account  = Account.create!(:name => 'foo')
+      ActsAsTenant.current_tenant = @account
+      @custom_foreign_key_task = CustomForeignKeyTask.create!(:name => 'foo')
+    end
+
+    it { @custom_foreign_key_task.account.should == @account }
+  end
+
+  # Scoping models
   describe 'Project.all should be scoped to the current tenant if set' do
     before do
       @account1 = Account.create!(:name => 'foo')
@@ -122,11 +174,12 @@ describe ActsAsTenant do
     it { @projects.count.should == 2 }
   end
 
+  # Associations
   describe 'Associations should be correctly scoped by current tenant' do
     before do
       @account = Account.create!(:name => 'foo')
-      @project = @account.projects.create!(:name => 'foobar', :account_id => @account.id )
-      # the next line would normally be nearly impossible: a task assigned to a tenant project,
+      @project = Project.create!(:name => 'foobar', :account => @account )
+      # the next line should normally be (nearly) impossible: a task assigned to a tenant project,
       # but the task has no tenant assigned
       @task1 = Task.create!(:name => 'no_tenant', :project => @project)
 
@@ -144,6 +197,30 @@ describe ActsAsTenant do
     end
   end
 
+  describe 'Associations can only be made with in-scope objects' do
+    before do
+      @account = Account.create!(:name => 'foo')
+      @project1 = Project.create!(:name => 'inaccessible_project', :account_id => @account.id + 1)
+
+      ActsAsTenant.current_tenant = @account
+      @project2 = Project.create!(:name => 'accessible_project')
+      @task = @project2.tasks.create!(:name => 'bar')
+    end
+
+    it { @task.update_attributes(:project_id => @project1.id).should == false }
+  end
+
+  describe "Create and save an AaT-enabled child without it having a parent" do
+      @account = Account.create!(:name => 'baz')
+      ActsAsTenant.current_tenant = @account
+      Task.create(:name => 'bar').valid?.should == true
+  end
+
+  describe "It should be possible to use aliased associations" do
+    it { AliasedTask.create(:name => 'foo', :project_alias => @project2).valid?.should == true }
+  end
+
+  # Additional default_scopes
   describe 'When dealing with a user defined default_scope' do
     before do
       @account = Account.create!(:name => 'foo')
@@ -166,47 +243,16 @@ describe ActsAsTenant do
     end
   end
 
-  describe 'tenant_id should be immutable, if already set' do
-    before do
-      @account = Account.create!(:name => 'foo')
-      @project = @account.projects.create!(:name => 'bar')
-    end
-
-    it { lambda {@project.account_id = @account.id + 1}.should raise_error }
-  end
-
-  describe 'tenant_id should be mutable, if not already set' do
-    before do
-      @account = Account.create!(:name => 'foo')
-      @project = Project.create!(:name => 'bar')
-    end
-
-    it { @project.account_id.should be_nil }
-    it { lambda { @project.account = @account }.should_not raise_error }
-  end
-
-  describe 'Associations can only be made with in-scope objects' do
-    before do
-      @account = Account.create!(:name => 'foo')
-      @project1 = Project.create!(:name => 'inaccessible_project', :account_id => @account.id + 1)
-
-      ActsAsTenant.current_tenant = @account
-      @project2 = Project.create!(:name => 'accessible_project')
-      @task = @project2.tasks.create!(:name => 'bar')
-    end
-
-    it { @task.update_attributes(:project_id => @project1.id).should == false }
-  end
-
+  # Validates_uniqueness
   describe 'When using validates_uniqueness_to_tenant in a aat model' do
     before do
-      @account = Account.create!(:name => 'foo')
-      ActsAsTenant.current_tenant = @account
-      @project1 = Project.create!(:name => 'bar')
+      account = Account.create!(:name => 'foo')
+      ActsAsTenant.current_tenant = account
+      Project.create!(:name => 'existing_name')
     end
 
     it 'should not be possible to create a duplicate within the same tenant' do
-      Project.create(:name => 'bar').valid?.should == false
+      Project.create(:name => 'existing_name').valid?.should == false
     end
 
     it 'should be possible to create a duplicate outside the tenant scope' do
@@ -214,33 +260,27 @@ describe ActsAsTenant do
       ActsAsTenant.current_tenant = account
       Project.create(:name => 'bar').valid?.should == true
     end
+  end
 
-    it 'applies additional scopes' do
-      subtask1 = SubTask.create!(:name => 'foo', :attribute2 => 'unique_scope')
-      SubTask.create(:name => 'foo', :attribute2 => 'another_scope').should be_valid
-      SubTask.create(:name => 'foo', :attribute2 => 'unique_scope').should_not be_valid
+  describe 'Handles user defined scopes' do
+    before do
+      UniqueTask.create!(:name => 'foo', :user_defined_scope => 'unique_scope')
     end
+
+    it { UniqueTask.create(:name => 'foo', :user_defined_scope => 'another_scope').should be_valid }
+    it { UniqueTask.create(:name => 'foo', :user_defined_scope => 'unique_scope').should_not be_valid }
   end
 
   describe 'When using validates_uniqueness_of in a NON-aat model' do
     before do
-      @city1 = City.create!(:name => 'foo')
+      UnscopedModel.create!(:name => 'foo')
     end
     it 'should not be possible to create duplicates' do
-      City.create(:name => 'foo').valid?.should == false
+      UnscopedModel.create(:name => 'foo').valid?.should == false
     end
   end
 
-  describe "It should be possible to use aliased associations" do
-    it { SubTask.create(:name => 'foo').valid?.should == true }
-  end
-
-  describe "It should be possible to create and save an AaT-enabled child without it having a parent" do
-      @account = Account.create!(:name => 'baz')
-      ActsAsTenant.current_tenant = @account
-      Task.create(:name => 'bar').valid?.should == true
-  end
-
+  # ::with_tenant
   describe "::with_tenant" do
     it "should set current_tenant to the specified tenant inside the block" do
       @account = Account.create!(:name => 'baz')
@@ -279,6 +319,7 @@ describe ActsAsTenant do
     end
   end
 
+  # Tenant required
   context "tenant required" do
     describe "raises exception if no tenant specified" do
       before do

data/spec/acts_as_tenant/tenant_by_filter_spec.rb

@@ -15,7 +15,7 @@ class ApplicationController2 < ActionController::Base
     current_account.name = 'account1'
     set_current_tenant(current_account)
   end
-  
+
 end
 
 # Start testing
@@ -25,7 +25,7 @@ describe ApplicationController2, :type => :controller do
       render :text => "custom called"
     end
   end
-  
+
   it 'Finds the correct tenant using the filter command' do
     get :index
     ActsAsTenant.current_tenant.name.should eq 'account1'

data/spec/acts_as_tenant/tenant_by_subdomain_spec.rb

@@ -15,14 +15,14 @@ describe ApplicationController, :type => :controller do
       render :text => "custom called"
     end
   end
-  
+
   it 'Finds the correct tenant with a subdomain.example.com' do
     @request.host = "account1.example.com"
     Account.should_receive(:where).with({subdomain: 'account1'}) {['account1']}
     get :index
     ActsAsTenant.current_tenant.should eq 'account1'
   end
-  
+
   it 'Finds the correct tenant with a www.subdomain.example.com' do
     @request.host = "www.account1.example.com"
     Account.should_receive(:where).with({subdomain: 'account1'}) {['account1']}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_tenant
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Erwin Matthijssen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-04 00:00:00.000000000 Z
+date: 2014-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store