acts_as_tenant 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82220bfda9712aaff3d6d06aa5ddbd236290d861
-  data.tar.gz: a2e325e8ed0ef37fb3a2bf0ab606eeede7e6907b
+  metadata.gz: 9820de48ce59a3e8efae341784175dadf04820cf
+  data.tar.gz: 28cc62d3e62171c690fd9ba48bbd53c29c5efdc7
 SHA512:
-  metadata.gz: e64518b47c7500dad952b6ffe4f1faf5b5d23965fd997fa98bef9a5fd9abd33613dac5b743d8aaec146495d615998d7677d67112efc69387e6d76397e83b1683
-  data.tar.gz: 535154c7c6ac8e4044fbdc989b931e78fc307027aa154e8b14fc63abd658b76d418d19c0abfbbff3265add12a2a1b861a22fa66f03c89ff419ac1870648ce233
+  metadata.gz: aa052469cd82efe7062999976d4782f2240718731331698ced6ceb324646aafd431e15ca66a98d55a398192ab410bf0a0620e962e9128a3daf7220dff871c4f3
+  data.tar.gz: 54d961326dedf594be8b87b9603feb063c4ee43a8bb2b8a86a973571b6f01cafd48cc4bd86127ca71771d0e91f275e61549f366c80be425a24df7af1ac1fa3cc

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+0.4.4
+-----
+* Implement support for polymorphic tenant
+* Ability to use acts_as_tenant with only ActiveRecord (no Rails)
+* Allow setting of custom primary key
+* Bug fixes
+
 0.4.3
 -----
 * allow 'optional' relations

data/README.md

@@ -94,7 +94,7 @@ This is useful in shared routes such as admin panels or internal dashboards when
 
 ### 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.
+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 configuration options.
 
 Scoping your models
 -------------------
@@ -210,6 +210,10 @@ If you have found a bug or want to suggest an improvement, please use our issue
 
 If you want to contribute, fork the project, code your improvements and make a pull request on [Github](http://github.com/ErwinM/acts_as_tenant/). When doing so, please don't forget to add tests. If your contribution is fixing a bug it would be perfect if you could also submit a failing test, illustrating the issue.
 
+Help maintain this gem
+----------------------
+I myself, do not work with RoR much anymore. As a result, I only check this repo a few time a year. If  wants to help me maintain this gem on a more regular basis, shoot me a message!
+
 Author & Credits
 ----------------
 acts_as_tenant is written by Erwin Matthijssen.

data/acts_as_tenant.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency('rspec', '>=3.0')
   s.add_development_dependency('rspec-rails')
-  s.add_development_dependency('database_cleaner', '~> 1.5.3')
+  s.add_development_dependency('database_cleaner', '~> 1.7')
   s.add_development_dependency('sqlite3')
   #s.add_development_dependency('mongoid', '~> 4.0')
 

data/lib/acts_as_tenant/model_extensions.rb

@@ -22,6 +22,14 @@ module ActsAsTenant
     "#{@@tenant_klass.to_s}_id"
   end
 
+  def self.pkey
+    :id
+  end
+
+  def self.polymorphic_type
+    "#{@@tenant_klass.to_s}_type"
+  end
+
   def self.current_tenant=(tenant)
     RequestStore.store[:current_tenant] = tenant
   end
@@ -43,7 +51,13 @@ module ActsAsTenant
   end
 
   class << self
-    attr_accessor :default_tenant
+    def default_tenant=(tenant)
+      @default_tenant = tenant
+    end
+
+    def default_tenant
+      @default_tenant unless unscoped
+    end
   end
 
   def self.with_tenant(tenant, &block)
@@ -90,8 +104,10 @@ module ActsAsTenant
         ActsAsTenant.add_global_record_model(self) if options[:has_global_records]
 
         # Create the association
-        valid_options = options.slice(:foreign_key, :class_name, :inverse_of, :optional)
+        valid_options = options.slice(:foreign_key, :class_name, :inverse_of, :optional, :primary_key)
         fkey = valid_options[:foreign_key] || ActsAsTenant.fkey
+        pkey = valid_options[:primary_key] || ActsAsTenant.pkey
+        polymorphic_type = valid_options[:foreign_type] || ActsAsTenant.polymorphic_type
         belongs_to tenant, valid_options
 
         default_scope lambda {
@@ -99,11 +115,14 @@ module ActsAsTenant
             raise ActsAsTenant::Errors::NoTenantSet
           end
           if ActsAsTenant.current_tenant
-            keys = [ActsAsTenant.current_tenant.id]
+            keys = [ActsAsTenant.current_tenant.send(pkey)]
             keys.push(nil) if options[:has_global_records]
-            where(fkey.to_sym => keys)
+
+            query_criteria = { fkey.to_sym => keys }
+            query_criteria.merge!({ polymorphic_type.to_sym => ActsAsTenant.current_tenant.class.to_s }) if options[:polymorphic]
+            where(query_criteria)
           else
-            Rails::VERSION::MAJOR < 4 ? scoped : all
+            ActiveRecord::VERSION::MAJOR < 4 ? scoped : all
           end
         }
 
@@ -113,7 +132,12 @@ module ActsAsTenant
         #
         before_validation Proc.new {|m|
           if ActsAsTenant.current_tenant
-            m.send "#{fkey}=".to_sym, ActsAsTenant.current_tenant.id
+            if options[:polymorphic]
+              m.send("#{fkey}=".to_sym, ActsAsTenant.current_tenant.class.to_s) if m.send("#{fkey}").nil?
+              m.send("#{polymorphic_type}=".to_sym, ActsAsTenant.current_tenant.class.to_s) if m.send("#{polymorphic_type}").nil?
+            else
+              m.send "#{fkey}=".to_sym, ActsAsTenant.current_tenant.send(pkey)
+            end
           end
         }, :on => :create
 
@@ -153,7 +177,7 @@ module ActsAsTenant
           end
 
           define_method "#{ActsAsTenant.tenant_klass.to_s}" do
-            if !ActsAsTenant.current_tenant.nil? && send(fkey) == ActsAsTenant.current_tenant.id
+            if !ActsAsTenant.current_tenant.nil? && send(fkey) == ActsAsTenant.current_tenant.send(pkey)
               return ActsAsTenant.current_tenant
             else
               super()
@@ -172,6 +196,7 @@ module ActsAsTenant
       def validates_uniqueness_to_tenant(fields, args ={})
         raise ActsAsTenant::Errors::ModelNotScopedByTenant unless respond_to?(:scoped_by_tenant?)
         fkey = reflect_on_association(ActsAsTenant.tenant_klass).foreign_key
+        pkey = reflect_on_association(ActsAsTenant.tenant_klass).active_record_primary_key
         #tenant_id = lambda { "#{ActsAsTenant.fkey}"}.call
         if args[:scope]
           args[:scope] = Array(args[:scope]) << fkey

data/lib/acts_as_tenant/version.rb

@@ -1,3 +1,3 @@
 module ActsAsTenant
-  VERSION = "0.4.3"
+  VERSION = "0.4.4"
 end

data/spec/active_record_models.rb

@@ -49,12 +49,22 @@ ActiveRecord::Schema.define(:version => 1) do
     t.column :accountID, :integer
   end
 
+  create_table :articles, :force => true do |t|
+    t.column :title, :string
+  end
+
   create_table :comments, :force => true do |t|
     t.column :commentable_id, :integer
     t.column :commentable_type, :string
     t.column :account_id, :integer
   end
 
+  create_table :polymorphic_tenant_comments, :force => true do |t|
+    t.column :polymorphic_tenant_commentable_id, :integer
+    t.column :polymorphic_tenant_commentable_type, :string
+    t.column :account_id, :integer
+  end
+
 end
 
 class Account < ActiveRecord::Base
@@ -64,6 +74,7 @@ end
 class Project < ActiveRecord::Base
   has_one :manager
   has_many :tasks
+  has_many :polymorphic_tenant_comments, as: :polymorphic_tenant_commentable
   acts_as_tenant :account
 
   validates_uniqueness_to_tenant :name
@@ -102,12 +113,28 @@ class CustomForeignKeyTask < ActiveRecord::Base
   validates_uniqueness_to_tenant :name
 end
 
+class CustomPrimaryKeyTask < ActiveRecord::Base
+  self.table_name = 'projects'
+  acts_as_tenant(:account, :foreign_key => "name", :primary_key => "name")
+  validates_presence_of :name
+end
+
 class Comment < ActiveRecord::Base
   belongs_to :commentable, polymorphic: true
   belongs_to :task, -> { where(comments: { commentable_type: 'Task'  })  }, foreign_key: 'commentable_id'
   acts_as_tenant :account
 end
 
+class Article < ActiveRecord::Base
+  has_many :polymorphic_tenant_comments, as: :polymorphic_tenant_commentable
+end
+
+class PolymorphicTenantComment < ActiveRecord::Base
+  belongs_to :polymorphic_tenant_commentable, polymorphic: true
+  belongs_to :account
+  acts_as_tenant :polymorphic_tenant_commentable, polymorphic: true
+end
+
 class GlobalProject < ActiveRecord::Base
   self.table_name = 'projects'
 

data/spec/acts_as_tenant/model_extensions_spec.rb

@@ -73,6 +73,18 @@ describe ActsAsTenant do
     it { expect(@custom_foreign_key_task.account).to eq(@account) }
   end
 
+  describe 'Handles custom primary_key on tenant model' do
+    before do
+      @account = Account.create!(:name => 'foo')
+      CustomPrimaryKeyTask.create!(name: 'bar')
+      ActsAsTenant.current_tenant = @account
+      @custom_primary_key_task = CustomPrimaryKeyTask.create!
+    end
+
+    it { expect(@custom_primary_key_task.account).to eq(@account) }
+    it { expect(CustomPrimaryKeyTask.count).to eq(1) }
+  end
+
   # Scoping models
   describe 'Project.all should be scoped to the current tenant if set' do
     before do
@@ -199,14 +211,46 @@ describe ActsAsTenant do
   end
 
   describe "It should be possible to use associations with foreign_key from polymorphic" do
-    before do
-      @account = Account.create!(name: 'foo')
-      ActsAsTenant.current_tenant = @account
-      @project = Project.create!(name: 'project', account: @account)
-      @comment = Comment.new commentable: @project, account: @account
+    context 'tenanted objects have a polymorphic association' do
+      before do
+        @account = Account.create!(name: 'foo')
+        ActsAsTenant.current_tenant = @account
+        @project = Project.create!(name: 'project', account: @account)
+        @comment = Comment.new commentable: @project, account: @account
+      end
+
+      it { expect(@comment.save!).to eq(true) }
     end
 
-    it { expect(@comment.save!).to eq(true) }
+    context 'tenant is polymorphic' do
+      before do
+        @account = Account.create!(name: 'foo')
+        @project = Project.create!(name: 'polymorphic project')
+        ActsAsTenant.current_tenant = @project
+        @comment = PolymorphicTenantComment.new(account: @account)
+      end
+
+      it 'populates commentable_type with the current tenant' do
+        expect(@comment.polymorphic_tenant_commentable_id).to eql(@project.id)
+        expect(@comment.polymorphic_tenant_commentable_type).to eql(@project.class.to_s)
+      end
+
+      context 'with another type of tenant, same id' do
+        before do
+          @comment.save!
+          @article = Article.create!(id: @project.id, title: 'article title')
+          @comment_on_article = @article.polymorphic_tenant_comments.create!
+        end
+
+        it 'correctly scopes to the current tenant type' do
+          expect(@comment_on_article).to be_persisted
+          expect(@comment).to be_persisted
+          expect(PolymorphicTenantComment.count).to eql(1)
+          expect(PolymorphicTenantComment.all.first.attributes).to eql(@comment.attributes)
+        end
+      end
+
+    end
   end
 
   # Additional default_scopes
@@ -315,6 +359,18 @@ describe ActsAsTenant do
       end
     end
 
+    it "should set current_tenant to nil even if default_tenant is set" do
+      begin
+        old_default_tenant = ActsAsTenant.default_tenant
+        ActsAsTenant.default_tenant = Account.create!(name: 'foo')
+        ActsAsTenant.without_tenant do
+          expect(ActsAsTenant.current_tenant).to be_nil
+        end
+      ensure
+        ActsAsTenant.default_tenant = old_default_tenant
+      end
+    end
+
     it "should reset current_tenant to the previous tenant once exiting the block" do
       @account1 = Account.create!(:name => 'foo')
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_tenant
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Erwin Matthijssen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-29 00:00:00.000000000 Z
+date: 2019-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement