activerecord-multi-tenant 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba7796208980393ca21739d24fa0ac384f0c63ab814041cf46e0216d22eef539
-  data.tar.gz: 107cea123278629ce9492b15eb6e168549eac4c155fe9a906e57e1695414faf7
+  metadata.gz: f277cdbd6175c03dcbbca13e06220f5612fdf40cefb539a3619b4afa0077d369
+  data.tar.gz: bae03db825cc60a9833a2287245b7ff5f62ede9aa67497594e867832a75eaedf
 SHA512:
-  metadata.gz: c184c2db6316a82d4b092dfdaff1cb69cde80319837302822b7fe8ae387bf627fa6e8670f828d980636e448761e51629c38c53d42dbb505d094f1a2b5eba4b54
-  data.tar.gz: c021571f18b6072a98bbe0793607077b785a3a989e3365cd45cd7c0d94fb89f5ed30f3129b35199d88aeab653d6c656d20028a84a5ce74bedbaf2a3c6d36c5b6
+  metadata.gz: fad6c663f7f588e1359ea4f831b1c66d24de31fa9895aee3ac42d59851597b3ceabf2576c4e2eb49f55baef6eaeb787fee946085b43909450580d4b6a66817cb
+  data.tar.gz: c58700fda6a8e99b928435f2bd5abfdc62eb6ccb249ab21350d12f25d9b6ff29860d12451e5e8a77aa2666302d8a9dbfa9bc062dab450ecfdfce2226452c0d43

data/.github/workflows/active-record-multi-tenant-tests.yml

@@ -51,13 +51,16 @@ jobs:
           - rails-6.0
           - rails-6.1
           - rails-7.0
+          - rails-7.1
           - active-record-6.0
           - active-record-6.1
           - active-record-7.0
+          - active-record-7.1
         citus_version:
           - '10'
           - '11'
-        
+          - '12'
+
     name: Ruby ${{ matrix.ruby }}/${{ matrix.gemfile }} / Citus ${{ matrix.citus_version }}
     env:
        APPRAISAL: ${{ matrix.appraisal }}

data/Appraisals

@@ -10,6 +10,10 @@ appraise 'rails-7.0' do
   gem 'rails', '~> 7.0.0'
 end
 
+appraise 'rails-7.1' do
+  gem 'rails', '~> 7.1.0.beta1'
+end
+
 appraise 'active-record-6.0' do
   gem 'activerecord', '~> 6.0.3'
 end
@@ -21,3 +25,7 @@ end
 appraise 'active-record-7.0' do
   gem 'activerecord', '~> 7.0.0'
 end
+
+appraise 'active-record-7.1' do
+  gem 'activerecord', '~> 7.1.0.beta1'
+end

data/CHANGELOG.md

@@ -1,4 +1,11 @@
 # Changelog
+
+## 2.4.0      2023-06-05
+* Adds citus 12 to test matrix (#210)
+* Adds Support for rails 7.1 (#208)
+* Fix missing scope in habtm.rb (#207)
+* Update logic inside the tenant_klass_defined? method (#202)
+
 ## 2.3.0      2023-06-05
 * Adds has_and_belongs_to_many feature with tenant (#193)
 * Removes eol ruby versions 

data/docs/requirements.txt

@@ -8,7 +8,7 @@ alabaster==0.7.13
     # via sphinx
 babel==2.12.1
     # via sphinx
-certifi==2023.5.7
+certifi==2023.7.22
     # via requests
 charset-normalizer==3.1.0
     # via requests

data/lib/activerecord-multi-tenant/habtm.rb

@@ -8,9 +8,9 @@ module ActiveRecord
   module Associations
     module ClassMethods
       # rubocop:disable Naming/PredicateName
-      def has_and_belongs_to_many_with_tenant(name, options = {}, &extension)
+      def has_and_belongs_to_many_with_tenant(name, scope = nil, **options, &extension)
         # rubocop:enable Naming/PredicateName
-        has_and_belongs_to_many_without_tenant(name, **options, &extension)
+        has_and_belongs_to_many_without_tenant(name, scope, **options, &extension)
 
         middle_reflection = _reflections[name.to_s].through_reflection
         join_model = middle_reflection.klass

data/lib/activerecord-multi-tenant/model_extensions.rb

@@ -67,7 +67,7 @@ module MultiTenant
         partition_key = @partition_key
 
         # Create an implicit belongs_to association only if tenant class exists
-        if MultiTenant.tenant_klass_defined?(tenant_name)
+        if MultiTenant.tenant_klass_defined?(tenant_name, options)
           belongs_to tenant_name, **options.slice(:class_name, :inverse_of, :optional)
                                            .merge(foreign_key: options[:partition_key])
         end
@@ -103,7 +103,7 @@ module MultiTenant
             tenant_id
           end
 
-          if MultiTenant.tenant_klass_defined?(tenant_name)
+          if MultiTenant.tenant_klass_defined?(tenant_name, options)
             define_method "#{tenant_name}=" do |model|
               super(model)
               if send("#{partition_key}_changed?") && persisted? && !send("#{partition_key}_was").nil?

data/lib/activerecord-multi-tenant/multi_tenant.rb

@@ -5,8 +5,13 @@ module MultiTenant
     attribute :tenant
   end
 
-  def self.tenant_klass_defined?(tenant_name)
-    !!tenant_name.to_s.classify.safe_constantize
+  def self.tenant_klass_defined?(tenant_name, options = {})
+    class_name = if options[:class_name].present?
+                   options[:class_name]
+                 else
+                   tenant_name.to_s.classify
+                 end
+    !!class_name.safe_constantize
   end
 
   def self.partition_key(tenant_name)
@@ -58,9 +63,9 @@ module MultiTenant
     return nil unless arel.respond_to?(:ast)
 
     if arel.ast.relation.is_a? Arel::Nodes::JoinSource
-      MultiTenant.multi_tenant_model_for_table(arel.ast.relation.left.table_name)
+      MultiTenant.multi_tenant_model_for_table(TableNode.table_name(arel.ast.relation.left))
     else
-      MultiTenant.multi_tenant_model_for_table(arel.ast.relation.table_name)
+      MultiTenant.multi_tenant_model_for_table(TableNode.table_name(arel.ast.relation))
     end
   end
 

data/lib/activerecord-multi-tenant/query_rewriter.rb

@@ -83,7 +83,7 @@ module MultiTenant
 
     def visit_Arel_Nodes_Equality(obj, *args)
       if obj.left.is_a?(Arel::Attributes::Attribute)
-        table_name = obj.left.relation.table_name
+        table_name = MultiTenant::TableNode.table_name(obj.left.relation)
         model = MultiTenant.multi_tenant_model_for_table(table_name)
         if model.present? && obj.left.name.to_s == model.partition_key.to_s
           @current_context.visited_handled_relation(obj.left.relation)
@@ -101,7 +101,7 @@ module MultiTenant
     end
 
     def visit_Arel_Table(obj, _collector = nil)
-      @current_context.visited_relation(obj) if tenant_relation?(obj.table_name)
+      @current_context.visited_relation(obj) if tenant_relation?(MultiTenant::TableNode.table_name(obj))
     end
 
     alias visit_Arel_Nodes_TableAlias visit_Arel_Table
@@ -179,7 +179,9 @@ module MultiTenant
     def initialize(tenant_attribute)
       super()
       @tenant_attribute = tenant_attribute
-      @tenant_model = MultiTenant.multi_tenant_model_for_table(tenant_attribute.relation.table_name)
+      @tenant_model = MultiTenant.multi_tenant_model_for_table(
+        MultiTenant::TableNode.table_name(tenant_attribute.relation)
+      )
     end
 
     def to_s
@@ -215,7 +217,7 @@ module MultiTenant
     def initialize(tenant_attribute, table_left)
       super(tenant_attribute)
       @table_left = table_left
-      @model_left = MultiTenant.multi_tenant_model_for_table(table_left.table_name)
+      @model_left = MultiTenant.multi_tenant_model_for_table(MultiTenant::TableNode.table_name(table_left))
     end
 
     private
@@ -241,7 +243,7 @@ module MultiTenant
   module DatabaseStatements
     def join_to_update(update, *args)
       update = super(update, *args)
-      model = MultiTenant.multi_tenant_model_for_table(update.ast.relation.table_name)
+      model = MultiTenant.multi_tenant_model_for_table(MultiTenant::TableNode.table_name(update.ast.relation))
       if model.present? && !MultiTenant.with_write_only_mode_enabled? && MultiTenant.current_tenant_id.present?
         update.where(MultiTenant::TenantEnforcementClause.new(model.arel_table[model.partition_key]))
       end
@@ -250,7 +252,7 @@ module MultiTenant
 
     def join_to_delete(delete, *args)
       delete = super(delete, *args)
-      model = MultiTenant.multi_tenant_model_for_table(delete.ast.left.table_name)
+      model = MultiTenant.multi_tenant_model_for_table(MultiTenant::TableNode.table_name(delete.ast.left))
       if model.present? && !MultiTenant.with_write_only_mode_enabled? && MultiTenant.current_tenant_id.present?
         delete.where(MultiTenant::TenantEnforcementClause.new(model.arel_table[model.partition_key]))
       end
@@ -295,7 +297,7 @@ module ActiveRecord
           node = context.arel_node
 
           context.unhandled_relations.each do |relation|
-            model = MultiTenant.multi_tenant_model_for_table(relation.arel_table.table_name)
+            model = MultiTenant.multi_tenant_model_for_table(MultiTenant::TableNode.table_name(relation.arel_table))
 
             if MultiTenant.current_tenant_id
               enforcement_clause = MultiTenant::TenantEnforcementClause.new(relation.arel_table[model.partition_key])
@@ -330,8 +332,8 @@ module ActiveRecord
 
               next unless relation_right && relation_left
 
-              model_right = MultiTenant.multi_tenant_model_for_table(relation_left.table_name)
-              model_left = MultiTenant.multi_tenant_model_for_table(relation_right.table_name)
+              model_right = MultiTenant.multi_tenant_model_for_table(MultiTenant::TableNode.table_name(relation_left))
+              model_left = MultiTenant.multi_tenant_model_for_table(MultiTenant::TableNode.table_name(relation_right))
               next unless model_right && model_left
 
               join_enforcement_clause = MultiTenant::TenantJoinEnforcementClause.new(

data/lib/activerecord-multi-tenant/table_node.rb

@@ -0,0 +1,13 @@
+module MultiTenant
+  module TableNode
+    # Return table name
+    def self.table_name(node)
+      # NOTE: Arel::Nodes::Table#table_name is removed in Rails 7.1
+      if node.is_a?(Arel::Nodes::TableAlias)
+        node.table_name
+      else
+        node.name
+      end
+    end
+  end
+end

data/lib/activerecord-multi-tenant/version.rb

@@ -1,3 +1,3 @@
 module MultiTenant
-  VERSION = '2.3.0'.freeze
+  VERSION = '2.4.0'.freeze
 end

data/lib/activerecord_multi_tenant.rb

@@ -8,5 +8,6 @@ require_relative 'activerecord-multi-tenant/model_extensions'
 require_relative 'activerecord-multi-tenant/multi_tenant'
 require_relative 'activerecord-multi-tenant/query_rewriter'
 require_relative 'activerecord-multi-tenant/query_monitor'
+require_relative 'activerecord-multi-tenant/table_node'
 require_relative 'activerecord-multi-tenant/version'
 require_relative 'activerecord-multi-tenant/habtm'

data/spec/activerecord-multi-tenant/multi_tenant_spec.rb

@@ -64,4 +64,58 @@ RSpec.describe MultiTenant do
       end
     end
   end
+
+  describe '.tenant_klass_defined?' do
+    context 'without options' do
+      before(:all) do
+        class SampleTenant < ActiveRecord::Base
+          multi_tenant :sample_tenant
+        end
+      end
+
+      it 'return true with valid tenant_name' do
+        expect(MultiTenant.tenant_klass_defined?(:sample_tenant)).to eq(true)
+      end
+
+      it 'return false with invalid_tenant_name' do
+        invalid_tenant_name = :tenant
+        expect(MultiTenant.tenant_klass_defined?(invalid_tenant_name)).to eq(false)
+      end
+    end
+
+    context 'with options' do
+      context 'and valid class_name' do
+        it 'return true' do
+          class SampleTenant < ActiveRecord::Base
+            multi_tenant :tenant
+          end
+
+          tenant_name = :tenant
+          options = {
+            class_name: 'SampleTenant'
+          }
+          expect(MultiTenant.tenant_klass_defined?(tenant_name, options)).to eq(true)
+        end
+
+        it 'return true when tenant class is nested' do
+          module SampleModule
+            class SampleNestedTenant < ActiveRecord::Base
+              multi_tenant :tenant
+            end
+            # rubocop:disable Layout/TrailingWhitespace
+            # Trailing whitespace is intentionally left here
+            
+            class AnotherTenant < ActiveRecord::Base
+            end
+            # rubocop:enable Layout/TrailingWhitespace
+          end
+          tenant_name = :tenant
+          options = {
+            class_name: 'SampleModule::SampleNestedTenant'
+          }
+          expect(MultiTenant.tenant_klass_defined?(tenant_name, options)).to eq(true)
+        end
+      end
+    end
+  end
 end

data/spec/schema.rb

@@ -174,8 +174,8 @@ end
 class Manager < ActiveRecord::Base
   multi_tenant :account
   belongs_to :project
-  has_and_belongs_to_many :tasks, { tenant_column: :account_id, tenant_enabled: true,
-                                    tenant_class_name: 'Account' }
+  has_and_belongs_to_many :tasks, tenant_column: :account_id, tenant_enabled: true,
+                                  tenant_class_name: 'Account'
 end
 
 class Task < ActiveRecord::Base

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-multi-tenant
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Citus Data
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-06 00:00:00.000000000 Z
+date: 2023-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -276,6 +276,7 @@ files:
 - lib/activerecord-multi-tenant/query_monitor.rb
 - lib/activerecord-multi-tenant/query_rewriter.rb
 - lib/activerecord-multi-tenant/sidekiq.rb
+- lib/activerecord-multi-tenant/table_node.rb
 - lib/activerecord-multi-tenant/version.rb
 - lib/activerecord_multi_tenant.rb
 - spec/activerecord-multi-tenant/associations_spec.rb