acts_as_tenant 2.0.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e172e79670c2137d3641f2062a07e351ad5291db58ffabad5cd15e8e52850583
-  data.tar.gz: 3445b7da7ef300fbecaa402e351c139f4c994e0ef5c990700ac57d69a9c02c1a
+  metadata.gz: 0ce468857038499bb74b14492a111731539baa6a6bee4a9cecefa9a598b8d48e
+  data.tar.gz: 89e9b45ba6df4ce362a7c17e857cd16d8c28fc10714d021e1a7bcee34811a140
 SHA512:
-  metadata.gz: bf02fcd6565346a41cbdb033952b25c48d79029a496239e2e785386527f0be23acbbe21983b0bc23b39f79c31752857b6eaa2f68bd9a0014f2313e7c8ff7573d
-  data.tar.gz: 9d1b38f89c0a0c26733effc2331d6d9adef3a523dd4333204c8c8234d4c92d363e4d923fcc7b854c517a04946362362a30760639ccbf63dbf65513b10c4ef998
+  metadata.gz: 576e189176dc1099e68db52d2fa6a0c62fd8d36321b23d5b3264ea325c101a34c95c1921dae48d8d7111a0426dc305ecc586575a4486b3275e15cae24733fc4c
+  data.tar.gz: a588f22a10de60ce2ed08d3b00e68ee07c801fa0384c8e9e238d5a024e77567f8f96c2a146290dffb38703ff5e579d96adaae5bd8b7f67f717297a87ba1901c0

data/README.md

@@ -208,7 +208,50 @@ New records are assigned the current tenant unless they already have one. A reco
 
 `belongs_to` associations are validated against the current tenant regardless of whether they are declared before or after `acts_as_tenant`.
 
-When no tenant is set (for example in an admin panel or inside `without_tenant`), `belongs_to` associations to tenanted models are validated to belong to the same tenant as the record. Associated records without a tenant, such as global records, are allowed.
+Associated records are looked up through the associated model's default scopes and the association's scope, and must belong to the same tenant as the record. This also applies when no tenant is set (for example in an admin panel or inside `without_tenant`). Associated records without a tenant, such as global records, are allowed. A record without a tenant can only refer to records of the current tenant.
+
+If the associated model has other default scopes, such as soft deletes, records hidden by them fail the validation. Override `tenant_validation_scope` to change the lookup for all associations to that model:
+
+```ruby
+class Project < ActiveRecord::Base
+  acts_as_tenant :account
+  default_scope { where(deleted_at: nil) }
+
+  # Tasks can refer to soft-deleted projects
+  def self.tenant_validation_scope(relation)
+    relation.unscope(where: :deleted_at)
+  end
+end
+```
+
+To change the lookup for all models, override it in `ApplicationRecord`. The tenants are always compared after the lookup, so a scope that removes the tenant condition can't accept records of another tenant.
+
+To skip the validation of an association, including ones declared elsewhere such as in a gem, override `validate_tenant_association?`:
+
+```ruby
+class Comment < ApplicationRecord
+  acts_as_tenant :account
+  include Trackable # declares belongs_to :source
+
+  def validate_tenant_association?(reflection)
+    reflection.name != :source
+  end
+end
+```
+
+The validation error messages can be overridden in your locale files, using the same lookup as other Active Record errors:
+
+```yaml
+en:
+  activerecord:
+    errors:
+      messages:
+        acts_as_tenant:
+          tenant_mismatch: "must be the current tenant"
+          association_invalid: "is invalid"
+```
+
+Messages can also be overridden for one model or one attribute, such as `activerecord.errors.models.task.acts_as_tenant.association_invalid` or `activerecord.errors.models.task.attributes.project_id.acts_as_tenant.association_invalid`.
 
 ### Validating attribute uniqueness
 

data/lib/acts_as_tenant/locale/en.yml

@@ -0,0 +1,7 @@
+en:
+  activerecord:
+    errors:
+      messages:
+        acts_as_tenant:
+          tenant_mismatch: "must be the current tenant [ActsAsTenant]"
+          association_invalid: "association is invalid [ActsAsTenant]"

data/lib/acts_as_tenant/model_extensions.rb

@@ -78,14 +78,21 @@ module ActsAsTenant
             else
               reflection.klass.polymorphic_name
             end
-            [id, type]
+            [id.to_s, type]
           end
         end
 
-        # Without a current tenant the association lookup isn't scoped, so compare the tenants directly
+        # Returns [tenant id, tenant class] for the current tenant, or nil if none is set
+        current_tenant_identity = lambda do
+          current_tenant = ActsAsTenant.current_tenant
+          [current_tenant.public_send(pkey).to_s, current_tenant.class.polymorphic_name] if current_tenant
+        end
+
+        # Compared directly since the lookup scope may not filter by tenant.
+        # Records without a tenant, such as global records, are compared with the current tenant.
         tenant_mismatch = lambda do |record, associated|
-          if ActsAsTenant.current_tenant.nil? && associated.class.respond_to?(:scoped_by_tenant?)
-            record_tenant = tenant_identity.call(record)
+          if associated.class.respond_to?(:scoped_by_tenant?)
+            record_tenant = tenant_identity.call(record) || current_tenant_identity.call
             associated_tenant = tenant_identity.call(associated)
 
             record_tenant && associated_tenant && record_tenant != associated_tenant
@@ -94,8 +101,8 @@ module ActsAsTenant
 
         # Records must belong to the current tenant, matching what the default scope would find
         validate do |record|
-          current_tenant = ActsAsTenant.current_tenant
-          next unless current_tenant
+          current_id, current_type = current_tenant_identity.call
+          next unless current_id
 
           tenant_attributes = [fkey, polymorphic_type].compact
           next unless record.new_record? || tenant_attributes.any? { |attr| record.will_save_change_to_attribute?(attr) }
@@ -104,10 +111,10 @@ module ActsAsTenant
           next if record_tenant.nil?
 
           record_id, record_type = record_tenant
-          matches = record_id.to_s == current_tenant.public_send(pkey).to_s
-          matches &&= record_type == current_tenant.class.polymorphic_name if options[:polymorphic]
+          matches = record_id == current_id
+          matches &&= record_type == current_type if options[:polymorphic]
 
-          record.errors.add(fkey, "must be the current tenant [ActsAsTenant]") unless matches
+          record.errors.add(fkey, :"acts_as_tenant.tenant_mismatch") unless matches
         end
 
         # Associations are looked up at validation time so belongs_to associations
@@ -116,35 +123,45 @@ module ActsAsTenant
           associations = record.class.reflect_on_all_associations(:belongs_to)
           polymorphic_foreign_keys = associations.select(&:polymorphic?).map(&:foreign_key)
 
-          associations.each do |a|
-            attr = a.foreign_key.to_sym
-            next if a.name == tenant.to_sym
+          associations.each do |association|
+            next if association.name == tenant.to_sym
+
+            attrs = Array(association.foreign_key).map(&:to_sym)
+            key_changed = attrs.any? { |attr| record.will_save_change_to_attribute?(attr) }
 
-            if a.polymorphic?
-              next unless record.will_save_change_to_attribute?(attr) || record.will_save_change_to_attribute?(a.foreign_type)
+            if association.polymorphic?
+              next unless key_changed || record.will_save_change_to_attribute?(association.foreign_type)
             else
               # Associations sharing a polymorphic foreign key are checked through the polymorphic association
-              next if polymorphic_foreign_keys.include?(a.foreign_key)
-              next unless record.will_save_change_to_attribute?(attr)
+              next if polymorphic_foreign_keys.include?(association.foreign_key)
+              next unless key_changed
             end
 
-            value = record.read_attribute_for_validation(attr)
-            next if value.nil?
+            values = attrs.map { |attr| record.read_attribute_for_validation(attr) }
+            next if values.any?(&:nil?)
 
-            klass = if a.polymorphic?
-              type = record.read_attribute(a.foreign_type)&.safe_constantize
+            next unless record.validate_tenant_association?(association)
+
+            klass = if association.polymorphic?
+              type = record.read_attribute(association.foreign_type)&.safe_constantize
               type if type.is_a?(Class) && type < ActiveRecord::Base
             else
-              a.klass
+              # Raises for composite keys whose column counts don't match, like loading the association would
+              association.check_validity! if attrs.size > 1
+              association.klass
             end
 
             associated = if klass
-              relation = a.scope ? a.scope_for(klass.all, record) : klass
-              relation.find_by(a.association_primary_key(klass) => value)
+              # The class itself keeps Rails' cached find_by when there are no scopes
+              relation = association.scope ? association.scope_for(klass.all, record) : klass
+              relation = klass.tenant_validation_scope(relation)
+              relation.find_by(Array(association.association_primary_key(klass)).zip(values).to_h)
             end
 
             if associated.nil? || tenant_mismatch.call(record, associated)
-              record.errors.add attr, "association is invalid [ActsAsTenant]"
+              # Composite keys often include the tenant column, which is not the one to blame
+              error_attr = (attrs - [fkey]).first || attrs.first
+              record.errors.add(error_attr, :"acts_as_tenant.association_invalid")
             end
           end
         end
@@ -185,6 +202,12 @@ module ActsAsTenant
         end
       end
 
+      # The relation used to find associated records when validating belongs_to associations.
+      # Override to change the lookup for all associations to this model, for example to include soft-deleted records.
+      def tenant_validation_scope(relation)
+        relation
+      end
+
       def validates_uniqueness_to_tenant(*fields)
         args = fields.extract_options!
         raise ActsAsTenant::Errors::ModelNotScopedByTenant unless respond_to?(:scoped_by_tenant?)
@@ -222,5 +245,10 @@ module ActsAsTenant
         end
       end
     end
+
+    # Override to skip the tenant validation of a belongs_to association
+    def validate_tenant_association?(reflection)
+      true
+    end
   end
 end

data/lib/acts_as_tenant/version.rb

@@ -1,3 +1,3 @@
 module ActsAsTenant
-  VERSION = "2.0.2"
+  VERSION = "2.2.0"
 end

data/lib/acts_as_tenant.rb

@@ -137,6 +137,10 @@ module ActsAsTenant
   end
 end
 
+ActiveSupport.on_load(:i18n) do
+  I18n.load_path << File.expand_path("acts_as_tenant/locale/en.yml", __dir__)
+end
+
 ActiveSupport.on_load(:active_record) do |base|
   base.include ActsAsTenant::ModelExtensions
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_tenant
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Erwin Matthijssen
@@ -44,6 +44,7 @@ files:
 - lib/acts_as_tenant/controller_extensions/subdomain.rb
 - lib/acts_as_tenant/controller_extensions/subdomain_or_domain.rb
 - lib/acts_as_tenant/errors.rb
+- lib/acts_as_tenant/locale/en.yml
 - lib/acts_as_tenant/model_extensions.rb
 - lib/acts_as_tenant/sidekiq.rb
 - lib/acts_as_tenant/tenant_helper.rb
@@ -68,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.21
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Add multi-tenancy to Rails applications using a shared db strategy
 test_files: []