acts_as_tenant 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fda1a0075313a96256ff1815cf9fd08422e2cfd18934703e8325273b2b941a3e
-  data.tar.gz: e89bef1337f0210769a0ffaca7c081a111944bdbdb5b4d282118df39f4a1d53f
+  metadata.gz: b9dbb40015b39583a44c37496f0687641e1a66f9b70357260b1fcabe7f3c542d
+  data.tar.gz: 88d1ce36220fd3c8e8264b95d76afb7f883cc77da0ac9f12538cde682fa9dacf
 SHA512:
-  metadata.gz: b80f8de28ae30db10fdca8e9a2a290e014c87ab195b250661c4c81a7d33d761b67929b2b43f77380c3c5fbe128611ede07e135c7adc3708f9fbe406d1f7e8516
-  data.tar.gz: ec85db56efcd7441559ef33adbc0ec25bd366108aa3bd2da9f1bd3279776e45181e9153796d2071116991c63a76e849b1411d8d852c4ba25fb0497958a59192a
+  metadata.gz: 7d76fbf4cc3381afdfa2c02627ad6de56ff9e4cdaa636da4103e11e38ee48a6f6ecf3f432f296bfd3b8ae5cfc690d8fc52cbc7e025953e39cf3b3dab4439d3f1
+  data.tar.gz: ba09cb46b06f2399de2ac2e4d6efa3369d22e287a6741bfd0fcfc483836b64ac96851dd671dd4a97bace409c7aa72f6e7fc03394250f853c55a54159e720118a

data/README.md

@@ -1,7 +1,8 @@
-Acts As Tenant
-==============
+# Acts As Tenant
 
-[![Build Status](https://github.com/ErwinM/acts_as_tenant/workflows/Tests/badge.svg)](https://github.com/ErwinM/acts_as_tenant/actions)
+[![Build Status](https://github.com/ErwinM/acts_as_tenant/workflows/Tests/badge.svg)](https://github.com/ErwinM/acts_as_tenant/actions) [![Gem Version](https://badge.fury.io/rb/acts_as_tenant.svg)](https://badge.fury.io/rb/acts_as_tenant)
+
+Row-level multitenancy for Ruby on Rails apps.
 
 This gem was born out of our own need for a fail-safe and out-of-the-way manner to add multi-tenancy to our Rails app through a shared database strategy, that integrates (near) seamless with Rails.
 
@@ -16,9 +17,25 @@ In addition, acts_as_tenant:
 
 **Note**: acts_as_tenant was introduced in this [blog post](https://github.com/ErwinM/acts_as_tenant/blob/master/docs/blog_post.md).
 
+**Row-level vs schema multitenancy**
+
+What's the difference?
+
+Row-level multitenancy  each model must have a tenant ID column on it. This makes it easy to filter records for each tenant using your standard database columns and indexes. ActsAsTenant uses row-level multitenancy.
+
+Schema multitenancy uses database schemas to handle multitenancy. For this approach, your database has multiple schemas and each schema contains your database tables. Schemas require migrations to be run against each tenant and generally makes it harder to scale as you add more tenants. The Apartment gem uses schema multitenancy.
+
+#### 🎬 Walkthrough 
+
+Want to see how it works? Check out [the ActsAsTenant walkthrough video](https://www.youtube.com/watch?v=BIyxM9f8Jus):
+
+<a href="https://www.youtube.com/watch?v=BIyxM9f8Jus">
+<img src="https://i.imgur.com/DLRPzhv.png" width="300" height="auto" alt="ActsAsTenant Walkthrough Video">
+</a>
+
 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 5.2 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:
 
@@ -206,6 +223,23 @@ end
 
 * `config.require_tenant` when set to true will raise an ActsAsTenant::NoTenant error whenever a query is made without a tenant set.
 
+belongs_to options
+---------------------
+`acts_as_tenant :account` includes the belongs_to relationship. 
+So when using acts_as_tenant on a model, do not add `belongs_to :account` alongside `acts_as_tenant :account`:
+
+```
+class User < ActiveRecord::Base
+  acts_as_tenant(:account) # YES
+  belongs_to :account # REDUNDANT
+end
+```
+
+You can add the following `belongs_to` options to `acts_as_tenant`:
+`:foreign_key, :class_name, :inverse_of, :optional, :primary_key, :counter_cache`
+
+Example: `acts_as_tenant(:account, counter_cache: true)`
+
 Sidekiq support
 ---------------
 

data/lib/acts_as_tenant/model_extensions.rb

@@ -28,7 +28,7 @@ module ActsAsTenant
             query_criteria[polymorphic_type.to_sym] = ActsAsTenant.current_tenant.class.to_s if options[:polymorphic]
             where(query_criteria)
           else
-            ActiveRecord::VERSION::MAJOR < 4 ? scoped : all
+            all
           end
         }
 
@@ -53,14 +53,13 @@ module ActsAsTenant
 
         reflect_on_all_associations(:belongs_to).each do |a|
           unless a == reflect_on_association(tenant) || polymorphic_foreign_keys.include?(a.foreign_key)
-            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|
               primary_key = if a.respond_to?(:active_record_primary_key)
                 a.active_record_primary_key
               else
                 a.primary_key
               end.to_sym
-              record.errors.add attr, "association is invalid [ActsAsTenant]" unless value.nil? || association_class.where(primary_key => value).any?
+              record.errors.add attr, "association is invalid [ActsAsTenant]" unless value.nil? || a.klass.where(primary_key => value).any?
             end
           end
         end
@@ -93,34 +92,36 @@ 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
-        # tenant_id = lambda { "#{ActsAsTenant.fkey}"}.call
-        args[:scope] = if args[:scope]
+
+        validation_args = args.clone
+        validation_args[:scope] = if args[:scope]
           Array(args[:scope]) << fkey
         else
           fkey
         end
 
-        validates_uniqueness_of(fields, args)
+        # validating within tenant scope
+        validates_uniqueness_of(fields, validation_args)
 
         if ActsAsTenant.models_with_global_records.include?(self)
-          validate do |instance|
-            Array(fields).each do |field|
-              if instance.new_record?
-                unless self.class.where(fkey.to_sym => [nil, instance[fkey]],
-                                        field.to_sym => instance[field]).empty?
-                  errors.add(field, "has already been taken")
-                end
-              else
-                unless self.class.where(fkey.to_sym => [nil, instance[fkey]],
-                                        field.to_sym => instance[field])
-                    .where.not(id: instance.id).empty?
-                  errors.add(field, "has already been taken")
-                end
-
-              end
-            end
-          end
+          arg_if = args.delete(:if)
+          arg_condition = args.delete(:conditions)
+
+          # if tenant is not set (instance is global) - validating globally
+          global_validation_args = args.merge(
+            if: ->(instance) { instance[fkey].blank? && (arg_if.blank? || arg_if.call(instance)) }
+          )
+          validates_uniqueness_of(fields, global_validation_args)
+
+          # if tenant is set (instance is not global) and records can be global - validating within records with blank tenant
+          blank_tenant_validation_args = args.merge({
+            conditions: -> { arg_condition.blank? ? where(fkey => nil) : arg_condition.call.where(fkey => nil) },
+            if: ->(instance) { instance[fkey].present? && (arg_if.blank? || arg_if.call(instance)) }
+          })
+
+          validates_uniqueness_of(fields, blank_tenant_validation_args)
         end
       end
     end

data/lib/acts_as_tenant/version.rb

@@ -1,3 +1,3 @@
 module ActsAsTenant
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

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

@@ -0,0 +1,6 @@
+class GlobalProjectWithConditions < ActiveRecord::Base
+  self.table_name = "projects"
+
+  acts_as_tenant :account, has_global_records: true
+  validates_uniqueness_to_tenant :name, conditions: -> { where(name: "foo") }
+end

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

@@ -0,0 +1,6 @@
+class GlobalProjectWithIf < ActiveRecord::Base
+  self.table_name = "projects"
+
+  acts_as_tenant :account, has_global_records: true
+  validates_uniqueness_to_tenant :name, if: ->(instance) { instance.name == "foo" }
+end

data/spec/models/model_extensions_spec.rb

@@ -113,6 +113,11 @@ describe ActsAsTenant do
       expect(GlobalProject.all.count).to eq(GlobalProject.unscoped.where(account: [nil]).count)
     end
 
+    it "should add the model to ActsAsTenant.models_with_global_records" do
+      expect(ActsAsTenant.models_with_global_records.include?(GlobalProject)).to be_truthy
+      expect(ActsAsTenant.models_with_global_records.include?(Project)).to be_falsy
+    end
+
     context "should validate tenant records against global & tenant records" do
       it "global records are valid" do
         expect(global_projects(:global).valid?).to be(true)
@@ -122,7 +127,13 @@ describe ActsAsTenant do
         expect(GlobalProject.new(name: "foo new").valid?).to be(true)
       end
 
-      it "is invalid with with duplicate tenant records" do
+      it "is valid if tenant is different" do
+        ActsAsTenant.current_tenant = accounts(:bar)
+
+        expect(GlobalProject.new(name: "global foo").valid?).to be(true)
+      end
+
+      it "is invalid with duplicate tenant records" do
         expect(GlobalProject.new(name: "global foo").valid?).to be(false)
       end
 
@@ -131,9 +142,28 @@ describe ActsAsTenant do
       end
     end
 
-    it "should add the model to ActsAsTenant.models_with_global_records" do
-      expect(ActsAsTenant.models_with_global_records.include?(GlobalProject)).to be_truthy
-      expect(ActsAsTenant.models_with_global_records.include?(Project)).to be_falsy
+    context "should validate global records against global & tenant records" do
+      before do
+        ActsAsTenant.current_tenant = nil
+      end
+
+      it "is invalid if global record conflicts with tenant record" do
+        expect(GlobalProject.new(name: "global foo").valid?).to be(false)
+      end
+    end
+
+    context "with conditions in args" do
+      it "respects conditions" do
+        expect(GlobalProjectWithConditions.new(name: "foo").valid?).to be(false)
+        expect(GlobalProjectWithConditions.new(name: "global foo").valid?).to be(true)
+      end
+    end
+
+    context "with if in args" do
+      it "respects if" do
+        expect(GlobalProjectWithIf.new(name: "foo").valid?).to be(false)
+        expect(GlobalProjectWithIf.new(name: "global foo").valid?).to be(true)
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_tenant
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Erwin Matthijssen
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-18 00:00:00.000000000 Z
+date: 2021-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store
@@ -181,6 +181,8 @@ files:
 - spec/dummy/app/models/custom_foreign_key_task.rb
 - spec/dummy/app/models/custom_primary_key_task.rb
 - spec/dummy/app/models/global_project.rb
+- spec/dummy/app/models/global_project_with_conditions.rb
+- spec/dummy/app/models/global_project_with_if.rb
 - spec/dummy/app/models/manager.rb
 - spec/dummy/app/models/polymorphic_tenant_comment.rb
 - spec/dummy/app/models/project.rb
@@ -252,7 +254,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Add multi-tenancy to Rails applications using a shared db strategy
@@ -285,6 +287,8 @@ test_files:
 - spec/dummy/app/models/custom_foreign_key_task.rb
 - spec/dummy/app/models/custom_primary_key_task.rb
 - spec/dummy/app/models/global_project.rb
+- spec/dummy/app/models/global_project_with_conditions.rb
+- spec/dummy/app/models/global_project_with_if.rb
 - spec/dummy/app/models/manager.rb
 - spec/dummy/app/models/polymorphic_tenant_comment.rb
 - spec/dummy/app/models/project.rb